Added stdio.h stream examples for the virtual CDC UART in the CDC host demos.

[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 d995c09..dee892d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -60,6 +60,10 @@
                        /** 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
                        /** 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
+                        *  \note Due to technical limitations, the HID device class driver does not utilize a seperate OUT\r
+                        *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to\r
+                        *        the device via the control endpoint.\r

                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r


@@ -98,42 +102,42 @@
                         *  \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
                         *  containing the given HID interface is selected.\r
                         *\r
                         *  \ref EVENT_USB_Device_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
+                        *  \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

-                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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_Device_UnhandledControlRequest() event.\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_Device_UnhandledControlRequest() event.\r
                         *\r

-                        *  \param[in,out] 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
                         */             \r

-                       void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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
                        /** 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
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state\r

                         */\r
                         */\r

-                       void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \r
                        /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r
                         *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended\r
                         *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via\r
                         *  \ref USB_Device_EnableSOFEvents();.\r
                         *\r
                        \r
                        /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r
                         *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended\r
                         *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via\r
                         *  \ref USB_Device_EnableSOFEvents();.\r
                         *\r

-                        *  \param[in,out] 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
                         */\r

-                       void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
+                       void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

                        \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 driver callback for the user creation of a HID IN 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
                         *  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] 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
                         *  \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
+                        *                 be set to the report ID of the generated HID input report (if any). 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
                         *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent\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
                         *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent\r


@@ -142,20 +146,20 @@
                         *          the idle period (useful for devices which report relative movement), false otherwise\r
                         */\r
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
                         *          the idle period (useful for devices which report relative movement), false otherwise\r
                         */\r
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r

-                                                     void* ReportData, uint16_t* ReportSize);\r
+                                                     void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1, 2, 3, 4);\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
+                       /** HID class driver callback for the user processing of a received HID OUT 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
                         *  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,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
                         *  \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
+                                                                 const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\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