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 & 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_ClearIN();
 204                 Pipe_Freeze();
 205
 206                 return PIPE_RWSTREAM_NoError;
 207         }
 208 }
 209
 210 uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint8_t ReportID, void* Buffer, uint16_t ReportSize)
 211 {
 212         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 213           return false;
 214
 215         if (HIDInterfaceInfo->State.DeviceUsesOUTPipe)
 216         {
 217                 USB_ControlRequest = (USB_Request_Header_t)
 218                 {
 219                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 220                         .bRequest      = REQ_SetReport,
 221                         .wValue        = ReportID,
 222                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 223                         .wLength       = ReportSize,
 224                 };
 225
 226                 Pipe_SelectPipe(PIPE_CONTROLPIPE);
 227
 228                 return USB_Host_SendControlRequest(Buffer);
 229         }
 230         else
 231         {
 232                 uint8_t ErrorCode;
 233
 234                 Pipe_SelectPipe(HIDInterfaceInfo->Config.DataOUTPipeNumber);
 235                 Pipe_Unfreeze();
 236
 237                 if (ReportID)
 238                   Pipe_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);
 239
 240                 if ((ErrorCode = Pipe_Write_Stream_LE(Buffer, ReportSize, NO_STREAM_CALLBACK)) != PIPE_RWSTREAM_NoError)
 241                   return ErrorCode;
 242
 243                 Pipe_ClearOUT();
 244                 Pipe_Freeze();
 245
 246                 return PIPE_RWSTREAM_NoError;
 247         }
 248 }
 249
 250 bool HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 251 {
 252         if ((USB_HostState != HOST_STATE_Configured) || !(HIDInterfaceInfo->State.IsActive))
 253           return false;
 254
 255         bool ReportReceived;
 256
 257         Pipe_SelectPipe(HIDInterfaceInfo->Config.DataINPipeNumber);
 258         Pipe_Unfreeze();
 259
 260         ReportReceived = Pipe_IsINReceived();
 261
 262         Pipe_Freeze();
 263
 264         return ReportReceived;
 265 }
 266
 267 uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 268 {
 269         uint8_t ErrorCode;
 270
 271         USB_ControlRequest = (USB_Request_Header_t)
 272                 {
 273                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 274                         .bRequest      = REQ_SetProtocol,
 275                         .wValue        = 0,
 276                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 277                         .wLength       = 0,
 278                 };
 279
 280         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 281
 282         if (!(HIDInterfaceInfo->State.SupportsBootProtocol))
 283           return HID_ERROR_LOGICAL;
 284
 285         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 286           return ErrorCode;
 287
 288         HIDInterfaceInfo->State.UsingBootProtocol = true;
 289
 290         return HOST_SENDCONTROL_Successful;
 291 }
 292
 293 uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo)
 294 {
 295         uint8_t ErrorCode;
 296
 297         uint8_t HIDReportData[HIDInterfaceInfo->State.HIDReportSize];
 298
 299         USB_ControlRequest = (USB_Request_Header_t)
 300                 {
 301                         .bmRequestType = (REQDIR_DEVICETOHOST | REQTYPE_STANDARD | REQREC_INTERFACE),
 302                         .bRequest      = REQ_GetDescriptor,
 303                         .wValue        = (DTYPE_Report << 8),
 304                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 305                         .wLength       = HIDInterfaceInfo->State.HIDReportSize,
 306                 };
 307
 308         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 309
 310         if ((ErrorCode = USB_Host_SendControlRequest(HIDReportData)) != HOST_SENDCONTROL_Successful)
 311           return ErrorCode;
 312
 313         USB_ControlRequest = (USB_Request_Header_t)
 314                 {
 315                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 316                         .bRequest      = REQ_SetProtocol,
 317                         .wValue        = 1,
 318                         .wIndex        = HIDInterfaceInfo->State.InterfaceNumber,
 319                         .wLength       = 0,
 320                 };
 321
 322         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 323           return ErrorCode;
 324
 325         HIDInterfaceInfo->State.UsingBootProtocol = false;
 326
 327         if (HIDInterfaceInfo->Config.HIDParserData == NULL)
 328           return HID_ERROR_LOGICAL;
 329
 330         if ((ErrorCode = USB_ProcessHIDReport(HIDReportData, HIDInterfaceInfo->State.HIDReportSize,
 331                                               HIDInterfaceInfo->Config.HIDParserData)) != HID_PARSE_Successful)
 332         {
 333                 return HID_ERROR_LOGICAL | ErrorCode;
 334         }
 335
 336         return 0;
 337 }
 338
 339 #endif