2 * Copyright 2012 Jun Wako <wakojun@gmail.com>
3 * This file is based on:
4 * LUFA-120219/Demos/Device/Lowlevel/KeyboardMouse
5 * LUFA-120219/Demos/Device/Lowlevel/GenericHID
10 Copyright (C) Dean Camera, 2012.
12 dean [at] fourwalledcubicle [dot] com
17 Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)
18 Copyright 2010 Denver Gingerich (denver [at] ossguy [dot] com)
20 Permission to use, copy, modify, distribute, and sell this
21 software and its documentation for any purpose is hereby granted
22 without fee, provided that the above copyright notice appear in
23 all copies and that both that the copyright notice and this
24 permission notice and warranty disclaimer appear in supporting
25 documentation, and that the name of the author not be used in
26 advertising or publicity pertaining to distribution of the
27 software without specific, written prior permission.
29 The author disclaim all warranties with regard to this
30 software, including all implied warranties of merchantability
31 and fitness. In no event shall the author be liable for any
32 special, indirect or consequential damages or any damages
33 whatsoever resulting from loss of use, data or profits, whether
34 in an action of contract, negligence or other tortious action,
35 arising out of or in connection with the use or performance of
41 #include "host_driver.h"
47 #ifdef SLEEP_LED_ENABLE
48 #include "sleep_led.h"
52 #include "descriptor.h"
55 static uint8_t idle_duration = 0;
56 static uint8_t protocol_report = 1;
57 static uint8_t keyboard_led_stats = 0;
59 static report_keyboard_t keyboard_report_sent;
63 static uint8_t keyboard_leds(void);
64 static void send_keyboard(report_keyboard_t *report);
65 static void send_mouse(report_mouse_t *report);
66 static void send_system(uint16_t data);
67 static void send_consumer(uint16_t data);
68 host_driver_t lufa_driver = {
77 /*******************************************************************************
79 ******************************************************************************/
81 static void Console_Task(void)
83 /* Device must be connected and configured for the task to run */
84 if (USB_DeviceState != DEVICE_STATE_Configured)
87 uint8_t ep = Endpoint_GetCurrentEndpoint();
90 // TODO: impl receivechar()/recvchar()
91 Endpoint_SelectEndpoint(CONSOLE_OUT_EPNUM);
93 /* Check to see if a packet has been sent from the host */
94 if (Endpoint_IsOUTReceived())
96 /* Check to see if the packet contains data */
97 if (Endpoint_IsReadWriteAllowed())
99 /* Create a temporary buffer to hold the read in report from the host */
100 uint8_t ConsoleData[CONSOLE_EPSIZE];
102 /* Read Console Report Data */
103 Endpoint_Read_Stream_LE(&ConsoleData, sizeof(ConsoleData), NULL);
105 /* Process Console Report Data */
106 //ProcessConsoleHIDReport(ConsoleData);
109 /* Finalize the stream transfer to send the last packet */
115 Endpoint_SelectEndpoint(CONSOLE_IN_EPNUM);
116 if (!Endpoint_IsEnabled() || !Endpoint_IsConfigured()) {
117 Endpoint_SelectEndpoint(ep);
122 while (Endpoint_IsReadWriteAllowed())
125 // flash senchar packet
126 if (Endpoint_IsINReady()) {
130 Endpoint_SelectEndpoint(ep);
133 static void Console_Task(void)
139 /*******************************************************************************
141 ******************************************************************************/
143 * Event Order of Plug in:
144 * 0) EVENT_USB_Device_Connect
145 * 1) EVENT_USB_Device_Suspend
146 * 2) EVENT_USB_Device_Reset
147 * 3) EVENT_USB_Device_Wake
149 void EVENT_USB_Device_Connect(void)
153 void EVENT_USB_Device_Disconnect(void)
157 void EVENT_USB_Device_Reset(void)
161 void EVENT_USB_Device_Suspend()
163 #ifdef SLEEP_LED_ENABLE
168 void EVENT_USB_Device_WakeUp()
170 suspend_wakeup_init();
172 #ifdef SLEEP_LED_ENABLE
174 // NOTE: converters may not accept this
175 led_set(host_keyboard_leds());
179 void EVENT_USB_Device_StartOfFrame(void)
184 /** Event handler for the USB_ConfigurationChanged event.
185 * This is fired when the host sets the current configuration of the USB device after enumeration.
187 void EVENT_USB_Device_ConfigurationChanged(void)
189 bool ConfigSuccess = true;
191 /* Setup Keyboard HID Report Endpoints */
192 ConfigSuccess &= ENDPOINT_CONFIG(KEYBOARD_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
193 KEYBOARD_EPSIZE, ENDPOINT_BANK_SINGLE);
196 /* Setup Mouse HID Report Endpoint */
197 ConfigSuccess &= ENDPOINT_CONFIG(MOUSE_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
198 MOUSE_EPSIZE, ENDPOINT_BANK_SINGLE);
201 #ifdef EXTRAKEY_ENABLE
202 /* Setup Extra HID Report Endpoint */
203 ConfigSuccess &= ENDPOINT_CONFIG(EXTRAKEY_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
204 EXTRAKEY_EPSIZE, ENDPOINT_BANK_SINGLE);
207 #ifdef CONSOLE_ENABLE
208 /* Setup Console HID Report Endpoints */
209 ConfigSuccess &= ENDPOINT_CONFIG(CONSOLE_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
210 CONSOLE_EPSIZE, ENDPOINT_BANK_DOUBLE);
211 ConfigSuccess &= ENDPOINT_CONFIG(CONSOLE_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
212 CONSOLE_EPSIZE, ENDPOINT_BANK_SINGLE);
216 /* Setup NKRO HID Report Endpoints */
217 ConfigSuccess &= ENDPOINT_CONFIG(NKRO_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
218 NKRO_EPSIZE, ENDPOINT_BANK_SINGLE);
223 Appendix G: HID Request Support Requirements
225 The following table enumerates the requests that need to be supported by various types of HID class devices.
227 Device type GetReport SetReport GetIdle SetIdle GetProtocol SetProtocol
228 ------------------------------------------------------------------------------------------
229 Boot Mouse Required Optional Optional Optional Required Required
230 Non-Boot Mouse Required Optional Optional Optional Optional Optional
231 Boot Keyboard Required Optional Required Required Required Required
232 Non-Boot Keybrd Required Optional Required Required Optional Optional
233 Other Device Required Optional Optional Optional Optional Optional
235 /** Event handler for the USB_ControlRequest event.
236 * This is fired before passing along unhandled control requests to the library for processing internally.
238 void EVENT_USB_Device_ControlRequest(void)
240 uint8_t* ReportData = NULL;
241 uint8_t ReportSize = 0;
243 /* Handle HID Class specific requests */
244 switch (USB_ControlRequest.bRequest)
246 case HID_REQ_GetReport:
247 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
249 Endpoint_ClearSETUP();
252 switch (USB_ControlRequest.wIndex) {
253 case KEYBOARD_INTERFACE:
255 ReportData = (uint8_t*)&keyboard_report_sent;
256 ReportSize = sizeof(keyboard_report_sent);
260 /* Write the report data to the control endpoint */
261 Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
266 case HID_REQ_SetReport:
267 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
271 switch (USB_ControlRequest.wIndex) {
272 case KEYBOARD_INTERFACE:
273 Endpoint_ClearSETUP();
275 while (!(Endpoint_IsOUTReceived())) {
276 if (USB_DeviceState == DEVICE_STATE_Unattached)
279 keyboard_led_stats = Endpoint_Read_8();
282 Endpoint_ClearStatusStage();
290 case HID_REQ_GetProtocol:
291 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
293 Endpoint_ClearSETUP();
294 while (!(Endpoint_IsINReady()));
295 Endpoint_Write_8(protocol_report);
297 Endpoint_ClearStatusStage();
301 case HID_REQ_SetProtocol:
302 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
304 Endpoint_ClearSETUP();
305 Endpoint_ClearStatusStage();
307 protocol_report = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
311 case HID_REQ_SetIdle:
312 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
314 Endpoint_ClearSETUP();
315 Endpoint_ClearStatusStage();
317 idle_duration = ((USB_ControlRequest.wValue & 0xFF00) >> 8);
321 case HID_REQ_GetIdle:
322 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
324 Endpoint_ClearSETUP();
325 while (!(Endpoint_IsINReady()));
326 Endpoint_Write_8(idle_duration);
328 Endpoint_ClearStatusStage();
335 /*******************************************************************************
337 ******************************************************************************/
338 static uint8_t keyboard_leds(void)
340 return keyboard_led_stats;
343 static void send_keyboard(report_keyboard_t *report)
345 uint8_t timeout = 255;
347 if (USB_DeviceState != DEVICE_STATE_Configured)
350 /* Select the Keyboard Report Endpoint */
353 Endpoint_SelectEndpoint(NKRO_IN_EPNUM);
355 /* Check if write ready for a polling interval around 1ms */
356 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(4);
357 if (!Endpoint_IsReadWriteAllowed()) return;
362 Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
364 /* Check if write ready for a polling interval around 10ms */
365 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
366 if (!Endpoint_IsReadWriteAllowed()) return;
369 /* Write Keyboard Report Data */
372 Endpoint_Write_Stream_LE(report, NKRO_EPSIZE, NULL);
378 Endpoint_Write_Stream_LE(report, KEYBOARD_EPSIZE, NULL);
381 /* Finalize the stream transfer to send the last packet */
384 keyboard_report_sent = *report;
387 static void send_mouse(report_mouse_t *report)
390 uint8_t timeout = 255;
392 if (USB_DeviceState != DEVICE_STATE_Configured)
395 /* Select the Mouse Report Endpoint */
396 Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
398 /* Check if write ready for a polling interval around 10ms */
399 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
400 if (!Endpoint_IsReadWriteAllowed()) return;
402 /* Write Mouse Report Data */
403 Endpoint_Write_Stream_LE(report, sizeof(report_mouse_t), NULL);
405 /* Finalize the stream transfer to send the last packet */
410 static void send_system(uint16_t data)
412 uint8_t timeout = 255;
414 if (USB_DeviceState != DEVICE_STATE_Configured)
418 .report_id = REPORT_ID_SYSTEM,
421 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
423 /* Check if write ready for a polling interval around 10ms */
424 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
425 if (!Endpoint_IsReadWriteAllowed()) return;
427 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
431 static void send_consumer(uint16_t data)
433 uint8_t timeout = 255;
435 if (USB_DeviceState != DEVICE_STATE_Configured)
439 .report_id = REPORT_ID_CONSUMER,
442 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
444 /* Check if write ready for a polling interval around 10ms */
445 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
446 if (!Endpoint_IsReadWriteAllowed()) return;
448 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
453 /*******************************************************************************
455 ******************************************************************************/
456 #ifdef CONSOLE_ENABLE
457 #define SEND_TIMEOUT 5
458 int8_t sendchar(uint8_t c)
460 // Not wait once timeouted.
461 // Because sendchar() is called so many times, waiting each call causes big lag.
462 static bool timeouted = false;
464 if (USB_DeviceState != DEVICE_STATE_Configured)
467 uint8_t ep = Endpoint_GetCurrentEndpoint();
468 Endpoint_SelectEndpoint(CONSOLE_IN_EPNUM);
469 if (!Endpoint_IsEnabled() || !Endpoint_IsConfigured()) {
470 Endpoint_SelectEndpoint(ep);
474 if (timeouted && !Endpoint_IsReadWriteAllowed()) {
475 Endpoint_SelectEndpoint(ep);
481 uint8_t timeout = SEND_TIMEOUT;
482 uint16_t prevFN = USB_Device_GetFrameNumber();
483 while (!Endpoint_IsReadWriteAllowed()) {
484 switch (USB_DeviceState) {
485 case DEVICE_STATE_Unattached:
486 case DEVICE_STATE_Suspended:
489 if (Endpoint_IsStalled()) {
490 Endpoint_SelectEndpoint(ep);
493 if (prevFN != USB_Device_GetFrameNumber()) {
496 Endpoint_SelectEndpoint(ep);
499 prevFN = USB_Device_GetFrameNumber();
505 // send when bank is full
506 if (!Endpoint_IsReadWriteAllowed())
509 Endpoint_SelectEndpoint(ep);
513 int8_t sendchar(uint8_t c)
520 /*******************************************************************************
522 ******************************************************************************/
523 static void SetupHardware(void)
525 /* Disable watchdog if enabled by bootloader/fuses */
526 MCUSR &= ~(1 << WDRF);
529 /* Disable clock division */
530 clock_prescale_set(clock_div_1);
532 // Leonardo needs. Without this USB device is not recognized.
538 USB_Device_EnableSOFEvents();
539 print_set_sendchar(sendchar);
542 int main(void) __attribute__ ((weak));
548 /* wait for USB startup & debug output */
549 while (USB_DeviceState != DEVICE_STATE_Configured) {
550 #if defined(INTERRUPT_CONTROL_ENDPOINT)
556 print("USB configured.\n");
560 host_set_driver(&lufa_driver);
561 #ifdef SLEEP_LED_ENABLE
565 print("Keyboard start.\n");
567 while (USB_DeviceState == DEVICE_STATE_Suspended) {
568 suspend_power_down();
569 if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) {
570 USB_Device_SendRemoteWakeup();
576 #if !defined(INTERRUPT_CONTROL_ENDPOINT)