Index: uspace/drv/usbkbd/Makefile =================================================================== --- uspace/drv/usbkbd/Makefile (revision d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (revision ) @@ -1,53 +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 = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a -EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. -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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (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 d3b6d5e0a18004858a874fcb193bd53440e9a57d) +++ (revision ) @@ -1,1 +1,0 @@ -10 usb&interface&class=HID&subclass=0x01&protocol=0x01