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 #if (ARCH == ARCH_AVR8)
 110         /* Disable watchdog if enabled by bootloader/fuses */
 111         MCUSR &= ~(1 << WDRF);
 112         wdt_disable();
 113
 114         /* Disable clock division */
 115         clock_prescale_set(clock_div_1);
 116 #elif (ARCH == ARCH_XMEGA)
 117         /* Start the PLL to multiply the 2MHz RC oscillator to 32MHz and switch the CPU core to run from it */
 118         XMEGACLK_StartPLL(CLOCK_SRC_INT_RC2MHZ, 2000000, F_CPU);
 119         XMEGACLK_SetCPUClockSource(CLOCK_SRC_PLL);
 120
 121         /* Start the 32MHz internal RC oscillator and start the DFLL to increase it to 48MHz using the USB SOF as a reference */
 122         XMEGACLK_StartInternalOscillator(CLOCK_SRC_INT_RC32MHZ);
 123         XMEGACLK_StartDFLL(CLOCK_SRC_INT_RC32MHZ, DFLL_REF_INT_USBSOF, F_USB);
 124
 125         PMIC.CTRL = PMIC_LOLVLEN_bm | PMIC_MEDLVLEN_bm | PMIC_HILVLEN_bm;
 126 #endif
 127
 128         /* Hardware Initialization */
 129         LEDs_Init();
 130         Joystick_Init();
 131         Buttons_Init();
 132         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 133         Dataflash_Init();
 134         USB_Init();
 135
 136         /* Check if the Dataflash is working, abort if not */
 137         if (!(DataflashManager_CheckDataflashOperation()))
 138         {
 139                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 140                 for(;;);
 141         }
 142
 143         /* Clear Dataflash sector protections, if enabled */
 144         DataflashManager_ResetDataflashProtections();
 145 }
 146
 147 /** Event handler for the library USB Connection event. */
 148 void EVENT_USB_Device_Connect(void)
 149 {
 150         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 151 }
 152
 153 /** Event handler for the library USB Disconnection event. */
 154 void EVENT_USB_Device_Disconnect(void)
 155 {
 156         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 157 }
 158
 159 /** Event handler for the library USB Configuration Changed event. */
 160 void EVENT_USB_Device_ConfigurationChanged(void)
 161 {
 162         bool ConfigSuccess = true;
 163
 164         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 165         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 166
 167         USB_Device_EnableSOFEvents();
 168
 169         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 170 }
 171
 172 /** Event handler for the library USB Control Request reception event. */
 173 void EVENT_USB_Device_ControlRequest(void)
 174 {
 175         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 176         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 177 }
 178
 179 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 180  *
 181  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 182  */
 183 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 184 {
 185         bool CommandSuccess;
 186
 187         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 188         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 189         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 190
 191         return CommandSuccess;
 192 }
 193
 194 /** Event handler for the USB device Start Of Frame event. */
 195 void EVENT_USB_Device_StartOfFrame(void)
 196 {
 197     HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 198 }
 199
 200 /** HID class driver callback function for the creation of HID reports to the host.
 201  *
 202  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 203  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 204  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 205  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 206  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 207  *
 208  *  \return Boolean \c true to force the sending of the report, \c false to let the library determine if it needs to be sent
 209  */
 210 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 211                                          uint8_t* const ReportID,
 212                                          const uint8_t ReportType,
 213                                          void* ReportData,
 214                                          uint16_t* const ReportSize)
 215 {
 216         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 217
 218         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 219         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 220
 221         KeyboardReport->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
 222
 223         if (JoyStatus_LCL & JOY_UP)
 224           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_A;
 225         else if (JoyStatus_LCL & JOY_DOWN)
 226           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_B;
 227
 228         if (JoyStatus_LCL & JOY_LEFT)
 229           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_C;
 230         else if (JoyStatus_LCL & JOY_RIGHT)
 231           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_D;
 232
 233         if (JoyStatus_LCL & JOY_PRESS)
 234           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_E;
 235
 236         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 237           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_F;
 238
 239         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 240         return false;
 241 }
 242
 243 /** HID class driver callback function for the processing of HID reports from the host.
 244  *
 245  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 246  *  \param[in] ReportID    Report ID of the received report from the host
 247  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 248  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 249  *  \param[in] ReportSize  Size in bytes of the received HID report
 250  */
 251 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 252                                           const uint8_t ReportID,
 253                                           const uint8_t ReportType,
 254                                           const void* ReportData,
 255                                           const uint16_t ReportSize)
 256 {
 257         uint8_t  LEDMask   = LEDS_NO_LEDS;
 258         uint8_t* LEDReport = (uint8_t*)ReportData;
 259
 260         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 261           LEDMask |= LEDS_LED1;
 262
 263         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 264           LEDMask |= LEDS_LED3;
 265
 266         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 267           LEDMask |= LEDS_LED4;
 268
 269         LEDs_SetAllLEDs(LEDMask);
 270 }
 271