Add FatFS library to the Webserver project, extend the HTTP server so that it now...

[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 c1a68f8..3aaf809 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/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
-\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
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\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


@@ -34,6 +34,7 @@
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Host/HID.c\r
  *  \section Sec_Dependencies Module Source Dependencies\r
  *  The following files must be built with any user project that uses this module:\r
  *    - LUFA/Drivers/USB/Class/Host/HID.c\r

+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c\r

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


@@ -57,7 +58,7 @@
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some HID Host functions, indicating a logical (and not hardware) error */\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some HID Host functions, indicating a logical (and not hardware) error */\r

-                       #define MS_ERROR_UNSUPPORTED              0xC0\r
+                       #define HID_ERROR_LOGICAL              0x80\r

        \r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r
        \r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r


@@ -69,14 +70,24 @@
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe */\r
                                const struct\r
                                {\r
                                        uint8_t  DataINPipeNumber; /**< Pipe number of the HID interface's IN data pipe */\r

+                                       bool     DataINPipeDoubleBank; /** Indicates if the HID interface's IN data pipe should use double banking */\r
+\r

                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */\r
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */\r

+                                       bool     DataOUTPipeDoubleBank; /** Indicates if the HID interface's OUT data pipe should use double banking */\r

 \r
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific\r
 \r
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific\r

-                                                                       *   boot subclass protocol is required (e.g. keyboard, mouse), or\r
-                                                                       *   leave as 0 to match against the first HID interface found\r
+                                                                       *   boot subclass protocol is required, either \ref HID_BOOT_MOUSE_PROTOCOL,\r
+                                                                                                       *   \ref HID_BOOT_KEYBOARD_PROTOCOL or \ref HID_NON_BOOT_PROTOCOL if any\r
+                                                                                                       *   HID device should be enumerated by the interface\r

                                                                        */\r
                                                                        */\r

+                                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r

                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol\r
                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol\r

-                                                                         *   is not used */\r
+                                                                         *   is not used\r
+                                                                                                         *\r
+                                                                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined,\r
+                                                                         *        this method is unavailable.\r
+                                                                         */\r
+                                       #endif\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
                                           */\r


@@ -91,10 +102,16 @@
                                        uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe */\r
                                        \r
                                        uint16_t DataINPipeSize; /**< Size in bytes of the HID interface's IN data pipe */\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe */\r
                                        \r

-                                       bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot\r
-                                                                   *   Protocol when enabled via \ref USB_HID_Host_SetProtocol()\r
+                                       bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot\r
+                                                                   *   Protocol when enabled via \ref HID_Host_SetBootProtocol()\r

                                                                    */\r
                                                                    */\r

+                                       bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a separate OUT data pipe for\r
+                                                                *   OUT reports, or if OUT reports are sent via the control pipe instead.\r
+                                                                */\r
+                                       bool UsingBootProtocol; /**< Indicates that the interface is currently initialized in Boot Protocol mode */\r

                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r

+                                       \r
+                                       uint8_t LargestReportSize; /**< Largest report the device will send, in bytes */\r

                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
                                                  *   the interface is enumerated.\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                  *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
                                                  *   the interface is enumerated.\r


@@ -102,6 +119,7 @@
                        } USB_ClassInfo_HID_Host_t;\r
 \r
                /* Enums: */\r
                        } USB_ClassInfo_HID_Host_t;\r
 \r
                /* Enums: */\r

+                       /** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */\r

                        enum HIDHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                        enum HIDHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r


@@ -112,14 +130,142 @@
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r

-                       void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
-                       uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,\r
-                                                       uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       /** Host interface configuration routine, to configure a given HID host interface instance using the Configuration\r
+                        *  Descriptor read from an attached USB device. This function automatically updates the given HID Host instance's\r
+                        *  state values and configures the pipes required to communicate with the interface if it is found within the\r
+                        *  device. This should be called once after the stack has enumerated the attached device, while the host state\r
+                        *  machine is in the Addressed state.\r
+                        *\r
+                        *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call\r
+                        *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor\r
+                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor\r
+                        *\r
+                        *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
+                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
+\r

 \r
 \r

-                       bool    HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.\r
+                        *  \r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
+                        *        can generate.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] Buffer  Buffer to store the received report into\r
+                        *\r
+                        *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
+                        */\r
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)\r
+                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
+\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                       /** Receives a HID IN report from the attached device, by the report ID.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] ReportID  Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch\r
+                        *  \param[in] Buffer  Buffer to store the received report into\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                                          void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r
+                       #endif\r

                        \r
                        \r

-                       uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol) ATTR_NON_NULL_PTR_ARG(1);\r
-               \r
+                       /** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's\r
+                        *  Control pipe if not.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed\r
+                        *        from the parameter list of this function.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] ReportID  Report ID of the report to send to the device, or 0 if the device does not use report IDs\r
+                        *  \param[in] Buffer  Buffer containing the report to send to the attached device\r
+                        *  \param[in] ReportSize  Report size in bytes to send to the attached device\r
+                        *\r
+                        *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in\r
+                        *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise\r
+                        */\r
+                       uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                                                       const uint8_t ReportID,\r
+                       #endif\r
+                                                       void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                                                       ATTR_NON_NULL_PTR_ARG(3);\r
+                       #else\r
+                                                       ATTR_NON_NULL_PTR_ARG(2);\r
+                       #endif\r
+\r
+                       /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
+                        *\r
+                        *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
+                        *        call will fail.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return Boolean true if a report has been received, false otherwise\r
+                        */\r
+                       bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       \r
+                       /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.\r
+                        *\r
+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called\r
+                        *        to explicitly place the attached device into boot protocol mode before use.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return \ref HID_ERROR_LOGICAL if the device does not support Boot Protocol mode, a value from the\r
+                        *          \ref USB_Host_SendControlErrorCodes_t enum otherwise\r
+                        */\r
+                       uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                       /** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves\r
+                        *  and parses the device's HID report descriptor, so that the size of each report can be determined in advance.\r
+                        *\r
+                        *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID\r
+                        *        Report Parser this function references <b>must</b> be implemented in the user code.\r
+                        *\r
+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum if an error occurs while retrieving the HID\r
+                        *          Report descriptor or the setting of the Report protocol, \ref HID_ERROR_LOGICAL if the HID interface does\r
+                        *          not have a valid \ref HID_ReportInfo_t structure set in its configuration, a mask of \ref HID_ERROR_LOGICAL\r
+                        *          and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
+                        */\r
+                       uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+                       #endif\r
+                       \r
+               /* Inline Functions: */\r
+                       /** General management task for a given Human Interface Class host class interface, required for the correct operation of\r
+                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        */\r
+                       static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo);\r
+                       static inline void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
+                       {\r
+                               (void)HIDInterfaceInfo;\r
+                       }               \r
+\r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r


@@ -130,9 +276,9 @@
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_HID_CLASS_HOST_C)\r
 \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_HID_CLASS_HOST_C)\r

-                               static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
-                               static uint8_t DComp_NextHID(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
-                               static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r
+                               static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);\r

                        #endif  \r
        #endif  \r
        \r
                        #endif  \r
        #endif  \r
        \r