README revision 7c478bd95313f5f23a4c958a745db2134aa03244
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License"). You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
/*
* Copyright 2002 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#pragma ident "%Z%%M% %I% %E% SMI"
USBA PIPE STATE TRANSITIONS INFORMATION
---------------------------------------
1. Control pipe state transitions:-
o Default control pipe (endpoint number 0):
NOTE:- Queuing of control requests are allowed at USBA level.
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_ctrl_xfer USB_PIPE_STATE_IDLE No outstanding request send req to hcd USB_PIPE_STATE_ACTIVE
Outstanding reqs pending queue the requests USB_PIPE_STATE_IDLE
(cb() will send
next reqs to hcd)
USB_PIPE_STATE_ACTIVE - queue the requests USB_PIPE_STATE_ACTIVE
(cb() will send
next reqs to hcd)
USB_PIPE_STATE_ERROR - queue the requests USB_PIPE_STATE_ERROR
(cb() will send
next reqs to hcd)
USB_PIPE_STATE_CLOSING - return failure USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE - Before doing callback USB_PIPE_STATE_IDLE
(Normal callback) No outstanding request - USB_PIPE_STATE_IDLE
Outstanding reqs pending Send next req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - Don't send any more req USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - Don't send any more req USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Don't remove
outstanding requests)
No outstanding request - USB_PIPE_STATE_IDLE
Outstanding reqs pending Send next req to hcd USB_PIPE_STATE_ACTIVE
usb_pipe_reset USB_PIPE_STATE_XXXX - Return failure USB_PIPE_STATE_XXXX
(Not allowed)
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
o Normal control pipe (endpoint number > 0):
NOTE:- Queuing of control requests are allowed at USBA level.
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_ctrl_xfer USB_PIPE_STATE_IDLE No outstanding request send req to hcd USB_PIPE_STATE_ACTIVE
Outstanding reqs pending queue the requests USB_PIPE_STATE_IDLE
(cb() will send
next reqs to hcd)
USB_PIPE_STATE_ACTIVE - queue the requests USB_PIPE_STATE_ACTIVE
(cb() will send
next reqs to hcd)
USB_PIPE_STATE_ERROR - return failure USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - return failure USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE - Before doing callback USB_PIPE_STATE_IDLE
(Normal callback) No outstanding request - USB_PIPE_STATE_IDLE
Outstanding reqs pending Send next req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - Don't send any more req USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
2. Bulk pipe state transitions (endpoint number > 1, both IN and OUT):-
NOTE:- Queuing of bulk requests are allowed at USBA level.
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_bulk_xfer USB_PIPE_STATE_IDLE No outstanding request send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ACTIVE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - return failure USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - return failure USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE if no requests are pending Before doing callback USB_PIPE_STATE_IDLE
else outstanding reqs pending Before doing callback USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - - USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - - USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
3. Interrupt pipe state transitions (endpoint number > 1, both IN and OUT) :-
Interrupt IN:
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_intr_xfer USB_PIPE_STATE_IDLE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ACTIVE - return failure USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE One time xfer Before doing callback USB_PIPE_STATE_IDLE
USB_CR_STOPPED_POLLING
USB_CR_PIPE_RESET
USB_PIPE_STATE_ERROR - - USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - - USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
Interrupt OUT:
NOTE: Send all interrupt OUT requests to HCD and no queuing at USBA level.
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_intr_xfer USB_PIPE_STATE_IDLE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ACTIVE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - return failure USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - return failure USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE if no requests are pending Before doing callback USB_PIPE_STATE_IDLE
else outstanding reqs pending Before doing callback USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - - USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - - USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
4. Isochronous pipe state transitions (endpoint number > 1, both IN and OUT):-
Isochronous IN:
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_isoch_xfer USB_PIPE_STATE_IDLE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ACTIVE - return failure USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE One time xfer Before doing callback USB_PIPE_STATE_IDLE
USB_CR_STOPPED_POLLING
USB_CR_PIPE_RESET
USB_PIPE_STATE_ERROR - - USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - - USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED
Isochronous OUT:-
NOTE: Send all isochronous OUT requests to HCD and no queuing at USBA level.
Calls Current state additional condition Action Next state
----- ------------- -------------------- ------ -----------
usb_pipe_open USB_PIPE_STATE_CLOSED - Initialize pipe USB_PIPE_STATE_IDLE
usb_pipe_intr_xfer USB_PIPE_STATE_IDLE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ACTIVE - send req to hcd USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - return failure USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - return failure USB_PIPE_STATE_CLOSING
usba_hcdi_cb USB_PIPE_STATE_ACTIVE if no requests are pending Before doing callback USB_PIPE_STATE_IDLE
else outstanding reqs pending Before doing callback USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR - - USB_PIPE_STATE_ERROR
USB_PIPE_STATE_CLOSING - - USB_PIPE_STATE_CLOSING
usba_hcdi_cb
(exceptional callback) USB_PIPE_STATE_ACTIVE - Before auto clear USB_PIPE_STATE_ERROR
- On auto clear USB_PIPE_STATE_IDLE
(Remove all outstanding
requests)
usb_pipe_reset USB_PIPE_STATE_XXXX - Remove all outstanding USB_PIPE_STATE_IDLE
requests
usb_pipe_close USB_PIPE_STATE_IDLE - - USB_PIPE_STATE_CLOSING
USB_PIPE_STATE_ACTIVE
USB_PIPE_STATE_ERROR
Once pipe is closed - USB_PIPE_STATE_CLOSED