Demos/Device/ClassDriver/GenericHID/GenericHID.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 /** \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 uint8_t PrevHIDReportBuffer[GENERIC_REPORT_SIZE];
  41
  42 /** Structure to contain reports from the host, so that they can be echoed back upon request */
  43 struct
  44 {
  45         uint8_t  ReportID;
  46         uint16_t ReportSize;
  47         uint8_t  ReportData[GENERIC_REPORT_SIZE];
  48 } HIDReportEcho;
  49
  50 /** LUFA HID Class driver interface configuration and state information. This structure is
  51  *  passed to all HID Class driver functions, so that multiple instances of the same class
  52  *  within a device can be differentiated from one another.
  53  */
  54 USB_ClassInfo_HID_Device_t Generic_HID_Interface =
  55         {
  56                 .Config =
  57                         {
  58                                 .InterfaceNumber              = 0,
  59
  60                                 .ReportINEndpointNumber       = GENERIC_IN_EPNUM,
  61                                 .ReportINEndpointSize         = GENERIC_EPSIZE,
  62                                 .ReportINEndpointDoubleBank   = false,
  63
  64                                 .PrevReportINBuffer           = PrevHIDReportBuffer,
  65                                 .PrevReportINBufferSize       = sizeof(PrevHIDReportBuffer),
  66                         },
  67         };
  68
  69 /** Main program entry point. This routine contains the overall program flow, including initial
  70  *  setup of all components and the main program loop.
  71  */
  72 int main(void)
  73 {
  74         SetupHardware();
  75
  76         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  77
  78         for (;;)
  79         {
  80                 HID_Device_USBTask(&Generic_HID_Interface);
  81                 USB_USBTask();
  82         }
  83 }
  84
  85 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  86 void SetupHardware(void)
  87 {
  88         /* Disable watchdog if enabled by bootloader/fuses */
  89         MCUSR &= ~(1 << WDRF);
  90         wdt_disable();
  91
  92         /* Disable clock division */
  93         clock_prescale_set(clock_div_1);
  94
  95         /* Hardware Initialization */
  96         LEDs_Init();
  97         USB_Init();
  98 }
  99
 100 /** Event handler for the library USB Connection event. */
 101 void EVENT_USB_Device_Connect(void)
 102 {
 103         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 104 }
 105
 106 /** Event handler for the library USB Disconnection event. */
 107 void EVENT_USB_Device_Disconnect(void)
 108 {
 109         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 110 }
 111
 112 /** Event handler for the library USB Configuration Changed event. */
 113 void EVENT_USB_Device_ConfigurationChanged(void)
 114 {
 115         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 116
 117         if (!(HID_Device_ConfigureEndpoints(&Generic_HID_Interface)))
 118           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 119
 120         USB_Device_EnableSOFEvents();
 121 }
 122
 123 /** Event handler for the library USB Unhandled Control Request event. */
 124 void EVENT_USB_Device_UnhandledControlRequest(void)
 125 {
 126         HID_Device_ProcessControlRequest(&Generic_HID_Interface);
 127 }
 128
 129 /** Event handler for the USB device Start Of Frame event. */
 130 void EVENT_USB_Device_StartOfFrame(void)
 131 {
 132         HID_Device_MillisecondElapsed(&Generic_HID_Interface);
 133 }
 134
 135 /** HID class driver callback function for the creation of HID reports to the host.
 136  *
 137  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 138  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 139  *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 140  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 141  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 142  *
 143  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 144  */
 145 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 146                                          const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
 147 {
 148         if (HIDReportEcho.ReportID)
 149           *ReportID = HIDReportEcho.ReportID;
 150
 151         memcpy(ReportData, HIDReportEcho.ReportData, HIDReportEcho.ReportSize);
 152
 153         *ReportSize = HIDReportEcho.ReportSize;
 154         return true;
 155 }
 156
 157 /** HID class driver callback function for the processing of HID reports from the host.
 158  *
 159  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 160  *  \param[in] ReportID  Report ID of the received report from the host
 161  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 162  *  \param[in] ReportSize  Size in bytes of the received HID report
 163  */
 164 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 165                                           const void* ReportData, const uint16_t ReportSize)
 166 {
 167         HIDReportEcho.ReportID   = ReportID;
 168         HIDReportEcho.ReportSize = ReportSize;
 169         memcpy(HIDReportEcho.ReportData, ReportData, ReportSize);
 170 }