HelenOS sources

root/uspace/lib/usbhost/src/usb_transfer_batch.c

DEFINITIONS

1. usb_transfer_batch_create
2. usb_transfer_batch_init
3. usb_transfer_batch_destroy
4. usb_transfer_batch_bounce_required
5. usb_transfer_batch_bounce
6. usb_transfer_batch_finish

/*
 * Copyright (c) 2011 Jan Vesely
 * Copyright (c) 2018 Ondrej Hlavaty
 * 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 libusbhost
 * @{
 */
/** @file
 * USB transfer transaction structures (implementation).
 */

#include <assert.h>
#include <errno.h>
#include <stdlib.h>
#include <str_error.h>
#include <usb/debug.h>

#include "endpoint.h"
#include "bus.h"

#include "usb_transfer_batch.h"

/**
 * Create a batch on a given endpoint.
 *
 * If the bus callback is not defined, it just creates a default batch.
 */
usb_transfer_batch_t *usb_transfer_batch_create(endpoint_t *ep)
{
        assert(ep);

        bus_t *bus = endpoint_get_bus(ep);

        if (!bus->ops->batch_create) {
                usb_transfer_batch_t *batch = calloc(1, sizeof(usb_transfer_batch_t));
                if (!batch)
                        return NULL;
                usb_transfer_batch_init(batch, ep);
                return batch;
        }

        return bus->ops->batch_create(ep);
}

/**
 * Initialize given batch structure.
 */
void usb_transfer_batch_init(usb_transfer_batch_t *batch, endpoint_t *ep)
{
        assert(ep);
        /* Batch reference */
        endpoint_add_ref(ep);
        batch->ep = ep;
}

/**
 * Destroy the batch. If there's no bus callback, just free it.
 */
void usb_transfer_batch_destroy(usb_transfer_batch_t *batch)
{
        assert(batch);
        assert(batch->ep);

        bus_t *bus = endpoint_get_bus(batch->ep);
        endpoint_t *ep = batch->ep;

        if (bus->ops) {
                usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT " destroying.",
                    batch, USB_TRANSFER_BATCH_ARGS(*batch));
                bus->ops->batch_destroy(batch);
        } else {
                usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT " disposing.",
                    batch, USB_TRANSFER_BATCH_ARGS(*batch));
                free(batch);
        }

        /* Batch reference */
        endpoint_del_ref(ep);
}

bool usb_transfer_batch_bounce_required(usb_transfer_batch_t *batch)
{
        if (!batch->size)
                return false;

        unsigned flags = batch->dma_buffer.policy & DMA_POLICY_FLAGS_MASK;
        unsigned required_flags =
            batch->ep->required_transfer_buffer_policy & DMA_POLICY_FLAGS_MASK;

        if (required_flags & ~flags)
                return true;

        size_t chunk_mask = dma_policy_chunk_mask(batch->dma_buffer.policy);
        size_t required_chunk_mask =
            dma_policy_chunk_mask(batch->ep->required_transfer_buffer_policy);

        /* If the chunks are at least as large as required, we're good */
        if ((required_chunk_mask & ~chunk_mask) == 0)
                return false;

        size_t start_chunk = batch->offset & ~chunk_mask;
        size_t end_chunk = (batch->offset + batch->size - 1) & ~chunk_mask;

        /* The requested area crosses a chunk boundary */
        if (start_chunk != end_chunk)
                return true;

        return false;
}

errno_t usb_transfer_batch_bounce(usb_transfer_batch_t *batch)
{
        assert(batch);
        assert(!batch->is_bounced);

        dma_buffer_release(&batch->dma_buffer);

        batch->original_buffer = batch->dma_buffer.virt + batch->offset;

        usb_log_debug("Batch(%p): Buffer cannot be used directly, "
            "falling back to bounce buffer!", batch);

        const errno_t err = dma_buffer_alloc_policy(&batch->dma_buffer,
            batch->size, batch->ep->transfer_buffer_policy);
        if (err)
                return err;

        /* Copy the data out */
        if (batch->dir == USB_DIRECTION_OUT)
                memcpy(batch->dma_buffer.virt,
                    batch->original_buffer,
                    batch->size);

        batch->is_bounced = true;
        batch->offset = 0;

        return err;
}

/**
 * Finish a transfer batch: call handler, destroy batch, release endpoint.
 *
 * Call only after the batch have been scheduled && completed!
 */
void usb_transfer_batch_finish(usb_transfer_batch_t *batch)
{
        assert(batch);
        assert(batch->ep);

        usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT " finishing.",
            batch, USB_TRANSFER_BATCH_ARGS(*batch));

        if (batch->error == EOK && batch->size > 0) {
                if (batch->is_bounced) {
                        /* We we're forced to use bounce buffer, copy it back */
                        if (batch->dir == USB_DIRECTION_IN)
                                memcpy(batch->original_buffer,
                                    batch->dma_buffer.virt,
                                    batch->transferred_size);

                        dma_buffer_free(&batch->dma_buffer);
                } else {
                        dma_buffer_release(&batch->dma_buffer);
                }
        }

        if (batch->on_complete) {
                const int err = batch->on_complete(batch->on_complete_data, batch->error, batch->transferred_size);
                if (err)
                        usb_log_warning("Batch %p failed to complete: %s",
                            batch, str_error(err));
        }

        usb_transfer_batch_destroy(batch);
}

/**
 * @}
 */