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 uint8_t keyboard_idle = 0;
56 uint8_t keyboard_protocol = 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);
212 ConfigSuccess &= ENDPOINT_CONFIG(CONSOLE_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
213 CONSOLE_EPSIZE, ENDPOINT_BANK_SINGLE);
218 /* Setup NKRO HID Report Endpoints */
219 ConfigSuccess &= ENDPOINT_CONFIG(NKRO_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
220 NKRO_EPSIZE, ENDPOINT_BANK_SINGLE);
225 Appendix G: HID Request Support Requirements
227 The following table enumerates the requests that need to be supported by various types of HID class devices.
229 Device type GetReport SetReport GetIdle SetIdle GetProtocol SetProtocol
230 ------------------------------------------------------------------------------------------
231 Boot Mouse Required Optional Optional Optional Required Required
232 Non-Boot Mouse Required Optional Optional Optional Optional Optional
233 Boot Keyboard Required Optional Required Required Required Required
234 Non-Boot Keybrd Required Optional Required Required Optional Optional
235 Other Device Required Optional Optional Optional Optional Optional
237 /** Event handler for the USB_ControlRequest event.
238 * This is fired before passing along unhandled control requests to the library for processing internally.
240 void EVENT_USB_Device_ControlRequest(void)
242 uint8_t* ReportData = NULL;
243 uint8_t ReportSize = 0;
245 /* Handle HID Class specific requests */
246 switch (USB_ControlRequest.bRequest)
248 case HID_REQ_GetReport:
249 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
251 Endpoint_ClearSETUP();
254 switch (USB_ControlRequest.wIndex) {
255 case KEYBOARD_INTERFACE:
257 ReportData = (uint8_t*)&keyboard_report_sent;
258 ReportSize = sizeof(keyboard_report_sent);
262 /* Write the report data to the control endpoint */
263 Endpoint_Write_Control_Stream_LE(ReportData, ReportSize);
268 case HID_REQ_SetReport:
269 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
273 switch (USB_ControlRequest.wIndex) {
274 case KEYBOARD_INTERFACE:
276 Endpoint_ClearSETUP();
278 while (!(Endpoint_IsOUTReceived())) {
279 if (USB_DeviceState == DEVICE_STATE_Unattached)
282 keyboard_led_stats = Endpoint_Read_8();
285 Endpoint_ClearStatusStage();
293 case HID_REQ_GetProtocol:
294 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
296 if (USB_ControlRequest.wIndex == KEYBOARD_INTERFACE) {
297 Endpoint_ClearSETUP();
298 while (!(Endpoint_IsINReady()));
299 Endpoint_Write_8(keyboard_protocol);
301 Endpoint_ClearStatusStage();
306 case HID_REQ_SetProtocol:
307 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
309 if (USB_ControlRequest.wIndex == KEYBOARD_INTERFACE) {
310 Endpoint_ClearSETUP();
311 Endpoint_ClearStatusStage();
313 keyboard_protocol = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
315 keyboard_nkro = !!keyboard_protocol;
322 case HID_REQ_SetIdle:
323 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
325 Endpoint_ClearSETUP();
326 Endpoint_ClearStatusStage();
328 keyboard_idle = ((USB_ControlRequest.wValue & 0xFF00) >> 8);
332 case HID_REQ_GetIdle:
333 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
335 Endpoint_ClearSETUP();
336 while (!(Endpoint_IsINReady()));
337 Endpoint_Write_8(keyboard_idle);
339 Endpoint_ClearStatusStage();
346 /*******************************************************************************
348 ******************************************************************************/
349 static uint8_t keyboard_leds(void)
351 return keyboard_led_stats;
354 static void send_keyboard(report_keyboard_t *report)
356 uint8_t timeout = 255;
358 if (USB_DeviceState != DEVICE_STATE_Configured)
361 /* Select the Keyboard Report Endpoint */
364 /* Report protocol - NKRO */
365 Endpoint_SelectEndpoint(NKRO_IN_EPNUM);
367 /* Check if write ready for a polling interval around 1ms */
368 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(4);
369 if (!Endpoint_IsReadWriteAllowed()) return;
371 /* Write Keyboard Report Data */
372 Endpoint_Write_Stream_LE(report, NKRO_EPSIZE, NULL);
378 Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
380 /* Check if write ready for a polling interval around 10ms */
381 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
382 if (!Endpoint_IsReadWriteAllowed()) return;
384 /* Write Keyboard Report Data */
385 Endpoint_Write_Stream_LE(report, KEYBOARD_EPSIZE, NULL);
388 /* Finalize the stream transfer to send the last packet */
391 keyboard_report_sent = *report;
394 static void send_mouse(report_mouse_t *report)
397 uint8_t timeout = 255;
399 if (USB_DeviceState != DEVICE_STATE_Configured)
402 /* Select the Mouse Report Endpoint */
403 Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
405 /* Check if write ready for a polling interval around 10ms */
406 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
407 if (!Endpoint_IsReadWriteAllowed()) return;
409 /* Write Mouse Report Data */
410 Endpoint_Write_Stream_LE(report, sizeof(report_mouse_t), NULL);
412 /* Finalize the stream transfer to send the last packet */
417 static void send_system(uint16_t data)
419 uint8_t timeout = 255;
421 if (USB_DeviceState != DEVICE_STATE_Configured)
425 .report_id = REPORT_ID_SYSTEM,
428 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
430 /* Check if write ready for a polling interval around 10ms */
431 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
432 if (!Endpoint_IsReadWriteAllowed()) return;
434 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
438 static void send_consumer(uint16_t data)
440 uint8_t timeout = 255;
442 if (USB_DeviceState != DEVICE_STATE_Configured)
446 .report_id = REPORT_ID_CONSUMER,
449 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
451 /* Check if write ready for a polling interval around 10ms */
452 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
453 if (!Endpoint_IsReadWriteAllowed()) return;
455 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
460 /*******************************************************************************
462 ******************************************************************************/
463 #ifdef CONSOLE_ENABLE
464 #define SEND_TIMEOUT 5
465 int8_t sendchar(uint8_t c)
467 // Not wait once timeouted.
468 // Because sendchar() is called so many times, waiting each call causes big lag.
469 static bool timeouted = false;
471 if (USB_DeviceState != DEVICE_STATE_Configured)
474 uint8_t ep = Endpoint_GetCurrentEndpoint();
475 Endpoint_SelectEndpoint(CONSOLE_IN_EPNUM);
476 if (!Endpoint_IsEnabled() || !Endpoint_IsConfigured()) {
477 Endpoint_SelectEndpoint(ep);
481 if (timeouted && !Endpoint_IsReadWriteAllowed()) {
482 Endpoint_SelectEndpoint(ep);
488 uint8_t timeout = SEND_TIMEOUT;
489 uint16_t prevFN = USB_Device_GetFrameNumber();
490 while (!Endpoint_IsReadWriteAllowed()) {
491 switch (USB_DeviceState) {
492 case DEVICE_STATE_Unattached:
493 case DEVICE_STATE_Suspended:
496 if (Endpoint_IsStalled()) {
497 Endpoint_SelectEndpoint(ep);
500 if (prevFN != USB_Device_GetFrameNumber()) {
503 Endpoint_SelectEndpoint(ep);
506 prevFN = USB_Device_GetFrameNumber();
512 // send when bank is full
513 if (!Endpoint_IsReadWriteAllowed())
516 Endpoint_SelectEndpoint(ep);
520 int8_t sendchar(uint8_t c)
527 /*******************************************************************************
529 ******************************************************************************/
530 static void SetupHardware(void)
532 /* Disable watchdog if enabled by bootloader/fuses */
533 MCUSR &= ~(1 << WDRF);
536 /* Disable clock division */
537 clock_prescale_set(clock_div_1);
539 // Leonardo needs. Without this USB device is not recognized.
545 USB_Device_EnableSOFEvents();
546 print_set_sendchar(sendchar);
549 int main(void) __attribute__ ((weak));
555 /* wait for USB startup & debug output */
556 while (USB_DeviceState != DEVICE_STATE_Configured) {
557 #if defined(INTERRUPT_CONTROL_ENDPOINT)
563 print("USB configured.\n");
567 host_set_driver(&lufa_driver);
568 #ifdef SLEEP_LED_ENABLE
572 print("Keyboard start.\n");
574 while (USB_DeviceState == DEVICE_STATE_Suspended) {
575 suspend_power_down();
576 if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) {
577 USB_Device_SendRemoteWakeup();
583 #if !defined(INTERRUPT_CONTROL_ENDPOINT)