3 Copyright (C) Dean Camera, 2014.
5 dean [at] fourwalledcubicle [dot] com
10 Copyright 2014 Dean Camera (dean [at] fourwalledcubicle [dot] com)
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.
21 The author disclaims 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
33 * Main source file for the MouseHost demo. This file contains the main tasks of
34 * the demo and is responsible for the initial application hardware configuration.
37 #include "MouseHost.h"
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.
46 puts_P(PSTR(ESC_FG_CYAN "Mouse HID Host Demo running.\r\n" ESC_FG_WHITE));
48 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
49 GlobalInterruptEnable();
59 /** Configures the board hardware and chip peripherals for the demo's functionality. */
60 void SetupHardware(void)
62 #if (ARCH == ARCH_AVR8)
63 /* Disable watchdog if enabled by bootloader/fuses */
64 MCUSR &= ~(1 << WDRF);
67 /* Disable clock division */
68 clock_prescale_set(clock_div_1);
71 /* Hardware Initialization */
72 Serial_Init(9600, false);
76 /* Create a stdio stream for the serial port for stdin and stdout */
77 Serial_CreateStream(NULL);
80 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
81 * starts the library USB task to begin the enumeration and USB management process.
83 void EVENT_USB_Host_DeviceAttached(void)
85 puts_P(PSTR(ESC_FG_GREEN "Device Attached.\r\n" ESC_FG_WHITE));
86 LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
89 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
90 * stops the library USB task management process.
92 void EVENT_USB_Host_DeviceUnattached(void)
94 puts_P(PSTR(ESC_FG_GREEN "Device Unattached.\r\n" ESC_FG_WHITE));
95 LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
98 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
99 * enumerated by the host and is now ready to be used by the application.
101 void EVENT_USB_Host_DeviceEnumerationComplete(void)
103 puts_P(PSTR("Getting Config Data.\r\n"));
107 /* Get and process the configuration descriptor data */
108 if ((ErrorCode = ProcessConfigurationDescriptor()) != SuccessfulConfigRead)
110 if (ErrorCode == ControlError)
111 puts_P(PSTR(ESC_FG_RED "Control Error (Get Configuration).\r\n"));
113 puts_P(PSTR(ESC_FG_RED "Invalid Device.\r\n"));
115 printf_P(PSTR(" -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
117 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
121 /* Set the device configuration to the first configuration (rarely do devices use multiple configurations) */
122 if ((ErrorCode = USB_Host_SetDeviceConfiguration(1)) != HOST_SENDCONTROL_Successful)
124 printf_P(PSTR(ESC_FG_RED "Control Error (Set Configuration).\r\n"
125 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
127 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
131 /* HID class request to set the mouse protocol to the Boot Protocol */
132 USB_ControlRequest = (USB_Request_Header_t)
134 .bmRequestType = (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE),
135 .bRequest = HID_REQ_SetProtocol,
141 /* Select the control pipe for the request transfer */
142 Pipe_SelectPipe(PIPE_CONTROLPIPE);
144 /* Send the request, display error and wait for device detach if request fails */
145 if ((ErrorCode = USB_Host_SendControlRequest(NULL)) != HOST_SENDCONTROL_Successful)
147 printf_P(PSTR(ESC_FG_RED "Control Error (Set Protocol).\r\n"
148 " -- Error Code: %d\r\n" ESC_FG_WHITE), ErrorCode);
150 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
151 USB_Host_SetDeviceConfiguration(0);
155 puts_P(PSTR("Mouse Enumerated.\r\n"));
156 LEDs_SetAllLEDs(LEDMASK_USB_READY);
159 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
160 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
164 printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
165 " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
167 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
171 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
172 * enumerating an attached USB device.
174 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
175 const uint8_t SubErrorCode)
177 printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
178 " -- Error Code %d\r\n"
179 " -- Sub Error Code %d\r\n"
180 " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
182 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
185 /** Reads in and processes the next report from the attached device, displaying the report
186 * contents on the board LEDs and via the serial port.
188 void MouseHost_Task(void)
190 if (USB_HostState != HOST_STATE_Configured)
193 USB_MouseReport_Data_t MouseReport;
194 uint8_t LEDMask = LEDS_NO_LEDS;
196 /* Select mouse data pipe */
197 Pipe_SelectPipe(MOUSE_DATA_IN_PIPE);
199 /* Unfreeze mouse data pipe */
202 /* Check to see if a packet has been received */
203 if (!(Pipe_IsINReceived()))
205 /* No packet received (no movement), turn off LEDs */
206 LEDs_SetAllLEDs(LEDS_NO_LEDS);
208 /* Refreeze HID data IN pipe */
214 /* Ensure pipe contains data before trying to read from it */
215 if (Pipe_IsReadWriteAllowed())
217 /* Read in mouse report data */
218 Pipe_Read_Stream_LE(&MouseReport, sizeof(MouseReport), NULL);
220 /* Alter status LEDs according to mouse X movement */
221 if (MouseReport.X > 0)
222 LEDMask |= LEDS_LED1;
223 else if (MouseReport.X < 0)
224 LEDMask |= LEDS_LED2;
226 /* Alter status LEDs according to mouse Y movement */
227 if (MouseReport.Y > 0)
228 LEDMask |= LEDS_LED3;
229 else if (MouseReport.Y < 0)
230 LEDMask |= LEDS_LED4;
232 /* Alter status LEDs according to mouse button position */
233 if (MouseReport.Button)
234 LEDMask = LEDS_ALL_LEDS;
236 LEDs_SetAllLEDs(LEDMask);
238 /* Print mouse report data through the serial port */
239 printf_P(PSTR("dX:%2d dY:%2d Button:%d\r\n"), MouseReport.X,
244 /* Clear the IN endpoint, ready for next data packet */
247 /* Refreeze mouse data pipe */