Fix up the incomplete Webserver project so that it integrates with the uIP stack...

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

diff --git a/LUFA/Drivers/USB/Class/Host/HID.c b/LUFA/Drivers/USB/Class/Host/HID.c
index a42f8af..3cd9394 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.c
+++ b/LUFA/Drivers/USB/Class/Host/HID.c
@@ -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,18 +34,18 @@
 #define INCLUDE_FROM_HID_CLASS_HOST_C\r
 #include "HID.h"\r
 \r
 #define INCLUDE_FROM_HID_CLASS_HOST_C\r
 #include "HID.h"\r
 \r

-#warning The HID Host mode Class driver is currently incomplete and is for preview purposes only.\r
-\r
-uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
-                                uint8_t* ConfigDescriptorData)\r
+uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
+                                void* ConfigDescriptorData)\r

 {\r
 {\r

-       uint8_t  FoundEndpoints = 0;\r
+       uint8_t FoundEndpoints = 0;\r

 \r
        memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));\r
 \r
        if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
          return HID_ENUMERROR_InvalidConfigDescriptor;\r
        \r
 \r
        memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));\r
 \r
        if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)\r
          return HID_ENUMERROR_InvalidConfigDescriptor;\r
        \r

+       USB_Descriptor_Interface_t* CurrentHIDInterface;\r
+       \r

        do\r
        {\r
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
        do\r
        {\r
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r


@@ -53,16 +53,27 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint
                {\r
                        return HID_ENUMERROR_NoHIDInterfaceFound;\r
                }\r
                {\r
                        return HID_ENUMERROR_NoHIDInterfaceFound;\r
                }\r

-       } while (HIDInterfaceInfo->Config.MatchInterfaceProtocol &&\r
-                DESCRIPTOR_PCAST(ConfigDescriptorData,\r
-                                 USB_Descriptor_Interface_t)->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol);\r
+               \r
+               CurrentHIDInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);\r
+       } while (HIDInterfaceInfo->Config.HIDInterfaceProtocol &&\r
+                (CurrentHIDInterface->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol));\r
+\r
+       HIDInterfaceInfo->State.InterfaceNumber      = CurrentHIDInterface->InterfaceNumber;\r
+       HIDInterfaceInfo->State.SupportsBootProtocol = (CurrentHIDInterface->SubClass != HID_NON_BOOT_PROTOCOL);\r
+\r
+       if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, DComp_NextHID) != DESCRIPTOR_SEARCH_COMP_Found)\r
+       {\r
+               return HID_ENUMERROR_NoHIDDescriptorFound;\r
+       }\r
+\r
+       HIDInterfaceInfo->State.HIDReportSize = DESCRIPTOR_CAST(ConfigDescriptorData, USB_HID_Descriptor_t).HIDReportLength;\r

 \r
 \r

-       while (FoundEndpoints != ((1 << HID_FOUND_DATAPIPE_IN) | (1 << HID_FOUND_DATAPIPE_OUT)))\r
+       while (FoundEndpoints != (HID_FOUND_DATAPIPE_IN | HID_FOUND_DATAPIPE_OUT))\r

        {\r
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
        {\r
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r

-                                             DComp_HID_Host_NextInterfaceHIDDataEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
+                                             DComp_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r

                {\r
                {\r

-                       if (FoundEndpoints == (1 << HID_FOUND_DATAPIPE_IN))\r
+                       if (FoundEndpoints & HID_FOUND_DATAPIPE_IN)\r

                          break;\r
                                \r
                        return HID_ENUMERROR_EndpointsNotFound;\r
                          break;\r
                                \r
                        return HID_ENUMERROR_EndpointsNotFound;\r


@@ -73,24 +84,31 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint
                if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
                {\r
                        Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r
                if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)\r
                {\r
                        Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,\r

-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
+                                                          HIDInterfaceInfo->Config.DataINPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);\r
+                       HIDInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;\r

                        \r
                        \r

-                       FoundEndpoints |= (1 << HID_FOUND_DATAPIPE_IN);\r
+                       FoundEndpoints |= HID_FOUND_DATAPIPE_IN;\r

                }\r
                else\r
                {\r
                        Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,\r
                }\r
                else\r
                {\r
                        Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,\r

-                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);\r
+                                                          EndpointData->EndpointAddress, EndpointData->EndpointSize,\r
+                                                          HIDInterfaceInfo->Config.DataOUTPipeDoubleBank ? PIPE_BANK_DOUBLE : PIPE_BANK_SINGLE);\r
+                       HIDInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;\r

                        \r
                        \r

-                       FoundEndpoints |= (1 << HID_FOUND_DATAPIPE_OUT);                \r
+                       HIDInterfaceInfo->State.DeviceUsesOUTPipe = true;\r
+                       \r
+                       FoundEndpoints |= HID_FOUND_DATAPIPE_OUT;               \r

                }\r
        }\r
 \r
                }\r
        }\r
 \r

-       HIDInterfaceInfo->State.Active = true;\r
+       HIDInterfaceInfo->State.LargestReportSize = 8;\r
+       HIDInterfaceInfo->State.IsActive = true;\r

        return HID_ENUMERROR_NoError;\r
 }\r
 \r
        return HID_ENUMERROR_NoError;\r
 }\r
 \r

-static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)\r
+static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor)\r

 {\r
        if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
        {\r
 {\r
        if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
        {\r


@@ -104,7 +122,17 @@ static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r

-static uint8_t DComp_HID_Host_NextInterfaceHIDDataEndpoint(void* CurrentDescriptor)\r
+static uint8_t DComp_NextHID(void* const CurrentDescriptor)\r
+{\r
+       if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_HID)\r
+         return DESCRIPTOR_SEARCH_Found;\r
+       else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)\r
+         return DESCRIPTOR_SEARCH_Fail;\r
+       else\r
+         return DESCRIPTOR_SEARCH_NotFound;      \r
+}\r
+\r
+static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor)\r

 {\r
        if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
        {\r
 {\r
        if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)\r
        {\r


@@ -122,26 +150,210 @@ static uint8_t DComp_HID_Host_NextInterfaceHIDDataEndpoint(void* CurrentDescript
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r
        return DESCRIPTOR_SEARCH_NotFound;\r
 }\r
 \r

-void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID, void* Buffer)\r

 {\r
 {\r

+       USB_ControlRequest = (USB_Request_Header_t)\r
+       {\r
+               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+               .bRequest      = REQ_SetReport,\r
+               .wValue        = (REPORT_ITEM_TYPE_In << 8) | ReportID,\r
+               .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+               .wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, REPORT_ITEM_TYPE_In),\r
+       };\r

 \r
 \r

+       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+       \r
+       return USB_Host_SendControlRequest(Buffer);\r
+}                                                                                         \r
+#endif\r
+                                                                                  \r
+uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)\r
+{\r
+       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
+         return PIPE_READYWAIT_DeviceDisconnected;\r
+\r
+       uint8_t ErrorCode;\r
+\r
+       Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);\r
+       Pipe_Unfreeze();\r
+       \r
+       uint16_t ReportSize;\r
+\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+       if (!(HIDInterfaceInfo->State.UsingBootProtocol))\r
+       {\r
+               uint8_t ReportID = 0;\r
+       \r
+               if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)\r
+               {\r
+                       ReportID = Pipe_Read_Byte();\r
+                       *((uint8_t*)Buffer++) = ReportID;\r
+               }\r
+               \r
+               ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, REPORT_ITEM_TYPE_In);\r
+       }\r
+       else\r
+#endif\r
+       {\r
+               ReportSize = Pipe_BytesInPipe();\r
+       }\r
+\r
+       if ((ErrorCode = Pipe_Read_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
+         return ErrorCode;\r
+        \r
+       Pipe_ClearIN();         \r
+       Pipe_Freeze();\r
+       \r
+       return PIPE_RWSTREAM_NoError;\r

 }\r
 \r
 }\r
 \r

-bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\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)\r

 {\r
 {\r

-       bool ReportReceived;\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
+         return false;\r

 \r
 \r

-       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.Active))\r
+       if (HIDInterfaceInfo->State.DeviceUsesOUTPipe)\r
+       {\r
+               uint8_t ErrorCode;\r
+       \r
+               Pipe_SelectPipe(HIDInterfaceInfo->Config.DataOUTPipeNumber);\r
+               Pipe_Unfreeze();\r
+               \r
+               if (ReportID)\r
+                 Pipe_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);\r
+               \r
+               if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
+                 return ErrorCode;\r
+               \r
+               Pipe_ClearOUT();\r
+               Pipe_Freeze();\r
+               \r
+               return PIPE_RWSTREAM_NoError;\r
+       }\r
+       else\r
+#endif\r
+       {\r
+               USB_ControlRequest = (USB_Request_Header_t)\r
+               {\r
+                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                       .bRequest      = REQ_SetReport,\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                       .wValue        = (REPORT_ITEM_TYPE_Out << 8) | ReportID,\r
+#else\r
+                       .wValue        = 0,\r
+#endif\r
+                       .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+                       .wLength       = ReportSize,\r
+               };\r
+\r
+               Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+               \r
+               return USB_Host_SendControlRequest(Buffer);\r
+       }\r
+}\r
+\r
+bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
+{\r
+       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r

          return false;\r
 \r
          return false;\r
 \r

+       bool ReportReceived;\r
+\r

        Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);\r
        Pipe_Unfreeze();\r
        \r
        Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);\r
        Pipe_Unfreeze();\r
        \r

-       ReportReceived = Pipe_IsReadWriteAllowed();\r
+       ReportReceived = Pipe_IsINReceived();\r

        \r
        Pipe_Freeze();\r
        \r
        Pipe_Freeze();\r

-\r
+       \r

        return ReportReceived;\r
 }\r
 \r
        return ReportReceived;\r
 }\r
 \r

+uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
+{\r
+       uint8_t ErrorCode;\r
+\r
+       USB_ControlRequest = (USB_Request_Header_t)\r
+               {\r
+                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                       .bRequest      = REQ_SetProtocol,\r
+                       .wValue        = 0,\r
+                       .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+                       .wLength       = 0,\r
+               };\r
+\r
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+       \r
+       if (!(HIDInterfaceInfo->State.SupportsBootProtocol))\r
+         return HID_ERROR_LOGICAL;\r
+\r
+       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
+         return ErrorCode;\r
+\r
+       HIDInterfaceInfo->State.LargestReportSize = 8;\r
+       HIDInterfaceInfo->State.UsingBootProtocol = true;\r
+       \r
+       return HOST_SENDCONTROL_Successful;\r
+}\r
+\r
+#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
+{\r
+       uint8_t ErrorCode;\r
+\r
+       uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];\r
+       \r
+       USB_ControlRequest = (USB_Request_Header_t)\r
+               {\r
+                       .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),\r
+                       .bRequest      = REQ_GetDescriptor,\r
+                       .wValue        = (DTYPE_Report << 8),\r
+                       .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+                       .wLength       = HIDInterfaceInfo->State.HIDReportSize,\r
+               };\r
+\r
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
+       if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)\r
+         return ErrorCode;\r
+         \r
+       if (HIDInterfaceInfo->State.UsingBootProtocol)\r
+       {\r
+               USB_ControlRequest = (USB_Request_Header_t)\r
+                       {\r
+                               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                               .bRequest      = REQ_SetProtocol,\r
+                               .wValue        = 1,\r
+                               .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+                               .wLength       = 0,\r
+                       };\r
+\r
+               if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
+                 return ErrorCode;\r
+\r
+               HIDInterfaceInfo->State.UsingBootProtocol = false;\r
+       }\r
+       \r
+       if (HIDInterfaceInfo->Config.HIDParserData == NULL)\r
+         return HID_ERROR_LOGICAL;\r
+               \r
+       if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,\r
+                                             HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)\r
+       {\r
+               return HID_ERROR_LOGICAL | ErrorCode;\r
+       }\r
+\r
+       uint8_t LargestReportSizeBits = HIDInterfaceInfo->Config.HIDParserData->LargestReportSizeBits;\r
+       HIDInterfaceInfo->State.LargestReportSize = (LargestReportSizeBits >> 3) + ((LargestReportSizeBits & 0x07) != 0);\r
+\r
+       return 0;\r
+}\r
+#endif\r
+\r

 #endif\r
 #endif\r