Changeset cc5908e in mainline for uspace/lib

Timestamp:

2011-05-07T14:28:51Z (15 years ago)

Author:

Matej Klonfar <maklf@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

252cf2a, 68b614e

Parents:

bd2394b (diff), 7205209 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Development changes merged

Location:

uspace/lib

Files:

• c/generic/devman.c (modified) (1 diff)
• c/include/devman.h (modified) (1 diff)
• c/include/ipc/devman.h (modified) (1 diff)
• usb/Makefile (modified) (1 diff)
• usb/include/usb/classes/hid_report_items.h (modified) (1 diff)
• usb/include/usb/classes/hidtypes.h (modified) (3 diffs)
• usb/include/usb/host.h (moved) (moved from uspace/app/virtusbkbd/stdreq.h ) (2 diffs)
• usb/include/usb/usb.h (modified) (1 diff)
• usb/src/hiddescriptor.c (modified) (9 diffs)
• usb/src/hidparser.c (modified) (1 diff)
• usb/src/host.c (moved) (moved from uspace/app/virtusbkbd/kbdconfig.h ) (2 diffs)
• usbvirt/Makefile (modified) (1 diff)
• usbvirt/include/usbvirt/device.h (modified) (4 diffs)
• usbvirt/include/usbvirt/ipc.h (modified) (4 diffs)
• usbvirt/src/ctrltransfer.c (modified) (3 diffs)
• usbvirt/src/device.c (added)
• usbvirt/src/ipc.c (deleted)
• usbvirt/src/ipc_dev.c (added)
• usbvirt/src/ipc_hc.c (added)
• usbvirt/src/private.h (modified) (2 diffs)
• usbvirt/src/stdreq.c (modified) (4 diffs)
• usbvirt/src/transfer.c (modified) (6 diffs)

uspace/lib/c/generic/devman.c

@@ -374 +374 @@
 }
 
+int devman_get_device_path(devman_handle_t handle, char *path, size_t path_size)
+{
+        int phone = devman_get_phone(DEVMAN_CLIENT, 0);
+
+        if (phone < 0)
+                return phone;
+
+        async_serialize_start();
+
+        ipc_call_t answer;
+        aid_t req = async_send_1(phone, DEVMAN_DEVICE_GET_DEVICE_PATH,
+            handle, &answer);
+
+        ipc_call_t data_request_call;
+        aid_t data_request = async_data_read(phone, path, path_size,
+            &data_request_call);
+        if (data_request == 0) {
+                async_wait_for(req, NULL);
+                async_serialize_end();
+                return ENOMEM;
+        }
+
+        sysarg_t data_request_rc;
+        sysarg_t opening_request_rc;
+        async_wait_for(data_request, &data_request_rc);
+        async_wait_for(req, &opening_request_rc);
+
+        async_serialize_end();
+
+        if (data_request_rc != EOK) {
+                /* Prefer the return code of the opening request. */
+                if (opening_request_rc != EOK) {
+                        return (int) opening_request_rc;
+                } else {
+                        return (int) data_request_rc;
+                }
+        }
+        if (opening_request_rc != EOK) {
+                return (int) opening_request_rc;
+        }
+
+        path[path_size - 1] = 0;
+
+        if (IPC_GET_ARG2(data_request_call) >= path_size) {
+                return ELIMIT;
+        }
+
+        return EOK;
+}
+
 
 /** @}

uspace/lib/c/include/devman.h

@@ -55 +55 @@
 extern int devman_device_get_handle_by_class(const char *, const char *,
     devman_handle_t *, unsigned int);
+extern int devman_get_device_path(devman_handle_t, char *, size_t);
 
 extern int devman_add_device_to_class(devman_handle_t, const char *);

uspace/lib/c/include/ipc/devman.h

@@ -149 +149 @@
 typedef enum {
         DEVMAN_DEVICE_GET_HANDLE = IPC_FIRST_USER_METHOD,
-        DEVMAN_DEVICE_GET_HANDLE_BY_CLASS
+        DEVMAN_DEVICE_GET_HANDLE_BY_CLASS,
+        DEVMAN_DEVICE_GET_DEVICE_PATH
 } client_to_devman_t;
 

uspace/lib/usb/Makefile

@@ -46 +46 @@
         src/hidparser.c \
         src/hiddescriptor.c \
+        src/host.c \
         src/hub.c \
         src/pipepriv.c \

uspace/lib/usb/include/usb/classes/hid_report_items.h

@@ -46 +46 @@
 #define USB_HID_ITEM_IS_LONG(data)      (data == 0xFE)
 
+
+/**
+ * Extended usage macros
+ */
+#define USB_HID_IS_EXTENDED_USAGE(usage)        ((usage & 0xFFFF0000) != 0)
+#define USB_HID_EXTENDED_USAGE_PAGE(usage)      ((usage & 0xFFFF0000) >> 16)
+#define USB_HID_EXTENDED_USAGE(usage)           (usage & 0xFFFF)
 
 /**

uspace/lib/usb/include/usb/classes/hidtypes.h

@@ -39 +39 @@
 #include <adt/list.h>
 
-#define USB_HID_MAX_USAGES      20
+#define USB_HID_MAX_USAGES      0xffff
 
 #define USB_HID_UINT32_TO_INT32(x, size)        ((((x) & (1 << ((size) - 1))) != 0) ? -(~(x - 1) & ((1 << size) - 1)) : (x)) //(-(~((x) - 1)))
@@ -92 +92 @@
         int32_t physical_minimum;
         int32_t physical_maximum;
-        uint32_t usage_minimum;
-        uint32_t usage_maximum;
+        int32_t usage_minimum;
+        int32_t usage_maximum;
         uint32_t unit;
         uint32_t unit_exponent;
-        
+
+        uint32_t *usages;
+        size_t usages_count;
 
         int32_t value;
@@ -121 +123 @@
 
         /** */  
-        uint32_t usage_minimum;
-        /** */  
-        uint32_t usage_maximum;
+        int32_t usage_minimum;
+        /** */  
+        int32_t usage_maximum;
         /** */  
         int32_t logical_minimum;

uspace/lib/usb/include/usb/host.h

@@ -1 +1 @@
 /*
- * Copyright (c) 2010 Vojtech Horky
+ * Copyright (c) 2011 Vojtech Horky
  * All rights reserved.
  *
@@ -27 +27 @@
  */
 
-/** @addtogroup usbvirtkbd
+/** @addtogroup libusb
  * @{
  */
 /** @file
- * @brief Standard device request handlers.
+ * Host controller common functions.
  */
-#ifndef VUK_STDREQ_H_
-#define VUK_STDREQ_H_
+#ifndef LIBUSB_HOST_H_
+#define LIBUSB_HOST_H_
 
-#include <usbvirt/device.h>
+#include <sys/types.h>
+#include <ipc/devman.h>
 
-int req_get_descriptor(usbvirt_device_t *device,
-    const usb_device_request_setup_packet_t *setup_packet,
-    uint8_t *data, size_t *act_size);
+int usb_ddf_get_hc_handle_by_class(size_t, devman_handle_t *);
 
 #endif

uspace/lib/usb/include/usb/usb.h

@@ -172 +172 @@
 } usb_packet_id;
 
+/** Class name for USB host controllers. */
+#define USB_HC_DDF_CLASS_NAME "usbhc"
+
 #endif
 /**

uspace/lib/usb/src/hiddescriptor.c

@@ -116 +116 @@
         int i;
 
-        for(i=0; i<report_item->usages_count; i++){
-                usb_log_debug("usages (%d) - %x\n", i, report_item->usages[i]);
-        }
-
+        usb_log_debug("usages_count  - %zu\n", report_item->usages_count);
+
+        uint32_t *usages;
+        int usages_used=0;
+        if(report_item->usages_count > 0){
+                usages = malloc(sizeof(int32_t) * report_item->usages_count);
+                memcpy(usages, report_item->usages, sizeof(int32_t) * report_item->usages_count);
+        }
+        else {
+                usages = NULL;
+        }
+        
         usb_hid_report_path_t *path = report_item->usage_path;  
         for(i=0; i<report_item->count; i++){
@@ -133 +141 @@
                 field->physical_maximum = report_item->physical_maximum;
 
-                field->usage_minimum = report_item->usage_minimum;
-                field->usage_maximum = report_item->usage_maximum;
-                if(report_item->extended_usage_page != 0){
-                        field->usage_page = report_item->extended_usage_page;
+                if(USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) == 0){
+                        /* 
+                                Store usage array. The Correct Usage Page and Usage is depending 
+                                on data in report and will be filled later
+                        */
+                        field->usage = 0;
+                        field->usage_page = report_item->usage_page;
+
+                        field->usages_count = report_item->usages_count;
+                        field->usages = usages;
+                        usages_used = 1;
                 }
                 else {
-                        field->usage_page = report_item->usage_page;
-                }
-
-                if(report_item->usages_count > 0 && ((report_item->usage_minimum == 0) && (report_item->usage_maximum == 0))) {
-                        uint32_t usage;
-                        if(i < report_item->usages_count){
+                        /* Fill the correct Usage and Usage Page */
+                        int32_t usage;
+                        if(i < report_item->usages_count) {
                                 usage = report_item->usages[i];
                         }
@@ -151 +163 @@
                         }
 
-                                                
-                        if((usage & 0xFFFF0000) != 0){
-                                field->usage_page = (usage >> 16);                                      
-                                field->usage = (usage & 0xFFFF);
+                        if(USB_HID_IS_EXTENDED_USAGE(usage)){
+                                field->usage = USB_HID_EXTENDED_USAGE(usage);
+                                field->usage_page = USB_HID_EXTENDED_USAGE_PAGE(usage);
                         }
                         else {
                                 field->usage = usage;
-                        }
-
-                        
-                }       
-
-                if((USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) != 0) && (!((report_item->usage_minimum == 0) && (report_item->usage_maximum == 0)))) {
-                        field->usage = report_item->usage_minimum + i;                                  
+                                field->usage_page = report_item->usage_page;
+                        }
                 }
                 
@@ -209 +215 @@
         }
 
+        // free only when not used!!!
+        if(usages && usages_used == 0) {
+                free(usages);
+        }
 
         return EOK;
@@ -565 +575 @@
                         }
                         break;
-                case USB_HID_REPORT_TAG_USAGE_MINIMUM:
-
-                        usb_log_debug("USAGE_MINIMUM (SIZE: %d), data[0](%x), data[1](%x), data[2](%x) data[3](%x)\n",
-                                      item_size, *data, *(data+1), *(data+2), *(data+3));
-                        
+                case USB_HID_REPORT_TAG_USAGE_MINIMUM:                  
                         if (item_size == 3) {
                                 // usage extended usages
@@ -581 +587 @@
                 case USB_HID_REPORT_TAG_USAGE_MAXIMUM:
                         if (item_size == 3) {
+
+                                if(report_item->extended_usage_page != ((usb_hid_report_tag_data_uint32(data,item_size) & 0xFF00) >> 16)) {
+                                        return EINVAL;
+                                }
+                                
                                 // usage extended usages
                                 report_item->extended_usage_page = (usb_hid_report_tag_data_uint32(data,item_size) & 0xFF00) >> 16; 
@@ -588 +599 @@
                                 report_item->usage_maximum = usb_hid_report_tag_data_uint32(data,item_size);
                         }
+
+                        // vlozit zaznamy do pole usages
+                        int32_t i;
+                        for(i=report_item->usage_minimum; i<=report_item->usage_maximum; i++) {
+                                if(report_item->extended_usage_page) {
+                                        report_item->usages[report_item->usages_count++] = (report_item->extended_usage_page << 16) + i;
+                                }
+                                else {
+                                        report_item->usages[report_item->usages_count++] = i;
+                                }
+                        }
+                        report_item->extended_usage_page = 0;
+                        
                         break;
                 case USB_HID_REPORT_TAG_DESIGNATOR_INDEX:
@@ -660 +684 @@
 
                 usb_log_debug("\t\tOFFSET: %X\n", report_item->offset);
-                usb_log_debug("\t\tSIZE: %X\n", report_item->size);                             
+                usb_log_debug("\t\tSIZE: %zu\n", report_item->size);                            
                 usb_log_debug("\t\tLOGMIN: %d\n", report_item->logical_minimum);
                 usb_log_debug("\t\tLOGMAX: %d\n", report_item->logical_maximum);                
@@ -699 +723 @@
                 usb_log_debug("Report ID: %d\n", report_des->report_id);
                 usb_log_debug("\tType: %d\n", report_des->type);
-                usb_log_debug("\tLength: %d\n", report_des->bit_length);                
-                usb_log_debug("\tItems: %d\n", report_des->item_length);                
+                usb_log_debug("\tLength: %zu\n", report_des->bit_length);               
+                usb_log_debug("\tItems: %zu\n", report_des->item_length);               
 
                 usb_hid_descriptor_print_list(&report_des->report_items);

uspace/lib/usb/src/hidparser.c

@@ -138 +138 @@
                                 // array
                                 item->value = usb_hid_translate_data(item, data);
-                            item->usage = (item->value - item->physical_minimum) + item->usage_minimum;
+                
+                                item->usage = USB_HID_EXTENDED_USAGE(item->usages[item->value - item->physical_minimum]);
+                                item->usage_page = USB_HID_EXTENDED_USAGE_PAGE(item->usages[item->value - item->physical_minimum]);
+
                         }
                         else {

uspace/lib/usb/src/host.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2010 Vojtech Horky
+ * Copyright (c) 2011 Vojtech Horky
  * All rights reserved.
  *
@@ -27 +27 @@
  */
 
-/** @addtogroup usbvirtkbd
+/** @addtogroup libusb
  * @{
  */
-/** @file
- * @brief USB keyboard configuration.
+/**
+ * @file
+ * Host controller common functions (implementation).
  */
-#ifndef VUK_KBDCONFIG_H_
-#define VUK_KBDCONFIG_H_
+#include <stdio.h>
+#include <str_error.h>
+#include <errno.h>
+#include <assert.h>
+#include <bool.h>
+#include <usb/host.h>
+#include <usb/descriptor.h>
+#include <devman.h>
 
-#include <usb/descriptor.h>
-#include "report.h"
-#include "descriptor.h"
+/** Get host controller handle by its class index.
+ *
+ * @param class_index Class index for the host controller.
+ * @param hc_handle Where to store the HC handle
+ *      (can be NULL for existence test only).
+ * @return Error code.
+ */
+int usb_ddf_get_hc_handle_by_class(size_t class_index,
+    devman_handle_t *hc_handle)
+{
+        char *class_index_str;
+        devman_handle_t hc_handle_tmp;
+        int rc;
 
-extern usb_standard_device_descriptor_t std_device_descriptor;
+        rc = asprintf(&class_index_str, "%zu", class_index);
+        if (rc < 0) {
+                return ENOMEM;
+        }
+        rc = devman_device_get_handle_by_class("usbhc", class_index_str,
+            &hc_handle_tmp, 0);
+        free(class_index_str);
+        if (rc != EOK) {
+                return rc;
+        }
 
-extern usb_standard_configuration_descriptor_t std_configuration_descriptor;
+        if (hc_handle != NULL) {
+                *hc_handle = hc_handle_tmp;
+        }
 
-extern usb_standard_interface_descriptor_t std_interface_descriptor;
+        return EOK;
+}
 
-extern usb_standard_endpoint_descriptor_t endpoint_descriptor;
-
-
-extern hid_descriptor_t hid_descriptor;
-
-extern report_descriptor_data_t report_descriptor;
-extern size_t report_descriptor_size;
-
-
-#endif
-/**
- * @}
+/** @}
  */

uspace/lib/usbvirt/Makefile

@@ -33 +33 @@
 
 SOURCES = \
-        src/ipc.c \
         src/ctrltransfer.c \
+        src/device.c \
+        src/ipc_dev.c \
+        src/ipc_hc.c \
         src/stdreq.c \
         src/transfer.c

uspace/lib/usbvirt/include/usbvirt/device.h

@@ -31 +31 @@
  */
 /** @file
- * @brief Virtual USB device.
+ * Virtual USB device.
  */
 #ifndef LIBUSBVIRT_DEVICE_H_
@@ -39 +39 @@
 #include <usb/request.h>
 
+/** Maximum number of endpoints supported by virtual USB. */
 #define USBVIRT_ENDPOINT_MAX 16
 
 typedef struct usbvirt_device usbvirt_device_t;
 
-typedef int (*usbvirt_on_data_to_device_t)(usbvirt_device_t *, usb_endpoint_t,
-    usb_transfer_type_t, void *, size_t);
-typedef int (*usbvirt_on_data_from_device_t)(usbvirt_device_t *, usb_endpoint_t,
-    usb_transfer_type_t, void *, size_t, size_t *);
-typedef int (*usbvirt_on_control_t)(usbvirt_device_t *,
-    const usb_device_request_setup_packet_t *, uint8_t *, size_t *);
-
-typedef struct {
+/** Callback for data to device (OUT transaction).
+ *
+ * @param dev Virtual device to which the transaction belongs.
+ * @param endpoint Target endpoint number.
+ * @param transfer_type Transfer type.
+ * @param buffer Data buffer.
+ * @param buffer_size Size of the buffer in bytes.
+ * @return Error code.
+ */
+typedef int (*usbvirt_on_data_to_device_t)(usbvirt_device_t *dev,
+    usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
+    void *buffer, size_t buffer_size);
+
+/** Callback for data from device (IN transaction).
+ *
+ * @param dev Virtual device to which the transaction belongs.
+ * @param endpoint Target endpoint number.
+ * @param transfer_type Transfer type.
+ * @param buffer Data buffer to write answer to.
+ * @param buffer_size Size of the buffer in bytes.
+ * @param act_buffer_size Write here how many bytes were actually written.
+ * @return Error code.
+ */
+typedef int (*usbvirt_on_data_from_device_t)(usbvirt_device_t *dev,
+    usb_endpoint_t endpoint, usb_transfer_type_t transfer_type,
+    void *buffer, size_t buffer_size, size_t *act_buffer_size);
+
+/** Callback for control transfer on endpoint zero.
+ *
+ * Notice that size of the data buffer is expected to be read from the
+ * setup packet.
+ *
+ * @param dev Virtual device to which the transaction belongs.
+ * @param setup_packet Standard setup packet.
+ * @param data Data (might be NULL).
+ * @param act_data_size Size of returned data in bytes.
+ * @return Error code.
+ */
+typedef int (*usbvirt_on_control_t)(usbvirt_device_t *dev,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_data_size);
+
+/** Callback for control request on a virtual USB device.
+ *
+ * See usbvirt_control_reply_helper() for simple way of answering
+ * control read requests.
+ */
+typedef struct {
+        /** Request direction (in or out). */
         usb_direction_t req_direction;
+        /** Request recipient (device, interface or endpoint). */
         usb_request_recipient_t req_recipient;
+        /** Request type (standard, class or vendor). */
         usb_request_type_t req_type;
+        /** Actual request code. */
         uint8_t request;
+        /** Request handler name for debugging purposes. */
         const char *name;
+        /** Callback to be executed on matching request. */
         usbvirt_on_control_t callback;
 } usbvirt_control_request_handler_t;
@@ -77 +124 @@
 } usbvirt_device_configuration_t;
 
-/** Standard USB descriptors. */
+/** Standard USB descriptors for virtual device. */
 typedef struct {
         /** Standard device descriptor.
@@ -102 +149 @@
 } usbvirt_device_state_t;
 
-typedef struct {
+/** Ops structure for virtual USB device. */
+typedef struct {
+        /** Callbacks for data to device.
+         * Index zero is ignored.
+         */
         usbvirt_on_data_to_device_t data_out[USBVIRT_ENDPOINT_MAX];
+        /** Callbacks for data from device.
+         * Index zero is ignored.
+         */
         usbvirt_on_data_from_device_t data_in[USBVIRT_ENDPOINT_MAX];
+        /** Array of control handlers.
+         * Last handler is expected to have the @c callback field set to NULL
+         */
         usbvirt_control_request_handler_t *control;
+        /** Callback when device changes state.
+         *
+         * The value of @c state attribute of @p dev device is not
+         * defined during call of this function.
+         *
+         * @param dev The virtual USB device.
+         * @param old_state Old device state.
+         * @param new_state New device state.
+         */
         void (*state_changed)(usbvirt_device_t *dev,
             usbvirt_device_state_t old_state, usbvirt_device_state_t new_state);
 } usbvirt_device_ops_t;
 
+/** Virtual USB device. */
 struct usbvirt_device {
+        /** Name for debugging purposes. */
         const char *name;
+        /** Custom device data. */
         void *device_data;
+        /** Device ops. */
         usbvirt_device_ops_t *ops;
+        /** Device descriptors. */
         usbvirt_descriptors_t *descriptors;
+        /** Current device address.
+         * You shall treat this field as read only in your code.
+         */
         usb_address_t address;
+        /** Current device state.
+         * You shall treat this field as read only in your code.
+         */
         usbvirt_device_state_t state;
+        /** Phone to the host controller.
+         * You shall treat this field as read only in your code.
+         */
+        int vhc_phone;
 };
 
 int usbvirt_device_plug(usbvirt_device_t *, const char *);
+void usbvirt_device_unplug(usbvirt_device_t *);
 
 void usbvirt_control_reply_helper(const usb_device_request_setup_packet_t *,

uspace/lib/usbvirt/include/usbvirt/ipc.h

@@ -1 +1 @@
 /*
- * Copyright (c) 2010 Vojtech Horky
+ * Copyright (c) 2011 Vojtech Horky
  * All rights reserved.
  *
@@ -31 +31 @@
  */
 /** @file
- * @brief Virtual USB device.
+ * IPC wrappers for virtual USB.
  */
 #ifndef LIBUSBVIRT_IPC_H_
@@ -40 +40 @@
 #include <bool.h>
 
+/** IPC methods communication between host controller and virtual device. */
 typedef enum {
         IPC_M_USBVIRT_GET_NAME = IPC_FIRST_USER_METHOD + 80,
@@ -45 +46 @@
         IPC_M_USBVIRT_CONTROL_WRITE,
         IPC_M_USBVIRT_INTERRUPT_IN,
-        IPC_M_USBVIRT_INTERRUPT_OUT
-} usbvirt_ipc_t;
+        IPC_M_USBVIRT_INTERRUPT_OUT,
+        IPC_M_USBVIRT_BULK_IN,
+        IPC_M_USBVIRT_BULK_OUT
+} usbvirt_hc_to_device_method_t;
 
-int usbvirt_ipc_send_control_read(int, usb_endpoint_t, void *, size_t,
+int usbvirt_ipc_send_control_read(int, void *, size_t,
     void *, size_t, size_t *);
-int usbvirt_ipc_send_control_write(int, usb_endpoint_t, void *, size_t,
+int usbvirt_ipc_send_control_write(int, void *, size_t,
     void *, size_t);
 int usbvirt_ipc_send_data_in(int, usb_endpoint_t, usb_transfer_type_t,

uspace/lib/usbvirt/src/ctrltransfer.c

@@ +1 @@
+/*
+ * Copyright (c) 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.
+ */
+
+/** @addtogroup libusbvirt
+ * @{
+ */
+/** @file
+ * Control transfer handling.
+ */
 #include "private.h"
 #include <usb/request.h>
@@ -5 +39 @@
 #include <errno.h>
 
+/** Find and execute control transfer handler for virtual USB device.
+ *
+ * @param dev Target virtual device.
+ * @param control_handlers Array of control request handlers.
+ * @param setup Setup packet.
+ * @param data Extra data.
+ * @param data_sent_size Size of extra data in bytes.
+ * @return Error code.
+ * @retval EFORWARD No suitable handler found.
+ */
 int process_control_transfer(usbvirt_device_t *dev,
     usbvirt_control_request_handler_t *control_handlers,
@@ -52 +96 @@
         return EFORWARD;
 }
+
+
+/**
+ * @}
+ */

uspace/lib/usbvirt/src/private.h

@@ +1 @@
+/*
+ * Copyright (c) 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.
+ */
+
+/** @addtogroup libusbvirt
+ * @{
+ */
+/** @file
+ * Private definitions.
+ */
+#ifndef USBVIRT_PRIVATE_H_
+#define USBVIRT_PRIVATE_H_
+
 #include <usbvirt/device.h>
 
@@ -7 +44 @@
 
 extern usbvirt_control_request_handler_t library_handlers[];
+
+#endif
+/**
+ * @}
+ */

uspace/lib/usbvirt/src/stdreq.c

@@ +1 @@
+/*
+ * Copyright (c) 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.
+ */
+
+/** @addtogroup libusbvirt
+ * @{
+ */
+/** @file
+ * Standard control request handlers.
+ */
 #include "private.h"
 #include <usb/request.h>
@@ -4 +38 @@
 #include <errno.h>
 
+/** Helper for replying to control read transfer from virtual USB device.
+ *
+ * This function takes care of copying data to answer buffer taking care
+ * of buffer sizes properly.
+ *
+ * @param setup_packet The setup packet.
+ * @param data Data buffer to write to.
+ * @param act_size Where to write actual size of returned data.
+ * @param actual_data Data to be returned.
+ * @param actual_data_size Size of answer data (@p actual_data) in bytes.
+ */
 void usbvirt_control_reply_helper(const usb_device_request_setup_packet_t *setup_packet,
     uint8_t *data, size_t *act_size,
@@ -144 +189 @@
 }
 
+/** Standard request handlers. */
 usbvirt_control_request_handler_t library_handlers[] = {
         {
@@ -173 +219 @@
 };
 
+/**
+ * @}
+ */

uspace/lib/usbvirt/src/transfer.c

@@ -31 +31 @@
  */
 /** @file
- *
+ * Transfer handling.
  */
 #include <usbvirt/device.h>
@@ -39 +39 @@
 #include "private.h"
 
+/** Process a control transfer to the virtual USB device.
+ *
+ * @param dev Target device.
+ * @param setup Setup packet data.
+ * @param setup_size Size of setup packet.
+ * @param data Extra data (DATA stage).
+ * @param data_size Size of extra data in bytes.
+ * @param data_size_sent Number of actually send bytes during the transfer
+ *      (only used for READ transfers).
+ * @return Error code.
+ */
 static int usbvirt_control_transfer(usbvirt_device_t *dev,
     void *setup, size_t setup_size,
@@ -78 +89 @@
 }
 
+/** Issue a control write transfer to virtual USB device.
+ *
+ * @see usbvirt_control_transfer
+ *
+ * @param dev Target virtual device.
+ * @param setup Setup data.
+ * @param setup_size Size of setup packet.
+ * @param data Extra data (DATA stage).
+ * @param data_size Size of extra data buffer in bytes.
+ * @return Error code.
+ */
 int usbvirt_control_write(usbvirt_device_t *dev, void *setup, size_t setup_size,
     void *data, size_t data_size)
@@ -85 +107 @@
 }
 
+/** Issue a control read transfer to virtual USB device.
+ *
+ * @see usbvirt_control_transfer
+ *
+ * @param dev Target virtual device.
+ * @param setup Setup data.
+ * @param setup_size Size of setup packet.
+ * @param data Extra data (DATA stage).
+ * @param data_size Size of extra data buffer in bytes.
+ * @param data_size_sent Number of actually send bytes during the transfer.
+ * @return Error code.
+ */
 int usbvirt_control_read(usbvirt_device_t *dev, void *setup, size_t setup_size,
     void *data, size_t data_size, size_t *data_size_sent)
@@ -92 +126 @@
 }
 
+/** Send data to virtual USB device.
+ *
+ * @param dev Target virtual device.
+ * @param transf_type Transfer type (interrupt, bulk).
+ * @param endpoint Endpoint number.
+ * @param data Data sent from the driver to the device.
+ * @param data_size Size of the @p data buffer in bytes.
+ * @return Error code.
+ */
 int usbvirt_data_out(usbvirt_device_t *dev, usb_transfer_type_t transf_type,
     usb_endpoint_t endpoint, void *data, size_t data_size)
@@ -108 +151 @@
 }
 
+/** Request data from virtual USB device.
+ *
+ * @param dev Target virtual device.
+ * @param transf_type Transfer type (interrupt, bulk).
+ * @param endpoint Endpoint number.
+ * @param data Where to stored data the device returns to the driver.
+ * @param data_size Size of the @p data buffer in bytes.
+ * @param data_size_sent Number of actually written bytes.
+ * @return Error code.
+ */
 int usbvirt_data_in(usbvirt_device_t *dev, usb_transfer_type_t transf_type,
     usb_endpoint_t endpoint, void *data, size_t data_size, size_t *data_size_sent)