/*\r
LUFA Library\r
- Copyright (C) Dean Camera, 2009.\r
+ Copyright (C) Dean Camera, 2010.\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
+ 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
\r
#include "MouseHost.h"\r
\r
-/* Scheduler Task List */\r
-TASK_LIST\r
-{\r
- { .Task = USB_USBTask , .TaskStatus = TASK_STOP },\r
- { .Task = USB_Mouse_Host , .TaskStatus = TASK_STOP },\r
-};\r
-\r
+/** LUFA HID Class driver interface configuration and state information. This structure is\r
+ * passed to all HID Class driver functions, so that multiple instances of the same class\r
+ * within a device can be differentiated from one another.\r
+ */\r
+USB_ClassInfo_HID_Host_t Mouse_HID_Interface =\r
+ {\r
+ .Config =\r
+ {\r
+ .DataINPipeNumber = 1,\r
+ .DataINPipeDoubleBank = false,\r
+ \r
+ .DataOUTPipeNumber = 2,\r
+ .DataOUTPipeDoubleBank = false,\r
+ \r
+ .HIDInterfaceProtocol = HID_BOOT_MOUSE_PROTOCOL,\r
+ },\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
+ * 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 "Mouse Host Demo running.\r\n" ESC_FG_WHITE));\r
+\r
+ LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);\r
+\r
+ for (;;)\r
+ {\r
+ switch (USB_HostState)\r
+ {\r
+ case HOST_STATE_Addressed:\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);\r
+ \r
+ uint16_t ConfigDescriptorSize;\r
+ uint8_t ConfigDescriptorData[512];\r
+\r
+ if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,\r
+ sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)\r
+ {\r
+ printf("Error Retrieving Configuration Descriptor.\r\n");\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+ USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+ break;\r
+ }\r
+\r
+ if (HID_Host_ConfigurePipes(&Mouse_HID_Interface,\r
+ ConfigDescriptorSize, ConfigDescriptorData) != HID_ENUMERROR_NoError)\r
+ {\r
+ printf("Attached Device Not a Valid Mouse.\r\n");\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+ USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+ break;\r
+ }\r
+ \r
+ if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)\r
+ {\r
+ printf("Error Setting Device Configuration.\r\n");\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+ USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+ break;\r
+ }\r
+\r
+ if (HID_Host_SetBootProtocol(&Mouse_HID_Interface) != 0)\r
+ {\r
+ printf("Could not Set Boot Protocol Mode.\r\n");\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
+ USB_HostState = HOST_STATE_WaitForDeviceRemoval;\r
+ break;\r
+ }\r
+ \r
+ printf("Mouse Enumerated.\r\n");\r
+ USB_HostState = HOST_STATE_Configured;\r
+ break;\r
+ case HOST_STATE_Configured:\r
+ if (HID_Host_IsReportReceived(&Mouse_HID_Interface))\r
+ {\r
+ uint8_t LEDMask = LEDS_NO_LEDS;\r
+ \r
+ USB_MouseReport_Data_t MouseReport;\r
+ HID_Host_ReceiveReport(&Mouse_HID_Interface, &MouseReport);\r
+ \r
+ printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,\r
+ MouseReport.Y,\r
+ MouseReport.Button);\r
+ if (MouseReport.X > 0)\r
+ LEDMask |= LEDS_LED1;\r
+ else if (MouseReport.X < 0)\r
+ LEDMask |= LEDS_LED2;\r
+ \r
+ if (MouseReport.Y > 0)\r
+ LEDMask |= LEDS_LED3;\r
+ else if (MouseReport.Y < 0)\r
+ LEDMask |= LEDS_LED4;\r
+\r
+ if (MouseReport.Button)\r
+ LEDMask = LEDS_ALL_LEDS;\r
+\r
+ LEDs_SetAllLEDs(LEDMask);\r
+ }\r
+ \r
+ break;\r
+ }\r
+ \r
+ HID_Host_USBTask(&Mouse_HID_Interface);\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
+\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
- "Mouse 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
+void EVENT_USB_Host_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
+ 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_DeviceUnattached(void)\r
+void EVENT_USB_Host_DeviceUnattached(void)\r
{\r
- /* Stop mouse and USB management task */\r
- Scheduler_SetTaskMode(USB_USBTask, TASK_STOP);\r
- Scheduler_SetTaskMode(USB_Mouse_Host, TASK_STOP);\r
-\r
- puts_P(PSTR("Device Unattached.\r\n"));\r
- UpdateStatus(Status_USBNotReady);\r
+ puts_P(PSTR("\r\nDevice Unattached.\r\n"));\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_DeviceEnumerationComplete(void)\r
+void EVENT_USB_Host_DeviceEnumerationComplete(void)\r
{\r
- /* Start Mouse Host task */\r
- Scheduler_SetTaskMode(USB_Mouse_Host, TASK_RUN);\r
-\r
- /* Indicate device enumeration complete */\r
- UpdateStatus(Status_USBReady);\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_HostError(const uint8_t ErrorCode)\r
+void EVENT_USB_Host_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
+ printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"\r
+ " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);\r
\r
- UpdateStatus(Status_HardwareError);\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_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 MouseHost_StatusCodes_t enum\r
- */\r
-void UpdateStatus(uint8_t CurrentStatus)\r
+void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode)\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
+ 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
- /* 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
- USB_MouseReport_Data_t MouseReport;\r
- uint8_t LEDMask = LEDS_NO_LEDS;\r
-\r
- /* Select mouse data pipe */\r
- Pipe_SelectPipe(MOUSE_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 mouse report data */\r
- Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport)); \r
-\r
- /* Alter status LEDs according to mouse X movement */\r
- if (MouseReport.X > 0)\r
- LEDMask |= LEDS_LED1;\r
- else if (MouseReport.X < 0)\r
- LEDMask |= LEDS_LED2;\r
- \r
- /* Alter status LEDs according to mouse Y movement */\r
- if (MouseReport.Y > 0)\r
- LEDMask |= LEDS_LED3;\r
- else if (MouseReport.Y < 0)\r
- LEDMask |= LEDS_LED4;\r
-\r
- /* Alter status LEDs according to mouse button position */\r
- if (MouseReport.Button)\r
- LEDMask = LEDS_ALL_LEDS;\r
- \r
- LEDs_SetAllLEDs(LEDMask);\r
- \r
- /* Print mouse report data through the serial port */\r
- printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,\r
- MouseReport.Y,\r
- MouseReport.Button);\r
- }\r
-\r
- /* Clear the IN endpoint, ready for next data packet */\r
- Pipe_ClearIN();\r
-\r
- /* Refreeze mouse 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
-TASK(USB_Mouse_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
- /* HID class request to set the mouse 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
- puts_P(PSTR("Control Error (Set Protocol).\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
- puts_P(PSTR("Mouse Enumerated.\r\n"));\r
- \r
- USB_HostState = HOST_STATE_Ready;\r
- break;\r
- case HOST_STATE_Ready:\r
- /* If a report has been received, read and process it */\r
- ReadNextReport();\r
-\r
- break;\r
- }\r
+ LEDs_SetAllLEDs(LEDMASK_USB_ERROR);\r
}\r