Fixing Mac OSX USB NKRO

[kiibohd-controller.git] / Output / pjrcUSB / avr / usb_keyboard_serial.h

diff --git a/Output/pjrcUSB/avr/usb_keyboard_serial.h b/Output/pjrcUSB/avr/usb_keyboard_serial.h
index 7b2c7209cb86b1e3b612b9e1b455574a9ee137a7..60b5090c9026e242acbe3103969bd66736ee3129 100644 (file)
--- a/Output/pjrcUSB/avr/usb_keyboard_serial.h
+++ b/Output/pjrcUSB/avr/usb_keyboard_serial.h
@@ -203,7 +203,7 @@ int8_t usb_serial_set_control(uint8_t signals); // set DSR, DCD, RI, etc
 
 #define KEYBOARD_NKRO_INTERFACE  0
 #define KEYBOARD_NKRO_ENDPOINT   1
-#define KEYBOARD_NKRO_SIZE       128
+#define KEYBOARD_NKRO_SIZE       64
 #define KEYBOARD_NKRO_HID_BUFFER EP_DOUBLE_BUFFER
 
 #define KEYBOARD_INTERFACE       1
@@ -260,7 +260,7 @@ static const uint8_t PROGMEM device_descriptor[] = {
        18,                                     // bLength
        1,                                      // bDescriptorType
        0x00, 0x02,                             // bcdUSB
-       0x03,                                   // bDeviceClass - 0x03 = HID Class
+       0x00,                                   // bDeviceClass - Composite device, 0x00 is required for Windows
        0,                                      // bDeviceSubClass
        0,                                      // bDeviceProtocol
        ENDPOINT0_SIZE,                         // bMaxPacketSize0
@@ -370,27 +370,49 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
        // See http://www.usb.org/developers/hidpage/Hut1_12v2.pdf Chapter 10
        // Or Macros/PartialMap/usb_hid.h
        //
+       // 50 must be excluded due to a Linux bug with bitmaps (not useful anyways)
        // 165-175 are reserved/unused as well as 222-223 and 232-65535
        // 224-231 are used for modifiers (see above)
        //
+       // Compatibility Notes:
+       //  - Using a second endpoint for a boot mode device helps with compatibility
+       //  - DO NOT use Padding in the descriptor for bitfields
+       //    (Mac OSX silently fails... Windows/Linux work correctly)
+       //
        // Packing of bitmaps are as follows:
-       //   4-164 : 20 bytes + 1 Report ID byte (0x04-0xA4)
-       // 176-221 :  6 bytes + 1 Report ID byte (0xB0-0xDD) (45 bits + 3 padding bits for 6 bytes total)
+       //   4-49  :  6 bytes + 1 Report ID byte (0x04-0x31) ( 46 bits + 2 padding bits for 6 bytes total)
+       //  51-164 : 20 bytes + 1 Report ID byte (0x33-0xA4) (114 bits + 6 padding bits for 15 bytes total)
+       // 176-221 :  6 bytes + 1 Report ID byte (0xB0-0xDD) ( 46 bits + 2 padding bits for 6 bytes total)
        //
-       // 4-164 (20 bytes/160 bits)
+       // 4-49 (6 bytes/46 bits)
         0x85, 0x03,          //   Report ID (3),
         0x75, 0x01,          //   Report Size (1),
-        0x95, 0xA0,          //   Report Count (160),
+        0x95, 0x2E,          //   Report Count (46),
         0x15, 0x00,          //   Logical Minimum (0),
         0x25, 0x01,          //   Logical Maximum (1),
         0x05, 0x07,          //   Usage Page (Key Codes),
         0x19, 0x04,          //   Usage Minimum (4),
-        0x29, 0xA4,          //   Usage Maximum (164),
+        0x29, 0x31,          //   Usage Maximum (49),
         0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
-       // 176-221 (45 bits)
+       // Should pad 2 bits according to the spec, but OSX doesn't like this -HaaTa
+
+       // 51-164 (15 bytes/160 bits)
         0x85, 0x04,          //   Report ID (4),
         0x75, 0x01,          //   Report Size (1),
+        0x95, 0xA0,          //   Report Count (160),
+        0x15, 0x00,          //   Logical Minimum (0),
+        0x25, 0x01,          //   Logical Maximum (1),
+        0x05, 0x07,          //   Usage Page (Key Codes),
+        0x19, 0x33,          //   Usage Minimum (51),
+        0x29, 0xA4,          //   Usage Maximum (164),
+        0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
+
+       // Should pad 6 bits according to the spec, but OSX doesn't like this -HaaTa
+
+       // 176-221 (6 bytes/46 bits)
+        0x85, 0x05,          //   Report ID (5),
+        0x75, 0x01,          //   Report Size (1),
         0x95, 0x2D,          //   Report Count (45),
         0x15, 0x00,          //   Logical Minimum (0),
         0x25, 0x01,          //   Logical Maximum (1),
@@ -399,10 +421,8 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x29, 0xDD,          //   Usage Maximum (221),
         0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
-       // 176-221 Padding (3 bits)
-        0x75, 0x03,          //   Report Size (3),
-        0x95, 0x01,          //   Report Count (1),
-        0x81, 0x03,          //   Input (Constant),
+       // Should pad 2 bits according to the spec, but OSX doesn't like this -HaaTa
+
         0xc0,                // End Collection - Keyboard
 
        // System Control Collection
@@ -413,7 +433,7 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x05, 0x01,          // Usage Page (Generic Desktop),
         0x09, 0x80,          // Usage (System Control),
         0xA1, 0x01,          // Collection (Application),
-        0x85, 0x05,          //   Report ID (5),
+        0x85, 0x06,          //   Report ID (6),
         0x75, 0x08,          //   Report Size (8),
         0x95, 0x01,          //   Report Count (1),
         0x16, 0x81, 0x00,    //   Logical Minimum (129),
@@ -431,7 +451,7 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x05, 0x0c,          // Usage Page (Consumer),
         0x09, 0x01,          // Usage (Consumer Control),
         0xA1, 0x01,          // Collection (Application),
-        0x85, 0x06,          //   Report ID (6),
+        0x85, 0x07,          //   Report ID (7),
         0x75, 0x10,          //   Report Size (16),
         0x95, 0x01,          //   Report Count (1),
         0x16, 0x20, 0x00,    //   Logical Minimum (32),