LUFA/Drivers/USB/Class/Device/HIDClassDevice.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 #define  __INCLUDE_FROM_USB_DRIVER
  32 #include "../../Core/USBMode.h"
  33
  34 #if defined(USB_CAN_BE_DEVICE)
  35
  36 #define  __INCLUDE_FROM_HID_DRIVER
  37 #define  __INCLUDE_FROM_HID_DEVICE_C
  38 #include "HIDClassDevice.h"
  39
  40 void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
  41 {
  42         if (!(Endpoint_IsSETUPReceived()))
  43           return;
  44
  45         if (USB_ControlRequest.wIndex != HIDInterfaceInfo->Config.InterfaceNumber)
  46           return;
  47
  48         switch (USB_ControlRequest.bRequest)
  49         {
  50                 case HID_REQ_GetReport:
  51                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  52                         {
  53                                 uint16_t ReportSize = 0;
  54                                 uint8_t  ReportID   = (USB_ControlRequest.wValue & 0xFF);
  55                                 uint8_t  ReportType = (USB_ControlRequest.wValue >> 8) - 1;
  56                                 uint8_t  ReportData[HIDInterfaceInfo->Config.PrevReportINBufferSize];
  57
  58                                 memset(ReportData, 0, sizeof(ReportData));
  59
  60                                 CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportType, ReportData, &ReportSize);
  61
  62                                 if (HIDInterfaceInfo->Config.PrevReportINBuffer != NULL)
  63                                 {
  64                                         memcpy(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportData,
  65                                                HIDInterfaceInfo->Config.PrevReportINBufferSize);
  66                                 }
  67
  68                                 Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);
  69
  70                                 Endpoint_ClearSETUP();
  71                                 Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
  72                                 Endpoint_ClearOUT();
  73                         }
  74
  75                         break;
  76                 case HID_REQ_SetReport:
  77                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  78                         {
  79                                 uint16_t ReportSize = USB_ControlRequest.wLength;
  80                                 uint8_t  ReportID   = (USB_ControlRequest.wValue & 0xFF);
  81                                 uint8_t  ReportType = (USB_ControlRequest.wValue >> 8) - 1;
  82                                 uint8_t  ReportData[ReportSize];
  83
  84                                 Endpoint_ClearSETUP();
  85                                 Endpoint_Read_Control_Stream_LE(ReportData, ReportSize);
  86                                 Endpoint_ClearIN();
  87
  88                                 CALLBACK_HID_Device_ProcessHIDReport(HIDInterfaceInfo, ReportID, ReportType,
  89                                                                      &ReportData[ReportID ? 1 : 0], ReportSize - (ReportID ? 1 : 0));
  90                         }
  91
  92                         break;
  93                 case HID_REQ_GetProtocol:
  94                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  95                         {
  96                                 Endpoint_ClearSETUP();
  97                                 while (!(Endpoint_IsINReady()));
  98                                 Endpoint_Write_8(HIDInterfaceInfo->State.UsingReportProtocol);
  99                                 Endpoint_ClearIN();
 100                                 Endpoint_ClearStatusStage();
 101                         }
 102
 103                         break;
 104                 case HID_REQ_SetProtocol:
 105                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 106                         {
 107                                 Endpoint_ClearSETUP();
 108                                 Endpoint_ClearStatusStage();
 109
 110                                 HIDInterfaceInfo->State.UsingReportProtocol = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
 111                         }
 112
 113                         break;
 114                 case HID_REQ_SetIdle:
 115                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 116                         {
 117                                 Endpoint_ClearSETUP();
 118                                 Endpoint_ClearStatusStage();
 119
 120                                 HIDInterfaceInfo->State.IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 121                         }
 122
 123                         break;
 124                 case HID_REQ_GetIdle:
 125                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 126                         {
 127                                 Endpoint_ClearSETUP();
 128                                 while (!(Endpoint_IsINReady()));
 129                                 Endpoint_Write_8(HIDInterfaceInfo->State.IdleCount >> 2);
 130                                 Endpoint_ClearIN();
 131                                 Endpoint_ClearStatusStage();
 132                         }
 133
 134                         break;
 135         }
 136 }
 137
 138 bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 139 {
 140         memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));
 141         HIDInterfaceInfo->State.UsingReportProtocol = true;
 142         HIDInterfaceInfo->State.IdleCount           = 500;
 143
 144         if (!(Endpoint_ConfigureEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber, EP_TYPE_INTERRUPT,
 145                                                                          ENDPOINT_DIR_IN, HIDInterfaceInfo->Config.ReportINEndpointSize,
 146                                                                          HIDInterfaceInfo->Config.ReportINEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
 147         {
 148                 return false;
 149         }
 150
 151         return true;
 152 }
 153
 154 void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 155 {
 156         if (USB_DeviceState != DEVICE_STATE_Configured)
 157           return;
 158
 159         if (HIDInterfaceInfo->State.PrevFrameNum == USB_Device_GetFrameNumber())
 160           return;
 161
 162         Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
 163
 164         if (Endpoint_IsReadWriteAllowed())
 165         {
 166                 uint8_t  ReportINData[HIDInterfaceInfo->Config.PrevReportINBufferSize];
 167                 uint8_t  ReportID     = 0;
 168                 uint16_t ReportINSize = 0;
 169
 170                 memset(ReportINData, 0, sizeof(ReportINData));
 171
 172                 bool ForceSend         = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, HID_REPORT_ITEM_In,
 173                                                                              ReportINData, &ReportINSize);
 174                 bool StatesChanged     = false;
 175                 bool IdlePeriodElapsed = (HIDInterfaceInfo->State.IdleCount && !(HIDInterfaceInfo->State.IdleMSRemaining));
 176
 177                 if (HIDInterfaceInfo->Config.PrevReportINBuffer != NULL)
 178                 {
 179                         StatesChanged = (memcmp(ReportINData, HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINSize) != 0);
 180                         memcpy(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINData, HIDInterfaceInfo->Config.PrevReportINBufferSize);
 181                 }
 182
 183                 if (ReportINSize && (ForceSend || StatesChanged || IdlePeriodElapsed))
 184                 {
 185                         HIDInterfaceInfo->State.IdleMSRemaining = HIDInterfaceInfo->State.IdleCount;
 186
 187                         Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
 188
 189                         if (ReportID)
 190                           Endpoint_Write_8(ReportID);
 191
 192                         Endpoint_Write_Stream_LE(ReportINData, ReportINSize, NULL);
 193
 194                         Endpoint_ClearIN();
 195                 }
 196
 197                 HIDInterfaceInfo->State.PrevFrameNum = USB_Device_GetFrameNumber();
 198         }
 199 }
 200
 201 #endif
 202