Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / Demos / Host / LowLevel / KeyboardHost / KeyboardHost.c
index 633094f..debbf76 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Main source file for the KeyboardHost demo. This file contains the main tasks of\r
- *  the demo and is responsible for the initial application hardware configuration.\r
- */\r
\r
-#include "KeyboardHost.h"\r
-\r
-/** Main program entry point. This routine configures the hardware required by the application, then\r
- *  enters a loop to run the application tasks in sequence.\r
- */\r
-int main(void)\r
-{\r
-       SetupHardware();\r
-\r
-       puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Host Demo running.\r\n" ESC_FG_WHITE));\r
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-       sei();\r
-\r
-       for (;;)\r
-       {\r
-               Keyboard_HID_Task();\r
-               USB_USBTask();\r
-       }\r
-}\r
-\r
-/** Configures the board hardware and chip peripherals for the demo's functionality. */\r
-void SetupHardware(void)\r
-{\r
-       /* Disable watchdog if enabled by bootloader/fuses */\r
-       MCUSR &= ~(1 << WDRF);\r
-       wdt_disable();\r
-\r
-       /* Disable clock division */\r
-       clock_prescale_set(clock_div_1);\r
-\r
-       /* Hardware Initialization */\r
-       SerialStream_Init(9600, false);\r
-       LEDs_Init();\r
-       USB_Init();\r
-}\r
-\r
-/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and\r
- *  starts the library USB task to begin the enumeration and USB management process.\r
- */\r
-void EVENT_USB_Host_DeviceAttached(void)\r
-{\r
-       puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
-}\r
-\r
-/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and\r
- *  stops the library USB task management process.\r
- */\r
-void EVENT_USB_Host_DeviceUnattached(void)\r
-{\r
-       puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-}\r
-\r
-/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully\r
- *  enumerated by the host and is now ready to be used by the application.\r
- */\r
-void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
-{\r
-       LEDs_SetAllLEDs(LEDMASK_USB_READY);\r
-}\r
-\r
-/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */\r
-void EVENT_USB_Host_HostError(const uint8_t ErrorCode)\r
-{\r
-       USB_ShutDown();\r
-\r
-       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
-                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-       for(;;);\r
-}\r
-\r
-/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while\r
- *  enumerating an attached USB device.\r
- */\r
-void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
-{\r
-       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"\r
-                                " -- Error Code %d\r\n"\r
-                                " -- Sub Error Code %d\r\n"\r
-                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);\r
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-}\r
-\r
-/** Reads in and processes the next report from the attached device, displaying the report\r
- *  contents on the board LEDs and via the serial port.\r
- */\r
-void ReadNextReport(void)\r
-{\r
-       USB_KeyboardReport_Data_t KeyboardReport;\r
-               \r
-       /* Select keyboard data pipe */\r
-       Pipe_SelectPipe(KEYBOARD_DATAPIPE);     \r
-\r
-       /* Unfreeze keyboard data pipe */\r
-       Pipe_Unfreeze();\r
-\r
-       /* Check to see if a packet has been received */\r
-       if (!(Pipe_IsINReceived()))\r
-       {\r
-               /* Refreeze HID data IN pipe */\r
-               Pipe_Freeze();\r
-                       \r
-               return;\r
-       }\r
-       \r
-       /* Ensure pipe contains data before trying to read from it */\r
-       if (Pipe_IsReadWriteAllowed())\r
-       {\r
-               /* Read in keyboard report data */\r
-               Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));\r
-\r
-               /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */\r
-               LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);\r
-               \r
-               /* Check if a key has been pressed */\r
-               if (KeyboardReport.KeyCode)\r
-               {\r
-                       /* Toggle status LED to indicate keypress */\r
-                       LEDs_ToggleLEDs(LEDS_LED2);\r
-                                 \r
-                       char PressedKey = 0;\r
-\r
-                       /* Retrieve pressed key character if alphanumeric */\r
-                       if ((KeyboardReport.KeyCode[0] >= 0x04) && (KeyboardReport.KeyCode[0] <= 0x1D))\r
-                         PressedKey = (KeyboardReport.KeyCode[0] - 0x04) + 'A';\r
-                       else if ((KeyboardReport.KeyCode[0] >= 0x1E) && (KeyboardReport.KeyCode[0] <= 0x27))\r
-                         PressedKey = (KeyboardReport.KeyCode[0] - 0x1E) + '0';\r
-                       else if (KeyboardReport.KeyCode[0] == 0x2C)\r
-                         PressedKey = ' ';                                             \r
-                       else if (KeyboardReport.KeyCode[0] == 0x28)\r
-                         PressedKey = '\n';\r
-                                \r
-                       /* Print the pressed key character out through the serial port if valid */\r
-                       if (PressedKey)\r
-                         putchar(PressedKey);\r
-               }\r
-       }\r
-               \r
-       /* Clear the IN endpoint, ready for next data packet */\r
-       Pipe_ClearIN();\r
-\r
-       /* Refreeze keyboard data pipe */\r
-       Pipe_Freeze();\r
-}\r
-\r
-/** Task to set the configuration of the attached device after it has been enumerated, and to read and process\r
- *  HID reports from the device and display the results onto the board LEDs.\r
- */\r
-void Keyboard_HID_Task(void)\r
-{\r
-       uint8_t ErrorCode;\r
-\r
-       switch (USB_HostState)\r
-       {\r
-               case HOST_STATE_Addressed:\r
-                       puts_P(PSTR("Getting Config Data.\r\n"));\r
-               \r
-                       /* Get and process the configuration descriptor data */\r
-                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)\r
-                       {\r
-                               if (ErrorCode == ControlError)\r
-                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));\r
-                               else\r
-                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));\r
-\r
-                               printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
-                               \r
-                               /* Indicate error status */\r
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
-                               break;\r
-                       }\r
-               \r
-                       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */\r
-                       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"\r
-                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
-\r
-                               /* Indicate error status */\r
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-\r
-                               /* Wait until USB device disconnected */\r
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
-                               break;\r
-                       }\r
-                               \r
-                       /* HID class request to set the keyboard protocol to the Boot Protocol */\r
-                       USB_ControlRequest = (USB_Request_Header_t)\r
-                               {\r
-                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
-                                       .bRequest      = REQ_SetProtocol,\r
-                                       .wValue        = 0,\r
-                                       .wIndex        = 0,\r
-                                       .wLength       = 0,\r
-                               };\r
-\r
-                       /* Select the control pipe for the request transfer */\r
-                       Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
-\r
-                       /* Send the request, display error and wait for device detach if request fails */\r
-                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)\r
-                       {\r
-                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"\r
-                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);\r
-\r
-                               /* Indicate error status */\r
-                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
-                               \r
-                               /* Wait until USB device disconnected */\r
-                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
-                               break;\r
-                       }\r
-\r
-                       puts_P(PSTR("Keyboard Enumerated.\r\n"));\r
-\r
-                       USB_HostState = HOST_STATE_Configured;\r
-                       break;\r
-               case HOST_STATE_Configured:\r
-                       /* If a report has been received, read and process it */\r
-                       ReadNextReport();\r
-\r
-                       break;\r
-       }\r
-}\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this 
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in 
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting 
+  documentation, and that the name of the author not be used in 
+  advertising or publicity pertaining to distribution of the 
+  software without specific, written prior permission.
+
+  The author disclaim all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *
+ *  Main source file for the KeyboardHost demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+#include "KeyboardHost.h"
+
+/** Main program entry point. This routine configures the hardware required by the application, then
+ *  enters a loop to run the application tasks in sequence.
+ */
+int main(void)
+{
+       SetupHardware();
+
+       puts_P(PSTR(ESC_FG_CYAN "Keyboard HID Host Demo running.\r\n" ESC_FG_WHITE));
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       sei();
+
+       for (;;)
+       {
+               Keyboard_HID_Task();
+               USB_USBTask();
+       }
+}
+
+/** Configures the board hardware and chip peripherals for the demo's functionality. */
+void SetupHardware(void)
+{
+       /* Disable watchdog if enabled by bootloader/fuses */
+       MCUSR &= ~(1 << WDRF);
+       wdt_disable();
+
+       /* Disable clock division */
+       clock_prescale_set(clock_div_1);
+
+       /* Hardware Initialization */
+       SerialStream_Init(9600, false);
+       LEDs_Init();
+       USB_Init();
+}
+
+/** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
+ *  starts the library USB task to begin the enumeration and USB management process.
+ */
+void EVENT_USB_Host_DeviceAttached(void)
+{
+       puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
+       LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
+}
+
+/** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
+ *  stops the library USB task management process.
+ */
+void EVENT_USB_Host_DeviceUnattached(void)
+{
+       puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+}
+
+/** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
+ *  enumerated by the host and is now ready to be used by the application.
+ */
+void EVENT_USB_Host_DeviceEnumerationComplete(void)
+{
+       LEDs_SetAllLEDs(LEDMASK_USB_READY);
+}
+
+/** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
+void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
+{
+       USB_ShutDown();
+
+       printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
+                                " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+       for(;;);
+}
+
+/** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
+ *  enumerating an attached USB device.
+ */
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)
+{
+       printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
+                                " -- Error Code %d\r\n"
+                                " -- Sub Error Code %d\r\n"
+                                " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
+
+       LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+}
+
+/** Reads in and processes the next report from the attached device, displaying the report
+ *  contents on the board LEDs and via the serial port.
+ */
+void ReadNextReport(void)
+{
+       USB_KeyboardReport_Data_t KeyboardReport;
+               
+       /* Select keyboard data pipe */
+       Pipe_SelectPipe(KEYBOARD_DATAPIPE);     
+
+       /* Unfreeze keyboard data pipe */
+       Pipe_Unfreeze();
+
+       /* Check to see if a packet has been received */
+       if (!(Pipe_IsINReceived()))
+       {
+               /* Refreeze HID data IN pipe */
+               Pipe_Freeze();
+                       
+               return;
+       }
+       
+       /* Ensure pipe contains data before trying to read from it */
+       if (Pipe_IsReadWriteAllowed())
+       {
+               /* Read in keyboard report data */
+               Pipe_Read_Stream_LE(&KeyboardReport, sizeof(KeyboardReport));
+
+               /* Indicate if the modifier byte is non-zero (special key such as shift is being pressed) */
+               LEDs_ChangeLEDs(LEDS_LED1, (KeyboardReport.Modifier) ? LEDS_LED1 : 0);
+               
+               /* Check if a key has been pressed */
+               if (KeyboardReport.KeyCode)
+               {
+                       /* Toggle status LED to indicate keypress */
+                       LEDs_ToggleLEDs(LEDS_LED2);
+                                 
+                       char PressedKey = 0;
+
+                       /* Retrieve pressed key character if alphanumeric */
+                       if ((KeyboardReport.KeyCode[0] >= 0x04) && (KeyboardReport.KeyCode[0] <= 0x1D))
+                         PressedKey = (KeyboardReport.KeyCode[0] - 0x04) + 'A';
+                       else if ((KeyboardReport.KeyCode[0] >= 0x1E) && (KeyboardReport.KeyCode[0] <= 0x27))
+                         PressedKey = (KeyboardReport.KeyCode[0] - 0x1E) + '0';
+                       else if (KeyboardReport.KeyCode[0] == 0x2C)
+                         PressedKey = ' ';                                             
+                       else if (KeyboardReport.KeyCode[0] == 0x28)
+                         PressedKey = '\n';
+                                
+                       /* Print the pressed key character out through the serial port if valid */
+                       if (PressedKey)
+                         putchar(PressedKey);
+               }
+       }
+               
+       /* Clear the IN endpoint, ready for next data packet */
+       Pipe_ClearIN();
+
+       /* Refreeze keyboard data pipe */
+       Pipe_Freeze();
+}
+
+/** Task to set the configuration of the attached device after it has been enumerated, and to read and process
+ *  HID reports from the device and display the results onto the board LEDs.
+ */
+void Keyboard_HID_Task(void)
+{
+       uint8_t ErrorCode;
+
+       switch (USB_HostState)
+       {
+               case HOST_STATE_Addressed:
+                       puts_P(PSTR("Getting Config Data.\r\n"));
+               
+                       /* Get and process the configuration descriptor data */
+                       if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
+                       {
+                               if (ErrorCode == ControlError)
+                                 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
+                               else
+                                 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
+
+                               printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+                               
+                               /* Indicate error status */
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+
+                               /* Wait until USB device disconnected */
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+                               break;
+                       }
+               
+                       /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
+                       if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
+                       {
+                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
+                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+                               /* Indicate error status */
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+
+                               /* Wait until USB device disconnected */
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+                               break;
+                       }
+                               
+                       /* HID class request to set the keyboard protocol to the Boot Protocol */
+                       USB_ControlRequest = (USB_Request_Header_t)
+                               {
+                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
+                                       .bRequest      = REQ_SetProtocol,
+                                       .wValue        = 0,
+                                       .wIndex        = 0,
+                                       .wLength       = 0,
+                               };
+
+                       /* Select the control pipe for the request transfer */
+                       Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+                       /* Send the request, display error and wait for device detach if request fails */
+                       if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
+                       {
+                               printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
+                                                        " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
+
+                               /* Indicate error status */
+                               LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
+                               
+                               /* Wait until USB device disconnected */
+                               USB_HostState = HOST_STATE_WaitForDeviceRemoval;
+                               break;
+                       }
+
+                       puts_P(PSTR("Keyboard Enumerated.\r\n"));
+
+                       USB_HostState = HOST_STATE_Configured;
+                       break;
+               case HOST_STATE_Configured:
+                       /* If a report has been received, read and process it */
+                       ReadNextReport();
+
+                       break;
+       }
+}