Add svn:eol-style property to source files, so that the line endings are correctly...
[pub/USBasp.git] / Demos / Host / LowLevel / GenericHIDHost / GenericHIDHost.c
index 3dc314e..f477ac2 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 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
-/** 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 "Generic HID Host Demo running.\r\n" ESC_FG_WHITE));\r
-\r
-       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
-       sei();\r
-\r
-       for (;;)\r
-       {\r
-               HID_Host_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
-       /* 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[in] ReportOUTData  Buffer containing the report to send to the device\r
- *  \param[in] ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)\r
- *  \param[in] ReportType  Type of report to send, either REPORT_TYPE_OUT or REPORT_TYPE_FEATURE\r
- *  \param[in] 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 the 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() && (ReportType == REPORT_TYPE_OUT))\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
-void HID_Host_Task(void)\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
-                       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
-                       puts_P(PSTR("HID Device Enumerated.\r\n"));\r
-\r
-                       USB_HostState = HOST_STATE_Configured;\r
-                       break;\r
-               case HOST_STATE_Configured:\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 GenericHIDHost demo. This file contains the main tasks of
+ *  the demo and is responsible for the initial application hardware configuration.
+ */
+#include "GenericHIDHost.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 "Generic HID Host Demo running.\r\n" ESC_FG_WHITE));
+
+       LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
+       sei();
+
+       for (;;)
+       {
+               HID_Host_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)
+{
+       /* Select and unfreeze HID data IN pipe */
+       Pipe_SelectPipe(HID_DATA_IN_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())
+       {
+               uint8_t ReportINData[Pipe_BytesInPipe()];
+
+               /* Read in HID report data */
+               Pipe_Read_Stream_LE(&ReportINData, sizeof(ReportINData));
+       
+               /* Print report data through the serial port */
+               for (uint16_t CurrByte = 0; CurrByte < sizeof(ReportINData); CurrByte++)
+                 printf_P(PSTR("0x%02X "), ReportINData[CurrByte]);
+               
+               puts_P(PSTR("\r\n"));
+       }
+               
+       /* Clear the IN endpoint, ready for next data packet */
+       Pipe_ClearIN();
+       
+       /* Refreeze HID data IN pipe */
+       Pipe_Freeze();
+}
+
+/** Writes a report to the attached device.
+ *
+ *  \param[in] ReportOUTData  Buffer containing the report to send to the device
+ *  \param[in] ReportIndex  Index of the report in the device (zero if the device does not use multiple reports)
+ *  \param[in] ReportType  Type of report to send, either REPORT_TYPE_OUT or REPORT_TYPE_FEATURE
+ *  \param[in] ReportLength  Length of the report to send
+ */
+void WriteNextReport(uint8_t* ReportOUTData, uint8_t ReportIndex, uint8_t ReportType, uint16_t ReportLength)
+{
+       /* Select the HID data OUT pipe */
+       Pipe_SelectPipe(HID_DATA_OUT_PIPE);
+       
+       /* Not all HID devices have an OUT endpoint (some require OUT reports to be sent over the
+        * control endpoint instead) - check to see if the OUT endpoint has been initialized */
+       if (Pipe_IsConfigured() && (ReportType == REPORT_TYPE_OUT))
+       {
+               Pipe_Unfreeze();
+
+               /* Ensure pipe is ready to be written to before continuing */
+               if (!(Pipe_IsOUTReady()))
+               {
+                       /* Refreeze the data OUT pipe */
+                       Pipe_Freeze();
+                       
+                       return;
+               }
+               
+               /* If the report index is used, send it before the report data */
+               if (ReportIndex)
+                 Pipe_Write_Byte(ReportIndex);
+
+               /* Write out HID report data */
+               Pipe_Write_Stream_LE(ReportOUTData, ReportLength);                              
+                       
+               /* Clear the OUT endpoint, send last data packet */
+               Pipe_ClearOUT();
+
+               /* Refreeze the data OUT pipe */
+               Pipe_Freeze();
+       }
+       else
+       {
+               /* Class specific request to send a HID report to the device */
+               USB_ControlRequest = (USB_Request_Header_t)
+                       {
+                               .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
+                               .bRequest      = REQ_SetReport,
+                               .wValue        = ((ReportType << 8) | ReportIndex),
+                               .wIndex        = 0,
+                               .wLength       = ReportLength,
+                       };
+
+               /* Select the control pipe for the request transfer */
+               Pipe_SelectPipe(PIPE_CONTROLPIPE);
+
+               /* Send the request to the device */
+               USB_Host_SendControlRequest(ReportOUTData);
+       }
+}
+
+/** 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 to send reports if desired.
+ */
+void HID_Host_Task(void)
+{
+       uint8_t ErrorCode;
+
+       /* Switch to determine what user-application handled host state the host state machine is in */
+       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;
+                       }
+                       
+                       puts_P(PSTR("HID Device Enumerated.\r\n"));
+
+                       USB_HostState = HOST_STATE_Configured;
+                       break;
+               case HOST_STATE_Configured:
+                       ReadNextReport();
+
+                       break;
+       }
+}