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:
278 Endpoint_ClearSETUP();
280 while (!(Endpoint_IsOUTReceived())) {
281 if (USB_DeviceState == DEVICE_STATE_Unattached)
284 keyboard_led_stats = Endpoint_Read_8();
287 Endpoint_ClearStatusStage();
295 case HID_REQ_GetProtocol:
296 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
298 if (USB_ControlRequest.wIndex == KEYBOARD_INTERFACE) {
299 Endpoint_ClearSETUP();
300 while (!(Endpoint_IsINReady()));
301 Endpoint_Write_8(keyboard_protocol);
303 Endpoint_ClearStatusStage();
308 case HID_REQ_SetProtocol:
309 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
311 if (USB_ControlRequest.wIndex == KEYBOARD_INTERFACE) {
312 Endpoint_ClearSETUP();
313 Endpoint_ClearStatusStage();
315 keyboard_protocol = ((USB_ControlRequest.wValue & 0xFF) != 0x00);
317 keyboard_nkro = !!keyboard_protocol;
324 case HID_REQ_SetIdle:
325 if (USB_ControlRequest.bmRequestType == (REQDIR_HOSTTODEVICE | REQTYPE_CLASS | REQREC_INTERFACE))
327 Endpoint_ClearSETUP();
328 Endpoint_ClearStatusStage();
330 keyboard_idle = ((USB_ControlRequest.wValue & 0xFF00) >> 8);
334 case HID_REQ_GetIdle:
335 if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_CLASS | REQREC_INTERFACE))
337 Endpoint_ClearSETUP();
338 while (!(Endpoint_IsINReady()));
339 Endpoint_Write_8(keyboard_idle);
341 Endpoint_ClearStatusStage();
348 /*******************************************************************************
350 ******************************************************************************/
351 static uint8_t keyboard_leds(void)
353 return keyboard_led_stats;
356 static void send_keyboard(report_keyboard_t *report)
358 uint8_t timeout = 255;
360 if (USB_DeviceState != DEVICE_STATE_Configured)
363 /* Select the Keyboard Report Endpoint */
366 /* Report protocol - NKRO */
367 Endpoint_SelectEndpoint(NKRO_IN_EPNUM);
369 /* Check if write ready for a polling interval around 1ms */
370 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(4);
371 if (!Endpoint_IsReadWriteAllowed()) return;
373 /* Write Keyboard Report Data */
374 Endpoint_Write_Stream_LE(report, NKRO_EPSIZE, NULL);
380 Endpoint_SelectEndpoint(KEYBOARD_IN_EPNUM);
382 /* Check if write ready for a polling interval around 10ms */
383 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
384 if (!Endpoint_IsReadWriteAllowed()) return;
386 /* Write Keyboard Report Data */
387 Endpoint_Write_Stream_LE(report, KEYBOARD_EPSIZE, NULL);
390 /* Finalize the stream transfer to send the last packet */
393 keyboard_report_sent = *report;
396 static void send_mouse(report_mouse_t *report)
399 uint8_t timeout = 255;
401 if (USB_DeviceState != DEVICE_STATE_Configured)
404 /* Select the Mouse Report Endpoint */
405 Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
407 /* Check if write ready for a polling interval around 10ms */
408 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
409 if (!Endpoint_IsReadWriteAllowed()) return;
411 /* Write Mouse Report Data */
412 Endpoint_Write_Stream_LE(report, sizeof(report_mouse_t), NULL);
414 /* Finalize the stream transfer to send the last packet */
419 static void send_system(uint16_t data)
421 uint8_t timeout = 255;
423 if (USB_DeviceState != DEVICE_STATE_Configured)
427 .report_id = REPORT_ID_SYSTEM,
430 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
432 /* Check if write ready for a polling interval around 10ms */
433 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
434 if (!Endpoint_IsReadWriteAllowed()) return;
436 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
440 static void send_consumer(uint16_t data)
442 uint8_t timeout = 255;
444 if (USB_DeviceState != DEVICE_STATE_Configured)
448 .report_id = REPORT_ID_CONSUMER,
451 Endpoint_SelectEndpoint(EXTRAKEY_IN_EPNUM);
453 /* Check if write ready for a polling interval around 10ms */
454 while (timeout-- && !Endpoint_IsReadWriteAllowed()) _delay_us(40);
455 if (!Endpoint_IsReadWriteAllowed()) return;
457 Endpoint_Write_Stream_LE(&r, sizeof(report_extra_t), NULL);
462 /*******************************************************************************
464 ******************************************************************************/
465 #ifdef CONSOLE_ENABLE
466 #define SEND_TIMEOUT 5
467 int8_t sendchar(uint8_t c)
469 // Not wait once timeouted.
470 // Because sendchar() is called so many times, waiting each call causes big lag.
471 static bool timeouted = false;
473 if (USB_DeviceState != DEVICE_STATE_Configured)
476 uint8_t ep = Endpoint_GetCurrentEndpoint();
477 Endpoint_SelectEndpoint(CONSOLE_IN_EPNUM);
478 if (!Endpoint_IsEnabled() || !Endpoint_IsConfigured()) {
479 Endpoint_SelectEndpoint(ep);
483 if (timeouted && !Endpoint_IsReadWriteAllowed()) {
484 Endpoint_SelectEndpoint(ep);
490 uint8_t timeout = SEND_TIMEOUT;
491 uint16_t prevFN = USB_Device_GetFrameNumber();
492 while (!Endpoint_IsReadWriteAllowed()) {
493 switch (USB_DeviceState) {
494 case DEVICE_STATE_Unattached:
495 case DEVICE_STATE_Suspended:
498 if (Endpoint_IsStalled()) {
499 Endpoint_SelectEndpoint(ep);
502 if (prevFN != USB_Device_GetFrameNumber()) {
505 Endpoint_SelectEndpoint(ep);
508 prevFN = USB_Device_GetFrameNumber();
514 // send when bank is full
515 if (!Endpoint_IsReadWriteAllowed())
518 Endpoint_SelectEndpoint(ep);
522 int8_t sendchar(uint8_t c)
529 /*******************************************************************************
531 ******************************************************************************/
532 static void SetupHardware(void)
534 /* Disable watchdog if enabled by bootloader/fuses */
535 MCUSR &= ~(1 << WDRF);
538 /* Disable clock division */
539 clock_prescale_set(clock_div_1);
541 // Leonardo needs. Without this USB device is not recognized.
547 USB_Device_EnableSOFEvents();
548 print_set_sendchar(sendchar);
551 int main(void) __attribute__ ((weak));
557 /* wait for USB startup & debug output */
558 while (USB_DeviceState != DEVICE_STATE_Configured) {
559 #if defined(INTERRUPT_CONTROL_ENDPOINT)
565 print("USB configured.\n");
569 host_set_driver(&lufa_driver);
570 #ifdef SLEEP_LED_ENABLE
574 print("Keyboard start.\n");
576 while (USB_DeviceState == DEVICE_STATE_Suspended) {
577 suspend_power_down();
578 if (USB_Device_RemoteWakeupEnabled && suspend_wakeup_condition()) {
579 USB_Device_SendRemoteWakeup();
585 #if !defined(INTERRUPT_CONTROL_ENDPOINT)