Skip to contentSkip to conversation

USB HID: proper LED-mapping (support for SpaceNavigator)

PATCH In review Simon Budig 4 participants 12 messages Jan 14, 2007 – Jan 15, 2007

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 USB HID: proper LED-mapping (support for SpaceNavigator)

From: Simon Budig <[email protected]>

This change introduces a mapping for LED indicators between the USB HID specification and the Linux input subsystem. The previous code properly mapped the LEDs relevant for Keyboards, but garbeled the remaining ones. With this change all LED enums from the input system get mapped to more or less equivalent LED numbers from the HID specification.

This patch also extends the debug output and ensures that the unused bits in a HID report to the device are zeroed out. This makes the 3Dconnexion SpaceNavigator fully usable with the linux input system.

drivers/usb/input/hid-core.c renamed from drivers/usb/input.orig/hid-core.c +4 -0
diff -uprN -X linux/Documentation/dontdiff linux/drivers/usb/input.orig/hid-core.c linux/drivers/usb/input/hid-core.c
@@ -1089,6 +1089,10 @@ static void hid_output_field(struct hid_
 	unsigned size = field->report_size;
 	unsigned n;
 
+	/* make sure the unused bits in the last byte are zeros */
+	if (count > 0 && size > 0)
+		data[(count*size-1)/8] = 0;
+
 	for (n = 0; n < count; n++) {
 		if (field->logical_minimum < 0)	/* signed values */
 			implement(data, offset + n * size, size, s32ton(field->value[n], size));
drivers/usb/input/hid-debug.h renamed from drivers/usb/input.orig/hid-debug.h +4 -3
diff -uprN -X linux/Documentation/dontdiff linux/drivers/usb/input.orig/hid-debug.h linux/drivers/usb/input/hid-debug.h
@@ -700,9 +700,10 @@ static char *keys[KEY_MAX + 1] = {
 
 static char *relatives[REL_MAX + 1] = {
 	[REL_X] = "X",			[REL_Y] = "Y",
-	[REL_Z] = "Z",			[REL_HWHEEL] = "HWheel",
-	[REL_DIAL] = "Dial",		[REL_WHEEL] = "Wheel",
-	[REL_MISC] = "Misc",
+	[REL_Z] = "Z",			[REL_RX] = "Rx",
+	[REL_RY] = "Ry",		[REL_RZ] = "Rz",
+	[REL_HWHEEL] = "HWheel",	[REL_DIAL] = "Dial",
+	[REL_WHEEL] = "Wheel",		[REL_MISC] = "Misc",
 };
 
 static char *absolutes[ABS_MAX + 1] = {
drivers/usb/input/hid-input.c renamed from drivers/usb/input.orig/hid-input.c +16 -3
diff -uprN -X linux/Documentation/dontdiff linux/drivers/usb/input.orig/hid-input.c linux/drivers/usb/input/hid-input.c
@@ -366,9 +366,22 @@ static void hidinput_configure_usage(str
 			break;
 
 		case HID_UP_LED:
-			if (((usage->hid - 1) & 0xffff) >= LED_MAX)
-				goto ignore;
-			map_led((usage->hid - 1) & 0xffff);
+
+			switch (usage->hid & 0xffff) {                        /* HID-Value: */
+				case 0x01:  map_led (LED_NUML);     break;    /* Num Lock */
+				case 0x02:  map_led (LED_CAPSL);    break;    /* Caps Lock */
+				case 0x03:  map_led (LED_SCROLLL);  break;    /* Scroll Lock */
+				case 0x04:  map_led (LED_COMPOSE);  break;    /* Compose */
+				case 0x05:  map_led (LED_KANA);     break;    /* Kana */
+				case 0x27:  map_led (LED_SLEEP);    break;    /* Stand-By */
+				case 0x4c:  map_led (LED_SUSPEND);  break;    /* System Suspend */
+				case 0x09:  map_led (LED_MUTE);     break;    /* Mute */
+				case 0x4b:  map_led (LED_MISC);     break;    /* Generic Indicator */
+				case 0x19:  map_led (LED_MAIL);     break;    /* Message Waiting */
+				case 0x4d:  map_led (LED_CHARGING); break;    /* External Power Connected */
+
+				default: goto ignore;
+			}
 			break;
 
 		case HID_UP_DIGITIZER:
#1 lore raw
Quoted 8 lines · Simon Budig

This change introduces a mapping for LED indicators between the USB HID specification and the Linux input subsystem. The previous code properly mapped the LEDs relevant for Keyboards, but garbeled the remaining ones. With this change all LED enums from the input system get mapped to more or less equivalent LED numbers from the HID specification. This patch also extends the debug output and ensures that the unused bits in a HID report to the device are zeroed out. This makes the 3Dconnexion SpaceNavigator fully usable with the linux input system.

Hi Simon,

thanks for the patch. It seems that it is based on pre-2.6.20-rc1 kernel (this is where the USBHID split happened and generic HID layer was introduced). Could you please rebase it against newer version of kernel and resend it?

All your changes happen to be in the transport-independent code, so it seems that this would be rather trivial task - probably only pathnames (and diff offsets) will change - your changes should now go to drivers/hid/hid-*, not drivers/usb/input/hid-*.

Thanks,

Signature · 1 line
Jiri Kosina
#2 lore raw
Quoted 4 lines · Jiri Kosina

thanks for the patch. It seems that it is based on pre-2.6.20-rc1 kernel (this is where the USBHID split happened and generic HID layer was introduced). Could you please rebase it against newer version of kernel and resend it?

I've updated the patch, will submit it to the list in a few minutes.

Quoted 4 lines

All your changes happen to be in the transport-independent code, so it seems that this would be rather trivial task - probably only pathnames (and diff offsets) will change - your changes should now go to drivers/hid/hid-*, not drivers/usb/input/hid-*.

Yeah, it was easy to port over. Did the hid-debug stuff disappear completely? What would I use instead?

Thanks,
Simon

Signature · 1 line
              [email protected]              http://simon.budig.de/
#3 lore raw
Quoted 5 lines · Simon Budig
Quoted 4 lines

thanks for the patch. It seems that it is based on pre-2.6.20-rc1 kernel (this is where the USBHID split happened and generic HID layer was introduced). Could you please rebase it against newer version of kernel and resend it?

I've updated the patch, will submit it to the list in a few minutes.

I got it, thanks.

Quoted 6 lines
Quoted 4 lines

All your changes happen to be in the transport-independent code, so it seems that this would be rather trivial task - probably only pathnames (and diff offsets) will change - your changes should now go to drivers/hid/hid-*, not drivers/usb/input/hid-*.

Yeah, it was easy to port over. Did the hid-debug stuff disappear completely? What would I use instead?

No, it didn't disappear, it was just moved to include/linux/hid-debug.h. Should I wait for an updated patch that uses hid-debug.h again?

Thanks,

Signature · 1 line
Jiri Kosina
#4 lore raw
Quoted 6 lines · Jiri Kosina
Quoted 2 lines · Simon Budig

Yeah, it was easy to port over. Did the hid-debug stuff disappear completely? What would I use instead?

No, it didn't disappear, it was just moved to include/linux/hid-debug.h. Should I wait for an updated patch that uses hid-debug.h again?

Thanks, I missed that. Since these issues are unrelated I'll just submit a trivial patch for the hid-debug.h stuff.

Is it possible that there is a regression in the hid-debug stuff? The mapping does not seem to appear in the dmesg-output. I unfortunately don't have an earlier kernel available right now to verify, but now the output on plugging in the device looks like this:

[...]
usbcore: registered new interface driver hiddev
hid-debug: input GenericDesktop.X = 0
hid-debug: input GenericDesktop.Y = 0
hid-debug: input GenericDesktop.Z = 0
hid-debug: input GenericDesktop.Rx = 0
hid-debug: input GenericDesktop.Ry = 0
hid-debug: input GenericDesktop.Rz = 0
[...]

which looks bogus to me, IIRC earlier versions really printed the mapping to linux input events at this point.

Anyway, the patch is correct anyway, will submit it soon.

Bye,
Simon

Signature · 1 line
              [email protected]              http://simon.budig.de/
#5 lore raw
Quoted 4 lines · Simon Budig

Is it possible that there is a regression in the hid-debug stuff? The mapping does not seem to appear in the dmesg-output. I unfortunately don't have an earlier kernel available right now to verify, but now the output on plugging in the device looks like this:

Hi Simon,

thanks, I queued the LED mapping fix for upstream.

I agree with Vojtech and Marcel that it doesn't make much sense having the hid-debug as a header file - I will fix it, and apply your patch to it (after I check why the debug output seems to be broken), you don't have to resend it, thanks.

Signature · 1 line
Jiri Kosina
#6 lore raw
Quoted 6 lines · Jiri Kosina
Quoted 4 lines · Simon Budig

Is it possible that there is a regression in the hid-debug stuff? The mapping does not seem to appear in the dmesg-output. I unfortunately don't have an earlier kernel available right now to verify, but now the output on plugging in the device looks like this:

[...]

Quoted 1 line

(after I check why the debug output seems to be broken),

Actually this might have been a false alarm. I remembered about /var/log/messages and looked up how this looked like with earlier kernels - turns out it looks exactly the same.

(the values dumped there seem to be the initial values of a given field in a HID-Report)

So there is no regression there, sorry about the confusion.

Bye,
Simon

Signature · 1 line
              [email protected]              http://simon.budig.de/
#7 lore raw
In reply to Jiri Kosina
Quoted 10 lines · Jiri Kosina
Quoted 5 lines · Simon Budig
Quoted 4 lines

thanks for the patch. It seems that it is based on pre-2.6.20-rc1 kernel (this is where the USBHID split happened and generic HID layer was introduced). Could you please rebase it against newer version of kernel and resend it?

I've updated the patch, will submit it to the list in a few minutes.

I got it, thanks.

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines

All your changes happen to be in the transport-independent code, so it seems that this would be rather trivial task - probably only pathnames (and diff offsets) will change - your changes should now go to drivers/hid/hid-*, not drivers/usb/input/hid-*.

Yeah, it was easy to port over. Did the hid-debug stuff disappear completely? What would I use instead?

No, it didn't disappear, it was just moved to include/linux/hid-debug.h.

Do you think that makes sense? It's code, not a header file.

Quoted 1 line

Should I wait for an updated patch that uses hid-debug.h again?

Signature · 2 lines
Vojtech Pavlik
Director SuSE Labs
#8 lore raw

Hi Vojtech,

Quoted 5 lines
Quoted 1 line

No, it didn't disappear, it was just moved to include/linux/hid-debug.h.

Do you think that makes sense? It's code, not a header file.

Quoted 1 line

Should I wait for an updated patch that uses hid-debug.h again?

actually that code shouldn't be in a header file at all. It should be drivers/hid/hid-debug.c and the Makefile should compile it conditionally depending on a Kconfig option.

Regards

Marcel

#9 lore raw
Quoted 11 lines · Marcel Holtmann

Hi Vojtech,

Quoted 5 lines
Quoted 1 line

No, it didn't disappear, it was just moved to include/linux/hid-debug.h.

Do you think that makes sense? It's code, not a header file.

Quoted 1 line

Should I wait for an updated patch that uses hid-debug.h again?

actually that code shouldn't be in a header file at all. It should be drivers/hid/hid-debug.c and the Makefile should compile it conditionally depending on a Kconfig option.

Agreed. It was a .h file just because of me being lazy.

Signature · 2 lines
Vojtech Pavlik
Director SuSE Labs
#10 lore raw

PATCH 1/1 USB HID: proper LED-mapping (support for SpaceNavigator)

In reply to Simon Budig

From: Simon Budig <[email protected]>

This change introduces a mapping for LED indicators between the USB HID specification and the Linux input subsystem. The previous code properly mapped the LEDs relevant for Keyboards, but garbeled the remaining ones. With this change all LED enums from the input system get mapped to more or less equivalent LED numbers from the HID specification.

This patch also ensures that the unused bits in a HID report to the device are zeroed out. This makes the 3Dconnexion SpaceNavigator fully usable with the linux input system.

drivers/hid/hid-core.c +4 -0
diff -uprN -X linux/Documentation/dontdiff linux-2.6.19/drivers/hid/hid-core.c linux/drivers/hid/hid-core.c
@@ -880,6 +880,10 @@ static void hid_output_field(struct hid_
 	unsigned size = field->report_size;
 	unsigned n;
 
+	/* make sure the unused bits in the last byte are zeros */
+	if (count > 0 && size > 0)
+		data[(count*size-1)/8] = 0;
+
 	for (n = 0; n < count; n++) {
 		if (field->logical_minimum < 0)	/* signed values */
 			implement(data, offset + n * size, size, s32ton(field->value[n], size));
drivers/hid/hid-input.c +16 -3
diff -uprN -X linux/Documentation/dontdiff linux-2.6.19/drivers/hid/hid-input.c linux/drivers/hid/hid-input.c
@@ -364,9 +364,22 @@ static void hidinput_configure_usage(str
 			break;
 
 		case HID_UP_LED:
-			if (((usage->hid - 1) & 0xffff) >= LED_MAX)
-				goto ignore;
-			map_led((usage->hid - 1) & 0xffff);
+
+			switch (usage->hid & 0xffff) {                        /* HID-Value:                   */
+				case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
+				case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
+				case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
+				case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
+				case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
+				case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
+				case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
+				case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
+				case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
+				case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
+				case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
+
+				default: goto ignore;
+			}
 			break;
 
 		case HID_UP_DIGITIZER:
#11 lore raw

From: Simon Budig <[email protected]>

This trivial change adds some missing enum values to the hid-debug output.

include/linux/hid-debug.h renamed from include/linux/hid-debug.h.orig +4 -3
@@ -700,9 +700,10 @@ static char *keys[KEY_MAX + 1] = {
 
 static char *relatives[REL_MAX + 1] = {
 	[REL_X] = "X",			[REL_Y] = "Y",
-	[REL_Z] = "Z",			[REL_HWHEEL] = "HWheel",
-	[REL_DIAL] = "Dial",		[REL_WHEEL] = "Wheel",
-	[REL_MISC] = "Misc",
+	[REL_Z] = "Z",			[REL_RX] = "Rx",
+	[REL_RY] = "Ry",		[REL_RZ] = "Rz",
+	[REL_HWHEEL] = "HWheel",	[REL_DIAL] = "Dial",
+	[REL_WHEEL] = "Wheel",		[REL_MISC] = "Misc",
 };
 
 static char *absolutes[ABS_MAX + 1] = {