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 /** 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
  52                                 .ReportINEndpointNumber  = GENERIC_IN_EPNUM,
  53                                 .ReportINEndpointSize    = GENERIC_EPSIZE,
  54
  55                                 .PrevReportINBuffer      = PrevHIDReportBuffer,
  56                                 .PrevReportINBufferSize  = sizeof(PrevHIDReportBuffer),
  57                         },
  58         };
  59
  60 /** Main program entry point. This routine contains the overall program flow, including initial
  61  *  setup of all components and the main program loop.
  62  */
  63 int main(void)
  64 {
  65         SetupHardware();
  66
  67         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  68
  69         for (;;)
  70         {
  71                 HID_Device_USBTask(&Generic_HID_Interface);
  72                 USB_USBTask();
  73         }
  74 }
  75
  76 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  77 void SetupHardware(void)
  78 {
  79         /* Disable watchdog if enabled by bootloader/fuses */
  80         MCUSR &= ~(1 << WDRF);
  81         wdt_disable();
  82
  83         /* Disable clock division */
  84         clock_prescale_set(clock_div_1);
  85
  86         /* Hardware Initialization */
  87         LEDs_Init();
  88         USB_Init();
  89
  90         /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
  91         OCR0A  = ((F_CPU / 64) / 1000);
  92         TCCR0A = (1 << WGM01);
  93         TCCR0B = ((1 << CS01) | (1 << CS00));
  94         TIMSK0 = (1 << OCIE0A);
  95 }
  96
  97 /** Event handler for the library USB Connection event. */
  98 void EVENT_USB_Connect(void)
  99 {
 100         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 101 }
 102
 103 /** Event handler for the library USB Disconnection event. */
 104 void EVENT_USB_Disconnect(void)
 105 {
 106         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 107 }
 108
 109 /** Event handler for the library USB Configuration Changed event. */
 110 void EVENT_USB_ConfigurationChanged(void)
 111 {
 112         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 113
 114         if (!(HID_Device_ConfigureEndpoints(&Generic_HID_Interface)))
 115           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 116 }
 117
 118 /** Event handler for the library USB Unhandled Control Packet event. */
 119 void EVENT_USB_UnhandledControlPacket(void)
 120 {
 121         HID_Device_ProcessControlPacket(&Generic_HID_Interface);
 122 }
 123
 124 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 125 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 126 {
 127         HID_Device_MillisecondElapsed(&Generic_HID_Interface);
 128 }
 129
 130 /** HID class driver callback function for the creation of HID reports to the host.
 131  *
 132  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 133  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 134  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 135  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 136  *
 137  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 138  */
 139 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 140                                          void* ReportData, uint16_t* ReportSize)
 141 {
 142         // Create generic HID report here
 143
 144         *ReportSize = 0;
 145         return true;
 146 }
 147
 148 /** HID class driver callback function for the processing of HID reports from the host.
 149  *
 150  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 151  *  \param[in] ReportID  Report ID of the received report from the host
 152  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 153  *  \param[in] ReportSize  Size in bytes of the received HID report
 154  */
 155 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 156                                           const void* ReportData, const uint16_t ReportSize)
 157 {
 158         // Process received generic HID report here
 159 }