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         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         /* Clear Dataflash sector protections, if enabled */
 121         DataflashManager_ResetDataflashProtections();
 122 }
 123
 124 /** Event handler for the library USB Connection event. */
 125 void EVENT_USB_Device_Connect(void)
 126 {
 127         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 128 }
 129
 130 /** Event handler for the library USB Disconnection event. */
 131 void EVENT_USB_Device_Disconnect(void)
 132 {
 133         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 134 }
 135
 136 /** Event handler for the library USB Configuration Changed event. */
 137 void EVENT_USB_Device_ConfigurationChanged(void)
 138 {
 139         bool ConfigSuccess = true;
 140
 141         ConfigSuccess &= MS_Device_ConfigureEndpoints(&Disk_MS_Interface);
 142         ConfigSuccess &= HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface);
 143
 144         USB_Device_EnableSOFEvents();
 145
 146         LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 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 HID_REPORT_ITEM_In or HID_REPORT_ITEM_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,
 188                                          uint8_t* const ReportID,
 189                                          const uint8_t ReportType,
 190                                          void* ReportData,
 191                                          uint16_t* const ReportSize)
 192 {
 193         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 194
 195         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 196         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 197
 198         KeyboardReport->Modifier = HID_KEYBOARD_MODIFER_LEFTSHIFT;
 199
 200         if (JoyStatus_LCL & JOY_UP)
 201           KeyboardReport->KeyCode[0] = 0x04; // A
 202         else if (JoyStatus_LCL & JOY_DOWN)
 203           KeyboardReport->KeyCode[0] = 0x05; // B
 204
 205         if (JoyStatus_LCL & JOY_LEFT)
 206           KeyboardReport->KeyCode[0] = 0x06; // C
 207         else if (JoyStatus_LCL & JOY_RIGHT)
 208           KeyboardReport->KeyCode[0] = 0x07; // D
 209
 210         if (JoyStatus_LCL & JOY_PRESS)
 211           KeyboardReport->KeyCode[0] = 0x08; // E
 212
 213         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 214           KeyboardReport->KeyCode[0] = 0x09; // F
 215
 216         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 217         return false;
 218 }
 219
 220 /** HID class driver callback function for the processing of HID reports from the host.
 221  *
 222  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 223  *  \param[in] ReportID    Report ID of the received report from the host
 224  *  \param[in] ReportType  The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
 225  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 226  *  \param[in] ReportSize  Size in bytes of the received HID report
 227  */
 228 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,
 229                                           const uint8_t ReportID,
 230                                           const uint8_t ReportType,
 231                                           const void* ReportData,
 232                                           const uint16_t ReportSize)
 233 {
 234         uint8_t  LEDMask   = LEDS_NO_LEDS;
 235         uint8_t* LEDReport = (uint8_t*)ReportData;
 236
 237         if (*LEDReport & HID_KEYBOARD_LED_NUMLOCK)
 238           LEDMask |= LEDS_LED1;
 239
 240         if (*LEDReport & HID_KEYBOARD_LED_CAPSLOCK)
 241           LEDMask |= LEDS_LED3;
 242
 243         if (*LEDReport & HID_KEYBOARD_LED_SCROLLLOCK)
 244           LEDMask |= LEDS_LED4;
 245
 246         LEDs_SetAllLEDs(LEDMask);
 247 }
 248