Demos/Device/ClassDriver/GenericHID/GenericHID.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "GenericHID.h"
  38
  39 /** Buffer to hold the previously generated HID report, for comparison purposes inside the HID class driver. */
  40 static uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Device_t Generic_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .InterfaceNumber              = 0,
  51                                 .ReportINEndpoint             =
  52                                         {
  53                                                 .Address              = GENERIC_IN_EPADDR,
  54                                                 .Size                 = GENERIC_EPSIZE,
  55                                                 .Banks                = 1,
  56                                         },
  57                                 .PrevReportINBuffer           = PrevHIDReportBuffer,
  58                                 .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
  59                         },
  60         };
  61
  62
  63 /** Main program entry point. This routine contains the overall program flow, including initial
  64  *  setup of all components and the main program loop.
  65  */
  66 int main(void)
  67 {
  68         SetupHardware();
  69
  70         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  71         GlobalInterruptEnable();
  72
  73         for (;;)
  74         {
  75                 HID_Device_USBTask(&Generic_HID_Interface);
  76                 USB_USBTask();
  77         }
  78 }
  79
  80 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  81 void SetupHardware(void)
  82 {
  83         /* Disable watchdog if enabled by bootloader/fuses */
  84         MCUSR &= ~(1 << WDRF);
  85         wdt_disable();
  86
  87         /* Disable clock division */
  88         clock_prescale_set(clock_div_1);
  89
  90         /* Hardware Initialization */
  91         LEDs_Init();
  92         USB_Init();
  93 }
  94
  95 /** Event handler for the library USB Connection event. */
  96 void EVENT_USB_Device_Connect(void)
  97 {
  98         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  99 }
 100
 101 /** Event handler for the library USB Disconnection event. */
 102 void EVENT_USB_Device_Disconnect(void)
 103 {
 104         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 105 }
 106
 107 /** Event handler for the library USB Configuration Changed event. */
 108 void EVENT_USB_Device_ConfigurationChanged(void)
 109 {
 110         bool ConfigSuccess = true;
 111
 112         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);
 113
 114         USB_Device_EnableSOFEvents();
 115
 116         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 117 }
 118
 119 /** Event handler for the library USB Control Request reception event. */
 120 void EVENT_USB_Device_ControlRequest(void)
 121 {
 122         HID_Device_ProcessControlRequest(&Generic_HID_Interface);
 123 }
 124
 125 /** Event handler for the USB device Start Of Frame event. */
 126 void EVENT_USB_Device_StartOfFrame(void)
 127 {
 128         HID_Device_MillisecondElapsed(&Generic_HID_Interface);
 129 }
 130
 131 /** HID class driver callback function for the creation of HID reports to the host.
 132  *
 133  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 134  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 135  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 136  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 137  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 138  *
 139  *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 140  */
 141 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 142                                          uint8_t* const ReportID,
 143                                          const uint8_t ReportType,
 144                                          void* ReportData,
 145                                          uint16_t* const ReportSize)
 146 {
 147         uint8_t* Data = (uint8_t*)ReportData;
 148         uint8_t  CurrLEDMask = LEDs_GetLEDs();
 149
 150         Data[0] = ((CurrLEDMask & LEDS_LED1) ? 1 : 0);
 151         Data[1] = ((CurrLEDMask & LEDS_LED2) ? 1 : 0);
 152         Data[2] = ((CurrLEDMask & LEDS_LED3) ? 1 : 0);
 153         Data[3] = ((CurrLEDMask & LEDS_LED4) ? 1 : 0);
 154
 155         *ReportSize = GENERIC_REPORT_SIZE;
 156         return false;
 157 }
 158
 159 /** HID class driver callback function for the processing of HID reports from the host.
 160  *
 161  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 162  *  \param[in] ReportID    Report ID of the received report from the host
 163  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 164  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 165  *  \param[in] ReportSize  Size in bytes of the received HID report
 166  */
 167 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 168                                           const uint8_t ReportID,
 169                                           const uint8_t ReportType,
 170                                           const void* ReportData,
 171                                           const uint16_t ReportSize)
 172 {
 173         uint8_t* Data = (uint8_t*)ReportData;
 174         uint8_t  NewLEDMask = LEDS_NO_LEDS;
 175
 176         if (Data[0])
 177           NewLEDMask |= LEDS_LED1;
 178
 179         if (Data[1])
 180           NewLEDMask |= LEDS_LED2;
 181
 182         if (Data[2])
 183           NewLEDMask |= LEDS_LED3;
 184
 185         if (Data[3])
 186           NewLEDMask |= LEDS_LED4;
 187
 188         LEDs_SetAllLEDs(NewLEDMask);
 189 }
 190