Complete TPI protocol code to enter and exit TPI programming mode for the ATTINY...

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


@@ -73,6 +73,7 @@
 \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  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

+                                       bool     ReportINEndpointDoubleBank; /** Indicates if the HID interface's IN report endpoint should use double banking */\r

                                        \r
                                        void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be\r
                                                                      *  stored by the driver, for comparison purposes to detect report changes that\r
                                        \r
                                        void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be\r
                                                                      *  stored by the driver, for comparison purposes to detect report changes that\r


@@ -88,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


@@ -111,11 +113,11 @@
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state\r
                         *\r
                         *\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
+                        *  \return Boolean true if the endpoints were successfully configured, false otherwise\r

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


@@ -146,14 +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, 2, 3, 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


@@ -166,7 +170,8 @@
                         *  \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] 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) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                                 const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
+                                                                 ATTR_NON_NULL_PTR_ARG(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