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 static 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
  62 /** Main program entry point. This routine contains the overall program flow, including initial
  63  *  setup of all components and the main program loop.
  64  */
  65 int main(void)
  66 {
  67         SetupHardware();
  68
  69         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  70         sei();
  71
  72         for (;;)
  73         {
  74                 HID_Device_USBTask(&Keyboard_HID_Interface);
  75                 USB_USBTask();
  76         }
  77 }
  78
  79 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  80 void SetupHardware()
  81 {
  82         /* Disable watchdog if enabled by bootloader/fuses */
  83         MCUSR &= ~(1 << WDRF);
  84         wdt_disable();
  85
  86         /* Disable clock division */
  87         clock_prescale_set(clock_div_1);
  88
  89         /* Hardware Initialization */
  90         Joystick_Init();
  91         LEDs_Init();
  92         Buttons_Init();
  93         USB_Init();
  94 }
  95
  96 /** Event handler for the library USB Connection event. */
  97 void EVENT_USB_Device_Connect(void)
  98 {
  99         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 100 }
 101
 102 /** Event handler for the library USB Disconnection event. */
 103 void EVENT_USB_Device_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_Device_ConfigurationChanged(void)
 110 {
 111         bool ConfigSuccess = true;
 112
 113         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 114
 115         USB_Device_EnableSOFEvents();
 116
 117         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 118 }
 119
 120 /** Event handler for the library USB Control Request reception event. */
 121 void EVENT_USB_Device_ControlRequest(void)
 122 {
 123         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 124 }
 125
 126 /** Event handler for the USB device Start Of Frame event. */
 127 void EVENT_USB_Device_StartOfFrame(void)
 128 {
 129         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 130 }
 131
 132 /** HID class driver callback function for the creation of HID reports to the host.
 133  *
 134  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 135  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 136  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 137  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 138  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 139  *
 140  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 141  */
 142 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 143                                          uint8_t* const ReportID,
 144                                          const uint8_t ReportType,
 145                                          void* ReportData,
 146                                          uint16_t* const ReportSize)
 147 {
 148         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 149
 150         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 151         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 152
 153         uint8_t UsedKeyCodes = 0;
 154
 155         if (JoyStatus_LCL & JOY_UP)
 156           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_A;
 157         else if (JoyStatus_LCL & JOY_DOWN)
 158           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_B;
 159
 160         if (JoyStatus_LCL & JOY_LEFT)
 161           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_C;
 162         else if (JoyStatus_LCL & JOY_RIGHT)
 163           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_D;
 164
 165         if (JoyStatus_LCL & JOY_PRESS)
 166           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_E;
 167
 168         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 169           KeyboardReport->KeyCode[UsedKeyCodes++] = HID_KEYBOARD_SC_F;
 170
 171         if (UsedKeyCodes)
 172           KeyboardReport->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
 173
 174         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 175         return false;
 176 }
 177
 178 /** HID class driver callback function for the processing of HID reports from the host.
 179  *
 180  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 181  *  \param[in] ReportID    Report ID of the received report from the host
 182  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 183  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 184  *  \param[in] ReportSize  Size in bytes of the received HID report
 185  */
 186 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 187                                           const uint8_t ReportID,
 188                                           const uint8_t ReportType,
 189                                           const void* ReportData,
 190                                           const uint16_t ReportSize)
 191 {
 192         uint8_t  LEDMask   = LEDS_NO_LEDS;
 193         uint8_t* LEDReport = (uint8_t*)ReportData;
 194
 195         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 196           LEDMask |= LEDS_LED1;
 197
 198         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 199           LEDMask |= LEDS_LED3;
 200
 201         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 202           LEDMask |= LEDS_LED4;
 203
 204         LEDs_SetAllLEDs(LEDMask);
 205 }
 206