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 9a56304..e4a919d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -28,25 +28,25 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r
-/** \ingroup Group_USBDeviceClassDrivers\r
- *  @defgroup Group_USBClassHIDDevice HID Device Class Driver - LUFA/Drivers/Class/Device/HID.h\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
  *\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
- *  Functions, macros, variables, enums and types related to the management of USB HID Class interfaces\r
- *  within a USB device.\r
+ *  Device Mode USB Class driver framework interface, for the HID USB Class driver.\r
  *\r
  *  @{\r
  */\r
  \r
  *\r
  *  @{\r
  */\r
  \r
-#ifndef _HID_CLASS_H_\r
-#define _HID_CLASS_H_\r
+#ifndef _HID_CLASS_DEVICE_H_\r
+#define _HID_CLASS_DEVICE_H_\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
 \r
        /* Includes: */\r
                #include "../../USB.h"\r
+               #include "../Common/HID.h"\r
 \r
                #include <string.h>\r
 \r
 \r
                #include <string.h>\r
 \r
@@ -55,80 +55,90 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\r
 \r
-       /* Macros: */\r
-               /** HID Class Specific Request to get the current HID report from the device. */\r
-               #define REQ_GetReport      0x01\r
-\r
-               /** HID Class Specific Request to get the current device idle count. */\r
-               #define REQ_GetIdle        0x02\r
-\r
-               /** HID Class Specific Request to set the current HID report to the device. */\r
-               #define REQ_SetReport      0x09\r
-\r
-               /** HID Class Specific Request to set the device's idle count. */\r
-               #define REQ_SetIdle        0x0A\r
-\r
-               /** HID Class Specific Request to get the current HID report protocol mode. */\r
-               #define REQ_GetProtocol    0x03\r
-\r
-               /** HID Class Specific Request to set the current HID report protocol mode. */\r
-               #define REQ_SetProtocol    0x0B\r
-\r
-               /** Descriptor header type value, to indicate a HID class HID descriptor. */\r
-               #define DTYPE_HID          0x21\r
-               \r
-               /** Descriptor header type value, to indicate a HID class HID report descriptor. */\r
-               #define DTYPE_Report       0x22\r
-\r
-       /* Type Defines: */\r
-               /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID\r
-                *  specification for details on the structure elements.\r
-                */\r
-               typedef struct\r
-               {\r
-                       USB_Descriptor_Header_t               Header;\r
-                               \r
-                       uint16_t                              HIDSpec;\r
-                       uint8_t                               CountryCode;\r
-               \r
-                       uint8_t                               TotalReportDescriptors;\r
-\r
-                       uint8_t                               HIDReportType;\r
-                       uint16_t                              HIDReportLength;\r
-               } USB_Descriptor_HID_t;\r
-\r
-               /** Type define for the data type used to store HID report descriptor elements. */\r
-               typedef uint8_t USB_Descriptor_HIDReport_Datatype_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. The contents of this structure should be set to their correct\r
-                *  values when used, or ommitted to force the library to use default values.\r
-                */\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  ReportOUTEndpointNumber; /**< Endpoint number of the HID interface's OUT report endpoint, if used */\r
-                       uint16_t ReportOUTEndpointSize;  /**< Size in bytes of the HID interface's OUT report endpoint, if used */\r
+       /* Public Interface - May be used in end-application: */\r
+               /* Type Defines: */\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 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
+                       /** Configures the endpoints of a given HID interface, ready for use. This should be linked to the library\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[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
+                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
                        \r
                        \r
-                       uint8_t  ReportINBufferSize;\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_t;\r
-\r
-       /* Function Prototypes: */\r
-               bool USB_HID_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
-               void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
-               void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
-               \r
-               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData);\r
-               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize);\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[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
+                        *  \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
+                       /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\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[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
+                       uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
+\r
+                       /** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to\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[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
+                        *  \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
+                       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