Changeset 41ef5b9 in mainline for uspace/lib/usb/include

Timestamp:

2011-03-21T17:16:10Z (15 years ago)

Author:

Matus Dekanek <smekideki@…>

Branches:

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

Children:

4d0c40b

Parents:

fd9f6e4c (diff), 434ef65 (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:

merge from usb/development

Location:

uspace/lib/usb/include/usb

Files:

• classes/hub.h (modified) (1 diff)
• devdrv.h (modified) (2 diffs)
• host/batch.h (added)
• host/device_keeper.h (moved) (moved from uspace/drv/uhci-hcd/utils/device_keeper.h ) (1 diff)
• pipes.h (modified) (3 diffs)
• recognise.h (modified) (1 diff)
• request.h (modified) (1 diff)
• usb.h (modified) (2 diffs)

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

@@ -60 +60 @@
 } usb_hub_class_feature_t;
 
+/** Header of standard hub descriptor without the "variadic" part. */
+typedef struct {
+        /** Descriptor length. */
+        uint8_t length;
+        /** Descriptor type (0x29). */
+        uint8_t descriptor_type;
+        /** Number of downstream ports. */
+        uint8_t port_count;
+        /** Characteristics bitmask. */
+        uint16_t characteristics;
+        /** Time from power-on to stabilization of current on the port. */
+        uint8_t power_good_time;
+        /** Maximum current requirements in mA. */
+        uint8_t max_current;
+} __attribute__ ((packed)) usb_hub_descriptor_header_t;
 
 /**

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

@@ -38 +38 @@
 #include <usb/pipes.h>
 
+/** Descriptors for USB device. */
+typedef struct {
+        /** Standard device descriptor. */
+        usb_standard_device_descriptor_t device;
+        /** Full configuration descriptor of current configuration. */
+        uint8_t *configuration;
+        size_t configuration_size;
+} usb_device_descriptors_t;
+
 /** USB device structure. */
 typedef struct {
         /** The default control pipe. */
-        usb_endpoint_pipe_t ctrl_pipe;
+        usb_pipe_t ctrl_pipe;
         /** Other endpoint pipes.
          * This is an array of other endpoint pipes in the same order as
@@ -52 +61 @@
          */
         int interface_no;
+
+        /** Some useful descriptors. */
+        usb_device_descriptors_t descriptors;
+
         /** Generic DDF device backing this one. */
         ddf_dev_t *ddf_dev;

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

@@ -27 +27 @@
  */
 
-/** @addtogroup drvusbuhcihc
+/** @addtogroup libusb
  * @{
  */
 /** @file
- * @brief UHCI driver
+ * Device keeper structure and functions.
+ *
+ * Typical USB host controller needs to keep track of various settings for
+ * each device that is connected to it.
+ * State of toggle bit, device speed etc. etc.
+ * This structure shall simplify the management.
  */
-#ifndef UTILS_DEVICE_KEEPER_H
-#define UTILS_DEVICE_KEEPER_H
+#ifndef LIBUSB_HOST_DEVICE_KEEPER_H
+#define LIBUSB_HOST_DEVICE_KEEPER_H
 #include <devman.h>
 #include <fibril_synch.h>
 #include <usb/usb.h>
 
+/** Number of USB address for array dimensions. */
 #define USB_ADDRESS_COUNT (USB11_ADDRESS_MAX + 1)
 
+/** Information about attached USB device. */
 struct usb_device_info {
         usb_speed_t speed;
         bool occupied;
-        uint16_t toggle_status;
+        uint16_t toggle_status[2];
         devman_handle_t handle;
 };
 
-typedef struct device_keeper {
+/** Host controller device keeper.
+ * You shall not access members directly but only using functions below.
+ */
+typedef struct {
         struct usb_device_info devices[USB_ADDRESS_COUNT];
         fibril_mutex_t guard;
         fibril_condvar_t default_address_occupied;
         usb_address_t last_address;
-} device_keeper_t;
+} usb_device_keeper_t;
 
-void device_keeper_init(device_keeper_t *instance);
+void usb_device_keeper_init(usb_device_keeper_t *instance);
 
-void device_keeper_reserve_default(
-    device_keeper_t *instance, usb_speed_t speed);
+void usb_device_keeper_reserve_default_address(usb_device_keeper_t *instance,
+    usb_speed_t speed);
 
-void device_keeper_release_default(device_keeper_t *instance);
+void usb_device_keeper_release_default_address(usb_device_keeper_t *instance);
 
-void device_keeper_reset_if_need(
-    device_keeper_t *instance, usb_target_t target, const unsigned char *setup_data);
+void usb_device_keeper_reset_if_need(usb_device_keeper_t *instance,
+    usb_target_t target,
+    const uint8_t *setup_data);
 
-int device_keeper_get_toggle(device_keeper_t *instance, usb_target_t target);
+int usb_device_keeper_get_toggle(usb_device_keeper_t *instance,
+    usb_target_t target, usb_direction_t direction);
 
-int device_keeper_set_toggle(
-    device_keeper_t *instance, usb_target_t target, bool toggle);
+int usb_device_keeper_set_toggle(usb_device_keeper_t *instance,
+    usb_target_t target, usb_direction_t direction, bool toggle);
 
-usb_address_t device_keeper_request(
-    device_keeper_t *instance, usb_speed_t speed);
+usb_address_t device_keeper_get_free_address(usb_device_keeper_t *instance,
+    usb_speed_t speed);
 
-void device_keeper_bind(
-    device_keeper_t *instance, usb_address_t address, devman_handle_t handle);
+void usb_device_keeper_bind(usb_device_keeper_t *instance,
+    usb_address_t address, devman_handle_t handle);
 
-void device_keeper_release(device_keeper_t *instance, usb_address_t address);
+void usb_device_keeper_release(usb_device_keeper_t *instance,
+    usb_address_t address);
 
-usb_address_t device_keeper_find(
-    device_keeper_t *instance, devman_handle_t handle);
+usb_address_t usb_device_keeper_find(usb_device_keeper_t *instance,
+    devman_handle_t handle);
 
-usb_speed_t device_keeper_speed(
-    device_keeper_t *instance, usb_address_t address);
+usb_speed_t usb_device_keeper_get_speed(usb_device_keeper_t *instance,
+    usb_address_t address);
+
 #endif
 /**

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

@@ -80 +80 @@
          */
         int hc_phone;
-} usb_endpoint_pipe_t;
+} usb_pipe_t;
 
 
@@ -102 +102 @@
 typedef struct {
         /** Endpoint pipe. */
-        usb_endpoint_pipe_t *pipe;
+        usb_pipe_t *pipe;
         /** Endpoint description. */
         const usb_endpoint_description_t *description;
@@ -125 +125 @@
 usb_address_t usb_device_get_assigned_address(devman_handle_t);
 
-int usb_endpoint_pipe_initialize(usb_endpoint_pipe_t *,
-    usb_device_connection_t *,
+int usb_pipe_initialize(usb_pipe_t *, usb_device_connection_t *,
     usb_endpoint_t, usb_transfer_type_t, size_t, usb_direction_t);
-int usb_endpoint_pipe_initialize_default_control(usb_endpoint_pipe_t *,
+int usb_pipe_initialize_default_control(usb_pipe_t *,
     usb_device_connection_t *);
-int usb_endpoint_pipe_probe_default_control(usb_endpoint_pipe_t *);
-int usb_endpoint_pipe_initialize_from_configuration(usb_endpoint_mapping_t *,
+int usb_pipe_probe_default_control(usb_pipe_t *);
+int usb_pipe_initialize_from_configuration(usb_endpoint_mapping_t *,
     size_t, uint8_t *, size_t, usb_device_connection_t *);
-int usb_endpoint_pipe_register(usb_endpoint_pipe_t *, unsigned int,
-    usb_hc_connection_t *);
-int usb_endpoint_pipe_unregister(usb_endpoint_pipe_t *, usb_hc_connection_t *);
+int usb_pipe_register(usb_pipe_t *, unsigned int, usb_hc_connection_t *);
+int usb_pipe_unregister(usb_pipe_t *, usb_hc_connection_t *);
 
-int usb_endpoint_pipe_start_session(usb_endpoint_pipe_t *);
-int usb_endpoint_pipe_end_session(usb_endpoint_pipe_t *);
-bool usb_endpoint_pipe_is_session_started(usb_endpoint_pipe_t *);
+int usb_pipe_start_session(usb_pipe_t *);
+int usb_pipe_end_session(usb_pipe_t *);
+bool usb_pipe_is_session_started(usb_pipe_t *);
 
-int usb_endpoint_pipe_read(usb_endpoint_pipe_t *, void *, size_t, size_t *);
-int usb_endpoint_pipe_write(usb_endpoint_pipe_t *, void *, size_t);
+int usb_pipe_read(usb_pipe_t *, void *, size_t, size_t *);
+int usb_pipe_write(usb_pipe_t *, void *, size_t);
 
-int usb_endpoint_pipe_control_read(usb_endpoint_pipe_t *, void *, size_t,
+int usb_pipe_control_read(usb_pipe_t *, void *, size_t,
     void *, size_t, size_t *);
-int usb_endpoint_pipe_control_write(usb_endpoint_pipe_t *, void *, size_t,
+int usb_pipe_control_write(usb_pipe_t *, void *, size_t,
     void *, size_t);
 

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

@@ -48 +48 @@
     const usb_standard_interface_descriptor_t *, match_id_list_t *);
 
-int usb_device_create_match_ids(usb_endpoint_pipe_t *, match_id_list_t *);
+int usb_device_create_match_ids(usb_pipe_t *, match_id_list_t *);
 
 int usb_device_register_child_in_devman(usb_address_t, devman_handle_t,

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

@@ -86 +86 @@
 } __attribute__ ((packed)) usb_device_request_setup_packet_t;
 
-int usb_control_request_set(usb_endpoint_pipe_t *,
+int usb_control_request_set(usb_pipe_t *,
     usb_request_type_t, usb_request_recipient_t, uint8_t,
     uint16_t, uint16_t, void *, size_t);
 
-int usb_control_request_get(usb_endpoint_pipe_t *,
+int usb_control_request_get(usb_pipe_t *,
     usb_request_type_t, usb_request_recipient_t, uint8_t,
     uint16_t, uint16_t, void *, size_t, size_t *);
 
-int usb_request_set_address(usb_endpoint_pipe_t *, usb_address_t);
-int usb_request_get_descriptor(usb_endpoint_pipe_t *, usb_request_type_t,
+int usb_request_get_status(usb_pipe_t *, usb_request_recipient_t,
+    uint16_t, uint16_t *);
+int usb_request_clear_feature(usb_pipe_t *, usb_request_type_t,
+    usb_request_recipient_t, uint16_t, uint16_t);
+int usb_request_set_feature(usb_pipe_t *, usb_request_type_t,
+    usb_request_recipient_t, uint16_t, uint16_t);
+int usb_request_set_address(usb_pipe_t *, usb_address_t);
+int usb_request_get_descriptor(usb_pipe_t *, usb_request_type_t,
     usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void *, size_t, 
     size_t *);
-int usb_request_get_descriptor_alloc(usb_endpoint_pipe_t *, usb_request_type_t,
+int usb_request_get_descriptor_alloc(usb_pipe_t *, usb_request_type_t,
     usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void **, size_t *);
-int usb_request_get_device_descriptor(usb_endpoint_pipe_t *,
+int usb_request_get_device_descriptor(usb_pipe_t *,
     usb_standard_device_descriptor_t *);
-int usb_request_get_bare_configuration_descriptor(usb_endpoint_pipe_t *, int,
+int usb_request_get_bare_configuration_descriptor(usb_pipe_t *, int,
     usb_standard_configuration_descriptor_t *);
-int usb_request_get_full_configuration_descriptor(usb_endpoint_pipe_t *, int,
+int usb_request_get_full_configuration_descriptor(usb_pipe_t *, int,
     void *, size_t, size_t *);
-int usb_request_get_full_configuration_descriptor_alloc(usb_endpoint_pipe_t *,
+int usb_request_get_full_configuration_descriptor_alloc(usb_pipe_t *,
     int, void **, size_t *);
-int usb_request_set_configuration(usb_endpoint_pipe_t *, uint8_t);
+int usb_request_set_descriptor(usb_pipe_t *, usb_request_type_t,
+    usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void *, size_t);
+int usb_request_get_configuration(usb_pipe_t *, uint8_t *);
+int usb_request_set_configuration(usb_pipe_t *, uint8_t);
+int usb_request_get_interface(usb_pipe_t *, uint8_t, uint8_t *);
+int usb_request_set_interface(usb_pipe_t *, uint8_t, uint8_t);
 
-int usb_request_get_supported_languages(usb_endpoint_pipe_t *,
+int usb_request_get_supported_languages(usb_pipe_t *,
     l18_win_locales_t **, size_t *);
-int usb_request_get_string(usb_endpoint_pipe_t *, size_t, l18_win_locales_t,
+int usb_request_get_string(usb_pipe_t *, size_t, l18_win_locales_t,
     char **);
 

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

@@ -61 +61 @@
 
 const char * usb_str_transfer_type(usb_transfer_type_t t);
+const char * usb_str_transfer_type_short(usb_transfer_type_t t);
 
 /** USB data transfer direction. */
@@ -78 +79 @@
         USB_SPEED_HIGH
 } usb_speed_t;
+
+const char *usb_str_speed(usb_speed_t);
+
 
 /** USB request type target. */