Enhanced class drivers to use the same public/private section seperations as other...

[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 a4317d7..6ed6b38 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -51,57 +51,58 @@
                        extern "C" {\r
                #endif\r
 \r
                        extern "C" {\r
                #endif\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 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_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
-               void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
+       /* Public Interface - May be used in end-application: */\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 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_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
+                       void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\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
-               \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 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
-                *\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
+                       /** 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
+                       \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 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
+                        *\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

 \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 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
-                *                   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
-                */\r
-               void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
-                                                         uint16_t ReportSize);\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 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
+                        *                   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
+                        */\r
+                       void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,\r
+                                                                                                         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