Break device mode class driver interfaces into seperate config and state structs...

[pub/lufa.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 6ed6b38..b4c400f 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -52,6 +52,48 @@
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\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
+                               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
+                       } 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
                /* 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


@@ -61,21 +103,21 @@
                         *\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

-                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
+                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\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
                         */             \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
                         */             \r

-                       void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\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
                         */\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
                         */\r

-                       void HID_Device_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\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
                        \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


@@ -89,7 +131,7 @@
                         *\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

-                       uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\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
 \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


@@ -101,7 +143,7 @@
                         *  \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
                         */\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
                         */\r

-                       void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
+                       void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r

                                                                                                          uint16_t ReportSize);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                                                                                                          uint16_t ReportSize);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r