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 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  41 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  42
  43 /** LUFA HID Class driver interface configuration and state information. This structure is
  44  *  passed to all HID Class driver functions, so that multiple instances of the same class
  45  *  within a device can be differentiated from one another.
  46  */
  47 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  48         {
  49                 .Config =
  50                         {
  51                                 .InterfaceNumber         = 0,
  52
  53                                 .ReportINEndpointNumber  = KEYBOARD_EPNUM,
  54                                 .ReportINEndpointSize    = KEYBOARD_EPSIZE,
  55
  56                                 .PrevReportINBuffer      = PrevKeyboardHIDReportBuffer,
  57                                 .PrevReportINBufferSize  = sizeof(PrevKeyboardHIDReportBuffer),
  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(&Keyboard_HID_Interface);
  73                 USB_USBTask();
  74         }
  75 }
  76
  77 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  78 void SetupHardware()
  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         Joystick_Init();
  89         LEDs_Init();
  90         Buttons_Init();
  91         USB_Init();
  92 }
  93
  94 /** Event handler for the library USB Connection event. */
  95 void EVENT_USB_Device_Connect(void)
  96 {
  97         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  98 }
  99
 100 /** Event handler for the library USB Disconnection event. */
 101 void EVENT_USB_Device_Disconnect(void)
 102 {
 103         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 104 }
 105
 106 /** Event handler for the library USB Configuration Changed event. */
 107 void EVENT_USB_Device_ConfigurationChanged(void)
 108 {
 109         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 110
 111         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 112           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 113
 114         USB_Device_EnableSOFEvents();
 115 }
 116
 117 /** Event handler for the library USB Unhandled Control Request event. */
 118 void EVENT_USB_Device_UnhandledControlRequest(void)
 119 {
 120         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 121 }
 122
 123 /** Event handler for the USB device Start Of Frame event. */
 124 void EVENT_USB_Device_StartOfFrame(void)
 125 {
 126         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 127 }
 128
 129 /** HID class driver callback function for the creation of HID reports to the host.
 130  *
 131  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 132  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 133  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 134  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 135  *
 136  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 137  */
 138 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 139                                          void* ReportData, uint16_t* ReportSize)
 140 {
 141         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 142
 143         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 144         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 145
 146         if (JoyStatus_LCL & JOY_UP)
 147           KeyboardReport->KeyCode[0] = 0x04; // A
 148         else if (JoyStatus_LCL & JOY_DOWN)
 149           KeyboardReport->KeyCode[0] = 0x05; // B
 150
 151         if (JoyStatus_LCL & JOY_LEFT)
 152           KeyboardReport->KeyCode[0] = 0x06; // C
 153         else if (JoyStatus_LCL & JOY_RIGHT)
 154           KeyboardReport->KeyCode[0] = 0x07; // D
 155
 156         if (JoyStatus_LCL & JOY_PRESS)
 157           KeyboardReport->KeyCode[0] = 0x08; // E
 158
 159         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 160           KeyboardReport->KeyCode[0] = 0x09; // F
 161
 162         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 163         return false;
 164 }
 165
 166 /** HID class driver callback function for the processing of HID reports from the host.
 167  *
 168  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 169  *  \param[in] ReportID  Report ID of the received report from the host
 170  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 171  *  \param[in] ReportSize  Size in bytes of the received HID report
 172  */
 173 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 174                                           const void* ReportData, const uint16_t ReportSize)
 175 {
 176         uint8_t  LEDMask   = LEDS_NO_LEDS;
 177         uint8_t* LEDReport = (uint8_t*)ReportData;
 178
 179         if (*LEDReport & 0x01) // NUM Lock
 180           LEDMask |= LEDS_LED1;
 181
 182         if (*LEDReport & 0x02) // CAPS Lock
 183           LEDMask |= LEDS_LED3;
 184
 185         if (*LEDReport & 0x04) // SCROLL Lock
 186           LEDMask |= LEDS_LED4;
 187
 188         LEDs_SetAllLEDs(LEDMask);
 189 }