Reduce struct name pollution - group typedef struct names by class driver name where...
[pub/lufa.git] / LUFA / Drivers / USB / Class / Device / HID.h
index 00d73a9..61e5eed 100644 (file)
 \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 elapsed - this should be\r
-                                                          *   decremented by the user application if non-zero each millisecond */                      \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
+                               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