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