Fix CDC blocking streams in Host mode locking up when the device is removed.

[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 25348f6..fcea5ae 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r

 \r
 \r

-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -89,7 +89,8 @@
                                                                      */\r
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
                                                                          *  second buffer of the same size within the driver so that subsequent reports\r
                                                                      */\r
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
                                                                          *  second buffer of the same size within the driver so that subsequent reports\r

-                                                                         *  can be compared.\r
+                                                                         *  can be compared. If the user app is to determine when reports are to be sent\r
+                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored.\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
                                } 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


@@ -147,15 +148,16 @@
                         *  \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 any). If multiple reports are not sent via the\r
                         *                 given HID interface, this parameter should be ignored.\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 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[in] ReportType  Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature\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
                         *\r
                         *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within\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
                         *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent\r
                         *\r
                         *  \return Boolean true to force the sending of the report even if it is identical to the previous report and still within\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) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2)\r
-                                                                ATTR_NON_NULL_PTR_ARG(3) ATTR_NON_NULL_PTR_ARG(4);\r
+                                                     const uint8_t ReportType, void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                                ATTR_NON_NULL_PTR_ARG(2) ATTR_NON_NULL_PTR_ARG(4) ATTR_NON_NULL_PTR_ARG(5);\r

                        \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
                        \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