umass.c revision 1.148 1 1.148 mlelstv /* $NetBSD: umass.c,v 1.148 2013/12/22 18:30:21 mlelstv Exp $ */
2 1.102 mycroft
3 1.102 mycroft /*
4 1.102 mycroft * Copyright (c) 2003 The NetBSD Foundation, Inc.
5 1.102 mycroft * All rights reserved.
6 1.102 mycroft *
7 1.102 mycroft * This code is derived from software contributed to The NetBSD Foundation
8 1.104 mycroft * by Charles M. Hannum.
9 1.102 mycroft *
10 1.102 mycroft * Redistribution and use in source and binary forms, with or without
11 1.102 mycroft * modification, are permitted provided that the following conditions
12 1.102 mycroft * are met:
13 1.102 mycroft * 1. Redistributions of source code must retain the above copyright
14 1.102 mycroft * notice, this list of conditions and the following disclaimer.
15 1.102 mycroft * 2. Redistributions in binary form must reproduce the above copyright
16 1.102 mycroft * notice, this list of conditions and the following disclaimer in the
17 1.102 mycroft * documentation and/or other materials provided with the distribution.
18 1.102 mycroft *
19 1.102 mycroft * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.102 mycroft * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.102 mycroft * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.102 mycroft * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.102 mycroft * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.102 mycroft * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.102 mycroft * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.102 mycroft * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.102 mycroft * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.102 mycroft * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.102 mycroft * POSSIBILITY OF SUCH DAMAGE.
30 1.102 mycroft */
31 1.102 mycroft
32 1.1 thorpej /*-
33 1.1 thorpej * Copyright (c) 1999 MAEKAWA Masahide <bishop (at) rr.iij4u.or.jp>,
34 1.28 augustss * Nick Hibma <n_hibma (at) freebsd.org>
35 1.1 thorpej * All rights reserved.
36 1.1 thorpej *
37 1.1 thorpej * Redistribution and use in source and binary forms, with or without
38 1.1 thorpej * modification, are permitted provided that the following conditions
39 1.1 thorpej * are met:
40 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
41 1.1 thorpej * notice, this list of conditions and the following disclaimer.
42 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
43 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
44 1.1 thorpej * documentation and/or other materials provided with the distribution.
45 1.1 thorpej *
46 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
47 1.1 thorpej * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 1.1 thorpej * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 1.1 thorpej * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
50 1.1 thorpej * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 1.1 thorpej * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52 1.1 thorpej * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53 1.1 thorpej * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54 1.1 thorpej * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55 1.1 thorpej * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56 1.1 thorpej * SUCH DAMAGE.
57 1.1 thorpej *
58 1.28 augustss * $FreeBSD: src/sys/dev/usb/umass.c,v 1.13 2000/03/26 01:39:12 n_hibma Exp $
59 1.28 augustss */
60 1.28 augustss
61 1.28 augustss /*
62 1.47 augustss * Universal Serial Bus Mass Storage Class specs:
63 1.108 wiz * http://www.usb.org/developers/devclass_docs/usb_msc_overview_1.2.pdf
64 1.108 wiz * http://www.usb.org/developers/devclass_docs/usbmassbulk_10.pdf
65 1.108 wiz * http://www.usb.org/developers/devclass_docs/usb_msc_cbi_1.1.pdf
66 1.108 wiz * http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf
67 1.28 augustss */
68 1.28 augustss
69 1.28 augustss /*
70 1.109 keihan * Ported to NetBSD by Lennart Augustsson <augustss (at) NetBSD.org>.
71 1.90 pooka * Parts of the code written by Jason R. Thorpe <thorpej (at) shagadelic.org>.
72 1.1 thorpej */
73 1.1 thorpej
74 1.1 thorpej /*
75 1.28 augustss * The driver handles 3 Wire Protocols
76 1.28 augustss * - Command/Bulk/Interrupt (CBI)
77 1.28 augustss * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
78 1.28 augustss * - Mass Storage Bulk-Only (BBB)
79 1.28 augustss * (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
80 1.28 augustss *
81 1.28 augustss * Over these wire protocols it handles the following command protocols
82 1.28 augustss * - SCSI
83 1.54 augustss * - 8070 (ATA/ATAPI for rewritable removable media)
84 1.54 augustss * - UFI (USB Floppy Interface)
85 1.1 thorpej *
86 1.54 augustss * 8070i is a transformed version of the SCSI command set. UFI is a transformed
87 1.88 augustss * version of the 8070i command set. The sc->transform method is used to
88 1.54 augustss * convert the commands into the appropriate format (if at all necessary).
89 1.54 augustss * For example, ATAPI requires all commands to be 12 bytes in length amongst
90 1.54 augustss * other things.
91 1.3 thorpej *
92 1.28 augustss * The source code below is marked and can be split into a number of pieces
93 1.28 augustss * (in this order):
94 1.3 thorpej *
95 1.28 augustss * - probe/attach/detach
96 1.28 augustss * - generic transfer routines
97 1.28 augustss * - BBB
98 1.28 augustss * - CBI
99 1.28 augustss * - CBI_I (in addition to functions from CBI)
100 1.28 augustss * - CAM (Common Access Method)
101 1.28 augustss * - SCSI
102 1.28 augustss * - UFI
103 1.28 augustss * - 8070i
104 1.3 thorpej *
105 1.28 augustss * The protocols are implemented using a state machine, for the transfers as
106 1.28 augustss * well as for the resets. The state machine is contained in umass_*_state.
107 1.28 augustss * The state machine is started through either umass_*_transfer or
108 1.28 augustss * umass_*_reset.
109 1.28 augustss *
110 1.28 augustss * The reason for doing this is a) CAM performs a lot better this way and b) it
111 1.28 augustss * avoids using tsleep from interrupt context (for example after a failed
112 1.28 augustss * transfer).
113 1.1 thorpej */
114 1.1 thorpej
115 1.28 augustss /*
116 1.28 augustss * The SCSI related part of this driver has been derived from the
117 1.28 augustss * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch (at) freebsd.org).
118 1.1 thorpej *
119 1.28 augustss * The CAM layer uses so called actions which are messages sent to the host
120 1.28 augustss * adapter for completion. The actions come in through umass_cam_action. The
121 1.28 augustss * appropriate block of routines is called depending on the transport protocol
122 1.28 augustss * in use. When the transfer has finished, these routines call
123 1.28 augustss * umass_cam_cb again to complete the CAM command.
124 1.1 thorpej */
125 1.64 lukem
126 1.64 lukem #include <sys/cdefs.h>
127 1.148 mlelstv __KERNEL_RCSID(0, "$NetBSD: umass.c,v 1.148 2013/12/22 18:30:21 mlelstv Exp $");
128 1.140 christos
129 1.141 mbalmer #ifdef _KERNEL_OPT
130 1.140 christos #include "opt_umass.h"
131 1.141 mbalmer #endif
132 1.1 thorpej
133 1.29 enami #include "atapibus.h"
134 1.79 augustss #include "scsibus.h"
135 1.80 augustss #include "wd.h"
136 1.29 enami
137 1.1 thorpej #include <sys/param.h>
138 1.1 thorpej #include <sys/systm.h>
139 1.1 thorpej #include <sys/kernel.h>
140 1.28 augustss #include <sys/conf.h>
141 1.28 augustss #include <sys/buf.h>
142 1.28 augustss #include <sys/device.h>
143 1.1 thorpej #include <sys/malloc.h>
144 1.1 thorpej
145 1.1 thorpej #include <dev/usb/usb.h>
146 1.1 thorpej #include <dev/usb/usbdi.h>
147 1.1 thorpej #include <dev/usb/usbdi_util.h>
148 1.28 augustss #include <dev/usb/usbdevs.h>
149 1.1 thorpej
150 1.56 augustss #include <dev/usb/umassvar.h>
151 1.78 gehenna #include <dev/usb/umass_quirks.h>
152 1.79 augustss #include <dev/usb/umass_scsipi.h>
153 1.80 augustss #include <dev/usb/umass_isdata.h>
154 1.28 augustss
155 1.99 mycroft #include <dev/scsipi/scsipi_all.h>
156 1.99 mycroft #include <dev/scsipi/scsipiconf.h>
157 1.99 mycroft
158 1.28 augustss
159 1.28 augustss #ifdef UMASS_DEBUG
160 1.57 augustss int umassdebug = 0;
161 1.57 augustss
162 1.119 drochner const char *states[TSTATE_STATES+1] = {
163 1.28 augustss /* should be kept in sync with the list at transfer_state */
164 1.28 augustss "Idle",
165 1.28 augustss "BBB CBW",
166 1.28 augustss "BBB Data",
167 1.28 augustss "BBB Data bulk-in/-out clear stall",
168 1.28 augustss "BBB CSW, 1st attempt",
169 1.28 augustss "BBB CSW bulk-in clear stall",
170 1.28 augustss "BBB CSW, 2nd attempt",
171 1.28 augustss "BBB Reset",
172 1.28 augustss "BBB bulk-in clear stall",
173 1.28 augustss "BBB bulk-out clear stall",
174 1.28 augustss "CBI Command",
175 1.28 augustss "CBI Data",
176 1.28 augustss "CBI Status",
177 1.28 augustss "CBI Data bulk-in/-out clear stall",
178 1.28 augustss "CBI Status intr-in clear stall",
179 1.28 augustss "CBI Reset",
180 1.28 augustss "CBI bulk-in clear stall",
181 1.28 augustss "CBI bulk-out clear stall",
182 1.28 augustss NULL
183 1.28 augustss };
184 1.28 augustss #endif
185 1.1 thorpej
186 1.28 augustss /* USB device probe/attach/detach functions */
187 1.131 dyoung int umass_match(device_t, cfdata_t, void *);
188 1.131 dyoung void umass_attach(device_t, device_t, void *);
189 1.131 dyoung int umass_detach(device_t, int);
190 1.131 dyoung static void umass_childdet(device_t, device_t);
191 1.131 dyoung int umass_activate(device_t, enum devact);
192 1.131 dyoung extern struct cfdriver umass_cd;
193 1.131 dyoung CFATTACH_DECL2_NEW(umass, sizeof(struct umass_softc), umass_match, umass_attach,
194 1.131 dyoung umass_detach, umass_activate, NULL, umass_childdet);
195 1.131 dyoung
196 1.38 augustss Static void umass_disco(struct umass_softc *sc);
197 1.1 thorpej
198 1.28 augustss /* generic transfer functions */
199 1.38 augustss Static usbd_status umass_setup_transfer(struct umass_softc *sc,
200 1.1 thorpej usbd_pipe_handle pipe,
201 1.28 augustss void *buffer, int buflen, int flags,
202 1.38 augustss usbd_xfer_handle xfer);
203 1.38 augustss Static usbd_status umass_setup_ctrl_transfer(struct umass_softc *sc,
204 1.28 augustss usb_device_request_t *req,
205 1.88 augustss void *buffer, int buflen, int flags,
206 1.38 augustss usbd_xfer_handle xfer);
207 1.73 gehenna Static void umass_clear_endpoint_stall(struct umass_softc *sc, int endpt,
208 1.70 gehenna usbd_xfer_handle xfer);
209 1.29 enami #if 0
210 1.38 augustss Static void umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv);
211 1.29 enami #endif
212 1.1 thorpej
213 1.1 thorpej /* Bulk-Only related functions */
214 1.75 gehenna Static void umass_bbb_transfer(struct umass_softc *, int, void *, int, void *,
215 1.143 mrg int, int, u_int, int, umass_callback, void *);
216 1.75 gehenna Static void umass_bbb_reset(struct umass_softc *, int);
217 1.75 gehenna Static void umass_bbb_state(usbd_xfer_handle, usbd_private_handle, usbd_status);
218 1.28 augustss
219 1.75 gehenna usbd_status umass_bbb_get_max_lun(struct umass_softc *, u_int8_t *);
220 1.28 augustss
221 1.28 augustss /* CBI related functions */
222 1.88 augustss Static void umass_cbi_transfer(struct umass_softc *, int, void *, int, void *,
223 1.143 mrg int, int, u_int, int, umass_callback, void *);
224 1.75 gehenna Static void umass_cbi_reset(struct umass_softc *, int);
225 1.75 gehenna Static void umass_cbi_state(usbd_xfer_handle, usbd_private_handle, usbd_status);
226 1.75 gehenna
227 1.143 mrg Static int umass_cbi_adsc(struct umass_softc *, char *, int, int, usbd_xfer_handle);
228 1.75 gehenna
229 1.75 gehenna const struct umass_wire_methods umass_bbb_methods = {
230 1.75 gehenna umass_bbb_transfer,
231 1.75 gehenna umass_bbb_reset,
232 1.75 gehenna umass_bbb_state
233 1.75 gehenna };
234 1.75 gehenna
235 1.75 gehenna const struct umass_wire_methods umass_cbi_methods = {
236 1.75 gehenna umass_cbi_transfer,
237 1.75 gehenna umass_cbi_reset,
238 1.75 gehenna umass_cbi_state
239 1.75 gehenna };
240 1.28 augustss
241 1.28 augustss #ifdef UMASS_DEBUG
242 1.28 augustss /* General debugging functions */
243 1.38 augustss Static void umass_bbb_dump_cbw(struct umass_softc *sc,
244 1.38 augustss umass_bbb_cbw_t *cbw);
245 1.38 augustss Static void umass_bbb_dump_csw(struct umass_softc *sc,
246 1.38 augustss umass_bbb_csw_t *csw);
247 1.38 augustss Static void umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer,
248 1.38 augustss int buflen, int printlen);
249 1.28 augustss #endif
250 1.28 augustss
251 1.28 augustss
252 1.28 augustss /*
253 1.28 augustss * USB device probe/attach/detach
254 1.28 augustss */
255 1.28 augustss
256 1.131 dyoung int
257 1.131 dyoung umass_match(device_t parent, cfdata_t match, void *aux)
258 1.28 augustss {
259 1.131 dyoung struct usbif_attach_arg *uaa = aux;
260 1.78 gehenna const struct umass_quirk *quirk;
261 1.28 augustss
262 1.78 gehenna quirk = umass_lookup(uaa->vendor, uaa->product);
263 1.126 ichiro if (quirk != NULL && quirk->uq_match != UMASS_QUIRK_USE_DEFAULTMATCH)
264 1.78 gehenna return (quirk->uq_match);
265 1.40 augustss
266 1.124 drochner if (uaa->class != UICLASS_MASS)
267 1.28 augustss return (UMATCH_NONE);
268 1.1 thorpej
269 1.124 drochner switch (uaa->subclass) {
270 1.78 gehenna case UISUBCLASS_RBC:
271 1.78 gehenna case UISUBCLASS_SFF8020I:
272 1.78 gehenna case UISUBCLASS_QIC157:
273 1.28 augustss case UISUBCLASS_UFI:
274 1.28 augustss case UISUBCLASS_SFF8070I:
275 1.78 gehenna case UISUBCLASS_SCSI:
276 1.40 augustss break;
277 1.28 augustss default:
278 1.78 gehenna return (UMATCH_IFACECLASS);
279 1.28 augustss }
280 1.28 augustss
281 1.124 drochner switch (uaa->proto) {
282 1.78 gehenna case UIPROTO_MASS_CBI_I:
283 1.28 augustss case UIPROTO_MASS_CBI:
284 1.78 gehenna case UIPROTO_MASS_BBB_OLD:
285 1.28 augustss case UIPROTO_MASS_BBB:
286 1.28 augustss break;
287 1.28 augustss default:
288 1.78 gehenna return (UMATCH_IFACECLASS_IFACESUBCLASS);
289 1.28 augustss }
290 1.1 thorpej
291 1.78 gehenna return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
292 1.1 thorpej }
293 1.1 thorpej
294 1.131 dyoung void
295 1.131 dyoung umass_attach(device_t parent, device_t self, void *aux)
296 1.1 thorpej {
297 1.131 dyoung struct umass_softc *sc = device_private(self);
298 1.131 dyoung struct usbif_attach_arg *uaa = aux;
299 1.78 gehenna const struct umass_quirk *quirk;
300 1.1 thorpej usb_interface_descriptor_t *id;
301 1.1 thorpej usb_endpoint_descriptor_t *ed;
302 1.78 gehenna const char *sWire, *sCommand;
303 1.118 augustss char *devinfop;
304 1.78 gehenna usbd_status err;
305 1.148 mlelstv int i, error;
306 1.1 thorpej
307 1.128 cube sc->sc_dev = self;
308 1.128 cube
309 1.134 plunky aprint_naive("\n");
310 1.134 plunky aprint_normal("\n");
311 1.134 plunky
312 1.145 mrg mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_USB);
313 1.145 mrg cv_init(&sc->sc_detach_cv, "umassdet");
314 1.145 mrg
315 1.118 augustss devinfop = usbd_devinfo_alloc(uaa->device, 0);
316 1.134 plunky aprint_normal_dev(self, "%s\n", devinfop);
317 1.118 augustss usbd_devinfo_free(devinfop);
318 1.1 thorpej
319 1.78 gehenna sc->sc_udev = uaa->device;
320 1.76 gehenna sc->sc_iface = uaa->iface;
321 1.76 gehenna sc->sc_ifaceno = uaa->ifaceno;
322 1.28 augustss
323 1.78 gehenna quirk = umass_lookup(uaa->vendor, uaa->product);
324 1.78 gehenna if (quirk != NULL) {
325 1.78 gehenna sc->sc_wire = quirk->uq_wire;
326 1.78 gehenna sc->sc_cmd = quirk->uq_cmd;
327 1.78 gehenna sc->sc_quirks = quirk->uq_flags;
328 1.82 augustss sc->sc_busquirks = quirk->uq_busquirks;
329 1.78 gehenna
330 1.78 gehenna if (quirk->uq_fixup != NULL)
331 1.78 gehenna (*quirk->uq_fixup)(sc);
332 1.78 gehenna } else {
333 1.78 gehenna sc->sc_wire = UMASS_WPROTO_UNSPEC;
334 1.78 gehenna sc->sc_cmd = UMASS_CPROTO_UNSPEC;
335 1.78 gehenna sc->sc_quirks = 0;
336 1.82 augustss sc->sc_busquirks = 0;
337 1.78 gehenna }
338 1.78 gehenna
339 1.78 gehenna if (sc->sc_wire == UMASS_WPROTO_UNSPEC) {
340 1.124 drochner switch (uaa->proto) {
341 1.78 gehenna case UIPROTO_MASS_CBI:
342 1.78 gehenna sc->sc_wire = UMASS_WPROTO_CBI;
343 1.78 gehenna break;
344 1.78 gehenna case UIPROTO_MASS_CBI_I:
345 1.78 gehenna sc->sc_wire = UMASS_WPROTO_CBI_I;
346 1.78 gehenna break;
347 1.78 gehenna case UIPROTO_MASS_BBB:
348 1.78 gehenna case UIPROTO_MASS_BBB_OLD:
349 1.78 gehenna sc->sc_wire = UMASS_WPROTO_BBB;
350 1.78 gehenna break;
351 1.78 gehenna default:
352 1.78 gehenna DPRINTF(UDMASS_GEN,
353 1.78 gehenna ("%s: Unsupported wire protocol %u\n",
354 1.131 dyoung device_xname(sc->sc_dev),
355 1.124 drochner uaa->proto));
356 1.131 dyoung return;
357 1.78 gehenna }
358 1.40 augustss }
359 1.28 augustss
360 1.78 gehenna if (sc->sc_cmd == UMASS_CPROTO_UNSPEC) {
361 1.124 drochner switch (uaa->subclass) {
362 1.78 gehenna case UISUBCLASS_SCSI:
363 1.78 gehenna sc->sc_cmd = UMASS_CPROTO_SCSI;
364 1.78 gehenna break;
365 1.78 gehenna case UISUBCLASS_UFI:
366 1.78 gehenna sc->sc_cmd = UMASS_CPROTO_UFI;
367 1.78 gehenna break;
368 1.78 gehenna case UISUBCLASS_SFF8020I:
369 1.78 gehenna case UISUBCLASS_SFF8070I:
370 1.78 gehenna case UISUBCLASS_QIC157:
371 1.78 gehenna sc->sc_cmd = UMASS_CPROTO_ATAPI;
372 1.78 gehenna break;
373 1.78 gehenna case UISUBCLASS_RBC:
374 1.78 gehenna sc->sc_cmd = UMASS_CPROTO_RBC;
375 1.78 gehenna break;
376 1.78 gehenna default:
377 1.78 gehenna DPRINTF(UDMASS_GEN,
378 1.78 gehenna ("%s: Unsupported command protocol %u\n",
379 1.131 dyoung device_xname(sc->sc_dev),
380 1.124 drochner uaa->subclass));
381 1.131 dyoung return;
382 1.78 gehenna }
383 1.78 gehenna }
384 1.17 thorpej
385 1.78 gehenna switch (sc->sc_wire) {
386 1.78 gehenna case UMASS_WPROTO_CBI:
387 1.78 gehenna sWire = "CBI";
388 1.32 augustss break;
389 1.78 gehenna case UMASS_WPROTO_CBI_I:
390 1.78 gehenna sWire = "CBI with CCI";
391 1.28 augustss break;
392 1.78 gehenna case UMASS_WPROTO_BBB:
393 1.78 gehenna sWire = "Bulk-Only";
394 1.28 augustss break;
395 1.17 thorpej default:
396 1.78 gehenna sWire = "unknown";
397 1.28 augustss break;
398 1.17 thorpej }
399 1.78 gehenna
400 1.78 gehenna switch (sc->sc_cmd) {
401 1.78 gehenna case UMASS_CPROTO_RBC:
402 1.78 gehenna sCommand = "RBC";
403 1.78 gehenna break;
404 1.78 gehenna case UMASS_CPROTO_SCSI:
405 1.78 gehenna sCommand = "SCSI";
406 1.28 augustss break;
407 1.78 gehenna case UMASS_CPROTO_UFI:
408 1.78 gehenna sCommand = "UFI";
409 1.28 augustss break;
410 1.78 gehenna case UMASS_CPROTO_ATAPI:
411 1.78 gehenna sCommand = "ATAPI";
412 1.32 augustss break;
413 1.80 augustss case UMASS_CPROTO_ISD_ATA:
414 1.80 augustss sCommand = "ISD-ATA";
415 1.80 augustss break;
416 1.17 thorpej default:
417 1.78 gehenna sCommand = "unknown";
418 1.32 augustss break;
419 1.17 thorpej }
420 1.78 gehenna
421 1.132 jmcneill aprint_verbose_dev(self, "using %s over %s\n", sCommand, sWire);
422 1.1 thorpej
423 1.104 mycroft if (quirk != NULL && quirk->uq_init != NULL) {
424 1.104 mycroft err = (*quirk->uq_init)(sc);
425 1.104 mycroft if (err) {
426 1.128 cube aprint_error_dev(self, "quirk init failed\n");
427 1.104 mycroft umass_disco(sc);
428 1.131 dyoung return;
429 1.104 mycroft }
430 1.104 mycroft }
431 1.104 mycroft
432 1.1 thorpej /*
433 1.28 augustss * In addition to the Control endpoint the following endpoints
434 1.28 augustss * are required:
435 1.28 augustss * a) bulk-in endpoint.
436 1.28 augustss * b) bulk-out endpoint.
437 1.28 augustss * and for Control/Bulk/Interrupt with CCI (CBI_I)
438 1.28 augustss * c) intr-in
439 1.1 thorpej *
440 1.1 thorpej * The endpoint addresses are not fixed, so we have to read them
441 1.1 thorpej * from the device descriptors of the current interface.
442 1.1 thorpej */
443 1.124 drochner id = usbd_get_interface_descriptor(sc->sc_iface);
444 1.1 thorpej for (i = 0 ; i < id->bNumEndpoints ; i++) {
445 1.76 gehenna ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
446 1.78 gehenna if (ed == NULL) {
447 1.128 cube aprint_error_dev(self,
448 1.128 cube "could not read endpoint descriptor\n");
449 1.131 dyoung return;
450 1.1 thorpej }
451 1.11 augustss if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
452 1.1 thorpej && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
453 1.73 gehenna sc->sc_epaddr[UMASS_BULKIN] = ed->bEndpointAddress;
454 1.11 augustss } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT
455 1.1 thorpej && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
456 1.73 gehenna sc->sc_epaddr[UMASS_BULKOUT] = ed->bEndpointAddress;
457 1.78 gehenna } else if (sc->sc_wire == UMASS_WPROTO_CBI_I
458 1.28 augustss && UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN
459 1.28 augustss && (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
460 1.73 gehenna sc->sc_epaddr[UMASS_INTRIN] = ed->bEndpointAddress;
461 1.28 augustss #ifdef UMASS_DEBUG
462 1.28 augustss if (UGETW(ed->wMaxPacketSize) > 2) {
463 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: intr size is %d\n",
464 1.131 dyoung device_xname(sc->sc_dev),
465 1.28 augustss UGETW(ed->wMaxPacketSize)));
466 1.28 augustss }
467 1.28 augustss #endif
468 1.1 thorpej }
469 1.1 thorpej }
470 1.1 thorpej
471 1.28 augustss /* check whether we found all the endpoints we need */
472 1.73 gehenna if (!sc->sc_epaddr[UMASS_BULKIN] || !sc->sc_epaddr[UMASS_BULKOUT] ||
473 1.78 gehenna (sc->sc_wire == UMASS_WPROTO_CBI_I &&
474 1.78 gehenna !sc->sc_epaddr[UMASS_INTRIN])) {
475 1.128 cube aprint_error_dev(self, "endpoint not found %u/%u/%u\n",
476 1.128 cube sc->sc_epaddr[UMASS_BULKIN],
477 1.105 augustss sc->sc_epaddr[UMASS_BULKOUT],
478 1.105 augustss sc->sc_epaddr[UMASS_INTRIN]);
479 1.131 dyoung return;
480 1.28 augustss }
481 1.28 augustss
482 1.7 thorpej /*
483 1.7 thorpej * Get the maximum LUN supported by the device.
484 1.7 thorpej */
485 1.129 rmind if (sc->sc_wire == UMASS_WPROTO_BBB &&
486 1.129 rmind (sc->sc_quirks & UMASS_QUIRK_NOGETMAXLUN) == 0) {
487 1.28 augustss err = umass_bbb_get_max_lun(sc, &sc->maxlun);
488 1.28 augustss if (err) {
489 1.128 cube aprint_error_dev(self, "unable to get Max Lun: %s\n",
490 1.128 cube usbd_errstr(err));
491 1.131 dyoung return;
492 1.28 augustss }
493 1.99 mycroft if (sc->maxlun > 0)
494 1.99 mycroft sc->sc_busquirks |= PQUIRK_FORCELUNS;
495 1.28 augustss } else {
496 1.28 augustss sc->maxlun = 0;
497 1.7 thorpej }
498 1.7 thorpej
499 1.1 thorpej /* Open the bulk-in and -out pipe */
500 1.100 mycroft DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for BULKOUT\n",
501 1.131 dyoung device_xname(sc->sc_dev), sc->sc_iface,
502 1.100 mycroft sc->sc_epaddr[UMASS_BULKOUT]));
503 1.76 gehenna err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKOUT],
504 1.73 gehenna USBD_EXCLUSIVE_USE,
505 1.73 gehenna &sc->sc_pipe[UMASS_BULKOUT]);
506 1.1 thorpej if (err) {
507 1.128 cube aprint_error_dev(self, "cannot open %u-out pipe (bulk)\n",
508 1.128 cube sc->sc_epaddr[UMASS_BULKOUT]);
509 1.28 augustss umass_disco(sc);
510 1.131 dyoung return;
511 1.1 thorpej }
512 1.100 mycroft DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for BULKIN\n",
513 1.131 dyoung device_xname(sc->sc_dev), sc->sc_iface,
514 1.100 mycroft sc->sc_epaddr[UMASS_BULKIN]));
515 1.76 gehenna err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_BULKIN],
516 1.73 gehenna USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_BULKIN]);
517 1.1 thorpej if (err) {
518 1.128 cube aprint_error_dev(self, "could not open %u-in pipe (bulk)\n",
519 1.128 cube sc->sc_epaddr[UMASS_BULKIN]);
520 1.28 augustss umass_disco(sc);
521 1.131 dyoung return;
522 1.1 thorpej }
523 1.88 augustss /*
524 1.28 augustss * Open the intr-in pipe if the protocol is CBI with CCI.
525 1.28 augustss * Note: early versions of the Zip drive do have an interrupt pipe, but
526 1.28 augustss * this pipe is unused
527 1.28 augustss *
528 1.28 augustss * We do not open the interrupt pipe as an interrupt pipe, but as a
529 1.28 augustss * normal bulk endpoint. We send an IN transfer down the wire at the
530 1.28 augustss * appropriate time, because we know exactly when to expect data on
531 1.28 augustss * that endpoint. This saves bandwidth, but more important, makes the
532 1.28 augustss * code for handling the data on that endpoint simpler. No data
533 1.28 augustss * arriving concurrently.
534 1.28 augustss */
535 1.78 gehenna if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
536 1.100 mycroft DPRINTF(UDMASS_USB, ("%s: opening iface %p epaddr %d for INTRIN\n",
537 1.131 dyoung device_xname(sc->sc_dev), sc->sc_iface,
538 1.100 mycroft sc->sc_epaddr[UMASS_INTRIN]));
539 1.76 gehenna err = usbd_open_pipe(sc->sc_iface, sc->sc_epaddr[UMASS_INTRIN],
540 1.73 gehenna USBD_EXCLUSIVE_USE, &sc->sc_pipe[UMASS_INTRIN]);
541 1.28 augustss if (err) {
542 1.128 cube aprint_error_dev(self, "couldn't open %u-in (intr)\n",
543 1.128 cube sc->sc_epaddr[UMASS_INTRIN]);
544 1.28 augustss umass_disco(sc);
545 1.131 dyoung return;
546 1.28 augustss }
547 1.28 augustss }
548 1.28 augustss
549 1.28 augustss /* initialisation of generic part */
550 1.28 augustss sc->transfer_state = TSTATE_IDLE;
551 1.28 augustss
552 1.28 augustss /* request a sufficient number of xfer handles */
553 1.28 augustss for (i = 0; i < XFER_NR; i++) {
554 1.28 augustss sc->transfer_xfer[i] = usbd_alloc_xfer(uaa->device);
555 1.92 tron if (sc->transfer_xfer[i] == NULL) {
556 1.128 cube aprint_error_dev(self, "Out of memory\n");
557 1.28 augustss umass_disco(sc);
558 1.131 dyoung return;
559 1.28 augustss }
560 1.28 augustss }
561 1.148 mlelstv /* Allocate buffer for data transfer (it's huge), command and
562 1.148 mlelstv status data here as auto allocation cannot happen in interrupt
563 1.148 mlelstv context */
564 1.78 gehenna switch (sc->sc_wire) {
565 1.78 gehenna case UMASS_WPROTO_BBB:
566 1.148 mlelstv sc->data_buffer = usbd_alloc_buffer(
567 1.148 mlelstv sc->transfer_xfer[XFER_BBB_DATA],
568 1.148 mlelstv UMASS_MAX_TRANSFER_SIZE);
569 1.148 mlelstv sc->cmd_buffer = usbd_alloc_buffer(
570 1.148 mlelstv sc->transfer_xfer[XFER_BBB_CBW],
571 1.148 mlelstv UMASS_BBB_CBW_SIZE);
572 1.148 mlelstv sc->s1_buffer = usbd_alloc_buffer(
573 1.148 mlelstv sc->transfer_xfer[XFER_BBB_CSW1],
574 1.148 mlelstv UMASS_BBB_CSW_SIZE);
575 1.148 mlelstv sc->s2_buffer = usbd_alloc_buffer(
576 1.148 mlelstv sc->transfer_xfer[XFER_BBB_CSW2],
577 1.148 mlelstv UMASS_BBB_CSW_SIZE);
578 1.148 mlelstv break;
579 1.78 gehenna case UMASS_WPROTO_CBI:
580 1.78 gehenna case UMASS_WPROTO_CBI_I:
581 1.148 mlelstv sc->data_buffer = usbd_alloc_buffer(
582 1.148 mlelstv sc->transfer_xfer[XFER_CBI_DATA],
583 1.148 mlelstv UMASS_MAX_TRANSFER_SIZE);
584 1.148 mlelstv sc->cmd_buffer = usbd_alloc_buffer(
585 1.148 mlelstv sc->transfer_xfer[XFER_CBI_CB],
586 1.148 mlelstv sizeof(sc->cbl));
587 1.148 mlelstv sc->s1_buffer = usbd_alloc_buffer(
588 1.148 mlelstv sc->transfer_xfer[XFER_CBI_STATUS],
589 1.148 mlelstv sizeof(sc->sbl));
590 1.148 mlelstv sc->s2_buffer = usbd_alloc_buffer(
591 1.148 mlelstv sc->transfer_xfer[XFER_CBI_RESET1],
592 1.148 mlelstv sizeof(sc->cbl));
593 1.28 augustss break;
594 1.28 augustss default:
595 1.28 augustss break;
596 1.28 augustss }
597 1.1 thorpej
598 1.148 mlelstv if (sc->data_buffer == NULL || sc->cmd_buffer == NULL
599 1.148 mlelstv || sc->s1_buffer == NULL || sc->s2_buffer == NULL) {
600 1.148 mlelstv /*
601 1.148 mlelstv * partially preallocated buffers are freed with
602 1.148 mlelstv * the xfer structures
603 1.148 mlelstv */
604 1.148 mlelstv aprint_error_dev(self, "no buffer memory\n");
605 1.148 mlelstv umass_disco(sc);
606 1.148 mlelstv return;
607 1.148 mlelstv }
608 1.148 mlelstv
609 1.28 augustss /* Initialise the wire protocol specific methods */
610 1.78 gehenna switch (sc->sc_wire) {
611 1.78 gehenna case UMASS_WPROTO_BBB:
612 1.75 gehenna sc->sc_methods = &umass_bbb_methods;
613 1.78 gehenna break;
614 1.78 gehenna case UMASS_WPROTO_CBI:
615 1.78 gehenna case UMASS_WPROTO_CBI_I:
616 1.75 gehenna sc->sc_methods = &umass_cbi_methods;
617 1.78 gehenna break;
618 1.78 gehenna default:
619 1.78 gehenna umass_disco(sc);
620 1.131 dyoung return;
621 1.78 gehenna }
622 1.28 augustss
623 1.79 augustss error = 0;
624 1.79 augustss switch (sc->sc_cmd) {
625 1.79 augustss case UMASS_CPROTO_RBC:
626 1.79 augustss case UMASS_CPROTO_SCSI:
627 1.79 augustss #if NSCSIBUS > 0
628 1.79 augustss error = umass_scsi_attach(sc);
629 1.79 augustss #else
630 1.128 cube aprint_error_dev(self, "scsibus not configured\n");
631 1.79 augustss #endif
632 1.79 augustss break;
633 1.79 augustss
634 1.79 augustss case UMASS_CPROTO_UFI:
635 1.79 augustss case UMASS_CPROTO_ATAPI:
636 1.79 augustss #if NATAPIBUS > 0
637 1.79 augustss error = umass_atapi_attach(sc);
638 1.79 augustss #else
639 1.128 cube aprint_error_dev(self, "atapibus not configured\n");
640 1.80 augustss #endif
641 1.80 augustss break;
642 1.80 augustss
643 1.80 augustss case UMASS_CPROTO_ISD_ATA:
644 1.80 augustss #if NWD > 0
645 1.80 augustss error = umass_isdata_attach(sc);
646 1.80 augustss #else
647 1.128 cube aprint_error_dev(self, "isdata not configured\n");
648 1.79 augustss #endif
649 1.79 augustss break;
650 1.79 augustss
651 1.79 augustss default:
652 1.128 cube aprint_error_dev(self, "command protocol=0x%x not supported\n",
653 1.128 cube sc->sc_cmd);
654 1.28 augustss umass_disco(sc);
655 1.131 dyoung return;
656 1.28 augustss }
657 1.79 augustss if (error) {
658 1.128 cube aprint_error_dev(self, "bus attach failed\n");
659 1.79 augustss umass_disco(sc);
660 1.131 dyoung return;
661 1.79 augustss }
662 1.79 augustss
663 1.79 augustss usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
664 1.131 dyoung sc->sc_dev);
665 1.1 thorpej
666 1.125 jmcneill if (!pmf_device_register(self, NULL, NULL))
667 1.125 jmcneill aprint_error_dev(self, "couldn't establish power handler\n");
668 1.125 jmcneill
669 1.131 dyoung DPRINTF(UDMASS_GEN, ("%s: Attach finished\n", device_xname(sc->sc_dev)));
670 1.28 augustss
671 1.131 dyoung return;
672 1.1 thorpej }
673 1.1 thorpej
674 1.131 dyoung static void
675 1.131 dyoung umass_childdet(device_t self, device_t child)
676 1.131 dyoung {
677 1.131 dyoung struct umass_softc *sc = device_private(self);
678 1.131 dyoung
679 1.142 mrg KASSERTMSG(child == sc->bus->sc_child,
680 1.142 mrg "assertion child == sc->bus->sc_child failed\n");
681 1.131 dyoung sc->bus->sc_child = NULL;
682 1.131 dyoung }
683 1.131 dyoung
684 1.131 dyoung int
685 1.131 dyoung umass_detach(device_t self, int flags)
686 1.28 augustss {
687 1.131 dyoung struct umass_softc *sc = device_private(self);
688 1.105 augustss struct umassbus_softc *scbus;
689 1.145 mrg int rv = 0, i;
690 1.1 thorpej
691 1.131 dyoung DPRINTF(UDMASS_USB, ("%s: detached\n", device_xname(sc->sc_dev)));
692 1.28 augustss
693 1.125 jmcneill pmf_device_deregister(self);
694 1.125 jmcneill
695 1.28 augustss /* Abort the pipes to wake up any waiting processes. */
696 1.73 gehenna for (i = 0 ; i < UMASS_NEP ; i++) {
697 1.117 nathanw if (sc->sc_pipe[i] != NULL)
698 1.73 gehenna usbd_abort_pipe(sc->sc_pipe[i]);
699 1.73 gehenna }
700 1.28 augustss
701 1.42 augustss /* Do we really need reference counting? Perhaps in ioctl() */
702 1.145 mrg mutex_enter(&sc->sc_lock);
703 1.28 augustss if (--sc->sc_refcnt >= 0) {
704 1.95 augustss #ifdef DIAGNOSTIC
705 1.128 cube aprint_normal_dev(self, "waiting for refcnt\n");
706 1.95 augustss #endif
707 1.28 augustss /* Wait for processes to go away. */
708 1.145 mrg usb_detach_wait(sc->sc_dev, &sc->sc_detach_cv, &sc->sc_lock);
709 1.28 augustss }
710 1.145 mrg mutex_exit(&sc->sc_lock);
711 1.28 augustss
712 1.105 augustss scbus = sc->bus;
713 1.79 augustss if (scbus != NULL) {
714 1.79 augustss if (scbus->sc_child != NULL)
715 1.79 augustss rv = config_detach(scbus->sc_child, flags);
716 1.79 augustss free(scbus, M_DEVBUF);
717 1.79 augustss sc->bus = NULL;
718 1.79 augustss }
719 1.56 augustss
720 1.28 augustss if (rv != 0)
721 1.28 augustss return (rv);
722 1.28 augustss
723 1.28 augustss umass_disco(sc);
724 1.28 augustss
725 1.28 augustss usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
726 1.131 dyoung sc->sc_dev);
727 1.28 augustss
728 1.145 mrg mutex_destroy(&sc->sc_lock);
729 1.145 mrg cv_destroy(&sc->sc_detach_cv);
730 1.145 mrg
731 1.79 augustss return (rv);
732 1.79 augustss }
733 1.79 augustss
734 1.79 augustss int
735 1.128 cube umass_activate(device_t dev, enum devact act)
736 1.79 augustss {
737 1.128 cube struct umass_softc *sc = device_private(dev);
738 1.79 augustss
739 1.79 augustss DPRINTF(UDMASS_USB, ("%s: umass_activate: %d\n",
740 1.136 dyoung device_xname(dev), act));
741 1.79 augustss
742 1.79 augustss switch (act) {
743 1.79 augustss case DVACT_DEACTIVATE:
744 1.79 augustss sc->sc_dying = 1;
745 1.136 dyoung return 0;
746 1.133 dyoung default:
747 1.133 dyoung return EOPNOTSUPP;
748 1.79 augustss }
749 1.28 augustss }
750 1.28 augustss
751 1.28 augustss Static void
752 1.38 augustss umass_disco(struct umass_softc *sc)
753 1.88 augustss {
754 1.28 augustss int i;
755 1.28 augustss
756 1.28 augustss DPRINTF(UDMASS_GEN, ("umass_disco\n"));
757 1.28 augustss
758 1.28 augustss /* Remove all the pipes. */
759 1.73 gehenna for (i = 0 ; i < UMASS_NEP ; i++) {
760 1.93 toshii if (sc->sc_pipe[i] != NULL) {
761 1.130 jmorse usbd_abort_pipe(sc->sc_pipe[i]);
762 1.73 gehenna usbd_close_pipe(sc->sc_pipe[i]);
763 1.93 toshii sc->sc_pipe[i] = NULL;
764 1.93 toshii }
765 1.73 gehenna }
766 1.130 jmorse
767 1.130 jmorse /* Some xfers may be queued in the default pipe */
768 1.130 jmorse usbd_abort_default_pipe(sc->sc_udev);
769 1.130 jmorse
770 1.130 jmorse /* Free the xfers. */
771 1.130 jmorse for (i = 0; i < XFER_NR; i++)
772 1.130 jmorse if (sc->transfer_xfer[i] != NULL) {
773 1.130 jmorse usbd_free_xfer(sc->transfer_xfer[i]);
774 1.130 jmorse sc->transfer_xfer[i] = NULL;
775 1.130 jmorse }
776 1.28 augustss }
777 1.1 thorpej
778 1.28 augustss /*
779 1.28 augustss * Generic functions to handle transfers
780 1.28 augustss */
781 1.9 thorpej
782 1.28 augustss Static usbd_status
783 1.28 augustss umass_setup_transfer(struct umass_softc *sc, usbd_pipe_handle pipe,
784 1.28 augustss void *buffer, int buflen, int flags,
785 1.28 augustss usbd_xfer_handle xfer)
786 1.28 augustss {
787 1.28 augustss usbd_status err;
788 1.9 thorpej
789 1.28 augustss if (sc->sc_dying)
790 1.28 augustss return (USBD_IOERROR);
791 1.18 augustss
792 1.28 augustss /* Initialiase a USB transfer and then schedule it */
793 1.18 augustss
794 1.28 augustss usbd_setup_xfer(xfer, pipe, (void *)sc, buffer, buflen,
795 1.143 mrg flags, sc->timeout, sc->sc_methods->wire_state);
796 1.18 augustss
797 1.28 augustss err = usbd_transfer(xfer);
798 1.28 augustss DPRINTF(UDMASS_XFER,("%s: start xfer buffer=%p buflen=%d flags=0x%x "
799 1.131 dyoung "timeout=%d\n", device_xname(sc->sc_dev),
800 1.143 mrg buffer, buflen, flags, sc->timeout));
801 1.28 augustss if (err && err != USBD_IN_PROGRESS) {
802 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: failed to setup transfer, %s\n",
803 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err)));
804 1.28 augustss return (err);
805 1.9 thorpej }
806 1.24 augustss
807 1.28 augustss return (USBD_NORMAL_COMPLETION);
808 1.1 thorpej }
809 1.1 thorpej
810 1.1 thorpej
811 1.28 augustss Static usbd_status
812 1.74 gehenna umass_setup_ctrl_transfer(struct umass_softc *sc, usb_device_request_t *req,
813 1.74 gehenna void *buffer, int buflen, int flags, usbd_xfer_handle xfer)
814 1.1 thorpej {
815 1.1 thorpej usbd_status err;
816 1.1 thorpej
817 1.28 augustss if (sc->sc_dying)
818 1.28 augustss return (USBD_IOERROR);
819 1.1 thorpej
820 1.28 augustss /* Initialiase a USB control transfer and then schedule it */
821 1.1 thorpej
822 1.75 gehenna usbd_setup_default_xfer(xfer, sc->sc_udev, (void *) sc, sc->timeout,
823 1.75 gehenna req, buffer, buflen, flags, sc->sc_methods->wire_state);
824 1.1 thorpej
825 1.28 augustss err = usbd_transfer(xfer);
826 1.28 augustss if (err && err != USBD_IN_PROGRESS) {
827 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: failed to setup ctrl transfer, %s\n",
828 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err)));
829 1.1 thorpej
830 1.28 augustss /* do not reset, as this would make us loop */
831 1.28 augustss return (err);
832 1.28 augustss }
833 1.1 thorpej
834 1.28 augustss return (USBD_NORMAL_COMPLETION);
835 1.1 thorpej }
836 1.1 thorpej
837 1.28 augustss Static void
838 1.73 gehenna umass_clear_endpoint_stall(struct umass_softc *sc, int endpt,
839 1.73 gehenna usbd_xfer_handle xfer)
840 1.7 thorpej {
841 1.28 augustss if (sc->sc_dying)
842 1.28 augustss return;
843 1.1 thorpej
844 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Clear endpoint 0x%02x stall\n",
845 1.131 dyoung device_xname(sc->sc_dev), sc->sc_epaddr[endpt]));
846 1.7 thorpej
847 1.73 gehenna usbd_clear_endpoint_toggle(sc->sc_pipe[endpt]);
848 1.7 thorpej
849 1.78 gehenna sc->sc_req.bmRequestType = UT_WRITE_ENDPOINT;
850 1.78 gehenna sc->sc_req.bRequest = UR_CLEAR_FEATURE;
851 1.78 gehenna USETW(sc->sc_req.wValue, UF_ENDPOINT_HALT);
852 1.78 gehenna USETW(sc->sc_req.wIndex, sc->sc_epaddr[endpt]);
853 1.78 gehenna USETW(sc->sc_req.wLength, 0);
854 1.78 gehenna umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0, xfer);
855 1.28 augustss }
856 1.15 thorpej
857 1.29 enami #if 0
858 1.28 augustss Static void
859 1.28 augustss umass_reset(struct umass_softc *sc, transfer_cb_f cb, void *priv)
860 1.28 augustss {
861 1.28 augustss sc->transfer_cb = cb;
862 1.28 augustss sc->transfer_priv = priv;
863 1.1 thorpej
864 1.28 augustss /* The reset is a forced reset, so no error (yet) */
865 1.28 augustss sc->reset(sc, STATUS_CMD_OK);
866 1.7 thorpej }
867 1.29 enami #endif
868 1.1 thorpej
869 1.28 augustss /*
870 1.28 augustss * Bulk protocol specific functions
871 1.28 augustss */
872 1.28 augustss
873 1.28 augustss Static void
874 1.28 augustss umass_bbb_reset(struct umass_softc *sc, int status)
875 1.1 thorpej {
876 1.142 mrg KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
877 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_bbb_reset\n",
878 1.142 mrg sc->sc_wire);
879 1.28 augustss
880 1.28 augustss if (sc->sc_dying)
881 1.28 augustss return;
882 1.1 thorpej
883 1.1 thorpej /*
884 1.1 thorpej * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
885 1.1 thorpej *
886 1.1 thorpej * For Reset Recovery the host shall issue in the following order:
887 1.1 thorpej * a) a Bulk-Only Mass Storage Reset
888 1.1 thorpej * b) a Clear Feature HALT to the Bulk-In endpoint
889 1.1 thorpej * c) a Clear Feature HALT to the Bulk-Out endpoint
890 1.28 augustss *
891 1.28 augustss * This is done in 3 steps, states:
892 1.28 augustss * TSTATE_BBB_RESET1
893 1.28 augustss * TSTATE_BBB_RESET2
894 1.28 augustss * TSTATE_BBB_RESET3
895 1.28 augustss *
896 1.28 augustss * If the reset doesn't succeed, the device should be port reset.
897 1.1 thorpej */
898 1.1 thorpej
899 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Bulk Reset\n",
900 1.131 dyoung device_xname(sc->sc_dev)));
901 1.88 augustss
902 1.28 augustss sc->transfer_state = TSTATE_BBB_RESET1;
903 1.28 augustss sc->transfer_status = status;
904 1.1 thorpej
905 1.28 augustss /* reset is a class specific interface write */
906 1.78 gehenna sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
907 1.78 gehenna sc->sc_req.bRequest = UR_BBB_RESET;
908 1.78 gehenna USETW(sc->sc_req.wValue, 0);
909 1.78 gehenna USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
910 1.78 gehenna USETW(sc->sc_req.wLength, 0);
911 1.78 gehenna umass_setup_ctrl_transfer(sc, &sc->sc_req, NULL, 0, 0,
912 1.28 augustss sc->transfer_xfer[XFER_BBB_RESET1]);
913 1.28 augustss }
914 1.28 augustss
915 1.28 augustss Static void
916 1.28 augustss umass_bbb_transfer(struct umass_softc *sc, int lun, void *cmd, int cmdlen,
917 1.67 augustss void *data, int datalen, int dir, u_int timeout,
918 1.143 mrg int flags, umass_callback cb, void *priv)
919 1.28 augustss {
920 1.28 augustss static int dCBWtag = 42; /* unique for CBW of transfer */
921 1.1 thorpej
922 1.28 augustss DPRINTF(UDMASS_BBB,("%s: umass_bbb_transfer cmd=0x%02x\n",
923 1.131 dyoung device_xname(sc->sc_dev), *(u_char *)cmd));
924 1.1 thorpej
925 1.142 mrg KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
926 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_bbb_transfer\n",
927 1.142 mrg sc->sc_wire);
928 1.1 thorpej
929 1.116 mycroft if (sc->sc_dying)
930 1.116 mycroft return;
931 1.116 mycroft
932 1.67 augustss /* Be a little generous. */
933 1.67 augustss sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;
934 1.67 augustss
935 1.1 thorpej /*
936 1.28 augustss * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
937 1.28 augustss * a data phase of datalen bytes from/to the device and finally a
938 1.28 augustss * csw read phase.
939 1.28 augustss * If the data direction was inbound a maximum of datalen bytes
940 1.28 augustss * is stored in the buffer pointed to by data.
941 1.28 augustss *
942 1.28 augustss * umass_bbb_transfer initialises the transfer and lets the state
943 1.88 augustss * machine in umass_bbb_state handle the completion. It uses the
944 1.28 augustss * following states:
945 1.28 augustss * TSTATE_BBB_COMMAND
946 1.28 augustss * -> TSTATE_BBB_DATA
947 1.28 augustss * -> TSTATE_BBB_STATUS
948 1.28 augustss * -> TSTATE_BBB_STATUS2
949 1.28 augustss * -> TSTATE_BBB_IDLE
950 1.28 augustss *
951 1.28 augustss * An error in any of those states will invoke
952 1.28 augustss * umass_bbb_reset.
953 1.1 thorpej */
954 1.1 thorpej
955 1.1 thorpej /* check the given arguments */
956 1.142 mrg KASSERTMSG(datalen == 0 || data != NULL,
957 1.142 mrg "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
958 1.142 mrg KASSERTMSG(cmdlen <= CBWCDBLENGTH,
959 1.142 mrg "%s: cmdlen exceeds CDB length in CBW (%d > %d)",
960 1.142 mrg device_xname(sc->sc_dev), cmdlen, CBWCDBLENGTH);
961 1.142 mrg KASSERTMSG(dir == DIR_NONE || datalen > 0,
962 1.142 mrg "%s: datalen == 0 while direction is not NONE\n",
963 1.142 mrg device_xname(sc->sc_dev));
964 1.142 mrg KASSERTMSG(datalen == 0 || dir != DIR_NONE,
965 1.142 mrg "%s: direction is NONE while datalen is not zero\n",
966 1.142 mrg device_xname(sc->sc_dev));
967 1.142 mrg /* CTASSERT */
968 1.142 mrg KASSERTMSG(sizeof(umass_bbb_cbw_t) == UMASS_BBB_CBW_SIZE,
969 1.142 mrg "%s: CBW struct does not have the right size (%zu vs. %u)\n",
970 1.131 dyoung device_xname(sc->sc_dev),
971 1.142 mrg sizeof(umass_bbb_cbw_t), UMASS_BBB_CBW_SIZE);
972 1.142 mrg /* CTASSERT */
973 1.142 mrg KASSERTMSG(sizeof(umass_bbb_csw_t) == UMASS_BBB_CSW_SIZE,
974 1.142 mrg "%s: CSW struct does not have the right size (%zu vs. %u)\n",
975 1.131 dyoung device_xname(sc->sc_dev),
976 1.142 mrg sizeof(umass_bbb_csw_t), UMASS_BBB_CSW_SIZE);
977 1.1 thorpej
978 1.1 thorpej /*
979 1.28 augustss * Determine the direction of the data transfer and the length.
980 1.1 thorpej *
981 1.1 thorpej * dCBWDataTransferLength (datalen) :
982 1.1 thorpej * This field indicates the number of bytes of data that the host
983 1.1 thorpej * intends to transfer on the IN or OUT Bulk endpoint(as indicated by
984 1.1 thorpej * the Direction bit) during the execution of this command. If this
985 1.1 thorpej * field is set to 0, the device will expect that no data will be
986 1.1 thorpej * transferred IN or OUT during this command, regardless of the value
987 1.1 thorpej * of the Direction bit defined in dCBWFlags.
988 1.1 thorpej *
989 1.1 thorpej * dCBWFlags (dir) :
990 1.1 thorpej * The bits of the Flags field are defined as follows:
991 1.28 augustss * Bits 0-6 reserved
992 1.28 augustss * Bit 7 Direction - this bit shall be ignored if the
993 1.28 augustss * dCBWDataTransferLength field is zero.
994 1.28 augustss * 0 = data Out from host to device
995 1.28 augustss * 1 = data In from device to host
996 1.1 thorpej */
997 1.1 thorpej
998 1.28 augustss /* Fill in the Command Block Wrapper */
999 1.28 augustss USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
1000 1.28 augustss USETDW(sc->cbw.dCBWTag, dCBWtag);
1001 1.28 augustss dCBWtag++; /* cannot be done in macro (it will be done 4 times) */
1002 1.28 augustss USETDW(sc->cbw.dCBWDataTransferLength, datalen);
1003 1.28 augustss /* DIR_NONE is treated as DIR_OUT (0x00) */
1004 1.28 augustss sc->cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
1005 1.28 augustss sc->cbw.bCBWLUN = lun;
1006 1.28 augustss sc->cbw.bCDBLength = cmdlen;
1007 1.69 gehenna memcpy(sc->cbw.CBWCDB, cmd, cmdlen);
1008 1.28 augustss
1009 1.28 augustss DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
1010 1.28 augustss
1011 1.28 augustss /* store the details for the data transfer phase */
1012 1.28 augustss sc->transfer_dir = dir;
1013 1.28 augustss sc->transfer_data = data;
1014 1.28 augustss sc->transfer_datalen = datalen;
1015 1.28 augustss sc->transfer_actlen = 0;
1016 1.28 augustss sc->transfer_cb = cb;
1017 1.28 augustss sc->transfer_priv = priv;
1018 1.28 augustss sc->transfer_status = STATUS_CMD_OK;
1019 1.1 thorpej
1020 1.28 augustss /* move from idle to the command state */
1021 1.28 augustss sc->transfer_state = TSTATE_BBB_COMMAND;
1022 1.1 thorpej
1023 1.1 thorpej /* Send the CBW from host to device via bulk-out endpoint. */
1024 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
1025 1.143 mrg &sc->cbw, UMASS_BBB_CBW_SIZE, flags,
1026 1.28 augustss sc->transfer_xfer[XFER_BBB_CBW])) {
1027 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1028 1.1 thorpej }
1029 1.28 augustss }
1030 1.28 augustss
1031 1.1 thorpej
1032 1.28 augustss Static void
1033 1.28 augustss umass_bbb_state(usbd_xfer_handle xfer, usbd_private_handle priv,
1034 1.28 augustss usbd_status err)
1035 1.28 augustss {
1036 1.28 augustss struct umass_softc *sc = (struct umass_softc *) priv;
1037 1.28 augustss usbd_xfer_handle next_xfer;
1038 1.135 is int residue;
1039 1.28 augustss
1040 1.142 mrg KASSERTMSG(sc->sc_wire & UMASS_WPROTO_BBB,
1041 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_bbb_state\n",
1042 1.142 mrg sc->sc_wire);
1043 1.28 augustss
1044 1.28 augustss if (sc->sc_dying)
1045 1.28 augustss return;
1046 1.1 thorpej
1047 1.1 thorpej /*
1048 1.28 augustss * State handling for BBB transfers.
1049 1.28 augustss *
1050 1.28 augustss * The subroutine is rather long. It steps through the states given in
1051 1.28 augustss * Annex A of the Bulk-Only specification.
1052 1.28 augustss * Each state first does the error handling of the previous transfer
1053 1.28 augustss * and then prepares the next transfer.
1054 1.28 augustss * Each transfer is done asynchroneously so after the request/transfer
1055 1.28 augustss * has been submitted you will find a 'return;'.
1056 1.1 thorpej */
1057 1.1 thorpej
1058 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Handling BBB state %d (%s), xfer=%p, %s\n",
1059 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_state,
1060 1.28 augustss states[sc->transfer_state], xfer, usbd_errstr(err)));
1061 1.28 augustss
1062 1.28 augustss switch (sc->transfer_state) {
1063 1.28 augustss
1064 1.28 augustss /***** Bulk Transfer *****/
1065 1.28 augustss case TSTATE_BBB_COMMAND:
1066 1.28 augustss /* Command transport phase, error handling */
1067 1.28 augustss if (err) {
1068 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: failed to send CBW\n",
1069 1.131 dyoung device_xname(sc->sc_dev)));
1070 1.28 augustss /* If the device detects that the CBW is invalid, then
1071 1.28 augustss * the device may STALL both bulk endpoints and require
1072 1.28 augustss * a Bulk-Reset
1073 1.28 augustss */
1074 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1075 1.28 augustss return;
1076 1.28 augustss }
1077 1.28 augustss
1078 1.28 augustss /* Data transport phase, setup transfer */
1079 1.28 augustss sc->transfer_state = TSTATE_BBB_DATA;
1080 1.28 augustss if (sc->transfer_dir == DIR_IN) {
1081 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
1082 1.28 augustss sc->data_buffer, sc->transfer_datalen,
1083 1.28 augustss USBD_SHORT_XFER_OK | USBD_NO_COPY,
1084 1.28 augustss sc->transfer_xfer[XFER_BBB_DATA]))
1085 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1086 1.28 augustss
1087 1.28 augustss return;
1088 1.28 augustss } else if (sc->transfer_dir == DIR_OUT) {
1089 1.88 augustss memcpy(sc->data_buffer, sc->transfer_data,
1090 1.28 augustss sc->transfer_datalen);
1091 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
1092 1.28 augustss sc->data_buffer, sc->transfer_datalen,
1093 1.28 augustss USBD_NO_COPY,/* fixed length transfer */
1094 1.28 augustss sc->transfer_xfer[XFER_BBB_DATA]))
1095 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1096 1.1 thorpej
1097 1.28 augustss return;
1098 1.28 augustss } else {
1099 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: no data phase\n",
1100 1.131 dyoung device_xname(sc->sc_dev)));
1101 1.28 augustss }
1102 1.1 thorpej
1103 1.28 augustss /* FALLTHROUGH if no data phase, err == 0 */
1104 1.28 augustss case TSTATE_BBB_DATA:
1105 1.103 mycroft /* Command transport phase error handling (ignored if no data
1106 1.28 augustss * phase (fallthrough from previous state)) */
1107 1.28 augustss if (sc->transfer_dir != DIR_NONE) {
1108 1.28 augustss /* retrieve the length of the transfer that was done */
1109 1.28 augustss usbd_get_xfer_status(xfer, NULL, NULL,
1110 1.103 mycroft &sc->transfer_actlen, NULL);
1111 1.103 mycroft DPRINTF(UDMASS_BBB, ("%s: BBB_DATA actlen=%d\n",
1112 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_actlen));
1113 1.28 augustss
1114 1.28 augustss if (err) {
1115 1.65 augustss DPRINTF(UDMASS_BBB, ("%s: Data-%s %d failed, "
1116 1.131 dyoung "%s\n", device_xname(sc->sc_dev),
1117 1.28 augustss (sc->transfer_dir == DIR_IN?"in":"out"),
1118 1.28 augustss sc->transfer_datalen,usbd_errstr(err)));
1119 1.28 augustss
1120 1.28 augustss if (err == USBD_STALLED) {
1121 1.70 gehenna sc->transfer_state = TSTATE_BBB_DCLEAR;
1122 1.28 augustss umass_clear_endpoint_stall(sc,
1123 1.28 augustss (sc->transfer_dir == DIR_IN?
1124 1.73 gehenna UMASS_BULKIN:UMASS_BULKOUT),
1125 1.28 augustss sc->transfer_xfer[XFER_BBB_DCLEAR]);
1126 1.28 augustss } else {
1127 1.28 augustss /* Unless the error is a pipe stall the
1128 1.28 augustss * error is fatal.
1129 1.28 augustss */
1130 1.28 augustss umass_bbb_reset(sc,STATUS_WIRE_FAILED);
1131 1.28 augustss }
1132 1.103 mycroft return;
1133 1.28 augustss }
1134 1.28 augustss }
1135 1.1 thorpej
1136 1.101 mycroft /* FALLTHROUGH, err == 0 (no data phase or successful) */
1137 1.101 mycroft case TSTATE_BBB_DCLEAR: /* stall clear after data phase */
1138 1.28 augustss if (sc->transfer_dir == DIR_IN)
1139 1.28 augustss memcpy(sc->transfer_data, sc->data_buffer,
1140 1.28 augustss sc->transfer_actlen);
1141 1.28 augustss
1142 1.28 augustss DIF(UDMASS_BBB, if (sc->transfer_dir == DIR_IN)
1143 1.28 augustss umass_dump_buffer(sc, sc->transfer_data,
1144 1.28 augustss sc->transfer_datalen, 48));
1145 1.28 augustss
1146 1.94 wiz /* FALLTHROUGH, err == 0 (no data phase or successful) */
1147 1.28 augustss case TSTATE_BBB_SCLEAR: /* stall clear after status phase */
1148 1.28 augustss /* Reading of CSW after bulk stall condition in data phase
1149 1.28 augustss * (TSTATE_BBB_DATA2) or bulk-in stall condition after
1150 1.28 augustss * reading CSW (TSTATE_BBB_SCLEAR).
1151 1.94 wiz * In the case of no data phase or successful data phase,
1152 1.28 augustss * err == 0 and the following if block is passed.
1153 1.28 augustss */
1154 1.28 augustss if (err) { /* should not occur */
1155 1.103 mycroft printf("%s: BBB bulk-%s stall clear failed, %s\n",
1156 1.131 dyoung device_xname(sc->sc_dev),
1157 1.103 mycroft (sc->transfer_dir == DIR_IN? "in":"out"),
1158 1.103 mycroft usbd_errstr(err));
1159 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1160 1.28 augustss return;
1161 1.28 augustss }
1162 1.88 augustss
1163 1.28 augustss /* Status transport phase, setup transfer */
1164 1.28 augustss if (sc->transfer_state == TSTATE_BBB_COMMAND ||
1165 1.28 augustss sc->transfer_state == TSTATE_BBB_DATA ||
1166 1.28 augustss sc->transfer_state == TSTATE_BBB_DCLEAR) {
1167 1.94 wiz /* After no data phase, successful data phase and
1168 1.28 augustss * after clearing bulk-in/-out stall condition
1169 1.28 augustss */
1170 1.28 augustss sc->transfer_state = TSTATE_BBB_STATUS1;
1171 1.28 augustss next_xfer = sc->transfer_xfer[XFER_BBB_CSW1];
1172 1.28 augustss } else {
1173 1.28 augustss /* After first attempt of fetching CSW */
1174 1.28 augustss sc->transfer_state = TSTATE_BBB_STATUS2;
1175 1.28 augustss next_xfer = sc->transfer_xfer[XFER_BBB_CSW2];
1176 1.1 thorpej }
1177 1.1 thorpej
1178 1.28 augustss /* Read the Command Status Wrapper via bulk-in endpoint. */
1179 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
1180 1.73 gehenna &sc->csw, UMASS_BBB_CSW_SIZE, 0, next_xfer)) {
1181 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1182 1.28 augustss return;
1183 1.28 augustss }
1184 1.1 thorpej
1185 1.28 augustss return;
1186 1.28 augustss case TSTATE_BBB_STATUS1: /* first attempt */
1187 1.28 augustss case TSTATE_BBB_STATUS2: /* second attempt */
1188 1.28 augustss /* Status transfer, error handling */
1189 1.1 thorpej if (err) {
1190 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Failed to read CSW, %s%s\n",
1191 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err),
1192 1.28 augustss (sc->transfer_state == TSTATE_BBB_STATUS1?
1193 1.28 augustss ", retrying":"")));
1194 1.28 augustss
1195 1.28 augustss /* If this was the first attempt at fetching the CSW
1196 1.28 augustss * retry it, otherwise fail.
1197 1.28 augustss */
1198 1.28 augustss if (sc->transfer_state == TSTATE_BBB_STATUS1) {
1199 1.70 gehenna sc->transfer_state = TSTATE_BBB_SCLEAR;
1200 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_BULKIN,
1201 1.66 augustss sc->transfer_xfer[XFER_BBB_SCLEAR]);
1202 1.28 augustss return;
1203 1.28 augustss } else {
1204 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1205 1.28 augustss return;
1206 1.28 augustss }
1207 1.28 augustss }
1208 1.28 augustss
1209 1.28 augustss DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
1210 1.68 augustss
1211 1.146 drochner #ifdef UMASS_DEBUG
1212 1.146 drochner residue = UGETDW(sc->csw.dCSWDataResidue);
1213 1.146 drochner if (residue != sc->transfer_datalen - sc->transfer_actlen)
1214 1.146 drochner printf("%s: dCSWDataResidue=%d req=%d act=%d\n",
1215 1.146 drochner device_xname(sc->sc_dev), residue,
1216 1.146 drochner sc->transfer_datalen, sc->transfer_actlen);
1217 1.146 drochner #endif
1218 1.146 drochner residue = sc->transfer_datalen - sc->transfer_actlen;
1219 1.135 is
1220 1.68 augustss /* Translate weird command-status signatures. */
1221 1.78 gehenna if ((sc->sc_quirks & UMASS_QUIRK_WRONG_CSWSIG) &&
1222 1.68 augustss UGETDW(sc->csw.dCSWSignature) == CSWSIGNATURE_OLYMPUS_C1)
1223 1.68 augustss USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
1224 1.91 erh
1225 1.91 erh /* Translate invalid command-status tags */
1226 1.91 erh if (sc->sc_quirks & UMASS_QUIRK_WRONG_CSWTAG)
1227 1.91 erh USETDW(sc->csw.dCSWTag, UGETDW(sc->cbw.dCBWTag));
1228 1.28 augustss
1229 1.28 augustss /* Check CSW and handle any error */
1230 1.28 augustss if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
1231 1.28 augustss /* Invalid CSW: Wrong signature or wrong tag might
1232 1.28 augustss * indicate that the device is confused -> reset it.
1233 1.28 augustss */
1234 1.28 augustss printf("%s: Invalid CSW: sig 0x%08x should be 0x%08x\n",
1235 1.131 dyoung device_xname(sc->sc_dev),
1236 1.28 augustss UGETDW(sc->csw.dCSWSignature),
1237 1.28 augustss CSWSIGNATURE);
1238 1.28 augustss
1239 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1240 1.28 augustss return;
1241 1.28 augustss } else if (UGETDW(sc->csw.dCSWTag)
1242 1.28 augustss != UGETDW(sc->cbw.dCBWTag)) {
1243 1.28 augustss printf("%s: Invalid CSW: tag %d should be %d\n",
1244 1.131 dyoung device_xname(sc->sc_dev),
1245 1.28 augustss UGETDW(sc->csw.dCSWTag),
1246 1.28 augustss UGETDW(sc->cbw.dCBWTag));
1247 1.28 augustss
1248 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1249 1.28 augustss return;
1250 1.28 augustss
1251 1.28 augustss /* CSW is valid here */
1252 1.28 augustss } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
1253 1.28 augustss printf("%s: Invalid CSW: status %d > %d\n",
1254 1.131 dyoung device_xname(sc->sc_dev),
1255 1.28 augustss sc->csw.bCSWStatus,
1256 1.28 augustss CSWSTATUS_PHASE);
1257 1.28 augustss
1258 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1259 1.28 augustss return;
1260 1.28 augustss } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
1261 1.28 augustss printf("%s: Phase Error, residue = %d\n",
1262 1.135 is device_xname(sc->sc_dev), residue);
1263 1.88 augustss
1264 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1265 1.28 augustss return;
1266 1.28 augustss
1267 1.28 augustss } else if (sc->transfer_actlen > sc->transfer_datalen) {
1268 1.28 augustss /* Buffer overrun! Don't let this go by unnoticed */
1269 1.147 skrll panic("%s: transferred %s %d bytes instead of %d bytes",
1270 1.147 skrll device_xname(sc->sc_dev),
1271 1.147 skrll sc->transfer_dir == DIR_IN ? "IN" : "OUT",
1272 1.147 skrll sc->transfer_actlen, sc->transfer_datalen);
1273 1.62 augustss #if 0
1274 1.28 augustss } else if (sc->transfer_datalen - sc->transfer_actlen
1275 1.135 is != residue) {
1276 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: actlen=%d != residue=%d\n",
1277 1.131 dyoung device_xname(sc->sc_dev),
1278 1.28 augustss sc->transfer_datalen - sc->transfer_actlen,
1279 1.135 is residue));
1280 1.28 augustss
1281 1.28 augustss umass_bbb_reset(sc, STATUS_WIRE_FAILED);
1282 1.28 augustss return;
1283 1.62 augustss #endif
1284 1.28 augustss } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
1285 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Command Failed, res = %d\n",
1286 1.135 is device_xname(sc->sc_dev), residue));
1287 1.28 augustss
1288 1.28 augustss /* SCSI command failed but transfer was succesful */
1289 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1290 1.135 is sc->transfer_cb(sc, sc->transfer_priv, residue,
1291 1.28 augustss STATUS_CMD_FAILED);
1292 1.28 augustss
1293 1.28 augustss return;
1294 1.28 augustss
1295 1.28 augustss } else { /* success */
1296 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1297 1.135 is sc->transfer_cb(sc, sc->transfer_priv, residue,
1298 1.28 augustss STATUS_CMD_OK);
1299 1.28 augustss
1300 1.28 augustss return;
1301 1.1 thorpej }
1302 1.1 thorpej
1303 1.28 augustss /***** Bulk Reset *****/
1304 1.28 augustss case TSTATE_BBB_RESET1:
1305 1.28 augustss if (err)
1306 1.28 augustss printf("%s: BBB reset failed, %s\n",
1307 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1308 1.28 augustss
1309 1.70 gehenna sc->transfer_state = TSTATE_BBB_RESET2;
1310 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_BULKIN,
1311 1.28 augustss sc->transfer_xfer[XFER_BBB_RESET2]);
1312 1.28 augustss
1313 1.28 augustss return;
1314 1.28 augustss case TSTATE_BBB_RESET2:
1315 1.28 augustss if (err) /* should not occur */
1316 1.28 augustss printf("%s: BBB bulk-in clear stall failed, %s\n",
1317 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1318 1.28 augustss /* no error recovery, otherwise we end up in a loop */
1319 1.28 augustss
1320 1.70 gehenna sc->transfer_state = TSTATE_BBB_RESET3;
1321 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
1322 1.28 augustss sc->transfer_xfer[XFER_BBB_RESET3]);
1323 1.28 augustss
1324 1.28 augustss return;
1325 1.28 augustss case TSTATE_BBB_RESET3:
1326 1.28 augustss if (err) /* should not occur */
1327 1.28 augustss printf("%s: BBB bulk-out clear stall failed, %s\n",
1328 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1329 1.28 augustss /* no error recovery, otherwise we end up in a loop */
1330 1.28 augustss
1331 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1332 1.28 augustss if (sc->transfer_priv) {
1333 1.28 augustss sc->transfer_cb(sc, sc->transfer_priv,
1334 1.28 augustss sc->transfer_datalen,
1335 1.28 augustss sc->transfer_status);
1336 1.28 augustss }
1337 1.1 thorpej
1338 1.28 augustss return;
1339 1.1 thorpej
1340 1.28 augustss /***** Default *****/
1341 1.28 augustss default:
1342 1.89 provos panic("%s: Unknown state %d",
1343 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_state);
1344 1.28 augustss }
1345 1.1 thorpej }
1346 1.1 thorpej
1347 1.1 thorpej /*
1348 1.28 augustss * Command/Bulk/Interrupt (CBI) specific functions
1349 1.1 thorpej */
1350 1.1 thorpej
1351 1.28 augustss Static int
1352 1.143 mrg umass_cbi_adsc(struct umass_softc *sc, char *buffer, int buflen, int flags,
1353 1.28 augustss usbd_xfer_handle xfer)
1354 1.1 thorpej {
1355 1.142 mrg KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
1356 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_cbi_adsc\n",
1357 1.142 mrg sc->sc_wire);
1358 1.78 gehenna
1359 1.123 christos if ((sc->sc_cmd == UMASS_CPROTO_RBC) &&
1360 1.123 christos (sc->sc_quirks & UMASS_QUIRK_RBC_PAD_TO_12) != 0 && buflen < 12) {
1361 1.123 christos (void)memset(buffer + buflen, 0, 12 - buflen);
1362 1.123 christos buflen = 12;
1363 1.123 christos }
1364 1.123 christos
1365 1.78 gehenna sc->sc_req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1366 1.78 gehenna sc->sc_req.bRequest = UR_CBI_ADSC;
1367 1.78 gehenna USETW(sc->sc_req.wValue, 0);
1368 1.78 gehenna USETW(sc->sc_req.wIndex, sc->sc_ifaceno);
1369 1.78 gehenna USETW(sc->sc_req.wLength, buflen);
1370 1.78 gehenna return umass_setup_ctrl_transfer(sc, &sc->sc_req, buffer,
1371 1.143 mrg buflen, flags, xfer);
1372 1.28 augustss }
1373 1.28 augustss
1374 1.1 thorpej
1375 1.28 augustss Static void
1376 1.28 augustss umass_cbi_reset(struct umass_softc *sc, int status)
1377 1.28 augustss {
1378 1.28 augustss int i;
1379 1.28 augustss # define SEND_DIAGNOSTIC_CMDLEN 12
1380 1.1 thorpej
1381 1.142 mrg KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
1382 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_cbi_reset\n",
1383 1.142 mrg sc->sc_wire);
1384 1.15 thorpej
1385 1.28 augustss if (sc->sc_dying)
1386 1.28 augustss return;
1387 1.28 augustss
1388 1.28 augustss /*
1389 1.28 augustss * Command Block Reset Protocol
1390 1.88 augustss *
1391 1.28 augustss * First send a reset request to the device. Then clear
1392 1.28 augustss * any possibly stalled bulk endpoints.
1393 1.28 augustss
1394 1.28 augustss * This is done in 3 steps, states:
1395 1.28 augustss * TSTATE_CBI_RESET1
1396 1.28 augustss * TSTATE_CBI_RESET2
1397 1.28 augustss * TSTATE_CBI_RESET3
1398 1.28 augustss *
1399 1.28 augustss * If the reset doesn't succeed, the device should be port reset.
1400 1.28 augustss */
1401 1.28 augustss
1402 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: CBI Reset\n",
1403 1.131 dyoung device_xname(sc->sc_dev)));
1404 1.88 augustss
1405 1.142 mrg /* CTASSERT */
1406 1.142 mrg KASSERTMSG(sizeof(sc->cbl) >= SEND_DIAGNOSTIC_CMDLEN,
1407 1.142 mrg "%s: CBL struct is too small (%zu < %u)\n",
1408 1.131 dyoung device_xname(sc->sc_dev),
1409 1.142 mrg sizeof(sc->cbl), SEND_DIAGNOSTIC_CMDLEN);
1410 1.28 augustss
1411 1.28 augustss sc->transfer_state = TSTATE_CBI_RESET1;
1412 1.28 augustss sc->transfer_status = status;
1413 1.28 augustss
1414 1.28 augustss /* The 0x1d code is the SEND DIAGNOSTIC command. To distingiush between
1415 1.28 augustss * the two the last 10 bytes of the cbl is filled with 0xff (section
1416 1.28 augustss * 2.2 of the CBI spec).
1417 1.28 augustss */
1418 1.28 augustss sc->cbl[0] = 0x1d; /* Command Block Reset */
1419 1.28 augustss sc->cbl[1] = 0x04;
1420 1.28 augustss for (i = 2; i < SEND_DIAGNOSTIC_CMDLEN; i++)
1421 1.28 augustss sc->cbl[i] = 0xff;
1422 1.28 augustss
1423 1.143 mrg umass_cbi_adsc(sc, sc->cbl, SEND_DIAGNOSTIC_CMDLEN, 0,
1424 1.28 augustss sc->transfer_xfer[XFER_CBI_RESET1]);
1425 1.28 augustss /* XXX if the command fails we should reset the port on the bub */
1426 1.28 augustss }
1427 1.28 augustss
1428 1.28 augustss Static void
1429 1.122 christos umass_cbi_transfer(struct umass_softc *sc, int lun,
1430 1.67 augustss void *cmd, int cmdlen, void *data, int datalen, int dir,
1431 1.143 mrg u_int timeout, int flags, umass_callback cb, void *priv)
1432 1.28 augustss {
1433 1.28 augustss DPRINTF(UDMASS_CBI,("%s: umass_cbi_transfer cmd=0x%02x, len=%d\n",
1434 1.131 dyoung device_xname(sc->sc_dev), *(u_char *)cmd, datalen));
1435 1.28 augustss
1436 1.142 mrg KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
1437 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_cbi_transfer\n",
1438 1.142 mrg sc->sc_wire);
1439 1.28 augustss
1440 1.28 augustss if (sc->sc_dying)
1441 1.28 augustss return;
1442 1.67 augustss
1443 1.67 augustss /* Be a little generous. */
1444 1.67 augustss sc->timeout = timeout + USBD_DEFAULT_TIMEOUT;
1445 1.28 augustss
1446 1.28 augustss /*
1447 1.28 augustss * Do a CBI transfer with cmdlen bytes from cmd, possibly
1448 1.28 augustss * a data phase of datalen bytes from/to the device and finally a
1449 1.28 augustss * csw read phase.
1450 1.28 augustss * If the data direction was inbound a maximum of datalen bytes
1451 1.28 augustss * is stored in the buffer pointed to by data.
1452 1.28 augustss *
1453 1.28 augustss * umass_cbi_transfer initialises the transfer and lets the state
1454 1.88 augustss * machine in umass_cbi_state handle the completion. It uses the
1455 1.28 augustss * following states:
1456 1.28 augustss * TSTATE_CBI_COMMAND
1457 1.28 augustss * -> XXX fill in
1458 1.28 augustss *
1459 1.28 augustss * An error in any of those states will invoke
1460 1.28 augustss * umass_cbi_reset.
1461 1.28 augustss */
1462 1.28 augustss
1463 1.28 augustss /* check the given arguments */
1464 1.142 mrg KASSERTMSG(datalen == 0 || data != NULL,
1465 1.142 mrg "%s: datalen > 0, but no buffer",device_xname(sc->sc_dev));
1466 1.142 mrg KASSERTMSG(datalen == 0 || dir != DIR_NONE,
1467 1.142 mrg "%s: direction is NONE while datalen is not zero\n",
1468 1.142 mrg device_xname(sc->sc_dev));
1469 1.28 augustss
1470 1.28 augustss /* store the details for the data transfer phase */
1471 1.28 augustss sc->transfer_dir = dir;
1472 1.28 augustss sc->transfer_data = data;
1473 1.28 augustss sc->transfer_datalen = datalen;
1474 1.28 augustss sc->transfer_actlen = 0;
1475 1.28 augustss sc->transfer_cb = cb;
1476 1.28 augustss sc->transfer_priv = priv;
1477 1.28 augustss sc->transfer_status = STATUS_CMD_OK;
1478 1.28 augustss
1479 1.28 augustss /* move from idle to the command state */
1480 1.28 augustss sc->transfer_state = TSTATE_CBI_COMMAND;
1481 1.28 augustss
1482 1.28 augustss /* Send the Command Block from host to device via control endpoint. */
1483 1.143 mrg if (umass_cbi_adsc(sc, cmd, cmdlen, flags, sc->transfer_xfer[XFER_CBI_CB]))
1484 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1485 1.28 augustss }
1486 1.28 augustss
1487 1.28 augustss Static void
1488 1.28 augustss umass_cbi_state(usbd_xfer_handle xfer, usbd_private_handle priv,
1489 1.28 augustss usbd_status err)
1490 1.28 augustss {
1491 1.28 augustss struct umass_softc *sc = (struct umass_softc *) priv;
1492 1.28 augustss
1493 1.142 mrg KASSERTMSG(sc->sc_wire & (UMASS_WPROTO_CBI|UMASS_WPROTO_CBI_I),
1494 1.142 mrg "sc->sc_wire == 0x%02x wrong for umass_cbi_state\n",
1495 1.142 mrg sc->sc_wire);
1496 1.28 augustss
1497 1.28 augustss if (sc->sc_dying)
1498 1.28 augustss return;
1499 1.28 augustss
1500 1.28 augustss /*
1501 1.28 augustss * State handling for CBI transfers.
1502 1.28 augustss */
1503 1.28 augustss
1504 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: Handling CBI state %d (%s), xfer=%p, %s\n",
1505 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_state,
1506 1.28 augustss states[sc->transfer_state], xfer, usbd_errstr(err)));
1507 1.28 augustss
1508 1.28 augustss switch (sc->transfer_state) {
1509 1.28 augustss
1510 1.28 augustss /***** CBI Transfer *****/
1511 1.28 augustss case TSTATE_CBI_COMMAND:
1512 1.28 augustss if (err == USBD_STALLED) {
1513 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: Command Transport failed\n",
1514 1.131 dyoung device_xname(sc->sc_dev)));
1515 1.28 augustss /* Status transport by control pipe (section 2.3.2.1).
1516 1.28 augustss * The command contained in the command block failed.
1517 1.28 augustss *
1518 1.28 augustss * The control pipe has already been unstalled by the
1519 1.28 augustss * USB stack.
1520 1.28 augustss * Section 2.4.3.1.1 states that the bulk in endpoints
1521 1.28 augustss * should not stalled at this point.
1522 1.28 augustss */
1523 1.28 augustss
1524 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1525 1.28 augustss sc->transfer_cb(sc, sc->transfer_priv,
1526 1.28 augustss sc->transfer_datalen,
1527 1.28 augustss STATUS_CMD_FAILED);
1528 1.28 augustss
1529 1.28 augustss return;
1530 1.28 augustss } else if (err) {
1531 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: failed to send ADSC\n",
1532 1.131 dyoung device_xname(sc->sc_dev)));
1533 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1534 1.28 augustss return;
1535 1.28 augustss }
1536 1.88 augustss
1537 1.103 mycroft /* Data transport phase, setup transfer */
1538 1.28 augustss sc->transfer_state = TSTATE_CBI_DATA;
1539 1.28 augustss if (sc->transfer_dir == DIR_IN) {
1540 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKIN],
1541 1.114 mycroft sc->data_buffer, sc->transfer_datalen,
1542 1.28 augustss USBD_SHORT_XFER_OK | USBD_NO_COPY,
1543 1.28 augustss sc->transfer_xfer[XFER_CBI_DATA]))
1544 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1545 1.28 augustss
1546 1.103 mycroft return;
1547 1.28 augustss } else if (sc->transfer_dir == DIR_OUT) {
1548 1.88 augustss memcpy(sc->data_buffer, sc->transfer_data,
1549 1.28 augustss sc->transfer_datalen);
1550 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_BULKOUT],
1551 1.114 mycroft sc->data_buffer, sc->transfer_datalen,
1552 1.28 augustss USBD_NO_COPY,/* fixed length transfer */
1553 1.28 augustss sc->transfer_xfer[XFER_CBI_DATA]))
1554 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1555 1.28 augustss
1556 1.103 mycroft return;
1557 1.28 augustss } else {
1558 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: no data phase\n",
1559 1.131 dyoung device_xname(sc->sc_dev)));
1560 1.28 augustss }
1561 1.28 augustss
1562 1.103 mycroft /* FALLTHROUGH if no data phase, err == 0 */
1563 1.28 augustss case TSTATE_CBI_DATA:
1564 1.103 mycroft /* Command transport phase error handling (ignored if no data
1565 1.103 mycroft * phase (fallthrough from previous state)) */
1566 1.103 mycroft if (sc->transfer_dir != DIR_NONE) {
1567 1.103 mycroft /* retrieve the length of the transfer that was done */
1568 1.103 mycroft usbd_get_xfer_status(xfer, NULL, NULL,
1569 1.103 mycroft &sc->transfer_actlen, NULL);
1570 1.103 mycroft DPRINTF(UDMASS_CBI, ("%s: CBI_DATA actlen=%d\n",
1571 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_actlen));
1572 1.28 augustss
1573 1.103 mycroft if (err) {
1574 1.103 mycroft DPRINTF(UDMASS_CBI, ("%s: Data-%s %d failed, "
1575 1.131 dyoung "%s\n", device_xname(sc->sc_dev),
1576 1.103 mycroft (sc->transfer_dir == DIR_IN?"in":"out"),
1577 1.103 mycroft sc->transfer_datalen,usbd_errstr(err)));
1578 1.28 augustss
1579 1.103 mycroft if (err == USBD_STALLED) {
1580 1.103 mycroft sc->transfer_state = TSTATE_CBI_DCLEAR;
1581 1.103 mycroft umass_clear_endpoint_stall(sc,
1582 1.103 mycroft (sc->transfer_dir == DIR_IN?
1583 1.103 mycroft UMASS_BULKIN:UMASS_BULKOUT),
1584 1.28 augustss sc->transfer_xfer[XFER_CBI_DCLEAR]);
1585 1.103 mycroft } else {
1586 1.103 mycroft /* Unless the error is a pipe stall the
1587 1.103 mycroft * error is fatal.
1588 1.103 mycroft */
1589 1.103 mycroft umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1590 1.103 mycroft }
1591 1.103 mycroft return;
1592 1.28 augustss }
1593 1.28 augustss }
1594 1.28 augustss
1595 1.28 augustss if (sc->transfer_dir == DIR_IN)
1596 1.28 augustss memcpy(sc->transfer_data, sc->data_buffer,
1597 1.28 augustss sc->transfer_actlen);
1598 1.28 augustss
1599 1.28 augustss DIF(UDMASS_CBI, if (sc->transfer_dir == DIR_IN)
1600 1.28 augustss umass_dump_buffer(sc, sc->transfer_data,
1601 1.28 augustss sc->transfer_actlen, 48));
1602 1.28 augustss
1603 1.103 mycroft /* Status phase */
1604 1.78 gehenna if (sc->sc_wire == UMASS_WPROTO_CBI_I) {
1605 1.28 augustss sc->transfer_state = TSTATE_CBI_STATUS;
1606 1.28 augustss memset(&sc->sbl, 0, sizeof(sc->sbl));
1607 1.73 gehenna if (umass_setup_transfer(sc, sc->sc_pipe[UMASS_INTRIN],
1608 1.28 augustss &sc->sbl, sizeof(sc->sbl),
1609 1.28 augustss 0, /* fixed length transfer */
1610 1.100 mycroft sc->transfer_xfer[XFER_CBI_STATUS]))
1611 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1612 1.28 augustss } else {
1613 1.28 augustss /* No command completion interrupt. Request
1614 1.28 augustss * sense to get status of command.
1615 1.28 augustss */
1616 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1617 1.28 augustss sc->transfer_cb(sc, sc->transfer_priv,
1618 1.28 augustss sc->transfer_datalen - sc->transfer_actlen,
1619 1.28 augustss STATUS_CMD_UNKNOWN);
1620 1.28 augustss }
1621 1.28 augustss return;
1622 1.28 augustss
1623 1.28 augustss case TSTATE_CBI_STATUS:
1624 1.28 augustss if (err) {
1625 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: Status Transport failed\n",
1626 1.131 dyoung device_xname(sc->sc_dev)));
1627 1.28 augustss /* Status transport by interrupt pipe (section 2.3.2.2).
1628 1.28 augustss */
1629 1.28 augustss
1630 1.28 augustss if (err == USBD_STALLED) {
1631 1.70 gehenna sc->transfer_state = TSTATE_CBI_SCLEAR;
1632 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_INTRIN,
1633 1.28 augustss sc->transfer_xfer[XFER_CBI_SCLEAR]);
1634 1.28 augustss } else {
1635 1.28 augustss umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1636 1.28 augustss }
1637 1.28 augustss return;
1638 1.28 augustss }
1639 1.28 augustss
1640 1.28 augustss /* Dissect the information in the buffer */
1641 1.28 augustss
1642 1.100 mycroft {
1643 1.100 mycroft u_int32_t actlen;
1644 1.100 mycroft usbd_get_xfer_status(xfer,NULL,NULL,&actlen,NULL);
1645 1.100 mycroft DPRINTF(UDMASS_CBI, ("%s: CBI_STATUS actlen=%d\n",
1646 1.131 dyoung device_xname(sc->sc_dev), actlen));
1647 1.100 mycroft if (actlen != 2)
1648 1.100 mycroft break;
1649 1.100 mycroft }
1650 1.100 mycroft
1651 1.78 gehenna if (sc->sc_cmd == UMASS_CPROTO_UFI) {
1652 1.28 augustss int status;
1653 1.88 augustss
1654 1.28 augustss /* Section 3.4.3.1.3 specifies that the UFI command
1655 1.28 augustss * protocol returns an ASC and ASCQ in the interrupt
1656 1.28 augustss * data block.
1657 1.28 augustss */
1658 1.28 augustss
1659 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: UFI CCI, ASC = 0x%02x, "
1660 1.28 augustss "ASCQ = 0x%02x\n",
1661 1.131 dyoung device_xname(sc->sc_dev),
1662 1.28 augustss sc->sbl.ufi.asc, sc->sbl.ufi.ascq));
1663 1.28 augustss
1664 1.100 mycroft if ((sc->sbl.ufi.asc == 0 && sc->sbl.ufi.ascq == 0) ||
1665 1.100 mycroft sc->sc_sense)
1666 1.28 augustss status = STATUS_CMD_OK;
1667 1.28 augustss else
1668 1.28 augustss status = STATUS_CMD_FAILED;
1669 1.28 augustss
1670 1.100 mycroft /* No autosense, command successful */
1671 1.100 mycroft sc->transfer_state = TSTATE_IDLE;
1672 1.100 mycroft sc->transfer_cb(sc, sc->transfer_priv,
1673 1.100 mycroft sc->transfer_datalen - sc->transfer_actlen, status);
1674 1.28 augustss } else {
1675 1.100 mycroft int status;
1676 1.100 mycroft
1677 1.28 augustss /* Command Interrupt Data Block */
1678 1.100 mycroft
1679 1.28 augustss DPRINTF(UDMASS_CBI, ("%s: type=0x%02x, value=0x%02x\n",
1680 1.131 dyoung device_xname(sc->sc_dev),
1681 1.28 augustss sc->sbl.common.type, sc->sbl.common.value));
1682 1.28 augustss
1683 1.28 augustss if (sc->sbl.common.type == IDB_TYPE_CCI) {
1684 1.100 mycroft switch (sc->sbl.common.value & IDB_VALUE_STATUS_MASK) {
1685 1.100 mycroft case IDB_VALUE_PASS:
1686 1.100 mycroft status = STATUS_CMD_OK;
1687 1.100 mycroft break;
1688 1.100 mycroft case IDB_VALUE_FAIL:
1689 1.100 mycroft case IDB_VALUE_PERSISTENT:
1690 1.100 mycroft status = STATUS_CMD_FAILED;
1691 1.100 mycroft break;
1692 1.100 mycroft case IDB_VALUE_PHASE:
1693 1.107 mycroft default: /* XXX: gcc */
1694 1.100 mycroft status = STATUS_WIRE_FAILED;
1695 1.100 mycroft break;
1696 1.28 augustss }
1697 1.28 augustss
1698 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1699 1.28 augustss sc->transfer_cb(sc, sc->transfer_priv,
1700 1.100 mycroft sc->transfer_datalen - sc->transfer_actlen, status);
1701 1.28 augustss }
1702 1.28 augustss }
1703 1.28 augustss return;
1704 1.28 augustss
1705 1.28 augustss case TSTATE_CBI_DCLEAR:
1706 1.113 mycroft if (err) { /* should not occur */
1707 1.103 mycroft printf("%s: CBI bulk-%s stall clear failed, %s\n",
1708 1.131 dyoung device_xname(sc->sc_dev),
1709 1.103 mycroft (sc->transfer_dir == DIR_IN? "in":"out"),
1710 1.103 mycroft usbd_errstr(err));
1711 1.113 mycroft umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1712 1.115 mycroft } else {
1713 1.115 mycroft sc->transfer_state = TSTATE_IDLE;
1714 1.115 mycroft sc->transfer_cb(sc, sc->transfer_priv,
1715 1.115 mycroft sc->transfer_datalen, STATUS_CMD_FAILED);
1716 1.115 mycroft }
1717 1.28 augustss return;
1718 1.28 augustss
1719 1.28 augustss case TSTATE_CBI_SCLEAR:
1720 1.113 mycroft if (err) { /* should not occur */
1721 1.28 augustss printf("%s: CBI intr-in stall clear failed, %s\n",
1722 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1723 1.113 mycroft umass_cbi_reset(sc, STATUS_WIRE_FAILED);
1724 1.115 mycroft } else {
1725 1.115 mycroft sc->transfer_state = TSTATE_IDLE;
1726 1.115 mycroft sc->transfer_cb(sc, sc->transfer_priv,
1727 1.115 mycroft sc->transfer_datalen, STATUS_CMD_FAILED);
1728 1.115 mycroft }
1729 1.28 augustss return;
1730 1.28 augustss
1731 1.28 augustss /***** CBI Reset *****/
1732 1.28 augustss case TSTATE_CBI_RESET1:
1733 1.28 augustss if (err)
1734 1.28 augustss printf("%s: CBI reset failed, %s\n",
1735 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1736 1.28 augustss
1737 1.70 gehenna sc->transfer_state = TSTATE_CBI_RESET2;
1738 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_BULKIN,
1739 1.28 augustss sc->transfer_xfer[XFER_CBI_RESET2]);
1740 1.28 augustss
1741 1.28 augustss return;
1742 1.28 augustss case TSTATE_CBI_RESET2:
1743 1.28 augustss if (err) /* should not occur */
1744 1.28 augustss printf("%s: CBI bulk-in stall clear failed, %s\n",
1745 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1746 1.28 augustss /* no error recovery, otherwise we end up in a loop */
1747 1.28 augustss
1748 1.70 gehenna sc->transfer_state = TSTATE_CBI_RESET3;
1749 1.73 gehenna umass_clear_endpoint_stall(sc, UMASS_BULKOUT,
1750 1.28 augustss sc->transfer_xfer[XFER_CBI_RESET3]);
1751 1.28 augustss
1752 1.28 augustss return;
1753 1.28 augustss case TSTATE_CBI_RESET3:
1754 1.28 augustss if (err) /* should not occur */
1755 1.28 augustss printf("%s: CBI bulk-out stall clear failed, %s\n",
1756 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1757 1.28 augustss /* no error recovery, otherwise we end up in a loop */
1758 1.28 augustss
1759 1.28 augustss sc->transfer_state = TSTATE_IDLE;
1760 1.28 augustss if (sc->transfer_priv) {
1761 1.28 augustss sc->transfer_cb(sc, sc->transfer_priv,
1762 1.28 augustss sc->transfer_datalen,
1763 1.28 augustss sc->transfer_status);
1764 1.28 augustss }
1765 1.28 augustss
1766 1.28 augustss return;
1767 1.28 augustss
1768 1.28 augustss
1769 1.28 augustss /***** Default *****/
1770 1.28 augustss default:
1771 1.89 provos panic("%s: Unknown state %d",
1772 1.131 dyoung device_xname(sc->sc_dev), sc->transfer_state);
1773 1.28 augustss }
1774 1.28 augustss }
1775 1.28 augustss
1776 1.28 augustss usbd_status
1777 1.28 augustss umass_bbb_get_max_lun(struct umass_softc *sc, u_int8_t *maxlun)
1778 1.28 augustss {
1779 1.28 augustss usb_device_request_t req;
1780 1.28 augustss usbd_status err;
1781 1.28 augustss
1782 1.28 augustss *maxlun = 0; /* Default to 0. */
1783 1.28 augustss
1784 1.131 dyoung DPRINTF(UDMASS_BBB, ("%s: Get Max Lun\n", device_xname(sc->sc_dev)));
1785 1.28 augustss
1786 1.28 augustss /* The Get Max Lun command is a class-specific request. */
1787 1.28 augustss req.bmRequestType = UT_READ_CLASS_INTERFACE;
1788 1.28 augustss req.bRequest = UR_BBB_GET_MAX_LUN;
1789 1.28 augustss USETW(req.wValue, 0);
1790 1.76 gehenna USETW(req.wIndex, sc->sc_ifaceno);
1791 1.28 augustss USETW(req.wLength, 1);
1792 1.28 augustss
1793 1.97 mycroft err = usbd_do_request_flags(sc->sc_udev, &req, maxlun,
1794 1.97 mycroft USBD_SHORT_XFER_OK, 0, USBD_DEFAULT_TIMEOUT);
1795 1.28 augustss switch (err) {
1796 1.28 augustss case USBD_NORMAL_COMPLETION:
1797 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Max Lun %d\n",
1798 1.131 dyoung device_xname(sc->sc_dev), *maxlun));
1799 1.28 augustss break;
1800 1.28 augustss
1801 1.28 augustss case USBD_STALLED:
1802 1.28 augustss /*
1803 1.28 augustss * Device doesn't support Get Max Lun request.
1804 1.28 augustss */
1805 1.28 augustss err = USBD_NORMAL_COMPLETION;
1806 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Get Max Lun not supported\n",
1807 1.131 dyoung device_xname(sc->sc_dev)));
1808 1.28 augustss break;
1809 1.28 augustss
1810 1.28 augustss case USBD_SHORT_XFER:
1811 1.28 augustss /*
1812 1.28 augustss * XXX This must mean Get Max Lun is not supported, too!
1813 1.28 augustss */
1814 1.28 augustss err = USBD_NORMAL_COMPLETION;
1815 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: Get Max Lun SHORT_XFER\n",
1816 1.131 dyoung device_xname(sc->sc_dev)));
1817 1.28 augustss break;
1818 1.28 augustss
1819 1.28 augustss default:
1820 1.28 augustss printf("%s: Get Max Lun failed: %s\n",
1821 1.131 dyoung device_xname(sc->sc_dev), usbd_errstr(err));
1822 1.28 augustss /* XXX Should we port_reset the device? */
1823 1.28 augustss break;
1824 1.28 augustss }
1825 1.28 augustss
1826 1.28 augustss return (err);
1827 1.28 augustss }
1828 1.28 augustss
1829 1.28 augustss
1830 1.28 augustss
1831 1.28 augustss
1832 1.28 augustss #ifdef UMASS_DEBUG
1833 1.28 augustss Static void
1834 1.28 augustss umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
1835 1.28 augustss {
1836 1.28 augustss int clen = cbw->bCDBLength;
1837 1.28 augustss int dlen = UGETDW(cbw->dCBWDataTransferLength);
1838 1.28 augustss u_int8_t *c = cbw->CBWCDB;
1839 1.28 augustss int tag = UGETDW(cbw->dCBWTag);
1840 1.28 augustss int flags = cbw->bCBWFlags;
1841 1.28 augustss
1842 1.83 augustss DPRINTF(UDMASS_BBB, ("%s: CBW %d: cmdlen=%d "
1843 1.83 augustss "(0x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%s), "
1844 1.28 augustss "data = %d bytes, dir = %s\n",
1845 1.131 dyoung device_xname(sc->sc_dev), tag, clen,
1846 1.83 augustss c[0], c[1], c[2], c[3], c[4], c[5],
1847 1.83 augustss c[6], c[7], c[8], c[9],
1848 1.83 augustss (clen > 10? "...":""),
1849 1.28 augustss dlen, (flags == CBWFLAGS_IN? "in":
1850 1.28 augustss (flags == CBWFLAGS_OUT? "out":"<invalid>"))));
1851 1.28 augustss }
1852 1.28 augustss
1853 1.28 augustss Static void
1854 1.28 augustss umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
1855 1.28 augustss {
1856 1.28 augustss int sig = UGETDW(csw->dCSWSignature);
1857 1.112 mycroft int tag = UGETDW(csw->dCSWTag);
1858 1.28 augustss int res = UGETDW(csw->dCSWDataResidue);
1859 1.28 augustss int status = csw->bCSWStatus;
1860 1.28 augustss
1861 1.28 augustss DPRINTF(UDMASS_BBB, ("%s: CSW %d: sig = 0x%08x (%s), tag = %d, "
1862 1.131 dyoung "res = %d, status = 0x%02x (%s)\n", device_xname(sc->sc_dev),
1863 1.28 augustss tag, sig, (sig == CSWSIGNATURE? "valid":"invalid"),
1864 1.28 augustss tag, res,
1865 1.28 augustss status, (status == CSWSTATUS_GOOD? "good":
1866 1.28 augustss (status == CSWSTATUS_FAILED? "failed":
1867 1.28 augustss (status == CSWSTATUS_PHASE? "phase":"<invalid>")))));
1868 1.28 augustss }
1869 1.28 augustss
1870 1.28 augustss Static void
1871 1.28 augustss umass_dump_buffer(struct umass_softc *sc, u_int8_t *buffer, int buflen,
1872 1.28 augustss int printlen)
1873 1.28 augustss {
1874 1.28 augustss int i, j;
1875 1.28 augustss char s1[40];
1876 1.28 augustss char s2[40];
1877 1.28 augustss char s3[5];
1878 1.28 augustss
1879 1.28 augustss s1[0] = '\0';
1880 1.28 augustss s3[0] = '\0';
1881 1.28 augustss
1882 1.110 itojun snprintf(s2, sizeof(s2), " buffer=%p, buflen=%d", buffer, buflen);
1883 1.28 augustss for (i = 0; i < buflen && i < printlen; i++) {
1884 1.28 augustss j = i % 16;
1885 1.28 augustss if (j == 0 && i != 0) {
1886 1.28 augustss DPRINTF(UDMASS_GEN, ("%s: 0x %s%s\n",
1887 1.131 dyoung device_xname(sc->sc_dev), s1, s2));
1888 1.28 augustss s2[0] = '\0';
1889 1.28 augustss }
1890 1.110 itojun snprintf(&s1[j * 2], sizeof(s1) - j * 2, "%02x",
1891 1.110 itojun buffer[i] & 0xff);
1892 1.28 augustss }
1893 1.28 augustss if (buflen > printlen)
1894 1.110 itojun snprintf(s3, sizeof(s3), " ...");
1895 1.28 augustss DPRINTF(UDMASS_GEN, ("%s: 0x %s%s%s\n",
1896 1.131 dyoung device_xname(sc->sc_dev), s1, s2, s3));
1897 1.28 augustss }
1898 1.28 augustss #endif
1899