Changeset 5410c04 in mainline for uspace/lib/usb/include/usb/pipes.h

Timestamp:

2011-04-09T16:11:41Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

a9d67aa, c6394aa

Parents:

8e8b84f (diff), 7b715892 (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:

Automatic pipe sessions

It is no longer necessary to start sessions on USB pipes manually.
Actually, the original functions usb_pipe_start/end_session are now
deprecated.

For sporadic transfers, you do not need to care about sessions at all.
For longer transfers, you may hint the library about it by calling
usb_pipe_start_long_transfer.

File:

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

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

@@ -42 +42 @@
 #include <ipc/devman.h>
 #include <ddf/driver.h>
+#include <fibril_synch.h>
 
 /** Abstraction of a physical connection to the device.
@@ -59 +60 @@
  * This endpoint must be bound with existing usb_device_connection_t
  * (i.e. the wire to send data over).
+ *
+ * Locking order: if you want to lock both mutexes
+ * (@c guard and @c hc_phone_mutex), lock @c guard first.
+ * It is not necessary to lock @c guard if you want to lock @c hc_phone_mutex
+ * only.
  */
 typedef struct {
+        /** Guard of the whole pipe. */
+        fibril_mutex_t guard;
+
         /** The connection used for sending the data. */
         usb_device_connection_t *wire;
@@ -78 +87 @@
         /** Phone to the host controller.
          * Negative when no session is active.
+         * It is an error to access this member without @c hc_phone_mutex
+         * being locked.
+         * If call over the phone is to be made, it must be preceeded by
+         * call to pipe_add_ref() [internal libusb function].
          */
         int hc_phone;
+
+        /** Guard for serialization of requests over the phone. */
+        fibril_mutex_t hc_phone_mutex;
+
+        /** Number of active transfers over the pipe. */
+        int refcount;
 } usb_pipe_t;
 
@@ -141 +160 @@
 bool usb_pipe_is_session_started(usb_pipe_t *);
 
+int usb_pipe_start_long_transfer(usb_pipe_t *);
+void usb_pipe_end_long_transfer(usb_pipe_t *);
+
 int usb_pipe_read(usb_pipe_t *, void *, size_t, size_t *);
 int usb_pipe_write(usb_pipe_t *, void *, size_t);