Changes in uspace/drv/bus/usb/ohci/hc.c [58563585:f83666c] in mainline

File:

• uspace/drv/bus/usb/ohci/hc.c (modified) (12 diffs)

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

@@ -34 +34 @@
  */
 
-#include <assert.h>
-#include <async.h>
 #include <errno.h>
-#include <macros.h>
-#include <mem.h>
-#include <stdlib.h>
+#include <stdbool.h>
 #include <str_error.h>
-#include <sys/types.h>
+#include <adt/list.h>
+#include <libarch/ddi.h>
 
 #include <usb/debug.h>
 #include <usb/usb.h>
-
+#include <usb/ddfiface.h>
+
+#include "hc.h"
 #include "ohci_endpoint.h"
-#include "ohci_batch.h"
-
-#include "hc.h"
 
 #define OHCI_USED_INTERRUPTS \
@@ -88 +84 @@
 };
 
+enum {
+        /** Number of PIO ranges used in IRQ code */
+        hc_irq_pio_range_count = 
+            sizeof(ohci_pio_ranges) / sizeof(irq_pio_range_t),
+
+        /** Number of commands used in IRQ code */
+        hc_irq_cmd_count =
+            sizeof(ohci_irq_commands) / sizeof(irq_cmd_t)
+};
+
 static void hc_gain_control(hc_t *instance);
 static void hc_start(hc_t *instance);
 static int hc_init_transfer_lists(hc_t *instance);
 static int hc_init_memory(hc_t *instance);
+static int interrupt_emulator(hc_t *instance);
+static int hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch);
 
 /** Generate IRQ code.
@@ -98 +106 @@
  * @param[out] cmds Commands buffer.
  * @param[in] cmds_size Size of the commands buffer (bytes).
- * @param[in] hw_res Device's resources.
+ * @param[in] regs Physical address of device's registers.
+ * @param[in] reg_size Size of the register area (bytes).
  *
  * @return Error code.
  */
-int ohci_hc_gen_irq_code(irq_code_t *code, const hw_res_list_parsed_t *hw_res)
-{
-        assert(code);
-        assert(hw_res);
-
-        if (hw_res->irqs.count != 1 || hw_res->mem_ranges.count != 1)
-                return EINVAL;
-
-        const addr_range_t regs = hw_res->mem_ranges.ranges[0];
-
-        if (RNGSZ(regs) < sizeof(ohci_regs_t))
+int
+hc_get_irq_code(irq_pio_range_t ranges[], size_t ranges_size, irq_cmd_t cmds[],
+    size_t cmds_size, uintptr_t regs, size_t reg_size)
+{
+        if ((ranges_size < sizeof(ohci_pio_ranges)) ||
+            (cmds_size < sizeof(ohci_irq_commands)) ||
+            (reg_size < sizeof(ohci_regs_t)))
                 return EOVERFLOW;
 
-        code->ranges = malloc(sizeof(ohci_pio_ranges));
-        if (code->ranges == NULL)
-                return ENOMEM;
-
-        code->cmds = malloc(sizeof(ohci_irq_commands));
-        if (code->cmds == NULL) {
-                free(code->ranges);
-                return ENOMEM;
-        }
-
-        code->rangecount = ARRAY_SIZE(ohci_pio_ranges);
-        code->cmdcount = ARRAY_SIZE(ohci_irq_commands);
-
-        memcpy(code->ranges, ohci_pio_ranges, sizeof(ohci_pio_ranges));
-        code->ranges[0].base = RNGABS(regs);
-
-        memcpy(code->cmds, ohci_irq_commands, sizeof(ohci_irq_commands));
-        ohci_regs_t *registers = (ohci_regs_t *) RNGABSPTR(regs);
-        code->cmds[0].addr = (void *) &registers->interrupt_status;
-        code->cmds[3].addr = (void *) &registers->interrupt_status;
-        OHCI_WR(code->cmds[1].value, OHCI_USED_INTERRUPTS);
-
-        usb_log_debug("Memory mapped regs at %p (size %zu), IRQ %d.\n",
-            RNGABSPTR(regs), RNGSZ(regs), hw_res->irqs.irqs[0]);
-
-        return hw_res->irqs.irqs[0];
+        memcpy(ranges, ohci_pio_ranges, sizeof(ohci_pio_ranges));
+        ranges[0].base = regs;
+
+        memcpy(cmds, ohci_irq_commands, sizeof(ohci_irq_commands));
+        ohci_regs_t *registers = (ohci_regs_t *) regs;
+        cmds[0].addr = (void *) &registers->interrupt_status;
+        cmds[3].addr = (void *) &registers->interrupt_status;
+        OHCI_WR(cmds[1].value, OHCI_USED_INTERRUPTS);
+
+        return EOK;
+}
+
+/** Register interrupt handler.
+ *
+ * @param[in] device Host controller DDF device
+ * @param[in] reg_base Register range base
+ * @param[in] reg_size Register range size
+ * @param[in] irq Interrupt number
+ * @paran[in] handler Interrupt handler
+ *
+ * @return EOK on success or negative error code
+ */
+int hc_register_irq_handler(ddf_dev_t *device, uintptr_t reg_base, size_t reg_size,
+    int irq, interrupt_handler_t handler)
+{
+        int rc;
+
+        irq_pio_range_t irq_ranges[hc_irq_pio_range_count];
+        irq_cmd_t irq_cmds[hc_irq_cmd_count];
+
+        irq_code_t irq_code = {
+                .rangecount = hc_irq_pio_range_count,
+                .ranges = irq_ranges,
+                .cmdcount = hc_irq_cmd_count,
+                .cmds = irq_cmds
+        };
+
+        rc = hc_get_irq_code(irq_ranges, sizeof(irq_ranges), irq_cmds,
+            sizeof(irq_cmds), reg_base, reg_size);
+        if (rc != EOK) {
+                usb_log_error("Failed to generate IRQ code: %s.\n",
+                    str_error(rc));
+                return rc;
+        }
+
+        /* Register handler to avoid interrupt lockup */
+        rc = register_interrupt_handler(device, irq, handler, &irq_code);
+        if (rc != EOK) {
+                usb_log_error("Failed to register interrupt handler: %s.\n",
+                    str_error(rc));
+                return rc;
+        }
+
+        return EOK;
+}
+
+/** Announce OHCI root hub to the DDF
+ *
+ * @param[in] instance OHCI driver intance
+ * @param[in] hub_fun DDF fuction representing OHCI root hub
+ * @return Error code
+ */
+int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun)
+{
+        bool addr_reqd = false;
+        bool ep_added = false;
+        bool fun_bound = false;
+        int rc;
+
+        assert(instance);
+        assert(hub_fun);
+
+        /* Try to get address 1 for root hub. */
+        instance->rh.address = 1;
+        rc = usb_device_manager_request_address(
+            &instance->generic.dev_manager, &instance->rh.address, false,
+            USB_SPEED_FULL);
+        if (rc != EOK) {
+                usb_log_error("Failed to get OHCI root hub address: %s\n",
+                    str_error(rc));
+                goto error;
+        }
+
+        addr_reqd = true;
+
+        rc = usb_endpoint_manager_add_ep(
+            &instance->generic.ep_manager, instance->rh.address, 0,
+            USB_DIRECTION_BOTH, USB_TRANSFER_CONTROL, USB_SPEED_FULL, 64,
+            0, NULL, NULL);
+        if (rc != EOK) {
+                usb_log_error("Failed to register root hub control endpoint: %s.\n",
+                    str_error(rc));
+                goto error;
+        }
+
+        ep_added = true;
+
+        rc = ddf_fun_add_match_id(hub_fun, "usb&class=hub", 100);
+        if (rc != EOK) {
+                usb_log_error("Failed to add root hub match-id: %s.\n",
+                    str_error(rc));
+                goto error;
+        }
+
+        rc = ddf_fun_bind(hub_fun);
+        if (rc != EOK) {
+                usb_log_error("Failed to bind root hub function: %s.\n",
+                    str_error(rc));
+                goto error;
+        }
+
+        fun_bound = true;
+
+        rc = usb_device_manager_bind_address(&instance->generic.dev_manager,
+            instance->rh.address, ddf_fun_get_handle(hub_fun));
+        if (rc != EOK) {
+                usb_log_warning("Failed to bind root hub address: %s.\n",
+                    str_error(rc));
+        }
+
+        return EOK;
+error:
+        if (fun_bound)
+                ddf_fun_unbind(hub_fun);
+        if (ep_added) {
+                usb_endpoint_manager_remove_ep(
+                    &instance->generic.ep_manager, instance->rh.address, 0,
+                    USB_DIRECTION_BOTH, NULL, NULL);
+        }
+        if (addr_reqd) {
+                usb_device_manager_release_address(
+                    &instance->generic.dev_manager, instance->rh.address);
+        }
+        return rc;
 }
 
@@ -146 +259 @@
  *
  * @param[in] instance Memory place for the structure.
- * @param[in] regs Device's resources
+ * @param[in] regs Address of the memory mapped I/O registers.
+ * @param[in] reg_size Size of the memory mapped area.
  * @param[in] interrupts True if w interrupts should be used
  * @return Error code
  */
-int hc_init(hc_t *instance, const hw_res_list_parsed_t *hw_res, bool interrupts)
-{
-        assert(instance);
-        assert(hw_res);
-        if (hw_res->mem_ranges.count != 1 ||
-            hw_res->mem_ranges.ranges[0].size < sizeof(ohci_regs_t))
-            return EINVAL;
-
-        int ret = pio_enable_range(&hw_res->mem_ranges.ranges[0],
-            (void **) &instance->registers);
-        if (ret != EOK) {
-                usb_log_error("Failed to gain access to registers: %s.\n",
-                    str_error(ret));
-                return ret;
-        }
-        usb_log_debug("Device registers at %" PRIx64 " (%zuB) accessible.\n",
-            hw_res->mem_ranges.ranges[0].address.absolute,
-            hw_res->mem_ranges.ranges[0].size);
+int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts)
+{
+        assert(instance);
+
+        int rc =
+            pio_enable((void*)regs, reg_size, (void**)&instance->registers);
+        if (rc != EOK) {
+                usb_log_error("Failed to gain access to device registers: %s.\n",
+                    str_error(rc));
+                return rc;
+        }
 
         list_initialize(&instance->pending_batches);
+
+        hcd_init(&instance->generic, USB_SPEED_FULL,
+            BANDWIDTH_AVAILABLE_USB11, bandwidth_count_usb11);
+        instance->generic.private_data = instance;
+        instance->generic.schedule = hc_schedule;
+        instance->generic.ep_add_hook = ohci_endpoint_init;
+        instance->generic.ep_remove_hook = ohci_endpoint_fini;
+
+        rc = hc_init_memory(instance);
+        if (rc != EOK) {
+                usb_log_error("Failed to create OHCI memory structures: %s.\n",
+                    str_error(rc));
+                return rc;
+        }
+
         fibril_mutex_initialize(&instance->guard);
-        instance->hw_interrupts = interrupts;
-
-        ret = hc_init_memory(instance);
-        if (ret != EOK) {
-                usb_log_error("Failed to create OHCI memory structures: %s.\n",
-                    str_error(ret));
-                // TODO: We should disable pio access here
-                return ret;
-        }
 
         hc_gain_control(instance);
 
-        ohci_rh_init(&instance->rh, instance->registers, "ohci rh");
+        if (!interrupts) {
+                instance->interrupt_emulator =
+                    fibril_create((int(*)(void*))interrupt_emulator, instance);
+                fibril_add_ready(instance->interrupt_emulator);
+        }
+
+        rh_init(&instance->rh, instance->registers);
         hc_start(instance);
 
         return EOK;
 }
-
-/** Safely dispose host controller internal structures
- *
- * @param[in] instance Host controller structure to use.
- */
-void hc_fini(hc_t *instance)
-{
-        assert(instance);
-        /* TODO: implement*/
-};
 
 void hc_enqueue_endpoint(hc_t *instance, const endpoint_t *ep)
@@ -267 +376 @@
 }
 
-int ohci_hc_status(hcd_t *hcd, uint32_t *status)
-{
-        assert(hcd);
-        assert(status);
-        hc_t *instance = hcd_get_driver_data(hcd);
-        assert(instance);
-
-        if (instance->registers){
-                *status = OHCI_RD(instance->registers->interrupt_status);
-                OHCI_WR(instance->registers->interrupt_status, *status);
-        }
-        return EOK;
-}
-
 /** Add USB transfer to the schedule.
  *
- * @param[in] hcd HCD driver structure.
+ * @param[in] instance OHCI hc driver structure.
  * @param[in] batch Batch representing the transfer.
  * @return Error code.
  */
-int ohci_hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch)
+int hc_schedule(hcd_t *hcd, usb_transfer_batch_t *batch)
 {
         assert(hcd);
-        hc_t *instance = hcd_get_driver_data(hcd);
+        hc_t *instance = hcd->private_data;
         assert(instance);
 
         /* Check for root hub communication */
-        if (batch->ep->address == ohci_rh_get_address(&instance->rh)) {
+        if (batch->ep->address == instance->rh.address) {
                 usb_log_debug("OHCI root hub request.\n");
-                return ohci_rh_schedule(&instance->rh, batch);
+                rh_request(&instance->rh, batch);
+                return EOK;
         }
         ohci_transfer_batch_t *ohci_batch = ohci_transfer_batch_get(batch);
@@ -324 +420 @@
 /** Interrupt handling routine
  *
- * @param[in] hcd HCD driver structure.
+ * @param[in] instance OHCI hc driver structure.
  * @param[in] status Value of the status register at the time of interrupt.
  */
-void ohci_hc_interrupt(hcd_t *hcd, uint32_t status)
-{
-        assert(hcd);
-        hc_t *instance = hcd_get_driver_data(hcd);
+void hc_interrupt(hc_t *instance, uint32_t status)
+{
         status = OHCI_RD(status);
         assert(instance);
@@ -337 +431 @@
         usb_log_debug2("OHCI(%p) interrupt: %x.\n", instance, status);
         if (status & I_RHSC)
-                ohci_rh_interrupt(&instance->rh);
+                rh_interrupt(&instance->rh);
 
         if (status & I_WDH) {
@@ -368 +462 @@
         }
 
+}
+
+/** Check status register regularly
+ *
+ * @param[in] instance OHCI hc driver structure.
+ * @return Error code
+ */
+int interrupt_emulator(hc_t *instance)
+{
+        assert(instance);
+        usb_log_info("Started interrupt emulator.\n");
+        while (1) {
+                const uint32_t status = instance->registers->interrupt_status;
+                instance->registers->interrupt_status = status;
+                hc_interrupt(instance, status);
+                async_usleep(10000);
+        }
+        return EOK;
 }
 
@@ -393 +505 @@
                     ohci_emulation_reg, OHCI_RD(*ohci_emulation_reg));
                 /* Zero everything but A20State */
-                // TODO: should we ack interrupts before doing this?
                 OHCI_CLR(*ohci_emulation_reg, ~0x100);
                 usb_log_debug(
@@ -403 +514 @@
         if (OHCI_RD(instance->registers->control) & C_IR) {
                 usb_log_debug("SMM driver: request ownership change.\n");
-                // TODO: should we ack interrupts before doing this?
                 OHCI_SET(instance->registers->command_status, CS_OCR);
                 /* Hope that SMM actually knows its stuff or we can hang here */
-                while (OHCI_RD(instance->registers->control) & C_IR) {
+                while (OHCI_RD(instance->registers->control & C_IR)) {
                         async_usleep(1000);
                 }
@@ -490 +600 @@
 
         /* Enable interrupts */
-        if (instance->hw_interrupts) {
-                OHCI_WR(instance->registers->interrupt_enable,
-                    OHCI_USED_INTERRUPTS);
-                usb_log_debug("Enabled interrupts: %x.\n",
-                    OHCI_RD(instance->registers->interrupt_enable));
-                OHCI_WR(instance->registers->interrupt_enable, I_MI);
-        }
+        OHCI_WR(instance->registers->interrupt_enable, OHCI_USED_INTERRUPTS);
+        usb_log_debug("Enabled interrupts: %x.\n",
+            OHCI_RD(instance->registers->interrupt_enable));
+        OHCI_WR(instance->registers->interrupt_enable, I_MI);
 
         /* Set periodic start to 90% */
@@ -522 +629 @@
 do { \
         const char *name = usb_str_transfer_type(type); \
-        const int ret = endpoint_list_init(&instance->lists[type], name); \
+        int ret = endpoint_list_init(&instance->lists[type], name); \
         if (ret != EOK) { \
                 usb_log_error("Failed to setup %s endpoint list: %s.\n", \