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