source: mainline/uspace/drv/bus/usb/ohci/ohci_batch.c@ 8820544

/*
 * 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 drvusbohci
 * @{
 */
/** @file
 * @brief OHCI driver USB transaction structure
 */
#include <errno.h>
#include <str_error.h>
#include <macros.h>

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

#include "ohci_batch.h"
#include "ohci_endpoint.h"
#include "utils/malloc32.h"

static void (*const batch_setup[])(ohci_transfer_batch_t*, usb_direction_t);

/** Safely destructs ohci_transfer_batch_t structure
 *
 * @param[in] ohci_batch Instance to destroy.
 */
static void ohci_transfer_batch_dispose(ohci_transfer_batch_t *ohci_batch)
{
        if (!ohci_batch)
                return;
        if (ohci_batch->tds) {
                const ohci_endpoint_t *ohci_ep =
                    ohci_endpoint_get(ohci_batch->usb_batch->ep);
                assert(ohci_ep);
                for (unsigned i = 0; i < ohci_batch->td_count; ++i) {
                        if (ohci_batch->tds[i] != ohci_ep->td)
                                free32(ohci_batch->tds[i]);
                }
                free(ohci_batch->tds);
        }
        usb_transfer_batch_destroy(ohci_batch->usb_batch);
        free32(ohci_batch->device_buffer);
        free(ohci_batch);
}

/** Finishes usb_transfer_batch and destroys the structure.
 *
 * @param[in] uhci_batch Instance to finish and destroy.
 */
void ohci_transfer_batch_finish_dispose(ohci_transfer_batch_t *ohci_batch)
{
        assert(ohci_batch);
        assert(ohci_batch->usb_batch);
        usb_transfer_batch_finish(ohci_batch->usb_batch,
            ohci_batch->device_buffer + ohci_batch->usb_batch->setup_size);
        ohci_transfer_batch_dispose(ohci_batch);
}

/** Allocate memory and initialize internal data structure.
 *
 * @param[in] usb_batch Pointer to generic USB batch structure.
 * @return Valid pointer if all structures were successfully created,
 * NULL otherwise.
 *
 * Determines the number of needed transfer descriptors (TDs).
 * Prepares a transport buffer (that is accessible by the hardware).
 * Initializes parameters needed for the transfer and callback.
 */
ohci_transfer_batch_t * ohci_transfer_batch_get(usb_transfer_batch_t *usb_batch)
{
        assert(usb_batch);
#define CHECK_NULL_DISPOSE_RET(ptr, message...) \
if (ptr == NULL) { \
        usb_log_error(message); \
        ohci_transfer_batch_dispose(ohci_batch); \
        return NULL; \
} else (void)0

        ohci_transfer_batch_t *ohci_batch =
            calloc(1, sizeof(ohci_transfer_batch_t));
        CHECK_NULL_DISPOSE_RET(ohci_batch,
            "Failed to allocate OHCI batch data.\n");
        link_initialize(&ohci_batch->link);
        ohci_batch->td_count =
            (usb_batch->buffer_size + OHCI_TD_MAX_TRANSFER - 1)
            / OHCI_TD_MAX_TRANSFER;
        /* Control transfer need Setup and Status stage */
        if (usb_batch->ep->transfer_type == USB_TRANSFER_CONTROL) {
                ohci_batch->td_count += 2;
        }

        /* We need an extra place for TD that was left at ED */
        ohci_batch->tds = calloc(ohci_batch->td_count + 1, sizeof(td_t*));
        CHECK_NULL_DISPOSE_RET(ohci_batch->tds,
            "Failed to allocate OHCI transfer descriptors.\n");

        /* Add TD left over by the previous transfer */
        ohci_batch->ed = ohci_endpoint_get(usb_batch->ep)->ed;
        ohci_batch->tds[0] = ohci_endpoint_get(usb_batch->ep)->td;

        for (unsigned i = 1; i <= ohci_batch->td_count; ++i) {
                ohci_batch->tds[i] = malloc32(sizeof(td_t));
                CHECK_NULL_DISPOSE_RET(ohci_batch->tds[i],
                    "Failed to allocate TD %d.\n", i );
        }


        /* NOTE: OHCI is capable of handling buffer that crosses page boundaries
         * it is, however, not capable of handling buffer that occupies more
         * than two pages (the first page is computed using start pointer, the
         * other using the end pointer) */
        if (usb_batch->setup_size + usb_batch->buffer_size > 0) {
                /* Use one buffer for setup and data stage */
                ohci_batch->device_buffer =
                    malloc32(usb_batch->setup_size + usb_batch->buffer_size);
                CHECK_NULL_DISPOSE_RET(ohci_batch->device_buffer,
                    "Failed to allocate device accessible buffer.\n");
                /* Copy setup data */
                memcpy(ohci_batch->device_buffer, usb_batch->setup_buffer,
                    usb_batch->setup_size);
                /* Copy generic data */
                if (usb_batch->ep->direction != USB_DIRECTION_IN)
                        memcpy(
                            ohci_batch->device_buffer + usb_batch->setup_size,
                            usb_batch->buffer, usb_batch->buffer_size);
        }
        ohci_batch->usb_batch = usb_batch;

        const usb_direction_t dir = usb_transfer_batch_direction(usb_batch);
        assert(batch_setup[usb_batch->ep->transfer_type]);
        batch_setup[usb_batch->ep->transfer_type](ohci_batch, dir);

        return ohci_batch;
#undef CHECK_NULL_DISPOSE_RET
}

/** Check batch TDs' status.
 *
 * @param[in] ohci_batch Batch structure to use.
 * @return False, if there is an active TD, true otherwise.
 *
 * Walk all TDs (usually there is just one). Stop with false if there is an
 * active TD. Stop with true if an error is found. Return true if the walk
 * completes with the last TD.
 */
bool ohci_transfer_batch_is_complete(const ohci_transfer_batch_t *ohci_batch)
{
        assert(ohci_batch);
        assert(ohci_batch->usb_batch);

        usb_log_debug("Batch %p checking %zu td(s) for completion.\n",
            ohci_batch->usb_batch, ohci_batch->td_count);
        usb_log_debug2("ED: %08x:%08x:%08x:%08x.\n",
            ohci_batch->ed->status, ohci_batch->ed->td_head,
            ohci_batch->ed->td_tail, ohci_batch->ed->next);

        if (!ed_inactive(ohci_batch->ed) && ed_transfer_pending(ohci_batch->ed))
                return false;

        /* Now we may be sure that either the ED is inactive because of errors
         * or all transfer descriptors completed successfully */

        /* Assume all data got through */
        ohci_batch->usb_batch->transfered_size =
            ohci_batch->usb_batch->buffer_size;

        /* Assume we will leave the last(unused) TD behind */
        unsigned leave_td = ohci_batch->td_count;

        /* Check all TDs */
        for (size_t i = 0; i < ohci_batch->td_count; ++i) {
                assert(ohci_batch->tds[i] != NULL);
                usb_log_debug("TD %zu: %08x:%08x:%08x:%08x.\n", i,
                    ohci_batch->tds[i]->status, ohci_batch->tds[i]->cbp,
                    ohci_batch->tds[i]->next, ohci_batch->tds[i]->be);

                ohci_batch->usb_batch->error = td_error(ohci_batch->tds[i]);
                if (ohci_batch->usb_batch->error == EOK) {
                        /* If the TD got all its data through, it will report
                         * 0 bytes remain, the sole exception is INPUT with
                         * data rounding flag (short), i.e. every INPUT.
                         * Nice thing is that short packets will correctly
                         * report remaining data, thus making this computation
                         * correct (short packets need to be produced by the
                         * last TD)
                         * NOTE: This also works for CONTROL transfer as
                         * the first TD will return 0 remain.
                         * NOTE: Short packets don't break the assumption that
                         * we leave the very last(unused) TD behind.
                         */
                        ohci_batch->usb_batch->transfered_size
                            -= td_remain_size(ohci_batch->tds[i]);
                } else {
                        usb_log_debug("Batch %p found error TD(%zu):%08x.\n",
                            ohci_batch->usb_batch, i,
                            ohci_batch->tds[i]->status);

                        /* ED should be stopped because of errors */
                        assert((ohci_batch->ed->td_head & ED_TDHEAD_HALTED_FLAG) != 0);

                        /* Now we have a problem: we don't know what TD
                         * the head pointer points to, the retiring rules
                         * described in specs say it should be the one after
                         * the failed one so set the tail pointer accordingly.
                         * It will be the one TD we leave behind.
                         */
                        leave_td = i + 1;

                        /* Check TD assumption */
                        assert(ed_head_td(ohci_batch->ed) ==
                            addr_to_phys(ohci_batch->tds[leave_td]));

                        /* Set tail to the same TD */
                        ed_set_tail_td(ohci_batch->ed,
                            ohci_batch->tds[leave_td]);

                        /* Clear possible ED HALT */
                        ed_clear_halt(ohci_batch->ed);
                        break;
                }
        }
        assert(ohci_batch->usb_batch->transfered_size <=
            ohci_batch->usb_batch->buffer_size);

        /* Store the remaining TD */
        ohci_endpoint_t *ohci_ep = ohci_endpoint_get(ohci_batch->usb_batch->ep);
        assert(ohci_ep);
        ohci_ep->td = ohci_batch->tds[leave_td];

        /* Make sure that we are leaving the right TD behind */
        assert(addr_to_phys(ohci_ep->td) == ed_head_td(ohci_batch->ed));
        assert(addr_to_phys(ohci_ep->td) == ed_tail_td(ohci_batch->ed));

        return true;
}

/** Starts execution of the TD list
 *
 * @param[in] ohci_batch Batch structure to use
 */
void ohci_transfer_batch_commit(const ohci_transfer_batch_t *ohci_batch)
{
        assert(ohci_batch);
        ed_set_tail_td(ohci_batch->ed, ohci_batch->tds[ohci_batch->td_count]);
}

/** Prepare generic control transfer
 *
 * @param[in] ohci_batch Batch structure to use.
 * @param[in] dir Communication direction
 *
 * Setup stage with toggle 0 and direction BOTH(SETUP_PID)
 * Data stage with alternating toggle and direction supplied by parameter.
 * Status stage with toggle 1 and direction supplied by parameter.
 */
static void batch_control(ohci_transfer_batch_t *ohci_batch, usb_direction_t dir)
{
        assert(ohci_batch);
        assert(ohci_batch->usb_batch);
        assert(dir == USB_DIRECTION_IN || dir == USB_DIRECTION_OUT);
        usb_log_debug("Using ED(%p): %08x:%08x:%08x:%08x.\n", ohci_batch->ed,
            ohci_batch->ed->status, ohci_batch->ed->td_tail,
            ohci_batch->ed->td_head, ohci_batch->ed->next);
        static const usb_direction_t reverse_dir[] = {
                [USB_DIRECTION_IN]  = USB_DIRECTION_OUT,
                [USB_DIRECTION_OUT] = USB_DIRECTION_IN,
        };

        int toggle = 0;
        const char* buffer = ohci_batch->device_buffer;
        const usb_direction_t data_dir = dir;
        const usb_direction_t status_dir = reverse_dir[dir];

        /* Setup stage */
        td_init(
            ohci_batch->tds[0], ohci_batch->tds[1], USB_DIRECTION_BOTH,
            buffer, ohci_batch->usb_batch->setup_size, toggle);
        usb_log_debug("Created CONTROL SETUP TD: %08x:%08x:%08x:%08x.\n",
            ohci_batch->tds[0]->status, ohci_batch->tds[0]->cbp,
            ohci_batch->tds[0]->next, ohci_batch->tds[0]->be);
        buffer += ohci_batch->usb_batch->setup_size;

        /* Data stage */
        size_t td_current = 1;
        size_t remain_size = ohci_batch->usb_batch->buffer_size;
        while (remain_size > 0) {
                const size_t transfer_size =
                    min(remain_size, OHCI_TD_MAX_TRANSFER);
                toggle = 1 - toggle;

                td_init(ohci_batch->tds[td_current],
                    ohci_batch->tds[td_current + 1],
                    data_dir, buffer, transfer_size, toggle);
                usb_log_debug("Created CONTROL DATA TD: %08x:%08x:%08x:%08x.\n",
                    ohci_batch->tds[td_current]->status,
                    ohci_batch->tds[td_current]->cbp,
                    ohci_batch->tds[td_current]->next,
                    ohci_batch->tds[td_current]->be);

                buffer += transfer_size;
                remain_size -= transfer_size;
                assert(td_current < ohci_batch->td_count - 1);
                ++td_current;
        }

        /* Status stage */
        assert(td_current == ohci_batch->td_count - 1);
        td_init(ohci_batch->tds[td_current], ohci_batch->tds[td_current + 1],
            status_dir, NULL, 0, 1);
        usb_log_debug("Created CONTROL STATUS TD: %08x:%08x:%08x:%08x.\n",
            ohci_batch->tds[td_current]->status,
            ohci_batch->tds[td_current]->cbp,
            ohci_batch->tds[td_current]->next,
            ohci_batch->tds[td_current]->be);
        usb_log_debug2(
            "Batch %p %s %s " USB_TRANSFER_BATCH_FMT " initialized.\n", \
            ohci_batch->usb_batch,
            usb_str_transfer_type(ohci_batch->usb_batch->ep->transfer_type),
            usb_str_direction(dir),
            USB_TRANSFER_BATCH_ARGS(*ohci_batch->usb_batch));
}

/** Prepare generic data transfer
 *
 * @param[in] ohci_batch Batch structure to use.
 * @paramp[in] dir Communication direction.
 *
 * Direction is supplied by the associated ep and toggle is maintained by the
 * OHCI hw in ED.
 */
static void batch_data(ohci_transfer_batch_t *ohci_batch, usb_direction_t dir)
{
        assert(ohci_batch);
        assert(ohci_batch->usb_batch);
        assert(dir == USB_DIRECTION_IN || dir == USB_DIRECTION_OUT);
        usb_log_debug("Using ED(%p): %08x:%08x:%08x:%08x.\n", ohci_batch->ed,
            ohci_batch->ed->status, ohci_batch->ed->td_tail,
            ohci_batch->ed->td_head, ohci_batch->ed->next);

        size_t td_current = 0;
        size_t remain_size = ohci_batch->usb_batch->buffer_size;
        char *buffer = ohci_batch->device_buffer;
        while (remain_size > 0) {
                const size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER
                    ? OHCI_TD_MAX_TRANSFER : remain_size;

                td_init(
                    ohci_batch->tds[td_current], ohci_batch->tds[td_current + 1],
                    dir, buffer, transfer_size, -1);

                usb_log_debug("Created DATA TD: %08x:%08x:%08x:%08x.\n",
                    ohci_batch->tds[td_current]->status,
                    ohci_batch->tds[td_current]->cbp,
                    ohci_batch->tds[td_current]->next,
                    ohci_batch->tds[td_current]->be);

                buffer += transfer_size;
                remain_size -= transfer_size;
                assert(td_current < ohci_batch->td_count);
                ++td_current;
        }
        usb_log_debug2(
            "Batch %p %s %s " USB_TRANSFER_BATCH_FMT " initialized.\n", \
            ohci_batch->usb_batch,
            usb_str_transfer_type(ohci_batch->usb_batch->ep->transfer_type),
            usb_str_direction(dir),
            USB_TRANSFER_BATCH_ARGS(*ohci_batch->usb_batch));
}

/** Transfer setup table. */
static void (*const batch_setup[])(ohci_transfer_batch_t*, usb_direction_t) =
{
        [USB_TRANSFER_CONTROL] = batch_control,
        [USB_TRANSFER_BULK] = batch_data,
        [USB_TRANSFER_INTERRUPT] = batch_data,
        [USB_TRANSFER_ISOCHRONOUS] = NULL,
};
/**
 * @}
 */