Demos/Device/ClassDriver/Keyboard/Keyboard.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 Keyboard demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "Keyboard.h"
  38
  39 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  40 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  41
  42 /** LUFA HID Class driver interface configuration and state information. This structure is
  43  *  passed to all HID Class driver functions, so that multiple instances of the same class
  44  *  within a device can be differentiated from one another.
  45  */
  46 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  47         {
  48                 .Config =
  49                         {
  50                                 .InterfaceNumber              = 0,
  51
  52                                 .ReportINEndpointNumber       = KEYBOARD_EPNUM,
  53                                 .ReportINEndpointSize         = KEYBOARD_EPSIZE,
  54                                 .ReportINEndpointDoubleBank   = false,
  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         sei();
  70
  71         for (;;)
  72         {
  73                 HID_Device_USBTask(&Keyboard_HID_Interface);
  74                 USB_USBTask();
  75         }
  76 }
  77
  78 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  79 void SetupHardware()
  80 {
  81         /* Disable watchdog if enabled by bootloader/fuses */
  82         MCUSR &= ~(1 << WDRF);
  83         wdt_disable();
  84
  85         /* Disable clock division */
  86         clock_prescale_set(clock_div_1);
  87
  88         /* Hardware Initialization */
  89         Joystick_Init();
  90         LEDs_Init();
  91         Buttons_Init();
  92         USB_Init();
  93 }
  94
  95 /** Event handler for the library USB Connection event. */
  96 void EVENT_USB_Device_Connect(void)
  97 {
  98         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  99 }
 100
 101 /** Event handler for the library USB Disconnection event. */
 102 void EVENT_USB_Device_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_Device_ConfigurationChanged(void)
 109 {
 110         bool ConfigSuccess = true;
 111
 112         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 113
 114         USB_Device_EnableSOFEvents();
 115
 116         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 117 }
 118
 119 /** Event handler for the library USB Control Request reception event. */
 120 void EVENT_USB_Device_ControlRequest(void)
 121 {
 122         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 123 }
 124
 125 /** Event handler for the USB device Start Of Frame event. */
 126 void EVENT_USB_Device_StartOfFrame(void)
 127 {
 128         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 129 }
 130
 131 /** HID class driver callback function for the creation of HID reports to the host.
 132  *
 133  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 134  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 135  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 136  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 137  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 138  *
 139  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 140  */
 141 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 142                                          const uint8_t ReportType, void* ReportData, uint16_t* const ReportSize)
 143 {
 144         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 145
 146         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 147         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 148
 149         uint8_t UsedKeyCodes = 0;
 150
 151         if (JoyStatus_LCL & JOY_UP)
 152           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_A;
 153         else if (JoyStatus_LCL & JOY_DOWN)
 154           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_B;
 155
 156         if (JoyStatus_LCL & JOY_LEFT)
 157           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_C;
 158         else if (JoyStatus_LCL & JOY_RIGHT)
 159           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_D;
 160
 161         if (JoyStatus_LCL & JOY_PRESS)
 162           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_E;
 163
 164         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 165           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_F;
 166
 167         if (UsedKeyCodes)
 168           KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 169
 170         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 171         return false;
 172 }
 173
 174 /** HID class driver callback function for the processing of HID reports from the host.
 175  *
 176  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 177  *  \param[in] ReportID    Report ID of the received report from the host
 178  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 179  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 180  *  \param[in] ReportSize  Size in bytes of the received HID report
 181  */
 182 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 183                                           const uint8_t ReportID,
 184                                           const uint8_t ReportType,
 185                                           const void* ReportData,
 186                                           const uint16_t ReportSize)
 187 {
 188         uint8_t  LEDMask   = LEDS_NO_LEDS;
 189         uint8_t* LEDReport = (uint8_t*)ReportData;
 190
 191         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 192           LEDMask |= LEDS_LED1;
 193
 194         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 195           LEDMask |= LEDS_LED3;
 196
 197         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 198           LEDMask |= LEDS_LED4;
 199
 200         LEDs_SetAllLEDs(LEDMask);
 201 }
 202