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

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