Demos/Device/ClassDriver/MassStorageKeyboard/MassStorageKeyboard.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11   Copyright 2009  Matthias Hullin (lufa [at] matthias [dot] hullin [dot] net)
  12
  13   Permission to use, copy, modify, and distribute this software
  14   and its documentation for any purpose and without fee is hereby
  15   granted, provided that the above copyright notice appear in all
  16   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 /** Buffer to hold the previously generated Keyboard HID report, for comparison purposes inside the HID class driver. */
  41 uint8_t PrevKeyboardHIDReportBuffer[sizeof(USB_KeyboardReport_Data_t)];
  42
  43 /** LUFA Mass Storage Class driver interface configuration and state information. This structure is
  44  *  passed to all Mass Storage Class driver functions, so that multiple instances of the same class
  45  *  within a device can be differentiated from one another.
  46  */
  47 USB_ClassInfo_MS_Device_t Disk_MS_Interface =
  48         {
  49                 .Config =
  50                         {
  51                                 .InterfaceNumber        = 0,
  52
  53                                 .DataINEndpointNumber   = MASS_STORAGE_IN_EPNUM,
  54                                 .DataINEndpointSize     = MASS_STORAGE_IO_EPSIZE,
  55
  56                                 .DataOUTEndpointNumber  = MASS_STORAGE_OUT_EPNUM,
  57                                 .DataOUTEndpointSize    = MASS_STORAGE_IO_EPSIZE,
  58
  59                                 .TotalLUNs              = TOTAL_LUNS,
  60                         },
  61         };
  62
  63 /** LUFA HID Class driver interface configuration and state information. This structure is
  64  *  passed to all HID Class driver functions, so that multiple instances of the same class
  65  *  within a device can be differentiated from one another.
  66  */
  67 USB_ClassInfo_HID_Device_t Keyboard_HID_Interface =
  68         {
  69                 .Config =
  70                         {
  71                                 .InterfaceNumber         = 1,
  72
  73                                 .ReportINEndpointNumber  = KEYBOARD_EPNUM,
  74                                 .ReportINEndpointSize    = KEYBOARD_EPSIZE,
  75
  76                                 .PrevReportINBuffer      = PrevKeyboardHIDReportBuffer,
  77                                 .PrevReportINBufferSize  = sizeof(PrevKeyboardHIDReportBuffer),
  78                         },
  79     };
  80
  81 /** Main program entry point. This routine contains the overall program flow, including initial
  82  *  setup of all components and the main program loop.
  83  */
  84 int main(void)
  85 {
  86         SetupHardware();
  87
  88         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  89
  90         for (;;)
  91         {
  92                 MS_Device_USBTask(&Disk_MS_Interface);
  93                 HID_Device_USBTask(&Keyboard_HID_Interface);
  94                 USB_USBTask();
  95         }
  96 }
  97
  98 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  99 void SetupHardware(void)
 100 {
 101         /* Disable watchdog if enabled by bootloader/fuses */
 102         MCUSR &= ~(1 << WDRF);
 103         wdt_disable();
 104
 105         /* Disable clock division */
 106         clock_prescale_set(clock_div_1);
 107
 108         /* Hardware Initialization */
 109         LEDs_Init();
 110         Joystick_Init();
 111         Buttons_Init();
 112         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 113         Dataflash_Init();
 114         USB_Init();
 115
 116         /* Clear Dataflash sector protections, if enabled */
 117         DataflashManager_ResetDataflashProtections();
 118
 119         /* Millisecond timer initialization, with output compare interrupt enabled for the HID idle timing */
 120         OCR0A  = ((F_CPU / 64) / 1000);
 121         TCCR0A = (1 << WGM01);
 122         TCCR0B = ((1 << CS01) | (1 << CS00));
 123         TIMSK0 = (1 << OCIE0A);
 124 }
 125
 126 /** Event handler for the library USB Connection event. */
 127 void EVENT_USB_Device_Connect(void)
 128 {
 129         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 130 }
 131
 132 /** Event handler for the library USB Disconnection event. */
 133 void EVENT_USB_Device_Disconnect(void)
 134 {
 135         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 136 }
 137
 138 /** Event handler for the library USB Configuration Changed event. */
 139 void EVENT_USB_Device_ConfigurationChanged(void)
 140 {
 141         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 142
 143         if (!(MS_Device_ConfigureEndpoints(&Disk_MS_Interface)))
 144           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 145         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 146           LEDs_SetAllLEDs(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* 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 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 172 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 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[out] ReportData  Pointer to a buffer where the created report should be stored
 182  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 183  *
 184  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 185  */
 186 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 187                                          void* ReportData, uint16_t* ReportSize)
 188 {
 189         USB_KeyboardReport_Data_t* KeyboardReport = (USB_KeyboardReport_Data_t*)ReportData;
 190
 191         uint8_t JoyStatus_LCL    = Joystick_GetStatus();
 192         uint8_t ButtonStatus_LCL = Buttons_GetStatus();
 193
 194         if (JoyStatus_LCL & JOY_UP)
 195           KeyboardReport->KeyCode[0] = 0x04; // A
 196         else if (JoyStatus_LCL & JOY_DOWN)
 197           KeyboardReport->KeyCode[0] = 0x05; // B
 198
 199         if (JoyStatus_LCL & JOY_LEFT)
 200           KeyboardReport->KeyCode[0] = 0x06; // C
 201         else if (JoyStatus_LCL & JOY_RIGHT)
 202           KeyboardReport->KeyCode[0] = 0x07; // D
 203
 204         if (JoyStatus_LCL & JOY_PRESS)
 205           KeyboardReport->KeyCode[0] = 0x08; // E
 206
 207         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 208           KeyboardReport->KeyCode[0] = 0x09; // F
 209
 210         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 211         return false;
 212 }
 213
 214 /** HID class driver callback function for the processing of HID reports from the host.
 215  *
 216  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 217  *  \param[in] ReportID  Report ID of the received report from the host
 218  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 219  *  \param[in] ReportSize  Size in bytes of the received HID report
 220  */
 221 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 222                                           const void* ReportData, const uint16_t ReportSize)
 223 {
 224         uint8_t  LEDMask   = LEDS_NO_LEDS;
 225         uint8_t* LEDReport = (uint8_t*)ReportData;
 226
 227         if (*LEDReport & 0x01) // NUM Lock
 228           LEDMask |= LEDS_LED1;
 229
 230         if (*LEDReport & 0x02) // CAPS Lock
 231           LEDMask |= LEDS_LED3;
 232
 233         if (*LEDReport & 0x04) // SCROLL Lock
 234           LEDMask |= LEDS_LED4;
 235
 236         LEDs_SetAllLEDs(LEDMask);
 237 }
 238