Changeset df6ded8 in mainline for uspace/lib/usbdev/include/usb/dev/poll.h

Timestamp:

2018-02-28T16:37:50Z (6 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

1b20da0

Parents:

f5e5f73 (diff), b2dca8de (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.

git-author:

Jakub Jermar <jakub@…> (2018-02-28 16:06:42)

git-committer:

Jakub Jermar <jakub@…> (2018-02-28 16:37:50)

Message:

Merge github.com:helenos-xhci-team/helenos

This commit merges support for USB 3 and generally refactors, fixes,
extends and cleans up the existing USB framework.

Notable additions and features:

• new host controller driver has been implemented to control various xHC models (among others, NEC Renesas uPD720200)
• isochronous data transfer mode
• support for explicit USB device removal
• USB tablet driver

File:

• uspace/lib/usbdev/include/usb/dev/poll.h (modified) (5 diffs)

uspace/lib/usbdev/include/usb/dev/poll.h

@@ -1 +1 @@
 /*
  * Copyright (c) 2011 Vojtech Horky
+ * Copyright (c) 2017 Petr Manek
  * All rights reserved.
  *
@@ -43 +44 @@
 #include <stddef.h>
 #include <stdint.h>
+#include <fibril_synch.h>
 
-/** Parameters and callbacks for automated polling. */
-typedef struct {
-        /** Level of debugging messages from auto polling.
-         * 0 - nothing
-         * 1 - inform about errors and polling start/end
-         * 2 - also dump every retrieved buffer
+
+/** USB automated polling. */
+typedef struct usb_polling {
+        /** Mandatory parameters - user is expected to configure these. */
+
+        /** USB device to poll. */
+        usb_device_t *device;
+
+        /** Device enpoint mapping to use for polling. */
+        usb_endpoint_mapping_t *ep_mapping;
+
+        /** Size of the recieved data. */
+        size_t request_size;
+
+        /**
+         * Data buffer of at least `request_size`. User is responsible for its
+         * allocation.
          */
-        int debug;
-        /** Maximum number of consecutive errors before polling termination. */
-        size_t max_failures;
-        /** Delay between poll requests in milliseconds.
-         * Set to negative value to use value from endpoint descriptor.
-         */
-        int delay;
-        /** Whether to automatically try to clear the HALT feature after
-         * the endpoint stalls.
-         */
-        bool auto_clear_halt;
+        uint8_t *buffer;
+
         /** Callback when data arrives.
          *
@@ -72 +76 @@
         bool (*on_data)(usb_device_t *dev, uint8_t *data, size_t data_size,
             void *arg);
+
+
+        /**
+         * Optional parameters - user can customize them, but they are
+         * defaulted to  some reasonable values.
+         */
+
+        /** Level of debugging messages from auto polling.
+         * 0 - nothing (default)
+         * 1 - inform about errors and polling start/end
+         * 2 - also dump every retrieved buffer
+         */
+        int debug;
+
+        /**
+         * Maximum number of consecutive errors before polling termination
+         * (default 3).
+         */
+        size_t max_failures;
+
+        /** Delay between poll requests in milliseconds.
+         * By default, value from endpoint descriptor used.
+         */
+        int delay;
+
+        /** Whether to automatically try to clear the HALT feature after
+         * the endpoint stalls (true by default).
+         */
+        bool auto_clear_halt;
+
+        /** Argument to pass to callbacks (default NULL). */
+        void *arg;
+
         /** Callback when polling is terminated.
          *
@@ -80 +117 @@
         void (*on_polling_end)(usb_device_t *dev, bool due_to_errors,
             void *arg);
+
         /** Callback when error occurs.
          *
@@ -88 +126 @@
          */
         bool (*on_error)(usb_device_t *dev, errno_t err_code, void *arg);
-        /** Argument to pass to callbacks. */
-        void *arg;
-} usb_device_auto_polling_t;
 
-typedef bool (*usb_polling_callback_t)(usb_device_t *, uint8_t *, size_t, void *);
-typedef void (*usb_polling_terminted_callback_t)(usb_device_t *, bool, void *);
 
-extern errno_t usb_device_auto_polling(usb_device_t *, usb_endpoint_t,
-    const usb_device_auto_polling_t *, size_t);
+        /**
+         * Internal parameters - user is not expected to set them. Messing with
+         * them can result in unexpected behavior if you do not know what you
+         * are doing.
+         */
 
-extern errno_t usb_device_auto_poll(usb_device_t *, usb_endpoint_t,
-    usb_polling_callback_t, size_t, int, usb_polling_terminted_callback_t, void *);
+        /** Fibril used for polling. */
+        fid_t fibril;
 
-extern errno_t usb_device_auto_polling_desc(usb_device_t *,
-    const usb_endpoint_description_t *, const usb_device_auto_polling_t *,
-    size_t);
+        /** True if polling is currently in operation. */
+        volatile bool running;
 
-extern errno_t usb_device_auto_poll_desc(usb_device_t *,
-    const usb_endpoint_description_t *, usb_polling_callback_t, size_t, int,
-    usb_polling_terminted_callback_t, void *);
+        /** True if polling should terminate as soon as possible. */
+        volatile bool joining;
+
+        /** Synchronization primitives for joining polling end. */
+        fibril_mutex_t guard;
+        fibril_condvar_t cv;
+} usb_polling_t;
+
+errno_t usb_polling_init(usb_polling_t *);
+void usb_polling_fini(usb_polling_t *);
+
+errno_t usb_polling_start(usb_polling_t *);
+errno_t usb_polling_join(usb_polling_t *);
 
 #endif