Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.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   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 static 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         sei();
  93
  94         for (;;)
  95         {
  96                 MS_Device_USBTask(&Disk_MS_Interface);
  97                 HID_Device_USBTask(&Keyboard_HID_Interface);
  98                 USB_USBTask();
  99         }
 100 }
 101
 102 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 103 void SetupHardware(void)
 104 {
 105         /* Disable watchdog if enabled by bootloader/fuses */
 106         MCUSR &= ~(1 << WDRF);
 107         wdt_disable();
 108
 109         /* Disable clock division */
 110         clock_prescale_set(clock_div_1);
 111
 112         /* Hardware Initialization */
 113         LEDs_Init();
 114         Joystick_Init();
 115         Buttons_Init();
 116         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 117         Dataflash_Init();
 118         USB_Init();
 119
 120         /* Check if the Dataflash is working, abort if not */
 121         if (!(DataflashManager_CheckDataflashOperation()))
 122         {
 123                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 124                 for(;;);
 125         }
 126
 127         /* Clear Dataflash sector protections, if enabled */
 128         DataflashManager_ResetDataflashProtections();
 129 }
 130
 131 /** Event handler for the library USB Connection event. */
 132 void EVENT_USB_Device_Connect(void)
 133 {
 134         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 135 }
 136
 137 /** Event handler for the library USB Disconnection event. */
 138 void EVENT_USB_Device_Disconnect(void)
 139 {
 140         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 141 }
 142
 143 /** Event handler for the library USB Configuration Changed event. */
 144 void EVENT_USB_Device_ConfigurationChanged(void)
 145 {
 146         bool ConfigSuccess = true;
 147
 148         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 149         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 150
 151         USB_Device_EnableSOFEvents();
 152
 153         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 154 }
 155
 156 /** Event handler for the library USB Control Request reception event. */
 157 void EVENT_USB_Device_ControlRequest(void)
 158 {
 159         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 160         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 161 }
 162
 163 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 164  *
 165  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 166  */
 167 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* const MSInterfaceInfo)
 168 {
 169         bool CommandSuccess;
 170
 171         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 172         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 173         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 174
 175         return CommandSuccess;
 176 }
 177
 178 /** Event handler for the USB device Start Of Frame event. */
 179 void EVENT_USB_Device_StartOfFrame(void)
 180 {
 181     HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 182 }
 183
 184 /** HID class driver callback function for the creation of HID reports to the host.
 185  *
 186  *  \param[in]     HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 187  *  \param[in,out] ReportID    Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 188  *  \param[in]     ReportType  Type of the report to create, either HID_REPORT_ITEM_In or HID_REPORT_ITEM_Feature
 189  *  \param[out]    ReportData  Pointer to a buffer where the created report should be stored
 190  *  \param[out]    ReportSize  Number of bytes written in the report (or zero if no report is to be sent)
 191  *
 192  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 193  */
 194 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 195                                          uint8_t* const ReportID,
 196                                          const uint8_t ReportType,
 197                                          void* ReportData,
 198                                          uint16_t* const ReportSize)
 199 {
 200         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 201
 202         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 203         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 204
 205         KeyboardReport->Modifier = HID_KEYBOARD_MODIFIER_LEFTSHIFT;
 206
 207         if (JoyStatus_LCL & JOY_UP)
 208           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_A;
 209         else if (JoyStatus_LCL & JOY_DOWN)
 210           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_B;
 211
 212         if (JoyStatus_LCL & JOY_LEFT)
 213           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_C;
 214         else if (JoyStatus_LCL & JOY_RIGHT)
 215           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_D;
 216
 217         if (JoyStatus_LCL & JOY_PRESS)
 218           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_E;
 219
 220         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 221           KeyboardReport->KeyCode[0] = HID_KEYBOARD_SC_F;
 222
 223         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 224         return false;
 225 }
 226
 227 /** HID class driver callback function for the processing of HID reports from the host.
 228  *
 229  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 230  *  \param[in] ReportID    Report ID of the received report from the host
 231  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 232  *  \param[in] ReportData  Pointer to a buffer where the received report has been stored
 233  *  \param[in] ReportSize  Size in bytes of the received HID report
 234  */
 235 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 236                                           const uint8_t ReportID,
 237                                           const uint8_t ReportType,
 238                                           const void* ReportData,
 239                                           const uint16_t ReportSize)
 240 {
 241         uint8_t  LEDMask   = LEDS_NO_LEDS;
 242         uint8_t* LEDReport = (uint8_t*)ReportData;
 243
 244         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 245           LEDMask |= LEDS_LED1;
 246
 247         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 248           LEDMask |= LEDS_LED3;
 249
 250         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 251           LEDMask |= LEDS_LED4;
 252
 253         LEDs_SetAllLEDs(LEDMask);
 254 }
 255