projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Minor documentation improvements.
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / HIDClassCommon.h
diff --git a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
index c3fe3ed..534dec7 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
+++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -40,7 +40,7 @@
 /** \ingroup Group_USBClassHID
  *  \defgroup Group_USBClassHIDCommon  Common Class Definitions
  *
 /** \ingroup Group_USBClassHID
  *  \defgroup Group_USBClassHIDCommon  Common Class Definitions
  *
- *  \section Sec_ModDescription Module Description
+ *  \section Sec_USBClassHIDCommon_ModDescription Module Description
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  HID Class.
  *
  *  Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
  *  HID Class.
  *
@@ -103,8 +103,11 @@
                /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
                #define HID_KEYBOARD_LED_SCROLLLOCK                       (1 << 2)
 
                /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
                #define HID_KEYBOARD_LED_SCROLLLOCK                       (1 << 2)
 
-               /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
-               #define HID_KEYBOARD_LED_KATANA                           (1 << 3)
+               /** Constant for a keyboard output report LED byte, indicating that the host's COMPOSE mode is currently set. */
+               #define HID_KEYBOARD_LED_COMPOSE                          (1 << 3)
+
+               /** Constant for a keyboard output report LED byte, indicating that the host's KANA mode is currently set. */
+               #define HID_KEYBOARD_LED_KANA                             (1 << 4)
                //@}
 
                /** \name Keyboard Standard Report Key Scan-codes */
                //@}
 
                /** \name Keyboard Standard Report Key Scan-codes */
@@ -209,8 +212,9 @@
                #define HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT               0x62
                #define HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE             0x63
                #define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE         0x64
                #define HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT               0x62
                #define HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE             0x63
                #define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE         0x64
+               #define HID_KEYBOARD_SC_APPLICATION                       0x65
                #define HID_KEYBOARD_SC_POWER                             0x66
                #define HID_KEYBOARD_SC_POWER                             0x66
-               #define HID_KEYBOARD_SC_EQUAL_SIGN                        0x67
+               #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN                 0x67
                #define HID_KEYBOARD_SC_F13                               0x68
                #define HID_KEYBOARD_SC_F14                               0x69
                #define HID_KEYBOARD_SC_F15                               0x6A
                #define HID_KEYBOARD_SC_F13                               0x68
                #define HID_KEYBOARD_SC_F14                               0x69
                #define HID_KEYBOARD_SC_F15                               0x6A
@@ -241,7 +245,7 @@
                #define HID_KEYBOARD_SC_LOCKING_NUM_LOCK                  0x83
                #define HID_KEYBOARD_SC_LOCKING_SCROLL_LOCK               0x84
                #define HID_KEYBOARD_SC_KEYPAD_COMMA                      0x85
                #define HID_KEYBOARD_SC_LOCKING_NUM_LOCK                  0x83
                #define HID_KEYBOARD_SC_LOCKING_SCROLL_LOCK               0x84
                #define HID_KEYBOARD_SC_KEYPAD_COMMA                      0x85
-               #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN                 0x86
+               #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400           0x86
                #define HID_KEYBOARD_SC_INTERNATIONAL1                    0x87
                #define HID_KEYBOARD_SC_INTERNATIONAL2                    0x88
                #define HID_KEYBOARD_SC_INTERNATIONAL3                    0x89
                #define HID_KEYBOARD_SC_INTERNATIONAL1                    0x87
                #define HID_KEYBOARD_SC_INTERNATIONAL2                    0x88
                #define HID_KEYBOARD_SC_INTERNATIONAL3                    0x89
@@ -367,7 +371,7 @@
                                        HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
                                        HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
                                        HID_RI_REPORT_COUNT(8, 3),              \
                                        HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
                                        HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
                                        HID_RI_REPORT_COUNT(8, 3),              \
-                                       HID_RI_REPORT_SIZE(8, ((((MinAxisVal >= -0xFF) && (MaxAxisVal <= 0xFF)) ? 8 : 16))), \
+                                       HID_RI_REPORT_SIZE(8, (((MinAxisVal >= -128) && (MaxAxisVal <= 127)) ? 8 : 16)), \
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
                                HID_RI_END_COLLECTION(0),                   \
                                HID_RI_USAGE_PAGE(8, 0x09),                 \
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
                                HID_RI_END_COLLECTION(0),                   \
                                HID_RI_USAGE_PAGE(8, 0x09),                 \
@@ -378,7 +382,7 @@
                                HID_RI_REPORT_SIZE(8, 0x01),                \
                                HID_RI_REPORT_COUNT(8, Buttons),            \
                                HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
                                HID_RI_REPORT_SIZE(8, 0x01),                \
                                HID_RI_REPORT_COUNT(8, Buttons),            \
                                HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
-                               HID_RI_REPORT_SIZE(8, (8 - (Buttons % 8))), \
+                               HID_RI_REPORT_SIZE(8, (Buttons % 8) ? (8 - (Buttons % 8)) : 0), \
                                HID_RI_REPORT_COUNT(8, 0x01),               \
                                HID_RI_INPUT(8, HID_IOF_CONSTANT),          \
                        HID_RI_END_COLLECTION(0)
                                HID_RI_REPORT_COUNT(8, 0x01),               \
                                HID_RI_INPUT(8, HID_IOF_CONSTANT),          \
                        HID_RI_END_COLLECTION(0)
@@ -424,10 +428,10 @@
                                HID_RI_REPORT_SIZE(8, 0x03),                \
                                HID_RI_OUTPUT(8, HID_IOF_CONSTANT),         \
                                HID_RI_LOGICAL_MINIMUM(8, 0x00),            \
                                HID_RI_REPORT_SIZE(8, 0x03),                \
                                HID_RI_OUTPUT(8, HID_IOF_CONSTANT),         \
                                HID_RI_LOGICAL_MINIMUM(8, 0x00),            \
-                               HID_RI_LOGICAL_MAXIMUM(8, 0x65),            \
+                               HID_RI_LOGICAL_MAXIMUM(8, 0xFF),            \
                                HID_RI_USAGE_PAGE(8, 0x07),                 \
                                HID_RI_USAGE_MINIMUM(8, 0x00),              \
                                HID_RI_USAGE_PAGE(8, 0x07),                 \
                                HID_RI_USAGE_MINIMUM(8, 0x00),              \
-                               HID_RI_USAGE_MAXIMUM(8, 0x65),              \
+                               HID_RI_USAGE_MAXIMUM(8, 0xFF),              \
                                HID_RI_REPORT_COUNT(8, MaxKeys),            \
                                HID_RI_REPORT_SIZE(8, 0x08),                \
                                HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE), \
                                HID_RI_REPORT_COUNT(8, MaxKeys),            \
                                HID_RI_REPORT_SIZE(8, 0x08),                \
                                HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE), \
@@ -472,7 +476,7 @@
                                        HID_RI_REPORT_SIZE(8, 0x01),            \
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
                                        HID_RI_REPORT_COUNT(8, 0x01),           \
                                        HID_RI_REPORT_SIZE(8, 0x01),            \
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
                                        HID_RI_REPORT_COUNT(8, 0x01),           \
-                                       HID_RI_REPORT_SIZE(8, (8 - (Buttons % 8))), \
+                                       HID_RI_REPORT_SIZE(8, (Buttons % 8) ? (8 - (Buttons % 8)) : 0), \
                                        HID_RI_INPUT(8, HID_IOF_CONSTANT),      \
                                        HID_RI_USAGE_PAGE(8, 0x01),             \
                                        HID_RI_USAGE(8, 0x30),                  \
                                        HID_RI_INPUT(8, HID_IOF_CONSTANT),      \
                                        HID_RI_USAGE_PAGE(8, 0x01),             \
                                        HID_RI_USAGE(8, 0x30),                  \
@@ -482,7 +486,7 @@
                                        HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
                                        HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
                                        HID_RI_REPORT_COUNT(8, 0x02),           \
                                        HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
                                        HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
                                        HID_RI_REPORT_COUNT(8, 0x02),           \
-                                       HID_RI_REPORT_SIZE(8, ((((MinAxisVal >= -0xFF) && (MaxAxisVal <= 0xFF)) ? 8 : 16))), \
+                                       HID_RI_REPORT_SIZE(8, (((MinAxisVal >= -128) && (MaxAxisVal <= 127)) ? 8 : 16)), \
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | (AbsoluteCoords ? HID_IOF_ABSOLUTE : HID_IOF_RELATIVE)), \
                                HID_RI_END_COLLECTION(0),                   \
                        HID_RI_END_COLLECTION(0)
                                        HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | (AbsoluteCoords ? HID_IOF_ABSOLUTE : HID_IOF_RELATIVE)), \
                                HID_RI_END_COLLECTION(0),                   \
                        HID_RI_END_COLLECTION(0)
@@ -582,7 +586,10 @@
                {
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 
                {
                        USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
 
-                       uint16_t                HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to. */
+                       uint16_t                HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to.
+                                                         *
+                                                         *   \see \ref VERSION_BCD() utility macro.
+                                                         */
                        uint8_t                 CountryCode; /**< Country code of the localized device, or zero if universal. */
 
                        uint8_t                 TotalReportDescriptors; /**< Total number of HID report descriptors for the interface. */
                        uint8_t                 CountryCode; /**< Country code of the localized device, or zero if universal. */
 
                        uint8_t                 TotalReportDescriptors; /**< Total number of HID report descriptors for the interface. */
@@ -608,7 +615,10 @@
                                                   *   given by the specific class.
                                                   */
 
                                                   *   given by the specific class.
                                                   */
 
-                       uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device complies to. */
+                       uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device complies to.
+                                         *
+                                         *   \see \ref VERSION_BCD() utility macro.
+                                         */
                        uint8_t  bCountryCode; /**< Country code of the localized device, or zero if universal. */
 
                        uint8_t  bNumDescriptors; /**< Total number of HID report descriptors for the interface. */
                        uint8_t  bCountryCode; /**< Country code of the localized device, or zero if universal. */
 
                        uint8_t  bNumDescriptors; /**< Total number of HID report descriptors for the interface. */
USB isp AVR programmer