Changeset c3d926f in mainline for uspace/drv/bus/usb/xhci/commands.h

Timestamp:

2017-10-25T08:03:13Z (7 years ago)

Author:

Petr Manek <petr.manek@…>

Branches:

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

Children:

a5b3de6

Parents:

0206d35

Message:

Big command refactoring. Unified and encapsulated command function API. Removed explicit heap command (de)allocation functions. Added three functions for (a)synchronous command issuing and neat inline macro with syntax sugar.

File:

• uspace/drv/bus/usb/xhci/commands.h (modified) (3 diffs)

uspace/drv/bus/usb/xhci/commands.h

@@ -42 +42 @@
 #include "hw_struct/trb.h"
 
-/* Useful timeouts for `xhci_cmd_wait()` */
-#define XHCI_DEFAULT_TIMEOUT             1000000
-#define XHCI_BLOCK_INDEFINITELY              0
+#define XHCI_DEFAULT_TIMEOUT       1000000
+#define XHCI_BLOCK_INDEFINITELY    0
 
 typedef struct xhci_hc xhci_hc_t;
@@ -50 +49 @@
 typedef struct xhci_port_bandwidth_ctx xhci_port_bandwidth_ctx_t;
 
+typedef enum xhci_cmd_type {
+        XHCI_CMD_ENABLE_SLOT,
+        XHCI_CMD_DISABLE_SLOT,
+        XHCI_CMD_ADDRESS_DEVICE,
+        XHCI_CMD_CONFIGURE_ENDPOINT,
+        XHCI_CMD_EVALUATE_CONTEXT,
+        XHCI_CMD_RESET_ENDPOINT,
+        XHCI_CMD_STOP_ENDPOINT,
+        XHCI_CMD_SET_TR_DEQUEUE_POINTER,
+        XHCI_CMD_RESET_DEVICE,
+        XHCI_CMD_FORCE_EVENT,
+        XHCI_CMD_NEGOTIATE_BANDWIDTH,
+        XHCI_CMD_SET_LATENCY_TOLERANCE_VALUE,
+        XHCI_CMD_GET_PORT_BANDWIDTH,
+        XHCI_CMD_FORCE_HEADER,
+        XHCI_CMD_NO_OP,
+} xhci_cmd_type_t;
+
 typedef struct xhci_command {
-        link_t link;
+        /** Internal fields used for bookkeeping. Need not worry about these. */
+        struct {
+                link_t link;
 
-        xhci_trb_t trb;
-        uintptr_t trb_phys;
+                xhci_cmd_type_t cmd;
+                suseconds_t timeout;
+
+                xhci_trb_t trb;
+                uintptr_t trb_phys;
+
+                bool async;
+                bool completed;
+
+                /* Will broadcast after command completes. */
+                fibril_mutex_t completed_mtx;
+                fibril_condvar_t completed_cv;
+        } _header;
+
+        /** Below are arguments of all commands mixed together.
+         *  Be sure to know which command accepts what arguments. */
 
         uint32_t slot_id;
+        uint32_t endpoint_id;
+        uint16_t stream_id;
+
+        xhci_input_ctx_t *input_ctx;
+        xhci_port_bandwidth_ctx_t *bandwidth_ctx;
+        uintptr_t dequeue_ptr;
+
+        uint8_t tcs;
+        uint8_t susp;
+        uint8_t device_speed;
         uint32_t status;
         bool deconfigure;
-
-        bool completed;
-
-        /* Will broadcast after command completes. */
-        fibril_mutex_t completed_mtx;
-        fibril_condvar_t completed_cv;
 } xhci_cmd_t;
 
+/* Command handling control */
 int xhci_init_commands(xhci_hc_t *);
 void xhci_fini_commands(xhci_hc_t *);
-
-xhci_cmd_t *xhci_cmd_alloc(void);
-void xhci_cmd_init(xhci_cmd_t *);
-int xhci_cmd_wait(xhci_cmd_t *, suseconds_t);
-void xhci_cmd_fini(xhci_cmd_t *);
-void xhci_cmd_free(xhci_cmd_t *);
 
 void xhci_stop_command_ring(xhci_hc_t *);
@@ -80 +112 @@
 void xhci_start_command_ring(xhci_hc_t *);
 
-int xhci_send_no_op_command(xhci_hc_t *, xhci_cmd_t *);
-int xhci_send_enable_slot_command(xhci_hc_t *, xhci_cmd_t *);
-int xhci_send_disable_slot_command(xhci_hc_t *, xhci_cmd_t *);
-int xhci_send_address_device_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
-int xhci_send_configure_endpoint_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
-int xhci_send_evaluate_context_command(xhci_hc_t *, xhci_cmd_t *, xhci_input_ctx_t *);
-int xhci_send_reset_endpoint_command(xhci_hc_t *, xhci_cmd_t *, uint32_t, uint8_t);
-int xhci_send_stop_endpoint_command(xhci_hc_t *, xhci_cmd_t *, uint32_t, uint8_t);
-int xhci_send_set_dequeue_ptr_command(xhci_hc_t *, xhci_cmd_t *, uintptr_t, uint16_t, uint32_t);
-int xhci_send_reset_device_command(xhci_hc_t *, xhci_cmd_t *);
-// TODO: Force event (optional normative, for VMM, section 4.6.12).
-// TODO: Negotiate bandwidth (optional normative, section 4.6.13).
-// TODO: Set latency tolerance value (optional normative, section 4.6.14).
-int xhci_get_port_bandwidth_command(xhci_hc_t *, xhci_cmd_t *, xhci_port_bandwidth_ctx_t *, uint8_t);
-// TODO: Get port bandwidth (mandatory, but needs root hub implementation, section 4.6.15).
-// TODO: Force header (mandatory, but needs root hub implementation, section 4.6.16).
+int xhci_handle_command_completion(xhci_hc_t *, xhci_trb_t *);
 
-int xhci_handle_command_completion(xhci_hc_t *, xhci_trb_t *);
+/* Command lifecycle */
+void xhci_cmd_init(xhci_cmd_t *, xhci_cmd_type_t);
+void xhci_cmd_fini(xhci_cmd_t *);
+
+/* Issuing commands */
+int xhci_cmd_sync(xhci_hc_t *, xhci_cmd_t *);
+int xhci_cmd_sync_fini(xhci_hc_t *, xhci_cmd_t *);
+int xhci_cmd_async_fini(xhci_hc_t *, xhci_cmd_t *);
+
+static inline int xhci_cmd_sync_inline_wrapper(xhci_hc_t *hc, xhci_cmd_t cmd)
+{
+        /* Poor man's xhci_cmd_init (everything else is zeroed) */
+        link_initialize(&cmd._header.link);
+        fibril_mutex_initialize(&cmd._header.completed_mtx);
+        fibril_condvar_initialize(&cmd._header.completed_cv);
+
+        if (!cmd._header.timeout) {
+                cmd._header.timeout = XHCI_DEFAULT_TIMEOUT;
+        }
+
+        /* Issue the command */
+        const int err = xhci_cmd_sync(hc, &cmd);
+        xhci_cmd_fini(&cmd);
+
+        return err;
+}
+
+/** The inline macro expects:
+ *    - hc      - HC to schedule command on (xhci_hc_t *).
+ *    - command - Member of `xhci_cmd_type_t` without the "XHCI_CMD_" prefix.
+ *    - VA_ARGS - (optional) Command arguments in struct initialization notation.
+ *
+ *  The return code and semantics matches those of `xhci_cmd_sync_fini`.
+ *
+ *  Example:
+ *    int err = xhci_cmd_sync_inline(hc, DISABLE_SLOT, .slot_id = 42);
+ */
+
+#define xhci_cmd_sync_inline(hc, command, ...) \
+        xhci_cmd_sync_inline_wrapper(hc, \
+        (xhci_cmd_t) { ._header.cmd = XHCI_CMD_##command, ##__VA_ARGS__ })
 
 #endif