Changeset eb928c4 in mainline for uspace/drv/bus/usb/xhci/rh.c

Timestamp:

2018-01-08T00:07:00Z (6 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

1102eca

Parents:

ecbad17

git-author:

Ondřej Hlavatý <aearsis@…> (2018-01-08 00:05:39)

git-committer:

Ondřej Hlavatý <aearsis@…> (2018-01-08 00:07:00)

Message:

xhci: documentation & cleanup

Also, a simple refactoring to remove functions that only wraps another
functions unused anywhere else.

File:

• uspace/drv/bus/usb/xhci/rh.c (modified) (12 diffs)

uspace/drv/bus/usb/xhci/rh.c

@@ -61 +61 @@
         XHCI_REG_MASK(XHCI_PORT_CEC);
 
+/**
+ * Initialize the roothub subsystem.
+ */
 int xhci_rh_init(xhci_rh_t *rh, xhci_hc_t *hc)
 {
@@ -81 +84 @@
 }
 
-/** Create a device node for device directly connected to RH.
+/**
+ * Finalize the RH subsystem.
+ */
+int xhci_rh_fini(xhci_rh_t *rh)
+{
+        assert(rh);
+        free(rh->devices_by_port);
+        return EOK;
+}
+
+/**
+ * Create and setup a device directly connected to RH. As the xHCI is not using
+ * a virtual usbhub device for RH, this routine is called for devices directly.
  */
 static int rh_setup_device(xhci_rh_t *rh, uint8_t port_id)
@@ -89 +104 @@
 
         assert(rh->devices_by_port[port_id - 1] == NULL);
-
-        xhci_bus_t *bus = &rh->hc->bus;
 
         device_t *dev = hcd_ddf_fun_create(&rh->hc->base);
@@ -107 +120 @@
         dev->speed = port_speed->usb_speed;
 
-        if ((err = xhci_bus_enumerate_device(bus, dev))) {
+        if ((err = bus_device_enumerate(dev))) {
                 usb_log_error("Failed to enumerate USB device: %s", str_error(err));
                 return err;
@@ -134 +147 @@
 }
 
+/**
+ * Handle a device connection. USB 3+ devices are set up directly, USB 2 and
+ * below first need to have their port reset.
+ */
 static int handle_connected_device(xhci_rh_t *rh, uint8_t port_id)
 {
@@ -161 +178 @@
                 usb_log_debug("USB 2 device attached, issuing reset.");
                 xhci_rh_reset_port(rh, port_id);
-                /*
-                        FIXME: we need to wait for the event triggered by the reset
-                        and then alloc_dev()... can't it be done directly instead of
-                        going around?
-                */
                 return EOK;
         }
 }
 
-/** Deal with a detached device.
+/**
+ * Deal with a detached device.
  */
 static int handle_disconnected_device(xhci_rh_t *rh, uint8_t port_id)
@@ -194 +207 @@
 
         /* Remove device from XHCI bus. */
-        if ((err = xhci_bus_remove_device(&rh->hc->bus, &dev->base))) {
+        if ((err = bus_device_remove(&dev->base))) {
                 usb_log_warning("Failed to remove device " XHCI_DEV_FMT " from XHCI bus: %s",
                     XHCI_DEV_ARGS(*dev), str_error(err));
@@ -202 +215 @@
 }
 
-/** Handle an incoming Port Change Detected Event.
+/**
+ * Handle an incoming Port Change Detected Event.
  */
 int xhci_rh_handle_port_status_change_event(xhci_hc_t *hc, xhci_trb_t *trb)
@@ -219 +233 @@
 }
 
+/**
+ * Handle all changes on all ports.
+ */
 void xhci_rh_handle_port_change(xhci_rh_t *rh)
 {
@@ -303 +320 @@
 }
 
-static inline int get_hub_available_bandwidth(xhci_hc_t *hc, xhci_device_t* dev, uint8_t speed, xhci_port_bandwidth_ctx_t *ctx)
-{
-        int err = EOK;
-
-        // TODO: find a correct place for this function + API
-        // We need speed, because a root hub device has both USB 2 and USB 3 speeds
-        // and the command can query only one of them
-        // ctx is an out parameter as of now
-        assert(dev);
-        assert(ctx);
-
-        xhci_cmd_t cmd;
-        xhci_cmd_init(&cmd, XHCI_CMD_GET_PORT_BANDWIDTH);
-
-        if ((err = dma_buffer_alloc(&cmd.bandwidth_ctx, sizeof(xhci_port_bandwidth_ctx_t))))
-                goto end;
-
-        cmd.device_speed = speed;
-
-        if ((err = xhci_cmd_sync(hc, &cmd)))
-                goto end;
-
-        memcpy(ctx, cmd.bandwidth_ctx.virt, sizeof(xhci_port_bandwidth_ctx_t));
-
-end:
-        xhci_cmd_fini(&cmd);
-        return err;
-}
-
+/**
+ * Get a port speed for a given port id.
+ */
 const xhci_port_speed_t *xhci_rh_get_port_speed(xhci_rh_t *rh, uint8_t port)
 {
@@ -340 +331 @@
 }
 
+/**
+ * Issue a port reset for a given port.
+ */
 int xhci_rh_reset_port(xhci_rh_t* rh, uint8_t port)
 {
@@ -349 +343 @@
 }
 
-int xhci_rh_fini(xhci_rh_t *rh)
-{
-        assert(rh);
-        free(rh->devices_by_port);
-        return EOK;
-}
-
 /**
  * @}