Demos/Device/LowLevel/GenericHID/GenericHID.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 /** \file
  32  *
  33  *  Main source file for the GenericHID demo. This file contains the main tasks of the demo and
  34  *  is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "GenericHID.h"
  38
  39 /** Static buffer to hold the last received report from the host, so that it can be echoed back in the next sent report */
  40 static uint8_t LastReceived[GENERIC_REPORT_SIZE];
  41
  42
  43 /** Main program entry point. This routine configures the hardware required by the application, then
  44  *  enters a loop to run the application tasks in sequence.
  45  */
  46 int main(void)
  47 {
  48         SetupHardware();
  49
  50         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  51         sei();
  52
  53         for (;;)
  54         {
  55                 HID_Task();
  56                 USB_USBTask();
  57         }
  58 }
  59
  60 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  61 void SetupHardware(void)
  62 {
  63         /* Disable watchdog if enabled by bootloader/fuses */
  64         MCUSR &= ~(1 << WDRF);
  65         wdt_disable();
  66
  67         /* Disable clock division */
  68         clock_prescale_set(clock_div_1);
  69
  70         /* Hardware Initialization */
  71         LEDs_Init();
  72         USB_Init();
  73 }
  74
  75 /** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs and
  76  *  starts the library USB task to begin the enumeration and USB management process.
  77  */
  78 void EVENT_USB_Device_Connect(void)
  79 {
  80         /* Indicate USB enumerating */
  81         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  82 }
  83
  84 /** Event handler for the USB_Disconnect event. This indicates that the device is no longer connected to a host via
  85  *  the status LEDs and stops the USB management task.
  86  */
  87 void EVENT_USB_Device_Disconnect(void)
  88 {
  89         /* Indicate USB not ready */
  90         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  91 }
  92
  93 /** Event handler for the USB_ConfigurationChanged event. This is fired when the host sets the current configuration
  94  *  of the USB device after enumeration, and configures the generic HID device endpoints.
  95  */
  96 void EVENT_USB_Device_ConfigurationChanged(void)
  97 {
  98         bool ConfigSuccess = true;
  99
 100         /* Setup HID Report Endpoints */
 101         ConfigSuccess &= Endpoint_ConfigureEndpoint(GENERIC_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
 102                                                     GENERIC_EPSIZE, ENDPOINT_BANK_SINGLE);
 103         ConfigSuccess &= Endpoint_ConfigureEndpoint(GENERIC_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
 104                                                     GENERIC_EPSIZE, ENDPOINT_BANK_SINGLE);
 105
 106         /* Indicate endpoint configuration success or failure */
 107         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 108 }
 109
 110 /** Event handler for the USB_UnhandledControlRequest event. This is used to catch standard and class specific
 111  *  control requests that are not handled internally by the USB library (including the HID commands, which are
 112  *  all issued via the control endpoint), so that they can be handled appropriately for the application.
 113  */
 114 void EVENT_USB_Device_UnhandledControlRequest(void)
 115 {
 116         /* Handle HID Class specific requests */
 117         switch (USB_ControlRequest.bRequest)
 118         {
 119                 case REQ_GetReport:
 120                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 121                         {
 122                                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 123
 124                                 Endpoint_ClearSETUP();
 125
 126                                 CreateGenericHIDReport(GenericData);
 127
 128                                 /* Write the report data to the control endpoint */
 129                                 Endpoint_Write_Control_Stream_LE(&GenericData, sizeof(GenericData));
 130
 131                                 /* Finalize the stream transfer to send the last packet or clear the host abort */
 132                                 Endpoint_ClearOUT();
 133                         }
 134
 135                         break;
 136                 case REQ_SetReport:
 137                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 138                         {
 139                                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 140
 141                                 Endpoint_ClearSETUP();
 142
 143                                 /* Wait until the generic report has been sent by the host */
 144                                 while (!(Endpoint_IsOUTReceived()))
 145                                 {
 146                                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 147                                           return;
 148                                 }
 149
 150                                 Endpoint_Read_Control_Stream_LE(&GenericData, sizeof(GenericData));
 151
 152                                 ProcessGenericHIDReport(GenericData);
 153
 154                                 /* Clear the endpoint data */
 155                                 Endpoint_ClearOUT();
 156
 157                                 /* Wait until the host is ready to receive the request confirmation */
 158                                 while (!(Endpoint_IsINReady()))
 159                                 {
 160                                         if (USB_DeviceState == DEVICE_STATE_Unattached)
 161                                           return;
 162                                 }
 163
 164                                 /* Handshake the request by sending an empty IN packet */
 165                                 Endpoint_ClearIN();
 166                         }
 167
 168                         break;
 169         }
 170 }
 171
 172 /** Function to process the lest received report from the host.
 173  *
 174  *  \param[in] DataArray  Pointer to a buffer where the last report data is stored
 175  */
 176 void ProcessGenericHIDReport(uint8_t* DataArray)
 177 {
 178         /*
 179                 This is where you need to process the reports being sent from the host to the device.
 180                 DataArray is an array holding the last report from the host. This function is called
 181                 each time the host has sent a report to the device.
 182         */
 183
 184         for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)
 185           LastReceived[i] = DataArray[i];
 186 }
 187
 188 /** Function to create the next report to send back to the host at the next reporting interval.
 189  *
 190  *  \param[out] DataArray  Pointer to a buffer where the next report data should be stored
 191  */
 192 void CreateGenericHIDReport(uint8_t* DataArray)
 193 {
 194         /*
 195                 This is where you need to create reports to be sent to the host from the device. This
 196                 function is called each time the host is ready to accept a new report. DataArray is
 197                 an array to hold the report to the host.
 198         */
 199
 200         for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)
 201           DataArray[i] = LastReceived[i];
 202 }
 203
 204 void HID_Task(void)
 205 {
 206         /* Device must be connected and configured for the task to run */
 207         if (USB_DeviceState != DEVICE_STATE_Configured)
 208           return;
 209
 210         Endpoint_SelectEndpoint(GENERIC_OUT_EPNUM);
 211
 212         /* Check to see if a packet has been sent from the host */
 213         if (Endpoint_IsOUTReceived())
 214         {
 215                 /* Check to see if the packet contains data */
 216                 if (Endpoint_IsReadWriteAllowed())
 217                 {
 218                         /* Create a temporary buffer to hold the read in report from the host */
 219                         uint8_t GenericData[GENERIC_REPORT_SIZE];
 220
 221                         /* Read Generic Report Data */
 222                         Endpoint_Read_Stream_LE(&GenericData, sizeof(GenericData));
 223
 224                         /* Process Generic Report Data */
 225                         ProcessGenericHIDReport(GenericData);
 226                 }
 227
 228                 /* Finalize the stream transfer to send the last packet */
 229                 Endpoint_ClearOUT();
 230         }
 231
 232         Endpoint_SelectEndpoint(GENERIC_IN_EPNUM);
 233
 234         /* Check to see if the host is ready to accept another packet */
 235         if (Endpoint_IsINReady())
 236         {
 237                 /* Create a temporary buffer to hold the report to send to the host */
 238                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 239
 240                 /* Create Generic Report Data */
 241                 CreateGenericHIDReport(GenericData);
 242
 243                 /* Write Generic Report Data */
 244                 Endpoint_Write_Stream_LE(&GenericData, sizeof(GenericData));
 245
 246                 /* Finalize the stream transfer to send the last packet */
 247                 Endpoint_ClearIN();
 248         }
 249 }