Demos/Host/LowLevel/KeyboardHost/KeyboardHost.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
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the KeyboardHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "KeyboardHost.h"
  38
  39 /** Main program entry point. This routine configures the hardware required by the application, then
  40  *  starts the scheduler to run the application tasks.
  41  */
  42 int main(void)
  43 {
  44         SetupHardware();
  45
  46         puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Host Demo running.\r\n" ESC_FG_WHITE));
  47
  48         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  49
  50         for (;;)
  51         {
  52                 Keyboard_HID_Task();
  53                 USB_USBTask();
  54         }
  55 }
  56
  57 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  58 void SetupHardware(void)
  59 {
  60         /* Disable watchdog if enabled by bootloader/fuses */
  61         MCUSR &= ~(1 << WDRF);
  62         wdt_disable();
  63
  64         /* Disable clock division */
  65         clock_prescale_set(clock_div_1);
  66
  67         /* Hardware Initialization */
  68         SerialStream_Init(9600, false);
  69         LEDs_Init();
  70         USB_Init();
  71 }
  72
  73 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  74  *  starts the library USB task to begin the enumeration and USB management process.
  75  */
  76 void EVENT_USB_DeviceAttached(void)
  77 {
  78         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  79         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  80 }
  81
  82 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  83  *  stops the library USB task management process.
  84  */
  85 void EVENT_USB_DeviceUnattached(void)
  86 {
  87         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  88         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  89 }
  90
  91 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  92  *  enumerated by the host and is now ready to be used by the application.
  93  */
  94 void EVENT_USB_DeviceEnumerationComplete(void)
  95 {
  96         LEDs_SetAllLEDs(LEDMASK_USB_READY);
  97 }
  98
  99 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 100 void EVENT_USB_HostError(const uint8_t ErrorCode)
 101 {
 102         USB_ShutDown();
 103
 104         puts_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"));
 105         printf_P(PSTR(" -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 106
 107         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 108         for(;;);
 109 }
 110
 111 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 112  *  enumerating an attached USB device.
 113  */
 114 void EVENT_USB_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
 115 {
 116         puts_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"));
 117         printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);
 118         printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);
 119         printf_P(PSTR(" -- In State %d\r\n" ESC_FG_WHITE), USB_HostState);
 120
 121         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 122 }
 123
 124 /** Reads in and processes the next report from the attached device, displaying the report
 125  *  contents on the board LEDs and via the serial port.
 126  */
 127 void ReadNextReport(void)
 128 {
 129         USB_KeyboardReport_Data_t KeyboardReport;
 130
 131         /* Select keyboard data pipe */
 132         Pipe_SelectPipe(KEYBOARD_DATAPIPE);
 133
 134         /* Unfreeze keyboard data pipe */
 135         Pipe_Unfreeze();
 136
 137         /* Check to see if a packet has been received */
 138         if (!(Pipe_IsINReceived()))
 139         {
 140                 /* Refreeze HID data IN pipe */
 141                 Pipe_Freeze();
 142
 143                 return;
 144         }
 145
 146         /* Ensure pipe contains data before trying to read from it */
 147         if (Pipe_IsReadWriteAllowed())
 148         {
 149                 /* Read in keyboard report data */
 150                 Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));
 151
 152                 /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
 153                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 154
 155                 /* Check if a key has been pressed */
 156                 if (KeyboardReport.KeyCode)
 157                 {
 158                         /* Toggle status LED to indicate keypress */
 159                         if (LEDs_GetLEDs() & LEDS_LED2)
 160                           LEDs_TurnOffLEDs(LEDS_LED2);
 161                         else
 162                           LEDs_TurnOnLEDs(LEDS_LED2);
 163
 164                         char PressedKey = 0;
 165
 166                         /* Retrieve pressed key character if alphanumeric */
 167                         if ((KeyboardReport.KeyCode >= 0x04) && (KeyboardReport.KeyCode <= 0x1D))
 168                           PressedKey = (KeyboardReport.KeyCode - 0x04) + 'A';
 169                         else if ((KeyboardReport.KeyCode >= 0x1E) && (KeyboardReport.KeyCode <= 0x27))
 170                           PressedKey = (KeyboardReport.KeyCode - 0x1E) + '0';
 171                         else if (KeyboardReport.KeyCode == 0x2C)
 172                           PressedKey = ' ';
 173                         else if (KeyboardReport.KeyCode == 0x28)
 174                           PressedKey = '\n';
 175
 176                         /* Print the pressed key character out through the serial port if valid */
 177                         if (PressedKey)
 178                           putchar(PressedKey);
 179                 }
 180         }
 181
 182         /* Clear the IN endpoint, ready for next data packet */
 183         Pipe_ClearIN();
 184
 185         /* Refreeze keyboard data pipe */
 186         Pipe_Freeze();
 187 }
 188
 189 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 190  *  HID reports from the device and display the results onto the board LEDs.
 191  */
 192 void Keyboard_HID_Task(void)
 193 {
 194         uint8_t ErrorCode;
 195
 196         switch (USB_HostState)
 197         {
 198                 case HOST_STATE_Addressed:
 199                         puts_P(PSTR("Getting Config Data.\r\n"));
 200
 201                         /* Get and process the configuration descriptor data */
 202                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 203                         {
 204                                 if (ErrorCode == ControlError)
 205                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 206                                 else
 207                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 208
 209                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 210
 211                                 /* Indicate error status */
 212                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 213
 214                                 /* Wait until USB device disconnected */
 215                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 216                                 break;
 217                         }
 218
 219                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 220                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 221                         {
 222                                 puts_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"));
 223                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 224
 225                                 /* Indicate error status */
 226                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 227
 228                                 /* Wait until USB device disconnected */
 229                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 230                                 break;
 231                         }
 232
 233                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 234                         USB_ControlRequest = (USB_Request_Header_t)
 235                                 {
 236                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 237                                         .bRequest      = REQ_SetProtocol,
 238                                         .wValue        = 0,
 239                                         .wIndex        = 0,
 240                                         .wLength       = 0,
 241                                 };
 242
 243                         /* Select the control pipe for the request transfer */
 244                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 245
 246                         /* Send the request, display error and wait for device detach if request fails */
 247                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 248                         {
 249                                 puts_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"));
 250                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 251
 252                                 /* Indicate error status */
 253                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 254
 255                                 /* Wait until USB device disconnected */
 256                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 257                                 break;
 258                         }
 259
 260                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 261
 262                         USB_HostState = HOST_STATE_Configured;
 263                         break;
 264                 case HOST_STATE_Configured:
 265                         /* If a report has been received, read and process it */
 266                         ReadNextReport();
 267
 268                         break;
 269         }
 270 }