source: mainline/uspace/drv/ohci/hc.c@ d017cea

/*
 * Copyright (c) 2011 Jan Vesely
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/** @addtogroup drvusbohcihc
 * @{
 */
/** @file
 * @brief OHCI Host controller driver routines
 */
#include <errno.h>
#include <str_error.h>
#include <adt/list.h>
#include <libarch/ddi.h>

#include <usb/debug.h>
#include <usb/usb.h>
#include <usb/ddfiface.h>
#include <usb/usbdevice.h>

#include "hc.h"

static int interrupt_emulator(hc_t *instance);
static void hc_gain_control(hc_t *instance);
static void hc_init_hw(hc_t *instance);
static int hc_init_transfer_lists(hc_t *instance);
static int hc_init_memory(hc_t *instance);
/*----------------------------------------------------------------------------*/
int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun)
{
        assert(instance);
        assert(hub_fun);

        usb_address_t hub_address =
            device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL);
        instance->rh.address = hub_address;
        usb_device_keeper_bind(
            &instance->manager, hub_address, hub_fun->handle);

        endpoint_t *ep = malloc(sizeof(endpoint_t));
        assert(ep);
        int ret = endpoint_init(ep, hub_address, 0, USB_DIRECTION_BOTH,
            USB_TRANSFER_CONTROL, USB_SPEED_FULL, 64);
        assert(ret == EOK);
        ret = usb_endpoint_manager_register_ep(&instance->ep_manager, ep, 0);
        assert(ret == EOK);

        char *match_str = NULL;
        ret = asprintf(&match_str, "usb&class=hub");
//      ret = (match_str == NULL) ? ret : EOK;
        if (ret < 0) {
                usb_log_error(
                    "Failed(%d) to create root hub match-id string.\n", ret);
                return ret;
        }

        ret = ddf_fun_add_match_id(hub_fun, match_str, 100);
        if (ret != EOK) {
                usb_log_error("Failed add create root hub match-id.\n");
        }
        return ret;
}
/*----------------------------------------------------------------------------*/
int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev,
    uintptr_t regs, size_t reg_size, bool interrupts)
{
        assert(instance);
        int ret = EOK;
#define CHECK_RET_RETURN(ret, message...) \
if (ret != EOK) { \
        usb_log_error(message); \
        return ret; \
} else (void)0

        ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers);
        CHECK_RET_RETURN(ret,
            "Failed(%d) to gain access to device registers: %s.\n",
            ret, str_error(ret));

        instance->ddf_instance = fun;
        usb_device_keeper_init(&instance->manager);
        ret = usb_endpoint_manager_init(&instance->ep_manager,
            BANDWIDTH_AVAILABLE_USB11);
        CHECK_RET_RETURN(ret, "Failed to initialize endpoint manager: %s.\n",
            ret, str_error(ret));

        hc_gain_control(instance);
        ret = hc_init_memory(instance);
        CHECK_RET_RETURN(ret, "Failed to create OHCI memory structures:%s.\n",
            ret, str_error(ret));
        hc_init_hw(instance);
        fibril_mutex_initialize(&instance->guard);

        rh_init(&instance->rh, dev, instance->registers);

        if (!interrupts) {
                instance->interrupt_emulator =
                    fibril_create((int(*)(void*))interrupt_emulator, instance);
                fibril_add_ready(instance->interrupt_emulator);
        }

        return EOK;
}
/*----------------------------------------------------------------------------*/
int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch)
{
        assert(instance);
        assert(batch);
        assert(batch->ep);

        /* check for root hub communication */
        if (batch->ep->address == instance->rh.address) {
                return rh_request(&instance->rh, batch);
        }

        fibril_mutex_lock(&instance->guard);
        switch (batch->ep->transfer_type) {
        case USB_TRANSFER_CONTROL:
                instance->registers->control &= ~C_CLE;
                transfer_list_add_batch(
                    instance->transfers[batch->ep->transfer_type], batch);
                instance->registers->command_status |= CS_CLF;
                usb_log_debug2("Set CS control transfer filled: %x.\n",
                        instance->registers->command_status);
                instance->registers->control_current = 0;
                instance->registers->control |= C_CLE;
                break;
        case USB_TRANSFER_BULK:
                instance->registers->control &= ~C_BLE;
                transfer_list_add_batch(
                    instance->transfers[batch->ep->transfer_type], batch);
                instance->registers->command_status |= CS_BLF;
                usb_log_debug2("Set bulk transfer filled: %x.\n",
                        instance->registers->command_status);
                instance->registers->control |= C_BLE;
                break;
        case USB_TRANSFER_INTERRUPT:
        case USB_TRANSFER_ISOCHRONOUS:
                instance->registers->control &= (~C_PLE & ~C_IE);
                transfer_list_add_batch(
                    instance->transfers[batch->ep->transfer_type], batch);
                instance->registers->control |= C_PLE | C_IE;
                usb_log_debug2("Added periodic transfer: %x.\n",
                    instance->registers->periodic_current);
                break;
        default:
                break;
        }
        fibril_mutex_unlock(&instance->guard);
        return EOK;
}
/*----------------------------------------------------------------------------*/
void hc_interrupt(hc_t *instance, uint32_t status)
{
        assert(instance);
        if ((status & ~IS_SF) == 0) /* ignore sof status */
                return;
        if (status & IS_RHSC)
                rh_interrupt(&instance->rh);

        usb_log_debug("OHCI interrupt: %x.\n", status);

        if (status & IS_WDH) {
                fibril_mutex_lock(&instance->guard);
                usb_log_debug2("HCCA: %p-%p(%p).\n", instance->hcca,
                    instance->registers->hcca, addr_to_phys(instance->hcca));
                usb_log_debug2("Periodic current: %p.\n",
                    instance->registers->periodic_current);
                LIST_INITIALIZE(done);
                transfer_list_remove_finished(
                    &instance->transfers_interrupt, &done);
                transfer_list_remove_finished(
                    &instance->transfers_isochronous, &done);
                transfer_list_remove_finished(
                    &instance->transfers_control, &done);
                transfer_list_remove_finished(
                    &instance->transfers_bulk, &done);

                while (!list_empty(&done)) {
                        link_t *item = done.next;
                        list_remove(item);
                        usb_transfer_batch_t *batch =
                            list_get_instance(item, usb_transfer_batch_t, link);
                        usb_transfer_batch_finish(batch);
                }
                fibril_mutex_unlock(&instance->guard);
        }
}
/*----------------------------------------------------------------------------*/
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(50000);
        }
        return EOK;
}
/*----------------------------------------------------------------------------*/
void hc_gain_control(hc_t *instance)
{
        assert(instance);
        /* Turn off legacy emulation */
        volatile uint32_t *ohci_emulation_reg =
            (uint32_t*)((char*)instance->registers + 0x100);
        usb_log_debug("OHCI legacy register %p: %x.\n",
                ohci_emulation_reg, *ohci_emulation_reg);
        *ohci_emulation_reg = 0;

        /* Interrupt routing enabled => smm driver is active */
        if (instance->registers->control & C_IR) {
                usb_log_debug("SMM driver: request ownership change.\n");
                instance->registers->command_status |= CS_OCR;
                while (instance->registers->control & C_IR) {
                        async_usleep(1000);
                }
                usb_log_info("SMM driver: Ownership taken.\n");
                return;
        }

        const unsigned hc_status =
            (instance->registers->control >> C_HCFS_SHIFT) & C_HCFS_MASK;
        /* Interrupt routing disabled && status != USB_RESET => BIOS active */
        if (hc_status != C_HCFS_RESET) {
                usb_log_debug("BIOS driver found.\n");
                if (hc_status == C_HCFS_OPERATIONAL) {
                        usb_log_info("BIOS driver: HC operational.\n");
                        return;
                }
                /* HC is suspended assert resume for 20ms */
                instance->registers->control &= (C_HCFS_RESUME << C_HCFS_SHIFT);
                async_usleep(20000);
                usb_log_info("BIOS driver: HC resumed.\n");
                return;
        }

        /* HC is in reset (hw startup) => no other driver
         * maintain reset for at least the time specified in USB spec (50 ms)*/
        usb_log_info("HC found in reset.\n");
        async_usleep(50000);
}
/*----------------------------------------------------------------------------*/
void hc_init_hw(hc_t *instance)
{
        /* OHCI guide page 42 */
        assert(instance);
        usb_log_debug2("Started hc initialization routine.\n");

        /* Save contents of fm_interval register */
        const uint32_t fm_interval = instance->registers->fm_interval;
        usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval);

        /* Reset hc */
        usb_log_debug2("HC reset.\n");
        size_t time = 0;
        instance->registers->command_status = CS_HCR;
        while (instance->registers->command_status & CS_HCR) {
                async_usleep(10);
                time += 10;
        }
        usb_log_debug2("HC reset complete in %zu us.\n", time);

        /* Restore fm_interval */
        instance->registers->fm_interval = fm_interval;
        assert((instance->registers->command_status & CS_HCR) == 0);

        /* hc is now in suspend state */
        usb_log_debug2("HC should be in suspend state(%x).\n",
            instance->registers->control);

        /* Use HCCA */
        instance->registers->hcca = addr_to_phys(instance->hcca);

        /* Use queues */
        instance->registers->bulk_head = instance->transfers_bulk.list_head_pa;
        usb_log_debug2("Bulk HEAD set to: %p(%p).\n",
            instance->transfers_bulk.list_head,
            instance->transfers_bulk.list_head_pa);

        instance->registers->control_head =
            instance->transfers_control.list_head_pa;
        usb_log_debug2("Control HEAD set to: %p(%p).\n",
            instance->transfers_control.list_head,
            instance->transfers_control.list_head_pa);

        /* Enable queues */
        instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE);
        usb_log_debug2("All queues enabled(%x).\n",
            instance->registers->control);

        /* Disable interrupts */
        instance->registers->interrupt_disable = I_SF | I_OC;
        usb_log_debug2("Disabling interrupts: %x.\n",
            instance->registers->interrupt_disable);
        instance->registers->interrupt_disable = I_MI;
        usb_log_debug2("Enabled interrupts: %x.\n",
            instance->registers->interrupt_enable);

        /* Set periodic start to 90% */
        uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK);
        instance->registers->periodic_start = (frame_length / 10) * 9;
        usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n",
            instance->registers->periodic_start,
            instance->registers->periodic_start, frame_length);

        instance->registers->control &= (C_HCFS_OPERATIONAL << C_HCFS_SHIFT);
        usb_log_info("OHCI HC up and running(%x).\n",
            instance->registers->control);
}
/*----------------------------------------------------------------------------*/
int hc_init_transfer_lists(hc_t *instance)
{
        assert(instance);

#define SETUP_TRANSFER_LIST(type, name) \
do { \
        int ret = transfer_list_init(&instance->type, name); \
        if (ret != EOK) { \
                usb_log_error("Failed(%d) to setup %s transfer list.\n", \
                    ret, name); \
                transfer_list_fini(&instance->transfers_isochronous); \
                transfer_list_fini(&instance->transfers_interrupt); \
                transfer_list_fini(&instance->transfers_control); \
                transfer_list_fini(&instance->transfers_bulk); \
        } \
} while (0)

        SETUP_TRANSFER_LIST(transfers_isochronous, "ISOCHRONOUS");
        SETUP_TRANSFER_LIST(transfers_interrupt, "INTERRUPT");
        SETUP_TRANSFER_LIST(transfers_control, "CONTROL");
        SETUP_TRANSFER_LIST(transfers_bulk, "BULK");
#undef SETUP_TRANSFER_LIST
        transfer_list_set_next(&instance->transfers_interrupt,
            &instance->transfers_isochronous);

        /* Assign pointers to be used during scheduling */
        instance->transfers[USB_TRANSFER_INTERRUPT] =
          &instance->transfers_interrupt;
        instance->transfers[USB_TRANSFER_ISOCHRONOUS] =
          &instance->transfers_interrupt;
        instance->transfers[USB_TRANSFER_CONTROL] =
          &instance->transfers_control;
        instance->transfers[USB_TRANSFER_BULK] =
          &instance->transfers_bulk;

        return EOK;
}
/*----------------------------------------------------------------------------*/
int hc_init_memory(hc_t *instance)
{
        assert(instance);
        /* Init queues */
        hc_init_transfer_lists(instance);

        /*Init HCCA */
        instance->hcca = malloc32(sizeof(hcca_t));
        if (instance->hcca == NULL)
                return ENOMEM;
        bzero(instance->hcca, sizeof(hcca_t));
        usb_log_debug2("OHCI HCCA initialized at %p.\n", instance->hcca);

        unsigned i = 0;
        for (; i < 32; ++i) {
                instance->hcca->int_ep[i] =
                    instance->transfers_interrupt.list_head_pa;
        }
        usb_log_debug2("Interrupt HEADs set to: %p(%p).\n",
            instance->transfers_interrupt.list_head,
            instance->transfers_interrupt.list_head_pa);

        return EOK;
}
/**
 * @}
 */