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_ProcessControlPacket(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
  37 {
  38         if (!(Endpoint_IsSETUPReceived()))
  39           return;
  40
  41         if ((USB_ControlRequest.wIndex   != HIDInterfaceInfo->Config.InterfaceNumber) &&
  42             (USB_ControlRequest.bRequest != REQ_SetIdle))
  43         {
  44                 return;
  45         }
  46
  47         switch (USB_ControlRequest.bRequest)
  48         {
  49                 case REQ_GetReport:
  50                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  51                         {
  52                                 Endpoint_ClearSETUP();
  53
  54                                 uint8_t  ReportINData[HIDInterfaceInfo->Config.ReportINBufferSize];
  55                                 uint16_t ReportINSize;
  56                                 uint8_t  ReportID = (USB_ControlRequest.wValue & 0xFF);
  57
  58                                 memset(ReportINData, 0, sizeof(ReportINData));
  59
  60                                 ReportINSize = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportINData);
  61
  62                                 Endpoint_Write_Control_Stream_LE(ReportINData, ReportINSize);
  63                                 Endpoint_ClearOUT();
  64                         }
  65
  66                         break;
  67                 case REQ_SetReport:
  68                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  69                         {
  70                                 Endpoint_ClearSETUP();
  71
  72                                 uint16_t ReportOUTSize = USB_ControlRequest.wLength;
  73                                 uint8_t  ReportOUTData[ReportOUTSize];
  74                                 uint8_t  ReportID = (USB_ControlRequest.wValue & 0xFF);
  75
  76                                 Endpoint_Read_Control_Stream_LE(ReportOUTData, ReportOUTSize);
  77                                 Endpoint_ClearIN();
  78
  79                                 CALLBACK_HID_Device_ProcessHIDReport(HIDInterfaceInfo, ReportID, ReportOUTData, ReportOUTSize);
  80                         }
  81
  82                         break;
  83                 case REQ_GetProtocol:
  84                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
  85                         {
  86                                 Endpoint_ClearSETUP();
  87
  88                                 Endpoint_Write_Byte(HIDInterfaceInfo->State.UsingReportProtocol);
  89                                 Endpoint_ClearIN();
  90
  91                                 while (!(Endpoint_IsOUTReceived()));
  92                                 Endpoint_ClearOUT();
  93                         }
  94
  95                         break;
  96                 case REQ_SetProtocol:
  97                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
  98                         {
  99                                 Endpoint_ClearSETUP();
 100
 101                                 HIDInterfaceInfo->State.UsingReportProtocol = (USB_ControlRequest.wValue != 0x0000);
 102
 103                                 while (!(Endpoint_IsINReady()));
 104                                 Endpoint_ClearIN();
 105                         }
 106
 107                         break;
 108                 case REQ_SetIdle:
 109                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 110                         {
 111                                 if ((USB_ControlRequest.wIndex         == HIDInterfaceInfo->Config.InterfaceNumber) ||
 112                                     (USB_ControlRequest.wValue & 0xFF) == 0)
 113                                 {
 114                                         Endpoint_ClearSETUP();
 115
 116                                         HIDInterfaceInfo->State.IdleCount = ((USB_ControlRequest.wValue & 0xFF00) >> 6);
 117
 118                                         while (!(Endpoint_IsINReady()));
 119                                         Endpoint_ClearIN();
 120                                 }
 121                         }
 122
 123                         break;
 124                 case REQ_GetIdle:
 125                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 126                         {
 127                                 Endpoint_ClearSETUP();
 128
 129                                 Endpoint_Write_Byte(HIDInterfaceInfo->State.IdleCount >> 2);
 130                                 Endpoint_ClearIN();
 131
 132                                 while (!(Endpoint_IsOUTReceived()));
 133                                 Endpoint_ClearOUT();
 134                         }
 135
 136                         break;
 137         }
 138 }
 139
 140 bool HID_Device_ConfigureEndpoints(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo)
 141 {
 142         HIDInterfaceInfo->State.UsingReportProtocol = true;
 143
 144         if (!(Endpoint_ConfigureEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber, EP_TYPE_INTERRUPT,
 145                                                                          ENDPOINT_DIR_IN, HIDInterfaceInfo->Config.ReportINEndpointSize, 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_IsConnected) || !(USB_ConfigurationNumber))
 156           return;
 157
 158         Endpoint_SelectEndpoint(HIDInterfaceInfo->Config.ReportINEndpointNumber);
 159
 160         if (Endpoint_IsReadWriteAllowed() &&
 161             !(HIDInterfaceInfo->State.IdleCount && HIDInterfaceInfo->State.IdleMSRemaining))
 162         {
 163                 if (HIDInterfaceInfo->State.IdleCount && !(HIDInterfaceInfo->State.IdleMSRemaining))
 164                   HIDInterfaceInfo->State.IdleMSRemaining = HIDInterfaceInfo->State.IdleCount;
 165
 166                 uint8_t  ReportINData[HIDInterfaceInfo->Config.ReportINBufferSize];
 167                 uint16_t ReportINSize;
 168                 uint8_t  ReportID = 0;
 169
 170                 memset(ReportINData, 0, sizeof(ReportINData));
 171
 172                 ReportINSize = CALLBACK_HID_Device_CreateHIDReport(HIDInterfaceInfo, &ReportID, ReportINData);
 173
 174                 if (ReportINSize)
 175                 {
 176                         if (ReportID)
 177                           Endpoint_Write_Stream_LE(&ReportID, sizeof(ReportID), NO_STREAM_CALLBACK);
 178
 179                         Endpoint_Write_Stream_LE(ReportINData, ReportINSize, NO_STREAM_CALLBACK);
 180                 }
 181
 182                 Endpoint_ClearIN();
 183         }
 184 }
 185
 186 #endif