leds: add new LED_FUNCTION_PLAYER for player LEDs for game controllers.

Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=2070873
Upstream Status: since v5.16
Tested: with the hid-tools test suite and some hardware

commit 61177c088a57bed259122f3c7bc6d61984936a12
Author: Roderick Colenbrander <roderick@gaikai.com>
Date:   Wed Sep 8 09:55:38 2021 -0700

    leds: add new LED_FUNCTION_PLAYER for player LEDs for game controllers.

    Player LEDs are commonly found on game controllers from Nintendo and Sony
    to indicate a player ID across a number of LEDs. For example, "Player 2"
    might be indicated as "-x--" on a device with 4 LEDs where "x" means on.

    This patch introduces LED_FUNCTION_PLAYER1-5 defines to properly indicate
    player LEDs from the kernel. Until now there was no good standard, which
    resulted in inconsistent behavior across xpad, hid-sony, hid-wiimote and
    other drivers. Moving forward new drivers should use LED_FUNCTION_PLAYERx.

    Note: management of Player IDs is left to user space, though a kernel
    driver may pick a default value.

    Signed-off-by: Roderick Colenbrander <roderick.colenbrander@sony.com>
    Acked-by: Pavel Machek <pavel@ucw.cz>
    Signed-off-by: Jiri Kosina <jkosina@suse.cz>

Signed-off-by: Benjamin Tissoires <benjamin.tissoires@redhat.com>
This commit is contained in:
Benjamin Tissoires
2022-06-22 18:09:05 +02:00
parent 7cbac52142
commit 1cecedb106
2 changed files with 21 additions and 0 deletions
+14
View File
@@ -16,6 +16,20 @@ but then try the legacy ones, too.
Notice there's a list of functions in include/dt-bindings/leds/common.h .
* Gamepads and joysticks
Game controllers may feature LEDs to indicate a player number. This is commonly
used on game consoles in which multiple controllers can be connected to a system.
The "player LEDs" are then programmed with a pattern to indicate a particular
player. For example, a game controller with 4 LEDs, may be programmed with "x---"
to indicate player 1, "-x--" to indicate player 2 etcetera where "x" means on.
Input drivers can utilize the LED class to expose the individual player LEDs
of a game controller using the function "player".
Note: tracking and management of Player IDs is the responsibility of user space,
though drivers may pick a default value.
Good: "input*:*:player-{1,2,3,4,5}
* Keyboards
Good: "input*:*:capslock"
+7
View File
@@ -60,6 +60,13 @@
#define LED_FUNCTION_MICMUTE "micmute"
#define LED_FUNCTION_MUTE "mute"
/* Used for player LEDs as found on game controllers from e.g. Nintendo, Sony. */
#define LED_FUNCTION_PLAYER1 "player-1"
#define LED_FUNCTION_PLAYER2 "player-2"
#define LED_FUNCTION_PLAYER3 "player-3"
#define LED_FUNCTION_PLAYER4 "player-4"
#define LED_FUNCTION_PLAYER5 "player-5"
/* Miscelleaus functions. Use functions above if you can. */
#define LED_FUNCTION_ACTIVITY "activity"
#define LED_FUNCTION_ALARM "alarm"