Add information on the new MouseHostDevice dual role demo to the library documentatio...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HID.c
index 22b2de1..a8e761d 100644 (file)
@@ -34,9 +34,7 @@
 #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 HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
                                 uint8_t* ConfigDescriptorData)\r
 {\r
        uint8_t FoundEndpoints = 0;\r
                                 uint8_t* ConfigDescriptorData)\r
 {\r
        uint8_t FoundEndpoints = 0;\r
@@ -75,7 +73,7 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
                                              DComp_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\r
                {\r
                if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,\r
                                              DComp_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)\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
@@ -103,6 +101,7 @@ uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint
                }\r
        }\r
 \r
                }\r
        }\r
 \r
+       HIDInterfaceInfo->State.LargestReportSize = 8;\r
        HIDInterfaceInfo->State.IsActive = true;\r
        return HID_ENUMERROR_NoError;\r
 }\r
        HIDInterfaceInfo->State.IsActive = true;\r
        return HID_ENUMERROR_NoError;\r
 }\r
@@ -149,64 +148,67 @@ static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor)
        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
+void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
 {\r
 \r
 }\r
 \r
 {\r
 \r
 }\r
 \r
-uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool ControlRequest, uint8_t* ReportID, void* Buffer)\r
+uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID, void* Buffer)\r
+{\r
+       USB_ControlRequest = (USB_Request_Header_t)\r
+       {\r
+               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+               .bRequest      = REQ_SetReport,\r
+               .wValue        = ReportID,\r
+               .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
+               .wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, REPORT_ITEM_TYPE_In),\r
+       };\r
+\r
+       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+       \r
+       return USB_Host_SendControlRequest(Buffer);\r
+}                                                                                         \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 false;\r
 \r
 {\r
        if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
          return false;\r
 \r
-       if (ControlRequest)\r
-       {\r
-               USB_ControlRequest = (USB_Request_Header_t)\r
-               {\r
-                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                       .bRequest      = REQ_SetReport,\r
-                       .wValue        = *ReportID,\r
-                       .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
-                       .wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In),\r
-               };\r
+       uint8_t ErrorCode;\r
 \r
 \r
-               Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-               \r
-               return USB_Host_SendControlRequest(Buffer);\r
+       Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);\r
+       Pipe_Unfreeze();\r
+       \r
+       uint16_t ReportSize;\r
+\r
+       if (HIDInterfaceInfo->State.UsingBootProtocol)\r
+       {\r
+               ReportSize = Pipe_BytesInPipe();\r
        }\r
        else\r
        {\r
        }\r
        else\r
        {\r
-               uint8_t ErrorCode;\r
+               uint8_t ReportID = 0;\r
        \r
        \r
-               Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);\r
-               Pipe_Unfreeze();\r
-               \r
-               uint16_t ReportSize;\r
-\r
-               if (HIDInterfaceInfo->State.UsingBootProtocol)\r
-               {\r
-                       ReportSize = Pipe_BytesInPipe();\r
-               }\r
-               else\r
+               if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)\r
                {\r
                {\r
-                       if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)\r
-                               *ReportID = Pipe_Read_Byte();\r
-                       else\r
-                               *ReportID = 0;\r
-                       \r
-                       ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In);\r
+                       ReportID = Pipe_Read_Byte();\r
+                       *((uint8_t*)Buffer++) = ReportID;\r
                }\r
                }\r
-\r
-               if ((ErrorCode = Pipe_Read_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
-                 return ErrorCode;\r
-               \r
-               Pipe_Freeze();\r
                \r
                \r
-               return PIPE_RWSTREAM_NoError;           \r
+               ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, ReportID, REPORT_ITEM_TYPE_In);\r
        }\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
-uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint8_t ReportID, void* Buffer, uint16_t ReportSize)\r
+uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint8_t ReportID, void* Buffer,\r
+                                const uint16_t ReportSize)\r
 {\r
        if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
          return false;\r
 {\r
        if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
          return false;\r
@@ -239,13 +241,14 @@ uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint8_t
                if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)\r
                  return ErrorCode;\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
 }\r
 \r
                Pipe_Freeze();\r
                \r
                return PIPE_RWSTREAM_NoError;\r
        }\r
 }\r
 \r
-bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\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
        if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
          return false;\r
@@ -255,17 +258,17 @@ bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
        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
        return ReportReceived;\r
 }\r
 \r
        \r
        Pipe_Freeze();\r
        \r
        return ReportReceived;\r
 }\r
 \r
-uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\r
+uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
 {\r
 {\r
-       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
-         return false;\r
+       if (HIDInterfaceInfo->State.UsingBootProtocol)\r
+         return HOST_SENDCONTROL_Successful;\r
 \r
        uint8_t ErrorCode;\r
 \r
 \r
        uint8_t ErrorCode;\r
 \r
@@ -273,7 +276,7 @@ uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
                {\r
                        .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
                        .bRequest      = REQ_SetProtocol,\r
                {\r
                        .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
                        .bRequest      = REQ_SetProtocol,\r
-                       .wValue        = 1,\r
+                       .wValue        = 0,\r
                        .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
                        .wLength       = 0,\r
                };\r
                        .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,\r
                        .wLength       = 0,\r
                };\r
@@ -286,16 +289,14 @@ uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
        if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
          return ErrorCode;\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
        HIDInterfaceInfo->State.UsingBootProtocol = true;\r
        \r
        return HOST_SENDCONTROL_Successful;\r
 }\r
 \r
-uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)\r
+uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo)\r
 {\r
 {\r
-       if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))\r
-         return false;\r
-\r
        uint8_t ErrorCode;\r
 \r
        uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];\r
        uint8_t ErrorCode;\r
 \r
        uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];\r
@@ -314,29 +315,35 @@ uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInf
        if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)\r
          return ErrorCode;\r
          \r
        if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)\r
          return 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
-       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-         return ErrorCode;\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
 \r
-       HIDInterfaceInfo->State.UsingBootProtocol = false;\r
+               HIDInterfaceInfo->State.UsingBootProtocol = false;\r
+       }\r
        \r
        if (HIDInterfaceInfo->Config.HIDParserData == NULL)\r
          return HID_ERROR_LOGICAL;\r
        \r
        if (HIDInterfaceInfo->Config.HIDParserData == NULL)\r
          return HID_ERROR_LOGICAL;\r
-         \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
        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
 \r
        return 0;\r
 }\r
 \r