Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.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  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2010  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
  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 MassStorageKeyboard demo. This file contains the main tasks of
  35  *  the demo and is responsible for the initial application hardware configuration.
  36  */
  37
  38 #include "MassStorageKeyboard.h"
  39
  40 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
  41  *  passed to all Mass Storage Class driver functions, so that multiple instances of the same class
  42  *  within a device can be differentiated from one another.
  43  */
  44 USB_ClassInfo_MS_Device_t Disk_MS_Interface =
  45         {
  46                 .Config =
  47                         {
  48                                 .InterfaceNumber           = 0,
  49
  50                                 .DataINEndpointNumber      = MASS_STORAGE_IN_EPNUM,
  51                                 .DataINEndpointSize        = MASS_STORAGE_IO_EPSIZE,
  52                                 .DataINEndpointDoubleBank  = false,
  53
  54                                 .DataOUTEndpointNumber     = MASS_STORAGE_OUT_EPNUM,
  55                                 .DataOUTEndpointSize       = MASS_STORAGE_IO_EPSIZE,
  56                                 .DataOUTEndpointDoubleBank = false,
  57
  58                                 .TotalLUNs                 = TOTAL_LUNS,
  59                         },
  60         };
  61
  62 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  63 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  64
  65 /** LUFA HID Class driver interface configuration and state information. This structure is
  66  *  passed to all HID Class driver functions, so that multiple instances of the same class
  67  *  within a device can be differentiated from one another.
  68  */
  69 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  70         {
  71                 .Config =
  72                         {
  73                                 .InterfaceNumber              = 1,
  74
  75                                 .ReportINEndpointNumber       = KEYBOARD_EPNUM,
  76                                 .ReportINEndpointSize         = KEYBOARD_EPSIZE,
  77                                 .ReportINEndpointDoubleBank   = false,
  78
  79                                 .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
  80                                 .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
  81                         },
  82     };
  83
  84 /** Main program entry point. This routine contains the overall program flow, including initial
  85  *  setup of all components and the main program loop.
  86  */
  87 int main(void)
  88 {
  89         SetupHardware();
  90
  91         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  92
  93         for (;;)
  94         {
  95                 MS_Device_USBTask(&Disk_MS_Interface);
  96                 HID_Device_USBTask(&Keyboard_HID_Interface);
  97                 USB_USBTask();
  98         }
  99 }
 100
 101 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 102 void SetupHardware(void)
 103 {
 104         /* Disable watchdog if enabled by bootloader/fuses */
 105         MCUSR &= ~(1 << WDRF);
 106         wdt_disable();
 107
 108         /* Disable clock division */
 109         clock_prescale_set(clock_div_1);
 110
 111         /* Hardware Initialization */
 112         LEDs_Init();
 113         Joystick_Init();
 114         Buttons_Init();
 115         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 116         Dataflash_Init();
 117         USB_Init();
 118
 119         /* Clear Dataflash sector protections, if enabled */
 120         DataflashManager_ResetDataflashProtections();
 121 }
 122
 123 /** Event handler for the library USB Connection event. */
 124 void EVENT_USB_Device_Connect(void)
 125 {
 126         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 127 }
 128
 129 /** Event handler for the library USB Disconnection event. */
 130 void EVENT_USB_Device_Disconnect(void)
 131 {
 132         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 133 }
 134
 135 /** Event handler for the library USB Configuration Changed event. */
 136 void EVENT_USB_Device_ConfigurationChanged(void)
 137 {
 138         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 139
 140         if (!(MS_Device_ConfigureEndpoints(&Disk_MS_Interface)))
 141           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 142
 143         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 144           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 145
 146         USB_Device_EnableSOFEvents();
 147 }
 148
 149 /** Event handler for the library USB Unhandled Control Request event. */
 150 void EVENT_USB_Device_UnhandledControlRequest(void)
 151 {
 152         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 153         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 154 }
 155
 156 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 157  *
 158  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 159  */
 160 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 161 {
 162         bool CommandSuccess;
 163
 164         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 165         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 166         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 167
 168         return CommandSuccess;
 169 }
 170
 171 /** Event handler for the USB device Start Of Frame event. */
 172 void EVENT_USB_Device_StartOfFrame(void)
 173 {
 174     HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 175 }
 176
 177 /** HID class driver callback function for the creation of HID reports to the host.
 178  *
 179  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 180  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 181  *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 182  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 183  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 184  *
 185  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 186  */
 187 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 188                                          const uint8_t ReportType, void* ReportData, uint16_t* ReportSize)
 189 {
 190         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 191
 192         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 193         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 194
 195         KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 196
 197         if (JoyStatus_LCL & JOY_UP)
 198           KeyboardReport->KeyCode[0] = 0x04; // A
 199         else if (JoyStatus_LCL & JOY_DOWN)
 200           KeyboardReport->KeyCode[0] = 0x05; // B
 201
 202         if (JoyStatus_LCL & JOY_LEFT)
 203           KeyboardReport->KeyCode[0] = 0x06; // C
 204         else if (JoyStatus_LCL & JOY_RIGHT)
 205           KeyboardReport->KeyCode[0] = 0x07; // D
 206
 207         if (JoyStatus_LCL & JOY_PRESS)
 208           KeyboardReport->KeyCode[0] = 0x08; // E
 209
 210         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 211           KeyboardReport->KeyCode[0] = 0x09; // F
 212
 213         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 214         return false;
 215 }
 216
 217 /** HID class driver callback function for the processing of HID reports from the host.
 218  *
 219  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 220  *  \param[in] ReportID  Report ID of the received report from the host
 221  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 222  *  \param[in] ReportSize  Size in bytes of the received HID report
 223  */
 224 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 225                                           const void* ReportData, const uint16_t ReportSize)
 226 {
 227         uint8_t  LEDMask   = LEDS_NO_LEDS;
 228         uint8_t* LEDReport = (uint8_t*)ReportData;
 229
 230         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 231           LEDMask |= LEDS_LED1;
 232
 233         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 234           LEDMask |= LEDS_LED3;
 235
 236         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 237           LEDMask |= LEDS_LED4;
 238
 239         LEDs_SetAllLEDs(LEDMask);
 240 }
 241