Changes in uspace/lib/drv/include/usbhc_iface.h [6427cf67:9753220] in mainline

File:

• uspace/lib/drv/include/usbhc_iface.h (modified) (5 diffs)

uspace/lib/drv/include/usbhc_iface.h

@@ -40 +40 @@
 #include "driver.h"
 #include <usb/usb.h>
-#include <bool.h>
 
 
@@ -67 +66 @@
  *   - argument #2 is target endpoint
  *   - argument #3 is buffer size
- * - this call is immediately followed by IPC data read (async version)
  * - the call is not answered until the device returns some data (or until
  *   error occurs)
+ * - if the call is answered with EOK, first argument of the answer is buffer
+ *   hash that could be used to retrieve the actual data
  *
  * Some special methods (NO-DATA transactions) do not send any data. These
  * might behave as both OUT or IN transactions because communication parts
  * where actual buffers are exchanged are omitted.
- **
+ *
+ * The mentioned data retrieval can be done any time after receiving EOK
+ * answer to IN method.
+ * This retrieval is done using the IPC_M_USBHC_GET_BUFFER where
+ * the first argument is buffer hash from call answer.
+ * This call must be immediately followed by data read-in and after the
+ * data are transferred, the initial call (IPC_M_USBHC_GET_BUFFER)
+ * is answered. Each buffer can be retrieved only once.
+ *
  * For all these methods, wrap functions exists. Important rule: functions
  * for IN transactions have (as parameters) buffers where retrieved data
@@ -96 +104 @@
         IPC_M_USBHC_GET_ADDRESS,
 
+        /** Asks for data buffer.
+         * See explanation at usb_iface_funcs_t.
+         * This function does not have counter part in functional interface
+         * as it is handled by the remote part itself.
+         */
+        IPC_M_USBHC_GET_BUFFER,
+
 
         /** Reserve usage of default address.
@@ -208 +223 @@
 /** Callback for outgoing transfer. */
 typedef void (*usbhc_iface_transfer_out_callback_t)(device_t *,
-    int, void *);
+    usb_transaction_outcome_t, void *);
 
 /** Callback for incoming transfer. */
 typedef void (*usbhc_iface_transfer_in_callback_t)(device_t *,
-    int, size_t, void *);
+    usb_transaction_outcome_t, size_t, void *);
 
 
@@ -232 +247 @@
         int (*tell_address)(device_t *, devman_handle_t, usb_address_t *);
 
-        int (*reserve_default_address)(device_t *, bool);
+        int (*reserve_default_address)(device_t *);
         int (*release_default_address)(device_t *);
-        int (*request_address)(device_t *, bool, usb_address_t *);
+        int (*request_address)(device_t *, usb_address_t *);
         int (*bind_address)(device_t *, usb_address_t, devman_handle_t);
         int (*release_address)(device_t *, usb_address_t);