LUFA/Drivers/USB/Class/Host/HID.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #include "../../HighLevel/USBMode.h"
  32 #if defined(USB_CAN_BE_HOST)
  33
  34 #define INCLUDE_FROM_HID_CLASS_HOST_C
  35 #include "HID.h"
  36
  37 #warning The HID Host mode Class driver is currently incomplete and is for preview purposes only.
  38
  39 uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorSize,
  40                                 uint8_t* ConfigDescriptorData)
  41 {
  42         uint8_t FoundEndpoints = 0;
  43
  44         memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));
  45
  46         if (DESCRIPTOR_TYPE(ConfigDescriptorData) != DTYPE_Configuration)
  47           return HID_ENUMERROR_InvalidConfigDescriptor;
  48
  49         USB_Descriptor_Interface_t* CurrentHIDInterface;
  50
  51         do
  52         {
  53                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  54                                                                           DComp_HID_Host_NextHIDInterface) != DESCRIPTOR_SEARCH_COMP_Found)
  55                 {
  56                         return HID_ENUMERROR_NoHIDInterfaceFound;
  57                 }
  58
  59                 CurrentHIDInterface = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Interface_t);
  60         } while (HIDInterfaceInfo->Config.HIDInterfaceProtocol &&
  61                  (CurrentHIDInterface->Protocol != HIDInterfaceInfo->Config.HIDInterfaceProtocol));
  62
  63         HIDInterfaceInfo->State.InterfaceNumber      = CurrentHIDInterface->InterfaceNumber;
  64         HIDInterfaceInfo->State.SupportsBootProtocol = (CurrentHIDInterface->SubClass != HID_NON_BOOT_PROTOCOL);
  65
  66         if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData, DComp_NextHID) != DESCRIPTOR_SEARCH_COMP_Found)
  67         {
  68                 return HID_ENUMERROR_NoHIDDescriptorFound;
  69         }
  70
  71         HIDInterfaceInfo->State.HIDReportSize = DESCRIPTOR_CAST(ConfigDescriptorData, USB_HID_Descriptor_t).HIDReportLength;
  72
  73         while (FoundEndpoints != (HID_FOUND_DATAPIPE_IN | HID_FOUND_DATAPIPE_OUT))
  74         {
  75                 if (USB_GetNextDescriptorComp(&ConfigDescriptorSize, &ConfigDescriptorData,
  76                                               DComp_HID_Host_NextHIDInterfaceEndpoint) != DESCRIPTOR_SEARCH_COMP_Found)
  77                 {
  78                         if (FoundEndpoints == (1 << HID_FOUND_DATAPIPE_IN))
  79                           break;
  80
  81                         return HID_ENUMERROR_EndpointsNotFound;
  82                 }
  83
  84                 USB_Descriptor_Endpoint_t* EndpointData = DESCRIPTOR_PCAST(ConfigDescriptorData, USB_Descriptor_Endpoint_t);
  85
  86                 if (EndpointData->EndpointAddress & ENDPOINT_DESCRIPTOR_DIR_IN)
  87                 {
  88                         Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataINPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_IN,
  89                                                            EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
  90                         HIDInterfaceInfo->State.DataINPipeSize = EndpointData->EndpointSize;
  91
  92                         FoundEndpoints |= HID_FOUND_DATAPIPE_IN;
  93                 }
  94                 else
  95                 {
  96                         Pipe_ConfigurePipe(HIDInterfaceInfo->Config.DataOUTPipeNumber, EP_TYPE_INTERRUPT, PIPE_TOKEN_OUT,
  97                                                            EndpointData->EndpointAddress, EndpointData->EndpointSize, PIPE_BANK_SINGLE);
  98                         HIDInterfaceInfo->State.DataOUTPipeSize = EndpointData->EndpointSize;
  99
 100                         HIDInterfaceInfo->State.DeviceUsesOUTPipe = true;
 101
 102                         FoundEndpoints |= HID_FOUND_DATAPIPE_OUT;
 103                 }
 104         }
 105
 106         HIDInterfaceInfo->State.IsActive = true;
 107         return HID_ENUMERROR_NoError;
 108 }
 109
 110 static uint8_t DComp_HID_Host_NextHIDInterface(void* CurrentDescriptor)
 111 {
 112         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 113         {
 114                 USB_Descriptor_Interface_t* CurrentInterface = DESCRIPTOR_PCAST(CurrentDescriptor,
 115                                                                                 USB_Descriptor_Interface_t);
 116
 117                 if (CurrentInterface->Class == HID_INTERFACE_CLASS)
 118                   return DESCRIPTOR_SEARCH_Found;
 119         }
 120
 121         return DESCRIPTOR_SEARCH_NotFound;
 122 }
 123
 124 static uint8_t DComp_NextHID(void* CurrentDescriptor)
 125 {
 126         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_HID)
 127           return DESCRIPTOR_SEARCH_Found;
 128         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 129           return DESCRIPTOR_SEARCH_Fail;
 130         else
 131           return DESCRIPTOR_SEARCH_NotFound;
 132 }
 133
 134 static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* CurrentDescriptor)
 135 {
 136         if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
 137         {
 138                 USB_Descriptor_Endpoint_t* CurrentEndpoint = DESCRIPTOR_PCAST(CurrentDescriptor,
 139                                                                               USB_Descriptor_Endpoint_t);
 140
 141                 if (!(Pipe_IsEndpointBound(CurrentEndpoint->EndpointAddress)))
 142                   return DESCRIPTOR_SEARCH_Found;
 143         }
 144         else if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Interface)
 145         {
 146                 return DESCRIPTOR_SEARCH_Fail;
 147         }
 148
 149         return DESCRIPTOR_SEARCH_NotFound;
 150 }
 151
 152 void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 153 {
 154
 155 }
 156
 157 uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool ControlRequest, uint8_t* ReportID, void* Buffer)
 158 {
 159         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 160           return false;
 161
 162         if (ControlRequest)
 163         {
 164                 USB_ControlRequest = (USB_Request_Header_t)
 165                 {
 166                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 167                         .bRequest      = REQ_SetReport,
 168                         .wValue        = *ReportID,
 169                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 170                         .wLength       = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In),
 171                 };
 172
 173                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 174
 175                 return USB_Host_SendControlRequest(Buffer);
 176         }
 177         else
 178         {
 179                 uint8_t ErrorCode;
 180
 181                 Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);
 182                 Pipe_Unfreeze();
 183
 184                 uint16_t ReportSize;
 185
 186                 if (HIDInterfaceInfo->State.UsingBootProtocol)
 187                 {
 188                         ReportSize = Pipe_BytesInPipe();
 189                 }
 190                 else
 191                 {
 192                         if (HIDInterfaceInfo->Config.HIDParserData->UsingReportIDs)
 193                                 *ReportID = Pipe_Read_Byte();
 194                         else
 195                                 *ReportID = 0;
 196
 197                         ReportSize = USB_GetHIDReportSize(HIDInterfaceInfo->Config.HIDParserData, *ReportID, REPORT_ITEM_TYPE_In);
 198                 }
 199
 200                 if ((ErrorCode = Pipe_Read_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
 201                   return ErrorCode;
 202
 203                 Pipe_Freeze();
 204
 205                 return PIPE_RWSTREAM_NoError;
 206         }
 207 }
 208
 209 uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint8_t ReportID, void* Buffer, uint16_t ReportSize)
 210 {
 211         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 212           return false;
 213
 214         if (HIDInterfaceInfo->State.DeviceUsesOUTPipe)
 215         {
 216                 USB_ControlRequest = (USB_Request_Header_t)
 217                 {
 218                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 219                         .bRequest      = REQ_SetReport,
 220                         .wValue        = ReportID,
 221                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 222                         .wLength       = ReportSize,
 223                 };
 224
 225                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 226
 227                 return USB_Host_SendControlRequest(Buffer);
 228         }
 229         else
 230         {
 231                 uint8_t ErrorCode;
 232
 233                 Pipe_SelectPipe(HIDInterfaceInfo->Config.DataOUTPipeNumber);
 234                 Pipe_Unfreeze();
 235
 236                 if (ReportID)
 237                   Pipe_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);
 238
 239                 if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
 240                   return ErrorCode;
 241
 242                 Pipe_Freeze();
 243
 244                 return PIPE_RWSTREAM_NoError;
 245         }
 246 }
 247
 248 bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 249 {
 250         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 251           return false;
 252
 253         bool ReportReceived;
 254
 255         Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);
 256         Pipe_Unfreeze();
 257
 258         ReportReceived = Pipe_IsReadWriteAllowed();
 259
 260         Pipe_Freeze();
 261
 262         return ReportReceived;
 263 }
 264
 265 uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 266 {
 267         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 268           return false;
 269
 270         uint8_t ErrorCode;
 271
 272         USB_ControlRequest = (USB_Request_Header_t)
 273                 {
 274                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 275                         .bRequest      = REQ_SetProtocol,
 276                         .wValue        = 1,
 277                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 278                         .wLength       = 0,
 279                 };
 280
 281         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 282
 283         if (!(HIDInterfaceInfo->State.SupportsBootProtocol))
 284           return HID_ERROR_LOGICAL;
 285
 286         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 287           return ErrorCode;
 288
 289         HIDInterfaceInfo->State.UsingBootProtocol = true;
 290
 291         return HOST_SENDCONTROL_Successful;
 292 }
 293
 294 uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 295 {
 296         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 297           return false;
 298
 299         uint8_t ErrorCode;
 300
 301         uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];
 302
 303         USB_ControlRequest = (USB_Request_Header_t)
 304                 {
 305                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
 306                         .bRequest      = REQ_GetDescriptor,
 307                         .wValue        = (DTYPE_Report << 8),
 308                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 309                         .wLength       = HIDInterfaceInfo->State.HIDReportSize,
 310                 };
 311
 312         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 313
 314         if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)
 315           return ErrorCode;
 316
 317         USB_ControlRequest = (USB_Request_Header_t)
 318                 {
 319                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 320                         .bRequest      = REQ_SetProtocol,
 321                         .wValue        = 0,
 322                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 323                         .wLength       = 0,
 324                 };
 325
 326         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 327           return ErrorCode;
 328
 329         HIDInterfaceInfo->State.UsingBootProtocol = false;
 330
 331         if (HIDInterfaceInfo->Config.HIDParserData == NULL)
 332           return HID_ERROR_LOGICAL;
 333
 334         if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,
 335                                               HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)
 336         {
 337                 return HID_ERROR_LOGICAL | ErrorCode;
 338         }
 339
 340         return 0;
 341 }
 342
 343 #endif