Demos/Device/ClassDriver/Keyboard/Keyboard.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  Denver Gingerich (denver [at] ossguy [dot] com)
  11       Based on code by Dean Camera (dean [at] fourwalledcubicle [dot] com)
  12
  13   Permission to use, copy, modify, and distribute this software
  14   and its documentation for any purpose and without fee is hereby
  15   granted, provided that the above copyright notice appear in all
  16   copies and that both that the copyright notice and this
  17   permission notice and warranty disclaimer appear in supporting
  18   documentation, and that the name of the author not be used in
  19   advertising or publicity pertaining to distribution of the
  20   software without specific, written prior permission.
  21
  22   The author disclaim all warranties with regard to this
  23   software, including all implied warranties of merchantability
  24   and fitness.  In no event shall the author be liable for any
  25   special, indirect or consequential damages or any damages
  26   whatsoever resulting from loss of use, data or profits, whether
  27   in an action of contract, negligence or other tortious action,
  28   arising out of or in connection with the use or performance of
  29   this software.
  30 */
  31
  32 /** \file
  33  *
  34  *  Main source file for the Keyboard demo. This file contains the main tasks of
  35  *  the demo and is responsible for the initial application hardware configuration.
  36  */
  37
  38 #include "Keyboard.h"
  39
  40 /** LUFA HID Class driver interface configuration and state information. This structure is
  41  *  passed to all HID Class driver functions, so that multiple instances of the same class
  42  *  within a device can be differentiated from one another.
  43  */
  44 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  45         {
  46                 .Config =
  47                         {
  48                                 .InterfaceNumber         = 0,
  49
  50                                 .ReportINEndpointNumber  = KEYBOARD_EPNUM,
  51                                 .ReportINEndpointSize    = KEYBOARD_EPSIZE,
  52
  53                                 .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),
  54                         },
  55     };
  56
  57 /** Main program entry point. This routine contains the overall program flow, including initial
  58  *  setup of all components and the main program loop.
  59  */
  60 int main(void)
  61 {
  62         SetupHardware();
  63
  64         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  65
  66         for (;;)
  67         {
  68                 HID_Device_USBTask(&Keyboard_HID_Interface);
  69                 USB_USBTask();
  70         }
  71 }
  72
  73 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  74 void SetupHardware()
  75 {
  76         /* Disable watchdog if enabled by bootloader/fuses */
  77         MCUSR &= ~(1 << WDRF);
  78         wdt_disable();
  79
  80         /* Disable clock division */
  81         clock_prescale_set(clock_div_1);
  82
  83         /* Hardware Initialization */
  84         Joystick_Init();
  85         LEDs_Init();
  86         Buttons_Init();
  87         USB_Init();
  88
  89         /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
  90         OCR0A  = ((F_CPU / 64) / 1000);
  91         TCCR0A = (1 << WGM01);
  92         TCCR0B = ((1 << CS01) | (1 << CS00));
  93         TIMSK0 = (1 << OCIE0A);
  94 }
  95
  96 /** Event handler for the library USB Connection event. */
  97 void EVENT_USB_Connect(void)
  98 {
  99         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 100 }
 101
 102 /** Event handler for the library USB Disconnection event. */
 103 void EVENT_USB_Disconnect(void)
 104 {
 105         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 106 }
 107
 108 /** Event handler for the library USB Configuration Changed event. */
 109 void EVENT_USB_ConfigurationChanged(void)
 110 {
 111         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 112
 113         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 114           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 115 }
 116
 117 /** Event handler for the library USB Unhandled Control Packet event. */
 118 void EVENT_USB_UnhandledControlPacket(void)
 119 {
 120         HID_Device_ProcessControlPacket(&Keyboard_HID_Interface);
 121 }
 122
 123 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 124 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 125 {
 126         if (Keyboard_HID_Interface.State.IdleMSRemaining)
 127           Keyboard_HID_Interface.State.IdleMSRemaining--;
 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  *
 136  *  \return Number of bytes written in the report (or zero if no report is to be sent
 137  */
 138 uint16_t CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID, void* ReportData)
 139 {
 140         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 141
 142         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 143         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 144
 145         if (JoyStatus_LCL & JOY_UP)
 146           KeyboardReport->KeyCode[0] = 0x04; // A
 147         else if (JoyStatus_LCL & JOY_DOWN)
 148           KeyboardReport->KeyCode[0] = 0x05; // B
 149
 150         if (JoyStatus_LCL & JOY_LEFT)
 151           KeyboardReport->KeyCode[0] = 0x06; // C
 152         else if (JoyStatus_LCL & JOY_RIGHT)
 153           KeyboardReport->KeyCode[0] = 0x07; // D
 154
 155         if (JoyStatus_LCL & JOY_PRESS)
 156           KeyboardReport->KeyCode[0] = 0x08; // E
 157
 158         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 159           KeyboardReport->KeyCode[0] = 0x09; // F
 160
 161         return sizeof(USB_KeyboardReport_Data_t);
 162 }
 163
 164 /** HID class driver callback function for the processing of HID reports from the host.
 165  *
 166  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 167  *  \param[in] ReportID  Report ID of the received report from the host
 168  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 169  *  \param[in] ReportSize  Size in bytes of the received HID report
 170  */
 171 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 172                                           const void* ReportData, const uint16_t ReportSize)
 173 {
 174         uint8_t  LEDMask   = LEDS_NO_LEDS;
 175         uint8_t* LEDReport = (uint8_t*)ReportData;
 176
 177         if (*LEDReport & 0x01) // NUM Lock
 178           LEDMask |= LEDS_LED1;
 179
 180         if (*LEDReport & 0x02) // CAPS Lock
 181           LEDMask |= LEDS_LED3;
 182
 183         if (*LEDReport & 0x04) // SCROLL Lock
 184           LEDMask |= LEDS_LED4;
 185
 186         LEDs_SetAllLEDs(LEDMask);
 187 }