source: mainline/uspace/drv/bus/usb/xhci/hw_struct/trb.h@ ae7d03c

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since ae7d03c was ae7d03c, checked in by Jiri Svoboda <jiri@…>, 7 years ago

Selected ccheck-proposed comment fixes.
  • Property mode set to 100644
File size: 8.4 KB
Line 
1/*
2 * Copyright (c) 2018 Ondrej Hlavaty, Michal Staruch, Jaroslav Jindrak
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 * TRB-related structures of the xHC.
34 *
35 * This file contains all the types of TRB and the TRB ring handling.
36 */
37
38#ifndef XHCI_TRB_H
39#define XHCI_TRB_H
40
41#include "common.h"
42#include <libarch/barrier.h>
43
44/**
45 * TRB types: section 6.4.6, table 139
46 */
47enum xhci_trb_type {
48 XHCI_TRB_TYPE_RESERVED = 0,
49
50 /*
51 * Transfer ring:
52 */
53 XHCI_TRB_TYPE_NORMAL,
54 XHCI_TRB_TYPE_SETUP_STAGE,
55 XHCI_TRB_TYPE_DATA_STAGE,
56 XHCI_TRB_TYPE_STATUS_STAGE,
57 XHCI_TRB_TYPE_ISOCH,
58 XHCI_TRB_TYPE_LINK,
59 XHCI_TRB_TYPE_EVENT_DATA,
60 XHCI_TRB_TYPE_NO_OP,
61
62 /*
63 * Command ring:
64 */
65 XHCI_TRB_TYPE_ENABLE_SLOT_CMD,
66 XHCI_TRB_TYPE_DISABLE_SLOT_CMD,
67 XHCI_TRB_TYPE_ADDRESS_DEVICE_CMD,
68 XHCI_TRB_TYPE_CONFIGURE_ENDPOINT_CMD,
69 XHCI_TRB_TYPE_EVALUATE_CONTEXT_CMD,
70 XHCI_TRB_TYPE_RESET_ENDPOINT_CMD,
71 XHCI_TRB_TYPE_STOP_ENDPOINT_CMD,
72 XHCI_TRB_TYPE_SET_TR_DEQUEUE_POINTER_CMD,
73 XHCI_TRB_TYPE_RESET_DEVICE_CMD,
74 XHCI_TRB_TYPE_FORCE_EVENT_CMD,
75 XHCI_TRB_TYPE_NEGOTIATE_BANDWIDTH_CMD,
76 XHCI_TRB_TYPE_SET_LATENCY_TOLERANCE_VALUE_CMD,
77 XHCI_TRB_TYPE_GET_PORT_BANDWIDTH_CMD,
78 XHCI_TRB_TYPE_FORCE_HEADER_CMD,
79 XHCI_TRB_TYPE_NO_OP_CMD,
80 /*
81 * Reserved: 24-31
82 */
83
84 /*
85 * Event ring:
86 */
87 XHCI_TRB_TYPE_TRANSFER_EVENT = 32,
88 XHCI_TRB_TYPE_COMMAND_COMPLETION_EVENT,
89 XHCI_TRB_TYPE_PORT_STATUS_CHANGE_EVENT,
90 XHCI_TRB_TYPE_BANDWIDTH_REQUEST_EVENT,
91 XHCI_TRB_TYPE_DOORBELL_EVENT,
92 XHCI_TRB_TYPE_HOST_CONTROLLER_EVENT,
93 XHCI_TRB_TYPE_DEVICE_NOTIFICATION_EVENT,
94 XHCI_TRB_TYPE_MFINDEX_WRAP_EVENT,
95
96 XHCI_TRB_TYPE_MAX
97};
98
99/**
100 * TRB template: section 4.11.1
101 */
102typedef struct xhci_trb {
103 xhci_qword_t parameter;
104 xhci_dword_t status;
105 xhci_dword_t control;
106} __attribute__((packed)) __attribute__((aligned(16))) xhci_trb_t;
107
108#define TRB_TYPE(trb) XHCI_DWORD_EXTRACT((trb).control, 15, 10)
109#define TRB_CYCLE(trb) XHCI_DWORD_EXTRACT((trb).control, 0, 0)
110#define TRB_LINK_TC(trb) XHCI_DWORD_EXTRACT((trb).control, 1, 1)
111#define TRB_IOC(trb) XHCI_DWORD_EXTRACT((trb).control, 5, 5)
112#define TRB_EVENT_DATA(trb) XHCI_DWORD_EXTRACT((trb).control, 2, 2)
113
114#define TRB_TRANSFER_LENGTH(trb) XHCI_DWORD_EXTRACT((trb).status, 23, 0)
115#define TRB_COMPLETION_CODE(trb) XHCI_DWORD_EXTRACT((trb).status, 31, 24)
116
117#define TRB_LINK_SET_TC(trb, val) \
118 xhci_dword_set_bits(&(trb).control, val, 1, 1)
119#define TRB_SET_CYCLE(trb, val) \
120 xhci_dword_set_bits(&(trb).control, val, 0, 0)
121
122#define TRB_CTRL_SET_SETUP_WLENGTH(trb, val) \
123 xhci_qword_set_bits(&(trb).parameter, val, 63, 48)
124#define TRB_CTRL_SET_SETUP_WINDEX(trb, val) \
125 xhci_qword_set_bits(&(trb).parameter, val, 47, 32)
126#define TRB_CTRL_SET_SETUP_WVALUE(trb, val) \
127 xhci_qword_set_bits(&(trb).parameter, val, 31, 16)
128#define TRB_CTRL_SET_SETUP_BREQ(trb, val) \
129 xhci_qword_set_bits(&(trb).parameter, val, 15, 8)
130#define TRB_CTRL_SET_SETUP_BMREQTYPE(trb, val) \
131 xhci_qword_set_bits(&(trb).parameter, val, 7, 0)
132
133#define TRB_CTRL_SET_TD_SIZE(trb, val) \
134 xhci_dword_set_bits(&(trb).status, val, 21, 17)
135#define TRB_CTRL_SET_XFER_LEN(trb, val) \
136 xhci_dword_set_bits(&(trb).status, val, 16, 0)
137
138#define TRB_CTRL_SET_ENT(trb, val) \
139 xhci_dword_set_bits(&(trb).control, val, 1, 1)
140#define TRB_CTRL_SET_ISP(trb, val) \
141 xhci_dword_set_bits(&(trb).control, val, 2, 2)
142#define TRB_CTRL_SET_NS(trb, val) \
143 xhci_dword_set_bits(&(trb).control, val, 3, 3)
144#define TRB_CTRL_SET_CHAIN(trb, val) \
145 xhci_dword_set_bits(&(trb).control, val, 4, 4)
146#define TRB_CTRL_SET_IOC(trb, val) \
147 xhci_dword_set_bits(&(trb).control, val, 5, 5)
148#define TRB_CTRL_SET_IDT(trb, val) \
149 xhci_dword_set_bits(&(trb).control, val, 6, 6)
150
151#define TRB_CTRL_SET_TRB_TYPE(trb, val) \
152 xhci_dword_set_bits(&(trb).control, val, 15, 10)
153#define TRB_CTRL_SET_DIR(trb, val) \
154 xhci_dword_set_bits(&(trb).control, val, 16, 16)
155#define TRB_CTRL_SET_TRT(trb, val) \
156 xhci_dword_set_bits(&(trb).control, val, 17, 16)
157
158#define TRB_ISOCH_SET_TBC(trb, val) \
159 xhci_dword_set_bits(&(trb).control, val, 8, 7)
160#define TRB_ISOCH_SET_TLBPC(trb, val) \
161 xhci_dword_set_bits(&(trb).control, val, 19, 16)
162#define TRB_ISOCH_SET_FRAMEID(trb, val) \
163 xhci_dword_set_bits(&(trb).control, val, 30, 20)
164#define TRB_ISOCH_SET_SIA(trb, val) \
165 xhci_dword_set_bits(&(trb).control, val, 31, 31)
166
167/**
168 * The Chain bit is valid only in specific TRB types.
169 */
170static inline bool xhci_trb_is_chained(xhci_trb_t *trb)
171{
172 const int type = TRB_TYPE(*trb);
173 const bool chain_bit = XHCI_DWORD_EXTRACT(trb->control, 4, 4);
174
175 return chain_bit &&
176 (type == XHCI_TRB_TYPE_NORMAL ||
177 type == XHCI_TRB_TYPE_DATA_STAGE ||
178 type == XHCI_TRB_TYPE_STATUS_STAGE ||
179 type == XHCI_TRB_TYPE_ISOCH);
180}
181
182static inline void xhci_trb_link_fill(xhci_trb_t *trb, uintptr_t next_phys)
183{
184 // TRBs require 16-byte alignment
185 assert((next_phys & 0xf) == 0);
186
187 xhci_dword_set_bits(&trb->control, XHCI_TRB_TYPE_LINK, 15, 10);
188 xhci_qword_set(&trb->parameter, next_phys);
189}
190
191static inline void xhci_trb_copy_to_pio(xhci_trb_t *dst, xhci_trb_t *src)
192{
193 /*
194 * As we do not know, whether our architecture is capable of copying 16
195 * bytes atomically, let's copy the fields one by one.
196 */
197 dst->parameter = src->parameter;
198 dst->status = src->status;
199
200 write_barrier();
201
202 dst->control = src->control;
203}
204
205static inline void xhci_trb_clean(xhci_trb_t *trb)
206{
207 memset(trb, 0, sizeof(*trb));
208}
209
210/**
211 * Event Ring Segment Table: section 6.5
212 */
213typedef struct xhci_erst_entry {
214 xhci_qword_t rs_base_ptr; /* 64B aligned */
215 xhci_dword_t size; /* only low 16 bits, the rest is RsvdZ */
216 xhci_dword_t _reserved;
217} xhci_erst_entry_t;
218
219static inline void xhci_fill_erst_entry(xhci_erst_entry_t *entry,
220 uintptr_t phys, int segments)
221{
222 xhci_qword_set(&entry->rs_base_ptr, phys);
223 xhci_dword_set_bits(&entry->size, segments, 16, 0);
224}
225
226typedef enum xhci_trb_completion_code {
227 XHCI_TRBC_INVALID = 0,
228 XHCI_TRBC_SUCCESS,
229 XHCI_TRBC_DATA_BUFFER_ERROR,
230 XHCI_TRBC_BABBLE_DETECTED_ERROR,
231 XHCI_TRBC_USB_TRANSACTION_ERROR,
232 XHCI_TRBC_TRB_ERROR,
233 XHCI_TRBC_STALL_ERROR,
234 XHCI_TRBC_RESOURCE_ERROR,
235 XHCI_TRBC_BANDWIDTH_ERROR,
236 XHCI_TRBC_NO_SLOTS_ERROR,
237 XHCI_TRBC_INVALID_STREAM_ERROR,
238 XHCI_TRBC_SLOT_NOT_ENABLED_ERROR,
239 XHCI_TRBC_EP_NOT_ENABLED_ERROR,
240 XHCI_TRBC_SHORT_PACKET,
241 XHCI_TRBC_RING_UNDERRUN,
242 XHCI_TRBC_RING_OVERRUN,
243 XHCI_TRBC_VF_EVENT_RING_FULL,
244 XHCI_TRBC_PARAMETER_ERROR,
245 XHCI_TRBC_BANDWIDTH_OVERRUN_ERROR,
246 XHCI_TRBC_CONTEXT_STATE_ERROR,
247 XHCI_TRBC_NO_PING_RESPONSE_ERROR,
248 XHCI_TRBC_EVENT_RING_FULL_ERROR,
249 XHCI_TRBC_INCOMPATIBLE_DEVICE_ERROR,
250 XHCI_TRBC_MISSED_SERVICE_ERROR,
251 XHCI_TRBC_COMMAND_RING_STOPPED,
252 XHCI_TRBC_COMMAND_ABORTED,
253 XHCI_TRBC_STOPPED,
254 XHCI_TRBC_STOPPED_LENGTH_INVALID,
255 XHCI_TRBC_STOPPED_SHORT_PACKET,
256 XHCI_TRBC_MAX_EXIT_LATENCY_TOO_LARGE_ERROR,
257 /* 30 reserved */
258 XHCI_TRBC_ISOCH_BUFFER_OVERRUN = 31,
259 XHCI_TRBC_EVENT_LOST_ERROR,
260 XHCI_TRBC_UNDEFINED_ERROR,
261 XHCI_TRBC_INVALID_STREAM_ID_ERROR,
262 XHCI_TRBC_SECONDARY_BANDWIDTH_ERROR,
263 XHCI_TRBC_SPLIT_TRANSACTION_ERROR,
264 XHCI_TRBC_MAX
265 /**
266 * 37 - 191 reserved
267 * 192 - 223 vendor defined error
268 * 224 - 255 vendor defined info
269 */
270} xhci_trb_completion_code_t;
271
272#endif
Note: See TracBrowser for help on using the repository browser.