]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Output/pjrcUSB/avr/usb_keyboard_serial.h
projects / kiibohd-controller.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Merge remote-tracking branch 'upstream/master'
[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 6dc727fb74fcb00da4148c6ecfb63683baa0c235..0c5c5850b01844a4b101a8a72ad5f223e33a7aa5 100644 (file)
--- a/Output/pjrcUSB/avr/usb_keyboard_serial.h
+++ b/Output/pjrcUSB/avr/usb_keyboard_serial.h
@@ -46,7 +46,7 @@
 // ----- Function Declarations -----
 
 // Basic USB Configuration
-void usb_init();                       // initialize everything
+uint8_t usb_init();                    // initialize everything
 uint8_t usb_configured();              // is the USB port configured
 
 // Keyboard HID Functions
@@ -337,19 +337,8 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x09, 0x06,          // Usage (Keyboard),
         0xA1, 0x01,          // Collection (Application) - Keyboard,
 
-       // Modifier Byte
-        0x85, 0x01,          //   Report ID (1),
-        0x75, 0x01,          //   Report Size (1),
-        0x95, 0x08,          //   Report Count (8),
-        0x15, 0x00,          //   Logical Minimum (0),
-        0x25, 0x01,          //   Logical Maximum (1),
-        0x05, 0x07,          //   Usage Page (Key Codes),
-        0x19, 0xE0,          //   Usage Minimum (224),
-        0x29, 0xE7,          //   Usage Maximum (231),
-        0x81, 0x02,          //   Input (Data, Variable, Absolute),
-
        // LED Report
-        0x85, 0x02,          //   Report ID (2),
+        0x85, 0x01,          //   Report ID (1),
         0x75, 0x01,          //   Report Size (1),
         0x95, 0x05,          //   Report Count (5),
         0x05, 0x08,          //   Usage Page (LEDs),
@@ -370,19 +359,39 @@ 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)
+       // 50 (ISO \ due to \ bug) and 156 (Clear due to Delete bug) 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)
        //
-       // Packing of bitmaps are as follows:
-       //   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)
+       // 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)
+       //  - DO NOT use Report IDs, Windows 8.1 will not update keyboard correctly (modifiers disappear)
+       //    (all other OSs, including OSX work fine...)
+       //    (you can use them *iff* you only have 1 per collection)
+       //  - Mac OSX and Windows 8.1 are extremely picky about padding
        //
-       // 4-49 (6 bytes/46 bits)
-        0x85, 0x03,          //   Report ID (3),
+       // Packing of bitmaps are as follows:
+       //   4-49  :  6 bytes (0x04-0x31) ( 46 bits + 2 padding bits for 6 bytes total)
+       //  51-155 : 14 bytes (0x33-0x9B) (105 bits + 6 padding bits for 15 bytes total)
+       // 157-164 :  1 byte  (0x9D-0xA4) (  8 bits)
+       // 176-221 :  6 bytes (0xB0-0xDD) ( 46 bits + 2 padding bits for 6 bytes total)
+       // 224-231 :  1 byte  (0xE0-0xE7) (  8 bits)
+
+       // Modifier Byte
         0x75, 0x01,          //   Report Size (1),
-        0x95, 0xA0,          //   Report Count (160),
+        0x95, 0x08,          //   Report Count (8),
+        0x15, 0x00,          //   Logical Minimum (0),
+        0x25, 0x01,          //   Logical Maximum (1),
+        0x05, 0x07,          //   Usage Page (Key Codes),
+        0x19, 0xE0,          //   Usage Minimum (224),
+        0x29, 0xE7,          //   Usage Maximum (231),
+        0x81, 0x02,          //   Input (Data, Variable, Absolute),
+
+       // 4-49 (6 bytes/46 bits) - MainKeys
+        0x75, 0x01,          //   Report Size (1),
+        0x95, 0x2E,          //   Report Count (46),
         0x15, 0x00,          //   Logical Minimum (0),
         0x25, 0x01,          //   Logical Maximum (1),
         0x05, 0x07,          //   Usage Page (Key Codes),
@@ -391,30 +400,38 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
        // Padding (2 bits)
-        0x75, 0x02,          //   Report Size (2),
-        0x95, 0x01,          //   Report Count (1),
-        0x81, 0x03,          //   Input (Constant),
+       0x75, 0x02,          //   Report Size (2),
+       0x95, 0x01,          //   Report Count (1),
+       0x81, 0x03,          //   Input (Constant),
 
-       // 51-164 (15 bytes/160 bits)
-        0x85, 0x04,          //   Report ID (4),
+       // 51-155 (14 bytes/105 bits) - SecondaryKeys
         0x75, 0x01,          //   Report Size (1),
-        0x95, 0xA0,          //   Report Count (160),
+        0x95, 0x69,          //   Report Count (105),
         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),
+        0x29, 0x9B,          //   Usage Maximum (155),
         0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
-       // Padding (6 bits)
-        0x75, 0x06,          //   Report Size (6),
-        0x95, 0x01,          //   Report Count (1),
-        0x81, 0x03,          //   Input (Constant),
+       // Padding (7 bits)
+       0x75, 0x07,          //   Report Size (7),
+       0x95, 0x01,          //   Report Count (1),
+       0x81, 0x03,          //   Input (Constant),
+
+       // 157-164 (1 byte/8 bits) - TertiaryKeys
+        0x75, 0x01,          //   Report Size (1),
+        0x95, 0x08,          //   Report Count (8),
+        0x15, 0x00,          //   Logical Minimum (0),
+        0x25, 0x01,          //   Logical Maximum (1),
+        0x05, 0x07,          //   Usage Page (Key Codes),
+        0x19, 0x9D,          //   Usage Minimum (157),
+        0x29, 0xA4,          //   Usage Maximum (164),
+        0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
-       // 176-221 (6 bytes/46 bits)
-        0x85, 0x05,          //   Report ID (5),
+       // 176-221 (6 bytes/46 bits) - QuartiaryKeys
         0x75, 0x01,          //   Report Size (1),
-        0x95, 0x2D,          //   Report Count (45),
+        0x95, 0x2E,          //   Report Count (46),
         0x15, 0x00,          //   Logical Minimum (0),
         0x25, 0x01,          //   Logical Maximum (1),
         0x05, 0x07,          //   Usage Page (Key Codes),
@@ -423,9 +440,9 @@ static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
         0x81, 0x02,          //   Input (Data, Variable, Absolute, Bitfield),
 
        // Padding (2 bits)
-        0x75, 0x02,          //   Report Size (2),
-        0x95, 0x01,          //   Report Count (1),
-        0x81, 0x03,          //   Input (Constant),
+       0x75, 0x02,          //   Report Size (2),
+       0x95, 0x01,          //   Report Count (1),
+       0x81, 0x03,          //   Input (Constant),
         0xc0,                // End Collection - Keyboard
 
        // System Control Collection
@@ -436,7 +453,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, 0x02,          //   Report ID (2),
         0x75, 0x08,          //   Report Size (8),
         0x95, 0x01,          //   Report Count (1),
         0x16, 0x81, 0x00,    //   Logical Minimum (129),
@@ -454,7 +471,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, 0x03,          //   Report ID (3),
         0x75, 0x10,          //   Report Size (16),
         0x95, 0x01,          //   Report Count (1),
         0x16, 0x20, 0x00,    //   Logical Minimum (32),
Unnamed repository; edit this file 'description' to name the repository.