Demos/Host/LowLevel/KeyboardHost/KeyboardHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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  *  enters a loop to run the application tasks in sequence.
  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         sei();
  50
  51         for (;;)
  52         {
  53                 Keyboard_HID_Task();
  54                 USB_USBTask();
  55         }
  56 }
  57
  58 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  59 void SetupHardware(void)
  60 {
  61         /* Disable watchdog if enabled by bootloader/fuses */
  62         MCUSR &= ~(1 << WDRF);
  63         wdt_disable();
  64
  65         /* Disable clock division */
  66         clock_prescale_set(clock_div_1);
  67
  68         /* Hardware Initialization */
  69         Serial_Init(9600, false);
  70         LEDs_Init();
  71         USB_Init();
  72
  73         /* Create a stdio stream for the serial port for stdin and stdout */
  74         Serial_CreateStream(NULL);
  75 }
  76
  77 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
  78  *  starts the library USB task to begin the enumeration and USB management process.
  79  */
  80 void EVENT_USB_Host_DeviceAttached(void)
  81 {
  82         puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
  83         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
  84 }
  85
  86 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
  87  *  stops the library USB task management process.
  88  */
  89 void EVENT_USB_Host_DeviceUnattached(void)
  90 {
  91         puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
  92         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  93 }
  94
  95 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
  96  *  enumerated by the host and is now ready to be used by the application.
  97  */
  98 void EVENT_USB_Host_DeviceEnumerationComplete(void)
  99 {
 100         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 101 }
 102
 103 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 104 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 105 {
 106         USB_Disable();
 107
 108         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 109                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 110
 111         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 112         for(;;);
 113 }
 114
 115 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 116  *  enumerating an attached USB device.
 117  */
 118 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 119                                             const uint8_t SubErrorCode)
 120 {
 121         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 122                                  " -- Error Code %d\r\n"
 123                                  " -- Sub Error Code %d\r\n"
 124                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 125
 126         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 127 }
 128
 129 /** Reads in and processes the next report from the attached device, displaying the report
 130  *  contents on the board LEDs and via the serial port.
 131  */
 132 void ReadNextReport(void)
 133 {
 134         USB_KeyboardReport_Data_t KeyboardReport;
 135
 136         /* Select keyboard data pipe */
 137         Pipe_SelectPipe(KEYBOARD_DATA_IN_PIPE);
 138
 139         /* Unfreeze keyboard data pipe */
 140         Pipe_Unfreeze();
 141
 142         /* Check to see if a packet has been received */
 143         if (!(Pipe_IsINReceived()))
 144         {
 145                 /* Refreeze HID data IN pipe */
 146                 Pipe_Freeze();
 147
 148                 return;
 149         }
 150
 151         /* Ensure pipe contains data before trying to read from it */
 152         if (Pipe_IsReadWriteAllowed())
 153         {
 154                 /* Read in keyboard report data */
 155                 Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport), NULL);
 156
 157                 /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
 158                 LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
 159
 160                 uint8_t KeyCode = KeyboardReport.KeyCode[0];
 161
 162                 /* Check if a key has been pressed */
 163                 if (KeyCode)
 164                 {
 165                         /* Toggle status LED to indicate keypress */
 166                         LEDs_ToggleLEDs(LEDS_LED2);
 167
 168                         char PressedKey = 0;
 169
 170                         /* Retrieve pressed key character if alphanumeric */
 171                         if ((KeyCode >= HID_KEYBOARD_SC_A) && (KeyCode <= HID_KEYBOARD_SC_Z))
 172                         {
 173                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_A) + 'A';
 174                         }
 175                         else if ((KeyCode >= HID_KEYBOARD_SC_1_AND_EXCLAMATION) &
 176                                          (KeyCode <= HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS))
 177                         {
 178                                 PressedKey = (KeyCode - HID_KEYBOARD_SC_1_AND_EXCLAMATION) + '0';
 179                         }
 180                         else if (KeyCode == HID_KEYBOARD_SC_SPACE)
 181                         {
 182                                 PressedKey = ' ';
 183                         }
 184                         else if (KeyCode == HID_KEYBOARD_SC_ENTER)
 185                         {
 186                                 PressedKey = '\n';
 187                         }
 188
 189                         /* Print the pressed key character out through the serial port if valid */
 190                         if (PressedKey)
 191                           putchar(PressedKey);
 192                 }
 193         }
 194
 195         /* Clear the IN endpoint, ready for next data packet */
 196         Pipe_ClearIN();
 197
 198         /* Refreeze keyboard data pipe */
 199         Pipe_Freeze();
 200 }
 201
 202 /** Task to set the configuration of the attached device after it has been enumerated, and to read and process
 203  *  HID reports from the device and display the results onto the board LEDs.
 204  */
 205 void Keyboard_HID_Task(void)
 206 {
 207         uint8_t ErrorCode;
 208
 209         switch (USB_HostState)
 210         {
 211                 case HOST_STATE_Addressed:
 212                         puts_P(PSTR("Getting Config Data.\r\n"));
 213
 214                         /* Get and process the configuration descriptor data */
 215                         if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
 216                         {
 217                                 if (ErrorCode == ControlError)
 218                                   puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
 219                                 else
 220                                   puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
 221
 222                                 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 223
 224                                 /* Indicate error status */
 225                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 226
 227                                 /* Wait until USB device disconnected */
 228                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 229                                 break;
 230                         }
 231
 232                         /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
 233                         if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
 234                         {
 235                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
 236                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 237
 238                                 /* Indicate error status */
 239                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 240
 241                                 /* Wait until USB device disconnected */
 242                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 243                                 break;
 244                         }
 245
 246                         /* HID class request to set the keyboard protocol to the Boot Protocol */
 247                         USB_ControlRequest = (USB_Request_Header_t)
 248                                 {
 249                                         .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
 250                                         .bRequest      = HID_REQ_SetProtocol,
 251                                         .wValue        = 0,
 252                                         .wIndex        = 0,
 253                                         .wLength       = 0,
 254                                 };
 255
 256                         /* Select the control pipe for the request transfer */
 257                         Pipe_SelectPipe(PIPE_CONTROLPIPE);
 258
 259                         /* Send the request, display error and wait for device detach if request fails */
 260                         if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
 261                         {
 262                                 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
 263                                                          " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
 264
 265                                 /* Indicate error status */
 266                                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 267
 268                                 /* Wait until USB device disconnected */
 269                                 USB_HostState = HOST_STATE_WaitForDeviceRemoval;
 270                                 break;
 271                         }
 272
 273                         puts_P(PSTR("Keyboard Enumerated.\r\n"));
 274
 275                         USB_HostState = HOST_STATE_Configured;
 276                         break;
 277                 case HOST_STATE_Configured:
 278                         /* If a report has been received, read and process it */
 279                         ReadNextReport();
 280
 281                         break;
 282         }
 283 }
 284