| 1 | /*
|
|---|
| 2 | * Copyright (c) 2011 Jan Vesely
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 | /** @addtogroup drvusbohci
|
|---|
| 29 | * @{
|
|---|
| 30 | */
|
|---|
| 31 | /** @file
|
|---|
| 32 | * @brief OHCI driver USB transaction structure
|
|---|
| 33 | */
|
|---|
| 34 | #ifndef DRV_OHCI_BATCH_H
|
|---|
| 35 | #define DRV_OHCI_BATCH_H
|
|---|
| 36 |
|
|---|
| 37 | #include <adt/list.h>
|
|---|
| 38 | #include <assert.h>
|
|---|
| 39 | #include <stdbool.h>
|
|---|
| 40 | #include <usb/dma_buffer.h>
|
|---|
| 41 | #include <usb/host/usb_transfer_batch.h>
|
|---|
| 42 |
|
|---|
| 43 | #include "hw_struct/transfer_descriptor.h"
|
|---|
| 44 | #include "hw_struct/endpoint_descriptor.h"
|
|---|
| 45 |
|
|---|
| 46 | /** OHCI specific data required for USB transfer */
|
|---|
| 47 | typedef struct ohci_transfer_batch {
|
|---|
| 48 | usb_transfer_batch_t base;
|
|---|
| 49 |
|
|---|
| 50 | /** Number of TDs used by the transfer */
|
|---|
| 51 | size_t td_count;
|
|---|
| 52 |
|
|---|
| 53 | /**
|
|---|
| 54 | * List of TDs needed for the transfer - together with setup data
|
|---|
| 55 | * backed by the dma buffer. Note that the TD pointers are pointing to
|
|---|
| 56 | * the DMA buffer initially, but as the scheduling must use the first TD
|
|---|
| 57 | * from EP, it is replaced.
|
|---|
| 58 | */
|
|---|
| 59 | td_t **tds;
|
|---|
| 60 | char *setup_buffer;
|
|---|
| 61 | char *data_buffer;
|
|---|
| 62 |
|
|---|
| 63 | dma_buffer_t ohci_dma_buffer;
|
|---|
| 64 | } ohci_transfer_batch_t;
|
|---|
| 65 |
|
|---|
| 66 | ohci_transfer_batch_t * ohci_transfer_batch_create(endpoint_t *batch);
|
|---|
| 67 | int ohci_transfer_batch_prepare(ohci_transfer_batch_t *ohci_batch);
|
|---|
| 68 | void ohci_transfer_batch_commit(const ohci_transfer_batch_t *batch);
|
|---|
| 69 | bool ohci_transfer_batch_check_completed(ohci_transfer_batch_t *batch);
|
|---|
| 70 | void ohci_transfer_batch_destroy(ohci_transfer_batch_t *ohci_batch);
|
|---|
| 71 |
|
|---|
| 72 | static inline ohci_transfer_batch_t * ohci_transfer_batch_get(usb_transfer_batch_t *usb_batch)
|
|---|
| 73 | {
|
|---|
| 74 | assert(usb_batch);
|
|---|
| 75 |
|
|---|
| 76 | return (ohci_transfer_batch_t *) usb_batch;
|
|---|
| 77 | }
|
|---|
| 78 |
|
|---|
| 79 | #endif
|
|---|
| 80 | /**
|
|---|
| 81 | * @}
|
|---|
| 82 | */
|
|---|
