Copy existing Host mode demos to new ClassDriver and LowLevel subfolders.
[pub/lufa.git] / Demos / Host / ClassDriver / GenericHIDHost / GenericHIDHost.c
diff --git a/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c b/Demos/Host/ClassDriver/GenericHIDHost/GenericHIDHost.c
new file mode 100644 (file)
index 0000000..e731f90
--- /dev/null
@@ -0,0 +1,343 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  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 GenericHIDHost demo. This file contains the main tasks of\r
+ *  the demo and is responsible for the initial application hardware configuration.\r
+ */\r
\r
+#include "GenericHIDHost.h"\r
+\r
+/* Scheduler Task List */\r
+TASK_LIST\r
+{\r
+       { .Task = USB_USBTask          , .TaskStatus = TASK_STOP },\r
+       { .Task = USB_HID_Host         , .TaskStatus = TASK_STOP },\r
+};\r
+\r
+\r
+/** Main program entry point. This routine configures the hardware required by the application, then\r
+ *  starts the scheduler to run the application tasks.\r
+ */\r
+int main(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
+       \r
+       /* Indicate USB not ready */\r
+       UpdateStatus(Status_USBNotReady);\r
+       \r
+       /* Initialize Scheduler so that it can be used */\r
+       Scheduler_Init();\r
+\r
+       /* Initialize USB Subsystem */\r
+       USB_Init();\r
+\r
+       /* Start-up message */\r
+       puts_P(PSTR(ESC_RESET ESC_BG_WHITE ESC_INVERSE_ON ESC_ERASE_DISPLAY\r
+              "Generic HID Host Demo running.\r\n" ESC_INVERSE_OFF));\r
+                  \r
+       /* Scheduling - routine never returns, so put this last in the main function */\r
+       Scheduler_Start();\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_DeviceAttached(void)\r
+{\r
+       puts_P(PSTR("Device Attached.\r\n"));\r
+       UpdateStatus(Status_USBEnumerating);\r
+\r
+       /* Start USB management task to enumerate the device */\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_RUN);\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_DeviceUnattached(void)\r
+{\r
+       /* Stop HID and USB management task */\r
+       Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
+       Scheduler_SetTaskMode(USB_HID_Host, TASK_STOP);\r
+\r
+       puts_P(PSTR("Device Unattached.\r\n"));\r
+       UpdateStatus(Status_USBNotReady);\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_DeviceEnumerationComplete(void)\r
+{\r
+       /* Start HID Host task */\r
+       Scheduler_SetTaskMode(USB_HID_Host, TASK_RUN);\r
+\r
+       /* Indicate device enumeration complete */\r
+       UpdateStatus(Status_USBReady);\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_HostError(const uint8_t ErrorCode)\r
+{\r
+       USB_ShutDown();\r
+\r
+       puts_P(PSTR(ESC_BG_RED "Host Mode Error\r\n"));\r
+       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+\r
+       UpdateStatus(Status_HardwareError);\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_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\r
+{\r
+       puts_P(PSTR(ESC_BG_RED "Dev Enum Error\r\n"));\r
+       printf_P(PSTR(" -- Error Code %d\r\n"), ErrorCode);\r
+       printf_P(PSTR(" -- Sub Error Code %d\r\n"), SubErrorCode);\r
+       printf_P(PSTR(" -- In State %d\r\n"), USB_HostState);\r
+\r
+       UpdateStatus(Status_EnumerationError);\r
+}\r
+\r
+/** Function to manage status updates to the user. This is done via LEDs on the given board, if available, but may be changed to\r
+ *  log to a serial port, or anything else that is suitable for status updates.\r
+ *\r
+ *  \param CurrentStatus  Current status of the system, from the GenericHIDHost_StatusCodes_t enum\r
+ */\r
+void UpdateStatus(uint8_t CurrentStatus)\r
+{\r
+       uint8_t LEDMask = LEDS_NO_LEDS;\r
+       \r
+       /* Set the LED mask to the appropriate LED mask based on the given status code */\r
+       switch (CurrentStatus)\r
+       {\r
+               case Status_USBNotReady:\r
+                       LEDMask = (LEDS_LED1);\r
+                       break;\r
+               case Status_USBEnumerating:\r
+                       LEDMask = (LEDS_LED1 | LEDS_LED2);\r
+                       break;\r
+               case Status_USBReady:\r
+                       LEDMask = (LEDS_LED2);\r
+                       break;\r
+               case Status_EnumerationError:\r
+               case Status_HardwareError:\r
+                       LEDMask = (LEDS_LED1 | LEDS_LED3);\r
+                       break;\r
+       }\r
+       \r
+       /* Set the board LEDs to the new LED mask */\r
+       LEDs_SetAllLEDs(LEDMask);\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
+       /* Select and unfreeze HID data IN pipe */\r
+       Pipe_SelectPipe(HID_DATA_IN_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
+               uint8_t ReportINData[Pipe_BytesInPipe()];\r
+\r
+               /* Read in HID report data */\r
+               Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));\r
+       \r
+               /* Print report data through the serial port */\r
+               for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)\r
+                 printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);\r
+               \r
+               puts_P(PSTR("\r\n"));\r
+       }\r
+               \r
+       /* Clear the IN endpoint, ready for next data packet */\r
+       Pipe_ClearIN();\r
+       \r
+       /* Refreeze HID data IN pipe */\r
+       Pipe_Freeze();\r
+}\r
+\r
+/** Writes a report to the attached device.\r
+ *\r
+ *  \param ReportOUTData  Buffer containing the report to send to the device\r
+ *  \param ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)\r
+ *  \param ReportType  Type of report to send, either HID_REPORTTYPE_OUTPUT or HID_REPORTTYPE_FEATURE\r
+ *  \param ReportLength  Length of the report to send\r
+ */\r
+void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)\r
+{\r
+       /* Select and unfreeze HID data OUT pipe */\r
+       Pipe_SelectPipe(HID_DATA_OUT_PIPE);\r
+       \r
+       /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the\r
+        * control endpoint instead) - check to see if the OUT endpoint has been initialized */\r
+       if (Pipe_IsConfigured())\r
+       {\r
+               Pipe_Unfreeze();\r
+\r
+               /* Ensure pipe is ready to be written to before continuing */\r
+               if (!(Pipe_IsOUTReady()))\r
+               {\r
+                       /* Refreeze the data OUT pipe */\r
+                       Pipe_Freeze();\r
+                       \r
+                       return;\r
+               }\r
+               \r
+               /* If the report index is used, send it before the report data */\r
+               if (ReportIndex)\r
+                 Pipe_Write_Byte(ReportIndex);\r
+\r
+               /* Write out HID report data */\r
+               Pipe_Write_Stream_LE(ReportOUTData, ReportLength);                              \r
+                       \r
+               /* Clear the OUT endpoint, send last data packet */\r
+               Pipe_ClearOUT();\r
+\r
+               /* Refreeze the data OUT pipe */\r
+               Pipe_Freeze();\r
+       }\r
+       else\r
+       {\r
+               /* Class specific request to send a HID report to the device */\r
+               USB_ControlRequest = (USB_Request_Header_t)\r
+                       {\r
+                               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),\r
+                               .bRequest      = REQ_SetReport,\r
+                               .wValue        = ((ReportType << 8) | ReportIndex),\r
+                               .wIndex        = 0,\r
+                               .wLength       = ReportLength,\r
+                       };\r
+\r
+               /* Select the control pipe for the request transfer */\r
+               Pipe_SelectPipe(PIPE_CONTROLPIPE);\r
+\r
+               /* Send the request to the device */\r
+               USB_Host_SendControlRequest(ReportOUTData);\r
+       }\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 to send reports if desired.\r
+ */\r
+TASK(USB_HID_Host)\r
+{\r
+       uint8_t ErrorCode;\r
+\r
+       /* Switch to determine what user-application handled host state the host state machine is in */\r
+       switch (USB_HostState)\r
+       {\r
+               case HOST_STATE_Addressed:\r
+                       /* Standard request to set the device configuration to configuration 1 */\r
+                       USB_ControlRequest = (USB_Request_Header_t)\r
+                               {\r
+                                       .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_STANDARD | REQREC_DEVICE),\r
+                                       .bRequest      = REQ_SetConfiguration,\r
+                                       .wValue        = 1,\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
+                               puts_P(PSTR("Control Error (Set Configuration).\r\n"));\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+\r
+                               /* Indicate error status */\r
+                               UpdateStatus(Status_EnumerationError);\r
+                               \r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;\r
+                       }\r
+                       \r
+                       USB_HostState = HOST_STATE_Configured;\r
+                       break;\r
+               case HOST_STATE_Configured:\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("Control Error (Get Configuration).\r\n"));\r
+                               else\r
+                                 puts_P(PSTR("Invalid Device.\r\n"));\r
+\r
+                               printf_P(PSTR(" -- Error Code: %d\r\n"), ErrorCode);\r
+                               \r
+                               /* Indicate error status */\r
+                               UpdateStatus(Status_EnumerationError);\r
+\r
+                               /* Wait until USB device disconnected */\r
+                               while (USB_IsConnected);\r
+                               break;\r
+                       }\r
+               \r
+                       puts_P(PSTR("HID Device Enumerated.\r\n"));\r
+                                       \r
+                       USB_HostState = HOST_STATE_Ready;\r
+                       break;\r
+               case HOST_STATE_Ready:\r
+                       ReadNextReport();\r
+\r
+                       break;\r
+       }\r
+}\r