Demos/Device/ClassDriver/Keyboard/Keyboard.c

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