Changeset 5fd9c30 in mainline for uspace/lib/usbhost/include/usb/host/usb_transfer_batch.h

Timestamp:

2017-10-21T20:52:56Z (8 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

766043c

Parents:

74b852b

Message:

usbhost refactoring: let transfer_batch be initialized by bus

Currently makes older HCs fail, work in progress.

File:

• uspace/lib/usbhost/include/usb/host/usb_transfer_batch.h (modified) (3 diffs)

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

@@ -37 +37 @@
 #define LIBUSBHOST_HOST_USB_TRANSFER_BATCH_H
 
-#include <usb/host/endpoint.h>
 #include <usb/usb.h>
+#include <usb/request.h>
 
-#include <assert.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -47 +46 @@
 #define USB_SETUP_PACKET_SIZE 8
 
+typedef struct endpoint endpoint_t;
+typedef struct bus bus_t;
+typedef struct usb_transfer_batch usb_transfer_batch_t;
+
+/** Callback to be called on transfer. */
+typedef int (*usb_transfer_batch_callback_t)(usb_transfer_batch_t *);
+
 /** Structure stores additional data needed for communication with EP */
 typedef struct usb_transfer_batch {
         /** Endpoint used for communication */
         endpoint_t *ep;
-        /** Function called on completion (IN version) */
-        usbhc_iface_transfer_in_callback_t callback_in;
-        /** Function called on completion (OUT version) */
-        usbhc_iface_transfer_out_callback_t callback_out;
-        /** Argument to pass to the completion function */
-        void *arg;
+        /** Size reported to be sent */
+        size_t expected_size;
+
+        /** Direction of the transfer */
+        usb_direction_t dir;
+
+        /** Function called on completion */
+        usb_transfer_batch_callback_t on_complete;
+        /** Arbitrary data for the handler */
+        void *on_complete_data;
+
+        /** Place to store SETUP data needed by control transfers */
+        union {
+                char buffer [USB_SETUP_PACKET_SIZE];
+                usb_device_request_setup_packet_t packet;
+                uint64_t packed;
+        } setup;
+
+        /** Resetting the Toggle */
+        toggle_reset_mode_t toggle_reset_mode;
+
         /** Place for data to send/receive */
         char *buffer;
         /** Size of memory pointed to by buffer member */
         size_t buffer_size;
-        /** Place to store SETUP data needed by control transfers */
-        char setup_buffer[USB_SETUP_PACKET_SIZE];
-        /** Used portion of setup_buffer member
-         *
-         * SETUP buffer must be 8 bytes for control transfers and is left
-         * unused for all other transfers. Thus, this field is either 0 or 8.
-         */
-        size_t setup_size;
 
-        /** Actually used portion of the buffer
-         * This member is never accessed by functions provided in this header,
-         * with the exception of usb_transfer_batch_finish. For external use.
-         */
+        /** Actually used portion of the buffer */
         size_t transfered_size;
-        /** Indicates success/failure of the communication
-         * This member is never accessed by functions provided in this header,
-         * with the exception of usb_transfer_batch_finish. For external use.
-         */
+        /** Indicates success/failure of the communication */
         int error;
 } usb_transfer_batch_t;
@@ -95 +102 @@
         (batch).buffer_size, (batch).ep->max_packet_size
 
+void usb_transfer_batch_init(usb_transfer_batch_t *, endpoint_t *);
+void usb_transfer_batch_finish(usb_transfer_batch_t *);
 
-usb_transfer_batch_t * usb_transfer_batch_create(
-    endpoint_t *ep,
-    char *buffer,
-    size_t buffer_size,
-    uint64_t setup_buffer,
-    usbhc_iface_transfer_in_callback_t func_in,
-    usbhc_iface_transfer_out_callback_t func_out,
-    void *arg
-);
-void usb_transfer_batch_destroy(const usb_transfer_batch_t *instance);
+usb_transfer_batch_t *usb_transfer_batch_create(endpoint_t *);
+void usb_transfer_batch_destroy(usb_transfer_batch_t *);
 
-void usb_transfer_batch_finish_error(const usb_transfer_batch_t *instance,
-    const void* data, size_t size, int error);
-
-/** Finish batch using stored error value and transferred size.
- *
- * @param[in] instance Batch structure to use.
- * @param[in] data Data to copy to the output buffer.
+/** Provided to ease the transition. Wraps old-style handlers into a new one.
  */
-static inline void usb_transfer_batch_finish(
-    const usb_transfer_batch_t *instance, const void* data)
-{
-        assert(instance);
-        usb_transfer_batch_finish_error(
-            instance, data, instance->transfered_size, instance->error);
-}
-
-/** Determine batch direction based on the callbacks present
- * @param[in] instance Batch structure to use, non-null.
- * @return USB_DIRECTION_IN, or USB_DIRECTION_OUT.
- */
-static inline usb_direction_t usb_transfer_batch_direction(
-    const usb_transfer_batch_t *instance)
-{
-        assert(instance);
-        if (instance->callback_in) {
-                assert(instance->callback_out == NULL);
-                assert(instance->ep == NULL
-                    || instance->ep->transfer_type == USB_TRANSFER_CONTROL
-                    || instance->ep->direction == USB_DIRECTION_IN);
-                return USB_DIRECTION_IN;
-        }
-        if (instance->callback_out) {
-                assert(instance->callback_in == NULL);
-                assert(instance->ep == NULL
-                    || instance->ep->transfer_type == USB_TRANSFER_CONTROL
-                    || instance->ep->direction == USB_DIRECTION_OUT);
-                return USB_DIRECTION_OUT;
-        }
-        assert(false);
-}
+extern void usb_transfer_batch_set_old_handlers(usb_transfer_batch_t *,
+        usbhc_iface_transfer_in_callback_t,
+        usbhc_iface_transfer_out_callback_t, void *);
 
 #endif