source: mainline/uspace/drv/bus/usb/usbhid/kbd/kbddev.c@ d6e2938

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since d6e2938 was 5da7199, checked in by Martin Decky <martin@…>, 14 years ago

remove the obsolete async API
  • Property mode set to 100644
File size: 25.3 KB
Line 
1/*
2 * Copyright (c) 2011 Lubos Slovak
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup drvusbhid
30 * @{
31 */
32/**
33 * @file
34 * USB HID keyboard device structure and API.
35 */
36
37#include <errno.h>
38#include <str_error.h>
39#include <stdio.h>
40
41#include <io/keycode.h>
42#include <io/console.h>
43#include <ipc/kbdev.h>
44#include <async.h>
45#include <fibril.h>
46#include <fibril_synch.h>
47
48#include <ddf/log.h>
49
50#include <usb/usb.h>
51#include <usb/dev/dp.h>
52#include <usb/dev/request.h>
53#include <usb/hid/hid.h>
54#include <usb/dev/pipes.h>
55#include <usb/debug.h>
56#include <usb/hid/hidparser.h>
57#include <usb/classes/classes.h>
58#include <usb/hid/usages/core.h>
59#include <usb/hid/request.h>
60#include <usb/hid/hidreport.h>
61#include <usb/hid/usages/led.h>
62
63#include <usb/dev/driver.h>
64
65#include "kbddev.h"
66
67#include "conv.h"
68#include "kbdrepeat.h"
69
70#include "../usbhid.h"
71
72/*----------------------------------------------------------------------------*/
73
74static const unsigned DEFAULT_ACTIVE_MODS = KM_NUM_LOCK;
75
76static const uint8_t ERROR_ROLLOVER = 1;
77
78/** Default idle rate for keyboards. */
79static const uint8_t IDLE_RATE = 0;
80
81/** Delay before a pressed key starts auto-repeating. */
82static const unsigned int DEFAULT_DELAY_BEFORE_FIRST_REPEAT = 500 * 1000;
83
84/** Delay between two repeats of a pressed key when auto-repeating. */
85static const unsigned int DEFAULT_REPEAT_DELAY = 50 * 1000;
86
87/*----------------------------------------------------------------------------*/
88
89/** Keyboard polling endpoint description for boot protocol class. */
90usb_endpoint_description_t usb_hid_kbd_poll_endpoint_description = {
91 .transfer_type = USB_TRANSFER_INTERRUPT,
92 .direction = USB_DIRECTION_IN,
93 .interface_class = USB_CLASS_HID,
94 .interface_subclass = USB_HID_SUBCLASS_BOOT,
95 .interface_protocol = USB_HID_PROTOCOL_KEYBOARD,
96 .flags = 0
97};
98
99const char *HID_KBD_FUN_NAME = "keyboard";
100const char *HID_KBD_CATEGORY_NAME = "keyboard";
101
102static void usb_kbd_set_led(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev);
103
104/*----------------------------------------------------------------------------*/
105
106enum {
107 USB_KBD_BOOT_REPORT_DESCRIPTOR_SIZE = 63
108};
109
110static const uint8_t USB_KBD_BOOT_REPORT_DESCRIPTOR[
111 USB_KBD_BOOT_REPORT_DESCRIPTOR_SIZE] = {
112 0x05, 0x01, // Usage Page (Generic Desktop),
113 0x09, 0x06, // Usage (Keyboard),
114 0xA1, 0x01, // Collection (Application),
115 0x75, 0x01, // Report Size (1),
116 0x95, 0x08, // Report Count (8),
117 0x05, 0x07, // Usage Page (Key Codes);
118 0x19, 0xE0, // Usage Minimum (224),
119 0x29, 0xE7, // Usage Maximum (231),
120 0x15, 0x00, // Logical Minimum (0),
121 0x25, 0x01, // Logical Maximum (1),
122 0x81, 0x02, // Input (Data, Variable, Absolute), ; Modifier byte
123 0x95, 0x01, // Report Count (1),
124 0x75, 0x08, // Report Size (8),
125 0x81, 0x01, // Input (Constant), ; Reserved byte
126 0x95, 0x05, // Report Count (5),
127 0x75, 0x01, // Report Size (1),
128 0x05, 0x08, // Usage Page (Page# for LEDs),
129 0x19, 0x01, // Usage Minimum (1),
130 0x29, 0x05, // Usage Maxmimum (5),
131 0x91, 0x02, // Output (Data, Variable, Absolute), ; LED report
132 0x95, 0x01, // Report Count (1),
133 0x75, 0x03, // Report Size (3),
134 0x91, 0x01, // Output (Constant), ; LED report padding
135 0x95, 0x06, // Report Count (6),
136 0x75, 0x08, // Report Size (8),
137 0x15, 0x00, // Logical Minimum (0),
138 0x25, 0xff, // Logical Maximum (255),
139 0x05, 0x07, // Usage Page (Key Codes),
140 0x19, 0x00, // Usage Minimum (0),
141 0x29, 0xff, // Usage Maximum (255),
142 0x81, 0x00, // Input (Data, Array), ; Key arrays (6 bytes)
143 0xC0 // End Collection
144
145};
146
147/*----------------------------------------------------------------------------*/
148
149typedef enum usb_kbd_flags {
150 USB_KBD_STATUS_UNINITIALIZED = 0,
151 USB_KBD_STATUS_INITIALIZED = 1,
152 USB_KBD_STATUS_TO_DESTROY = -1
153} usb_kbd_flags;
154
155/*----------------------------------------------------------------------------*/
156/* IPC method handler */
157/*----------------------------------------------------------------------------*/
158
159static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *);
160
161/**
162 * Default handler for IPC methods not handled by DDF.
163 *
164 * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it
165 * assumes the caller is the console and thus it stores IPC session to it for
166 * later use by the driver to notify about key events.
167 *
168 * @param fun Device function handling the call.
169 * @param icallid Call id.
170 * @param icall Call data.
171 */
172static void default_connection_handler(ddf_fun_t *fun,
173 ipc_callid_t icallid, ipc_call_t *icall)
174{
175 sysarg_t method = IPC_GET_IMETHOD(*icall);
176
177 usb_kbd_t *kbd_dev = (usb_kbd_t *) fun->driver_data;
178 if (kbd_dev == NULL) {
179 usb_log_debug("default_connection_handler: "
180 "Missing parameter.\n");
181 async_answer_0(icallid, EINVAL);
182 return;
183 }
184
185 async_sess_t *sess =
186 async_callback_receive_start(EXCHANGE_SERIALIZE, icall);
187 if (sess != NULL) {
188 if (kbd_dev->console_sess == NULL) {
189 kbd_dev->console_sess = sess;
190 usb_log_debug("default_connection_handler: OK\n");
191 async_answer_0(icallid, EOK);
192 } else {
193 usb_log_debug("default_connection_handler: "
194 "console session already set\n");
195 async_answer_0(icallid, ELIMIT);
196 }
197 } else {
198 switch (method) {
199 case KBDEV_SET_IND:
200 kbd_dev->mods = IPC_GET_ARG1(*icall);
201 usb_kbd_set_led(kbd_dev->hid_dev, kbd_dev);
202 async_answer_0(icallid, EOK);
203 break;
204 default:
205 usb_log_debug("default_connection_handler: Wrong function.\n");
206 async_answer_0(icallid, EINVAL);
207 break;
208 }
209 }
210}
211
212/*----------------------------------------------------------------------------*/
213/* Key processing functions */
214/*----------------------------------------------------------------------------*/
215/**
216 * Handles turning of LED lights on and off.
217 *
218 * As with most other keyboards, the LED indicators in USB keyboards are
219 * driven by software. When state of some modifier changes, the input server
220 * will call us and tell us to update the LED state and what the new state
221 * should be.
222 *
223 * This functions sets the LED lights according to current settings of modifiers
224 * kept in the keyboard device structure.
225 *
226 * @param kbd_dev Keyboard device structure.
227 */
228static void usb_kbd_set_led(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev)
229{
230 if (kbd_dev->output_size == 0) {
231 return;
232 }
233
234 /* Reset the LED data. */
235 memset(kbd_dev->led_data, 0, kbd_dev->led_output_size * sizeof(int32_t));
236 usb_log_debug("Creating output report:\n");
237
238 usb_hid_report_field_t *field = usb_hid_report_get_sibling(
239 hid_dev->report, NULL, kbd_dev->led_path,
240 USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY,
241 USB_HID_REPORT_TYPE_OUTPUT);
242
243 while (field != NULL) {
244
245 if ((field->usage == USB_HID_LED_NUM_LOCK)
246 && (kbd_dev->mods & KM_NUM_LOCK)){
247 field->value = 1;
248 }
249
250 if ((field->usage == USB_HID_LED_CAPS_LOCK)
251 && (kbd_dev->mods & KM_CAPS_LOCK)){
252 field->value = 1;
253 }
254
255 if ((field->usage == USB_HID_LED_SCROLL_LOCK)
256 && (kbd_dev->mods & KM_SCROLL_LOCK)){
257 field->value = 1;
258 }
259
260 field = usb_hid_report_get_sibling(hid_dev->report, field,
261 kbd_dev->led_path,
262 USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY,
263 USB_HID_REPORT_TYPE_OUTPUT);
264 }
265
266 // TODO: what about the Report ID?
267 int rc = usb_hid_report_output_translate(hid_dev->report, 0,
268 kbd_dev->output_buffer, kbd_dev->output_size);
269
270 if (rc != EOK) {
271 usb_log_warning("Error translating LED output to output report"
272 ".\n");
273 return;
274 }
275
276 usb_log_debug("Output report buffer: %s\n",
277 usb_debug_str_buffer(kbd_dev->output_buffer, kbd_dev->output_size,
278 0));
279
280 usbhid_req_set_report(&hid_dev->usb_dev->ctrl_pipe,
281 hid_dev->usb_dev->interface_no, USB_HID_REPORT_TYPE_OUTPUT,
282 kbd_dev->output_buffer, kbd_dev->output_size);
283}
284
285/*----------------------------------------------------------------------------*/
286/** Send key event.
287 *
288 * @param kbd_dev Keyboard device structure.
289 * @param type Type of the event (press / release). Recognized values:
290 * KEY_PRESS, KEY_RELEASE
291 * @param key Key code
292 */
293void usb_kbd_push_ev(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev, int type,
294 unsigned int key)
295{
296 usb_log_debug2("Sending kbdev event %d/%d to the console\n", type, key);
297 if (kbd_dev->console_sess == NULL) {
298 usb_log_warning(
299 "Connection to console not ready, key discarded.\n");
300 return;
301 }
302
303 async_exch_t *exch = async_exchange_begin(kbd_dev->console_sess);
304 async_msg_2(exch, KBDEV_EVENT, type, key);
305 async_exchange_end(exch);
306}
307
308/*----------------------------------------------------------------------------*/
309
310static inline int usb_kbd_is_lock(unsigned int key_code)
311{
312 return (key_code == KC_NUM_LOCK
313 || key_code == KC_SCROLL_LOCK
314 || key_code == KC_CAPS_LOCK);
315}
316
317static size_t find_in_array_int32(int32_t val, int32_t *arr, size_t arr_size)
318{
319 for (size_t i = 0; i < arr_size; i++) {
320 if (arr[i] == val) {
321 return i;
322 }
323 }
324
325 return (size_t) -1;
326}
327
328/*----------------------------------------------------------------------------*/
329/**
330 * Checks if some keys were pressed or released and generates key events.
331 *
332 * An event is created only when key is pressed or released. Besides handling
333 * the events (usb_kbd_push_ev()), the auto-repeat fibril is notified about
334 * key presses and releases (see usb_kbd_repeat_start() and
335 * usb_kbd_repeat_stop()).
336 *
337 * @param kbd_dev Keyboard device structure.
338 * @param key_codes Parsed keyboard report - codes of currently pressed keys
339 * according to HID Usage Tables.
340 * @param count Number of key codes in report (size of the report).
341 *
342 * @sa usb_kbd_push_ev(), usb_kbd_repeat_start(), usb_kbd_repeat_stop()
343 */
344static void usb_kbd_check_key_changes(usb_hid_dev_t *hid_dev,
345 usb_kbd_t *kbd_dev)
346{
347 unsigned int key;
348 size_t i;
349
350 /*
351 * First of all, check if the kbd have reported phantom state.
352 *
353 * As there is no way to distinguish keys from modifiers, we do not have
354 * a way to check that 'all keys report Error Rollover'. We thus check
355 * if there is at least one such error and in such case we ignore the
356 * whole input report.
357 */
358 i = find_in_array_int32(ERROR_ROLLOVER, kbd_dev->keys,
359 kbd_dev->key_count);
360 if (i != (size_t) -1) {
361 usb_log_debug("Detected phantom state.\n");
362 return;
363 }
364
365 /*
366 * Key releases
367 */
368 for (i = 0; i < kbd_dev->key_count; i++) {
369 int32_t old_key = kbd_dev->keys_old[i];
370 /* Find the old key among currently pressed keys. */
371 size_t pos = find_in_array_int32(old_key, kbd_dev->keys,
372 kbd_dev->key_count);
373 /* If the key was not found, we need to signal release. */
374 if (pos == (size_t) -1) {
375 key = usbhid_parse_scancode(old_key);
376 if (!usb_kbd_is_lock(key)) {
377 usb_kbd_repeat_stop(kbd_dev, key);
378 }
379 usb_kbd_push_ev(hid_dev, kbd_dev, KEY_RELEASE, key);
380 usb_log_debug2("Key released: %u "
381 "(USB code %" PRIu32 ")\n", key, old_key);
382 }
383 }
384
385 /*
386 * Key presses
387 */
388 for (i = 0; i < kbd_dev->key_count; ++i) {
389 int32_t new_key = kbd_dev->keys[i];
390 /* Find the new key among already pressed keys. */
391 size_t pos = find_in_array_int32(new_key, kbd_dev->keys_old,
392 kbd_dev->key_count);
393 /* If the key was not found, we need to signal press. */
394 if (pos == (size_t) -1) {
395 key = usbhid_parse_scancode(kbd_dev->keys[i]);
396 if (!usb_kbd_is_lock(key)) {
397 usb_kbd_repeat_start(kbd_dev, key);
398 }
399 usb_kbd_push_ev(hid_dev, kbd_dev, KEY_PRESS, key);
400 usb_log_debug2("Key pressed: %u "
401 "(USB code %" PRIu32 ")\n", key, new_key);
402 }
403 }
404
405 memcpy(kbd_dev->keys_old, kbd_dev->keys, kbd_dev->key_count * 4);
406
407 char key_buffer[512];
408 ddf_dump_buffer(key_buffer, 512,
409 kbd_dev->keys_old, 4, kbd_dev->key_count, 0);
410 usb_log_debug2("Stored keys %s.\n", key_buffer);
411}
412
413/*----------------------------------------------------------------------------*/
414/* General kbd functions */
415/*----------------------------------------------------------------------------*/
416/**
417 * Processes data received from the device in form of report.
418 *
419 * This function uses the HID report parser to translate the data received from
420 * the device into generic USB HID key codes and into generic modifiers bitmap.
421 * The parser then calls the given callback (usb_kbd_process_keycodes()).
422 *
423 * @note Currently, only the boot protocol is supported.
424 *
425 * @param kbd_dev Keyboard device structure (must be initialized).
426 * @param buffer Data from the keyboard (i.e. the report).
427 * @param actual_size Size of the data from keyboard (report size) in bytes.
428 *
429 * @sa usb_kbd_process_keycodes(), usb_hid_boot_keyboard_input_report(),
430 * usb_hid_parse_report().
431 */
432static void usb_kbd_process_data(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev)
433{
434 assert(hid_dev->report != NULL);
435 assert(hid_dev != NULL);
436 assert(kbd_dev != NULL);
437
438 usb_hid_report_path_t *path = usb_hid_report_path();
439 usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0);
440
441 usb_hid_report_path_set_report_id (path, hid_dev->report_id);
442
443 // fill in the currently pressed keys
444
445 usb_hid_report_field_t *field = usb_hid_report_get_sibling(
446 hid_dev->report, NULL, path,
447 USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY,
448 USB_HID_REPORT_TYPE_INPUT);
449 unsigned i = 0;
450
451 while (field != NULL) {
452 usb_log_debug2("FIELD (%p) - VALUE(%d) USAGE(%u)\n",
453 field, field->value, field->usage);
454
455 assert(i < kbd_dev->key_count);
456
457 // save the key usage
458 if (field->value != 0) {
459 kbd_dev->keys[i] = field->usage;
460 }
461 else {
462 kbd_dev->keys[i] = 0;
463 }
464 usb_log_debug2("Saved %u. key usage %d\n", i, kbd_dev->keys[i]);
465
466 ++i;
467 field = usb_hid_report_get_sibling(hid_dev->report, field, path,
468 USB_HID_PATH_COMPARE_END
469 | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY,
470 USB_HID_REPORT_TYPE_INPUT);
471 }
472
473 usb_hid_report_path_free(path);
474
475 usb_kbd_check_key_changes(hid_dev, kbd_dev);
476}
477
478/*----------------------------------------------------------------------------*/
479/* HID/KBD structure manipulation */
480/*----------------------------------------------------------------------------*/
481
482static void usb_kbd_mark_unusable(usb_kbd_t *kbd_dev)
483{
484 kbd_dev->initialized = USB_KBD_STATUS_TO_DESTROY;
485}
486
487/*----------------------------------------------------------------------------*/
488
489/**
490 * Creates a new USB/HID keyboard structure.
491 *
492 * The structure returned by this function is not initialized. Use
493 * usb_kbd_init() to initialize it prior to polling.
494 *
495 * @return New uninitialized structure for representing a USB/HID keyboard or
496 * NULL if not successful (memory error).
497 */
498static usb_kbd_t *usb_kbd_new(void)
499{
500 usb_kbd_t *kbd_dev =
501 (usb_kbd_t *)calloc(1, sizeof(usb_kbd_t));
502
503 if (kbd_dev == NULL) {
504 usb_log_fatal("No memory!\n");
505 return NULL;
506 }
507
508 kbd_dev->console_sess = NULL;
509 kbd_dev->initialized = USB_KBD_STATUS_UNINITIALIZED;
510
511 return kbd_dev;
512}
513
514/*----------------------------------------------------------------------------*/
515
516static int usb_kbd_create_function(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev)
517{
518 assert(hid_dev != NULL);
519 assert(hid_dev->usb_dev != NULL);
520 assert(kbd_dev != NULL);
521
522 /* Create the exposed function. */
523 usb_log_debug("Creating DDF function %s...\n", HID_KBD_FUN_NAME);
524 ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed,
525 HID_KBD_FUN_NAME);
526 if (fun == NULL) {
527 usb_log_error("Could not create DDF function node.\n");
528 return ENOMEM;
529 }
530
531 /*
532 * Store the initialized HID device and HID ops
533 * to the DDF function.
534 */
535 fun->ops = &kbd_dev->ops;
536 fun->driver_data = kbd_dev;
537
538 int rc = ddf_fun_bind(fun);
539 if (rc != EOK) {
540 usb_log_error("Could not bind DDF function: %s.\n",
541 str_error(rc));
542 ddf_fun_destroy(fun);
543 return rc;
544 }
545
546 usb_log_debug("%s function created. Handle: %" PRIun "\n",
547 HID_KBD_FUN_NAME, fun->handle);
548
549 usb_log_debug("Adding DDF function to category %s...\n",
550 HID_KBD_CLASS_NAME);
551 rc = ddf_fun_add_to_category(fun, HID_KBD_CATEGORY_NAME);
552 if (rc != EOK) {
553 usb_log_error(
554 "Could not add DDF function to category %s: %s.\n",
555 HID_KBD_CLASS_NAME, str_error(rc));
556 ddf_fun_destroy(fun);
557 return rc;
558 }
559
560 return EOK;
561}
562
563/*----------------------------------------------------------------------------*/
564/* API functions */
565/*----------------------------------------------------------------------------*/
566/**
567 * Initialization of the USB/HID keyboard structure.
568 *
569 * This functions initializes required structures from the device's descriptors.
570 *
571 * During initialization, the keyboard is switched into boot protocol, the idle
572 * rate is set to 0 (infinity), resulting in the keyboard only reporting event
573 * when a key is pressed or released. Finally, the LED lights are turned on
574 * according to the default setup of lock keys.
575 *
576 * @note By default, the keyboards is initialized with Num Lock turned on and
577 * other locks turned off.
578 *
579 * @param kbd_dev Keyboard device structure to be initialized.
580 * @param dev DDF device structure of the keyboard.
581 *
582 * @retval EOK if successful.
583 * @retval EINVAL if some parameter is not given.
584 * @return Other value inherited from function usbhid_dev_init().
585 */
586int usb_kbd_init(usb_hid_dev_t *hid_dev, void **data)
587{
588 usb_log_debug("Initializing HID/KBD structure...\n");
589
590 if (hid_dev == NULL) {
591 usb_log_error("Failed to init keyboard structure: no structure"
592 " given.\n");
593 return EINVAL;
594 }
595
596 usb_kbd_t *kbd_dev = usb_kbd_new();
597 if (kbd_dev == NULL) {
598 usb_log_error("Error while creating USB/HID KBD device "
599 "structure.\n");
600 return ENOMEM; // TODO: some other code??
601 }
602
603 /* Store link to HID device */
604 kbd_dev->hid_dev = hid_dev;
605
606 /*
607 * TODO: make more general
608 */
609 usb_hid_report_path_t *path = usb_hid_report_path();
610 usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0);
611
612 usb_hid_report_path_set_report_id(path, 0);
613
614 kbd_dev->key_count = usb_hid_report_size(
615 hid_dev->report, 0, USB_HID_REPORT_TYPE_INPUT);
616 usb_hid_report_path_free(path);
617
618 usb_log_debug("Size of the input report: %zu\n", kbd_dev->key_count);
619
620 kbd_dev->keys = (int32_t *)calloc(kbd_dev->key_count, sizeof(int32_t));
621
622 if (kbd_dev->keys == NULL) {
623 usb_log_fatal("No memory!\n");
624 free(kbd_dev);
625 return ENOMEM;
626 }
627
628 kbd_dev->keys_old =
629 (int32_t *)calloc(kbd_dev->key_count, sizeof(int32_t));
630
631 if (kbd_dev->keys_old == NULL) {
632 usb_log_fatal("No memory!\n");
633 free(kbd_dev->keys);
634 free(kbd_dev);
635 return ENOMEM;
636 }
637
638 /*
639 * Output report
640 */
641 kbd_dev->output_size = 0;
642 kbd_dev->output_buffer = usb_hid_report_output(hid_dev->report,
643 &kbd_dev->output_size, 0);
644 if (kbd_dev->output_buffer == NULL) {
645 usb_log_warning("Error creating output report buffer.\n");
646 free(kbd_dev->keys);
647 return ENOMEM;
648 }
649
650 usb_log_debug("Output buffer size: %zu\n", kbd_dev->output_size);
651
652 kbd_dev->led_path = usb_hid_report_path();
653 usb_hid_report_path_append_item(
654 kbd_dev->led_path, USB_HIDUT_PAGE_LED, 0);
655
656 kbd_dev->led_output_size = usb_hid_report_size(hid_dev->report,
657 0, USB_HID_REPORT_TYPE_OUTPUT);
658
659 usb_log_debug("Output report size (in items): %zu\n",
660 kbd_dev->led_output_size);
661
662 kbd_dev->led_data = (int32_t *)calloc(
663 kbd_dev->led_output_size, sizeof(int32_t));
664
665 if (kbd_dev->led_data == NULL) {
666 usb_log_warning("Error creating buffer for LED output report."
667 "\n");
668 free(kbd_dev->keys);
669 usb_hid_report_output_free(kbd_dev->output_buffer);
670 free(kbd_dev);
671 return ENOMEM;
672 }
673
674 /*
675 * Modifiers and locks
676 */
677 kbd_dev->modifiers = 0;
678 kbd_dev->mods = DEFAULT_ACTIVE_MODS;
679 kbd_dev->lock_keys = 0;
680
681 /*
682 * Autorepeat
683 */
684 kbd_dev->repeat.key_new = 0;
685 kbd_dev->repeat.key_repeated = 0;
686 kbd_dev->repeat.delay_before = DEFAULT_DELAY_BEFORE_FIRST_REPEAT;
687 kbd_dev->repeat.delay_between = DEFAULT_REPEAT_DELAY;
688
689 kbd_dev->repeat_mtx = (fibril_mutex_t *)(
690 malloc(sizeof(fibril_mutex_t)));
691 if (kbd_dev->repeat_mtx == NULL) {
692 usb_log_fatal("No memory!\n");
693 free(kbd_dev->keys);
694 usb_hid_report_output_free(kbd_dev->output_buffer);
695 free(kbd_dev);
696 return ENOMEM;
697 }
698
699 fibril_mutex_initialize(kbd_dev->repeat_mtx);
700
701 // save the KBD device structure into the HID device structure
702 *data = kbd_dev;
703
704 // set handler for incoming calls
705 kbd_dev->ops.default_handler = default_connection_handler;
706
707 /*
708 * Set LEDs according to initial setup.
709 * Set Idle rate
710 */
711 usb_kbd_set_led(hid_dev, kbd_dev);
712
713 usbhid_req_set_idle(&hid_dev->usb_dev->ctrl_pipe,
714 hid_dev->usb_dev->interface_no, IDLE_RATE);
715
716 /*
717 * Create new fibril for auto-repeat
718 */
719 fid_t fid = fibril_create(usb_kbd_repeat_fibril, kbd_dev);
720 if (fid == 0) {
721 usb_log_error("Failed to start fibril for KBD auto-repeat");
722 return ENOMEM;
723 }
724 fibril_add_ready(fid);
725
726 kbd_dev->initialized = USB_KBD_STATUS_INITIALIZED;
727 usb_log_debug("HID/KBD device structure initialized.\n");
728
729 usb_log_debug("Creating KBD function...\n");
730 int rc = usb_kbd_create_function(hid_dev, kbd_dev);
731 if (rc != EOK) {
732 usb_kbd_destroy(kbd_dev);
733 return rc;
734 }
735
736 return EOK;
737}
738
739/*----------------------------------------------------------------------------*/
740
741bool usb_kbd_polling_callback(usb_hid_dev_t *hid_dev, void *data)
742{
743 if (hid_dev == NULL/* || buffer == NULL*/ || data == NULL) {
744 // do not continue polling (???)
745 return false;
746 }
747
748 usb_kbd_t *kbd_dev = (usb_kbd_t *)data;
749 assert(kbd_dev != NULL);
750
751 // TODO: add return value from this function
752 usb_kbd_process_data(hid_dev, kbd_dev);
753
754 return true;
755}
756
757/*----------------------------------------------------------------------------*/
758
759int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev)
760{
761 return (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED);
762}
763
764/*----------------------------------------------------------------------------*/
765
766int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev)
767{
768 return (kbd_dev->initialized == USB_KBD_STATUS_TO_DESTROY);
769}
770
771/*----------------------------------------------------------------------------*/
772/**
773 * Properly destroys the USB/HID keyboard structure.
774 *
775 * @param kbd_dev Pointer to the structure to be destroyed.
776 */
777void usb_kbd_destroy(usb_kbd_t *kbd_dev)
778{
779 if (kbd_dev == NULL) {
780 return;
781 }
782
783 // hangup session to the console
784 async_hangup(kbd_dev->console_sess);
785
786 if (kbd_dev->repeat_mtx != NULL) {
787 //assert(!fibril_mutex_is_locked((*kbd_dev)->repeat_mtx));
788 // FIXME - the fibril_mutex_is_locked may not cause
789 // fibril scheduling
790 while (fibril_mutex_is_locked(kbd_dev->repeat_mtx)) {}
791 free(kbd_dev->repeat_mtx);
792 }
793
794 // free all buffers
795 if (kbd_dev->keys != NULL) {
796 free(kbd_dev->keys);
797 }
798 if (kbd_dev->keys_old != NULL) {
799 free(kbd_dev->keys_old);
800 }
801 if (kbd_dev->led_data != NULL) {
802 free(kbd_dev->led_data);
803 }
804 if (kbd_dev->led_path != NULL) {
805 usb_hid_report_path_free(kbd_dev->led_path);
806 }
807 if (kbd_dev->output_buffer != NULL) {
808 usb_hid_report_output_free(kbd_dev->output_buffer);
809 }
810}
811
812/*----------------------------------------------------------------------------*/
813
814void usb_kbd_deinit(usb_hid_dev_t *hid_dev, void *data)
815{
816 if (hid_dev == NULL) {
817 return;
818 }
819
820 if (data != NULL) {
821 usb_kbd_t *kbd_dev = (usb_kbd_t *)data;
822 if (usb_kbd_is_initialized(kbd_dev)) {
823 usb_kbd_mark_unusable(kbd_dev);
824 } else {
825 usb_kbd_destroy(kbd_dev);
826 }
827 }
828}
829
830/*----------------------------------------------------------------------------*/
831
832int usb_kbd_set_boot_protocol(usb_hid_dev_t *hid_dev)
833{
834 int rc = usb_hid_parse_report_descriptor(hid_dev->report,
835 USB_KBD_BOOT_REPORT_DESCRIPTOR,
836 USB_KBD_BOOT_REPORT_DESCRIPTOR_SIZE);
837
838 if (rc != EOK) {
839 usb_log_error("Failed to parse boot report descriptor: %s\n",
840 str_error(rc));
841 return rc;
842 }
843
844 rc = usbhid_req_set_protocol(&hid_dev->usb_dev->ctrl_pipe,
845 hid_dev->usb_dev->interface_no, USB_HID_PROTOCOL_BOOT);
846
847 if (rc != EOK) {
848 usb_log_warning("Failed to set boot protocol to the device: "
849 "%s\n", str_error(rc));
850 return rc;
851 }
852
853 return EOK;
854}
855
856/**
857 * @}
858 */
Note: See TracBrowser for help on using the repository browser.