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