Changeset c4e84ed6 in mainline for uspace/drv/bus/usb/usbhub/port.h

Timestamp:

2018-01-16T03:45:38Z (7 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

c952abc4

Parents:

d2c3dcd

git-author:

Ondřej Hlavatý <aearsis@…> (2018-01-15 20:49:15)

git-committer:

Ondřej Hlavatý <aearsis@…> (2018-01-16 03:45:38)

Message:

usbhub: rewrite port handling

The state space of a usb hub port is a bit more complex than what was
there originally. Got rid of the active operations counting, and
replaced that with finite state machine. Fixes a lot of race conditions
and lack of synchronization when connect and disconnect events come very
fast.

File:

• uspace/drv/bus/usb/usbhub/port.h (modified) (3 diffs)

uspace/drv/bus/usb/usbhub/port.h

@@ -2 +2 @@
  * Copyright (c) 2011 Vojtech Horky
  * Copyright (c) 2011 Jan Vesely
+ * Copyright (c) 2017 Ondra Hlavaty
  * All rights reserved.
  *
@@ -32 +33 @@
  */
 /** @file
- * Hub ports related functions.
+ * Hub port state machine.
  */
 
@@ -43 +44 @@
 typedef struct usb_hub_dev usb_hub_dev_t;
 
+typedef enum {
+        PORT_DISABLED,  /* No device connected. */
+        PORT_CONNECTED, /* A device connected, not yet initialized. */
+        PORT_IN_RESET,  /* An initial port reset in progress. */
+        PORT_ENABLED,   /* Port reset complete, port enabled. Device announced to the HC. */
+        PORT_ERROR,     /* An error occured. There is still a fibril that needs to know it. */
+} port_state_t;
+
 /** Information about single port on a hub. */
 typedef struct {
+        /* Parenting hub */
+        usb_hub_dev_t *hub;
+        /** Guarding all fields */
+        fibril_mutex_t guard;
+        /** Current state of the port */
+        port_state_t state;
+        /** A speed of the device connected (if any). Valid unless state == PORT_DISABLED. */
+        usb_speed_t speed;
         /** Port number as reported in descriptors. */
         unsigned int port_number;
-        /** Device communication pipe. */
-        usb_pipe_t *control_pipe;
-        /** Mutex needed not only by CV for checking port reset. */
-        fibril_mutex_t mutex;
         /** CV for waiting to port reset completion. */
-        fibril_condvar_t reset_cv;
-        /** Port reset status.
-         * Guarded by @c reset_mutex.
-         */
-        enum {
-                NO_RESET,
-                IN_RESET,
-                RESET_OK,
-                RESET_FAIL,
-        } reset_status;
-        /** Device reported to USB bus driver */
-        bool device_attached;
+        fibril_condvar_t state_cv;
 } usb_hub_port_t;
 
-/** Initialize hub port information.
- *
- * @param port Port to be initialized.
- */
-static inline void usb_hub_port_init(usb_hub_port_t *port,
-    unsigned int port_number, usb_pipe_t *control_pipe)
-{
-        assert(port);
-        port->port_number = port_number;
-        port->control_pipe = control_pipe;
-        port->reset_status = NO_RESET;
-        port->device_attached = false;
-        fibril_mutex_initialize(&port->mutex);
-        fibril_condvar_initialize(&port->reset_cv);
-}
+void usb_hub_port_init(usb_hub_port_t *, usb_hub_dev_t *, unsigned int);
+void usb_hub_port_fini(usb_hub_port_t *);
 
-int usb_hub_port_fini(usb_hub_port_t *port, usb_hub_dev_t *hub);
-int usb_hub_port_clear_feature(
-    usb_hub_port_t *port, usb_hub_class_feature_t feature);
-int usb_hub_port_set_feature(
-    usb_hub_port_t *port, usb_hub_class_feature_t feature);
-void usb_hub_port_reset_fail(usb_hub_port_t *port);
 void usb_hub_port_process_interrupt(usb_hub_port_t *port, usb_hub_dev_t *hub);