| 1 | /*
|
|---|
| 2 | * Copyright (c) 2018 Ondrej Hlavaty
|
|---|
| 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 |
|
|---|
| 29 | /** @addtogroup drvusbxhci
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * @brief Data structures and functions related to isochronous transfers.
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef XHCI_ISOCH_H
|
|---|
| 37 | #define XHCI_ISOCH_H
|
|---|
| 38 |
|
|---|
| 39 | #include <usb/dma_buffer.h>
|
|---|
| 40 |
|
|---|
| 41 | #include "trb_ring.h"
|
|---|
| 42 |
|
|---|
| 43 | #include "transfers.h"
|
|---|
| 44 |
|
|---|
| 45 | typedef struct xhci_endpoint xhci_endpoint_t;
|
|---|
| 46 |
|
|---|
| 47 | typedef enum {
|
|---|
| 48 | ISOCH_EMPTY, /* Unused yet */
|
|---|
| 49 | ISOCH_FILLED, /* The data buffer is valid */
|
|---|
| 50 | ISOCH_FED, /* The data buffer is in possession of xHC */
|
|---|
| 51 | ISOCH_COMPLETE, /* The error code is valid */
|
|---|
| 52 | } xhci_isoch_transfer_state_t;
|
|---|
| 53 |
|
|---|
| 54 | typedef struct {
|
|---|
| 55 | /** Buffer with data */
|
|---|
| 56 | dma_buffer_t data;
|
|---|
| 57 | /** Used buffer size */
|
|---|
| 58 | size_t size;
|
|---|
| 59 |
|
|---|
| 60 | /** Current state */
|
|---|
| 61 | xhci_isoch_transfer_state_t state;
|
|---|
| 62 |
|
|---|
| 63 | /** Microframe to which to schedule */
|
|---|
| 64 | uint64_t mfindex;
|
|---|
| 65 |
|
|---|
| 66 | /** Physical address of enqueued TRB */
|
|---|
| 67 | uintptr_t interrupt_trb_phys;
|
|---|
| 68 |
|
|---|
| 69 | /** Result of the transfer. Valid only if status == ISOCH_COMPLETE. */
|
|---|
| 70 | errno_t error;
|
|---|
| 71 | } xhci_isoch_transfer_t;
|
|---|
| 72 |
|
|---|
| 73 | typedef struct {
|
|---|
| 74 | /** Protects common buffers. */
|
|---|
| 75 | fibril_mutex_t guard;
|
|---|
| 76 |
|
|---|
| 77 | /** Signals filled buffer. */
|
|---|
| 78 | fibril_condvar_t avail;
|
|---|
| 79 |
|
|---|
| 80 | /** Defers handing buffers to the HC. */
|
|---|
| 81 | fibril_timer_t *feeding_timer;
|
|---|
| 82 |
|
|---|
| 83 | /** Resets endpoint if there is no traffic. */
|
|---|
| 84 | fibril_timer_t *reset_timer;
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * The maximum size of an isochronous transfer
|
|---|
| 88 | * and therefore the size of buffers
|
|---|
| 89 | */
|
|---|
| 90 | size_t max_size;
|
|---|
| 91 |
|
|---|
| 92 | /** The microframe at which the last TRB was scheduled. */
|
|---|
| 93 | uint64_t last_mf;
|
|---|
| 94 |
|
|---|
| 95 | /** The number of transfer buffers allocated */
|
|---|
| 96 | size_t buffer_count;
|
|---|
| 97 |
|
|---|
| 98 | /** Isochronous scheduled transfers with respective buffers */
|
|---|
| 99 | xhci_isoch_transfer_t *transfers;
|
|---|
| 100 |
|
|---|
| 101 | /**
|
|---|
| 102 | * Out: Next buffer that will be handed to HW.
|
|---|
| 103 | * In: Invalid. Hidden inside HC.
|
|---|
| 104 | */
|
|---|
| 105 | size_t hw_enqueue;
|
|---|
| 106 |
|
|---|
| 107 | /**
|
|---|
| 108 | * Out: Next buffer that will be used for writing.
|
|---|
| 109 | * In: Next buffer that will be enqueued to be written by the HC
|
|---|
| 110 | */
|
|---|
| 111 | size_t enqueue;
|
|---|
| 112 |
|
|---|
| 113 | /**
|
|---|
| 114 | * Out: First buffer that will be checked for completion
|
|---|
| 115 | * In: Next buffer to be read from, when valid.
|
|---|
| 116 | */
|
|---|
| 117 | size_t dequeue;
|
|---|
| 118 | } xhci_isoch_t;
|
|---|
| 119 |
|
|---|
| 120 | typedef struct usb_endpoint_descriptors usb_endpoint_descriptors_t;
|
|---|
| 121 |
|
|---|
| 122 | extern void isoch_init(xhci_endpoint_t *, const usb_endpoint_descriptors_t *);
|
|---|
| 123 | extern void isoch_fini(xhci_endpoint_t *);
|
|---|
| 124 | extern errno_t isoch_alloc_transfers(xhci_endpoint_t *);
|
|---|
| 125 |
|
|---|
| 126 | extern errno_t isoch_schedule_out(xhci_transfer_t *);
|
|---|
| 127 | extern errno_t isoch_schedule_in(xhci_transfer_t *);
|
|---|
| 128 | extern void isoch_handle_transfer_event(xhci_hc_t *, xhci_endpoint_t *,
|
|---|
| 129 | xhci_trb_t *);
|
|---|
| 130 |
|
|---|
| 131 | #endif
|
|---|
| 132 |
|
|---|
| 133 | /**
|
|---|
| 134 | * @}
|
|---|
| 135 | */
|
|---|
