LUFA/Drivers/USB/Class/Device/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_DEVICE)
  33
  34 #include "HID.h"
  35
  36 void HID_Device_ProcessControlRequest(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
  37 {
  38         if (!(Endpoint_IsSETUPReceived()))
  39           return;
  40
  41         if (USB_ControlRequest.wIndex != HIDInterfaceInfo->Config.InterfaceNumber)
  42           return;
  43
  44         switch (USB_ControlRequest.bRequest)
  45         {
  46                 case REQ_GetReport:
  47                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  48                         {
  49                                 Endpoint_ClearSETUP();
  50
  51                                 uint16_t ReportINSize = 0;
  52                                 uint8_t  ReportID     = (USB_ControlRequest.wValue & 0xFF);
  53                                 uint8_t  ReportType   = (USB_ControlRequest.wValue >> 8) - 1;
  54
  55                                 memset(HIDInterfaceInfo->Config.PrevReportINBuffer, 0, HIDInterfaceInfo->Config.PrevReportINBufferSize);
  56
  57                                 CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportType,
  58                                                                     HIDInterfaceInfo->Config.PrevReportINBuffer, &ReportINSize);
  59
  60                                 Endpoint_SelectEndpoint(ENDPOINT_CONTROLEP);
  61                                 Endpoint_Write_Control_Stream_LE(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINSize);
  62                                 Endpoint_ClearOUT();
  63                         }
  64
  65                         break;
  66                 case REQ_SetReport:
  67                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  68                         {
  69                                 Endpoint_ClearSETUP();
  70
  71                                 uint16_t ReportOUTSize = USB_ControlRequest.wLength;
  72                                 uint8_t  ReportOUTData[ReportOUTSize];
  73                                 uint8_t  ReportID = (USB_ControlRequest.wValue & 0xFF);
  74
  75                                 Endpoint_Read_Control_Stream_LE(ReportOUTData, ReportOUTSize);
  76                                 Endpoint_ClearIN();
  77
  78                                 CALLBACK_HID_Device_ProcessHIDReport(HIDInterfaceInfo, ReportID, ReportOUTData, ReportOUTSize);
  79                         }
  80
  81                         break;
  82                 case REQ_GetProtocol:
  83                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  84                         {
  85                                 Endpoint_ClearSETUP();
  86
  87                                 Endpoint_Write_Byte(HIDInterfaceInfo->State.UsingReportProtocol);
  88                                 Endpoint_ClearIN();
  89
  90                                 Endpoint_ClearStatusStage();
  91                         }
  92
  93                         break;
  94                 case REQ_SetProtocol:
  95                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  96                         {
  97                                 Endpoint_ClearSETUP();
  98
  99                                 HIDInterfaceInfo->State.UsingReportProtocol = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
 100
 101                                 Endpoint_ClearStatusStage();
 102                         }
 103
 104                         break;
 105                 case REQ_SetIdle:
 106                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 107                         {
 108                                 Endpoint_ClearSETUP();
 109
 110                                 HIDInterfaceInfo->State.IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 111
 112                                 Endpoint_ClearStatusStage();
 113                         }
 114
 115                         break;
 116                 case REQ_GetIdle:
 117                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 118                         {
 119                                 Endpoint_ClearSETUP();
 120
 121                                 Endpoint_Write_Byte(HIDInterfaceInfo->State.IdleCount >> 2);
 122                                 Endpoint_ClearIN();
 123
 124                                 Endpoint_ClearStatusStage();
 125                         }
 126
 127                         break;
 128         }
 129 }
 130
 131 bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 132 {
 133         memset(&HIDInterfaceInfo->State, 0x00, sizeof(HIDInterfaceInfo->State));
 134         HIDInterfaceInfo->State.UsingReportProtocol = true;
 135         HIDInterfaceInfo->State.IdleCount = 500;
 136
 137         if (!(Endpoint_ConfigureEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber, EP_TYPE_INTERRUPT,
 138                                                                          ENDPOINT_DIR_IN, HIDInterfaceInfo->Config.ReportINEndpointSize,
 139                                                                          HIDInterfaceInfo->Config.ReportINEndpointDoubleBank ? ENDPOINT_BANK_DOUBLE : ENDPOINT_BANK_SINGLE)))
 140         {
 141                 return false;
 142         }
 143
 144         return true;
 145 }
 146
 147 void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 148 {
 149         if (USB_DeviceState != DEVICE_STATE_Configured)
 150           return;
 151
 152         Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
 153
 154         if (Endpoint_IsReadWriteAllowed())
 155         {
 156                 uint8_t  ReportINData[HIDInterfaceInfo->Config.PrevReportINBufferSize];
 157                 uint8_t  ReportID     = 0;
 158                 uint16_t ReportINSize = 0;
 159
 160                 memset(ReportINData, 0, sizeof(ReportINData));
 161
 162                 bool ForceSend         = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, REPORT_ITEM_TYPE_In,
 163                                                                              ReportINData, &ReportINSize);
 164                 bool StatesChanged     = false;
 165                 bool IdlePeriodElapsed = (HIDInterfaceInfo->State.IdleCount && !(HIDInterfaceInfo->State.IdleMSRemaining));
 166
 167                 if (HIDInterfaceInfo->Config.PrevReportINBuffer != NULL)
 168                 {
 169                         StatesChanged = (memcmp(ReportINData, HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINSize) != 0);
 170                         memcpy(HIDInterfaceInfo->Config.PrevReportINBuffer, ReportINData, ReportINSize);
 171                 }
 172
 173                 if (ReportINSize && (ForceSend || StatesChanged || IdlePeriodElapsed))
 174                 {
 175                         HIDInterfaceInfo->State.IdleMSRemaining = HIDInterfaceInfo->State.IdleCount;
 176
 177                         Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
 178
 179                         if (ReportID)
 180                           Endpoint_Write_Byte(ReportID);
 181
 182                         Endpoint_Write_Stream_LE(ReportINData, ReportINSize, NO_STREAM_CALLBACK);
 183
 184                         Endpoint_ClearIN();
 185                 }
 186         }
 187 }
 188
 189 void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo)
 190 {
 191         if (HIDInterfaceInfo->State.IdleMSRemaining)
 192           HIDInterfaceInfo->State.IdleMSRemaining--;
 193 }
 194
 195 #endif