Index: uspace/drv/usbhid/Makefile =================================================================== --- uspace/drv/usbhid/Makefile (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/Makefile (revision b2995c36bde63fff456febd935929123ef169c49) @@ -57,6 +57,6 @@ generic/hiddev.c \ mouse/mousedev.c \ - lgtch-ultrax/lgtch-ultrax.c \ - lgtch-ultrax/keymap.c \ + multimedia/multimedia.c \ + multimedia/keymap.c \ $(STOLEN_LAYOUT_SOURCES) Index: uspace/drv/usbhid/generic/hiddev.c =================================================================== --- uspace/drv/usbhid/generic/hiddev.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/generic/hiddev.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -162,5 +162,5 @@ /*----------------------------------------------------------------------------*/ -int usb_generic_hid_init(usb_hid_dev_t *hid_dev) +int usb_generic_hid_init(usb_hid_dev_t *hid_dev, void **data) { if (hid_dev == NULL) { @@ -173,5 +173,5 @@ /*----------------------------------------------------------------------------*/ -bool usb_generic_hid_polling_callback(usb_hid_dev_t *hid_dev, +bool usb_generic_hid_polling_callback(usb_hid_dev_t *hid_dev, void *data, uint8_t *buffer, size_t buffer_size) { Index: uspace/drv/usbhid/generic/hiddev.h =================================================================== --- uspace/drv/usbhid/generic/hiddev.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/generic/hiddev.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -48,7 +48,7 @@ /*----------------------------------------------------------------------------*/ -int usb_generic_hid_init(struct usb_hid_dev *hid_dev); +int usb_generic_hid_init(struct usb_hid_dev *hid_dev, void **data); -bool usb_generic_hid_polling_callback(struct usb_hid_dev *hid_dev, +bool usb_generic_hid_polling_callback(struct usb_hid_dev *hid_dev, void *data, uint8_t *buffer, size_t buffer_size); Index: uspace/drv/usbhid/kbd/kbddev.c =================================================================== --- uspace/drv/usbhid/kbd/kbddev.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/kbd/kbddev.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -252,7 +252,6 @@ sysarg_t method = IPC_GET_IMETHOD(*icall); - usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; - - if (hid_dev == NULL || hid_dev->data == NULL) { + usb_kbd_t *kbd_dev = (usb_kbd_t *)fun->driver_data; + if (kbd_dev == NULL) { usb_log_debug("default_connection_handler: " "Missing parameter.\n"); @@ -260,8 +259,4 @@ return; } - - assert(hid_dev != NULL); - assert(hid_dev->data != NULL); - usb_kbd_t *kbd_dev = (usb_kbd_t *)hid_dev->data; if (method == IPC_M_CONNECT_TO_ME) { @@ -313,9 +308,9 @@ usb_hid_report_field_t *field = usb_hid_report_get_sibling( hid_dev->report, NULL, kbd_dev->led_path, - USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY | USB_HID_PATH_COMPARE_END, + USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, USB_HID_REPORT_TYPE_OUTPUT); - while (field != NULL) { - + while (field != NULL) { + if ((field->usage == USB_HID_LED_NUM_LOCK) && (kbd_dev->mods & KM_NUM_LOCK)){ @@ -334,6 +329,7 @@ field = usb_hid_report_get_sibling(hid_dev->report, field, - kbd_dev->led_path, USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY - | USB_HID_PATH_COMPARE_END, USB_HID_REPORT_TYPE_OUTPUT); + kbd_dev->led_path, + USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_OUTPUT); } @@ -662,12 +658,10 @@ * usb_hid_parse_report(). */ -static void usb_kbd_process_data(usb_hid_dev_t *hid_dev, +static void usb_kbd_process_data(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev, uint8_t *buffer, size_t actual_size) { assert(hid_dev->report != NULL); assert(hid_dev != NULL); - assert(hid_dev->data != NULL); - - usb_kbd_t *kbd_dev = (usb_kbd_t *)hid_dev->data; + assert(kbd_dev != NULL); usb_log_debug("Calling usb_hid_parse_report() with " @@ -774,8 +768,9 @@ /*----------------------------------------------------------------------------*/ -static int usb_kbd_create_function(usb_hid_dev_t *hid_dev) +static int usb_kbd_create_function(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev) { assert(hid_dev != NULL); assert(hid_dev->usb_dev != NULL); + assert(kbd_dev != NULL); /* Create the function exposed under /dev/devices. */ @@ -792,6 +787,6 @@ * to the DDF function. */ - fun->ops = &hid_dev->ops; - fun->driver_data = hid_dev; // TODO: maybe change to hid_dev->data + fun->ops = &kbd_dev->ops; + fun->driver_data = kbd_dev; int rc = ddf_fun_bind(fun); @@ -840,5 +835,5 @@ * @return Other value inherited from function usbhid_dev_init(). */ -int usb_kbd_init(usb_hid_dev_t *hid_dev) +int usb_kbd_init(usb_hid_dev_t *hid_dev, void **data) { usb_log_debug("Initializing HID/KBD structure...\n"); @@ -865,7 +860,6 @@ usb_hid_report_path_set_report_id(path, 0); - kbd_dev->key_count = usb_hid_report_input_length( - hid_dev->report, path, - USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY); + kbd_dev->key_count = usb_hid_report_size( + hid_dev->report, 0, USB_HID_REPORT_TYPE_INPUT); usb_hid_report_path_free(path); @@ -908,7 +902,6 @@ kbd_dev->led_path, USB_HIDUT_PAGE_LED, 0); - kbd_dev->led_output_size = usb_hid_report_output_size(hid_dev->report, - kbd_dev->led_path, - USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY); + kbd_dev->led_output_size = usb_hid_report_size(hid_dev->report, + 0, USB_HID_REPORT_TYPE_OUTPUT); usb_log_debug("Output report size (in items): %zu\n", @@ -955,8 +948,9 @@ // save the KBD device structure into the HID device structure - hid_dev->data = kbd_dev; + //hid_dev->data = kbd_dev; + *data = kbd_dev; // set handler for incoming calls - hid_dev->ops.default_handler = default_connection_handler; + kbd_dev->ops.default_handler = default_connection_handler; /* @@ -983,5 +977,5 @@ usb_log_debug("Creating KBD function...\n"); - int rc = usb_kbd_create_function(hid_dev); + int rc = usb_kbd_create_function(hid_dev, kbd_dev); if (rc != EOK) { usb_kbd_free(&kbd_dev); @@ -994,14 +988,17 @@ /*----------------------------------------------------------------------------*/ -bool usb_kbd_polling_callback(usb_hid_dev_t *hid_dev, uint8_t *buffer, - size_t buffer_size) -{ - if (hid_dev == NULL || buffer == NULL) { +bool usb_kbd_polling_callback(usb_hid_dev_t *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + if (hid_dev == NULL || buffer == NULL || data == NULL) { // do not continue polling (???) return false; } + usb_kbd_t *kbd_dev = (usb_kbd_t *)data; + assert(kbd_dev != NULL); + // TODO: add return value from this function - usb_kbd_process_data(hid_dev, buffer, buffer_size); + usb_kbd_process_data(hid_dev, kbd_dev, buffer, buffer_size); return true; @@ -1066,5 +1063,5 @@ /*----------------------------------------------------------------------------*/ -void usb_kbd_deinit(usb_hid_dev_t *hid_dev) +void usb_kbd_deinit(usb_hid_dev_t *hid_dev, void *data) { if (hid_dev == NULL) { @@ -1072,11 +1069,10 @@ } - if (hid_dev->data != NULL) { - usb_kbd_t *kbd_dev = (usb_kbd_t *)hid_dev->data; + if (data != NULL) { + usb_kbd_t *kbd_dev = (usb_kbd_t *)data; if (usb_kbd_is_initialized(kbd_dev)) { usb_kbd_mark_unusable(kbd_dev); } else { usb_kbd_free(&kbd_dev); - hid_dev->data = NULL; } } Index: uspace/drv/usbhid/kbd/kbddev.h =================================================================== --- uspace/drv/usbhid/kbd/kbddev.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/kbd/kbddev.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -83,4 +83,7 @@ int console_phone; + /** @todo What is this actually? */ + ddf_dev_ops_t ops; + /** Information for auto-repeat of keys. */ usb_kbd_repeat_t repeat; @@ -117,8 +120,8 @@ /*----------------------------------------------------------------------------*/ -int usb_kbd_init(struct usb_hid_dev *hid_dev); +int usb_kbd_init(struct usb_hid_dev *hid_dev, void **data); -bool usb_kbd_polling_callback(struct usb_hid_dev *hid_dev, uint8_t *buffer, - size_t buffer_size); +bool usb_kbd_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev); @@ -131,5 +134,5 @@ int type, unsigned int key); -void usb_kbd_deinit(struct usb_hid_dev *hid_dev); +void usb_kbd_deinit(struct usb_hid_dev *hid_dev, void *data); int usb_kbd_set_boot_protocol(struct usb_hid_dev *hid_dev); Index: uspace/drv/usbhid/lgtch-ultrax/keymap.c =================================================================== --- uspace/drv/usbhid/lgtch-ultrax/keymap.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,101 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * UUSB multimedia key to keycode mapping. - */ - -#include -#include -#include -#include -#include "keymap.h" - -/** - * Mapping between USB HID multimedia usages (from HID Usage Tables) and - * corresponding HelenOS key codes. - * - * Currently only Usages used by Logitech UltraX keyboard are present. All other - * should result in 0. - */ -static int usb_hid_keymap_consumer[0x29c] = { - [0xf] = KC_F1, /* Just for testing purposes */ - [0x5] = KC_F1, /* Just for testing purposes */ - [0x8] = KC_F3, /* Just for testing purposes */ - [0x6] = KC_F4, /* Just for testing purposes */ - [0x7] = KC_F5, /* Just for testing purposes */ - [0xc] = KC_F6, /* Just for testing purposes */ - - [0xb5] = 0, /* Scan Next Track */ - [0xb6] = 0, /* Scan Previous Track */ - [0xb7] = 0, /* Stop */ - [0xb8] = 0, /* Eject */ - [0xcd] = KC_F2, /* Play/Pause */ - [0xe2] = KC_F3, /* Mute */ - [0xe9] = KC_F5, /* Volume Increment */ - [0xea] = KC_F4, /* Volume Decrement */ - [0x183] = 0, /* AL Consumer Control Configuration */ - [0x18a] = 0, /* AL Email Reader */ - [0x192] = 0, /* AL Calculator */ - [0x221] = 0, /* AC Search */ - [0x223] = 0, /* AC Home */ - [0x224] = 0, /* AC Back */ - [0x225] = 0, /* AC Forward */ - [0x226] = 0, /* AC Stop */ - [0x227] = KC_F1, /* AC Refresh */ - [0x22a] = KC_F6 /* AC Bookmarks */ -}; - -/** - * Translates USB HID Usages from the Consumer Page into HelenOS keycodes. - * - * @param usage USB HID Consumer Page Usage number. - * - * @retval HelenOS key code corresponding to the given USB Consumer Page Usage. - */ -unsigned int usb_lgtch_map_usage(int usage) -{ - unsigned int key; - int *map = usb_hid_keymap_consumer; - size_t map_length = sizeof(usb_hid_keymap_consumer) / sizeof(int); - - if ((usage < 0) || ((size_t)usage >= map_length)) - return -1; - - /*! @todo What if the usage is not in the table? */ - key = map[usage]; - - return key; -} - -/** - * @} - */ Index: uspace/drv/usbhid/lgtch-ultrax/keymap.h =================================================================== --- uspace/drv/usbhid/lgtch-ultrax/keymap.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,45 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB multimedia key to keycode mapping. - */ - -#ifndef USB_HID_LGTCH_ULTRAX_KEYMAP_H_ -#define USB_HID_LGTCH_ULTRAX_KEYMAP_H_ - -unsigned int usb_lgtch_map_usage(int usage); - -#endif /* USB_HID_LGTCH_ULTRAX_KEYMAP_H_ */ - -/** - * @} - */ Index: uspace/drv/usbhid/lgtch-ultrax/lgtch-ultrax.c =================================================================== --- uspace/drv/usbhid/lgtch-ultrax/lgtch-ultrax.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,427 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak, Vojtech Horky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** - * @file - * USB Logitech UltraX Keyboard sample driver. - */ - - -#include "lgtch-ultrax.h" -#include "../usbhid.h" -#include "keymap.h" - -#include -#include -#include - -#include -#include - -#include -#include - -#define NAME "lgtch-ultrax" - -typedef enum usb_lgtch_flags { - USB_LGTCH_STATUS_UNINITIALIZED = 0, - USB_LGTCH_STATUS_INITIALIZED = 1, - USB_LGTCH_STATUS_TO_DESTROY = -1 -} usb_lgtch_flags; - -/*----------------------------------------------------------------------------*/ -/** - * Logitech UltraX device type. - */ -typedef struct usb_lgtch_ultrax_t { - /** Previously pressed keys (not translated to key codes). */ - int32_t *keys_old; - /** Currently pressed keys (not translated to key codes). */ - int32_t *keys; - /** Count of stored keys (i.e. number of keys in the report). */ - size_t key_count; - - /** IPC phone to the console device (for sending key events). */ - int console_phone; - - /** Information for auto-repeat of keys. */ -// usb_kbd_repeat_t repeat; - - /** Mutex for accessing the information about auto-repeat. */ -// fibril_mutex_t *repeat_mtx; - - /** State of the structure (for checking before use). - * - * 0 - not initialized - * 1 - initialized - * -1 - ready for destroying - */ - int initialized; -} usb_lgtch_ultrax_t; - - -/*----------------------------------------------------------------------------*/ -/** - * Default handler for IPC methods not handled by DDF. - * - * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it - * assumes the caller is the console and thus it stores IPC phone to it for - * later use by the driver to notify about key events. - * - * @param fun Device function handling the call. - * @param icallid Call id. - * @param icall Call data. - */ -static void default_connection_handler(ddf_fun_t *fun, - ipc_callid_t icallid, ipc_call_t *icall) -{ - usb_log_debug(NAME " default_connection_handler()\n"); - - sysarg_t method = IPC_GET_IMETHOD(*icall); - - usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; - - if (hid_dev == NULL || hid_dev->data == NULL) { - async_answer_0(icallid, EINVAL); - return; - } - - assert(hid_dev != NULL); - assert(hid_dev->data != NULL); - usb_lgtch_ultrax_t *lgtch_dev = (usb_lgtch_ultrax_t *)hid_dev->data; - - if (method == IPC_M_CONNECT_TO_ME) { - int callback = IPC_GET_ARG5(*icall); - - if (lgtch_dev->console_phone != -1) { - async_answer_0(icallid, ELIMIT); - return; - } - - lgtch_dev->console_phone = callback; - usb_log_debug(NAME " Saved phone to console: %d\n", callback); - async_answer_0(icallid, EOK); - return; - } - - async_answer_0(icallid, EINVAL); -} - -/*----------------------------------------------------------------------------*/ - -static ddf_dev_ops_t lgtch_ultrax_ops = { - .default_handler = default_connection_handler -}; - -/*----------------------------------------------------------------------------*/ - -//static void usb_lgtch_process_keycodes(const uint8_t *key_codes, size_t count, -// uint8_t report_id, void *arg); - -//static const usb_hid_report_in_callbacks_t usb_lgtch_parser_callbacks = { -// .keyboard = usb_lgtch_process_keycodes -//}; - -///*----------------------------------------------------------------------------*/ - -//static void usb_lgtch_process_keycodes(const uint8_t *key_codes, size_t count, -// uint8_t report_id, void *arg) -//{ -// // TODO: checks - -// usb_log_debug(NAME " Got keys from parser (report id: %u): %s\n", -// report_id, usb_debug_str_buffer(key_codes, count, 0)); -//} - -/*----------------------------------------------------------------------------*/ -/** - * Processes key events. - * - * @note This function was copied from AT keyboard driver and modified to suit - * USB keyboard. - * - * @note Lock keys are not sent to the console, as they are completely handled - * in the driver. It may, however, be required later that the driver - * sends also these keys to application (otherwise it cannot use those - * keys at all). - * - * @param hid_dev - * @param lgtch_dev - * @param type Type of the event (press / release). Recognized values: - * KEY_PRESS, KEY_RELEASE - * @param key Key code of the key according to HID Usage Tables. - */ -static void usb_lgtch_push_ev(usb_hid_dev_t *hid_dev, int type, - unsigned int key) -{ - assert(hid_dev != NULL); - assert(hid_dev->data != NULL); - - usb_lgtch_ultrax_t *lgtch_dev = (usb_lgtch_ultrax_t *)hid_dev->data; - - console_event_t ev; - - ev.type = type; - ev.key = key; - ev.mods = 0; - - ev.c = 0; - - usb_log_debug2(NAME " Sending key %d to the console\n", ev.key); - if (lgtch_dev->console_phone < 0) { - usb_log_warning( - "Connection to console not ready, key discarded.\n"); - return; - } - - async_msg_4(lgtch_dev->console_phone, KBD_EVENT, ev.type, ev.key, - ev.mods, ev.c); -} - -/*----------------------------------------------------------------------------*/ - -static void usb_lgtch_free(usb_lgtch_ultrax_t **lgtch_dev) -{ - if (lgtch_dev == NULL || *lgtch_dev == NULL) { - return; - } - - // hangup phone to the console - async_hangup((*lgtch_dev)->console_phone); - -// if ((*lgtch_dev)->repeat_mtx != NULL) { -// /* TODO: replace by some check and wait */ -// assert(!fibril_mutex_is_locked((*lgtch_dev)->repeat_mtx)); -// free((*lgtch_dev)->repeat_mtx); -// } - - // free all buffers - if ((*lgtch_dev)->keys != NULL) { - free((*lgtch_dev)->keys); - } - if ((*lgtch_dev)->keys_old != NULL) { - free((*lgtch_dev)->keys_old); - } - - free(*lgtch_dev); - *lgtch_dev = NULL; -} - -/*----------------------------------------------------------------------------*/ - -static int usb_lgtch_create_function(usb_hid_dev_t *hid_dev) -{ - /* Create the function exposed under /dev/devices. */ - ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, - NAME); - if (fun == NULL) { - usb_log_error("Could not create DDF function node.\n"); - return ENOMEM; - } - - /* - * Store the initialized HID device and HID ops - * to the DDF function. - */ - fun->ops = &lgtch_ultrax_ops; - fun->driver_data = hid_dev; // TODO: maybe change to hid_dev->data - - int rc = ddf_fun_bind(fun); - if (rc != EOK) { - usb_log_error("Could not bind DDF function: %s.\n", - str_error(rc)); - // TODO: Can / should I destroy the DDF function? - ddf_fun_destroy(fun); - return rc; - } - - rc = ddf_fun_add_to_class(fun, "keyboard"); - if (rc != EOK) { - usb_log_error( - "Could not add DDF function to class 'keyboard': %s.\n", - str_error(rc)); - // TODO: Can / should I destroy the DDF function? - ddf_fun_destroy(fun); - return rc; - } - - return EOK; -} - -/*----------------------------------------------------------------------------*/ - -int usb_lgtch_init(struct usb_hid_dev *hid_dev) -{ - if (hid_dev == NULL || hid_dev->usb_dev == NULL) { - return EINVAL; /*! @todo Other return code? */ - } - - usb_log_debug(NAME " Initializing HID/lgtch_ultrax structure...\n"); - - usb_lgtch_ultrax_t *lgtch_dev = (usb_lgtch_ultrax_t *)malloc( - sizeof(usb_lgtch_ultrax_t)); - if (lgtch_dev == NULL) { - return ENOMEM; - } - - lgtch_dev->console_phone = -1; - - usb_hid_report_path_t *path = usb_hid_report_path(); - usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_CONSUMER, 0); - - usb_hid_report_path_set_report_id(path, 1); - - lgtch_dev->key_count = usb_hid_report_input_length( - hid_dev->report, path, - USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY); - usb_hid_report_path_free(path); - - usb_log_debug(NAME " Size of the input report: %zu\n", - lgtch_dev->key_count); - - lgtch_dev->keys = (int32_t *)calloc(lgtch_dev->key_count, - sizeof(int32_t)); - - if (lgtch_dev->keys == NULL) { - usb_log_fatal("No memory!\n"); - free(lgtch_dev); - return ENOMEM; - } - - lgtch_dev->keys_old = - (int32_t *)calloc(lgtch_dev->key_count, sizeof(int32_t)); - - if (lgtch_dev->keys_old == NULL) { - usb_log_fatal("No memory!\n"); - free(lgtch_dev->keys); - free(lgtch_dev); - return ENOMEM; - } - - /*! @todo Autorepeat */ - - // save the KBD device structure into the HID device structure - hid_dev->data = lgtch_dev; - - lgtch_dev->initialized = USB_LGTCH_STATUS_INITIALIZED; - usb_log_debug(NAME " HID/lgtch_ultrax device structure initialized.\n"); - - int rc = usb_lgtch_create_function(hid_dev); - if (rc != EOK) { - usb_lgtch_free(&lgtch_dev); - return rc; - } - - usb_log_debug(NAME " HID/lgtch_ultrax structure initialized.\n"); - - return EOK; -} - -/*----------------------------------------------------------------------------*/ - -void usb_lgtch_deinit(struct usb_hid_dev *hid_dev) -{ - if (hid_dev == NULL) { - return; - } - - if (hid_dev->data != NULL) { - usb_lgtch_ultrax_t *lgtch_dev = - (usb_lgtch_ultrax_t *)hid_dev->data; -// if (usb_kbd_is_initialized(kbd_dev)) { -// usb_kbd_mark_unusable(kbd_dev); -// } else { - usb_lgtch_free(&lgtch_dev); - hid_dev->data = NULL; -// } - } -} - -/*----------------------------------------------------------------------------*/ - -bool usb_lgtch_polling_callback(struct usb_hid_dev *hid_dev, - uint8_t *buffer, size_t buffer_size) -{ - // TODO: checks - - usb_log_debug(NAME " usb_lgtch_polling_callback(%p, %p, %zu)\n", - hid_dev, buffer, buffer_size); - - usb_log_debug(NAME " Calling usb_hid_parse_report() with " - "buffer %s\n", usb_debug_str_buffer(buffer, buffer_size, 0)); - - usb_hid_report_path_t *path = usb_hid_report_path(); - usb_hid_report_path_append_item(path, 0xc, 0); - - uint8_t report_id; - - int rc = usb_hid_parse_report(hid_dev->report, buffer, buffer_size, - &report_id); - - if (rc != EOK) { - usb_log_warning(NAME "Error in usb_hid_parse_report(): %s\n", - str_error(rc)); - return true; - } - - usb_hid_report_path_set_report_id(path, report_id); - - usb_hid_report_field_t *field = usb_hid_report_get_sibling( - hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END - | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, - USB_HID_REPORT_TYPE_INPUT); - - unsigned int key; - - /*! @todo Is this iterating OK if done multiple times? - * @todo The parsing is not OK - */ - while (field != NULL) { - usb_log_debug(NAME " KEY VALUE(%X) USAGE(%X)\n", field->value, - field->usage); - - key = usb_lgtch_map_usage(field->usage); - usb_lgtch_push_ev(hid_dev, KEY_PRESS, key); - - field = usb_hid_report_get_sibling( - hid_dev->report, field, path, USB_HID_PATH_COMPARE_END - | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, - USB_HID_REPORT_TYPE_INPUT); - } - - usb_hid_report_path_free(path); - - return true; -} - -/** - * @} - */ Index: uspace/drv/usbhid/lgtch-ultrax/lgtch-ultrax.h =================================================================== --- uspace/drv/usbhid/lgtch-ultrax/lgtch-ultrax.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,58 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB Logitech UltraX Keyboard sample driver. - */ - -#ifndef USB_HID_LGTCH_ULTRAX_H_ -#define USB_HID_LGTCH_ULTRAX_H_ - -#include - -struct usb_hid_dev; - -/*----------------------------------------------------------------------------*/ - -int usb_lgtch_init(struct usb_hid_dev *hid_dev); - -void usb_lgtch_deinit(struct usb_hid_dev *hid_dev); - -bool usb_lgtch_polling_callback(struct usb_hid_dev *hid_dev, uint8_t *buffer, - size_t buffer_size); - -/*----------------------------------------------------------------------------*/ - -#endif // USB_HID_LGTCH_ULTRAX_H_ - -/** - * @} - */ Index: uspace/drv/usbhid/mouse/mousedev.c =================================================================== --- uspace/drv/usbhid/mouse/mousedev.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/mouse/mousedev.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -122,7 +122,7 @@ sysarg_t method = IPC_GET_IMETHOD(*icall); - usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; - - if (hid_dev == NULL || hid_dev->data == NULL) { + usb_mouse_t *mouse_dev = (usb_mouse_t *)fun->driver_data; + + if (mouse_dev == NULL) { usb_log_debug("default_connection_handler: Missing " "parameters.\n"); @@ -131,7 +131,8 @@ } - assert(hid_dev != NULL); - assert(hid_dev->data != NULL); - usb_mouse_t *mouse_dev = (usb_mouse_t *)hid_dev->data; + usb_log_debug("default_connection_handler: fun->name: %s\n", + fun->name); + usb_log_debug("default_connection_handler: mouse_phone: %d, wheel " + "phone: %d\n", mouse_dev->mouse_phone, mouse_dev->wheel_phone); int *phone = (str_cmp(fun->name, HID_MOUSE_FUN_NAME) == 0) @@ -145,10 +146,9 @@ "phone to mouse already set.\n"); async_answer_0(icallid, ELIMIT); - //async_answer_0(icallid, EOK); return; } *phone = callback; - usb_log_debug("Console phone to mouse set ok (%d).\n", callback); + usb_log_debug("Console phone to mouse set ok (%d).\n", *phone); async_answer_0(icallid, EOK); return; @@ -224,8 +224,9 @@ /*----------------------------------------------------------------------------*/ -static bool usb_mouse_process_report(usb_hid_dev_t *hid_dev, uint8_t *buffer, - size_t buffer_size) -{ - usb_mouse_t *mouse_dev = (usb_mouse_t *)hid_dev->data; +static bool usb_mouse_process_report(usb_hid_dev_t *hid_dev, + usb_mouse_t *mouse_dev, uint8_t *buffer, + size_t buffer_size) +{ + assert(mouse_dev != NULL); usb_log_debug2("got buffer: %s.\n", @@ -378,6 +379,9 @@ /*----------------------------------------------------------------------------*/ -static int usb_mouse_create_function(usb_hid_dev_t *hid_dev) -{ +static int usb_mouse_create_function(usb_hid_dev_t *hid_dev, usb_mouse_t *mouse) +{ + assert(hid_dev != NULL); + assert(mouse != NULL); + /* Create the function exposed under /dev/devices. */ usb_log_debug("Creating DDF function %s...\n", HID_MOUSE_FUN_NAME); @@ -389,10 +393,6 @@ } - /* - * Store the initialized HID device and HID ops - * to the DDF function. - */ - fun->ops = &hid_dev->ops; - fun->driver_data = hid_dev; // TODO: maybe change to hid_dev->data + fun->ops = &mouse->ops; + fun->driver_data = mouse; // TODO: maybe change to hid_dev->data int rc = ddf_fun_bind(fun); @@ -431,6 +431,6 @@ * to the DDF function. */ - fun->ops = &hid_dev->ops; - fun->driver_data = hid_dev; // TODO: maybe change to hid_dev->data + fun->ops = &mouse->ops; + fun->driver_data = mouse; // TODO: maybe change to hid_dev->data rc = ddf_fun_bind(fun); @@ -458,5 +458,5 @@ /*----------------------------------------------------------------------------*/ -int usb_mouse_init(usb_hid_dev_t *hid_dev) +int usb_mouse_init(usb_hid_dev_t *hid_dev, void **data) { usb_log_debug("Initializing HID/Mouse structure...\n"); @@ -485,8 +485,9 @@ // save the Mouse device structure into the HID device structure - hid_dev->data = mouse_dev; + *data = mouse_dev; // set handler for incoming calls - hid_dev->ops.default_handler = default_connection_handler; + // TODO: must be one for each subdriver!! + mouse_dev->ops.default_handler = default_connection_handler; // TODO: how to know if the device supports the request??? @@ -494,5 +495,5 @@ // hid_dev->usb_dev->interface_no, IDLE_RATE); - int rc = usb_mouse_create_function(hid_dev); + int rc = usb_mouse_create_function(hid_dev, mouse_dev); if (rc != EOK) { usb_mouse_free(&mouse_dev); @@ -505,11 +506,11 @@ /*----------------------------------------------------------------------------*/ -bool usb_mouse_polling_callback(usb_hid_dev_t *hid_dev, uint8_t *buffer, - size_t buffer_size) +bool usb_mouse_polling_callback(usb_hid_dev_t *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) { usb_log_debug("usb_mouse_polling_callback()\n"); usb_debug_str_buffer(buffer, buffer_size, 0); - if (hid_dev == NULL) { + if (hid_dev == NULL || data == NULL) { usb_log_error("Missing argument to the mouse polling callback." "\n"); @@ -517,18 +518,17 @@ } - if (hid_dev->data == NULL) { - usb_log_error("Wrong argument to the mouse polling callback." - "\n"); - return false; - } - - return usb_mouse_process_report(hid_dev, buffer, buffer_size); -} - -/*----------------------------------------------------------------------------*/ - -void usb_mouse_deinit(usb_hid_dev_t *hid_dev) -{ - usb_mouse_free((usb_mouse_t **)&hid_dev->data); + usb_mouse_t *mouse_dev = (usb_mouse_t *)data; + + return usb_mouse_process_report(hid_dev, mouse_dev, buffer, + buffer_size); +} + +/*----------------------------------------------------------------------------*/ + +void usb_mouse_deinit(usb_hid_dev_t *hid_dev, void *data) +{ + if (data != NULL) { + usb_mouse_free((usb_mouse_t **)&data); + } } Index: uspace/drv/usbhid/mouse/mousedev.h =================================================================== --- uspace/drv/usbhid/mouse/mousedev.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/mouse/mousedev.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -52,4 +52,6 @@ int32_t *buttons; + + ddf_dev_ops_t ops; } usb_mouse_t; @@ -63,10 +65,10 @@ /*----------------------------------------------------------------------------*/ -int usb_mouse_init(struct usb_hid_dev *hid_dev); +int usb_mouse_init(struct usb_hid_dev *hid_dev, void **data); -bool usb_mouse_polling_callback(struct usb_hid_dev *hid_dev, uint8_t *buffer, - size_t buffer_size); +bool usb_mouse_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); -void usb_mouse_deinit(struct usb_hid_dev *hid_dev); +void usb_mouse_deinit(struct usb_hid_dev *hid_dev, void *data); int usb_mouse_set_boot_protocol(struct usb_hid_dev *hid_dev); Index: uspace/drv/usbhid/multimedia/keymap.c =================================================================== --- uspace/drv/usbhid/multimedia/keymap.c (revision b2995c36bde63fff456febd935929123ef169c49) +++ uspace/drv/usbhid/multimedia/keymap.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -0,0 +1,791 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * UUSB multimedia key to keycode mapping. + */ + +#include +#include +#include +#include +#include "keymap.h" + +/** + * Mapping between USB HID multimedia usages (from HID Usage Tables) and + * corresponding HelenOS key codes. + * + * Currently only Usages used by Logitech UltraX keyboard are present. All other + * should result in 0. + */ +static int usb_hid_keymap_consumer[0x29c] = { + [0xf] = KC_F1, /* Just for testing purposes */ + [0x5] = KC_F2, /* Just for testing purposes */ + [0x8] = KC_F3, /* Just for testing purposes */ + [0x6] = KC_F4, /* Just for testing purposes */ + [0x7] = KC_F5, /* Just for testing purposes */ + [0xc] = KC_F6, /* Just for testing purposes */ + + [0xb5] = 0, /* Scan Next Track */ + [0xb6] = 0, /* Scan Previous Track */ + [0xb7] = 0, /* Stop */ + [0xb8] = 0, /* Eject */ + [0xcd] = KC_F2, /* Play/Pause */ + [0xe2] = KC_F3, /* Mute */ + [0xe9] = KC_F5, /* Volume Increment */ + [0xea] = KC_F4, /* Volume Decrement */ + [0x183] = 0, /* AL Consumer Control Configuration */ + [0x18a] = 0, /* AL Email Reader */ + [0x192] = 0, /* AL Calculator */ + [0x221] = 0, /* AC Search */ + [0x223] = 0, /* AC Home */ + [0x224] = 0, /* AC Back */ + [0x225] = 0, /* AC Forward */ + [0x226] = 0, /* AC Stop */ + [0x227] = KC_F1, /* AC Refresh */ + [0x22a] = KC_F6 /* AC Bookmarks */ +}; + +static const char *usb_hid_consumer_usage_str[0x29d] = { + [0x01] = "Consumer Control", + [0x02] = "Numeric Key Pad", + [0x03] = "Programmable Buttons", + [0x04] = "Microphone", + [0x05] = "Headphone", + [0x06] = "Graphic Equalizer", + [0x07] = "Reserved", + [0x08] = "Reserved", + [0x09] = "Reserved", + [0x0a] = "Reserved", + [0x0b] = "Reserved", + [0x0c] = "Reserved", + [0x0d] = "Reserved", + [0x0e] = "Reserved", + [0x0f] = "Reserved", + [0x10] = "Reserved", + [0x11] = "Reserved", + [0x12] = "Reserved", + [0x13] = "Reserved", + [0x14] = "Reserved", + [0x15] = "Reserved", + [0x16] = "Reserved", + [0x17] = "Reserved", + [0x18] = "Reserved", + [0x19] = "Reserved", + [0x1a] = "Reserved", + [0x1b] = "Reserved", + [0x1c] = "Reserved", + [0x1d] = "Reserved", + [0x1e] = "Reserved", + [0x1f] = "Reserved", + [0x20] = "+10", + [0x21] = "+100", + [0x22] = "AM/PM", + [0x23] = "Reserved", + [0x24] = "Reserved", + [0x25] = "Reserved", + [0x26] = "Reserved", + [0x27] = "Reserved", + [0x28] = "Reserved", + [0x29] = "Reserved", + [0x2a] = "Reserved", + [0x2b] = "Reserved", + [0x2c] = "Reserved", + [0x2d] = "Reserved", + [0x2e] = "Reserved", + [0x2f] = "Reserved", + [0x30] = "Reserved", + [0x31] = "Reserved", + [0x32] = "Reserved", + [0x33] = "Reserved", + [0x34] = "Reserved", + [0x35] = "Reserved", + [0x36] = "Reserved", + [0x37] = "Reserved", + [0x38] = "Reserved", + [0x39] = "Reserved", + [0x3a] = "Reserved", + [0x3b] = "Reserved", + [0x3c] = "Reserved", + [0x3d] = "Reserved", + [0x3e] = "Reserved", + [0x3f] = "Reserved", + [0x40] = "Menu", + [0x41] = "Menu Pick", + [0x42] = "Menu Up", + [0x43] = "Menu Down", + [0x44] = "Menu Left", + [0x45] = "Menu Right", + [0x46] = "Menu Escape", + [0x47] = "Menu Value Increase", + [0x48] = "Menu Value Decrease", + [0x49] = "Reserved", + [0x4a] = "Reserved", + [0x4b] = "Reserved", + [0x4c] = "Reserved", + [0x4d] = "Reserved", + [0x4e] = "Reserved", + [0x4f] = "Reserved", + [0x50] = "Reserved", + [0x51] = "Reserved", + [0x52] = "Reserved", + [0x53] = "Reserved", + [0x54] = "Reserved", + [0x55] = "Reserved", + [0x56] = "Reserved", + [0x57] = "Reserved", + [0x58] = "Reserved", + [0x59] = "Reserved", + [0x5a] = "Reserved", + [0x5b] = "Reserved", + [0x5c] = "Reserved", + [0x5d] = "Reserved", + [0x5e] = "Reserved", + [0x5f] = "Reserved", + [0x60] = "Data On Screen", + [0x61] = "Closed Caption", + [0x62] = "Closed Caption Select", + [0x63] = "VCR/TV", + [0x64] = "Broadcast Mode", + [0x65] = "Snapshot", + [0x66] = "Still", + [0x67] = "Reserved", + [0x68] = "Reserved", + [0x69] = "Reserved", + [0x6a] = "Reserved", + [0x6b] = "Reserved", + [0x6c] = "Reserved", + [0x6d] = "Reserved", + [0x6e] = "Reserved", + [0x6f] = "Reserved", + [0x70] = "Reserved", + [0x71] = "Reserved", + [0x72] = "Reserved", + [0x73] = "Reserved", + [0x74] = "Reserved", + [0x75] = "Reserved", + [0x76] = "Reserved", + [0x77] = "Reserved", + [0x78] = "Reserved", + [0x79] = "Reserved", + [0x7a] = "Reserved", + [0x7b] = "Reserved", + [0x7c] = "Reserved", + [0x7d] = "Reserved", + [0x7e] = "Reserved", + [0x7f] = "Reserved", + [0x80] = "Selection", + [0x81] = "Assign Selection", + [0x82] = "Mode Step", + [0x83] = "Recall Last", + [0x84] = "Enter Channel", + [0x85] = "Order Movie", + [0x86] = "Channel", + [0x87] = "Media Selection", + [0x88] = "Media Select Computer", + [0x89] = "Media Select TV", + [0x8a] = "Media Select WWW", + [0x8b] = "Media Select DVD", + [0x8c] = "Media Select Telephone", + [0x8d] = "Media Select Program Guide", + [0x8e] = "Media Select Video Phone", + [0x8f] = "Media Select Games", + [0x90] = "Media Select Messages", + [0x91] = "Media Select CD", + [0x92] = "Media Select VCR", + [0x93] = "Media Select Tuner", + [0x94] = "Quit", + [0x95] = "Help", + [0x96] = "Media Select Tape", + [0x97] = "Media Select Cable", + [0x98] = "Media Select Satellite", + [0x99] = "Media Select Security", + [0x9a] = "Media Select Home", + [0x9b] = "Media Select Call", + [0x9c] = "Channel Increment", + [0x9d] = "Channel Decrement", + [0x9e] = "Media Select SAP", + [0x9f] = "Reserved", + [0xa0] = "VCR Plus", + [0xa1] = "Once", + [0xa2] = "Daily", + [0xa3] = "Weekly", + [0xa4] = "Monthly", + [0xa5] = "Reserved", + [0xa6] = "Reserved", + [0xa7] = "Reserved", + [0xa8] = "Reserved", + [0xa9] = "Reserved", + [0xaa] = "Reserved", + [0xab] = "Reserved", + [0xac] = "Reserved", + [0xad] = "Reserved", + [0xae] = "Reserved", + [0xaf] = "Reserved", + [0xb0] = "Play", + [0xb1] = "Pause", + [0xb2] = "Record", + [0xb3] = "Fast Forward", + [0xb4] = "Rewind", + [0xb5] = "Scan Next Track", + [0xb6] = "Scan Previous Trac", + [0xb7] = "Stop", + [0xb8] = "Eject", + [0xb9] = "Random Play", + [0xba] = "Select Disc", + [0xbb] = "Enter Disc", + [0xbc] = "Repeat", + [0xbd] = "Tracking", + [0xbe] = "Track Normal", + [0xbf] = "Slow Tracking", + [0xc0] = "Frame Forward", + [0xc1] = "Frame Back", + [0xc2] = "Mark", + [0xc3] = "Clear Mark", + [0xc4] = "Repeat From Mark", + [0xc5] = "Return to Mark", + [0xc6] = "Search Mark Forward", + [0xc7] = "Search Mark Backwards", + [0xc8] = "Counter Reset", + [0xc9] = "Show Counter", + [0xca] = "Tracking Increment", + [0xcb] = "Tracking Decrement", + [0xcc] = "Stop/Eject", + [0xcd] = "Play/Pause", + [0xce] = "Play/Skip", + [0xcf] = "Reserved", + [0xd0] = "Reserved", + [0xd1] = "Reserved", + [0xd2] = "Reserved", + [0xd3] = "Reserved", + [0xd4] = "Reserved", + [0xd5] = "Reserved", + [0xd6] = "Reserved", + [0xd7] = "Reserved", + [0xd8] = "Reserved", + [0xd9] = "Reserved", + [0xda] = "Reserved", + [0xdb] = "Reserved", + [0xdc] = "Reserved", + [0xdd] = "Reserved", + [0xde] = "Reserved", + [0xdf] = "Reserved", + [0xe0] = "Volume", + [0xe1] = "Balance", + [0xe2] = "Mute", + [0xe3] = "Bass", + [0xe4] = "Treble", + [0xe5] = "Bass Boost", + [0xe6] = "Surround Mode", + [0xe7] = "Loudness", + [0xe8] = "MPX", + [0xe9] = "Volume Increment", + [0xea] = "Volume Decrement", + [0xeb] = "Reserved", + [0xec] = "Reserved", + [0xed] = "Reserved", + [0xee] = "Reserved", + [0xef] = "Reserved", + [0xf0] = "Speed Select", + [0xf1] = "Playback Speed", + [0xf2] = "Standard Play", + [0xf3] = "Long Play", + [0xf4] = "Extended Play", + [0xf5] = "Slow", + [0xf6] = "Reserved", + [0xf7] = "Reserved", + [0xf8] = "Reserved", + [0xf9] = "Reserved", + [0xfa] = "Reserved", + [0xfb] = "Reserved", + [0xfc] = "Reserved", + [0xfd] = "Reserved", + [0xfe] = "Reserved", + [0xff] = "Reserved", + [0x100] = "Fan Enable", + [0x101] = "Fan Speed", + [0x102] = "Light Enable", + [0x103] = "Light Illumination Level", + [0x104] = "Climate Control Enable", + [0x105] = "Room Temperature", + [0x106] = "Security Enable", + [0x107] = "Fire Alarm", + [0x108] = "Police Alarm", + [0x109] = "Proximity", + [0x10a] = "Motion", + [0x10b] = "Duress Alarm", + [0x10c] = "Holdup Alarm", + [0x10d] = "Medical Alarm", + [0x10e] = "Reserved", + [0x10f] = "Reserved", + [0x110] = "Reserved", + [0x111] = "Reserved", + [0x112] = "Reserved", + [0x113] = "Reserved", + [0x114] = "Reserved", + [0x115] = "Reserved", + [0x116] = "Reserved", + [0x117] = "Reserved", + [0x118] = "Reserved", + [0x119] = "Reserved", + [0x11a] = "Reserved", + [0x11b] = "Reserved", + [0x11c] = "Reserved", + [0x11d] = "Reserved", + [0x11e] = "Reserved", + [0x11f] = "Reserved", + [0x120] = "Reserved", + [0x121] = "Reserved", + [0x122] = "Reserved", + [0x123] = "Reserved", + [0x124] = "Reserved", + [0x125] = "Reserved", + [0x126] = "Reserved", + [0x127] = "Reserved", + [0x128] = "Reserved", + [0x129] = "Reserved", + [0x12a] = "Reserved", + [0x12b] = "Reserved", + [0x12c] = "Reserved", + [0x12d] = "Reserved", + [0x12e] = "Reserved", + [0x12f] = "Reserved", + [0x130] = "Reserved", + [0x131] = "Reserved", + [0x132] = "Reserved", + [0x133] = "Reserved", + [0x134] = "Reserved", + [0x135] = "Reserved", + [0x136] = "Reserved", + [0x137] = "Reserved", + [0x138] = "Reserved", + [0x139] = "Reserved", + [0x13a] = "Reserved", + [0x13b] = "Reserved", + [0x13c] = "Reserved", + [0x13d] = "Reserved", + [0x13e] = "Reserved", + [0x13f] = "Reserved", + [0x140] = "Reserved", + [0x141] = "Reserved", + [0x142] = "Reserved", + [0x143] = "Reserved", + [0x144] = "Reserved", + [0x145] = "Reserved", + [0x146] = "Reserved", + [0x147] = "Reserved", + [0x148] = "Reserved", + [0x149] = "Reserved", + [0x14a] = "Reserved", + [0x14b] = "Reserved", + [0x14c] = "Reserved", + [0x14d] = "Reserved", + [0x14e] = "Reserved", + [0x14f] = "Reserved", + [0x150] = "Balance Right", + [0x151] = "Balance Left", + [0x152] = "Bass Increment", + [0x153] = "Bass Decrement", + [0x154] = "Treble Increment", + [0x155] = "Treble Decrement", + [0x156] = "Reserved", + [0x157] = "Reserved", + [0x158] = "Reserved", + [0x159] = "Reserved", + [0x15a] = "Reserved", + [0x15b] = "Reserved", + [0x15c] = "Reserved", + [0x15d] = "Reserved", + [0x15e] = "Reserved", + [0x15f] = "Reserved", + [0x160] = "Speaker System", + [0x161] = "Channel Left", + [0x162] = "Channel Right", + [0x163] = "Channel Center", + [0x164] = "Channel Front", + [0x165] = "Channel Center Front", + [0x166] = "Channel Side", + [0x167] = "Channel Surround", + [0x168] = "Channel Low Frequency Enhancement", + [0x169] = "Channel Top", + [0x16a] = "Channel Unknown", + [0x16b] = "Reserved", + [0x16c] = "Reserved", + [0x16d] = "Reserved", + [0x16e] = "Reserved", + [0x16f] = "Reserved", + [0x170] = "Sub-channel", + [0x171] = "Sub-channel Increment", + [0x172] = "Sub-channel Decrement", + [0x173] = "Alternate Audio Increment", + [0x174] = "Alternate Audio Decrement", + [0x175] = "Reserved", + [0x176] = "Reserved", + [0x177] = "Reserved", + [0x178] = "Reserved", + [0x179] = "Reserved", + [0x17a] = "Reserved", + [0x17b] = "Reserved", + [0x17c] = "Reserved", + [0x17d] = "Reserved", + [0x17e] = "Reserved", + [0x17f] = "Reserved", + [0x180] = "Application Launch Buttons", + [0x181] = "AL Launch Buttion Configuration Tool", + [0x182] = "AL Programmable Button Configuration", + [0x183] = "AL Consumer Control Configuration", + [0x184] = "AL Word Processor", + [0x185] = "AL Text Editor", + [0x186] = "AL Spreadsheet", + [0x187] = "AL Graphics Editor", + [0x188] = "AL Presentation App", + [0x189] = "AL Database App", + [0x18a] = "AL Email Reader", + [0x18b] = "AL Newsreader", + [0x18c] = "AL Voicemail", + [0x18d] = "AL Contacts/Address Book", + [0x18e] = "AL Calendar/Schedule", + [0x18f] = "AL Task/Project Manager", + [0x190] = "AL Log/Journal/Timecard", + [0x191] = "AL Checkbook/Finance", + [0x192] = "AL Calculator", + [0x193] = "AL A/V Capture/Playback", + [0x194] = "AL Local Machine Browser", + [0x195] = "AL LAN/WAN Browser", + [0x196] = "AL Internet Browser", + [0x197] = "AL Remote Networking/ISP Connect", + [0x198] = "AL Network Conference", + [0x199] = "AL Network Chat", + [0x19a] = "AL Telephony/Dialer", + [0x19b] = "AL Logon", + [0x19c] = "AL Logoff", + [0x19d] = "AL Logon/Logoff", + [0x19e] = "AL Terminal Lock/Screensaver", + [0x19f] = "AL Control Panel", + [0x1a0] = "AL Command Line Processor/Run", + [0x1a1] = "AL Process/Task Manager", + [0x1a2] = "AL Select Task/Application", + [0x1a3] = "AL Next Task/Application", + [0x1a4] = "AL Previous Task/Application", + [0x1a5] = "AL Preemptive Halt Task/Application", + [0x1a6] = "AL Integrated Help Center", + [0x1a7] = "AL Documents", + [0x1a8] = "AL Thesaurus", + [0x1a9] = "AL Dictionary", + [0x1aa] = "AL Desktop", + [0x1ab] = "AL Spell Check", + [0x1ac] = "AL Grammar Check", + [0x1ad] = "AL Wireless Status", + [0x1ae] = "AL Keyboard Layout", + [0x1af] = "AL Virus Protection", + [0x1b0] = "AL Encryption", + [0x1b1] = "AL Screen Saver", + [0x1b2] = "AL Alarms", + [0x1b3] = "AL Clock", + [0x1b4] = "AL File Browser", + [0x1b5] = "AL Power Status", + [0x1b6] = "AL Image Browser", + [0x1b7] = "AL Audio Browser", + [0x1b8] = "AL Movie Browser", + [0x1b9] = "AL Digital Rights Manager", + [0x1ba] = "AL Digital Wallet", + [0x1bb] = "Reserved", + [0x1bc] = "AL Instant Messaging", + [0x1bd] = "AL OEM Features Tips/Tutorial Browser", + [0x1be] = "AL OEM Help", + [0x1bf] = "AL Online Community", + [0x1c0] = "AL Entertainment Content Browser", + [0x1c1] = "AL Online Shopping Browser", + [0x1c2] = "AL SmartCard Information/Help", + [0x1c3] = "AL Market Monitor/Finance Browser", + [0x1c4] = "AL Customized Corporate News Browser", + [0x1c5] = "AL Online Activity Browser", + [0x1c6] = "AL Research/Search Browser", + [0x1c7] = "AL Audio Player", + [0x1c8] = "Reserved", + [0x1c9] = "Reserved", + [0x1ca] = "Reserved", + [0x1cb] = "Reserved", + [0x1cc] = "Reserved", + [0x1cd] = "Reserved", + [0x1ce] = "Reserved", + [0x1cf] = "Reserved", + [0x1d0] = "Reserved", + [0x1d1] = "Reserved", + [0x1d2] = "Reserved", + [0x1d3] = "Reserved", + [0x1d4] = "Reserved", + [0x1d5] = "Reserved", + [0x1d6] = "Reserved", + [0x1d7] = "Reserved", + [0x1d8] = "Reserved", + [0x1d9] = "Reserved", + [0x1da] = "Reserved", + [0x1db] = "Reserved", + [0x1dc] = "Reserved", + [0x1dd] = "Reserved", + [0x1de] = "Reserved", + [0x1df] = "Reserved", + [0x1e0] = "Reserved", + [0x1e1] = "Reserved", + [0x1e2] = "Reserved", + [0x1e3] = "Reserved", + [0x1e4] = "Reserved", + [0x1e5] = "Reserved", + [0x1e6] = "Reserved", + [0x1e7] = "Reserved", + [0x1e8] = "Reserved", + [0x1e9] = "Reserved", + [0x1ea] = "Reserved", + [0x1eb] = "Reserved", + [0x1ec] = "Reserved", + [0x1ed] = "Reserved", + [0x1ee] = "Reserved", + [0x1ef] = "Reserved", + [0x1f0] = "Reserved", + [0x1f1] = "Reserved", + [0x1f2] = "Reserved", + [0x1f3] = "Reserved", + [0x1f4] = "Reserved", + [0x1f5] = "Reserved", + [0x1f6] = "Reserved", + [0x1f7] = "Reserved", + [0x1f8] = "Reserved", + [0x1f9] = "Reserved", + [0x1fa] = "Reserved", + [0x1fb] = "Reserved", + [0x1fc] = "Reserved", + [0x1fd] = "Reserved", + [0x1fe] = "Reserved", + [0x1ff] = "Reserved", + [0x200] = "Generic GUI Application Controls", + [0x201] = "AC New", + [0x202] = "AC Open", + [0x203] = "AC Close", + [0x204] = "AC Exit", + [0x205] = "AC Maximize", + [0x206] = "AC Minimize", + [0x207] = "AC Save", + [0x208] = "AC Print", + [0x209] = "AC Properties", + [0x20a] = "", + [0x20b] = "", + [0x20c] = "", + [0x20d] = "", + [0x20e] = "", + [0x20f] = "", + [0x210] = "", + [0x211] = "", + [0x212] = "", + [0x213] = "", + [0x214] = "", + [0x215] = "", + [0x216] = "", + [0x217] = "", + [0x218] = "", + [0x219] = "", + [0x21a] = "AC Undo", + [0x21b] = "AC Copy", + [0x21c] = "AC Cut", + [0x21d] = "AC Paste", + [0x21e] = "AC Select All", + [0x21f] = "AC Find", + [0x220] = "AC Find and Replace", + [0x221] = "AC Search", + [0x222] = "AC Go To", + [0x223] = "AC Home", + [0x224] = "AC Back", + [0x225] = "AC Forward", + [0x226] = "AC Stop", + [0x227] = "AC Refresh", + [0x228] = "AC Previous Link", + [0x229] = "AC Next Link", + [0x22a] = "AC Bookmarks", + [0x22b] = "AC History", + [0x22c] = "AC Subscriptions", + [0x22d] = "AC Zoom In", + [0x22e] = "AC Zoom Out", + [0x22f] = "AC Zoom", + [0x230] = "AC Full Screen View", + [0x231] = "AC Normal View", + [0x232] = "AC View Toggle", + [0x233] = "AC Scroll Up", + [0x234] = "AC Scroll Down", + [0x235] = "AC Scroll", + [0x236] = "AC Pan Left", + [0x237] = "AC Pan Right", + [0x238] = "AC Pan", + [0x239] = "AC New Window", + [0x23a] = "AC Tile Horizontally", + [0x23b] = "AC Tile Vertically", + [0x23c] = "AC Format", + [0x23d] = "AC Edit", + [0x23e] = "AC Bold", + [0x23f] = "AC Italics", + [0x240] = "AC Undeline", + [0x241] = "AC Strikethrough", + [0x242] = "AC Subscript", + [0x243] = "AC Superscript", + [0x244] = "AC All Caps", + [0x245] = "AC Rotate", + [0x246] = "AC Resize", + [0x247] = "AC Flip Horizontal", + [0x248] = "AC Flip Vertical", + [0x249] = "AC Mirror Horizontal", + [0x24a] = "AC Mirror Vertical", + [0x24b] = "AC Font Select", + [0x24c] = "AC Font Color", + [0x24d] = "AC Font Size", + [0x24e] = "AC Justify Left", + [0x24f] = "AC Justify Center H", + [0x250] = "AC Justify Right", + [0x251] = "AC Justify Block H", + [0x252] = "AC Justify Top", + [0x253] = "AC Justify Center V", + [0x254] = "AC Justify Bottom", + [0x255] = "AC Justify Block V", + [0x256] = "AC Indent Decrease", + [0x257] = "AC Indent Increase", + [0x258] = "AC Numbered List", + [0x259] = "AC Restart Numbering", + [0x25a] = "AC Bulleted List", + [0x25b] = "AC Promote", + [0x25c] = "AC Demote", + [0x25d] = "AC Yes", + [0x25e] = "AC No", + [0x25f] = "AC Cancel", + [0x260] = "AC Catalog", + [0x261] = "AC Buy/Checkout", + [0x262] = "AC Add to Cart", + [0x263] = "AC Expand", + [0x264] = "AC Expand All", + [0x265] = "AC Collapse", + [0x266] = "AC Collapse All", + [0x267] = "AC Print Preview", + [0x268] = "AC Paste Special", + [0x269] = "AC Insert Mode", + [0x26a] = "AC Delete", + [0x26b] = "AC Lock", + [0x26c] = "AC Unlock", + [0x26d] = "AC Protect", + [0x26e] = "AC Unprotect", + [0x26f] = "AC Attach Comment", + [0x270] = "AC Delete Comment", + [0x271] = "AC View Comment", + [0x272] = "AC Select Word", + [0x273] = "AC Select Sentence", + [0x274] = "AC Select Paragraph", + [0x275] = "AC Select Column", + [0x276] = "AC Select Row", + [0x277] = "AC Select Table", + [0x278] = "AC Select Object", + [0x279] = "AC Redo/Repeat", + [0x27a] = "AC Sort", + [0x27b] = "AC Sort Ascending", + [0x27c] = "AC Sort Descending", + [0x27d] = "AC Filter", + [0x27e] = "AC Set Clock", + [0x27f] = "AC View Clock", + [0x280] = "AC Select Time Zone", + [0x281] = "AC Edit Time Zones", + [0x282] = "AC Set Alarm", + [0x283] = "AC Clear Alarm", + [0x284] = "AC Snooze Alarm", + [0x285] = "AC Reset Alarm", + [0x286] = "AC Synchronize", + [0x287] = "AC Send/Receive", + [0x288] = "AC Send To", + [0x289] = "AC Reply", + [0x28a] = "AC Reply All", + [0x28b] = "AC Forward Msg", + [0x28c] = "AC Send", + [0x28d] = "AC Attach File", + [0x28e] = "AC Upload", + [0x28f] = "AC Download (Save Target As)", + [0x290] = "AC Set Borders", + [0x291] = "AC Insert Row", + [0x292] = "AC Insert Column", + [0x293] = "AC Insert File", + [0x294] = "AC Insert Picture", + [0x295] = "AC Insert Object", + [0x296] = "AC Insert Symbol", + [0x297] = "AC Save and Close", + [0x298] = "AC Rename", + [0x299] = "AC Merge", + [0x29a] = "AC Split", + [0x29b] = "AC Distrubute Horizontally", + [0x29c] = "AC Distrubute Vertically" +}; + +/** + * Translates USB HID Usages from the Consumer Page into HelenOS keycodes. + * + * @param usage USB HID Consumer Page Usage number. + * + * @retval HelenOS key code corresponding to the given USB Consumer Page Usage. + */ +unsigned int usb_multimedia_map_usage(int usage) +{ + unsigned int key; + int *map = usb_hid_keymap_consumer; + size_t map_length = sizeof(usb_hid_keymap_consumer) / sizeof(int); + + if ((usage < 0) || ((size_t)usage >= map_length)) + return -1; + + /*! @todo What if the usage is not in the table? */ + key = map[usage]; + + return key; +} + +/** + * Translates USB HID Usages from the Consumer Page into their string + * representation. + * + * @param usage USB HID Consumer Page Usage number. + * + * @retval HelenOS key code corresponding to the given USB Consumer Page Usage. + */ +const char *usb_multimedia_usage_to_str(int usage) +{ + size_t map_length = sizeof(usb_hid_consumer_usage_str) / sizeof(char *); + + if ((usage < 0) || ((size_t)usage >= map_length)) + return "Unknown usage"; + + /*! @todo What if the usage is not in the table? */ + return usb_hid_consumer_usage_str[usage]; +} + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/keymap.h =================================================================== --- uspace/drv/usbhid/multimedia/keymap.h (revision b2995c36bde63fff456febd935929123ef169c49) +++ uspace/drv/usbhid/multimedia/keymap.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -0,0 +1,47 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB multimedia key to keycode mapping. + */ + +#ifndef USB_HID_MULTIMEDIA_KEYMAP_H_ +#define USB_HID_MULTIMEDIA_KEYMAP_H_ + +unsigned int usb_multimedia_map_usage(int usage); + +const char *usb_multimedia_usage_to_str(int usage); + +#endif /* USB_HID_MULTIMEDIA_KEYMAP_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/multimedia.c =================================================================== --- uspace/drv/usbhid/multimedia/multimedia.c (revision b2995c36bde63fff456febd935929123ef169c49) +++ uspace/drv/usbhid/multimedia/multimedia.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -0,0 +1,378 @@ +/* + * Copyright (c) 2011 Lubos Slovak, Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * USB Keyboard multimedia keys subdriver. + */ + + +#include "multimedia.h" +#include "../usbhid.h" +#include "keymap.h" + +#include +#include +#include + +#include +#include + +#include +#include + +#define NAME "multimedia-keys" + +/*----------------------------------------------------------------------------*/ +/** + * Logitech UltraX device type. + */ +typedef struct usb_multimedia_t { + /** Previously pressed keys (not translated to key codes). */ + int32_t *keys_old; + /** Currently pressed keys (not translated to key codes). */ + int32_t *keys; + /** Count of stored keys (i.e. number of keys in the report). */ + size_t key_count; + /** IPC phone to the console device (for sending key events). */ + int console_phone; +} usb_multimedia_t; + + +/*----------------------------------------------------------------------------*/ +/** + * Default handler for IPC methods not handled by DDF. + * + * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it + * assumes the caller is the console and thus it stores IPC phone to it for + * later use by the driver to notify about key events. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +static void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + usb_log_debug(NAME " default_connection_handler()\n"); + + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)fun->driver_data; + //usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + if (multim_dev == NULL) { + async_answer_0(icallid, EINVAL); + return; + } + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (multim_dev->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + multim_dev->console_phone = callback; + usb_log_debug(NAME " Saved phone to console: %d\n", callback); + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/*----------------------------------------------------------------------------*/ + +static ddf_dev_ops_t multimedia_ops = { + .default_handler = default_connection_handler +}; + +/*----------------------------------------------------------------------------*/ +/** + * Processes key events. + * + * @note This function was copied from AT keyboard driver and modified to suit + * USB keyboard. + * + * @note Lock keys are not sent to the console, as they are completely handled + * in the driver. It may, however, be required later that the driver + * sends also these keys to application (otherwise it cannot use those + * keys at all). + * + * @param hid_dev + * @param lgtch_dev + * @param type Type of the event (press / release). Recognized values: + * KEY_PRESS, KEY_RELEASE + * @param key Key code of the key according to HID Usage Tables. + */ +static void usb_multimedia_push_ev(usb_hid_dev_t *hid_dev, + usb_multimedia_t *multim_dev, int type, unsigned int key) +{ + assert(hid_dev != NULL); + assert(multim_dev != NULL); + +// usb_multimedia_t *multim_dev = (usb_multimedia_t *)hid_dev->data; + + console_event_t ev; + + ev.type = type; + ev.key = key; + ev.mods = 0; + ev.c = 0; + + usb_log_debug2(NAME " Sending key %d to the console\n", ev.key); + if (multim_dev->console_phone < 0) { + usb_log_warning( + "Connection to console not ready, key discarded.\n"); + return; + } + + async_msg_4(multim_dev->console_phone, KBD_EVENT, ev.type, ev.key, + ev.mods, ev.c); +} + +/*----------------------------------------------------------------------------*/ + +static void usb_multimedia_free(usb_multimedia_t **multim_dev) +{ + if (multim_dev == NULL || *multim_dev == NULL) { + return; + } + + // hangup phone to the console + async_hangup((*multim_dev)->console_phone); + + // free all buffers + if ((*multim_dev)->keys != NULL) { + free((*multim_dev)->keys); + } + if ((*multim_dev)->keys_old != NULL) { + free((*multim_dev)->keys_old); + } + + free(*multim_dev); + *multim_dev = NULL; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_multimedia_create_function(usb_hid_dev_t *hid_dev, + usb_multimedia_t *multim_dev) +{ + /* Create the function exposed under /dev/devices. */ + ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + fun->ops = &multimedia_ops; + fun->driver_data = multim_dev; // TODO: maybe change to hid_dev->data + + int rc = ddf_fun_bind(fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(fun); + return rc; + } + + rc = ddf_fun_add_to_class(fun, "keyboard"); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class 'keyboard': %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(fun); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +int usb_multimedia_init(struct usb_hid_dev *hid_dev, void **data) +{ + if (hid_dev == NULL || hid_dev->usb_dev == NULL) { + return EINVAL; /*! @todo Other return code? */ + } + + usb_log_debug(NAME " Initializing HID/multimedia structure...\n"); + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)malloc( + sizeof(usb_multimedia_t)); + if (multim_dev == NULL) { + return ENOMEM; + } + + multim_dev->console_phone = -1; + + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_CONSUMER, 0); + + usb_hid_report_path_set_report_id(path, 1); + + multim_dev->key_count = usb_hid_report_size( + hid_dev->report, 0, USB_HID_REPORT_TYPE_INPUT); + + usb_hid_report_path_free(path); + + usb_log_debug(NAME " Size of the input report: %zu\n", + multim_dev->key_count); + + multim_dev->keys = (int32_t *)calloc(multim_dev->key_count, + sizeof(int32_t)); + + if (multim_dev->keys == NULL) { + usb_log_fatal("No memory!\n"); + free(multim_dev); + return ENOMEM; + } + + multim_dev->keys_old = + (int32_t *)calloc(multim_dev->key_count, sizeof(int32_t)); + + if (multim_dev->keys_old == NULL) { + usb_log_fatal("No memory!\n"); + free(multim_dev->keys); + free(multim_dev); + return ENOMEM; + } + + /*! @todo Autorepeat */ + + // save the KBD device structure into the HID device structure + *data = multim_dev; + + usb_log_debug(NAME " HID/multimedia device structure initialized.\n"); + + int rc = usb_multimedia_create_function(hid_dev, multim_dev); + if (rc != EOK) { + usb_multimedia_free(&multim_dev); + return rc; + } + + usb_log_debug(NAME " HID/multimedia structure initialized.\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +void usb_multimedia_deinit(struct usb_hid_dev *hid_dev, void *data) +{ + if (hid_dev == NULL) { + return; + } + + if (data != NULL) { + usb_multimedia_t *multim_dev = (usb_multimedia_t *)data; + usb_multimedia_free(&multim_dev); + } +} + +/*----------------------------------------------------------------------------*/ + +bool usb_multimedia_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + // TODO: checks + + usb_log_debug(NAME " usb_lgtch_polling_callback(%p, %p, %zu)\n", + hid_dev, buffer, buffer_size); + + if (data == NULL) { + return EINVAL; // TODO: other error code? + } + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)data; + + usb_log_debug(NAME " Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, buffer_size, 0)); + + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_CONSUMER, 0); + + uint8_t report_id; + + int rc = usb_hid_parse_report(hid_dev->report, buffer, buffer_size, + &report_id); + + if (rc != EOK) { + usb_log_warning(NAME "Error in usb_hid_parse_report(): %s\n", + str_error(rc)); + return true; + } + + usb_hid_report_path_set_report_id(path, report_id); + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + +// unsigned int key; + + /*! @todo Is this iterating OK if done multiple times? + * @todo The parsing is not OK + */ + while (field != NULL) { + if(field->value != 0) { + usb_log_debug(NAME " KEY VALUE(%X) USAGE(%X)\n", + field->value, field->usage); + unsigned int key = + usb_multimedia_map_usage(field->usage); + const char *key_str = + usb_multimedia_usage_to_str(field->usage); + usb_log_info("Pressed key: %s\n", key_str); + usb_multimedia_push_ev(hid_dev, multim_dev, KEY_PRESS, + key); + } + + field = usb_hid_report_get_sibling( + hid_dev->report, field, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + } + + usb_hid_report_path_free(path); + + return true; +} + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/multimedia.h =================================================================== --- uspace/drv/usbhid/multimedia/multimedia.h (revision b2995c36bde63fff456febd935929123ef169c49) +++ uspace/drv/usbhid/multimedia/multimedia.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB Keyboard multimedia keys subdriver. + */ + +#ifndef USB_HID_MULTIMEDIA_H_ +#define USB_HID_MULTIMEDIA_H_ + +#include + +struct usb_hid_dev; + +/*----------------------------------------------------------------------------*/ + +int usb_multimedia_init(struct usb_hid_dev *hid_dev, void **data); + +void usb_multimedia_deinit(struct usb_hid_dev *hid_dev, void *data); + +bool usb_multimedia_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); + +/*----------------------------------------------------------------------------*/ + +#endif // USB_HID_MULTIMEDIA_H_ + +/** + * @} + */ Index: uspace/drv/usbhid/subdrivers.c =================================================================== --- uspace/drv/usbhid/subdrivers.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/subdrivers.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -38,19 +38,21 @@ #include -#include "lgtch-ultrax/lgtch-ultrax.h" +//#include "lgtch-ultrax/lgtch-ultrax.h" +#include "multimedia/multimedia.h" #include "mouse/mousedev.h" static usb_hid_subdriver_usage_t path_kbd[] = { - {USB_HIDUT_PAGE_KEYBOARD, 0}, + {USB_HIDUT_PAGE_GENERIC_DESKTOP, + USB_HIDUT_USAGE_GENERIC_DESKTOP_KEYBOARD}, {0, 0} }; -static usb_hid_subdriver_usage_t path_mouse2[] = { - {USB_HIDUT_PAGE_GENERIC_DESKTOP, USB_HIDUT_USAGE_GENERIC_DESKTOP_X}, +static usb_hid_subdriver_usage_t path_mouse[] = { + {USB_HIDUT_PAGE_GENERIC_DESKTOP, USB_HIDUT_USAGE_GENERIC_DESKTOP_MOUSE}, {0, 0} }; -static usb_hid_subdriver_usage_t lgtch_path[] = { - {0xc, 0}, +static usb_hid_subdriver_usage_t multim_key_path[] = { + {USB_HIDUT_PAGE_CONSUMER, USB_HIDUT_USAGE_CONSUMER_CONSUMER_CONTROL}, {0, 0} }; @@ -60,6 +62,5 @@ path_kbd, -1, - USB_HID_PATH_COMPARE_END - | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_PATH_COMPARE_BEGIN, -1, -1, @@ -73,22 +74,20 @@ }, { - lgtch_path, + multim_key_path, 1, - USB_HID_PATH_COMPARE_END - | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, - 0x046d, - 0xc30e, + USB_HID_PATH_COMPARE_BEGIN, + -1, + -1, { - .init = usb_lgtch_init, - .deinit = usb_lgtch_deinit, - .poll = usb_lgtch_polling_callback, + .init = usb_multimedia_init, + .deinit = usb_multimedia_deinit, + .poll = usb_multimedia_polling_callback, .poll_end = NULL } }, { - path_mouse2, + path_mouse, -1, - USB_HID_PATH_COMPARE_END - | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_PATH_COMPARE_BEGIN, -1, -1, @@ -100,5 +99,5 @@ } }, - {NULL, -1, 0, -1, -1, {NULL, NULL, NULL, NULL}} + {NULL, -1, 0, -1, -1, {NULL, NULL, NULL, NULL, NULL}} }; Index: uspace/drv/usbhid/usbhid.c =================================================================== --- uspace/drv/usbhid/usbhid.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/usbhid.c (revision b2995c36bde63fff456febd935929123ef169c49) @@ -203,8 +203,17 @@ usb_log_debug("Compare flags: %d\n", mapping->compare); - size_t size = usb_hid_report_input_length(hid_dev->report, usage_path, - mapping->compare); +// size_t size = usb_hid_report_size(hid_dev->report, 0, +// USB_HID_REPORT_TYPE_INPUT); + size_t size = 0; + usb_hid_report_field_t *field = usb_hid_report_get_sibling (hid_dev->report, + NULL, usage_path, mapping->compare, USB_HID_REPORT_TYPE_INPUT); + while(field != NULL) { + size++; + field = usb_hid_report_get_sibling (hid_dev->report, + field, usage_path, mapping->compare, + USB_HID_REPORT_TYPE_INPUT); + } + usb_log_debug("Size of the input report: %zuB\n", size); - usb_hid_report_path_free(usage_path); @@ -457,5 +466,6 @@ if (hid_dev->subdrivers[i].init != NULL) { usb_log_debug("Initializing subdriver %d.\n",i); - rc = hid_dev->subdrivers[i].init(hid_dev); + rc = hid_dev->subdrivers[i].init(hid_dev, + &hid_dev->subdrivers[i].data); if (rc != EOK) { usb_log_warning("Failed to initialize" @@ -522,6 +532,6 @@ for (i = 0; i < hid_dev->subdriver_count; ++i) { if (hid_dev->subdrivers[i].poll != NULL - && hid_dev->subdrivers[i].poll(hid_dev, buffer, - buffer_size)) { + && hid_dev->subdrivers[i].poll(hid_dev, + hid_dev->subdrivers[i].data, buffer, buffer_size)) { cont = true; } @@ -546,5 +556,6 @@ for (i = 0; i < hid_dev->subdriver_count; ++i) { if (hid_dev->subdrivers[i].poll_end != NULL) { - hid_dev->subdrivers[i].poll_end(hid_dev, reason); + hid_dev->subdrivers[i].poll_end(hid_dev, + hid_dev->subdrivers[i].data, reason); } } @@ -627,5 +638,6 @@ for (i = 0; i < (*hid_dev)->subdriver_count; ++i) { if ((*hid_dev)->subdrivers[i].deinit != NULL) { - (*hid_dev)->subdrivers[i].deinit(*hid_dev); + (*hid_dev)->subdrivers[i].deinit(*hid_dev, + (*hid_dev)->subdrivers[i].data); } } Index: uspace/drv/usbhid/usbhid.h =================================================================== --- uspace/drv/usbhid/usbhid.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ uspace/drv/usbhid/usbhid.h (revision b2995c36bde63fff456febd935929123ef169c49) @@ -48,8 +48,10 @@ struct usb_hid_dev; -typedef int (*usb_hid_driver_init_t)(struct usb_hid_dev *); -typedef void (*usb_hid_driver_deinit_t)(struct usb_hid_dev *); -typedef bool (*usb_hid_driver_poll)(struct usb_hid_dev *, uint8_t *, size_t); -typedef int (*usb_hid_driver_poll_ended)(struct usb_hid_dev *, bool reason); +typedef int (*usb_hid_driver_init_t)(struct usb_hid_dev *, void **data); +typedef void (*usb_hid_driver_deinit_t)(struct usb_hid_dev *, void *data); +typedef bool (*usb_hid_driver_poll)(struct usb_hid_dev *, void *data, uint8_t *, + size_t); +typedef int (*usb_hid_driver_poll_ended)(struct usb_hid_dev *, void *data, + bool reason); // TODO: add function and class name?? @@ -63,4 +65,6 @@ /** Function to be called when polling ends. */ usb_hid_driver_poll_ended poll_end; + /** Arbitrary data needed by the subdriver. */ + void *data; } usb_hid_subdriver_t; @@ -72,7 +76,4 @@ /** Structure holding generic USB device information. */ usb_device_t *usb_dev; - - /** @todo What is this actually? */ - ddf_dev_ops_t ops; /** Index of the polling pipe in usb_hid_endpoints array. */ @@ -97,7 +98,4 @@ size_t input_report_size; - - /** Arbitrary data (e.g. a special structure for handling keyboard). */ - void *data; } usb_hid_dev_t; Index: uspace/drv/usbkbd/Makefile =================================================================== --- uspace/drv/usbkbd/Makefile (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,64 +1,0 @@ -# -# Copyright (c) 2010-2011 Vojtech Horky -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# - Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# - Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in the -# documentation and/or other materials provided with the distribution. -# - The name of the author may not be used to endorse or promote products -# derived from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR -# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES -# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. -# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, -# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT -# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF -# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# - -USPACE_PREFIX = ../.. - -LIBS = \ - $(LIBUSBHID_PREFIX)/libusbhid.a \ - $(LIBUSBDEV_PREFIX)/libusbdev.a \ - $(LIBUSB_PREFIX)/libusb.a \ - $(LIBDRV_PREFIX)/libdrv.a -EXTRA_CFLAGS += \ - -I. \ - -I$(LIBUSB_PREFIX)/include \ - -I$(LIBUSBDEV_PREFIX)/include \ - -I$(LIBUSBHID_PREFIX)/include \ - -I$(LIBDRV_PREFIX)/include - -BINARY = usbkbd - -STOLEN_LAYOUT_SOURCES = \ - layout/us_qwerty.c \ - layout/us_dvorak.c \ - layout/cz.c - -SOURCES = \ - main.c \ - conv.c \ - kbddev.c \ - kbdrepeat.c \ - $(STOLEN_LAYOUT_SOURCES) - -EXTRA_CLEAN = $(STOLEN_LAYOUT_SOURCES) - -SRV_KBD = $(USPACE_PREFIX)/srv/hid/kbd - -include $(USPACE_PREFIX)/Makefile.common - -layout/%.c: $(SRV_KBD)/layout/%.c - ln -sfn ../$< $@ Index: uspace/drv/usbkbd/conv.c =================================================================== --- uspace/drv/usbkbd/conv.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,193 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB scancode parser. - */ - -#include -#include -#include -#include -#include "conv.h" - -/** - * Mapping between USB HID key codes (from HID Usage Tables) and corresponding - * HelenOS key codes. - */ -static int scanmap_simple[255] = { - -// [0x29] = KC_BACKTICK, - -// [0x02] = KC_1, -// [0x03] = KC_2, - [0x04] = KC_A, - [0x05] = KC_B, - [0x06] = KC_C, - [0x07] = KC_D, - [0x08] = KC_E, - [0x09] = KC_F, - [0x0a] = KC_G, - [0x0b] = KC_H, - [0x0c] = KC_I, - [0x0d] = KC_J, - [0x0e] = KC_K, - [0x0f] = KC_L, - [0x10] = KC_M, - [0x11] = KC_N, - [0x12] = KC_O, - [0x13] = KC_P, - [0x14] = KC_Q, - [0x15] = KC_R, - [0x16] = KC_S, - [0x17] = KC_T, - [0x18] = KC_U, - [0x19] = KC_V, - [0x1a] = KC_W, - [0x1b] = KC_X, - [0x1c] = KC_Y, - [0x1d] = KC_Z, - - [0x1e] = KC_1, - [0x1f] = KC_2, - [0x20] = KC_3, - [0x21] = KC_4, - [0x22] = KC_5, - [0x23] = KC_6, - [0x24] = KC_7, - [0x25] = KC_8, - [0x26] = KC_9, - [0x27] = KC_0, - - [0x28] = KC_ENTER, - [0x29] = KC_ESCAPE, - [0x2a] = KC_BACKSPACE, - [0x2b] = KC_TAB, - [0x2c] = KC_SPACE, - - [0x2d] = KC_MINUS, // same as DASH? (- or _) - [0x2e] = KC_EQUALS, - [0x2f] = KC_LBRACKET, - [0x30] = KC_RBRACKET, - [0x31] = KC_BACKSLASH, - //[0x32] = KC_, // TODO: HASH??? maybe some as 0x31 - backslash - [0x33] = KC_SEMICOLON, - [0x34] = KC_QUOTE, // same as APOSTROPHE? (') - [0x35] = KC_BACKTICK, // same as GRAVE ACCENT?? (`) - [0x36] = KC_COMMA, - [0x37] = KC_PERIOD, - [0x38] = KC_SLASH, - - [0x39] = KC_CAPS_LOCK, - - [0x3a] = KC_F1, - [0x3b] = KC_F2, - [0x3c] = KC_F3, - [0x3d] = KC_F4, - [0x3e] = KC_F5, - [0x3f] = KC_F6, - [0x40] = KC_F7, - [0x41] = KC_F8, - [0x42] = KC_F9, - [0x43] = KC_F10, - [0x44] = KC_F11, - [0x45] = KC_F12, - - [0x46] = KC_PRTSCR, - [0x47] = KC_SCROLL_LOCK, - [0x48] = KC_PAUSE, - [0x49] = KC_INSERT, - [0x4a] = KC_HOME, - [0x4b] = KC_PAGE_UP, - [0x4c] = KC_DELETE, - [0x4d] = KC_END, - [0x4e] = KC_PAGE_DOWN, - [0x4f] = KC_RIGHT, - [0x50] = KC_LEFT, - [0x51] = KC_DOWN, - [0x52] = KC_UP, - - //[0x64] = // some funny key - - [0xe0] = KC_LCTRL, - [0xe1] = KC_LSHIFT, - [0xe2] = KC_LALT, - //[0xe3] = KC_L // TODO: left GUI - [0xe4] = KC_RCTRL, - [0xe5] = KC_RSHIFT, - [0xe6] = KC_RALT, - //[0xe7] = KC_R // TODO: right GUI - - [0x53] = KC_NUM_LOCK, - [0x54] = KC_NSLASH, - [0x55] = KC_NTIMES, - [0x56] = KC_NMINUS, - [0x57] = KC_NPLUS, - [0x58] = KC_NENTER, - [0x59] = KC_N1, - [0x5a] = KC_N2, - [0x5b] = KC_N3, - [0x5c] = KC_N4, - [0x5d] = KC_N5, - [0x5e] = KC_N6, - [0x5f] = KC_N7, - [0x60] = KC_N8, - [0x61] = KC_N9, - [0x62] = KC_N0, - [0x63] = KC_NPERIOD - -}; - -/** - * Translate USB HID key codes (from HID Usage Tables) to generic key codes - * recognized by HelenOS. - * - * @param scancode USB HID key code (from HID Usage Tables). - * - * @retval HelenOS key code corresponding to the given USB HID key code. - */ -unsigned int usbhid_parse_scancode(int scancode) -{ - unsigned int key; - int *map = scanmap_simple; - size_t map_length = sizeof(scanmap_simple) / sizeof(int); - - if ((scancode < 0) || ((size_t) scancode >= map_length)) - return -1; - - key = map[scancode]; - - return key; -} - -/** - * @} - */ Index: uspace/drv/usbkbd/conv.h =================================================================== --- uspace/drv/usbkbd/conv.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,45 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB scancode parser. - */ - -#ifndef USB_KBD_CONV_H_ -#define USB_KBD_CONV_H_ - -unsigned int usbhid_parse_scancode(int scancode); - -#endif /* USB_KBD_CONV_H_ */ - -/** - * @} - */ Index: uspace/drv/usbkbd/kbd.h =================================================================== --- uspace/drv/usbkbd/kbd.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,5 +1,0 @@ -/* - * Dummy file because of shared layout sources. - * - * Do not delete. - */ Index: uspace/drv/usbkbd/kbddev.c =================================================================== --- uspace/drv/usbkbd/kbddev.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,951 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** - * @file - * USB HID keyboard device structure and API. - */ - -#include -#include -#include - -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include - -#include "kbddev.h" - -#include "layout.h" -#include "conv.h" -#include "kbdrepeat.h" - -/*----------------------------------------------------------------------------*/ -/** Default modifiers when the keyboard is initialized. */ -static const unsigned DEFAULT_ACTIVE_MODS = KM_NUM_LOCK; - -///** Boot protocol report size (key part). */ -//static const size_t BOOTP_REPORT_SIZE = 6; - -///** Boot protocol total report size. */ -//static const size_t BOOTP_BUFFER_SIZE = 8; - -///** Boot protocol output report size. */ -//static const size_t BOOTP_BUFFER_OUT_SIZE = 1; - -///** Boot protocol error key code. */ -//static const uint8_t BOOTP_ERROR_ROLLOVER = 1; -static const uint8_t ERROR_ROLLOVER = 1; - -/** Default idle rate for keyboards. */ -static const uint8_t IDLE_RATE = 0; - -/** Delay before a pressed key starts auto-repeating. */ -static const unsigned int DEFAULT_DELAY_BEFORE_FIRST_REPEAT = 500 * 1000; - -/** Delay between two repeats of a pressed key when auto-repeating. */ -static const unsigned int DEFAULT_REPEAT_DELAY = 50 * 1000; - -/*----------------------------------------------------------------------------*/ - -/** Keyboard polling endpoint description for boot protocol class. */ -static usb_endpoint_description_t boot_poll_endpoint_description = { - .transfer_type = USB_TRANSFER_INTERRUPT, - .direction = USB_DIRECTION_IN, - .interface_class = USB_CLASS_HID, - .interface_subclass = USB_HID_SUBCLASS_BOOT, - .interface_protocol = USB_HID_PROTOCOL_KEYBOARD, - .flags = 0 -}; - -/* Array of endpoints expected on the device, NULL terminated. */ -usb_endpoint_description_t - *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1] = { - &boot_poll_endpoint_description, - NULL -}; - -/*----------------------------------------------------------------------------*/ - -enum { - BOOT_REPORT_DESCRIPTOR_SIZE = 63 -}; - -static const uint8_t BOOT_REPORT_DESCRIPTOR[BOOT_REPORT_DESCRIPTOR_SIZE] = { - 0x05, 0x01, // Usage Page (Generic Desktop), - 0x09, 0x06, // Usage (Keyboard), - 0xA1, 0x01, // Collection (Application), - 0x75, 0x01, // Report Size (1), - 0x95, 0x08, // Report Count (8), - 0x05, 0x07, // Usage Page (Key Codes); - 0x19, 0xE0, // Usage Minimum (224), - 0x29, 0xE7, // Usage Maximum (231), - 0x15, 0x00, // Logical Minimum (0), - 0x25, 0x01, // Logical Maximum (1), - //0x85, 0x00, // Report ID, - //0xA4, // Push - 0x81, 0x02, // Input (Data, Variable, Absolute), ; Modifier byte - //0xB4, // Pop - 0x75, 0x08, // Report Size (1), - 0x95, 0x01, // Report Count (8), - 0x81, 0x01, // Input (Constant), ; Reserved byte - 0x95, 0x05, // Report Count (5), - 0x75, 0x01, // Report Size (1), - 0x05, 0x08, // Usage Page (Page# for LEDs), - 0x19, 0x01, // Usage Minimum (1), - 0x29, 0x05, // Usage Maxmimum (5), - 0x91, 0x02, // Output (Data, Variable, Absolute), ; LED report - 0x95, 0x01, // Report Count (1), - 0x75, 0x03, // Report Size (3), - 0x91, 0x01, // Output (Constant), ; LED report padding - 0x95, 0x06, // Report Count (6), - 0x75, 0x08, // Report Size (8), - 0x15, 0x00, // Logical Minimum (0), - 0x25, 0xff, // Logical Maximum (255), - 0x05, 0x07, // Usage Page (Key Codes), - 0x19, 0x00, // Usage Minimum (0), - 0x29, 0xff, // Usage Maximum (255), - 0x81, 0x00, // Input (Data, Array), ; Key arrays (6 bytes) - 0xC0 // End Collection - -}; - -/*----------------------------------------------------------------------------*/ - -typedef enum usb_kbd_flags { - USB_KBD_STATUS_UNINITIALIZED = 0, - USB_KBD_STATUS_INITIALIZED = 1, - USB_KBD_STATUS_TO_DESTROY = -1 -} usb_kbd_flags; - -/*----------------------------------------------------------------------------*/ -/* Keyboard layouts */ -/*----------------------------------------------------------------------------*/ - -#define NUM_LAYOUTS 3 - -/** Keyboard layout map. */ -static layout_op_t *layout[NUM_LAYOUTS] = { - &us_qwerty_op, - &us_dvorak_op, - &cz_op -}; - -static int active_layout = 0; - -/*----------------------------------------------------------------------------*/ -/* Modifier constants */ -/*----------------------------------------------------------------------------*/ -/** Mapping of USB modifier key codes to generic modifier key codes. */ -static const keycode_t usbhid_modifiers_keycodes[USB_HID_MOD_COUNT] = { - KC_LCTRL, /* USB_HID_MOD_LCTRL */ - KC_LSHIFT, /* USB_HID_MOD_LSHIFT */ - KC_LALT, /* USB_HID_MOD_LALT */ - 0, /* USB_HID_MOD_LGUI */ - KC_RCTRL, /* USB_HID_MOD_RCTRL */ - KC_RSHIFT, /* USB_HID_MOD_RSHIFT */ - KC_RALT, /* USB_HID_MOD_RALT */ - 0, /* USB_HID_MOD_RGUI */ -}; - -typedef enum usbhid_lock_code { - USB_KBD_LOCK_NUM = 0x53, - USB_KBD_LOCK_CAPS = 0x39, - USB_KBD_LOCK_SCROLL = 0x47, - USB_KBD_LOCK_COUNT = 3 -} usbhid_lock_code; - -static const usbhid_lock_code usbhid_lock_codes[USB_KBD_LOCK_COUNT] = { - USB_KBD_LOCK_NUM, - USB_KBD_LOCK_CAPS, - USB_KBD_LOCK_SCROLL -}; - -/*----------------------------------------------------------------------------*/ -/* IPC method handler */ -/*----------------------------------------------------------------------------*/ - -static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); -ddf_dev_ops_t keyboard_ops = { - .default_handler = default_connection_handler -}; - -/** - * Default handler for IPC methods not handled by DDF. - * - * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it - * assumes the caller is the console and thus it stores IPC phone to it for - * later use by the driver to notify about key events. - * - * @param fun Device function handling the call. - * @param icallid Call id. - * @param icall Call data. - */ -void default_connection_handler(ddf_fun_t *fun, - ipc_callid_t icallid, ipc_call_t *icall) -{ - sysarg_t method = IPC_GET_IMETHOD(*icall); - - usb_kbd_t *kbd_dev = (usb_kbd_t *)fun->driver_data; - assert(kbd_dev != NULL); - - if (method == IPC_M_CONNECT_TO_ME) { - int callback = IPC_GET_ARG5(*icall); - - if (kbd_dev->console_phone != -1) { - async_answer_0(icallid, ELIMIT); - return; - } - - kbd_dev->console_phone = callback; - async_answer_0(icallid, EOK); - return; - } - - async_answer_0(icallid, EINVAL); -} - -/*----------------------------------------------------------------------------*/ -/* Key processing functions */ -/*----------------------------------------------------------------------------*/ -/** - * Handles turning of LED lights on and off. - * - * In case of USB keyboards, the LEDs are handled in the driver, not in the - * device. When there should be a change (lock key was pressed), the driver - * uses a Set_Report request sent to the device to set the state of the LEDs. - * - * This functions sets the LED lights according to current settings of modifiers - * kept in the keyboard device structure. - * - * @param kbd_dev Keyboard device structure. - */ -static void usb_kbd_set_led(usb_kbd_t *kbd_dev) -{ - if (kbd_dev->output_size == 0) { - return; - } - - unsigned i = 0; - - /* Reset the LED data. */ - memset(kbd_dev->led_data, 0, kbd_dev->led_output_size * sizeof(int32_t)); - - if ((kbd_dev->mods & KM_NUM_LOCK) && (i < kbd_dev->led_output_size)) { - kbd_dev->led_data[i++] = USB_HID_LED_NUM_LOCK; - } - - if ((kbd_dev->mods & KM_CAPS_LOCK) && (i < kbd_dev->led_output_size)) { - kbd_dev->led_data[i++] = USB_HID_LED_CAPS_LOCK; - } - - if ((kbd_dev->mods & KM_SCROLL_LOCK) - && (i < kbd_dev->led_output_size)) { - kbd_dev->led_data[i++] = USB_HID_LED_SCROLL_LOCK; - } - - // TODO: COMPOSE and KANA - - usb_log_debug("Creating output report.\n"); - - //usb_hid_report_output_set_data(kbd_dev->parser, kbd_dev->led_path, - // USB_HID_PATH_COMPARE_END , kbd_dev->led_data, - // kbd_dev->led_output_size); - int rc = usb_hid_report_output_translate(kbd_dev->parser, 0, - kbd_dev->output_buffer, kbd_dev->output_size); - - if (rc != EOK) { - usb_log_warning("Error translating LED output to output report" - ".\n"); - return; - } - - usb_log_debug("Output report buffer: %s\n", - usb_debug_str_buffer(kbd_dev->output_buffer, kbd_dev->output_size, - 0)); - - usbhid_req_set_report(&kbd_dev->usb_dev->ctrl_pipe, - kbd_dev->usb_dev->interface_no, USB_HID_REPORT_TYPE_OUTPUT, - kbd_dev->output_buffer, kbd_dev->output_size); -} - -/*----------------------------------------------------------------------------*/ -/** - * Processes key events. - * - * @note This function was copied from AT keyboard driver and modified to suit - * USB keyboard. - * - * @note Lock keys are not sent to the console, as they are completely handled - * in the driver. It may, however, be required later that the driver - * sends also these keys to application (otherwise it cannot use those - * keys at all). - * - * @param kbd_dev Keyboard device structure. - * @param type Type of the event (press / release). Recognized values: - * KEY_PRESS, KEY_RELEASE - * @param key Key code of the key according to HID Usage Tables. - */ -void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key) -{ - console_event_t ev; - unsigned mod_mask; - - /* - * These parts are copy-pasted from the AT keyboard driver. - * - * They definitely require some refactoring, but will keep it for later - * when the console and keyboard system is changed in HelenOS. - */ - switch (key) { - case KC_LCTRL: mod_mask = KM_LCTRL; break; - case KC_RCTRL: mod_mask = KM_RCTRL; break; - case KC_LSHIFT: mod_mask = KM_LSHIFT; break; - case KC_RSHIFT: mod_mask = KM_RSHIFT; break; - case KC_LALT: mod_mask = KM_LALT; break; - case KC_RALT: mod_mask = KM_RALT; break; - default: mod_mask = 0; break; - } - - if (mod_mask != 0) { - if (type == KEY_PRESS) - kbd_dev->mods = kbd_dev->mods | mod_mask; - else - kbd_dev->mods = kbd_dev->mods & ~mod_mask; - } - - switch (key) { - case KC_CAPS_LOCK: mod_mask = KM_CAPS_LOCK; break; - case KC_NUM_LOCK: mod_mask = KM_NUM_LOCK; break; - case KC_SCROLL_LOCK: mod_mask = KM_SCROLL_LOCK; break; - default: mod_mask = 0; break; - } - - if (mod_mask != 0) { - if (type == KEY_PRESS) { - /* - * Only change lock state on transition from released - * to pressed. This prevents autorepeat from messing - * up the lock state. - */ - unsigned int locks_old = kbd_dev->lock_keys; - - kbd_dev->mods = - kbd_dev->mods ^ (mod_mask & ~kbd_dev->lock_keys); - kbd_dev->lock_keys = kbd_dev->lock_keys | mod_mask; - - /* Update keyboard lock indicator lights. */ - if (kbd_dev->lock_keys != locks_old) { - usb_kbd_set_led(kbd_dev); - } - } else { - kbd_dev->lock_keys = kbd_dev->lock_keys & ~mod_mask; - } - } - - if (key == KC_CAPS_LOCK || key == KC_NUM_LOCK || key == KC_SCROLL_LOCK) { - // do not send anything to the console, this is our business - return; - } - - if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F1) { - active_layout = 0; - layout[active_layout]->reset(); - return; - } - - if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F2) { - active_layout = 1; - layout[active_layout]->reset(); - return; - } - - if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F3) { - active_layout = 2; - layout[active_layout]->reset(); - return; - } - - ev.type = type; - ev.key = key; - ev.mods = kbd_dev->mods; - - ev.c = layout[active_layout]->parse_ev(&ev); - - usb_log_debug2("Sending key %d to the console\n", ev.key); - if (kbd_dev->console_phone < 0) { - usb_log_warning( - "Connection to console not ready, key discarded.\n"); - return; - } - - async_msg_4(kbd_dev->console_phone, KBD_EVENT, ev.type, ev.key, - ev.mods, ev.c); -} - -/*----------------------------------------------------------------------------*/ - -static inline int usb_kbd_is_lock(unsigned int key_code) -{ - return (key_code == KC_NUM_LOCK - || key_code == KC_SCROLL_LOCK - || key_code == KC_CAPS_LOCK); -} - -/*----------------------------------------------------------------------------*/ -/** - * Checks if some keys were pressed or released and generates key events. - * - * An event is created only when key is pressed or released. Besides handling - * the events (usb_kbd_push_ev()), the auto-repeat fibril is notified about - * key presses and releases (see usb_kbd_repeat_start() and - * usb_kbd_repeat_stop()). - * - * @param kbd_dev Keyboard device structure. - * @param key_codes Parsed keyboard report - codes of currently pressed keys - * according to HID Usage Tables. - * @param count Number of key codes in report (size of the report). - * - * @sa usb_kbd_push_ev(), usb_kbd_repeat_start(), usb_kbd_repeat_stop() - */ -static void usb_kbd_check_key_changes(usb_kbd_t *kbd_dev, - const uint8_t *key_codes, size_t count) -{ - unsigned int key; - unsigned int i, j; - - /* - * First of all, check if the kbd have reported phantom state. - * - * As there is no way to distinguish keys from modifiers, we do not have - * a way to check that 'all keys report Error Rollover'. We thus check - * if there is at least one such error and in such case we ignore the - * whole input report. - */ - i = 0; - while (i < count && key_codes[i] != ERROR_ROLLOVER) { - ++i; - } - if (i != count) { - usb_log_debug("Phantom state occured.\n"); - // phantom state, do nothing - return; - } - - /* TODO: quite dummy right now, think of better implementation */ - assert(count == kbd_dev->key_count); - - /* - * 1) Key releases - */ - for (j = 0; j < count; ++j) { - // try to find the old key in the new key list - i = 0; - while (i < kbd_dev->key_count - && key_codes[i] != kbd_dev->keys[j]) { - ++i; - } - - if (i == count) { - // not found, i.e. the key was released - key = usbhid_parse_scancode(kbd_dev->keys[j]); - if (!usb_kbd_is_lock(key)) { - usb_kbd_repeat_stop(kbd_dev, key); - } - usb_kbd_push_ev(kbd_dev, KEY_RELEASE, key); - usb_log_debug2("Key released: %d\n", key); - } else { - // found, nothing happens - } - } - - /* - * 1) Key presses - */ - for (i = 0; i < kbd_dev->key_count; ++i) { - // try to find the new key in the old key list - j = 0; - while (j < count && kbd_dev->keys[j] != key_codes[i]) { - ++j; - } - - if (j == count) { - // not found, i.e. new key pressed - key = usbhid_parse_scancode(key_codes[i]); - usb_log_debug2("Key pressed: %d (keycode: %d)\n", key, - key_codes[i]); - usb_kbd_push_ev(kbd_dev, KEY_PRESS, key); - if (!usb_kbd_is_lock(key)) { - usb_kbd_repeat_start(kbd_dev, key); - } - } else { - // found, nothing happens - } - } - - memcpy(kbd_dev->keys, key_codes, count); - - usb_log_debug("New stored keycodes: %s\n", - usb_debug_str_buffer(kbd_dev->keys, kbd_dev->key_count, 0)); -} - -/*----------------------------------------------------------------------------*/ -/* Callbacks for parser */ -/*----------------------------------------------------------------------------*/ -/** - * Callback function for the HID report parser. - * - * This function is called by the HID report parser with the parsed report. - * The parsed report is used to check if any events occured (key was pressed or - * released, modifier was pressed or released). - * - * @param key_codes Parsed keyboard report - codes of currently pressed keys - * according to HID Usage Tables. - * @param count Number of key codes in report (size of the report). - * @param report_id - * @param arg User-specified argument. Expects pointer to the keyboard device - * structure representing the keyboard. - * - * @sa usb_kbd_check_key_changes(), usb_kbd_check_modifier_changes() - */ -static void usb_kbd_process_keycodes(const uint8_t *key_codes, size_t count, - uint8_t report_id, void *arg) -{ - if (arg == NULL) { - usb_log_warning("Missing argument in callback " - "usbhid_process_keycodes().\n"); - return; - } - - usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; - assert(kbd_dev != NULL); - - usb_log_debug("Got keys from parser (report id: %d): %s\n", report_id, - usb_debug_str_buffer(key_codes, count, 0)); - - if (count != kbd_dev->key_count) { - usb_log_warning("Number of received keycodes (%zu) differs from" - " expected (%zu).\n", count, kbd_dev->key_count); - return; - } - - ///usb_kbd_check_modifier_changes(kbd_dev, key_codes, count); - usb_kbd_check_key_changes(kbd_dev, key_codes, count); -} - -/*----------------------------------------------------------------------------*/ -/* General kbd functions */ -/*----------------------------------------------------------------------------*/ -/** - * Processes data received from the device in form of report. - * - * This function uses the HID report parser to translate the data received from - * the device into generic USB HID key codes and into generic modifiers bitmap. - * The parser then calls the given callback (usb_kbd_process_keycodes()). - * - * @note Currently, only the boot protocol is supported. - * - * @param kbd_dev Keyboard device structure (must be initialized). - * @param buffer Data from the keyboard (i.e. the report). - * @param actual_size Size of the data from keyboard (report size) in bytes. - * - * @sa usb_kbd_process_keycodes(), usb_hid_boot_keyboard_input_report(), - * usb_hid_parse_report(). - */ -static void usb_kbd_process_data(usb_kbd_t *kbd_dev, - uint8_t *buffer, size_t actual_size) -{ - assert(kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); - assert(kbd_dev->parser != NULL); - - usb_hid_report_in_callbacks_t *callbacks = - (usb_hid_report_in_callbacks_t *)malloc( - sizeof(usb_hid_report_in_callbacks_t)); - - callbacks->keyboard = usb_kbd_process_keycodes; - - usb_log_debug("Calling usb_hid_parse_report() with " - "buffer %s\n", usb_debug_str_buffer(buffer, actual_size, 0)); - -// int rc = usb_hid_boot_keyboard_input_report(buffer, actual_size, -// callbacks, kbd_dev); - usb_hid_report_path_t *path = usb_hid_report_path(); - usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); - - uint8_t report_id; - int rc = usb_hid_parse_report(kbd_dev->parser, buffer, actual_size, &report_id); - usb_hid_descriptor_print (kbd_dev->parser); - - usb_hid_report_path_free (path); - - if (rc != EOK) { - usb_log_warning("Error in usb_hid_boot_keyboard_input_report():" - "%s\n", str_error(rc)); - } -} - -/*----------------------------------------------------------------------------*/ -/* HID/KBD structure manipulation */ -/*----------------------------------------------------------------------------*/ - -static void usb_kbd_mark_unusable(usb_kbd_t *kbd_dev) -{ - kbd_dev->initialized = USB_KBD_STATUS_TO_DESTROY; -} - - -/*----------------------------------------------------------------------------*/ -/* API functions */ -/*----------------------------------------------------------------------------*/ -/** - * Creates a new USB/HID keyboard structure. - * - * The structure returned by this function is not initialized. Use - * usb_kbd_init() to initialize it prior to polling. - * - * @return New uninitialized structure for representing a USB/HID keyboard or - * NULL if not successful (memory error). - */ -usb_kbd_t *usb_kbd_new(void) -{ - usb_kbd_t *kbd_dev = - (usb_kbd_t *)malloc(sizeof(usb_kbd_t)); - - if (kbd_dev == NULL) { - usb_log_fatal("No memory!\n"); - return NULL; - } - - memset(kbd_dev, 0, sizeof(usb_kbd_t)); - - kbd_dev->parser = (usb_hid_report_t *)(malloc(sizeof( - usb_hid_report_t))); - if (kbd_dev->parser == NULL) { - usb_log_fatal("No memory!\n"); - free(kbd_dev); - return NULL; - } - - kbd_dev->console_phone = -1; - kbd_dev->initialized = USB_KBD_STATUS_UNINITIALIZED; - - return kbd_dev; -} - -/*----------------------------------------------------------------------------*/ -/** - * Initialization of the USB/HID keyboard structure. - * - * This functions initializes required structures from the device's descriptors. - * - * During initialization, the keyboard is switched into boot protocol, the idle - * rate is set to 0 (infinity), resulting in the keyboard only reporting event - * when a key is pressed or released. Finally, the LED lights are turned on - * according to the default setup of lock keys. - * - * @note By default, the keyboards is initialized with Num Lock turned on and - * other locks turned off. - * - * @param kbd_dev Keyboard device structure to be initialized. - * @param dev DDF device structure of the keyboard. - * - * @retval EOK if successful. - * @retval EINVAL if some parameter is not given. - * @return Other value inherited from function usbhid_dev_init(). - */ -int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev) -{ - int rc; - - usb_log_debug("Initializing HID/KBD structure...\n"); - - if (kbd_dev == NULL) { - usb_log_error("Failed to init keyboard structure: no structure" - " given.\n"); - return EINVAL; - } - - if (dev == NULL) { - usb_log_error("Failed to init keyboard structure: no USB device" - " given.\n"); - return EINVAL; - } - - if (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED) { - usb_log_warning("Keyboard structure already initialized.\n"); - return EINVAL; - } - - /* TODO: does not work! */ - if (!dev->pipes[USB_KBD_POLL_EP_NO].present) { - usb_log_warning("Required endpoint not found - probably not " - "a supported device.\n"); - return ENOTSUP; - } - - /* The USB device should already be initialized, save it in structure */ - kbd_dev->usb_dev = dev; - - /* Initialize the report parser. */ - //rc = usb_hid_parser_init(kbd_dev->parser); - //if (rc != EOK) { - // usb_log_error("Failed to initialize report parser.\n"); - // return rc; - //} - - /* Get the report descriptor and parse it. */ - rc = usb_hid_process_report_descriptor(kbd_dev->usb_dev, - kbd_dev->parser); - if (rc != EOK) { - usb_log_warning("Could not process report descriptor, " - "falling back to boot protocol.\n"); - rc = usb_hid_parse_report_descriptor(kbd_dev->parser, - BOOT_REPORT_DESCRIPTOR, BOOT_REPORT_DESCRIPTOR_SIZE); - if (rc != EOK) { - usb_log_error("Failed to parse boot report descriptor:" - " %s.\n", str_error(rc)); - return rc; - } - - rc = usbhid_req_set_protocol(&kbd_dev->usb_dev->ctrl_pipe, - kbd_dev->usb_dev->interface_no, USB_HID_PROTOCOL_BOOT); - - if (rc != EOK) { - usb_log_warning("Failed to set boot protocol to the " - "device: %s\n", str_error(rc)); - return rc; - } - } - - /* - * TODO: make more general - */ - usb_hid_report_path_t *path = usb_hid_report_path(); - usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); - - usb_hid_report_path_set_report_id(path, 0); - - kbd_dev->key_count = usb_hid_report_input_length( - kbd_dev->parser, path, USB_HID_PATH_COMPARE_END); - usb_hid_report_path_free (path); - - usb_log_debug("Size of the input report: %zu\n", kbd_dev->key_count); - - kbd_dev->keys = (uint8_t *)calloc(kbd_dev->key_count, sizeof(uint8_t)); - - if (kbd_dev->keys == NULL) { - usb_log_fatal("No memory!\n"); - return ENOMEM; - } - - /* - * Output report - */ - kbd_dev->output_size = 0; - kbd_dev->output_buffer = usb_hid_report_output(kbd_dev->parser, - &kbd_dev->output_size, 0x00); - if (kbd_dev->output_buffer == NULL) { - usb_log_warning("Error creating output report buffer.\n"); - free(kbd_dev->keys); - return ENOMEM; /* TODO: other error code */ - } - - usb_log_debug("Output buffer size: %zu\n", kbd_dev->output_size); - - kbd_dev->led_path = usb_hid_report_path(); - usb_hid_report_path_append_item( - kbd_dev->led_path, USB_HIDUT_PAGE_LED, 0); - usb_hid_report_path_set_report_id(kbd_dev->led_path, 0x00); - - kbd_dev->led_output_size = usb_hid_report_output_size(kbd_dev->parser, - kbd_dev->led_path, - USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY); - - usb_log_debug("Output report size (in items): %zu\n", - kbd_dev->led_output_size); - - kbd_dev->led_data = (int32_t *)calloc( - kbd_dev->led_output_size, sizeof(int32_t)); - - if (kbd_dev->led_data == NULL) { - usb_log_warning("Error creating buffer for LED output report." - "\n"); - free(kbd_dev->keys); - usb_hid_report_output_free(kbd_dev->output_buffer); - return ENOMEM; - } - - /* - * Modifiers and locks - */ - kbd_dev->modifiers = 0; - kbd_dev->mods = DEFAULT_ACTIVE_MODS; - kbd_dev->lock_keys = 0; - - /* - * Autorepeat - */ - kbd_dev->repeat.key_new = 0; - kbd_dev->repeat.key_repeated = 0; - kbd_dev->repeat.delay_before = DEFAULT_DELAY_BEFORE_FIRST_REPEAT; - kbd_dev->repeat.delay_between = DEFAULT_REPEAT_DELAY; - - kbd_dev->repeat_mtx = (fibril_mutex_t *)( - malloc(sizeof(fibril_mutex_t))); - if (kbd_dev->repeat_mtx == NULL) { - usb_log_fatal("No memory!\n"); - free(kbd_dev->keys); - return ENOMEM; - } - - fibril_mutex_initialize(kbd_dev->repeat_mtx); - - /* - * Set LEDs according to initial setup. - * Set Idle rate - */ - usb_kbd_set_led(kbd_dev); - - usbhid_req_set_idle(&kbd_dev->usb_dev->ctrl_pipe, - kbd_dev->usb_dev->interface_no, IDLE_RATE); - - kbd_dev->initialized = USB_KBD_STATUS_INITIALIZED; - usb_log_debug("HID/KBD device structure initialized.\n"); - - return EOK; -} - -/*----------------------------------------------------------------------------*/ - -bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, - size_t buffer_size, void *arg) -{ - if (dev == NULL || buffer == NULL || arg == NULL) { - // do not continue polling (???) - return false; - } - - usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; - - // TODO: add return value from this function - usb_kbd_process_data(kbd_dev, buffer, buffer_size); - - return true; -} - -/*----------------------------------------------------------------------------*/ - -void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, - void *arg) -{ - if (dev == NULL || arg == NULL) { - return; - } - - usb_kbd_t *kbd = (usb_kbd_t *)arg; - - usb_kbd_mark_unusable(kbd); -} - -/*----------------------------------------------------------------------------*/ - -int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev) -{ - return (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); -} - -/*----------------------------------------------------------------------------*/ - -int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev) -{ - return (kbd_dev->initialized == USB_KBD_STATUS_TO_DESTROY); -} - -/*----------------------------------------------------------------------------*/ -/** - * Properly destroys the USB/HID keyboard structure. - * - * @param kbd_dev Pointer to the structure to be destroyed. - */ -void usb_kbd_free(usb_kbd_t **kbd_dev) -{ - if (kbd_dev == NULL || *kbd_dev == NULL) { - return; - } - - // hangup phone to the console - async_hangup((*kbd_dev)->console_phone); - -// if ((*kbd_dev)->hid_dev != NULL) { -// usbhid_dev_free(&(*kbd_dev)->hid_dev); -// assert((*kbd_dev)->hid_dev == NULL); -// } - - if ((*kbd_dev)->repeat_mtx != NULL) { - /* TODO: replace by some check and wait */ - assert(!fibril_mutex_is_locked((*kbd_dev)->repeat_mtx)); - free((*kbd_dev)->repeat_mtx); - } - - // destroy the parser - if ((*kbd_dev)->parser != NULL) { - usb_hid_free_report((*kbd_dev)->parser); - } - - // free the output buffer - usb_hid_report_output_free((*kbd_dev)->output_buffer); - - /* TODO: what about the USB device structure?? */ - - free(*kbd_dev); - *kbd_dev = NULL; -} - -/** - * @} - */ Index: uspace/drv/usbkbd/kbddev.h =================================================================== --- uspace/drv/usbkbd/kbddev.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,154 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB HID keyboard device structure and API. - */ - -#ifndef USB_KBDDEV_H_ -#define USB_KBDDEV_H_ - -#include - -#include - -#include -#include -#include -#include -#include - -#include "kbdrepeat.h" - -/*----------------------------------------------------------------------------*/ -/** - * USB/HID keyboard device type. - * - * Holds a reference to generic USB/HID device structure and keyboard-specific - * data, such as currently pressed keys, modifiers and lock keys. - * - * Also holds a IPC phone to the console (since there is now no other way to - * communicate with it). - * - * @note Storing active lock keys in this structure results in their setting - * being device-specific. - */ -typedef struct usb_kbd_t { - /** Structure holding generic USB device information. */ - //usbhid_dev_t *hid_dev; - usb_device_t *usb_dev; - - /** Currently pressed keys (not translated to key codes). */ - uint8_t *keys; - /** Count of stored keys (i.e. number of keys in the report). */ - size_t key_count; - /** Currently pressed modifiers (bitmap). */ - uint8_t modifiers; - - /** Currently active modifiers including locks. Sent to the console. */ - unsigned mods; - - /** Currently active lock keys. */ - unsigned lock_keys; - - /** IPC phone to the console device (for sending key events). */ - int console_phone; - - /** Information for auto-repeat of keys. */ - usb_kbd_repeat_t repeat; - - /** Mutex for accessing the information about auto-repeat. */ - fibril_mutex_t *repeat_mtx; - - /** Report descriptor. */ - uint8_t *report_desc; - - /** Report descriptor size. */ - size_t report_desc_size; - - uint8_t *output_buffer; - - size_t output_size; - - size_t led_output_size; - - usb_hid_report_path_t *led_path; - - int32_t *led_data; - - /** HID Report parser. */ - usb_hid_report_t *parser; - - /** State of the structure (for checking before use). - * - * 0 - not initialized - * 1 - initialized - * -1 - ready for destroying - */ - int initialized; -} usb_kbd_t; - -/*----------------------------------------------------------------------------*/ - -enum { - USB_KBD_POLL_EP_NO = 0, - USB_KBD_POLL_EP_COUNT = 1 -}; - -usb_endpoint_description_t *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1]; - -ddf_dev_ops_t keyboard_ops; - -/*----------------------------------------------------------------------------*/ - -usb_kbd_t *usb_kbd_new(void); - -int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev); - -bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, - size_t buffer_size, void *arg); - -void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, - void *arg); - -int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev); - -int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev); - -void usb_kbd_free(usb_kbd_t **kbd_dev); - -void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key); - -#endif /* USB_KBDDEV_H_ */ - -/** - * @} - */ Index: uspace/drv/usbkbd/kbdrepeat.c =================================================================== --- uspace/drv/usbkbd/kbdrepeat.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,185 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** - * @file - * USB HID keyboard autorepeat facilities - */ - -#include -#include -#include -#include - -#include - -#include "kbdrepeat.h" -#include "kbddev.h" - - -/** Delay between auto-repeat state checks when no key is being repeated. */ -static unsigned int CHECK_DELAY = 10000; - -/*----------------------------------------------------------------------------*/ -/** - * Main loop handling the auto-repeat of keys. - * - * This functions periodically checks if there is some key to be auto-repeated. - * - * If a new key is to be repeated, it uses the delay before first repeat stored - * in the keyboard structure to wait until the key has to start repeating. - * - * If the same key is still pressed, it uses the delay between repeats stored - * in the keyboard structure to wait until the key should be repeated. - * - * If the currently repeated key is not pressed any more ( - * usb_kbd_repeat_stop() was called), it stops repeating it and starts - * checking again. - * - * @note For accessing the keyboard device auto-repeat information a fibril - * mutex (repeat_mtx) from the @a kbd structure is used. - * - * @param kbd Keyboard device structure. - */ -static void usb_kbd_repeat_loop(usb_kbd_t *kbd) -{ - unsigned int delay = 0; - - usb_log_debug("Starting autorepeat loop.\n"); - - while (true) { - // check if the kbd structure is usable - if (!usb_kbd_is_initialized(kbd)) { - if (usb_kbd_is_ready_to_destroy(kbd)) { - usb_kbd_free(&kbd); - assert(kbd == NULL); - } - return; - } - - fibril_mutex_lock(kbd->repeat_mtx); - - if (kbd->repeat.key_new > 0) { - if (kbd->repeat.key_new == kbd->repeat.key_repeated) { - usb_log_debug2("Repeating key: %u.\n", - kbd->repeat.key_repeated); - usb_kbd_push_ev(kbd, KEY_PRESS, - kbd->repeat.key_repeated); - delay = kbd->repeat.delay_between; - } else { - usb_log_debug("New key to repeat: %u.\n", - kbd->repeat.key_new); - kbd->repeat.key_repeated = kbd->repeat.key_new; - delay = kbd->repeat.delay_before; - } - } else { - if (kbd->repeat.key_repeated > 0) { - usb_log_debug("Stopping to repeat key: %u.\n", - kbd->repeat.key_repeated); - kbd->repeat.key_repeated = 0; - } - delay = CHECK_DELAY; - } - fibril_mutex_unlock(kbd->repeat_mtx); - - async_usleep(delay); - } -} - -/*----------------------------------------------------------------------------*/ -/** - * Main routine to be executed by a fibril for handling auto-repeat. - * - * Starts the loop for checking changes in auto-repeat. - * - * @param arg User-specified argument. Expects pointer to the keyboard device - * structure representing the keyboard. - * - * @retval EOK if the routine has finished. - * @retval EINVAL if no argument is supplied. - */ -int usb_kbd_repeat_fibril(void *arg) -{ - usb_log_debug("Autorepeat fibril spawned.\n"); - - if (arg == NULL) { - usb_log_error("No device!\n"); - return EINVAL; - } - - usb_kbd_t *kbd = (usb_kbd_t *)arg; - - usb_kbd_repeat_loop(kbd); - - return EOK; -} - -/*----------------------------------------------------------------------------*/ -/** - * Start repeating particular key. - * - * @note Only one key is repeated at any time, so calling this function - * effectively cancels auto-repeat of the current repeated key (if any) - * and 'schedules' another key for auto-repeat. - * - * @param kbd Keyboard device structure. - * @param key Key to start repeating. - */ -void usb_kbd_repeat_start(usb_kbd_t *kbd, unsigned int key) -{ - fibril_mutex_lock(kbd->repeat_mtx); - kbd->repeat.key_new = key; - fibril_mutex_unlock(kbd->repeat_mtx); -} - -/*----------------------------------------------------------------------------*/ -/** - * Stop repeating particular key. - * - * @note Only one key is repeated at any time, but this function may be called - * even with key that is not currently repeated (in that case nothing - * happens). - * - * @param kbd Keyboard device structure. - * @param key Key to stop repeating. - */ -void usb_kbd_repeat_stop(usb_kbd_t *kbd, unsigned int key) -{ - fibril_mutex_lock(kbd->repeat_mtx); - if (key == kbd->repeat.key_new) { - kbd->repeat.key_new = 0; - } - fibril_mutex_unlock(kbd->repeat_mtx); -} - -/** - * @} - */ Index: uspace/drv/usbkbd/kbdrepeat.h =================================================================== --- uspace/drv/usbkbd/kbdrepeat.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,68 +1,0 @@ -/* - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * USB HID keyboard autorepeat facilities - */ - -#ifndef USB_KBDREPEAT_H_ -#define USB_KBDREPEAT_H_ - -struct usb_kbd_t; - -/*----------------------------------------------------------------------------*/ -/** - * Structure for keeping information needed for auto-repeat of keys. - */ -typedef struct { - /** Last pressed key. */ - unsigned int key_new; - /** Key to be repeated. */ - unsigned int key_repeated; - /** Delay before first repeat in microseconds. */ - unsigned int delay_before; - /** Delay between repeats in microseconds. */ - unsigned int delay_between; -} usb_kbd_repeat_t; - -/*----------------------------------------------------------------------------*/ - -int usb_kbd_repeat_fibril(void *arg); - -void usb_kbd_repeat_start(struct usb_kbd_t *kbd, unsigned int key); - -void usb_kbd_repeat_stop(struct usb_kbd_t *kbd, unsigned int key); - -#endif /* USB_KBDREPEAT_H_ */ - -/** - * @} - */ Index: uspace/drv/usbkbd/layout.h =================================================================== --- uspace/drv/usbkbd/layout.h (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,57 +1,0 @@ -/* - * Copyright (c) 2009 Jiri Svoboda - * Copyright (c) 2011 Lubos Slovak - * (copied from /uspace/srv/hid/kbd/include/layout.h) - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** @file - * Keyboard layout. - */ - -#ifndef USB_KBD_LAYOUT_H_ -#define USB_KBD_LAYOUT_H_ - -#include -#include - -typedef struct { - void (*reset)(void); - wchar_t (*parse_ev)(console_event_t *); -} layout_op_t; - -extern layout_op_t us_qwerty_op; -extern layout_op_t us_dvorak_op; -extern layout_op_t cz_op; - -#endif - -/** - * @} - */ Index: uspace/drv/usbkbd/main.c =================================================================== --- uspace/drv/usbkbd/main.c (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,252 +1,0 @@ -/* - * Copyright (c) 2010 Vojtech Horky - * Copyright (c) 2011 Lubos Slovak - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbhid - * @{ - */ -/** - * @file - * Main routines of USB KBD driver. - */ - -#include -#include -#include -#include - -#include -#include - -#include "kbddev.h" -#include "kbdrepeat.h" - -/*----------------------------------------------------------------------------*/ - -#define NAME "usbkbd" - -/** - * Function for adding a new device of type USB/HID/keyboard. - * - * This functions initializes required structures from the device's descriptors - * and starts new fibril for polling the keyboard for events and another one for - * handling auto-repeat of keys. - * - * During initialization, the keyboard is switched into boot protocol, the idle - * rate is set to 0 (infinity), resulting in the keyboard only reporting event - * when a key is pressed or released. Finally, the LED lights are turned on - * according to the default setup of lock keys. - * - * @note By default, the keyboards is initialized with Num Lock turned on and - * other locks turned off. - * @note Currently supports only boot-protocol keyboards. - * - * @param dev Device to add. - * - * @retval EOK if successful. - * @retval ENOMEM if there - * @return Other error code inherited from one of functions usb_kbd_init(), - * ddf_fun_bind() and ddf_fun_add_to_class(). - * - * @sa usb_kbd_fibril(), usb_kbd_repeat_fibril() - */ -static int usb_kbd_try_add_device(usb_device_t *dev) -{ - /* Create the function exposed under /dev/devices. */ - ddf_fun_t *kbd_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, - "keyboard"); - if (kbd_fun == NULL) { - usb_log_error("Could not create DDF function node.\n"); - return ENOMEM; - } - - /* - * Initialize device (get and process descriptors, get address, etc.) - */ - usb_log_debug("Initializing USB/HID KBD device...\n"); - - usb_kbd_t *kbd_dev = usb_kbd_new(); - if (kbd_dev == NULL) { - usb_log_error("Error while creating USB/HID KBD device " - "structure.\n"); - ddf_fun_destroy(kbd_fun); - return ENOMEM; // TODO: some other code?? - } - - int rc = usb_kbd_init(kbd_dev, dev); - - if (rc != EOK) { - usb_log_error("Failed to initialize USB/HID KBD device.\n"); - ddf_fun_destroy(kbd_fun); - usb_kbd_free(&kbd_dev); - return rc; - } - - usb_log_debug("USB/HID KBD device structure initialized.\n"); - - /* - * Store the initialized keyboard device and keyboard ops - * to the DDF function. - */ - kbd_fun->driver_data = kbd_dev; - kbd_fun->ops = &keyboard_ops; - - rc = ddf_fun_bind(kbd_fun); - if (rc != EOK) { - usb_log_error("Could not bind DDF function: %s.\n", - str_error(rc)); - // TODO: Can / should I destroy the DDF function? - ddf_fun_destroy(kbd_fun); - usb_kbd_free(&kbd_dev); - return rc; - } - - rc = ddf_fun_add_to_class(kbd_fun, "keyboard"); - if (rc != EOK) { - usb_log_error( - "Could not add DDF function to class 'keyboard': %s.\n", - str_error(rc)); - // TODO: Can / should I destroy the DDF function? - ddf_fun_destroy(kbd_fun); - usb_kbd_free(&kbd_dev); - return rc; - } - - /* - * Create new fibril for handling this keyboard - */ - //fid_t fid = fibril_create(usb_kbd_fibril, kbd_dev); - - /* Start automated polling function. - * This will create a separate fibril that will query the device - * for the data continuously - */ - rc = usb_device_auto_poll(dev, - /* Index of the polling pipe. */ - USB_KBD_POLL_EP_NO, - /* Callback when data arrives. */ - usb_kbd_polling_callback, - /* How much data to request. */ - dev->pipes[USB_KBD_POLL_EP_NO].pipe->max_packet_size, - /* Callback when the polling ends. */ - usb_kbd_polling_ended_callback, - /* Custom argument. */ - kbd_dev); - - - if (rc != EOK) { - usb_log_error("Failed to start polling fibril for `%s'.\n", - dev->ddf_dev->name); - return rc; - } - //fibril_add_ready(fid); - - /* - * Create new fibril for auto-repeat - */ - fid_t fid = fibril_create(usb_kbd_repeat_fibril, kbd_dev); - if (fid == 0) { - usb_log_error("Failed to start fibril for KBD auto-repeat"); - return ENOMEM; - } - fibril_add_ready(fid); - - (void)keyboard_ops; - - /* - * Hurrah, device is initialized. - */ - return EOK; -} - -/*----------------------------------------------------------------------------*/ -/** - * Callback for passing a new device to the driver. - * - * @note Currently, only boot-protocol keyboards are supported by this driver. - * - * @param dev Structure representing the new device. - * - * @retval EOK if successful. - * @retval EREFUSED if the device is not supported. - */ -static int usb_kbd_add_device(usb_device_t *dev) -{ - usb_log_debug("usb_kbd_add_device()\n"); - - if (dev->interface_no < 0) { - usb_log_warning("Device is not a supported keyboard.\n"); - usb_log_error("Failed to add USB KBD device: endpoint not " - "found.\n"); - return ENOTSUP; - } - - int rc = usb_kbd_try_add_device(dev); - - if (rc != EOK) { - usb_log_warning("Device is not a supported keyboard.\n"); - usb_log_error("Failed to add KBD device: %s.\n", - str_error(rc)); - return rc; - } - - usb_log_info("Keyboard `%s' ready to use.\n", dev->ddf_dev->name); - - return EOK; -} - -/*----------------------------------------------------------------------------*/ - -/* Currently, the framework supports only device adding. Once the framework - * supports unplug, more callbacks will be added. */ -static usb_driver_ops_t usb_kbd_driver_ops = { - .add_device = usb_kbd_add_device, -}; - - -/* The driver itself. */ -static usb_driver_t usb_kbd_driver = { - .name = NAME, - .ops = &usb_kbd_driver_ops, - .endpoints = usb_kbd_endpoints -}; - -/*----------------------------------------------------------------------------*/ - -int main(int argc, char *argv[]) -{ - printf(NAME ": HelenOS USB KBD driver.\n"); - - usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); - - return usb_driver_main(&usb_kbd_driver); -} - -/** - * @} - */ Index: uspace/drv/usbkbd/usbkbd.ma =================================================================== --- uspace/drv/usbkbd/usbkbd.ma (revision faa44e5822a62f097605f7e1a86f8019bcb3872e) +++ (revision ) @@ -1,1 +1,0 @@ -10 usb&interface&class=HID&subclass=0x01&protocol=0x01