Minor documentation corrections for the new HID report item constant defines.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / HID.h

diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h
index f53345f..da2b64e 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/HID.h
+++ b/LUFA/Drivers/USB/Class/Common/HID.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  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


@@ -40,7 +40,7 @@
 /** \ingroup Group_USBClassHID
  *  @defgroup Group_USBClassHIDCommon  Common Class Definitions
  *
 /** \ingroup Group_USBClassHID
  *  @defgroup Group_USBClassHIDCommon  Common Class Definitions
  *

- *  \section Module Description
+ *  \section Sec_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.
  *


@@ -52,6 +52,7 @@
 
        /* Includes: */
                #include "../../HighLevel/StdDescriptors.h"
 
        /* Includes: */
                #include "../../HighLevel/StdDescriptors.h"

+               #include "HIDParser.h"

 
                #include <string.h>
 
 
                #include <string.h>
 


@@ -111,7 +112,7 @@
                #define HID_KEYBOARD_SC_A                                 0x04
                #define HID_KEYBOARD_SC_B                                 0x05
                #define HID_KEYBOARD_SC_C                                 0x06
                #define HID_KEYBOARD_SC_A                                 0x04
                #define HID_KEYBOARD_SC_B                                 0x05
                #define HID_KEYBOARD_SC_C                                 0x06

-               #define HID_KEYBOARD_SC_D                                 0x04
+               #define HID_KEYBOARD_SC_D                                 0x07

                #define HID_KEYBOARD_SC_E                                 0x08
                #define HID_KEYBOARD_SC_F                                 0x09
                #define HID_KEYBOARD_SC_G                                 0x0A
                #define HID_KEYBOARD_SC_E                                 0x08
                #define HID_KEYBOARD_SC_F                                 0x09
                #define HID_KEYBOARD_SC_G                                 0x0A


@@ -239,7 +240,8 @@
                #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN                 0x86
                #define HID_KEYBOARD_SC_INTERNATIONAL1                    0x87
                #define HID_KEYBOARD_SC_INTERNATIONAL2                    0x88
                #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN                 0x86
                #define HID_KEYBOARD_SC_INTERNATIONAL1                    0x87
                #define HID_KEYBOARD_SC_INTERNATIONAL2                    0x88

-               #define HID_KEYBOARD_SC_INTERNATIONAL3                    0x8A
+               #define HID_KEYBOARD_SC_INTERNATIONAL3                    0x89
+               #define HID_KEYBOARD_SC_INTERNATIONAL4                    0x8A

                #define HID_KEYBOARD_SC_INTERNATIONAL5                    0x8B
                #define HID_KEYBOARD_SC_INTERNATIONAL6                    0x8C
                #define HID_KEYBOARD_SC_INTERNATIONAL7                    0x8D
                #define HID_KEYBOARD_SC_INTERNATIONAL5                    0x8B
                #define HID_KEYBOARD_SC_INTERNATIONAL6                    0x8C
                #define HID_KEYBOARD_SC_INTERNATIONAL7                    0x8D


@@ -351,19 +353,19 @@
                /** Enum for the HID class specific control requests that can be issued by the USB bus host. */
                enum HID_ClassRequests_t
                {
                /** Enum for the HID class specific control requests that can be issued by the USB bus host. */
                enum HID_ClassRequests_t
                {

-                       HID_REQ_GetReport   = 0x01, /**< HID class-specific Request to get the current HID report from the device. */
-                       HID_REQ_GetIdle     = 0x02, /**< HID class-specific Request to get the current device idle count. */
-                       HID_REQ_SetReport   = 0x09, /**< HID class-specific Request to set the current HID report to the device. */
-                       HID_REQ_SetIdle     = 0x0A, /**< HID class-specific Request to set the device's idle count. */
-                       HID_REQ_GetProtocol = 0x03, /**< HID class-specific Request to get the current HID report protocol mode. */
-                       HID_REQ_SetProtocol = 0x0B, /**< HID class-specific Request to set the current HID report protocol mode. */
+                       HID_REQ_GetReport       = 0x01, /**< HID class-specific Request to get the current HID report from the device. */
+                       HID_REQ_GetIdle         = 0x02, /**< HID class-specific Request to get the current device idle count. */
+                       HID_REQ_GetProtocol     = 0x03, /**< HID class-specific Request to get the current HID report protocol mode. */
+                       HID_REQ_SetReport       = 0x09, /**< HID class-specific Request to set the current HID report to the device. */
+                       HID_REQ_SetIdle         = 0x0A, /**< HID class-specific Request to set the device's idle count. */
+                       HID_REQ_SetProtocol     = 0x0B, /**< HID class-specific Request to set the current HID report protocol mode. */

                };
 
                /** Enum for the HID class specific descriptor types. */
                enum HID_DescriptorTypes_t
                {
                };
 
                /** Enum for the HID class specific descriptor types. */
                enum HID_DescriptorTypes_t
                {

-                       HID_DTYPE_HID    = 0x21, /**< Descriptor header type value, to indicate a HID class HID descriptor. */
-                       HID_DTYPE_Report = 0x22, /**< Descriptor header type value, to indicate a HID class HID report descriptor. */
+                       HID_DTYPE_HID           = 0x21, /**< Descriptor header type value, to indicate a HID class HID descriptor. */
+                       HID_DTYPE_Report        = 0x22, /**< Descriptor header type value, to indicate a HID class HID report descriptor. */

                };
 
                /** Enum for the different types of HID reports. */
                };
 
                /** Enum for the different types of HID reports. */


@@ -436,7 +438,7 @@
                typedef struct
                {
                        uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
                typedef struct
                {
                        uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of

-                                          *   HID_KEYBOARD_MODIFER_* masks).
+                                          *   \c HID_KEYBOARD_MODIFER_* masks).

                                           */
                        uint8_t Reserved; /**< Reserved for OEM use, always set to 0. */
                        uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys. */
                                           */
                        uint8_t Reserved; /**< Reserved for OEM use, always set to 0. */
                        uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys. */