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.lufa-lib.org
   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_ControlRequest event. This is used to catch and process control requests sent to
 111  *  the device from the USB host before passing along unhandled control requests to the library for processing
 112  *  internally.
 113  */
 114 void EVENT_USB_Device_ControlRequest(void)
 115 {
 116         /* Handle HID Class specific requests */
 117         switch (USB_ControlRequest.bRequest)
 118         {
 119                 case HID_REQ_GetReport:
 120                         if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
 121                         {
 122                                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 123                                 CreateGenericHIDReport(GenericData);
 124
 125                                 Endpoint_ClearSETUP();
 126
 127                                 /* Write the report data to the control endpoint */
 128                                 Endpoint_Write_Control_Stream_LE(&GenericData, sizeof(GenericData));
 129                                 Endpoint_ClearOUT();
 130                         }
 131
 132                         break;
 133                 case HID_REQ_SetReport:
 134                         if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
 135                         {
 136                                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 137
 138                                 Endpoint_ClearSETUP();
 139
 140                                 /* Read the report data from the control endpoint */
 141                                 Endpoint_Read_Control_Stream_LE(&GenericData, sizeof(GenericData));
 142                                 Endpoint_ClearOUT();
 143
 144                                 ProcessGenericHIDReport(GenericData);
 145                         }
 146
 147                         break;
 148         }
 149 }
 150
 151 /** Function to process the lest received report from the host.
 152  *
 153  *  \param[in] DataArray  Pointer to a buffer where the last report data is stored
 154  */
 155 void ProcessGenericHIDReport(uint8_t* DataArray)
 156 {
 157         /*
 158                 This is where you need to process the reports being sent from the host to the device.
 159                 DataArray is an array holding the last report from the host. This function is called
 160                 each time the host has sent a report to the device.
 161         */
 162
 163         for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)
 164           LastReceived[i] = DataArray[i];
 165 }
 166
 167 /** Function to create the next report to send back to the host at the next reporting interval.
 168  *
 169  *  \param[out] DataArray  Pointer to a buffer where the next report data should be stored
 170  */
 171 void CreateGenericHIDReport(uint8_t* DataArray)
 172 {
 173         /*
 174                 This is where you need to create reports to be sent to the host from the device. This
 175                 function is called each time the host is ready to accept a new report. DataArray is
 176                 an array to hold the report to the host.
 177         */
 178
 179         for (uint8_t i = 0; i < GENERIC_REPORT_SIZE; i++)
 180           DataArray[i] = LastReceived[i];
 181 }
 182
 183 void HID_Task(void)
 184 {
 185         /* Device must be connected and configured for the task to run */
 186         if (USB_DeviceState != DEVICE_STATE_Configured)
 187           return;
 188
 189         Endpoint_SelectEndpoint(GENERIC_OUT_EPNUM);
 190
 191         /* Check to see if a packet has been sent from the host */
 192         if (Endpoint_IsOUTReceived())
 193         {
 194                 /* Check to see if the packet contains data */
 195                 if (Endpoint_IsReadWriteAllowed())
 196                 {
 197                         /* Create a temporary buffer to hold the read in report from the host */
 198                         uint8_t GenericData[GENERIC_REPORT_SIZE];
 199
 200                         /* Read Generic Report Data */
 201                         Endpoint_Read_Stream_LE(&GenericData, sizeof(GenericData));
 202
 203                         /* Process Generic Report Data */
 204                         ProcessGenericHIDReport(GenericData);
 205                 }
 206
 207                 /* Finalize the stream transfer to send the last packet */
 208                 Endpoint_ClearOUT();
 209         }
 210
 211         Endpoint_SelectEndpoint(GENERIC_IN_EPNUM);
 212
 213         /* Check to see if the host is ready to accept another packet */
 214         if (Endpoint_IsINReady())
 215         {
 216                 /* Create a temporary buffer to hold the report to send to the host */
 217                 uint8_t GenericData[GENERIC_REPORT_SIZE];
 218
 219                 /* Create Generic Report Data */
 220                 CreateGenericHIDReport(GenericData);
 221
 222                 /* Write Generic Report Data */
 223                 Endpoint_Write_Stream_LE(&GenericData, sizeof(GenericData));
 224
 225                 /* Finalize the stream transfer to send the last packet */
 226                 Endpoint_ClearIN();
 227         }
 228 }
 229