Changeset e34e77a in mainline for uspace/lib/usb/include

Timestamp:

2011-03-21T14:33:50Z (15 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

1387692

Parents:

68b5ed6e

Message:

Formatting and comments

No change in functionality

File:

• uspace/lib/usb/include/usb/host/device_keeper.h (modified) (4 diffs)

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

@@ -31 +31 @@
  */
 /** @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 LIBUSB_HOST_DEVICE_KEEPER_H
@@ -39 +44 @@
 #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;
@@ -48 +55 @@
 };
 
+/** 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];
@@ -57 +67 @@
 void usb_device_keeper_init(usb_device_keeper_t *instance);
 
-void usb_device_keeper_reserve_default_address(
-    usb_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 usb_device_keeper_release_default_address(usb_device_keeper_t *instance);
 
-void usb_device_keeper_reset_if_need(
-    usb_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 usb_device_keeper_get_toggle(
-    usb_device_keeper_t *instance, usb_target_t target, usb_direction_t direction);
+int usb_device_keeper_get_toggle(usb_device_keeper_t *instance,
+    usb_target_t target, usb_direction_t direction);
 
 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_get_free_address(
-    usb_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 usb_device_keeper_bind(
-    usb_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 usb_device_keeper_release(usb_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 usb_device_keeper_find(
-    usb_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 usb_device_keeper_get_speed(
-    usb_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
 /**