Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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                                 .DataINEndpoint            =
  50                                         {
  51                                                 .Address           = MASS_STORAGE_IN_EPADDR,
  52                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  53                                                 .Banks             = 1,
  54                                         },
  55                                 .DataOUTEndpoint            =
  56                                         {
  57                                                 .Address           = MASS_STORAGE_OUT_EPADDR,
  58                                                 .Size              = MASS_STORAGE_IO_EPSIZE,
  59                                                 .Banks             = 1,
  60                                         },
  61                                 .TotalLUNs                 = TOTAL_LUNS,
  62                         },
  63         };
  64
  65 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  66 static uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  67
  68 /** LUFA HID Class driver interface configuration and state information. This structure is
  69  *  passed to all HID Class driver functions, so that multiple instances of the same class
  70  *  within a device can be differentiated from one another.
  71  */
  72 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  73         {
  74                 .Config =
  75                         {
  76                                 .InterfaceNumber              = 1,
  77                                 .ReportINEndpoint             =
  78                                         {
  79                                                 .Address              = KEYBOARD_EPADDR,
  80                                                 .Size                 = KEYBOARD_EPSIZE,
  81                                                 .Banks                = 1,
  82                                         },
  83                                 .PrevReportINBuffer           = PrevKeyboardHIDReportBuffer,
  84                                 .PrevReportINBufferSize       = sizeof(PrevKeyboardHIDReportBuffer),
  85                         },
  86     };
  87
  88 /** Main program entry point. This routine contains the overall program flow, including initial
  89  *  setup of all components and the main program loop.
  90  */
  91 int main(void)
  92 {
  93         SetupHardware();
  94
  95         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  96         GlobalInterruptEnable();
  97
  98         for (;;)
  99         {
 100                 MS_Device_USBTask(&Disk_MS_Interface);
 101                 HID_Device_USBTask(&Keyboard_HID_Interface);
 102                 USB_USBTask();
 103         }
 104 }
 105
 106 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 107 void SetupHardware(void)
 108 {
 109         /* Disable watchdog if enabled by bootloader/fuses */
 110         MCUSR &= ~(1 << WDRF);
 111         wdt_disable();
 112
 113         /* Disable clock division */
 114         clock_prescale_set(clock_div_1);
 115
 116         /* Hardware Initialization */
 117         LEDs_Init();
 118         Joystick_Init();
 119         Buttons_Init();
 120         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 121         Dataflash_Init();
 122         USB_Init();
 123
 124         /* Check if the Dataflash is working, abort if not */
 125         if (!(DataflashManager_CheckDataflashOperation()))
 126         {
 127                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 128                 for(;;);
 129         }
 130
 131         /* Clear Dataflash sector protections, if enabled */
 132         DataflashManager_ResetDataflashProtections();
 133 }
 134
 135 /** Event handler for the library USB Connection event. */
 136 void EVENT_USB_Device_Connect(void)
 137 {
 138         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 139 }
 140
 141 /** Event handler for the library USB Disconnection event. */
 142 void EVENT_USB_Device_Disconnect(void)
 143 {
 144         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 145 }
 146
 147 /** Event handler for the library USB Configuration Changed event. */
 148 void EVENT_USB_Device_ConfigurationChanged(void)
 149 {
 150         bool ConfigSuccess = true;
 151
 152         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 153         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 154
 155         USB_Device_EnableSOFEvents();
 156
 157         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 158 }
 159
 160 /** Event handler for the library USB Control Request reception event. */
 161 void EVENT_USB_Device_ControlRequest(void)
 162 {
 163         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 164         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 165 }
 166
 167 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 168  *
 169  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 170  */
 171 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 172 {
 173         bool CommandSuccess;
 174
 175         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 176         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 177         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 178
 179         return CommandSuccess;
 180 }
 181
 182 /** Event handler for the USB device Start Of Frame event. */
 183 void EVENT_USB_Device_StartOfFrame(void)
 184 {
 185     HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 186 }
 187
 188 /** HID class driver callback function for the creation of HID reports to the host.
 189  *
 190  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 191  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 192  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 193  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 194  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 195  *
 196  *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 197  */
 198 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 199                                          uint8_t* const ReportID,
 200                                          const uint8_t ReportType,
 201                                          void* ReportData,
 202                                          uint16_t* const ReportSize)
 203 {
 204         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 205
 206         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 207         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 208
 209         KeyboardReport->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
 210
 211         if (JoyStatus_LCL & JOY_UP)
 212           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_A;
 213         else if (JoyStatus_LCL & JOY_DOWN)
 214           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_B;
 215
 216         if (JoyStatus_LCL & JOY_LEFT)
 217           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_C;
 218         else if (JoyStatus_LCL & JOY_RIGHT)
 219           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_D;
 220
 221         if (JoyStatus_LCL & JOY_PRESS)
 222           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_E;
 223
 224         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 225           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_F;
 226
 227         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 228         return false;
 229 }
 230
 231 /** HID class driver callback function for the processing of HID reports from the host.
 232  *
 233  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 234  *  \param[in] ReportID    Report ID of the received report from the host
 235  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 236  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 237  *  \param[in] ReportSize  Size in bytes of the received HID report
 238  */
 239 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 240                                           const uint8_t ReportID,
 241                                           const uint8_t ReportType,
 242                                           const void* ReportData,
 243                                           const uint16_t ReportSize)
 244 {
 245         uint8_t  LEDMask   = LEDS_NO_LEDS;
 246         uint8_t* LEDReport = (uint8_t*)ReportData;
 247
 248         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 249           LEDMask |= LEDS_LED1;
 250
 251         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 252           LEDMask |= LEDS_LED3;
 253
 254         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 255           LEDMask |= LEDS_LED4;
 256
 257         LEDs_SetAllLEDs(LEDMask);
 258 }
 259