projects / pub / USBasp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Use sane ANSI terminal escape codes for the Host mode demos, so that they do not...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / HID.h
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index b4c400f..e4a919d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver\r
  *\r
 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver\r
  *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/Class/Device/HID.c\r
+ *\r
  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.\r
  *\r
@@ -53,45 +57,35 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
-                       /** Configuration information structure for \ref USB_ClassInfo_HID_Device_t HID device interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               uint8_t  InterfaceNumber; /**< Interface number of the HID interface within the device */\r
-\r
-                               uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
-                               uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */\r
-                               \r
-                               uint8_t  ReportINBufferSize; /**< Size of the largest possible report to send to the host, for\r
-                                                             *   buffer allocation purposes\r
-                                                             */\r
-                       } USB_ClassInfo_HID_Device_Config_t;\r
-               \r
-                       /** Current State information structure for \ref USB_ClassInfo_HID_Device_t HID device interface structures. */\r
-                       typedef struct\r
-                       {\r
-                               bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */\r
-                               uint16_t IdleCount; /**< Report idle period, in ms, set by the host */\r
-                               uint16_t IdleMSRemaining; /**< Total number of ms remaining before the idle period elapses */                   \r
-                       } USB_ClassInfo_HID_Device_State_t;\r
-\r
                        /** Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\r
                        /** Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
                         */\r
                        typedef struct\r
                        {\r
-                               const USB_ClassInfo_HID_Device_Config_t Config; /**< Config data for the USB class interface within\r
-                                                                                *   the device. All elements in this section\r
-                                                                                *   <b>must</b> be set or the interface will fail\r
-                                                                                *   to enumerate and operate correctly.\r
-                                                                                */\r
-                                                                                                                        \r
-                               USB_ClassInfo_HID_Device_State_t State; /**< State data for the USB class interface within\r
-                                                                        *   the device. All elements in this section\r
-                                                                        *   <b>may</b> be set to initial values, but may\r
-                                                                        *   also be ignored to default to sane values when\r
-                                                                        *   the interface is enumerated.\r
-                                                                        */\r
+                               const struct\r
+                               {\r
+                                       uint8_t  InterfaceNumber; /**< Interface number of the HID interface within the device */\r
+\r
+                                       uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
+                                       uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */\r
+                                       \r
+                                       uint8_t  ReportINBufferSize; /**< Size of the largest possible report to send to the host, for\r
+                                                                                                 *   buffer allocation purposes\r
+                                                                                                 */\r
+                               } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+                                          *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+                                          */                                                                            \r
+                               struct\r
+                               {\r
+                                       bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */\r
+                                       uint16_t IdleCount; /**< Report idle period, in ms, set by the host */\r
+                                       uint16_t IdleMSRemaining; /**< Total number of ms remaining before the idle period elapsed - this should be\r
+                                                                                          *   decremented by the user application if non-zero each millisecond */                      \r
+                               } State; /**< State data for the USB class interface within the device. All elements in this section\r
+                                         *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
+                                         *   the interface is enumerated.\r
+                                         */\r
                        } USB_ClassInfo_HID_Device_t;\r
        \r
                /* Function Prototypes: */\r
                        } USB_ClassInfo_HID_Device_t;\r
        \r
                /* Function Prototypes: */\r
@@ -99,7 +93,7 @@
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given HID interface is selected.\r
                         *\r
                         *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given HID interface is selected.\r
                         *\r
-                        *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
                         *\r
                         *  \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
                         */\r
@@ -108,14 +102,14 @@
                        /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
                         *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
                         *\r
                        /** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be\r
                         *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
                         *\r
-                        *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */             \r
                        void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
 \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
                         */             \r
                        void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
 \r
                        /** General management task for a given HID class interface, required for the correct operation of the interface. This should\r
                         *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
                         *\r
-                        *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */\r
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
                        \r
                         */\r
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
                        \r
@@ -123,11 +117,11 @@
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
                         *  user is responsible for the creation of the next HID input report to be sent to the host.\r
                         *\r
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
                         *  user is responsible for the creation of the next HID input report to be sent to the host.\r
                         *\r
-                        *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
-                        *  \param ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
-                        *                   be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
-                        *                   given HID interface, this parameter should be ignored.\r
-                        *  \param ReportData  Pointer to a buffer where the generated HID report should be stored.\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                        *  \param[in,out] ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
+                        *                 be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
+                        *                 given HID interface, this parameter should be ignored.\r
+                        *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored.\r
                         *\r
                         *  \return  Number of bytes in the generated input report, or zero if no report is to be sent\r
                         */\r
                         *\r
                         *  \return  Number of bytes in the generated input report, or zero if no report is to be sent\r
                         */\r
@@ -137,14 +131,14 @@
                         *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
                         *  the user is responsible for the processing of the received HID output report from the host.\r
                         *\r
                         *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
                         *  the user is responsible for the processing of the received HID output report from the host.\r
                         *\r
-                        *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
-                        *  \param ReportID  Report ID of the received output report. If multiple reports are not received via the given HID\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                        *  \param[in] ReportID  Report ID of the received output report. If multiple reports are not received via the given HID\r
                         *                   interface, this parameter should be ignored.\r
                         *                   interface, this parameter should be ignored.\r
-                        *  \param ReportData  Pointer to a buffer where the received HID report is stored.\r
-                        *  \param ReportSize  Size in bytes of the received report from the host.\r
+                        *  \param[in] ReportData  Pointer to a buffer where the received HID report is stored.\r
+                        *  \param[in] ReportSize  Size in bytes of the received report from the host.\r
                         */\r
                         */\r
-                       void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
-                                                                                                         uint16_t ReportSize);\r
+                       void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                                                 const void* ReportData, const uint16_t ReportSize);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
USB isp AVR programmer