Demos/Device/ClassDriver/Keyboard/Keyboard.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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, distribute, and sell this
  14   software and its documentation for any purpose is hereby granted
  15   without fee, provided that the above copyright notice appear in
  16   all 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                                 .ReportINEndpointDoubleBank   = false,
  56
  57                                 .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
  58                                 .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
  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
  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         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 111
 112         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 113           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 114
 115         USB_Device_EnableSOFEvents();
 116 }
 117
 118 /** Event handler for the library USB Unhandled Control Request event. */
 119 void EVENT_USB_Device_UnhandledControlRequest(void)
 120 {
 121         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 122 }
 123
 124 /** Event handler for the USB device Start Of Frame event. */
 125 void EVENT_USB_Device_StartOfFrame(void)
 126 {
 127         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 128 }
 129
 130 /** HID class driver callback function for the creation of HID reports to the host.
 131  *
 132  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 133  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 134  *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 135  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 136  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 137  *
 138  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 139  */
 140 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 141                                          const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
 142 {
 143         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 144
 145         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 146         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 147
 148         uint8_t UsedKeyCodes = 0;
 149
 150         if (JoyStatus_LCL & JOY_UP)
 151           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x04; // A
 152         else if (JoyStatus_LCL & JOY_DOWN)
 153           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x05; // B
 154
 155         if (JoyStatus_LCL & JOY_LEFT)
 156           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x06; // C
 157         else if (JoyStatus_LCL & JOY_RIGHT)
 158           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x07; // D
 159
 160         if (JoyStatus_LCL & JOY_PRESS)
 161           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x08; // E
 162
 163         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 164           KeyboardReport->KeyCode[UsedKeyCodes++] = 0x09; // F
 165
 166         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 167         return false;
 168 }
 169
 170 /** HID class driver callback function for the processing of HID reports from the host.
 171  *
 172  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 173  *  \param[in] ReportID  Report ID of the received report from the host
 174  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 175  *  \param[in] ReportSize  Size in bytes of the received HID report
 176  */
 177 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 178                                           const void* ReportData, const uint16_t ReportSize)
 179 {
 180         uint8_t  LEDMask   = LEDS_NO_LEDS;
 181         uint8_t* LEDReport = (uint8_t*)ReportData;
 182
 183         if (*LEDReport & 0x01) // NUM Lock
 184           LEDMask |= LEDS_LED1;
 185
 186         if (*LEDReport & 0x02) // CAPS Lock
 187           LEDMask |= LEDS_LED3;
 188
 189         if (*LEDReport & 0x04) // SCROLL Lock
 190           LEDMask |= LEDS_LED4;
 191
 192         LEDs_SetAllLEDs(LEDMask);
 193 }