Changeset 07c08ea in mainline

Timestamp:

2017-08-20T13:22:44Z (7 years ago)

Author:

Petr Manek <petr.manek@…>

Branches:

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

Children:

60ac352

Parents:

d32d51d

Message:

Basic virtual implementation for the root hub.

Location:

uspace/drv/bus/usb/xhci

Files:

• hc.c (modified) (1 diff)
• hc.h (modified) (1 diff)
• rh.c (modified) (3 diffs)
• rh.h (modified) (2 diffs)

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

@@ -458 +458 @@
         status = hc->op_regs->usbsts;
 
+        /* TODO: Figure out how root hub interrupts work. */
+        if (status | 1) {
+                usb_log_debug2("Root hub interrupt.");
+                xhci_rh_interrupt(&hc->rh);
+        }
+
         if (status & XHCI_REG_MASK(XHCI_OP_HSE)) {
                 usb_log_error("Host controller error occured. Bad things gonna happen...");

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

@@ -76 +76 @@
         xhci_scratchpad_t *scratchpad;
 
-  /* Root hub emulation */
+        /* Root hub emulation */
         xhci_rh_t rh;
 

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

@@ -44 +44 @@
 #include "rh.h"
 
+enum {
+        HUB_STATUS_CHANGE_PIPE = 1,
+};
+
+static usbvirt_device_ops_t ops;
+
 int xhci_rh_init(xhci_rh_t *rh)
 {
-        /* TODO: Implement me! */
-        return EOK;
+        return virthub_base_init(&rh->base, "xhci rh", &ops, rh, NULL,
+            &rh->hub_descriptor.header, HUB_STATUS_CHANGE_PIPE);
 }
 
@@ -229 +235 @@
 int xhci_rh_schedule(xhci_rh_t *rh, usb_transfer_batch_t *batch)
 {
-        /* TODO: Implement me! */
+        assert(rh);
+        assert(batch);
+        const usb_target_t target = {{
+                .address = batch->ep->address,
+                .endpoint = batch->ep->endpoint,
+        }};
+        batch->error = virthub_base_request(&rh->base, target,
+            usb_transfer_batch_direction(batch), (void*)batch->setup_buffer,
+            batch->buffer, batch->buffer_size, &batch->transfered_size);
+        if (batch->error == ENAK) {
+                /* This is safe because only status change interrupt transfers
+                 * return NAK. The assertion holds true because the batch
+                 * existence prevents communication with that ep */
+                assert(rh->unfinished_interrupt_transfer == NULL);
+                rh->unfinished_interrupt_transfer = batch;
+        } else {
+                usb_transfer_batch_finish(batch, NULL);
+                usb_transfer_batch_destroy(batch);
+        }
+        return EOK;
+}
+
+int xhci_rh_interrupt(xhci_rh_t *rh)
+{
+        usb_log_debug2("Called xhci_rh_interrupt().");
+
+        /* TODO: atomic swap needed */
+        usb_transfer_batch_t *batch = rh->unfinished_interrupt_transfer;
+        rh->unfinished_interrupt_transfer = NULL;
+        if (batch) {
+                const usb_target_t target = {{
+                        .address = batch->ep->address,
+                        .endpoint = batch->ep->endpoint,
+                }};
+                batch->error = virthub_base_request(&rh->base, target,
+                    usb_transfer_batch_direction(batch),
+                    (void*)batch->setup_buffer,
+                    batch->buffer, batch->buffer_size, &batch->transfered_size);
+                usb_transfer_batch_finish(batch, NULL);
+                usb_transfer_batch_destroy(batch);
+        }
+        return EOK;
+}
+
+/** Hub status request handler.
+ * @param device Virtual hub device
+ * @param setup_packet USB setup stage data.
+ * @param[out] data destination data buffer, size must be at least
+ *             setup_packet->length bytes
+ * @param[out] act_size Sized of the valid response part of the buffer.
+ * @return Error code.
+ */
+static int req_get_status(usbvirt_device_t *device,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_get_status().");
+        return EOK;
+}
+
+/** Hub set feature request handler.
+ * @param device Virtual hub device
+ * @param setup_packet USB setup stage data.
+ * @param[out] data destination data buffer, size must be at least
+ *             setup_packet->length bytes
+ * @param[out] act_size Sized of the valid response part of the buffer.
+ * @return Error code.
+ */
+static int req_clear_hub_feature(usbvirt_device_t *device,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_clear_hub_feature().");
+        return EOK;
+}
+
+/** Port status request handler.
+ * @param device Virtual hub device
+ * @param setup_packet USB setup stage data.
+ * @param[out] data destination data buffer, size must be at least
+ *             setup_packet->length bytes
+ * @param[out] act_size Sized of the valid response part of the buffer.
+ * @return Error code.
+ */
+static int req_get_port_status(usbvirt_device_t *device,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_get_port_status().");
+        return EOK;
+}
+
+/** Port clear feature request handler.
+ * @param device Virtual hub device
+ * @param setup_packet USB setup stage data.
+ * @param[out] data destination data buffer, size must be at least
+ *             setup_packet->length bytes
+ * @param[out] act_size Sized of the valid response part of the buffer.
+ * @return Error code.
+ */
+static int req_clear_port_feature(usbvirt_device_t *device,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_clear_port_feature().");
+        return EOK;
+}
+
+/** Port set feature request handler.
+ * @param device Virtual hub device
+ * @param setup_packet USB setup stage data.
+ * @param[out] data destination data buffer, size must be at least
+ *             setup_packet->length bytes
+ * @param[out] act_size Sized of the valid response part of the buffer.
+ * @return Error code.
+ */
+static int req_set_port_feature(usbvirt_device_t *device,
+    const usb_device_request_setup_packet_t *setup_packet,
+    uint8_t *data, size_t *act_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_set_port_feature().");
+        return EOK;
+}
+
+/** Status change handler.
+ * @param device Virtual hub device
+ * @param endpoint Endpoint number
+ * @param tr_type Transfer type
+ * @param buffer Response destination
+ * @param buffer_size Bytes available in buffer
+ * @param actual_size Size us the used part of the dest buffer.
+ *
+ * Produces status mask. Bit 0 indicates hub status change the other bits
+ * represent port status change. Endian does not matter as UHCI root hubs
+ * only need 1 byte.
+ */
+static int req_status_change_handler(usbvirt_device_t *device,
+    usb_endpoint_t endpoint, usb_transfer_type_t tr_type,
+    void *buffer, size_t buffer_size, size_t *actual_size)
+{
+        /* TODO: Implement me! */
+        usb_log_debug2("Called req_status_change_handler().");
         return EOK;
 }
@@ -236 +388 @@
 {
         /* TODO: Implement me! */
-        return EOK;
-}
+        usb_log_debug2("Called xhci_rh_fini().");
+        return EOK;
+}
+
+/** XHCI root hub request handlers */
+static const usbvirt_control_request_handler_t control_transfer_handlers[] = {
+        {
+                STD_REQ_IN(USB_REQUEST_RECIPIENT_DEVICE, USB_DEVREQ_GET_DESCRIPTOR),
+                .name = "GetDescriptor",
+                .callback = virthub_base_get_hub_descriptor,
+        },
+        {
+                CLASS_REQ_IN(USB_REQUEST_RECIPIENT_DEVICE, USB_DEVREQ_GET_DESCRIPTOR),
+                .name = "GetDescriptor",
+                .callback = virthub_base_get_hub_descriptor,
+        },
+        {
+                CLASS_REQ_IN(USB_REQUEST_RECIPIENT_DEVICE, USB_HUB_REQUEST_GET_DESCRIPTOR),
+                .name = "GetHubDescriptor",
+                .callback = virthub_base_get_hub_descriptor,
+        },
+        {
+                CLASS_REQ_IN(USB_REQUEST_RECIPIENT_OTHER, USB_HUB_REQUEST_GET_STATUS),
+                .name = "GetPortStatus",
+                .callback = req_get_port_status,
+        },
+        {
+                CLASS_REQ_OUT(USB_REQUEST_RECIPIENT_DEVICE, USB_HUB_REQUEST_CLEAR_FEATURE),
+                .name = "ClearHubFeature",
+                .callback = req_clear_hub_feature,
+        },
+        {
+                CLASS_REQ_OUT(USB_REQUEST_RECIPIENT_OTHER, USB_HUB_REQUEST_CLEAR_FEATURE),
+                .name = "ClearPortFeature",
+                .callback = req_clear_port_feature,
+        },
+        {
+                CLASS_REQ_IN(USB_REQUEST_RECIPIENT_DEVICE, USB_HUB_REQUEST_GET_STATUS),
+                .name = "GetHubStatus",
+                .callback = req_get_status,
+        },
+        {
+                CLASS_REQ_IN(USB_REQUEST_RECIPIENT_OTHER, USB_HUB_REQUEST_GET_STATUS),
+                .name = "GetPortStatus",
+                .callback = req_get_port_status,
+        },
+        {
+                CLASS_REQ_OUT(USB_REQUEST_RECIPIENT_DEVICE, USB_HUB_REQUEST_SET_FEATURE),
+                .name = "SetHubFeature",
+                .callback = req_nop,
+        },
+        {
+                CLASS_REQ_OUT(USB_REQUEST_RECIPIENT_OTHER, USB_HUB_REQUEST_SET_FEATURE),
+                .name = "SetPortFeature",
+                .callback = req_set_port_feature,
+        },
+        {
+                .callback = NULL
+        }
+};
+
+/** Virtual XHCI root hub ops */
+static usbvirt_device_ops_t ops = {
+        .control = control_transfer_handlers,
+        .data_in[HUB_STATUS_CHANGE_PIPE] = req_status_change_handler,
+};
 
 

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

@@ -40 +40 @@
 #include <usbvirt/virthub_base.h>
 
+enum {
+        XHCI_MAX_PORTS = 255,
+};
+
 /* XHCI root hub instance */
 typedef struct {
         /** Virtual hub instance */
         virthub_base_t base;
+        /** USB hub descriptor describing the XHCI root hub */
+        struct {
+                usb_hub_descriptor_header_t header;
+                uint8_t rempow[STATUS_BYTES(XHCI_MAX_PORTS) * 2];
+        } __attribute__((packed)) hub_descriptor;
+        /** Interrupt transfer waiting for an actual interrupt to occur */
+        usb_transfer_batch_t *unfinished_interrupt_transfer;
 } xhci_rh_t;
 
@@ -52 +63 @@
 int xhci_reset_hub_port(xhci_hc_t *, uint8_t);
 int xhci_rh_schedule(xhci_rh_t *, usb_transfer_batch_t *);
+int xhci_rh_interrupt(xhci_rh_t *);
 
 #endif