Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the libpayload project. |
| 3 | * |
| 4 | * Copyright (C) 2010 Patrick Georgi |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 5 | * Copyright (C) 2013 secunet Security Networks AG |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 6 | * |
| 7 | * Redistribution and use in source and binary forms, with or without |
| 8 | * modification, are permitted provided that the following conditions |
| 9 | * are met: |
| 10 | * 1. Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * 2. Redistributions in binary form must reproduce the above copyright |
| 13 | * notice, this list of conditions and the following disclaimer in the |
| 14 | * documentation and/or other materials provided with the distribution. |
| 15 | * 3. The name of the author may not be used to endorse or promote products |
| 16 | * derived from this software without specific prior written permission. |
| 17 | * |
| 18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND |
| 19 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 21 | * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE |
| 22 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 23 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| 24 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| 25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| 26 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| 27 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| 28 | * SUCH DAMAGE. |
| 29 | */ |
| 30 | |
| 31 | #ifndef __XHCI_PRIVATE_H |
| 32 | #define __XHCI_PRIVATE_H |
| 33 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 34 | //#define USB_DEBUG |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 35 | #include <usb/usb.h> |
Yidi Lin | d42ee15 | 2015-05-07 15:36:04 +0800 | [diff] [blame] | 36 | #include <arch/barrier.h> |
| 37 | #include <kconfig.h> |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 38 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 39 | //#define XHCI_DUMPS |
| 40 | #define xhci_debug(fmt, args...) usb_debug("%s: " fmt, __func__, ## args) |
| 41 | #ifdef XHCI_SPEW_DEBUG |
| 42 | # define xhci_spew(fmt, args...) xhci_debug(fmt, ##args) |
| 43 | #else |
| 44 | # define xhci_spew(fmt, args...) do {} while(0) |
| 45 | #endif |
| 46 | |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 47 | #define MASK(startbit, lenbit) (((1<<(lenbit))-1)<<(startbit)) |
| 48 | |
Julius Werner | 5f9a3f7 | 2015-08-03 14:21:07 -0700 | [diff] [blame] | 49 | /* Make these high enough to not collide with negative XHCI CCs */ |
| 50 | #define TIMEOUT -65 |
| 51 | #define CONTROLLER_ERROR -66 |
| 52 | #define COMMUNICATION_ERROR -67 |
| 53 | #define OUT_OF_MEMORY -68 |
| 54 | #define DRIVER_ERROR -69 |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 55 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 56 | #define CC_SUCCESS 1 |
| 57 | #define CC_TRB_ERROR 5 |
| 58 | #define CC_STALL_ERROR 6 |
Julius Werner | e44a4e8 | 2015-07-08 22:36:00 -0700 | [diff] [blame] | 59 | #define CC_RESOURCE_ERROR 7 |
| 60 | #define CC_BANDWIDTH_ERROR 8 |
| 61 | #define CC_NO_SLOTS_AVAILABLE 9 |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 62 | #define CC_SHORT_PACKET 13 |
| 63 | #define CC_EVENT_RING_FULL_ERROR 21 |
| 64 | #define CC_COMMAND_RING_STOPPED 24 |
| 65 | #define CC_COMMAND_ABORTED 25 |
| 66 | #define CC_STOPPED 26 |
| 67 | #define CC_STOPPED_LENGTH_INVALID 27 |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 68 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 69 | enum { |
| 70 | TRB_NORMAL = 1, |
| 71 | TRB_SETUP_STAGE = 2, TRB_DATA_STAGE = 3, TRB_STATUS_STAGE = 4, |
Julius Werner | 83da501 | 2013-09-27 12:45:11 -0700 | [diff] [blame] | 72 | TRB_LINK = 6, TRB_EVENT_DATA = 7, |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 73 | TRB_CMD_ENABLE_SLOT = 9, TRB_CMD_DISABLE_SLOT = 10, TRB_CMD_ADDRESS_DEV = 11, |
| 74 | TRB_CMD_CONFIGURE_EP = 12, TRB_CMD_EVAL_CTX = 13, TRB_CMD_RESET_EP = 14, |
| 75 | TRB_CMD_STOP_EP = 15, TRB_CMD_SET_TR_DQ = 16, TRB_CMD_NOOP = 23, |
| 76 | TRB_EV_TRANSFER = 32, TRB_EV_CMD_CMPL = 33, TRB_EV_PORTSC = 34, TRB_EV_HOST = 37, |
| 77 | }; |
| 78 | enum { TRB_TRT_NO_DATA = 0, TRB_TRT_OUT_DATA = 2, TRB_TRT_IN_DATA = 3 }; |
| 79 | enum { TRB_DIR_OUT = 0, TRB_DIR_IN = 1 }; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 80 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 81 | #define TRB_PORT_FIELD ptr_low |
| 82 | #define TRB_PORT_START 24 |
| 83 | #define TRB_PORT_LEN 8 |
| 84 | #define TRB_TL_FIELD status /* TL - Transfer Length */ |
| 85 | #define TRB_TL_START 0 |
| 86 | #define TRB_TL_LEN 17 |
| 87 | #define TRB_EVTL_FIELD status /* EVTL - (Event TRB) Transfer Length */ |
| 88 | #define TRB_EVTL_START 0 |
| 89 | #define TRB_EVTL_LEN 24 |
| 90 | #define TRB_TDS_FIELD status /* TDS - TD Size */ |
| 91 | #define TRB_TDS_START 17 |
| 92 | #define TRB_TDS_LEN 5 |
| 93 | #define TRB_CC_FIELD status /* CC - Completion Code */ |
| 94 | #define TRB_CC_START 24 |
| 95 | #define TRB_CC_LEN 8 |
| 96 | #define TRB_C_FIELD control /* C - Cycle Bit */ |
| 97 | #define TRB_C_START 0 |
| 98 | #define TRB_C_LEN 1 |
| 99 | #define TRB_TC_FIELD control /* TC - Toggle Cycle */ |
| 100 | #define TRB_TC_START 1 |
| 101 | #define TRB_TC_LEN 1 |
Sourabh Banerjee | e73335c | 2014-09-24 16:14:45 +0530 | [diff] [blame] | 102 | #define TRB_ENT_FIELD control /* ENT - Evaluate Next TRB */ |
| 103 | #define TRB_ENT_START 1 |
| 104 | #define TRB_ENT_LEN 1 |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 105 | #define TRB_ISP_FIELD control /* ISP - Interrupt-on Short Packet */ |
| 106 | #define TRB_ISP_START 2 |
| 107 | #define TRB_ISP_LEN 1 |
| 108 | #define TRB_CH_FIELD control /* CH - Chain Bit */ |
| 109 | #define TRB_CH_START 4 |
| 110 | #define TRB_CH_LEN 1 |
| 111 | #define TRB_IOC_FIELD control /* IOC - Interrupt On Completion */ |
| 112 | #define TRB_IOC_START 5 |
| 113 | #define TRB_IOC_LEN 1 |
| 114 | #define TRB_IDT_FIELD control /* IDT - Immediate Data */ |
| 115 | #define TRB_IDT_START 6 |
| 116 | #define TRB_IDT_LEN 1 |
| 117 | #define TRB_DC_FIELD control /* DC - Deconfigure */ |
| 118 | #define TRB_DC_START 9 |
| 119 | #define TRB_DC_LEN 1 |
| 120 | #define TRB_TT_FIELD control /* TT - TRB Type */ |
| 121 | #define TRB_TT_START 10 |
| 122 | #define TRB_TT_LEN 6 |
| 123 | #define TRB_TRT_FIELD control /* TRT - Transfer Type */ |
| 124 | #define TRB_TRT_START 16 |
| 125 | #define TRB_TRT_LEN 2 |
| 126 | #define TRB_DIR_FIELD control /* DIR - Direction */ |
| 127 | #define TRB_DIR_START 16 |
| 128 | #define TRB_DIR_LEN 1 |
| 129 | #define TRB_EP_FIELD control /* EP - Endpoint ID */ |
| 130 | #define TRB_EP_START 16 |
| 131 | #define TRB_EP_LEN 5 |
| 132 | #define TRB_ID_FIELD control /* ID - Slot ID */ |
| 133 | #define TRB_ID_START 24 |
| 134 | #define TRB_ID_LEN 8 |
| 135 | #define TRB_MASK(tok) MASK(TRB_##tok##_START, TRB_##tok##_LEN) |
| 136 | #define TRB_GET(tok, trb) (((trb)->TRB_##tok##_FIELD & TRB_MASK(tok)) \ |
| 137 | >> TRB_##tok##_START) |
| 138 | #define TRB_SET(tok, trb, to) (trb)->TRB_##tok##_FIELD = \ |
| 139 | (((trb)->TRB_##tok##_FIELD & ~TRB_MASK(tok)) | \ |
| 140 | (((to) << TRB_##tok##_START) & TRB_MASK(tok))) |
| 141 | #define TRB_DUMP(tok, trb) usb_debug(" "#tok"\t0x%04"PRIx32"\n", TRB_GET(tok, trb)) |
| 142 | |
| 143 | #define TRB_CYCLE (1 << 0) |
| 144 | typedef volatile struct trb { |
| 145 | u32 ptr_low; |
| 146 | u32 ptr_high; |
| 147 | u32 status; |
| 148 | u32 control; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 149 | } trb_t; |
| 150 | |
Rajmohan Mani | d6fb32b | 2014-05-30 13:06:01 -0700 | [diff] [blame] | 151 | #define TRB_MAX_TD_SIZE 0x1F /* bits 21:17 of TD Size in TRB */ |
| 152 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 153 | #define EVENT_RING_SIZE 64 |
| 154 | typedef struct { |
| 155 | trb_t *ring; |
| 156 | trb_t *cur; |
| 157 | trb_t *last; |
| 158 | u8 ccs; |
| 159 | u8 adv; |
| 160 | } event_ring_t; |
| 161 | |
Julius Werner | 83da501 | 2013-09-27 12:45:11 -0700 | [diff] [blame] | 162 | /* Never raise this above 256 to prevent transfer event length overflow! */ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 163 | #define TRANSFER_RING_SIZE 32 |
| 164 | typedef struct { |
| 165 | trb_t *ring; |
| 166 | trb_t *cur; |
| 167 | u8 pcs; |
| 168 | } __attribute__ ((packed)) transfer_ring_t; |
| 169 | |
| 170 | #define COMMAND_RING_SIZE 4 |
| 171 | typedef transfer_ring_t command_ring_t; |
| 172 | |
| 173 | #define SC_ROUTE_FIELD f1 /* ROUTE - Route String */ |
| 174 | #define SC_ROUTE_START 0 |
| 175 | #define SC_ROUTE_LEN 20 |
Julius Werner | e00ba21 | 2013-09-24 20:03:54 -0700 | [diff] [blame] | 176 | #define SC_SPEED1_FIELD f1 /* SPEED - Port speed plus one (compared to usb_speed enum) */ |
| 177 | #define SC_SPEED1_START 20 |
| 178 | #define SC_SPEED1_LEN 4 |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 179 | #define SC_MTT_FIELD f1 /* MTT - Multi Transaction Translator */ |
| 180 | #define SC_MTT_START 25 |
| 181 | #define SC_MTT_LEN 1 |
| 182 | #define SC_HUB_FIELD f1 /* HUB - Is this a hub? */ |
| 183 | #define SC_HUB_START 26 |
| 184 | #define SC_HUB_LEN 1 |
| 185 | #define SC_CTXENT_FIELD f1 /* CTXENT - Context Entries (number of following ep contexts) */ |
| 186 | #define SC_CTXENT_START 27 |
| 187 | #define SC_CTXENT_LEN 5 |
| 188 | #define SC_RHPORT_FIELD f2 /* RHPORT - Root Hub Port Number */ |
| 189 | #define SC_RHPORT_START 16 |
| 190 | #define SC_RHPORT_LEN 8 |
| 191 | #define SC_NPORTS_FIELD f2 /* NPORTS - Number of Ports */ |
| 192 | #define SC_NPORTS_START 24 |
| 193 | #define SC_NPORTS_LEN 8 |
| 194 | #define SC_TTID_FIELD f3 /* TTID - TT Hub Slot ID */ |
| 195 | #define SC_TTID_START 0 |
| 196 | #define SC_TTID_LEN 8 |
| 197 | #define SC_TTPORT_FIELD f3 /* TTPORT - TT Port Number */ |
| 198 | #define SC_TTPORT_START 8 |
| 199 | #define SC_TTPORT_LEN 8 |
| 200 | #define SC_TTT_FIELD f3 /* TTT - TT Think Time */ |
| 201 | #define SC_TTT_START 16 |
| 202 | #define SC_TTT_LEN 2 |
| 203 | #define SC_UADDR_FIELD f4 /* UADDR - USB Device Address */ |
| 204 | #define SC_UADDR_START 0 |
| 205 | #define SC_UADDR_LEN 8 |
| 206 | #define SC_STATE_FIELD f4 /* STATE - Slot State */ |
| 207 | #define SC_STATE_START 27 |
| 208 | #define SC_STATE_LEN 8 |
| 209 | #define SC_MASK(tok) MASK(SC_##tok##_START, SC_##tok##_LEN) |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 210 | #define SC_GET(tok, sc) (((sc)->SC_##tok##_FIELD & SC_MASK(tok)) \ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 211 | >> SC_##tok##_START) |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 212 | #define SC_SET(tok, sc, to) (sc)->SC_##tok##_FIELD = \ |
| 213 | (((sc)->SC_##tok##_FIELD & ~SC_MASK(tok)) | \ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 214 | (((to) << SC_##tok##_START) & SC_MASK(tok))) |
| 215 | #define SC_DUMP(tok, sc) usb_debug(" "#tok"\t0x%04"PRIx32"\n", SC_GET(tok, sc)) |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 216 | typedef volatile struct slotctx { |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 217 | u32 f1; |
| 218 | u32 f2; |
| 219 | u32 f3; |
| 220 | u32 f4; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 221 | u32 rsvd[4]; |
| 222 | } slotctx_t; |
| 223 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 224 | #define EC_STATE_FIELD f1 /* STATE - Endpoint State */ |
| 225 | #define EC_STATE_START 0 |
| 226 | #define EC_STATE_LEN 3 |
| 227 | #define EC_INTVAL_FIELD f1 /* INTVAL - Interval */ |
| 228 | #define EC_INTVAL_START 16 |
| 229 | #define EC_INTVAL_LEN 8 |
| 230 | #define EC_CERR_FIELD f2 /* CERR - Error Count */ |
| 231 | #define EC_CERR_START 1 |
| 232 | #define EC_CERR_LEN 2 |
| 233 | #define EC_TYPE_FIELD f2 /* TYPE - EP Type */ |
| 234 | #define EC_TYPE_START 3 |
| 235 | #define EC_TYPE_LEN 3 |
| 236 | #define EC_MBS_FIELD f2 /* MBS - Max Burst Size */ |
| 237 | #define EC_MBS_START 8 |
| 238 | #define EC_MBS_LEN 8 |
| 239 | #define EC_MPS_FIELD f2 /* MPS - Max Packet Size */ |
| 240 | #define EC_MPS_START 16 |
| 241 | #define EC_MPS_LEN 16 |
| 242 | #define EC_DCS_FIELD tr_dq_low /* DCS - Dequeue Cycle State */ |
| 243 | #define EC_DCS_START 0 |
| 244 | #define EC_DCS_LEN 1 |
| 245 | #define EC_AVRTRB_FIELD f5 /* AVRTRB - Average TRB Length */ |
| 246 | #define EC_AVRTRB_START 0 |
| 247 | #define EC_AVRTRB_LEN 16 |
| 248 | #define EC_MXESIT_FIELD f5 /* MXESIT - Max ESIT Payload */ |
| 249 | #define EC_MXESIT_START 16 |
| 250 | #define EC_MXESIT_LEN 16 |
Yidi Lin | d42ee15 | 2015-05-07 15:36:04 +0800 | [diff] [blame] | 251 | #define EC_BPKTS_FIELD rsvd[0] /* BPKTS - packets tx in scheduled uframe */ |
| 252 | #define EC_BPKTS_START 0 |
| 253 | #define EC_BPKTS_LEN 6 |
| 254 | #define EC_BBM_FIELD rsvd[0] /* BBM - burst mode for scheduling */ |
| 255 | #define EC_BBM_START 11 |
| 256 | #define EC_BBM_LEN 1 |
| 257 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 258 | #define EC_MASK(tok) MASK(EC_##tok##_START, EC_##tok##_LEN) |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 259 | #define EC_GET(tok, ec) (((ec)->EC_##tok##_FIELD & EC_MASK(tok)) \ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 260 | >> EC_##tok##_START) |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 261 | #define EC_SET(tok, ec, to) (ec)->EC_##tok##_FIELD = \ |
| 262 | (((ec)->EC_##tok##_FIELD & ~EC_MASK(tok)) | \ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 263 | (((to) << EC_##tok##_START) & EC_MASK(tok))) |
| 264 | #define EC_DUMP(tok, ec) usb_debug(" "#tok"\t0x%04"PRIx32"\n", EC_GET(tok, ec)) |
| 265 | enum { EP_ISOC_OUT = 1, EP_BULK_OUT = 2, EP_INTR_OUT = 3, |
| 266 | EP_CONTROL = 4, EP_ISOC_IN = 5, EP_BULK_IN = 6, EP_INTR_IN = 7 }; |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 267 | typedef volatile struct epctx { |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 268 | u32 f1; |
| 269 | u32 f2; |
| 270 | u32 tr_dq_low; |
| 271 | u32 tr_dq_high; |
| 272 | u32 f5; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 273 | u32 rsvd[3]; |
| 274 | } epctx_t; |
| 275 | |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 276 | #define NUM_EPS 32 |
| 277 | #define CTXSIZE(xhci) ((xhci)->capreg->csz ? 64 : 32) |
| 278 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 279 | typedef union devctx { |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 280 | /* set of pointers, so we can dynamically adjust Slot/EP context size */ |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 281 | struct { |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 282 | union { |
| 283 | slotctx_t *slot; |
| 284 | void *raw; /* Pointer to the whole dev context. */ |
| 285 | }; |
| 286 | epctx_t *ep0; |
| 287 | epctx_t *eps1_30[NUM_EPS - 2]; |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 288 | }; |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 289 | epctx_t *ep[NUM_EPS]; /* At index 0 it's actually the slotctx, |
| 290 | we have it like that so we can use |
| 291 | the ep_id directly as index. */ |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 292 | } devctx_t; |
| 293 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 294 | typedef struct inputctx { |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 295 | union { /* The drop flags are located at the start of the */ |
| 296 | u32 *drop; /* structure, so a pointer to them is equivalent */ |
| 297 | void *raw; /* to a pointer to the whole (raw) input context. */ |
| 298 | }; |
| 299 | u32 *add; |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 300 | devctx_t dev; |
| 301 | } inputctx_t; |
| 302 | |
| 303 | typedef struct intrq { |
| 304 | size_t size; /* Size of each transfer */ |
| 305 | size_t count; /* The number of TRBs to fill at once */ |
| 306 | trb_t *next; /* The next TRB expected to be processed by the controller */ |
| 307 | trb_t *ready; /* The last TRB in the transfer ring processed by the controller */ |
| 308 | endpoint_t *ep; |
| 309 | } intrq_t; |
| 310 | |
| 311 | typedef struct devinfo { |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 312 | devctx_t ctx; |
| 313 | transfer_ring_t *transfer_rings[NUM_EPS]; |
Julius Werner | e44a4e8 | 2015-07-08 22:36:00 -0700 | [diff] [blame] | 314 | intrq_t *interrupt_queues[NUM_EPS]; |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 315 | } devinfo_t; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 316 | |
| 317 | typedef struct erst_entry { |
| 318 | u32 seg_base_lo; |
| 319 | u32 seg_base_hi; |
| 320 | u32 seg_size; |
| 321 | u32 rsvd; |
| 322 | } erst_entry_t; |
| 323 | |
| 324 | typedef struct xhci { |
| 325 | /* capreg is read-only, so no need for volatile, |
| 326 | and thus 32bit accesses can be assumed. */ |
| 327 | struct capreg { |
| 328 | u8 caplength; |
| 329 | u8 res1; |
| 330 | union { |
| 331 | u16 hciversion; |
| 332 | struct { |
| 333 | u8 hciver_lo; |
| 334 | u8 hciver_hi; |
| 335 | } __attribute__ ((packed)); |
| 336 | } __attribute__ ((packed)); |
| 337 | union { |
| 338 | u32 hcsparams1; |
| 339 | struct { |
| 340 | unsigned long MaxSlots:7; |
| 341 | unsigned long MaxIntrs:11; |
| 342 | unsigned long:6; |
| 343 | unsigned long MaxPorts:8; |
| 344 | } __attribute__ ((packed)); |
| 345 | } __attribute__ ((packed)); |
| 346 | union { |
| 347 | u32 hcsparams2; |
| 348 | struct { |
| 349 | unsigned long IST:4; |
| 350 | unsigned long ERST_Max:4; |
Julius Werner | 57ddd9a | 2015-08-07 13:14:20 -0700 | [diff] [blame] | 351 | unsigned long:13; |
| 352 | unsigned long Max_Scratchpad_Bufs_Hi:5; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 353 | unsigned long SPR:1; |
Julius Werner | 57ddd9a | 2015-08-07 13:14:20 -0700 | [diff] [blame] | 354 | unsigned long Max_Scratchpad_Bufs_Lo:5; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 355 | } __attribute__ ((packed)); |
| 356 | } __attribute__ ((packed)); |
| 357 | union { |
| 358 | u32 hcsparams3; |
| 359 | struct { |
| 360 | unsigned long u1latency:8; |
| 361 | unsigned long:8; |
| 362 | unsigned long u2latency:16; |
| 363 | } __attribute__ ((packed)); |
| 364 | } __attribute__ ((packed)); |
| 365 | union { |
| 366 | u32 hccparams; |
| 367 | struct { |
| 368 | unsigned long ac64:1; |
| 369 | unsigned long bnc:1; |
| 370 | unsigned long csz:1; |
| 371 | unsigned long ppc:1; |
| 372 | unsigned long pind:1; |
| 373 | unsigned long lhrc:1; |
| 374 | unsigned long ltc:1; |
| 375 | unsigned long nss:1; |
| 376 | unsigned long:4; |
| 377 | unsigned long MaxPSASize:4; |
| 378 | unsigned long xECP:16; |
| 379 | } __attribute__ ((packed)); |
| 380 | } __attribute__ ((packed)); |
| 381 | u32 dboff; |
| 382 | u32 rtsoff; |
| 383 | } __attribute__ ((packed)) *capreg; |
| 384 | |
| 385 | /* opreg is R/W is most places, so volatile access is necessary. |
| 386 | volatile means that the compiler seeks byte writes if possible, |
| 387 | making bitfields unusable for MMIO register blocks. Yay C :-( */ |
| 388 | volatile struct opreg { |
| 389 | u32 usbcmd; |
| 390 | #define USBCMD_RS 1<<0 |
| 391 | #define USBCMD_HCRST 1<<1 |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 392 | #define USBCMD_INTE 1<<2 |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 393 | u32 usbsts; |
| 394 | #define USBSTS_HCH 1<<0 |
| 395 | #define USBSTS_HSE 1<<2 |
| 396 | #define USBSTS_EINT 1<<3 |
| 397 | #define USBSTS_PCD 1<<4 |
| 398 | #define USBSTS_CNR 1<<11 |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 399 | #define USBSTS_PRSRV_MASK ((1 << 1) | 0xffffe000) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 400 | u32 pagesize; |
| 401 | u8 res1[0x13-0x0c+1]; |
| 402 | u32 dnctrl; |
| 403 | u32 crcr_lo; |
| 404 | u32 crcr_hi; |
| 405 | #define CRCR_RCS 1<<0 |
| 406 | #define CRCR_CS 1<<1 |
| 407 | #define CRCR_CA 1<<2 |
| 408 | #define CRCR_CRR 1<<3 |
| 409 | u8 res2[0x2f-0x20+1]; |
| 410 | u32 dcbaap_lo; |
| 411 | u32 dcbaap_hi; |
| 412 | u32 config; |
Gabe Black | 1ee2c6d | 2013-08-09 04:27:35 -0700 | [diff] [blame] | 413 | #define CONFIG_LP_MASK_MaxSlotsEn 0xff |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 414 | u8 res3[0x3ff-0x3c+1]; |
| 415 | struct { |
| 416 | u32 portsc; |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 417 | #define PORTSC_CCS (1<<0) |
| 418 | #define PORTSC_PED (1<<1) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 419 | // BIT 2 rsvdZ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 420 | #define PORTSC_OCA (1<<3) |
| 421 | #define PORTSC_PR (1<<4) |
| 422 | #define PORTSC_PLS (1<<5) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 423 | #define PORTSC_PLS_MASK MASK(5, 4) |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 424 | #define PORTSC_PP (1<<9) |
| 425 | #define PORTSC_PORT_SPEED_START 10 |
| 426 | #define PORTSC_PORT_SPEED (1<<PORTSC_PORT_SPEED_START) |
| 427 | #define PORTSC_PORT_SPEED_MASK MASK(PORTSC_PORT_SPEED_START, 4) |
| 428 | #define PORTSC_PIC (1<<14) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 429 | #define PORTSC_PIC_MASK MASK(14, 2) |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 430 | #define PORTSC_LWS (1<<16) |
| 431 | #define PORTSC_CSC (1<<17) |
| 432 | #define PORTSC_PEC (1<<18) |
| 433 | #define PORTSC_WRC (1<<19) |
| 434 | #define PORTSC_OCC (1<<20) |
| 435 | #define PORTSC_PRC (1<<21) |
| 436 | #define PORTSC_PLC (1<<22) |
| 437 | #define PORTSC_CEC (1<<23) |
| 438 | #define PORTSC_CAS (1<<24) |
| 439 | #define PORTSC_WCE (1<<25) |
| 440 | #define PORTSC_WDE (1<<26) |
| 441 | #define PORTSC_WOE (1<<27) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 442 | // BIT 29:28 rsvdZ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 443 | #define PORTSC_DR (1<<30) |
| 444 | #define PORTSC_WPR (1<<31) |
| 445 | #define PORTSC_RW_MASK (PORTSC_PR | PORTSC_PLS_MASK | PORTSC_PP | PORTSC_PIC_MASK | PORTSC_LWS | PORTSC_WCE | PORTSC_WDE | PORTSC_WOE) |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 446 | u32 portpmsc; |
| 447 | u32 portli; |
| 448 | u32 res; |
| 449 | } __attribute__ ((packed)) prs[]; |
| 450 | } __attribute__ ((packed)) *opreg; |
| 451 | |
| 452 | /* R/W, volatile, MMIO -> no bitfields */ |
| 453 | volatile struct hcrreg { |
| 454 | u32 mfindex; |
| 455 | u8 res1[0x20-0x4]; |
| 456 | struct { |
| 457 | u32 iman; |
| 458 | u32 imod; |
| 459 | u32 erstsz; |
| 460 | u32 res; |
| 461 | u32 erstba_lo; |
| 462 | u32 erstba_hi; |
| 463 | u32 erdp_lo; |
| 464 | u32 erdp_hi; |
| 465 | } __attribute__ ((packed)) intrrs[]; // up to 1024, but maximum host specific, given in capreg->MaxIntrs |
| 466 | } __attribute__ ((packed)) *hcrreg; |
| 467 | |
| 468 | /* R/W, volatile, MMIO -> no bitfields */ |
| 469 | volatile u32 *dbreg; |
| 470 | |
| 471 | /* R/W, volatile, Memory -> bitfields allowed */ |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 472 | u64 *dcbaa; /* pointers to sp_ptrs and output (device) contexts */ |
| 473 | u64 *sp_ptrs; /* pointers to scratchpad buffers */ |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 474 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 475 | command_ring_t cr; |
| 476 | event_ring_t er; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 477 | volatile erst_entry_t *ev_ring_table; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 478 | |
| 479 | usbdev_t *roothub; |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 480 | |
| 481 | u8 max_slots_en; |
Julius Werner | 1f86434 | 2013-09-03 17:15:31 -0700 | [diff] [blame] | 482 | devinfo_t *dev; /* array of devinfos by slot_id */ |
| 483 | |
| 484 | #define DMA_SIZE (64 * 1024) |
| 485 | void *dma_buffer; |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 486 | } xhci_t; |
| 487 | |
| 488 | #define XHCI_INST(controller) ((xhci_t*)((controller)->instance)) |
| 489 | |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 490 | void *xhci_align(const size_t min_align, const size_t size); |
| 491 | void xhci_init_cycle_ring(transfer_ring_t *, const size_t ring_size); |
Julius Werner | d13e2c4 | 2013-09-17 22:16:04 -0700 | [diff] [blame] | 492 | usbdev_t *xhci_set_address (hci_t *, usb_speed speed, int hubport, int hubaddr); |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 493 | int xhci_finish_device_config(usbdev_t *); |
| 494 | void xhci_destroy_dev(hci_t *, int slot_id); |
| 495 | |
| 496 | void xhci_reset_event_ring(event_ring_t *); |
| 497 | void xhci_advance_event_ring(xhci_t *); |
| 498 | void xhci_update_event_dq(xhci_t *); |
| 499 | void xhci_handle_events(xhci_t *); |
| 500 | int xhci_wait_for_command_aborted(xhci_t *, const trb_t *); |
| 501 | int xhci_wait_for_command_done(xhci_t *, const trb_t *, int clear_event); |
| 502 | int xhci_wait_for_transfer(xhci_t *, const int slot_id, const int ep_id); |
| 503 | |
| 504 | void xhci_clear_trb(trb_t *, int pcs); |
| 505 | |
| 506 | trb_t *xhci_next_command_trb(xhci_t *); |
| 507 | void xhci_post_command(xhci_t *); |
| 508 | int xhci_cmd_enable_slot(xhci_t *, int *slot_id); |
| 509 | int xhci_cmd_disable_slot(xhci_t *, int slot_id); |
| 510 | int xhci_cmd_address_device(xhci_t *, int slot_id, inputctx_t *); |
| 511 | int xhci_cmd_configure_endpoint(xhci_t *, int slot_id, int config_id, inputctx_t *); |
| 512 | int xhci_cmd_evaluate_context(xhci_t *, int slot_id, inputctx_t *); |
| 513 | int xhci_cmd_reset_endpoint(xhci_t *, int slot_id, int ep); |
| 514 | int xhci_cmd_stop_endpoint(xhci_t *, int slot_id, int ep); |
| 515 | int xhci_cmd_set_tr_dq(xhci_t *, int slot_id, int ep, trb_t *, int dcs); |
| 516 | |
| 517 | static inline int xhci_ep_id(const endpoint_t *const ep) { |
Liangfeng Wu | 8c7e416 | 2016-05-24 19:40:46 +0800 | [diff] [blame] | 518 | return ((ep->endpoint & 0x7f) * 2) + (ep->direction != OUT); |
Nico Huber | 9029265 | 2013-06-13 14:37:15 +0200 | [diff] [blame] | 519 | } |
| 520 | |
| 521 | |
| 522 | #ifdef XHCI_DUMPS |
| 523 | void xhci_dump_slotctx(const slotctx_t *); |
| 524 | void xhci_dump_epctx(const epctx_t *); |
| 525 | void xhci_dump_devctx(const devctx_t *, const u32 ctx_mask); |
| 526 | void xhci_dump_inputctx(const inputctx_t *); |
| 527 | void xhci_dump_transfer_trb(const trb_t *); |
| 528 | void xhci_dump_transfer_trbs(const trb_t *first, const trb_t *last); |
| 529 | #else |
| 530 | #define xhci_dump_slotctx(args...) do {} while(0) |
| 531 | #define xhci_dump_epctx(args...) do {} while(0) |
| 532 | #define xhci_dump_devctx(args...) do {} while(0) |
| 533 | #define xhci_dump_inputctx(args...) do {} while(0) |
| 534 | #define xhci_dump_transfer_trb(args...) do {} while(0) |
| 535 | #define xhci_dump_transfer_trbs(args...) do {} while(0) |
| 536 | #endif |
| 537 | |
Patrick Georgi | 6615ef3 | 2010-08-13 09:18:58 +0000 | [diff] [blame] | 538 | #endif |