Remove USB_MODE_* macros, replace with a semantically linked USB_Modes_t enum.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HID.h

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 70728d8..8a16a4f 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -42,8 +42,8 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:

- *    - LUFA/Drivers/USB/Class/Host/HID.c
- *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
+ *    - LUFA/Drivers/USB/Class/Host/HID.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>

  *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  \section Module Description
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.


@@ -92,9 +92,8 @@
                                        bool     DataOUTPipeDoubleBank; /**< Indicates if the HID interface's OUT data pipe should use double banking. */
 
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific
                                        bool     DataOUTPipeDoubleBank; /**< Indicates if the HID interface's OUT data pipe should use double banking. */
 
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific

-                                                                       *   boot subclass protocol is required, either \ref HID_BOOT_MOUSE_PROTOCOL,
-                                                                                                       *   \ref HID_BOOT_KEYBOARD_PROTOCOL or \ref HID_NON_BOOT_PROTOCOL if any
-                                                                                                       *   HID device should be enumerated by the interface.
+                                                                       *   boot subclass protocol is required, a value from the \ref HID_BootProtocols_t
+                                                                       *   enum.

                                                                        */
                                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol
                                                                        */
                                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol


@@ -136,13 +135,11 @@
 
                /* Enums: */
                        /** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */
 
                /* Enums: */
                        /** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */

-                       enum HIDHost_EnumerationFailure_ErrorCodes_t
+                       enum HID_Host_EnumerationFailure_ErrorCodes_t

                        {
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
                                HID_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
                        {
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
                                HID_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */

-                               HID_ENUMERROR_NoHIDInterfaceFound        = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor. */
-                               HID_ENUMERROR_NoHIDDescriptorFound       = 3, /**< The HID descriptor was not found in the device's HID interface. */
-                               HID_ENUMERROR_EndpointsNotFound          = 4, /**< Compatible HID endpoints were not found in the device's HID interface. */
+                               HID_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible HID interface was not found in the device's Configuration Descriptor. */

                        };
        
                /* Function Prototypes: */
                        };
        
                /* Function Prototypes: */


@@ -152,6 +149,11 @@
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *
                         *  device. This should be called once after the stack has enumerated the attached device, while the host state
                         *  machine is in the Addressed state.
                         *

+                        *  \note The pipe index numbers as given in the interface's configuration structure must not overlap with any other
+                        *        interface, or pipe bank corruption will occur. Gaps in the allocated pipe numbers or non-sequential indexes
+                        *        within a single interface is allowed, but no two interfaces of any type have have interleaved pipe indexes.
+                        *        \n\n
+                        *

                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *
                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *


@@ -159,9 +161,10 @@
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
                         *
                         *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
                         *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
                         *

-                        *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum.
+                        *  \return A value from the \ref HID_Host_EnumerationFailure_ErrorCodes_t enum.

                         */
                         */

-                       uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,
+                       uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
+                                                       uint16_t ConfigDescriptorSize,

                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 
 
                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 
 


@@ -178,8 +181,8 @@
                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */
                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum.
                         */

-                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)
-                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
+                                                      void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);

 
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                        /** Receives a HID IN report from the attached device, by the report ID.
 
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                        /** Receives a HID IN report from the attached device, by the report ID.


@@ -195,7 +198,8 @@
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
                         */

-                       uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,
+                       uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,
+                                                          const uint8_t ReportID,

                                                           void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
                        #endif
                        
                                                           void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
                        #endif
                        


@@ -210,7 +214,7 @@
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
                         *  \param[in]     ReportID          Report ID of the report to send to the device, or 0 if the device does not use report IDs.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state.
                         *  \param[in]     ReportID          Report ID of the report to send to the device, or 0 if the device does not use report IDs.

-                        *  \param[in]     ReportType        Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature.
+                        *  \param[in]     ReportType        Type of report to issue to the device, either \ref HID_REPORT_ITEM_Out or \ref HID_REPORT_ITEM_Feature.

                         *  \param[in]     Buffer            Buffer containing the report to send to the attached device.
                         *  \param[in]     ReportSize        Report size in bytes to send to the attached device.
                         *
                         *  \param[in]     Buffer            Buffer containing the report to send to the attached device.
                         *  \param[in]     ReportSize        Report size in bytes to send to the attached device.
                         *


@@ -221,7 +225,9 @@
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        const uint8_t ReportID,
                        #endif
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        const uint8_t ReportID,
                        #endif

-                                                       const uint8_t ReportType, void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
+                                                       const uint8_t ReportType,
+                                                       void* Buffer,
+                                                       const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)

                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        ATTR_NON_NULL_PTR_ARG(4);
                        #else
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        ATTR_NON_NULL_PTR_ARG(4);
                        #else


@@ -288,14 +294,11 @@
        #if !defined(__DOXYGEN__)
                /* Macros: */
                        #define HID_INTERFACE_CLASS             0x03
        #if !defined(__DOXYGEN__)
                /* Macros: */
                        #define HID_INTERFACE_CLASS             0x03

-                       
-                       #define HID_FOUND_DATAPIPE_IN           (1 << 0)
-                       #define HID_FOUND_DATAPIPE_OUT          (1 << 1)

 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HID_CLASS_HOST_C)
                                static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HID_CLASS_HOST_C)
                                static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

-                               static uint8_t DCOMP_HID_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_HID_Host_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

                                static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
                        #endif  
        #endif  
                                static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
                        #endif  
        #endif