Index: boot/arch/amd64/Makefile.inc =================================================================== --- boot/arch/amd64/Makefile.inc (revision e4153eadfe26585d8652d9e38196d2cf564007fa) +++ boot/arch/amd64/Makefile.inc (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -50,4 +50,5 @@ usbhub \ usbkbd \ + usbhid \ usbmid \ usbmouse \ Index: uspace/Makefile =================================================================== --- uspace/Makefile (revision e4153eadfe26585d8652d9e38196d2cf564007fa) +++ uspace/Makefile (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -123,4 +123,5 @@ drv/usbflbk \ drv/usbkbd \ + drv/usbhid \ drv/usbhub \ drv/usbmid \ @@ -143,4 +144,5 @@ drv/usbflbk \ drv/usbkbd \ + drv/usbhid \ drv/usbhub \ drv/usbmid \ Index: uspace/drv/usbhid/Makefile =================================================================== --- uspace/drv/usbhid/Makefile (revision 966acedea361193a3281881799f3c0e6984cc329) +++ uspace/drv/usbhid/Makefile (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -0,0 +1,39 @@ +# +# 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 = usbhid + +SOURCES = \ + main.c \ + usbhid.c + +include $(USPACE_PREFIX)/Makefile.common + Index: uspace/drv/usbhid/main.c =================================================================== --- uspace/drv/usbhid/main.c (revision 966acedea361193a3281881799f3c0e6984cc329) +++ uspace/drv/usbhid/main.c (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -0,0 +1,233 @@ +/* + * 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 HID driver. + */ + +#include +#include +#include +#include + +#include + +#include "usbhid.h" + +/*----------------------------------------------------------------------------*/ + +#define NAME "usbhid" + +/** + * 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_hid_try_add_device(usb_device_t *dev) +{ + /* Create the function exposed under /dev/devices. */ + ddf_fun_t *hid_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, + "hid"); + if (hid_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 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(hid_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(hid_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; + hid_fun->ops = &hid_ops; + + int rc = ddf_fun_bind(hid_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(hid_fun); + return rc; + } + + rc = ddf_fun_add_to_class(hid_fun, "hid"); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class 'hid': %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(hid_fun); + return rc; + } + + + /* 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_HID_POLL_EP_NO, + /* Callback when data arrives. */ + usb_hid_polling_callback, + /* How much data to request. */ + dev->pipes[USB_HID_POLL_EP_NO].pipe->max_packet_size, + /* Callback when the polling ends. */ + usb_hid_polling_ended_callback, + /* Custom argument. */ + NULL); + + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril for `%s'.\n", + dev->ddf_dev->name); + return rc; + } + + (void)hid_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_hid_add_device(usb_device_t *dev) +{ + usb_log_debug("usb_hid_add_device()\n"); + + if (dev->interface_no < 0) { + usb_log_warning("Device is not a supported HID device.\n"); + usb_log_error("Failed to add HID device: endpoint not found." + "\n"); + return ENOTSUP; + } + + int rc = usb_hid_try_add_device(dev); + + if (rc != EOK) { + usb_log_warning("Device is not a supported HID device.\n"); + usb_log_error("Failed to add HID device: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("HID device `%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_hid_driver_ops = { + .add_device = usb_hid_add_device, +}; + + +/* The driver itself. */ +static usb_driver_t usb_hid_driver = { + .name = NAME, + .ops = &usb_hid_driver_ops, + .endpoints = usb_hid_endpoints +}; + +/*----------------------------------------------------------------------------*/ + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB HID driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); + + return usb_driver_main(&usb_hid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.c =================================================================== --- uspace/drv/usbhid/usbhid.c (revision 966acedea361193a3281881799f3c0e6984cc329) +++ uspace/drv/usbhid/usbhid.c (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -0,0 +1,84 @@ +/* + * 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 driver API. + */ + +#include +#include + +#include "usbhid.h" + +/*----------------------------------------------------------------------------*/ + +/** HID device polling endpoint description. */ +static usb_endpoint_description_t poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .flags = 0 +}; + +/* Array of endpoints expected on the device, NULL terminated. */ +usb_endpoint_description_t + *usb_hid_endpoints[USB_HID_POLL_EP_COUNT + 1] = { + &poll_endpoint_description, + NULL +}; + +/*----------------------------------------------------------------------------*/ + +ddf_dev_ops_t hid_ops = { + .default_handler = NULL +}; + +/*----------------------------------------------------------------------------*/ + +bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg) +{ + usb_debug_str_buffer(buffer, buffer_size, 0); + return true; +} + +/*----------------------------------------------------------------------------*/ + +void usb_hid_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg) +{ + +} + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.h =================================================================== --- uspace/drv/usbhid/usbhid.h (revision 966acedea361193a3281881799f3c0e6984cc329) +++ uspace/drv/usbhid/usbhid.h (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -0,0 +1,140 @@ +/* + * 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 driver API. + */ + +#ifndef USB_USBHID_H_ +#define USB_USBHID_H_ + +#include + +//#include + +//#include +//#include +#include +#include +#include + +/*----------------------------------------------------------------------------*/ +///** +// * 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_parser_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_HID_POLL_EP_NO = 0, + USB_HID_POLL_EP_COUNT = 1 +}; + +usb_endpoint_description_t *usb_hid_endpoints[USB_HID_POLL_EP_COUNT + 1]; + +ddf_dev_ops_t hid_ops; + +/*----------------------------------------------------------------------------*/ + +bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg); + +void usb_hid_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg); + +#endif /* USB_KBDDEV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.ma =================================================================== --- uspace/drv/usbhid/usbhid.ma (revision 966acedea361193a3281881799f3c0e6984cc329) +++ uspace/drv/usbhid/usbhid.ma (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -0,0 +1,1 @@ +100 usb&interface&class=HID Index: uspace/drv/usbkbd/main.c =================================================================== --- uspace/drv/usbkbd/main.c (revision e4153eadfe26585d8652d9e38196d2cf564007fa) +++ uspace/drv/usbkbd/main.c (revision 966acedea361193a3281881799f3c0e6984cc329) @@ -33,5 +33,5 @@ /** * @file - * Main routines of USB HID driver. + * Main routines of USB KBD driver. */ @@ -75,5 +75,5 @@ * @sa usb_kbd_fibril(), usb_kbd_repeat_fibril() */ -static int usbhid_try_add_device(usb_device_t *dev) +static int usb_kbd_try_add_device(usb_device_t *dev) { /* Create the function exposed under /dev/devices. */ @@ -195,20 +195,20 @@ * @retval EREFUSED if the device is not supported. */ -static int usbhid_add_device(usb_device_t *dev) +static int usb_kbd_add_device(usb_device_t *dev) { - usb_log_debug("usbhid_add_device()\n"); + 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 HID device: endpoint not found." + usb_log_error("Failed to add USB KBD device: endpoint not found." "\n"); return ENOTSUP; } - int rc = usbhid_try_add_device(dev); + 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 HID device: %s.\n", + usb_log_error("Failed to add KBD device: %s.\n", str_error(rc)); return rc; @@ -224,13 +224,13 @@ /* Currently, the framework supports only device adding. Once the framework * supports unplug, more callbacks will be added. */ -static usb_driver_ops_t usbhid_driver_ops = { - .add_device = usbhid_add_device, +static usb_driver_ops_t usb_kbd_driver_ops = { + .add_device = usb_kbd_add_device, }; /* The driver itself. */ -static usb_driver_t usbhid_driver = { +static usb_driver_t usb_kbd_driver = { .name = NAME, - .ops = &usbhid_driver_ops, + .ops = &usb_kbd_driver_ops, .endpoints = usb_kbd_endpoints }; @@ -238,24 +238,11 @@ /*----------------------------------------------------------------------------*/ -//static driver_ops_t kbd_driver_ops = { -// .add_device = usbhid_add_device, -//}; - -///*----------------------------------------------------------------------------*/ - -//static driver_t kbd_driver = { -// .name = NAME, -// .driver_ops = &kbd_driver_ops -//}; - -/*----------------------------------------------------------------------------*/ - int main(int argc, char *argv[]) { - printf(NAME ": HelenOS USB HID driver.\n"); + printf(NAME ": HelenOS USB KBD driver.\n"); usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); - return usb_driver_main(&usbhid_driver); + return usb_driver_main(&usb_kbd_driver); }