| 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 <usbhc_iface.h> | 
|---|
| 39 | #include <usb/usb.h> | 
|---|
| 40 | #include <usb/host/usb_transfer_batch.h> | 
|---|
| 41 |  | 
|---|
| 42 | #include "hw_struct/transfer_descriptor.h" | 
|---|
| 43 | #include "hw_struct/endpoint_descriptor.h" | 
|---|
| 44 |  | 
|---|
| 45 | /** OHCI specific data required for USB transfer */ | 
|---|
| 46 | typedef struct ohci_transfer_batch { | 
|---|
| 47 | /** Link */ | 
|---|
| 48 | link_t link; | 
|---|
| 49 | /** Endpoint descriptor of the target endpoint. */ | 
|---|
| 50 | ed_t *ed; | 
|---|
| 51 | /** List of TDs needed for the transfer */ | 
|---|
| 52 | td_t **tds; | 
|---|
| 53 | /** Number of TDs used by the transfer */ | 
|---|
| 54 | size_t td_count; | 
|---|
| 55 | /** Dummy TD to be left at the ED and used by the next transfer */ | 
|---|
| 56 | size_t leave_td; | 
|---|
| 57 | /** Data buffer, must be accessible by the OHCI hw. */ | 
|---|
| 58 | char *device_buffer; | 
|---|
| 59 | /** Generic USB transfer structure */ | 
|---|
| 60 | usb_transfer_batch_t *usb_batch; | 
|---|
| 61 | } ohci_transfer_batch_t; | 
|---|
| 62 |  | 
|---|
| 63 | ohci_transfer_batch_t * ohci_transfer_batch_get(usb_transfer_batch_t *batch); | 
|---|
| 64 | bool ohci_transfer_batch_is_complete(ohci_transfer_batch_t *batch); | 
|---|
| 65 | void ohci_transfer_batch_commit(ohci_transfer_batch_t *batch); | 
|---|
| 66 | void ohci_transfer_batch_finish_dispose(ohci_transfer_batch_t *batch); | 
|---|
| 67 | /*----------------------------------------------------------------------------*/ | 
|---|
| 68 | static inline ohci_transfer_batch_t *ohci_transfer_batch_from_link(link_t *l) | 
|---|
| 69 | { | 
|---|
| 70 | assert(l); | 
|---|
| 71 | return list_get_instance(l, ohci_transfer_batch_t, link); | 
|---|
| 72 | } | 
|---|
| 73 | #endif | 
|---|
| 74 | /** | 
|---|
| 75 | * @} | 
|---|
| 76 | */ | 
|---|