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 /** 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
  93         for (;;)
  94         {
  95                 MS_Device_USBTask(&Disk_MS_Interface);
  96                 HID_Device_USBTask(&Keyboard_HID_Interface);
  97                 USB_USBTask();
  98         }
  99 }
 100
 101 /** Configures the board hardware and chip peripherals for the demo's functionality. */
 102 void SetupHardware(void)
 103 {
 104         /* Disable watchdog if enabled by bootloader/fuses */
 105         MCUSR &= ~(1 << WDRF);
 106         wdt_disable();
 107
 108         /* Disable clock division */
 109         clock_prescale_set(clock_div_1);
 110
 111         /* Hardware Initialization */
 112         LEDs_Init();
 113         Joystick_Init();
 114         Buttons_Init();
 115         SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
 116         Dataflash_Init();
 117         USB_Init();
 118
 119         /* Clear Dataflash sector protections, if enabled */
 120         DataflashManager_ResetDataflashProtections();
 121
 122         /* Millisecond timer initialization, with output compare interrupt enabled for the HID idle timing */
 123         OCR0A  = ((F_CPU / 64) / 1000);
 124         TCCR0A = (1 << WGM01);
 125         TCCR0B = ((1 << CS01) | (1 << CS00));
 126         TIMSK0 = (1 << OCIE0A);
 127 }
 128
 129 /** Event handler for the library USB Connection event. */
 130 void EVENT_USB_Device_Connect(void)
 131 {
 132         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 133 }
 134
 135 /** Event handler for the library USB Disconnection event. */
 136 void EVENT_USB_Device_Disconnect(void)
 137 {
 138         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 139 }
 140
 141 /** Event handler for the library USB Configuration Changed event. */
 142 void EVENT_USB_Device_ConfigurationChanged(void)
 143 {
 144         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 145
 146         if (!(MS_Device_ConfigureEndpoints(&Disk_MS_Interface)))
 147           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 148         if (!(HID_Device_ConfigureEndpoints(&Keyboard_HID_Interface)))
 149           LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 150 }
 151
 152 /** Event handler for the library USB Unhandled Control Request event. */
 153 void EVENT_USB_Device_UnhandledControlRequest(void)
 154 {
 155         MS_Device_ProcessControlRequest(&Disk_MS_Interface);
 156         HID_Device_ProcessControlRequest(&Keyboard_HID_Interface);
 157 }
 158
 159 /** Mass Storage class driver callback function the reception of SCSI commands from the host, which must be processed.
 160  *
 161  *  \param[in] MSInterfaceInfo  Pointer to the Mass Storage class interface configuration structure being referenced
 162  */
 163 bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_Device_t* MSInterfaceInfo)
 164 {
 165         bool CommandSuccess;
 166
 167         LEDs_SetAllLEDs(LEDMASK_USB_BUSY);
 168         CommandSuccess = SCSI_DecodeSCSICommand(MSInterfaceInfo);
 169         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 170
 171         return CommandSuccess;
 172 }
 173
 174 /** ISR to keep track of each millisecond interrupt, for determining the HID class idle period remaining when set. */
 175 ISR(TIMER0_COMPA_vect, ISR_BLOCK)
 176 {
 177         HID_Device_MillisecondElapsed(&Keyboard_HID_Interface);
 178 }
 179
 180 /** HID class driver callback function for the creation of HID reports to the host.
 181  *
 182  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 183  *  \param[in,out] ReportID  Report ID requested by the host if non-zero, otherwise callback should set to the generated report ID
 184  *  \param[in] ReportType  Type of the report to create, either REPORT_ITEM_TYPE_In or REPORT_ITEM_TYPE_Feature
 185  *  \param[out] ReportData  Pointer to a buffer where the created report should be stored
 186  *  \param[out] ReportSize  Number of bytes written in the report (or zero if no report is to be sent
 187  *
 188  *  \return Boolean true to force the sending of the report, false to let the library determine if it needs to be sent
 189  */
 190 bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,
 191                                          const uint8_t ReportType, void* ReportData, uint16_t* 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         if (JoyStatus_LCL & JOY_UP)
 199           KeyboardReport->KeyCode[0] = 0x04; // A
 200         else if (JoyStatus_LCL & JOY_DOWN)
 201           KeyboardReport->KeyCode[0] = 0x05; // B
 202
 203         if (JoyStatus_LCL & JOY_LEFT)
 204           KeyboardReport->KeyCode[0] = 0x06; // C
 205         else if (JoyStatus_LCL & JOY_RIGHT)
 206           KeyboardReport->KeyCode[0] = 0x07; // D
 207
 208         if (JoyStatus_LCL & JOY_PRESS)
 209           KeyboardReport->KeyCode[0] = 0x08; // E
 210
 211         if (ButtonStatus_LCL & BUTTONS_BUTTON1)
 212           KeyboardReport->KeyCode[0] = 0x09; // F
 213
 214         *ReportSize = sizeof(USB_KeyboardReport_Data_t);
 215         return false;
 216 }
 217
 218 /** HID class driver callback function for the processing of HID reports from the host.
 219  *
 220  *  \param[in] HIDInterfaceInfo  Pointer to the HID class interface configuration structure being referenced
 221  *  \param[in] ReportID  Report ID of the received report from the host
 222  *  \param[in] ReportData  Pointer to a buffer where the created report has been stored
 223  *  \param[in] ReportSize  Size in bytes of the received HID report
 224  */
 225 void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
 226                                           const void* ReportData, const uint16_t ReportSize)
 227 {
 228         uint8_t  LEDMask   = LEDS_NO_LEDS;
 229         uint8_t* LEDReport = (uint8_t*)ReportData;
 230
 231         if (*LEDReport & 0x01) // NUM Lock
 232           LEDMask |= LEDS_LED1;
 233
 234         if (*LEDReport & 0x02) // CAPS Lock
 235           LEDMask |= LEDS_LED3;
 236
 237         if (*LEDReport & 0x04) // SCROLL Lock
 238           LEDMask |= LEDS_LED4;
 239
 240         LEDs_SetAllLEDs(LEDMask);
 241 }
 242