source: mainline/uspace/drv/uhci/transfer_list.h@ 9600516

/*
 * Copyright (c) 2010 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 usb
 * @{
 */
/** @file
 * @brief UHCI driver
 */
#ifndef DRV_UHCI_TRANSFER_LIST_H
#define DRV_UHCI_TRANSFER_LIST_H

#include "debug.h"
#include "translating_malloc.h"
#include "uhci_struct/queue_head.h"
#include "uhci_struct/transfer_descriptor.h"

typedef struct transfer_list
{
        transfer_descriptor_t *first;
        transfer_descriptor_t *last;
        queue_head_t *queue_head;
        uint32_t queue_head_pa;
} transfer_list_t;

static inline int transfer_list_init(
  transfer_list_t *instance, transfer_list_t *next)
{
        assert(instance);
        instance->first = NULL;
        instance->last = NULL;
        instance->queue_head = trans_malloc(sizeof(queue_head_t));
        if (!instance->queue_head) {
                uhci_print_error("Failed to allocate queue head.\n");
                return ENOMEM;
        }
        instance->queue_head_pa = (uintptr_t)addr_to_phys(instance->queue_head);

        uint32_t next_pa = next ? next->queue_head_pa : 0;
        queue_head_init(instance->queue_head, next_pa);
        return EOK;
}

static inline void transfer_list_fini(transfer_list_t *instance)
{
        assert(instance);
        if (instance->queue_head)
                free(instance->queue_head);
}

#endif
/**
 * @}
 */