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_t Keyboard_HID_Interface =
  45     {
  46         .InterfaceNumber         = 0,
  47
  48         .ReportINEndpointNumber  = KEYBOARD_EPNUM,
  49         .ReportINEndpointSize    = KEYBOARD_EPSIZE,
  50
  51                 .ReportINBufferSize      = sizeof(USB_KeyboardReport_Data_t),
  52
  53         .IdleCount               = 500,
  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         USB_HID_USBTask(&Keyboard_HID_Interface);
  68         USB_USBTask();
  69     }
  70 }
  71
  72 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  73 void SetupHardware()
  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     Joystick_Init();
  84     LEDs_Init();
  85     Buttons_Init();
  86     USB_Init();
  87
  88         /* Millisecond timer initialization, with output compare interrupt enabled for the idle timing */
  89         OCR0A  = ((F_CPU / 64) / 1000);
  90         TCCR0A = (1 << WGM01);
  91         TCCR0B = ((1 << CS01) | (1 << CS00));
  92         TIMSK0 = (1 << OCIE0A);
  93 }
  94
  95 /** Event handler for the library USB Connection event. */
  96 void EVENT_USB_Connect(void)
  97 {
  98     LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  99 }
 100
 101 /** Event handler for the library USB Disconnection event. */
 102 void EVENT_USB_Disconnect(void)
 103 {
 104     LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 105 }
 106
 107 /** Event handler for the library USB Configuration Changed event. */
 108 void EVENT_USB_ConfigurationChanged(void)
 109 {
 110     LEDs_SetAllLEDs(LEDMASK_USB_READY);
 111
 112     if (!(USB_HID_ConfigureEndpoints(&Keyboard_HID_Interface)))
 113       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 114 }
 115
 116 /** Event handler for the library USB Unhandled Control Packet event. */
 117 void EVENT_USB_UnhandledControlPacket(void)
 118 {
 119     USB_HID_ProcessControlPacket(&Keyboard_HID_Interface);
 120 }
 121
 122 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 123 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 124 {
 125         if (Keyboard_HID_Interface.IdleMSRemaining)
 126           Keyboard_HID_Interface.IdleMSRemaining--;
 127 }
 128
 129 /** HID class driver callback function for the creation of HID reports to the host.
 130  *
 131  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 132  *  \param ReportData  Pointer to a buffer where the created report should be stored
 133  *
 134  *  \return Number of bytes written in the report (or zero if no report is to be sent
 135  */
 136 uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData)
 137 {
 138     USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 139
 140     uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 141     uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 142
 143     if (JoyStatus_LCL & JOY_UP)
 144       KeyboardReport->KeyCode[0] = 0x04; // A
 145     else if (JoyStatus_LCL & JOY_DOWN)
 146       KeyboardReport->KeyCode[0] = 0x05; // B
 147
 148     if (JoyStatus_LCL & JOY_LEFT)
 149       KeyboardReport->KeyCode[0] = 0x06; // C
 150     else if (JoyStatus_LCL & JOY_RIGHT)
 151       KeyboardReport->KeyCode[0] = 0x07; // D
 152
 153     if (JoyStatus_LCL & JOY_PRESS)
 154       KeyboardReport->KeyCode[0] = 0x08; // E
 155
 156     if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 157       KeyboardReport->KeyCode[0] = 0x09; // F
 158
 159     return sizeof(USB_KeyboardReport_Data_t);
 160 }
 161
 162 /** HID class driver callback function for the processing of HID reports from the host.
 163  *
 164  *  \param HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 165  *  \param ReportData  Pointer to a buffer where the created report has been stored
 166  *  \param ReportSize  Size in bytes of the received HID report
 167  */
 168 void CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID,
 169                                                void* ReportData, uint16_t ReportSize)
 170 {
 171     uint8_t  LEDMask   = LEDS_NO_LEDS;
 172     uint8_t* LEDReport = (uint8_t*)ReportData;
 173
 174     if (*LEDReport & 0x01) // NUM Lock
 175       LEDMask |= LEDS_LED1;
 176
 177     if (*LEDReport & 0x02) // CAPS Lock
 178       LEDMask |= LEDS_LED3;
 179
 180     if (*LEDReport & 0x04) // SCROLL Lock
 181       LEDMask |= LEDS_LED4;
 182
 183     LEDs_SetAllLEDs(LEDMask);
 184 }