[v2] Input: Add "Share" button to Microsoft Xbox One controller.

Add "Share" button input capability and input event mapping for
Microsoft Xbox One controller.
Fixed Microsoft Xbox One controller share button not working under USB
connection.

Signed-off-by: Chris Ye <redacted>
---
 drivers/input/joystick/xpad.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/drivers/input/joystick/xpad.c b/drivers/input/joystick/xpad.c
index 9f0d07dcbf06..0c3374091aff 100644
--- a/drivers/input/joystick/xpad.c
+++ b/drivers/input/joystick/xpad.c

@@ -79,6 +79,7 @@
 #define MAP_DPAD_TO_BUTTONS		(1 << 0)
 #define MAP_TRIGGERS_TO_BUTTONS		(1 << 1)
 #define MAP_STICKS_TO_NULL		(1 << 2)
+#define MAP_SHARE_BUTTON		(1 << 3)
 #define DANCEPAD_MAP_CONFIG	(MAP_DPAD_TO_BUTTONS |			\
 				MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)
 

@@ -130,6 +131,7 @@ static const struct xpad_device {
 	{ 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", 0, XTYPE_XBOXONE },
 	{ 0x045e, 0x02ea, "Microsoft X-Box One S pad", 0, XTYPE_XBOXONE },
 	{ 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
+	{ 0x045e, 0x0b12, "Microsoft X-Box One X pad", MAP_SHARE_BUTTON, XTYPE_XBOXONE },
 	{ 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
 	{ 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
 	{ 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },

@@ -862,6 +864,8 @@ static void xpadone_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char
 	/* menu/view buttons */
 	input_report_key(dev, BTN_START,  data[4] & 0x04);
 	input_report_key(dev, BTN_SELECT, data[4] & 0x08);
+	if (xpad->mapping & MAP_SHARE_BUTTON)
+		input_report_key(dev, KEY_RECORD, data[22] & 0x01);
 
 	/* buttons A,B,X,Y */
 	input_report_key(dev, BTN_A,	data[4] & 0x10);

@@ -1669,9 +1673,12 @@ static int xpad_init_input(struct usb_xpad *xpad)
 
 	/* set up model-specific ones */
 	if (xpad->xtype == XTYPE_XBOX360 || xpad->xtype == XTYPE_XBOX360W ||
-	    xpad->xtype == XTYPE_XBOXONE) {
+		xpad->xtype == XTYPE_XBOXONE) {
 		for (i = 0; xpad360_btn[i] >= 0; i++)
 			input_set_capability(input_dev, EV_KEY, xpad360_btn[i]);
+		if (xpad->mapping & MAP_SHARE_BUTTON) {
+			input_set_capability(input_dev, EV_KEY, KEY_RECORD);
+		}
 	} else {
 		for (i = 0; xpad_btn[i] >= 0; i++)
 			input_set_capability(input_dev, EV_KEY, xpad_btn[i]);

-- 
2.30.0.617.g56c4b15f3c-goog

On 2/24/21 11:32 PM, Chris Ye wrote:

Let's use 'Xbox' for new entries instead of 'X-Box'. There was an effort to
standardize on 'Xbox' (which is what Microsoft uses), but changing device
names can impact userspace which may use these names in mapping heuristics
(SDL does this). We can at least not make the problem worse though.

I was worried adding a button to an existing supported gamepad like this
might cause a breaking change to SDL's gamepad mapping for this gamepad,
since SDL assigns each present button an index rather than using the keycodes
directly (adding a new one could change the old indices). Fortunately, SDL
always processes buttons in the BTN_GAMEPAD range first, so this new button
ends up at the end of the list anyway.

Style nit: Drop the uneeded {} here

 	} else {
 		for (i = 0; xpad_btn[i] >= 0; i++)
 			input_set_capability(input_dev, EV_KEY, xpad_btn[i]);

LGTM, other than the minor changes suggested above.


Regards,
Cameron

Hi Cameron,
   I was first thinking of adding a new XTYPE but then realized it is
still XBox One but just a model with extra button, so adding
MAP_SHARE_BUTTON would avoid adding a new XTYPE there.
Addressed the name to be "Microsoft Xbox One X pad" and removed the
{}, please review again, thanks!
Chris


On Sat, Feb 27, 2021 at 6:01 PM Cameron Gutman [off-list ref] wrote:

On 2/24/21 11:32 PM, Chris Ye wrote:

quoted

Add "Share" button input capability and input event mapping for
Microsoft Xbox One controller.
Fixed Microsoft Xbox One controller share button not working under USB
connection.

Signed-off-by: Chris Ye <redacted>
---
 drivers/input/joystick/xpad.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/drivers/input/joystick/xpad.c b/drivers/input/joystick/xpad.c
index 9f0d07dcbf06..0c3374091aff 100644
--- a/drivers/input/joystick/xpad.c
+++ b/drivers/input/joystick/xpad.c

@@ -79,6 +79,7 @@
 #define MAP_DPAD_TO_BUTTONS          (1 << 0)
 #define MAP_TRIGGERS_TO_BUTTONS              (1 << 1)
 #define MAP_STICKS_TO_NULL           (1 << 2)
+#define MAP_SHARE_BUTTON             (1 << 3)
 #define DANCEPAD_MAP_CONFIG  (MAP_DPAD_TO_BUTTONS |                  \
                              MAP_TRIGGERS_TO_BUTTONS | MAP_STICKS_TO_NULL)

@@ -130,6 +131,7 @@ static const struct xpad_device {
      { 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", 0, XTYPE_XBOXONE },
      { 0x045e, 0x02ea, "Microsoft X-Box One S pad", 0, XTYPE_XBOXONE },
      { 0x045e, 0x0719, "Xbox 360 Wireless Receiver", MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
+     { 0x045e, 0x0b12, "Microsoft X-Box One X pad", MAP_SHARE_BUTTON, XTYPE_XBOXONE },

Let's use 'Xbox' for new entries instead of 'X-Box'. There was an effort to
standardize on 'Xbox' (which is what Microsoft uses), but changing device
names can impact userspace which may use these names in mapping heuristics
(SDL does this). We can at least not make the problem worse though.

quoted

      { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
      { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
      { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },

@@ -862,6 +864,8 @@ static void xpadone_process_packet(struct usb_xpad *xpad, u16 cmd, unsigned char
      /* menu/view buttons */

39 more quoted lines

On Thu, 2021-02-25 at 05:32 +0000, Chris Ye wrote:

21 more quoted lines

Is there not a better keycode to use than "Record"? Should a "share"
keycode be added?

I couldn't find a share button in the most recent USB HID Usage Tables:
https://www.usb.org/document-library/hid-usage-tables-121

+               }
        } else {
                for (i = 0; xpad_btn[i] >= 0; i++)
                        input_set_capability(input_dev, EV_KEY,
xpad_btn[i]);

Hi Bastien,
    The "Share button" is a name Microsoft calls it, it actually has
HID descriptor defined in the bluetooth interface, which the HID usage
is:
consumer 0xB2:
0x05, 0x0C,        //   Usage Page (Consumer)
0x0A, 0xB2, 0x00,  //   Usage (Record)
Microsoft wants the same key code to be generated consistently for USB
and bluetooth.
Thanks!
Chris


On Tue, Mar 2, 2021 at 1:50 AM Bastien Nocera [off-list ref] wrote:

On Thu, 2021-02-25 at 05:32 +0000, Chris Ye wrote:

quoted

Add "Share" button input capability and input event mapping for
Microsoft Xbox One controller.
Fixed Microsoft Xbox One controller share button not working under USB
connection.

Signed-off-by: Chris Ye <redacted>
---
 drivers/input/joystick/xpad.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/drivers/input/joystick/xpad.c

b/drivers/input/joystick/xpad.c
index 9f0d07dcbf06..0c3374091aff 100644

--- a/drivers/input/joystick/xpad.c
+++ b/drivers/input/joystick/xpad.c

@@ -79,6 +79,7 @@
 #define MAP_DPAD_TO_BUTTONS            (1 << 0)
 #define MAP_TRIGGERS_TO_BUTTONS                (1 << 1)
 #define MAP_STICKS_TO_NULL             (1 << 2)
+#define MAP_SHARE_BUTTON               (1 << 3)
 #define DANCEPAD_MAP_CONFIG    (MAP_DPAD_TO_BUTTONS

|                  \
                                MAP_TRIGGERS_TO_BUTTONS |
MAP_STICKS_TO_NULL)

@@ -130,6 +131,7 @@ static const struct xpad_device {
        { 0x045e, 0x02e3, "Microsoft X-Box One Elite pad", 0,

XTYPE_XBOXONE },
        { 0x045e, 0x02ea, "Microsoft X-Box One S pad", 0, XTYPE_XBOXONE
},
        { 0x045e, 0x0719, "Xbox 360 Wireless Receiver",
MAP_DPAD_TO_BUTTONS, XTYPE_XBOX360W },
+       { 0x045e, 0x0b12, "Microsoft X-Box One X pad",
MAP_SHARE_BUTTON, XTYPE_XBOXONE },
        { 0x046d, 0xc21d, "Logitech Gamepad F310", 0, XTYPE_XBOX360 },
        { 0x046d, 0xc21e, "Logitech Gamepad F510", 0, XTYPE_XBOX360 },
        { 0x046d, 0xc21f, "Logitech Gamepad F710", 0, XTYPE_XBOX360 },

@@ -862,6 +864,8 @@ static void xpadone_process_packet(struct usb_xpad

37 more quoted lines

Hi Bastien,  just want to follow up again on this.  I've checked again
with the Xbox team that the "Share button" is given for the product,
the HID usage profile and mapping to RECORD is what Xbox team expects
and they want the same mapping for USB.

Thanks!
Chris


On Tue, Mar 2, 2021 at 3:57 PM Chris Ye [off-list ref] wrote:

Hi Bastien,
    The "Share button" is a name Microsoft calls it, it actually has
HID descriptor defined in the bluetooth interface, which the HID usage
is:
consumer 0xB2:
0x05, 0x0C,        //   Usage Page (Consumer)
0x0A, 0xB2, 0x00,  //   Usage (Record)
Microsoft wants the same key code to be generated consistently for USB
and bluetooth.
Thanks!
Chris


On Tue, Mar 2, 2021 at 1:50 AM Bastien Nocera [off-list ref] wrote:

quoted

On Thu, 2021-02-25 at 05:32 +0000, Chris Ye wrote:

quoted

Add "Share" button input capability and input event mapping for
Microsoft Xbox One controller.
Fixed Microsoft Xbox One controller share button not working under USB
connection.

Signed-off-by: Chris Ye <redacted>
---
 drivers/input/joystick/xpad.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/drivers/input/joystick/xpad.c

b/drivers/input/joystick/xpad.c
index 9f0d07dcbf06..0c3374091aff 100644

--- a/drivers/input/joystick/xpad.c
+++ b/drivers/input/joystick/xpad.c

@@ -79,6 +79,7 @@
 #define MAP_DPAD_TO_BUTTONS            (1 << 0)
 #define MAP_TRIGGERS_TO_BUTTONS                (1 << 1)
 #define MAP_STICKS_TO_NULL             (1 << 2)
+#define MAP_SHARE_BUTTON               (1 << 3)
 #define DANCEPAD_MAP_CONFIG    (MAP_DPAD_TO_BUTTONS

|                  \
                                MAP_TRIGGERS_TO_BUTTONS |

52 more quoted lines

(resend in plain text)
+benjamin in a more explicit way

Hi Chris,

I see the need for the Record button. I wonder what makes sense from
the Linux kernel perspective. For DualShock 4 and DualSense there is a
Share button too (it introduced it). For DualShock 4 that was mapped
to 'Select' I think per Linux gamepad spec. For DualSense in 5.12 we
did the same... Though if there is a true 'Record' button we want to
use moving forward. Maybe we still want to change the button
definition for DualSensein 5.12 while we can...

It would be good to get some consensus on these buttons.

Thanks,
Roderick


On Thu, Mar 4, 2021 at 6:25 PM Chris Ye [off-list ref] wrote:

Hi Bastien,  just want to follow up again on this.  I've checked again
with the Xbox team that the "Share button" is given for the product,
the HID usage profile and mapping to RECORD is what Xbox team expects
and they want the same mapping for USB.

Thanks!
Chris


On Tue, Mar 2, 2021 at 3:57 PM Chris Ye [off-list ref] wrote:

quoted

Hi Bastien,
    The "Share button" is a name Microsoft calls it, it actually has
HID descriptor defined in the bluetooth interface, which the HID usage
is:
consumer 0xB2:
0x05, 0x0C,        //   Usage Page (Consumer)
0x0A, 0xB2, 0x00,  //   Usage (Record)
Microsoft wants the same key code to be generated consistently for USB
and bluetooth.
Thanks!
Chris


On Tue, Mar 2, 2021 at 1:50 AM Bastien Nocera [off-list ref] wrote:

quoted

On Thu, 2021-02-25 at 05:32 +0000, Chris Ye wrote:

quoted

Add "Share" button input capability and input event mapping for
Microsoft Xbox One controller.
Fixed Microsoft Xbox One controller share button not working under USB
connection.

Signed-off-by: Chris Ye <redacted>
---
 drivers/input/joystick/xpad.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/drivers/input/joystick/xpad.c

b/drivers/input/joystick/xpad.c

63 more quoted lines

On Thu, 2021-03-04 at 20:42 -0800, Roderick Colenbrander wrote:

(resend in plain text)
+benjamin in a more explicit way

Hi Chris,

I see the need for the Record button. I wonder what makes sense from
the Linux kernel perspective. For DualShock 4 and DualSense there is a
Share button too (it introduced it). For DualShock 4 that was mapped
to 'Select' I think per Linux gamepad spec. For DualSense in 5.12 we
did the same... Though if there is a true 'Record' button we want to
use moving forward. Maybe we still want to change the button
definition for DualSensein 5.12 while we can...

It would be good to get some consensus on these buttons.

The XBox One Series X controller has 3 of those "middle" buttons, 2
equivalent to Start/Select on older controllers (that were already
present on older versions of the pad) and Share.
https://www.xbox.com/en-US/accessories/controllers/xbox-wireless-controller

The Options buttons on the DS4 replaces Start and Select:
https://manuals.playstation.net/document/en/ps4/basic/pn_controller.html
so Share got added, but Select taken away, which is why you had to
label it Select in the driver.

I don't really see how to fix that without retroactively re-adding
buttons to the DS4 controller ;)

Thanks,
Roderick


On Thu, Mar 4, 2021 at 6:25 PM Chris Ye [off-list ref] wrote:

quoted

Hi Bastien,  just want to follow up again on this.  I've checked
again
with the Xbox team that the "Share button" is given for the product,
the HID usage profile and mapping to RECORD is what Xbox team expects
and they want the same mapping for USB.

Thanks!
Chris


On Tue, Mar 2, 2021 at 3:57 PM Chris Ye [off-list ref] wrote:

quoted

Hi Bastien,
    The "Share button" is a name Microsoft calls it, it actually
has
HID descriptor defined in the bluetooth interface, which the HID
usage
is:
consumer 0xB2:
0x05, 0x0C,        //   Usage Page (Consumer)
0x0A, 0xB2, 0x00,  //   Usage (Record)
Microsoft wants the same key code to be generated consistently for
USB
and bluetooth.
Thanks!
Chris


On Tue, Mar 2, 2021 at 1:50 AM Bastien Nocera [off-list ref]
wrote:

quoted

On Thu, 2021-02-25 at 05:32 +0000, Chris Ye wrote:

quoted

Add "Share" button input capability and input event mapping for

84 more quoted lines