umass.c revision 1.3 1 1.3 thorpej /* $NetBSD: umass.c,v 1.3 1999/08/29 18:13:26 thorpej Exp $ */
2 1.1 thorpej
3 1.1 thorpej /*-
4 1.1 thorpej * Copyright (c) 1999 MAEKAWA Masahide <bishop (at) rr.iij4u.or.jp>,
5 1.1 thorpej * Nick Hibma <hibma (at) skylink.it>
6 1.1 thorpej * All rights reserved.
7 1.1 thorpej *
8 1.1 thorpej * Redistribution and use in source and binary forms, with or without
9 1.1 thorpej * modification, are permitted provided that the following conditions
10 1.1 thorpej * are met:
11 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
12 1.1 thorpej * notice, this list of conditions and the following disclaimer.
13 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
15 1.1 thorpej * documentation and/or other materials provided with the distribution.
16 1.1 thorpej *
17 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 1.1 thorpej * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 1.1 thorpej * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 1.1 thorpej * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 1.1 thorpej * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 1.1 thorpej * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 1.1 thorpej * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 1.1 thorpej * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 1.1 thorpej * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 1.1 thorpej * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 1.1 thorpej * SUCH DAMAGE.
28 1.1 thorpej *
29 1.1 thorpej * FreeBSD: src/sys/dev/usb/umass.c,v 1.8 1999/06/20 15:46:13 n_hibma Exp
30 1.1 thorpej */
31 1.1 thorpej
32 1.1 thorpej /*
33 1.3 thorpej * Universal Serial Bus Mass Storage Class Control/Interrupt/Bulk (CBI)
34 1.3 thorpej * Specification:
35 1.1 thorpej *
36 1.3 thorpej * http://www.usb.org/developers/usbmass-cbi10.pdf
37 1.3 thorpej *
38 1.3 thorpej * Universal Serial Bus Mass Storage Bulk Only 1.0rc4 Specification:
39 1.3 thorpej *
40 1.3 thorpej * http://www.usb.org/developers/umassbulk_10rc4.pdf
41 1.3 thorpej *
42 1.3 thorpej * Relevant parts of the old spec (Bulk-only 0.9) have been quoted
43 1.3 thorpej * in the source.
44 1.1 thorpej */
45 1.1 thorpej
46 1.1 thorpej /* To do:
47 1.1 thorpej * x The umass_usb_transfer routine uses synchroneous transfers. This
48 1.1 thorpej * should be changed to async and state handling.
49 1.1 thorpej *
50 1.1 thorpej * x Should handle more than just Iomega USB Zip drives. There are
51 1.1 thorpej * a fair number of USB->SCSI dongles out there.
52 1.2 thorpej *
53 1.2 thorpej * x Need to implement SCSI command timeout/abort handling.
54 1.2 thorpej *
55 1.2 thorpej * x Need to handle SCSI Sense handling.
56 1.2 thorpej *
57 1.2 thorpej * x Need to handle hot-unplug.
58 1.3 thorpej *
59 1.3 thorpej * x Add support for other than Bulk.
60 1.1 thorpej */
61 1.1 thorpej
62 1.1 thorpej /* Authors: (with short acronyms for comments)
63 1.1 thorpej * NWH - Nick Hibma <hibma (at) skylink.it>
64 1.1 thorpej * JRT - Jason R. Thorpe <thorpej (at) shagadelic.org>
65 1.1 thorpej */
66 1.1 thorpej
67 1.1 thorpej #include <sys/param.h>
68 1.1 thorpej #include <sys/systm.h>
69 1.1 thorpej #include <sys/kernel.h>
70 1.1 thorpej #include <sys/malloc.h>
71 1.1 thorpej #include <sys/device.h>
72 1.1 thorpej #include <sys/buf.h>
73 1.1 thorpej #include <sys/proc.h>
74 1.1 thorpej
75 1.1 thorpej #include <dev/usb/usb.h>
76 1.1 thorpej #include <dev/usb/usbdi.h>
77 1.1 thorpej #include <dev/usb/usbdi_util.h>
78 1.1 thorpej
79 1.1 thorpej #include <dev/scsipi/scsi_all.h>
80 1.1 thorpej #include <dev/scsipi/scsipi_all.h>
81 1.1 thorpej #include <dev/scsipi/scsiconf.h>
82 1.1 thorpej
83 1.1 thorpej #ifdef UMASS_DEBUG
84 1.1 thorpej #define DPRINTF(m, x) if (umassdebug & (m)) logprintf x
85 1.1 thorpej #define UDMASS_SCSI 0x00020000
86 1.1 thorpej #define UDMASS_USB 0x00040000
87 1.1 thorpej #define UDMASS_BULK 0x00080000
88 1.1 thorpej #define UDMASS_ALL 0xffff0000
89 1.1 thorpej int umassdebug = /* UDMASS_SCSI|UDMASS_BULK|UDMASS_USB */ 0;
90 1.1 thorpej #else
91 1.1 thorpej #define DPRINTF(m, x)
92 1.1 thorpej #endif
93 1.1 thorpej
94 1.1 thorpej typedef struct umass_softc {
95 1.1 thorpej bdevice sc_dev; /* base device */
96 1.1 thorpej usbd_interface_handle sc_iface; /* the interface we use */
97 1.1 thorpej
98 1.1 thorpej u_int8_t sc_bulkout; /* bulk-out Endpoint Address */
99 1.1 thorpej usbd_pipe_handle sc_bulkout_pipe;
100 1.1 thorpej u_int8_t sc_bulkin; /* bulk-in Endpoint Address */
101 1.1 thorpej usbd_pipe_handle sc_bulkin_pipe;
102 1.1 thorpej
103 1.1 thorpej struct scsipi_link sc_link; /* prototype for devs */
104 1.1 thorpej struct scsipi_adapter sc_adapter;
105 1.1 thorpej } umass_softc_t;
106 1.1 thorpej
107 1.1 thorpej #define USBD_COMMAND_FAILED USBD_INVAL /* redefine some errors for */
108 1.1 thorpej
109 1.1 thorpej #define UPROTO_MASS_ZIP 0x50 /* letter 'P' for protoype */
110 1.1 thorpej
111 1.1 thorpej #define UMASS_SCSIID_HOST 0x00
112 1.1 thorpej #define UMASS_SCSIID_DEVICE 0x01
113 1.1 thorpej
114 1.1 thorpej #define DIR_OUT 0
115 1.1 thorpej #define DIR_IN 1
116 1.1 thorpej #define DIR_NONE 2
117 1.1 thorpej
118 1.1 thorpej /* Bulk-Only specific request */
119 1.1 thorpej #define UR_RESET 0xff
120 1.1 thorpej
121 1.1 thorpej /* Bulk-Only Mass Storage features */
122 1.1 thorpej /* Command Block Wrapper */
123 1.1 thorpej typedef struct {
124 1.1 thorpej uDWord dCBWSignature;
125 1.1 thorpej #define CBWSIGNATURE 0x43425355
126 1.1 thorpej uDWord dCBWTag;
127 1.1 thorpej uDWord dCBWDataTransferLength;
128 1.1 thorpej uByte bCBWFlags;
129 1.1 thorpej #define CBWFLAGS_OUT 0x00
130 1.1 thorpej #define CBWFLAGS_IN 0x80
131 1.1 thorpej uByte bCBWLUN;
132 1.1 thorpej uByte bCDBLength;
133 1.1 thorpej uByte CBWCDB[16];
134 1.1 thorpej } usb_bulk_cbw_t;
135 1.1 thorpej #define USB_BULK_CBW_SIZE 31
136 1.1 thorpej
137 1.1 thorpej /* Command Status Wrapper */
138 1.1 thorpej typedef struct {
139 1.1 thorpej uDWord dCSWSignature;
140 1.1 thorpej #define CSWSIGNATURE 0x53425355
141 1.1 thorpej uDWord dCSWTag;
142 1.1 thorpej uDWord dCSWDataResidue;
143 1.1 thorpej uByte bCSWStatus;
144 1.1 thorpej #define CSWSTATUS_GOOD 0x0
145 1.1 thorpej #define CSWSTATUS_FAILED 0x1
146 1.1 thorpej #define CSWSTATUS_PHASE 0x2
147 1.1 thorpej } usb_bulk_csw_t;
148 1.1 thorpej #define USB_BULK_CSW_SIZE 13
149 1.1 thorpej
150 1.1 thorpej
151 1.1 thorpej USB_DECLARE_DRIVER(umass);
152 1.1 thorpej
153 1.1 thorpej /* USB related functions */
154 1.1 thorpej usbd_status umass_usb_transfer __P((usbd_interface_handle iface,
155 1.1 thorpej usbd_pipe_handle pipe,
156 1.1 thorpej void *buf, int buflen,
157 1.1 thorpej int flags, int *xfer_size));
158 1.1 thorpej
159 1.1 thorpej /* Bulk-Only related functions */
160 1.1 thorpej usbd_status umass_bulk_reset __P((umass_softc_t *sc));
161 1.1 thorpej usbd_status umass_bulk_transfer __P((umass_softc_t *sc, int lun,
162 1.1 thorpej void *cmd, int cmdlen,
163 1.1 thorpej void *data, int datalen,
164 1.1 thorpej int dir, int *residue));
165 1.1 thorpej
166 1.1 thorpej /* SCSIPI related functions */
167 1.1 thorpej struct scsipi_device umass_dev = {
168 1.1 thorpej NULL, /* Use default error handler */
169 1.1 thorpej NULL, /* have a queue, served by this */
170 1.1 thorpej NULL, /* have no async handler */
171 1.1 thorpej NULL, /* Use default `done' routine */
172 1.1 thorpej };
173 1.1 thorpej
174 1.1 thorpej void umass_minphys __P((struct buf *));
175 1.1 thorpej int umass_scsi_cmd __P((struct scsipi_xfer *));
176 1.1 thorpej
177 1.1 thorpej
178 1.1 thorpej
179 1.1 thorpej USB_MATCH(umass)
180 1.1 thorpej {
181 1.1 thorpej USB_MATCH_START(umass, uaa);
182 1.1 thorpej usb_interface_descriptor_t *id;
183 1.1 thorpej
184 1.1 thorpej if (!uaa->iface)
185 1.1 thorpej return(UMATCH_NONE);
186 1.1 thorpej
187 1.1 thorpej id = usbd_get_interface_descriptor(uaa->iface);
188 1.1 thorpej if (id
189 1.1 thorpej && id->bInterfaceClass == UCLASS_MASS
190 1.1 thorpej && id->bInterfaceSubClass == USUBCLASS_SCSI
191 1.1 thorpej && id->bInterfaceProtocol == UPROTO_MASS_ZIP)
192 1.1 thorpej /* probe the Iomega USB Zip 100 drive */
193 1.1 thorpej return(UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO);
194 1.1 thorpej
195 1.1 thorpej return(UMATCH_NONE);
196 1.1 thorpej }
197 1.1 thorpej
198 1.1 thorpej USB_ATTACH(umass)
199 1.1 thorpej {
200 1.1 thorpej USB_ATTACH_START(umass, sc, uaa);
201 1.1 thorpej usb_interface_descriptor_t *id;
202 1.1 thorpej usb_endpoint_descriptor_t *ed;
203 1.1 thorpej char devinfo[1024];
204 1.1 thorpej int i;
205 1.1 thorpej int err;
206 1.1 thorpej
207 1.1 thorpej sc->sc_iface = uaa->iface;
208 1.1 thorpej sc->sc_bulkout_pipe = NULL;
209 1.1 thorpej sc->sc_bulkin_pipe = NULL;
210 1.1 thorpej
211 1.1 thorpej usbd_devinfo(uaa->device, 0, devinfo);
212 1.1 thorpej USB_ATTACH_SETUP;
213 1.1 thorpej
214 1.1 thorpej id = usbd_get_interface_descriptor(sc->sc_iface);
215 1.1 thorpej printf("%s: %s, iclass %d/%d/%d\n", USBDEVNAME(sc->sc_dev), devinfo,
216 1.1 thorpej id->bInterfaceClass, id->bInterfaceSubClass,
217 1.1 thorpej id->bInterfaceProtocol);
218 1.1 thorpej
219 1.1 thorpej /*
220 1.1 thorpej * A Bulk-Only Mass Storage device supports the following endpoints,
221 1.1 thorpej * in addition to the Endpoint 0 for Control transfer that is required
222 1.1 thorpej * of all USB devices:
223 1.1 thorpej * (a) bulk-in endpoint.
224 1.1 thorpej * (b) bulk-out endpoint.
225 1.1 thorpej *
226 1.1 thorpej * The endpoint addresses are not fixed, so we have to read them
227 1.1 thorpej * from the device descriptors of the current interface.
228 1.1 thorpej */
229 1.1 thorpej for (i = 0 ; i < id->bNumEndpoints ; i++) {
230 1.1 thorpej ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
231 1.1 thorpej if (!ed) {
232 1.1 thorpej printf("%s: could not read endpoint descriptor\n",
233 1.1 thorpej USBDEVNAME(sc->sc_dev));
234 1.1 thorpej USB_ATTACH_ERROR_RETURN;
235 1.1 thorpej }
236 1.1 thorpej if (UE_GET_DIR(ed->bEndpointAddress) == UE_IN
237 1.1 thorpej && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
238 1.1 thorpej sc->sc_bulkin = ed->bEndpointAddress;
239 1.1 thorpej } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_OUT
240 1.1 thorpej && (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
241 1.1 thorpej sc->sc_bulkout = ed->bEndpointAddress;
242 1.1 thorpej }
243 1.1 thorpej }
244 1.1 thorpej
245 1.1 thorpej /* Open the bulk-in and -out pipe */
246 1.1 thorpej err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkout,
247 1.1 thorpej USBD_EXCLUSIVE_USE, &sc->sc_bulkout_pipe);
248 1.1 thorpej if (err) {
249 1.1 thorpej DPRINTF(UDMASS_USB, ("cannot open bulk out pipe (address %d)\n",
250 1.1 thorpej sc->sc_bulkout));
251 1.1 thorpej USB_ATTACH_ERROR_RETURN;
252 1.1 thorpej }
253 1.1 thorpej err = usbd_open_pipe(sc->sc_iface, sc->sc_bulkin,
254 1.1 thorpej USBD_EXCLUSIVE_USE, &sc->sc_bulkin_pipe);
255 1.1 thorpej if (err) {
256 1.1 thorpej DPRINTF(UDMASS_USB, ("cannot open bulk in pipe (address %d)\n",
257 1.1 thorpej sc->sc_bulkin));
258 1.1 thorpej usbd_close_pipe(sc->sc_bulkout_pipe);
259 1.1 thorpej USB_ATTACH_ERROR_RETURN;
260 1.1 thorpej }
261 1.1 thorpej
262 1.1 thorpej /* attach the device to the SCSI layer */
263 1.1 thorpej sc->sc_adapter.scsipi_cmd = umass_scsi_cmd;
264 1.1 thorpej sc->sc_adapter.scsipi_minphys = umass_minphys;
265 1.1 thorpej
266 1.1 thorpej sc->sc_link.scsipi_scsi.channel = SCSI_CHANNEL_ONLY_ONE;
267 1.1 thorpej sc->sc_link.adapter_softc = sc;
268 1.1 thorpej sc->sc_link.scsipi_scsi.adapter_target = UMASS_SCSIID_HOST;
269 1.1 thorpej sc->sc_link.adapter = &sc->sc_adapter;
270 1.1 thorpej sc->sc_link.device = &umass_dev;
271 1.1 thorpej sc->sc_link.openings = 4; /* XXX */
272 1.1 thorpej sc->sc_link.scsipi_scsi.max_target = UMASS_SCSIID_DEVICE; /* XXX */
273 1.1 thorpej sc->sc_link.scsipi_scsi.max_lun = 0; /* XXX */
274 1.1 thorpej sc->sc_link.type = BUS_SCSI;
275 1.1 thorpej
276 1.1 thorpej if (config_found(&sc->sc_dev, &sc->sc_link, scsiprint) == NULL) {
277 1.1 thorpej usbd_close_pipe(sc->sc_bulkout_pipe);
278 1.1 thorpej usbd_close_pipe(sc->sc_bulkin_pipe);
279 1.1 thorpej /* XXX Not really an error. */
280 1.1 thorpej USB_ATTACH_ERROR_RETURN;
281 1.1 thorpej }
282 1.1 thorpej
283 1.1 thorpej USB_ATTACH_SUCCESS_RETURN;
284 1.1 thorpej }
285 1.1 thorpej
286 1.1 thorpej int
287 1.1 thorpej umass_activate(self, act)
288 1.1 thorpej struct device *self;
289 1.1 thorpej enum devact act;
290 1.1 thorpej {
291 1.1 thorpej
292 1.1 thorpej switch (act) {
293 1.1 thorpej case DVACT_ACTIVATE:
294 1.1 thorpej return (EOPNOTSUPP);
295 1.1 thorpej break;
296 1.1 thorpej
297 1.1 thorpej case DVACT_DEACTIVATE:
298 1.1 thorpej /* XXX Not supported yet. */
299 1.1 thorpej return (EOPNOTSUPP);
300 1.1 thorpej break;
301 1.1 thorpej }
302 1.1 thorpej return (0);
303 1.1 thorpej }
304 1.1 thorpej
305 1.1 thorpej int
306 1.1 thorpej umass_detach(self, flags)
307 1.1 thorpej struct device *self;
308 1.1 thorpej int flags;
309 1.1 thorpej {
310 1.1 thorpej
311 1.1 thorpej /* XXX Not supported yet. */
312 1.1 thorpej return (EOPNOTSUPP);
313 1.1 thorpej }
314 1.1 thorpej
315 1.1 thorpej /* Performs a request over a pipe.
316 1.1 thorpej *
317 1.1 thorpej * flags: Can be set to USBD_SHORT_XFER_OK
318 1.1 thorpej * xfer_size: if not null returns the nr. of bytes transferred
319 1.1 thorpej *
320 1.1 thorpej * If the returned error is USBD_STALLED the pipe stall has
321 1.1 thorpej * been cleared again.
322 1.1 thorpej */
323 1.1 thorpej
324 1.1 thorpej usbd_status
325 1.1 thorpej umass_usb_transfer(usbd_interface_handle iface, usbd_pipe_handle pipe,
326 1.1 thorpej void *buf, int buflen, int flags, int *xfer_size)
327 1.1 thorpej {
328 1.1 thorpej usbd_request_handle reqh;
329 1.1 thorpej usbd_private_handle priv;
330 1.1 thorpej void *buffer;
331 1.1 thorpej int size;
332 1.1 thorpej usbd_status err;
333 1.1 thorpej
334 1.1 thorpej /* A transfer is done synchronously. We create and schedule the
335 1.1 thorpej * transfer and then wait for it to complete
336 1.1 thorpej */
337 1.1 thorpej
338 1.1 thorpej reqh = usbd_alloc_request();
339 1.1 thorpej if (!reqh) {
340 1.1 thorpej DPRINTF(UDMASS_USB, ("Not enough memory\n"));
341 1.1 thorpej return USBD_NOMEM;
342 1.1 thorpej }
343 1.1 thorpej
344 1.1 thorpej (void) usbd_setup_request(reqh, pipe, 0, buf, buflen,
345 1.1 thorpej flags, 3000 /*ms*/, NULL);
346 1.1 thorpej err = usbd_sync_transfer(reqh);
347 1.1 thorpej if (err) {
348 1.1 thorpej DPRINTF(UDMASS_USB, ("transfer failed, %s\n",
349 1.1 thorpej usbd_errstr(err)));
350 1.1 thorpej usbd_free_request(reqh);
351 1.1 thorpej return(err);
352 1.1 thorpej }
353 1.1 thorpej
354 1.1 thorpej usbd_get_request_status(reqh, &priv, &buffer, &size, &err);
355 1.1 thorpej
356 1.1 thorpej if (xfer_size)
357 1.1 thorpej *xfer_size = size;
358 1.1 thorpej
359 1.1 thorpej usbd_free_request(reqh);
360 1.1 thorpej return(USBD_NORMAL_COMPLETION);
361 1.1 thorpej }
362 1.1 thorpej
363 1.1 thorpej
364 1.1 thorpej
365 1.1 thorpej
366 1.1 thorpej usbd_status
367 1.1 thorpej umass_bulk_reset(umass_softc_t *sc)
368 1.1 thorpej {
369 1.1 thorpej usbd_device_handle dev;
370 1.1 thorpej usb_device_request_t req;
371 1.1 thorpej usbd_status err;
372 1.1 thorpej usb_interface_descriptor_t *id;
373 1.1 thorpej
374 1.1 thorpej /*
375 1.1 thorpej * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
376 1.1 thorpej *
377 1.1 thorpej * For Reset Recovery the host shall issue in the following order:
378 1.1 thorpej * a) a Bulk-Only Mass Storage Reset
379 1.1 thorpej * b) a Clear Feature HALT to the Bulk-In endpoint
380 1.1 thorpej * c) a Clear Feature HALT to the Bulk-Out endpoint
381 1.1 thorpej */
382 1.1 thorpej
383 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: Reset\n",
384 1.1 thorpej USBDEVNAME(sc->sc_dev)));
385 1.1 thorpej
386 1.1 thorpej usbd_interface2device_handle(sc->sc_iface, &dev);
387 1.1 thorpej id = usbd_get_interface_descriptor(sc->sc_iface);
388 1.1 thorpej
389 1.1 thorpej /* the reset command is a class specific interface request */
390 1.1 thorpej req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
391 1.1 thorpej req.bRequest = UR_RESET;
392 1.1 thorpej USETW(req.wValue, 0);
393 1.1 thorpej USETW(req.wIndex, id->bInterfaceNumber);
394 1.1 thorpej USETW(req.wLength, 0);
395 1.1 thorpej
396 1.1 thorpej err = usbd_do_request(dev, &req, 0);
397 1.1 thorpej if (err) {
398 1.1 thorpej printf("%s: Reset failed, %s\n",
399 1.1 thorpej USBDEVNAME(sc->sc_dev), usbd_errstr(err));
400 1.1 thorpej /* XXX we should port_reset the device */
401 1.1 thorpej return(err);
402 1.1 thorpej }
403 1.1 thorpej
404 1.1 thorpej usbd_clear_endpoint_stall(sc->sc_bulkout_pipe);
405 1.1 thorpej usbd_clear_endpoint_stall(sc->sc_bulkin_pipe);
406 1.1 thorpej
407 1.1 thorpej /*
408 1.1 thorpej * XXX we should convert this into a more friendly delay.
409 1.1 thorpej * Perhaps a tsleep (or is this routine run from int context?)
410 1.1 thorpej */
411 1.1 thorpej
412 1.1 thorpej DELAY(2500000 /*us*/);
413 1.1 thorpej
414 1.1 thorpej return(USBD_NORMAL_COMPLETION);
415 1.1 thorpej }
416 1.1 thorpej
417 1.1 thorpej /*
418 1.1 thorpej * Do a Bulk-Only transfer with cmdlen bytes from cmd, possibly
419 1.1 thorpej * a data phase of datalen bytes from/to data and finally a csw read
420 1.1 thorpej * phase.
421 1.1 thorpej *
422 1.1 thorpej * If the data direction was inbound a maximum of datalen bytes
423 1.1 thorpej * is stored in the buffer pointed to by data.
424 1.1 thorpej * The status returned is USBD_NORMAL_COMPLETION,
425 1.1 thorpej * USBD_IOERROR, USBD_COMMAND_FAILED.
426 1.1 thorpej * In the last case *residue is set to the residue from the CSW,
427 1.1 thorpej * otherwise to 0.
428 1.1 thorpej *
429 1.1 thorpej * For the functionality of this subroutine see the Mass Storage
430 1.1 thorpej * Spec., the graphs on page 14 and page 19 and beyong (v0.9 of
431 1.1 thorpej * the spec).
432 1.1 thorpej */
433 1.1 thorpej
434 1.1 thorpej usbd_status
435 1.1 thorpej umass_bulk_transfer(umass_softc_t *sc, int lun, void *cmd, int cmdlen,
436 1.1 thorpej void *data, int datalen, int dir, int *residue)
437 1.1 thorpej {
438 1.1 thorpej static int dCBWtag = 42; /* tag to be used in transfers,
439 1.1 thorpej * incremented at each transfer */
440 1.1 thorpej usb_bulk_cbw_t cbw; /* command block wrapper struct */
441 1.1 thorpej usb_bulk_csw_t csw; /* command status wrapper struct */
442 1.1 thorpej u_int32_t n = 0; /* number of bytes transported */
443 1.1 thorpej usbd_status err;
444 1.1 thorpej
445 1.1 thorpej #ifdef UMASS_DEBUG
446 1.1 thorpej u_int8_t *c = cmd;
447 1.1 thorpej
448 1.1 thorpej /* check the given arguments */
449 1.1 thorpej if (!data && datalen > 0) { /* no buffer for transfer */
450 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: no buffer, but datalen > 0 !\n",
451 1.1 thorpej USBDEVNAME(sc->sc_dev)));
452 1.1 thorpej return USBD_IOERROR;
453 1.1 thorpej }
454 1.1 thorpej
455 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: cmd: %d bytes (0x%02x%02x%02x%02x%02x%02x%s)"
456 1.1 thorpej ", data: %d bytes, dir: %s\n",
457 1.1 thorpej USBDEVNAME(sc->sc_dev),
458 1.1 thorpej cmdlen, c[0], c[1], c[2], c[3], c[4], c[5],
459 1.1 thorpej (cmdlen > 6? "...":""),
460 1.1 thorpej datalen, (dir == DIR_IN? "in":"out")));
461 1.1 thorpej #endif
462 1.1 thorpej
463 1.1 thorpej if (dir == DIR_NONE || datalen == 0) { /* make sure they correspond */
464 1.1 thorpej datalen = 0;
465 1.1 thorpej dir = DIR_NONE;
466 1.1 thorpej }
467 1.1 thorpej
468 1.1 thorpej *residue = 0; /* reset residue */
469 1.1 thorpej
470 1.1 thorpej /*
471 1.1 thorpej * Determine the direction of transferring data and data length.
472 1.1 thorpej *
473 1.1 thorpej * dCBWDataTransferLength (datalen) :
474 1.1 thorpej * This field indicates the number of bytes of data that the host
475 1.1 thorpej * intends to transfer on the IN or OUT Bulk endpoint(as indicated by
476 1.1 thorpej * the Direction bit) during the execution of this command. If this
477 1.1 thorpej * field is set to 0, the device will expect that no data will be
478 1.1 thorpej * transferred IN or OUT during this command, regardless of the value
479 1.1 thorpej * of the Direction bit defined in dCBWFlags.
480 1.1 thorpej *
481 1.1 thorpej * dCBWFlags (dir) :
482 1.1 thorpej * The bits of the Flags field are defined as follows:
483 1.1 thorpej * Bits 0-6 reserved
484 1.1 thorpej * Bit 7 Direction - this bit shall be ignored if the
485 1.1 thorpej * dCBWDataTransferLength field is zero.
486 1.1 thorpej * 0 = data Out from host to device
487 1.1 thorpej * 1 = data In from device to host
488 1.1 thorpej */
489 1.1 thorpej
490 1.1 thorpej
491 1.1 thorpej /*
492 1.1 thorpej * Command transport phase
493 1.1 thorpej */
494 1.1 thorpej
495 1.1 thorpej /* Fill in the Command Block Wrapper */
496 1.1 thorpej USETDW(cbw.dCBWSignature, CBWSIGNATURE);
497 1.1 thorpej USETDW(cbw.dCBWTag, dCBWtag++);
498 1.1 thorpej USETDW(cbw.dCBWDataTransferLength, datalen);
499 1.1 thorpej /* we do not check for DIR_NONE below (see text on dCBWFlags above) */
500 1.1 thorpej cbw.bCBWFlags = (dir == DIR_IN? CBWFLAGS_IN:CBWFLAGS_OUT);
501 1.1 thorpej cbw.bCBWLUN = lun;
502 1.1 thorpej cbw.bCDBLength = cmdlen;
503 1.1 thorpej bcopy(cmd, cbw.CBWCDB, cmdlen);
504 1.1 thorpej
505 1.1 thorpej /* Send the CBW from host to device via bulk-out endpoint. */
506 1.1 thorpej err = umass_usb_transfer(sc->sc_iface, sc->sc_bulkout_pipe,
507 1.1 thorpej &cbw, USB_BULK_CBW_SIZE, 0, NULL);
508 1.1 thorpej if (err) {
509 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: failed to send CBW\n",
510 1.1 thorpej USBDEVNAME(sc->sc_dev)));
511 1.1 thorpej /* If the device detects that the CBW is invalid, then the
512 1.1 thorpej * device may STALL both bulk endpoints and require a
513 1.1 thorpej * Bulk-Only MS Reset
514 1.1 thorpej */
515 1.1 thorpej umass_bulk_reset(sc);
516 1.1 thorpej return(USBD_IOERROR);
517 1.1 thorpej }
518 1.1 thorpej
519 1.1 thorpej
520 1.1 thorpej /*
521 1.1 thorpej * Data transport phase (only if there is data to be sent/received)
522 1.1 thorpej */
523 1.1 thorpej
524 1.1 thorpej if (dir == DIR_IN) {
525 1.1 thorpej /* we allow short transfers for bulk-in pipes */
526 1.1 thorpej err = umass_usb_transfer(sc->sc_iface, sc->sc_bulkin_pipe,
527 1.1 thorpej data, datalen,
528 1.1 thorpej USBD_SHORT_XFER_OK, &n);
529 1.1 thorpej if (err)
530 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: failed to receive data, "
531 1.1 thorpej "(%d bytes, n = %d), %s\n",
532 1.1 thorpej USBDEVNAME(sc->sc_dev),
533 1.1 thorpej datalen, n, usbd_errstr(err)));
534 1.1 thorpej } else if (dir == DIR_OUT) {
535 1.1 thorpej err = umass_usb_transfer(sc->sc_iface,
536 1.1 thorpej sc->sc_bulkout_pipe,
537 1.1 thorpej data, datalen, 0, &n);
538 1.1 thorpej if (err)
539 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: failed to send data, "
540 1.1 thorpej "(%d bytes, n = %d), %s\n",
541 1.1 thorpej USBDEVNAME(sc->sc_dev),
542 1.1 thorpej datalen, n, usbd_errstr(err)));
543 1.1 thorpej }
544 1.1 thorpej if (err && err != USBD_STALLED)
545 1.1 thorpej return(USBD_IOERROR);
546 1.1 thorpej
547 1.1 thorpej
548 1.1 thorpej /*
549 1.1 thorpej * Status transport phase
550 1.1 thorpej */
551 1.1 thorpej
552 1.1 thorpej /* Read the Command Status Wrapper via bulk-in endpoint. */
553 1.1 thorpej err = umass_usb_transfer(sc->sc_iface, sc->sc_bulkin_pipe,
554 1.1 thorpej &csw, USB_BULK_CSW_SIZE, 0, NULL);
555 1.1 thorpej /* Try again if the bulk-in pipe was stalled */
556 1.1 thorpej if (err == USBD_STALLED) {
557 1.1 thorpej err = usbd_clear_endpoint_stall(sc->sc_bulkin_pipe);
558 1.1 thorpej if (!err) {
559 1.1 thorpej err = umass_usb_transfer(sc->sc_iface, sc->sc_bulkin_pipe,
560 1.1 thorpej &csw, USB_BULK_CSW_SIZE, 0, NULL);
561 1.1 thorpej }
562 1.1 thorpej }
563 1.1 thorpej if (err && err != USBD_STALLED)
564 1.1 thorpej return(USBD_IOERROR);
565 1.1 thorpej
566 1.1 thorpej /*
567 1.1 thorpej * Check the CSW for status and validity, and check for fatal errors
568 1.1 thorpej */
569 1.1 thorpej
570 1.1 thorpej /* Invalid CSW: Wrong signature or wrong tag might indicate
571 1.1 thorpej * that the device is confused -> reset it.
572 1.1 thorpej * Other fatal errors: STALL on read of CSW and Phase error
573 1.1 thorpej * or unknown status.
574 1.1 thorpej */
575 1.1 thorpej if (err == USBD_STALLED
576 1.1 thorpej || UGETDW(csw.dCSWSignature) != CSWSIGNATURE
577 1.1 thorpej || UGETDW(csw.dCSWTag) != UGETDW(cbw.dCBWTag)
578 1.1 thorpej || csw.bCSWStatus == CSWSTATUS_PHASE
579 1.1 thorpej || csw.bCSWStatus > CSWSTATUS_PHASE) {
580 1.1 thorpej if (err) {
581 1.1 thorpej printf("%s: failed to read CSW, %s\n",
582 1.1 thorpej USBDEVNAME(sc->sc_dev), usbd_errstr(err));
583 1.1 thorpej } else if (csw.bCSWStatus == CSWSTATUS_PHASE) {
584 1.1 thorpej printf("%s: Phase Error, residue = %d, n = %d\n",
585 1.1 thorpej USBDEVNAME(sc->sc_dev),
586 1.1 thorpej UGETDW(csw.dCSWDataResidue), n);
587 1.1 thorpej } else if (csw.bCSWStatus > CSWSTATUS_PHASE) {
588 1.1 thorpej printf("%s: Unknown status %d in CSW\n",
589 1.1 thorpej USBDEVNAME(sc->sc_dev), csw.bCSWStatus);
590 1.1 thorpej } else {
591 1.1 thorpej printf("%s: invalid CSW, sig = 0x%08x, tag = %d (!= %d)\n",
592 1.1 thorpej USBDEVNAME(sc->sc_dev),
593 1.1 thorpej UGETDW(csw.dCSWSignature),
594 1.1 thorpej UGETDW(csw.dCSWTag), UGETDW(cbw.dCBWTag));
595 1.1 thorpej }
596 1.1 thorpej umass_bulk_reset(sc);
597 1.1 thorpej return(USBD_IOERROR);
598 1.1 thorpej }
599 1.1 thorpej
600 1.1 thorpej if (csw.bCSWStatus == CSWSTATUS_FAILED) {
601 1.1 thorpej DPRINTF(UDMASS_BULK, ("%s: Command Failed, "
602 1.1 thorpej "residue = %d, n = %d\n",
603 1.1 thorpej USBDEVNAME(sc->sc_dev),
604 1.1 thorpej UGETDW(csw.dCSWDataResidue), n));
605 1.1 thorpej *residue = UGETDW(csw.dCSWDataResidue);
606 1.1 thorpej return(USBD_COMMAND_FAILED);
607 1.1 thorpej }
608 1.1 thorpej
609 1.1 thorpej /*
610 1.1 thorpej * XXX a residue not equal to 0 might indicate that something
611 1.1 thorpej * is wrong. Does CAM high level drivers check this for us?
612 1.1 thorpej */
613 1.1 thorpej
614 1.1 thorpej return(USBD_NORMAL_COMPLETION);
615 1.1 thorpej }
616 1.1 thorpej
617 1.1 thorpej
618 1.1 thorpej /*
619 1.1 thorpej * SCSIPI specific functions
620 1.1 thorpej */
621 1.1 thorpej
622 1.1 thorpej int
623 1.1 thorpej umass_scsi_cmd(xs)
624 1.1 thorpej struct scsipi_xfer *xs;
625 1.1 thorpej {
626 1.1 thorpej struct scsipi_link *sc_link = xs->sc_link;
627 1.1 thorpej struct umass_softc *sc = sc_link->adapter_softc;
628 1.1 thorpej int residue, dir;
629 1.1 thorpej usbd_status err;
630 1.1 thorpej
631 1.1 thorpej DPRINTF(UDMASS_SCSI, ("%s: umass_scsi_cmd %d:%d\n",
632 1.1 thorpej USBDEVNAME(sc->sc_dev),
633 1.1 thorpej sc_link->scsipi_scsi.target, sc_link->scsipi_scsi.lun));
634 1.1 thorpej
635 1.1 thorpej #ifdef UMASS_DEBUG
636 1.1 thorpej if (sc_link->scsipi_scsi.target != UMASS_SCSIID_DEVICE ||
637 1.1 thorpej sc_link->scsipi_scsi.lun != 0) {
638 1.1 thorpej DPRINTF(UDMASS_SCSI, ("%s: Wrong SCSI ID %d or LUN %d\n",
639 1.1 thorpej USBDEVNAME(sc->sc_dev),
640 1.1 thorpej sc_link->scsipi_scsi.target,
641 1.1 thorpej sc_link->scsipi_scsi.lun));
642 1.1 thorpej xs->error = XS_DRIVER_STUFFUP;
643 1.1 thorpej return (COMPLETE);
644 1.1 thorpej }
645 1.1 thorpej #endif
646 1.1 thorpej
647 1.1 thorpej dir = DIR_NONE;
648 1.1 thorpej if (xs->datalen) {
649 1.1 thorpej switch (xs->flags & (SCSI_DATA_IN|SCSI_DATA_OUT)) {
650 1.1 thorpej case SCSI_DATA_IN:
651 1.1 thorpej dir = DIR_IN;
652 1.1 thorpej break;
653 1.1 thorpej case SCSI_DATA_OUT:
654 1.1 thorpej dir = DIR_OUT;
655 1.1 thorpej break;
656 1.1 thorpej }
657 1.1 thorpej }
658 1.1 thorpej
659 1.1 thorpej err = umass_bulk_transfer(sc, sc_link->scsipi_scsi.lun,
660 1.1 thorpej xs->cmd, xs->cmdlen, xs->data, xs->datalen, dir, &residue);
661 1.1 thorpej
662 1.1 thorpej /*
663 1.1 thorpej * FAILED commands are supposed to be SCSI failed commands
664 1.1 thorpej * and are therefore considered to be successfull CDW/CSW
665 1.1 thorpej * transfers. PHASE errors are more serious and should return
666 1.1 thorpej * an error to the SCSIPI system.
667 1.1 thorpej *
668 1.1 thorpej * XXX This is however more based on empirical evidence than on
669 1.1 thorpej * hard proof from the Bulk-Only spec.
670 1.1 thorpej */
671 1.1 thorpej if (err == USBD_NORMAL_COMPLETION)
672 1.1 thorpej xs->error = XS_NOERROR;
673 1.1 thorpej else
674 1.1 thorpej xs->error = XS_DRIVER_STUFFUP; /* XXX */
675 1.1 thorpej xs->resid = residue;
676 1.1 thorpej
677 1.1 thorpej DPRINTF(UDMASS_SCSI, ("%s: umass_scsi_cmd: error = %d, resid = 0x%x\n",
678 1.1 thorpej USBDEVNAME(sc->sc_dev), xs->error, xs->resid));
679 1.1 thorpej
680 1.1 thorpej xs->flags |= ITSDONE;
681 1.1 thorpej scsipi_done(xs);
682 1.1 thorpej
683 1.1 thorpej /*
684 1.1 thorpej * XXXJRT We must return successfully queued if we're an
685 1.1 thorpej * XXXJRT `asynchronous' command, otherwise `xs' will be
686 1.1 thorpej * XXXJRT freed twice: once in scsipi_done(), and once in
687 1.1 thorpej * XXXJRT scsi_scsipi_cmd().
688 1.1 thorpej */
689 1.1 thorpej if (SCSIPI_XFER_ASYNC(xs))
690 1.1 thorpej return (SUCCESSFULLY_QUEUED);
691 1.1 thorpej
692 1.1 thorpej return (COMPLETE);
693 1.1 thorpej }
694 1.1 thorpej
695 1.1 thorpej void
696 1.1 thorpej umass_minphys(bp)
697 1.1 thorpej struct buf *bp;
698 1.1 thorpej {
699 1.1 thorpej
700 1.1 thorpej /* No limit here. */
701 1.1 thorpej minphys(bp);
702 1.1 thorpej }
703