Demos/Device/ClassDriver/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
  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         sei();
  78
  79         for (;;)
  80         {
  81                 HID_Device_USBTask(&Generic_HID_Interface);
  82                 USB_USBTask();
  83         }
  84 }
  85
  86 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  87 void SetupHardware(void)
  88 {
  89         /* Disable watchdog if enabled by bootloader/fuses */
  90         MCUSR &= ~(1 << WDRF);
  91         wdt_disable();
  92
  93         /* Disable clock division */
  94         clock_prescale_set(clock_div_1);
  95
  96         /* Hardware Initialization */
  97         LEDs_Init();
  98         USB_Init();
  99 }
 100
 101 /** Event handler for the library USB Connection event. */
 102 void EVENT_USB_Device_Connect(void)
 103 {
 104         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 105 }
 106
 107 /** Event handler for the library USB Disconnection event. */
 108 void EVENT_USB_Device_Disconnect(void)
 109 {
 110         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 111 }
 112
 113 /** Event handler for the library USB Configuration Changed event. */
 114 void EVENT_USB_Device_ConfigurationChanged(void)
 115 {
 116         bool ConfigSuccess = true;
 117
 118         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Generic_HID_Interface);
 119
 120         USB_Device_EnableSOFEvents();
 121
 122         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 123 }
 124
 125 /** Event handler for the library USB Control Request reception event. */
 126 void EVENT_USB_Device_ControlRequest(void)
 127 {
 128         HID_Device_ProcessControlRequest(&Generic_HID_Interface);
 129 }
 130
 131 /** Event handler for the USB device Start Of Frame event. */
 132 void EVENT_USB_Device_StartOfFrame(void)
 133 {
 134         HID_Device_MillisecondElapsed(&Generic_HID_Interface);
 135 }
 136
 137 /** HID class driver callback function for the creation of HID reports to the host.
 138  *
 139  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 140  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 141  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 142  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 143  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 144  *
 145  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 146  */
 147 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 148                                          uint8_t* const ReportID,
 149                                          const uint8_t ReportType,
 150                                          void* ReportData,
 151                                          uint16_t* const ReportSize)
 152 {
 153         if (HIDReportEcho.ReportID)
 154           *ReportID = HIDReportEcho.ReportID;
 155
 156         memcpy(ReportData, HIDReportEcho.ReportData, HIDReportEcho.ReportSize);
 157
 158         *ReportSize = HIDReportEcho.ReportSize;
 159         return true;
 160 }
 161
 162 /** HID class driver callback function for the processing of HID reports from the host.
 163  *
 164  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 165  *  \param[in] ReportID    Report ID of the received report from the host
 166  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 167  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 168  *  \param[in] ReportSize  Size in bytes of the received HID report
 169  */
 170 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 171                                           const uint8_t ReportID,
 172                                           const uint8_t ReportType,
 173                                           const void* ReportData,
 174                                           const uint16_t ReportSize)
 175 {
 176         HIDReportEcho.ReportID   = ReportID;
 177         HIDReportEcho.ReportSize = ReportSize;
 178         memcpy(HIDReportEcho.ReportData, ReportData, ReportSize);
 179 }
 180