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