FreeBSD kernel usb device Code
umass.c
Go to the documentation of this file.
1#include <sys/cdefs.h>
2__FBSDID("$FreeBSD$");
3
4/*-
5 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
6 *
7 * Copyright (c) 1999 MAEKAWA Masahide <bishop@rr.iij4u.or.jp>,
8 * Nick Hibma <n_hibma@FreeBSD.org>
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * $FreeBSD$
33 * $NetBSD: umass.c,v 1.28 2000/04/02 23:46:53 augustss Exp $
34 */
35
36/* Also already merged from NetBSD:
37 * $NetBSD: umass.c,v 1.67 2001/11/25 19:05:22 augustss Exp $
38 * $NetBSD: umass.c,v 1.90 2002/11/04 19:17:33 pooka Exp $
39 * $NetBSD: umass.c,v 1.108 2003/11/07 17:03:25 wiz Exp $
40 * $NetBSD: umass.c,v 1.109 2003/12/04 13:57:31 keihan Exp $
41 */
42
43/*
44 * Universal Serial Bus Mass Storage Class specs:
45 * http://www.usb.org/developers/devclass_docs/usb_msc_overview_1.2.pdf
46 * http://www.usb.org/developers/devclass_docs/usbmassbulk_10.pdf
47 * http://www.usb.org/developers/devclass_docs/usb_msc_cbi_1.1.pdf
48 * http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf
49 */
50
51/*
52 * Ported to NetBSD by Lennart Augustsson <augustss@NetBSD.org>.
53 * Parts of the code written by Jason R. Thorpe <thorpej@shagadelic.org>.
54 */
55
56/*
57 * The driver handles 3 Wire Protocols
58 * - Command/Bulk/Interrupt (CBI)
59 * - Command/Bulk/Interrupt with Command Completion Interrupt (CBI with CCI)
60 * - Mass Storage Bulk-Only (BBB)
61 * (BBB refers Bulk/Bulk/Bulk for Command/Data/Status phases)
62 *
63 * Over these wire protocols it handles the following command protocols
64 * - SCSI
65 * - UFI (floppy command set)
66 * - 8070i (ATAPI)
67 *
68 * UFI and 8070i (ATAPI) are transformed versions of the SCSI command set. The
69 * sc->sc_transform method is used to convert the commands into the appropriate
70 * format (if at all necessary). For example, UFI requires all commands to be
71 * 12 bytes in length amongst other things.
72 *
73 * The source code below is marked and can be split into a number of pieces
74 * (in this order):
75 *
76 * - probe/attach/detach
77 * - generic transfer routines
78 * - BBB
79 * - CBI
80 * - CBI_I (in addition to functions from CBI)
81 * - CAM (Common Access Method)
82 * - SCSI
83 * - UFI
84 * - 8070i (ATAPI)
85 *
86 * The protocols are implemented using a state machine, for the transfers as
87 * well as for the resets. The state machine is contained in umass_t_*_callback.
88 * The state machine is started through either umass_command_start() or
89 * umass_reset().
90 *
91 * The reason for doing this is a) CAM performs a lot better this way and b) it
92 * avoids using tsleep from interrupt context (for example after a failed
93 * transfer).
94 */
95
96/*
97 * The SCSI related part of this driver has been derived from the
98 * dev/ppbus/vpo.c driver, by Nicolas Souchu (nsouch@FreeBSD.org).
99 *
100 * The CAM layer uses so called actions which are messages sent to the host
101 * adapter for completion. The actions come in through umass_cam_action. The
102 * appropriate block of routines is called depending on the transport protocol
103 * in use. When the transfer has finished, these routines call
104 * umass_cam_cb again to complete the CAM command.
105 */
106
107#include <sys/stdint.h>
108#include <sys/stddef.h>
109#include <sys/param.h>
110#include <sys/queue.h>
111#include <sys/types.h>
112#include <sys/systm.h>
113#include <sys/kernel.h>
114#include <sys/bus.h>
115#include <sys/module.h>
116#include <sys/lock.h>
117#include <sys/mutex.h>
118#include <sys/condvar.h>
119#include <sys/sysctl.h>
120#include <sys/sx.h>
121#include <sys/unistd.h>
122#include <sys/callout.h>
123#include <sys/malloc.h>
124#include <sys/priv.h>
125
126#include <dev/usb/usb.h>
127#include <dev/usb/usbdi.h>
128#include <dev/usb/usbdi_util.h>
129#include "usbdevs.h"
130
132
133#include <cam/cam.h>
134#include <cam/cam_ccb.h>
135#include <cam/cam_sim.h>
136#include <cam/cam_xpt_sim.h>
137#include <cam/scsi/scsi_all.h>
138#include <cam/scsi/scsi_da.h>
139
140#include <cam/cam_periph.h>
141
142#ifdef USB_DEBUG
143#define DIF(m, x) \
144 do { \
145 if (umass_debug & (m)) { x ; } \
146 } while (0)
147
148#define DPRINTF(sc, m, fmt, ...) \
149 do { \
150 if (umass_debug & (m)) { \
151 printf("%s:%s: " fmt, \
152 (sc) ? (const char *)(sc)->sc_name : \
153 (const char *)"umassX", \
154 __FUNCTION__ ,## __VA_ARGS__); \
155 } \
156 } while (0)
157
158#define UDMASS_GEN 0x00010000 /* general */
159#define UDMASS_SCSI 0x00020000 /* scsi */
160#define UDMASS_UFI 0x00040000 /* ufi command set */
161#define UDMASS_ATAPI 0x00080000 /* 8070i command set */
162#define UDMASS_CMD (UDMASS_SCSI|UDMASS_UFI|UDMASS_ATAPI)
163#define UDMASS_USB 0x00100000 /* USB general */
164#define UDMASS_BBB 0x00200000 /* Bulk-Only transfers */
165#define UDMASS_CBI 0x00400000 /* CBI transfers */
166#define UDMASS_WIRE (UDMASS_BBB|UDMASS_CBI)
167#define UDMASS_ALL 0xffff0000 /* all of the above */
168static int umass_debug;
169static int umass_throttle;
170
171static SYSCTL_NODE(_hw_usb, OID_AUTO, umass, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
172 "USB umass");
173SYSCTL_INT(_hw_usb_umass, OID_AUTO, debug, CTLFLAG_RWTUN,
174 &umass_debug, 0, "umass debug level");
175SYSCTL_INT(_hw_usb_umass, OID_AUTO, throttle, CTLFLAG_RWTUN,
176 &umass_throttle, 0, "Forced delay between commands in milliseconds");
177#else
178#define DIF(...) do { } while (0)
179#define DPRINTF(...) do { } while (0)
180#endif
181
182#define UMASS_BULK_SIZE (1 << 17)
183#define UMASS_CBI_DIAGNOSTIC_CMDLEN 12 /* bytes */
184#define UMASS_MAX_CMDLEN MAX(12, CAM_MAX_CDBLEN) /* bytes */
185
186/* USB transfer definitions */
187
188#define UMASS_T_BBB_RESET1 0 /* Bulk-Only */
189#define UMASS_T_BBB_RESET2 1
190#define UMASS_T_BBB_RESET3 2
191#define UMASS_T_BBB_COMMAND 3
192#define UMASS_T_BBB_DATA_READ 4
193#define UMASS_T_BBB_DATA_RD_CS 5
194#define UMASS_T_BBB_DATA_WRITE 6
195#define UMASS_T_BBB_DATA_WR_CS 7
196#define UMASS_T_BBB_STATUS 8
197#define UMASS_T_BBB_MAX 9
198
199#define UMASS_T_CBI_RESET1 0 /* CBI */
200#define UMASS_T_CBI_RESET2 1
201#define UMASS_T_CBI_RESET3 2
202#define UMASS_T_CBI_COMMAND 3
203#define UMASS_T_CBI_DATA_READ 4
204#define UMASS_T_CBI_DATA_RD_CS 5
205#define UMASS_T_CBI_DATA_WRITE 6
206#define UMASS_T_CBI_DATA_WR_CS 7
207#define UMASS_T_CBI_STATUS 8
208#define UMASS_T_CBI_RESET4 9
209#define UMASS_T_CBI_MAX 10
210
211#define UMASS_T_MAX MAX(UMASS_T_CBI_MAX, UMASS_T_BBB_MAX)
212
213/* Generic definitions */
214
215/* Direction for transfer */
216#define DIR_NONE 0
217#define DIR_IN 1
218#define DIR_OUT 2
219
220/* device name */
221#define DEVNAME "umass"
222#define DEVNAME_SIM "umass-sim"
223
224/* Approximate maximum transfer speeds (assumes 33% overhead). */
225#define UMASS_FULL_TRANSFER_SPEED 1000
226#define UMASS_HIGH_TRANSFER_SPEED 40000
227#define UMASS_SUPER_TRANSFER_SPEED 400000
228#define UMASS_FLOPPY_TRANSFER_SPEED 20
229
230#define UMASS_TIMEOUT 5000 /* ms */
231
232/* CAM specific definitions */
233
234#define UMASS_SCSIID_MAX 1 /* maximum number of drives expected */
235#define UMASS_SCSIID_HOST UMASS_SCSIID_MAX
236
237/* Bulk-Only features */
238
239#define UR_BBB_RESET 0xff /* Bulk-Only reset */
240#define UR_BBB_GET_MAX_LUN 0xfe /* Get maximum lun */
241
242/* Command Block Wrapper */
243typedef struct {
245#define CBWSIGNATURE 0x43425355
249#define CBWFLAGS_OUT 0x00
250#define CBWFLAGS_IN 0x80
253#define CBWCDBLENGTH 16
255} __packed umass_bbb_cbw_t;
256
257#define UMASS_BBB_CBW_SIZE 31
258
259/* Command Status Wrapper */
260typedef struct {
262#define CSWSIGNATURE 0x53425355
263#define CSWSIGNATURE_IMAGINATION_DBX1 0x43425355
264#define CSWSIGNATURE_OLYMPUS_C1 0x55425355
268#define CSWSTATUS_GOOD 0x0
269#define CSWSTATUS_FAILED 0x1
270#define CSWSTATUS_PHASE 0x2
271} __packed umass_bbb_csw_t;
272
273#define UMASS_BBB_CSW_SIZE 13
274
275/* CBI features */
276
277#define UR_CBI_ADSC 0x00
278
279typedef union {
280 struct {
281 uint8_t type;
282#define IDB_TYPE_CCI 0x00
283 uint8_t value;
284#define IDB_VALUE_PASS 0x00
285#define IDB_VALUE_FAIL 0x01
286#define IDB_VALUE_PHASE 0x02
287#define IDB_VALUE_PERSISTENT 0x03
288#define IDB_VALUE_STATUS_MASK 0x03
289 } __packed common;
290
291 struct {
292 uint8_t asc;
293 uint8_t ascq;
294 } __packed ufi;
295} __packed umass_cbi_sbl_t;
296
297struct umass_softc; /* see below */
298
299typedef void (umass_callback_t)(struct umass_softc *sc, union ccb *ccb,
300 uint32_t residue, uint8_t status);
301
302#define STATUS_CMD_OK 0 /* everything ok */
303#define STATUS_CMD_UNKNOWN 1 /* will have to fetch sense */
304#define STATUS_CMD_FAILED 2 /* transfer was ok, command failed */
305#define STATUS_WIRE_FAILED 3 /* couldn't even get command across */
306
307typedef uint8_t (umass_transform_t)(struct umass_softc *sc, uint8_t *cmd_ptr,
308 uint8_t cmd_len);
309
310/* Wire and command protocol */
311#define UMASS_PROTO_BBB 0x0001 /* USB wire protocol */
312#define UMASS_PROTO_CBI 0x0002
313#define UMASS_PROTO_CBI_I 0x0004
314#define UMASS_PROTO_WIRE 0x00ff /* USB wire protocol mask */
315#define UMASS_PROTO_SCSI 0x0100 /* command protocol */
316#define UMASS_PROTO_ATAPI 0x0200
317#define UMASS_PROTO_UFI 0x0400
318#define UMASS_PROTO_RBC 0x0800
319#define UMASS_PROTO_COMMAND 0xff00 /* command protocol mask */
320
321/* Device specific quirks */
322#define NO_QUIRKS 0x0000
323 /*
324 * The drive does not support Test Unit Ready. Convert to Start Unit
325 */
326#define NO_TEST_UNIT_READY 0x0001
327 /*
328 * The drive does not reset the Unit Attention state after REQUEST
329 * SENSE has been sent. The INQUIRY command does not reset the UA
330 * either, and so CAM runs in circles trying to retrieve the initial
331 * INQUIRY data.
332 */
333#define RS_NO_CLEAR_UA 0x0002
334 /* The drive does not support START STOP. */
335#define NO_START_STOP 0x0004
336 /* Don't ask for full inquiry data (255b). */
337#define FORCE_SHORT_INQUIRY 0x0008
338 /* Needs to be initialised the Shuttle way */
339#define SHUTTLE_INIT 0x0010
340 /* Drive needs to be switched to alternate iface 1 */
341#define ALT_IFACE_1 0x0020
342 /* Drive does not do 1Mb/s, but just floppy speeds (20kb/s) */
343#define FLOPPY_SPEED 0x0040
344 /* The device can't count and gets the residue of transfers wrong */
345#define IGNORE_RESIDUE 0x0080
346 /* No GetMaxLun call */
347#define NO_GETMAXLUN 0x0100
348 /* The device uses a weird CSWSIGNATURE. */
349#define WRONG_CSWSIG 0x0200
350 /* Device cannot handle INQUIRY so fake a generic response */
351#define NO_INQUIRY 0x0400
352 /* Device cannot handle INQUIRY EVPD, return CHECK CONDITION */
353#define NO_INQUIRY_EVPD 0x0800
354 /* Pad all RBC requests to 12 bytes. */
355#define RBC_PAD_TO_12 0x1000
356 /*
357 * Device reports number of sectors from READ_CAPACITY, not max
358 * sector number.
359 */
360#define READ_CAPACITY_OFFBY1 0x2000
361 /*
362 * Device cannot handle a SCSI synchronize cache command. Normally
363 * this quirk would be handled in the cam layer, but for IDE bridges
364 * we need to associate the quirk with the bridge and not the
365 * underlying disk device. This is handled by faking a success
366 * result.
367 */
368#define NO_SYNCHRONIZE_CACHE 0x4000
369 /* Device does not support 'PREVENT/ALLOW MEDIUM REMOVAL'. */
370#define NO_PREVENT_ALLOW 0x8000
371
373 struct scsi_sense cam_scsi_sense;
375 struct mtx sc_mtx;
376 struct {
377 uint8_t *data_ptr;
378 union ccb *ccb;
380
381 uint32_t data_len; /* bytes */
382 uint32_t data_rem; /* bytes */
383 uint32_t data_timeout; /* ms */
384 uint32_t actlen; /* bytes */
385
387 uint8_t cmd_len; /* bytes */
388 uint8_t dir;
389 uint8_t lun;
391
392 /* Bulk specific variables for transfers in progress */
393 umass_bbb_cbw_t cbw; /* command block wrapper */
394 umass_bbb_csw_t csw; /* command status wrapper */
395
396 /* CBI specific variables for transfers in progress */
397 umass_cbi_sbl_t sbl; /* status block */
398
399 device_t sc_dev;
401 struct cam_sim *sc_sim; /* SCSI Interface Module */
403
404 /*
405 * The command transform function is used to convert the SCSI
406 * commands into their derivatives, like UFI, ATAPI, and friends.
407 */
409
410 uint32_t sc_unit;
411 uint32_t sc_quirks; /* they got it almost right */
412 uint32_t sc_proto; /* wire and cmd protocol */
413
414 uint8_t sc_name[16];
415 uint8_t sc_iface_no; /* interface number */
416 uint8_t sc_maxlun; /* maximum LUN number, inclusive */
419};
420
422 uint32_t quirks;
423 uint32_t proto;
424
425 int error;
426};
427
428/* prototypes */
429
430static device_probe_t umass_probe;
431static device_attach_t umass_attach;
432static device_detach_t umass_detach;
433
454
455static void umass_cancel_ccb(struct umass_softc *);
456static void umass_init_shuttle(struct umass_softc *);
457static void umass_reset(struct umass_softc *);
459 uint8_t, uint8_t, usb_error_t);
460static void umass_command_start(struct umass_softc *, uint8_t, void *,
461 uint32_t, uint32_t, umass_callback_t *, union ccb *);
462static uint8_t umass_bbb_get_max_lun(struct umass_softc *);
463static void umass_cbi_start_status(struct umass_softc *);
465 uint8_t, uint8_t, usb_error_t);
466static int umass_cam_attach_sim(struct umass_softc *);
467static void umass_cam_attach(struct umass_softc *);
468static void umass_cam_detach_sim(struct umass_softc *);
469static void umass_cam_action(struct cam_sim *, union ccb *);
470static void umass_cam_poll(struct cam_sim *);
471static void umass_cam_cb(struct umass_softc *, union ccb *, uint32_t,
472 uint8_t);
473static void umass_cam_sense_cb(struct umass_softc *, union ccb *, uint32_t,
474 uint8_t);
475static void umass_cam_quirk_cb(struct umass_softc *, union ccb *, uint32_t,
476 uint8_t);
477static uint8_t umass_scsi_transform(struct umass_softc *, uint8_t *, uint8_t);
478static uint8_t umass_rbc_transform(struct umass_softc *, uint8_t *, uint8_t);
479static uint8_t umass_ufi_transform(struct umass_softc *, uint8_t *, uint8_t);
480static uint8_t umass_atapi_transform(struct umass_softc *, uint8_t *,
481 uint8_t);
482static uint8_t umass_no_transform(struct umass_softc *, uint8_t *, uint8_t);
483static uint8_t umass_std_transform(struct umass_softc *, union ccb *, uint8_t
484 *, uint8_t);
485
486#ifdef USB_DEBUG
487static void umass_bbb_dump_cbw(struct umass_softc *, umass_bbb_cbw_t *);
488static void umass_bbb_dump_csw(struct umass_softc *, umass_bbb_csw_t *);
489static void umass_cbi_dump_cmd(struct umass_softc *, void *, uint8_t);
490static void umass_dump_buffer(struct umass_softc *, uint8_t *, uint32_t,
491 uint32_t);
492#endif
493
496 .type = UE_CONTROL,
497 .endpoint = 0x00, /* Control pipe */
498 .direction = UE_DIR_ANY,
499 .bufsize = sizeof(struct usb_device_request),
500 .callback = &umass_t_bbb_reset1_callback,
501 .timeout = 5000, /* 5 seconds */
502 .interval = 500, /* 500 milliseconds */
503 },
504
506 .type = UE_CONTROL,
507 .endpoint = 0x00, /* Control pipe */
508 .direction = UE_DIR_ANY,
509 .bufsize = sizeof(struct usb_device_request),
510 .callback = &umass_t_bbb_reset2_callback,
511 .timeout = 5000, /* 5 seconds */
512 .interval = 50, /* 50 milliseconds */
513 },
514
516 .type = UE_CONTROL,
517 .endpoint = 0x00, /* Control pipe */
518 .direction = UE_DIR_ANY,
519 .bufsize = sizeof(struct usb_device_request),
520 .callback = &umass_t_bbb_reset3_callback,
521 .timeout = 5000, /* 5 seconds */
522 .interval = 50, /* 50 milliseconds */
523 },
524
526 .type = UE_BULK,
527 .endpoint = UE_ADDR_ANY,
528 .direction = UE_DIR_OUT,
529 .bufsize = sizeof(umass_bbb_cbw_t),
530 .callback = &umass_t_bbb_command_callback,
531 .timeout = 5000, /* 5 seconds */
532 },
533
535 .type = UE_BULK,
536 .endpoint = UE_ADDR_ANY,
537 .direction = UE_DIR_IN,
538 .bufsize = UMASS_BULK_SIZE,
539 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer=1,},
541 .timeout = 0, /* overwritten later */
542 },
543
545 .type = UE_CONTROL,
546 .endpoint = 0x00, /* Control pipe */
547 .direction = UE_DIR_ANY,
548 .bufsize = sizeof(struct usb_device_request),
550 .timeout = 5000, /* 5 seconds */
551 },
552
554 .type = UE_BULK,
555 .endpoint = UE_ADDR_ANY,
556 .direction = UE_DIR_OUT,
557 .bufsize = UMASS_BULK_SIZE,
558 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer=1,},
560 .timeout = 0, /* overwritten later */
561 },
562
564 .type = UE_CONTROL,
565 .endpoint = 0x00, /* Control pipe */
566 .direction = UE_DIR_ANY,
567 .bufsize = sizeof(struct usb_device_request),
569 .timeout = 5000, /* 5 seconds */
570 },
571
573 .type = UE_BULK,
574 .endpoint = UE_ADDR_ANY,
575 .direction = UE_DIR_IN,
576 .bufsize = sizeof(umass_bbb_csw_t),
577 .flags = {.short_xfer_ok = 1,},
578 .callback = &umass_t_bbb_status_callback,
579 .timeout = 5000, /* ms */
580 },
581};
582
585 .type = UE_CONTROL,
586 .endpoint = 0x00, /* Control pipe */
587 .direction = UE_DIR_ANY,
588 .bufsize = (sizeof(struct usb_device_request) +
590 .callback = &umass_t_cbi_reset1_callback,
591 .timeout = 5000, /* 5 seconds */
592 .interval = 500, /* 500 milliseconds */
593 },
594
596 .type = UE_CONTROL,
597 .endpoint = 0x00, /* Control pipe */
598 .direction = UE_DIR_ANY,
599 .bufsize = sizeof(struct usb_device_request),
600 .callback = &umass_t_cbi_reset2_callback,
601 .timeout = 5000, /* 5 seconds */
602 .interval = 50, /* 50 milliseconds */
603 },
604
606 .type = UE_CONTROL,
607 .endpoint = 0x00, /* Control pipe */
608 .direction = UE_DIR_ANY,
609 .bufsize = sizeof(struct usb_device_request),
610 .callback = &umass_t_cbi_reset3_callback,
611 .timeout = 5000, /* 5 seconds */
612 .interval = 50, /* 50 milliseconds */
613 },
614
616 .type = UE_CONTROL,
617 .endpoint = 0x00, /* Control pipe */
618 .direction = UE_DIR_ANY,
619 .bufsize = (sizeof(struct usb_device_request) +
621 .callback = &umass_t_cbi_command_callback,
622 .timeout = 5000, /* 5 seconds */
623 },
624
626 .type = UE_BULK,
627 .endpoint = UE_ADDR_ANY,
628 .direction = UE_DIR_IN,
629 .bufsize = UMASS_BULK_SIZE,
630 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer=1,},
632 .timeout = 0, /* overwritten later */
633 },
634
636 .type = UE_CONTROL,
637 .endpoint = 0x00, /* Control pipe */
638 .direction = UE_DIR_ANY,
639 .bufsize = sizeof(struct usb_device_request),
641 .timeout = 5000, /* 5 seconds */
642 },
643
645 .type = UE_BULK,
646 .endpoint = UE_ADDR_ANY,
647 .direction = UE_DIR_OUT,
648 .bufsize = UMASS_BULK_SIZE,
649 .flags = {.proxy_buffer = 1,.short_xfer_ok = 1,.ext_buffer=1,},
651 .timeout = 0, /* overwritten later */
652 },
653
655 .type = UE_CONTROL,
656 .endpoint = 0x00, /* Control pipe */
657 .direction = UE_DIR_ANY,
658 .bufsize = sizeof(struct usb_device_request),
660 .timeout = 5000, /* 5 seconds */
661 },
662
664 .type = UE_INTERRUPT,
665 .endpoint = UE_ADDR_ANY,
666 .direction = UE_DIR_IN,
667 .flags = {.short_xfer_ok = 1,.no_pipe_ok = 1,},
668 .bufsize = sizeof(umass_cbi_sbl_t),
669 .callback = &umass_t_cbi_status_callback,
670 .timeout = 5000, /* ms */
671 },
672
674 .type = UE_CONTROL,
675 .endpoint = 0x00, /* Control pipe */
676 .direction = UE_DIR_ANY,
677 .bufsize = sizeof(struct usb_device_request),
678 .callback = &umass_t_cbi_reset4_callback,
679 .timeout = 5000, /* ms */
680 },
681};
682
683/* If device cannot return valid inquiry data, fake it */
684static const uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH] = {
685 0, /* removable */ 0x80, SCSI_REV_2, SCSI_REV_2,
686 /* additional_length */ 31, 0, 0, 0
687};
688
689#define UFI_COMMAND_LENGTH 12 /* UFI commands are always 12 bytes */
690#define ATAPI_COMMAND_LENGTH 12 /* ATAPI commands are always 12 bytes */
691
692static devclass_t umass_devclass;
693
694static device_method_t umass_methods[] = {
695 /* Device interface */
696 DEVMETHOD(device_probe, umass_probe),
697 DEVMETHOD(device_attach, umass_attach),
698 DEVMETHOD(device_detach, umass_detach),
699
700 DEVMETHOD_END
701};
702
703static driver_t umass_driver = {
704 .name = "umass",
705 .methods = umass_methods,
706 .size = sizeof(struct umass_softc),
707};
708
709static const STRUCT_USB_HOST_ID __used umass_devs[] = {
710 /* generic mass storage class */
712};
713
715MODULE_DEPEND(umass, usb, 1, 1, 1);
716MODULE_DEPEND(umass, cam, 1, 1, 1);
719
720/*
721 * USB device probe/attach/detach
722 */
723
724static uint16_t
726{
728 uint16_t retval;
729
730 retval = 0;
731
732 /* Check for a standards compliant device */
734 if ((id == NULL) ||
735 (id->bInterfaceClass != UICLASS_MASS)) {
736 goto done;
737 }
738 switch (id->bInterfaceSubClass) {
739 case UISUBCLASS_SCSI:
740 retval |= UMASS_PROTO_SCSI;
741 break;
742 case UISUBCLASS_UFI:
743 retval |= UMASS_PROTO_UFI;
744 break;
745 case UISUBCLASS_RBC:
746 retval |= UMASS_PROTO_RBC;
747 break;
750 retval |= UMASS_PROTO_ATAPI;
751 break;
752 default:
753 goto done;
754 }
755
756 switch (id->bInterfaceProtocol) {
757 case UIPROTO_MASS_CBI:
758 retval |= UMASS_PROTO_CBI;
759 break;
761 retval |= UMASS_PROTO_CBI_I;
762 break;
764 case UIPROTO_MASS_BBB:
765 retval |= UMASS_PROTO_BBB;
766 break;
767 default:
768 goto done;
769 }
770done:
771 return (retval);
772}
773
774/*
775 * Match the device we are seeing with the devices supported.
776 */
777static struct umass_probe_proto
779{
780 struct umass_probe_proto ret;
781 uint32_t quirks = NO_QUIRKS;
782 uint32_t proto = umass_get_proto(uaa->iface);
783
784 memset(&ret, 0, sizeof(ret));
785 ret.error = BUS_PROBE_GENERIC;
786
787 /* Check if we should deny probing. */
788 if (usb_test_quirk(uaa, UQ_MSC_IGNORE)) {
789 ret.error = ENXIO;
790 goto done;
791 }
792
793 /* Search for protocol enforcement */
794
796 proto &= ~UMASS_PROTO_WIRE;
798 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI)) {
799 proto &= ~UMASS_PROTO_WIRE;
801 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_WIRE_CBI_I)) {
802 proto &= ~UMASS_PROTO_WIRE;
804 }
805
807 proto &= ~UMASS_PROTO_COMMAND;
809 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_ATAPI)) {
810 proto &= ~UMASS_PROTO_COMMAND;
812 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_UFI)) {
813 proto &= ~UMASS_PROTO_COMMAND;
815 } else if (usb_test_quirk(uaa, UQ_MSC_FORCE_PROTO_RBC)) {
816 proto &= ~UMASS_PROTO_COMMAND;
818 }
819
820 /* Check if the protocol is invalid */
821
822 if ((proto & UMASS_PROTO_COMMAND) == 0) {
823 ret.error = ENXIO;
824 goto done;
825 }
826
827 if ((proto & UMASS_PROTO_WIRE) == 0) {
828 ret.error = ENXIO;
829 goto done;
830 }
831
832 /* Search for quirks */
833
866
867done:
868 ret.quirks = quirks;
869 ret.proto = proto;
870 return (ret);
871}
872
873static int
874umass_probe(device_t dev)
875{
876 struct usb_attach_arg *uaa = device_get_ivars(dev);
877 struct umass_probe_proto temp;
878
879 if (uaa->usb_mode != USB_MODE_HOST) {
880 return (ENXIO);
881 }
882 temp = umass_probe_proto(dev, uaa);
883
884 return (temp.error);
885}
886
887static int
888umass_attach(device_t dev)
889{
890 struct umass_softc *sc = device_get_softc(dev);
891 struct usb_attach_arg *uaa = device_get_ivars(dev);
892 struct umass_probe_proto temp = umass_probe_proto(dev, uaa);
894 int err;
895
896 /*
897 * NOTE: the softc struct is cleared in device_set_driver.
898 * We can safely call umass_detach without specifically
899 * initializing the struct.
900 */
901
902 sc->sc_dev = dev;
903 sc->sc_udev = uaa->device;
904 sc->sc_proto = temp.proto;
905 sc->sc_quirks = temp.quirks;
906 sc->sc_unit = device_get_unit(dev);
907
908 snprintf(sc->sc_name, sizeof(sc->sc_name),
909 "%s", device_get_nameunit(dev));
910
912
913 mtx_init(&sc->sc_mtx, device_get_nameunit(dev),
914 NULL, MTX_DEF | MTX_RECURSE);
915
916 /* get interface index */
917
919 if (id == NULL) {
920 device_printf(dev, "failed to get "
921 "interface number\n");
922 goto detach;
923 }
924 sc->sc_iface_no = id->bInterfaceNumber;
925
926#ifdef USB_DEBUG
927 device_printf(dev, " ");
928
929 switch (sc->sc_proto & UMASS_PROTO_COMMAND) {
930 case UMASS_PROTO_SCSI:
931 printf("SCSI");
932 break;
934 printf("8070i (ATAPI)");
935 break;
936 case UMASS_PROTO_UFI:
937 printf("UFI");
938 break;
939 case UMASS_PROTO_RBC:
940 printf("RBC");
941 break;
942 default:
943 printf("(unknown 0x%02x)",
945 break;
946 }
947
948 printf(" over ");
949
950 switch (sc->sc_proto & UMASS_PROTO_WIRE) {
951 case UMASS_PROTO_BBB:
952 printf("Bulk-Only");
953 break;
954 case UMASS_PROTO_CBI: /* uses Comand/Bulk pipes */
955 printf("CBI");
956 break;
957 case UMASS_PROTO_CBI_I: /* uses Comand/Bulk/Interrupt pipes */
958 printf("CBI with CCI");
959 break;
960 default:
961 printf("(unknown 0x%02x)",
963 }
964
965 printf("; quirks = 0x%04x\n", sc->sc_quirks);
966#endif
967
968 if (sc->sc_quirks & ALT_IFACE_1) {
970 (uaa->device, uaa->info.bIfaceIndex, 1);
971
972 if (err) {
973 DPRINTF(sc, UDMASS_USB, "could not switch to "
974 "Alt Interface 1\n");
975 goto detach;
976 }
977 }
978 /* allocate all required USB transfers */
979
980 if (sc->sc_proto & UMASS_PROTO_BBB) {
981 err = usbd_transfer_setup(uaa->device,
983 UMASS_T_BBB_MAX, sc, &sc->sc_mtx);
984
985 /* skip reset first time */
987
988 } else if (sc->sc_proto & (UMASS_PROTO_CBI | UMASS_PROTO_CBI_I)) {
989 err = usbd_transfer_setup(uaa->device,
991 UMASS_T_CBI_MAX, sc, &sc->sc_mtx);
992
993 /* skip reset first time */
995
996 } else {
997 err = USB_ERR_INVAL;
998 }
999
1000 if (err) {
1001 device_printf(dev, "could not setup required "
1002 "transfers, %s\n", usbd_errstr(err));
1003 goto detach;
1004 }
1005#ifdef USB_DEBUG
1006 if (umass_throttle > 0) {
1007 uint8_t x;
1008 int iv;
1009
1010 iv = umass_throttle;
1011
1012 if (iv < 1)
1013 iv = 1;
1014 else if (iv > 8000)
1015 iv = 8000;
1016
1017 for (x = 0; x != UMASS_T_MAX; x++) {
1018 if (sc->sc_xfer[x] != NULL)
1019 usbd_xfer_set_interval(sc->sc_xfer[x], iv);
1020 }
1021 }
1022#endif
1023 sc->sc_transform =
1029
1030 /* from here onwards the device can be used. */
1031
1032 if (sc->sc_quirks & SHUTTLE_INIT) {
1034 }
1035 /* get the maximum LUN supported by the device */
1036
1037 if (((sc->sc_proto & UMASS_PROTO_WIRE) == UMASS_PROTO_BBB) &&
1038 !(sc->sc_quirks & NO_GETMAXLUN))
1040 else
1041 sc->sc_maxlun = 0;
1042
1043 /* Prepare the SCSI command block */
1044 sc->cam_scsi_sense.opcode = REQUEST_SENSE;
1045 sc->cam_scsi_test_unit_ready.opcode = TEST_UNIT_READY;
1046
1047 /* register the SIM */
1048 err = umass_cam_attach_sim(sc);
1049 if (err) {
1050 goto detach;
1051 }
1052 /* scan the SIM */
1053 umass_cam_attach(sc);
1054
1055 DPRINTF(sc, UDMASS_GEN, "Attach finished\n");
1056
1057 return (0); /* success */
1058
1059detach:
1061 return (ENXIO); /* failure */
1062}
1063
1064static int
1065umass_detach(device_t dev)
1066{
1067 struct umass_softc *sc = device_get_softc(dev);
1068
1069 DPRINTF(sc, UDMASS_USB, "\n");
1070
1071 /* teardown our statemachine */
1072
1074
1075 mtx_lock(&sc->sc_mtx);
1076
1077 /* cancel any leftover CCB's */
1078
1079 umass_cancel_ccb(sc);
1080
1082
1083 mtx_unlock(&sc->sc_mtx);
1084
1085 mtx_destroy(&sc->sc_mtx);
1086
1087 return (0); /* success */
1088}
1089
1090static void
1092{
1093 struct usb_device_request req;
1094 uint8_t status[2] = {0, 0};
1095
1096 /*
1097 * The Linux driver does this, but no one can tell us what the
1098 * command does.
1099 */
1100 req.bmRequestType = UT_READ_VENDOR_DEVICE;
1101 req.bRequest = 1; /* XXX unknown command */
1102 USETW(req.wValue, 0);
1103 req.wIndex[0] = sc->sc_iface_no;
1104 req.wIndex[1] = 0;
1105 USETW(req.wLength, sizeof(status));
1106 usbd_do_request(sc->sc_udev, NULL, &req, &status);
1107
1108 DPRINTF(sc, UDMASS_GEN, "Shuttle init returned 0x%02x%02x\n",
1109 status[0], status[1]);
1110}
1111
1112/*
1113 * Generic functions to handle transfers
1114 */
1115
1116static void
1117umass_transfer_start(struct umass_softc *sc, uint8_t xfer_index)
1118{
1119 DPRINTF(sc, UDMASS_GEN, "transfer index = "
1120 "%d\n", xfer_index);
1121
1122 if (sc->sc_xfer[xfer_index]) {
1123 sc->sc_last_xfer_index = xfer_index;
1124 usbd_transfer_start(sc->sc_xfer[xfer_index]);
1125 } else {
1126 umass_cancel_ccb(sc);
1127 }
1128}
1129
1130static void
1132{
1133 DPRINTF(sc, UDMASS_GEN, "resetting device\n");
1134
1135 /*
1136 * stop the last transfer, if not already stopped:
1137 */
1139 umass_transfer_start(sc, 0);
1140}
1141
1142static void
1144{
1145 union ccb *ccb;
1146
1147 USB_MTX_ASSERT(&sc->sc_mtx, MA_OWNED);
1148
1149 ccb = sc->sc_transfer.ccb;
1150 sc->sc_transfer.ccb = NULL;
1151 sc->sc_last_xfer_index = 0;
1152
1153 if (ccb) {
1154 (sc->sc_transfer.callback)
1155 (sc, ccb, (sc->sc_transfer.data_len -
1157 }
1158}
1159
1160static void
1162{
1163 struct umass_softc *sc = usbd_xfer_softc(xfer);
1164
1165 if (error != USB_ERR_CANCELLED) {
1166 DPRINTF(sc, UDMASS_GEN, "transfer error, %s -> "
1167 "reset\n", usbd_errstr(error));
1168 }
1169 umass_cancel_ccb(sc);
1170}
1171
1172/*
1173 * BBB protocol specific functions
1174 */
1175
1176static void
1178{
1179 struct umass_softc *sc = usbd_xfer_softc(xfer);
1180 struct usb_device_request req;
1181 struct usb_page_cache *pc;
1182
1183 switch (USB_GET_STATE(xfer)) {
1184 case USB_ST_TRANSFERRED:
1186 return;
1187
1188 case USB_ST_SETUP:
1189 /*
1190 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
1191 *
1192 * For Reset Recovery the host shall issue in the following order:
1193 * a) a Bulk-Only Mass Storage Reset
1194 * b) a Clear Feature HALT to the Bulk-In endpoint
1195 * c) a Clear Feature HALT to the Bulk-Out endpoint
1196 *
1197 * This is done in 3 steps, using 3 transfers:
1198 * UMASS_T_BBB_RESET1
1199 * UMASS_T_BBB_RESET2
1200 * UMASS_T_BBB_RESET3
1201 */
1202
1203 DPRINTF(sc, UDMASS_BBB, "BBB reset!\n");
1204
1205 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1206 req.bRequest = UR_BBB_RESET; /* bulk only reset */
1207 USETW(req.wValue, 0);
1208 req.wIndex[0] = sc->sc_iface_no;
1209 req.wIndex[1] = 0;
1210 USETW(req.wLength, 0);
1211
1212 pc = usbd_xfer_get_frame(xfer, 0);
1213 usbd_copy_in(pc, 0, &req, sizeof(req));
1214
1215 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1216 usbd_xfer_set_frames(xfer, 1);
1218 return;
1219
1220 default: /* Error */
1221 umass_tr_error(xfer, error);
1222 return;
1223 }
1224}
1225
1226static void
1228{
1231}
1232
1233static void
1235{
1238}
1239
1240static void
1242 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error)
1243{
1244 struct umass_softc *sc = usbd_xfer_softc(xfer);
1245
1246 switch (USB_GET_STATE(xfer)) {
1247 case USB_ST_TRANSFERRED:
1248tr_transferred:
1249 umass_transfer_start(sc, next_xfer);
1250 return;
1251
1252 case USB_ST_SETUP:
1253 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) {
1254 goto tr_transferred;
1255 }
1256 return;
1257
1258 default: /* Error */
1259 umass_tr_error(xfer, error);
1260 return;
1261 }
1262}
1263
1264static void
1266{
1267 struct umass_softc *sc = usbd_xfer_softc(xfer);
1268 union ccb *ccb = sc->sc_transfer.ccb;
1269 struct usb_page_cache *pc;
1270 uint32_t tag;
1271
1272 switch (USB_GET_STATE(xfer)) {
1273 case USB_ST_TRANSFERRED:
1275 (sc, ((sc->sc_transfer.dir == DIR_IN) ? UMASS_T_BBB_DATA_READ :
1278 return;
1279
1280 case USB_ST_SETUP:
1281
1282 sc->sc_status_try = 0;
1283
1284 if (ccb) {
1285 /*
1286 * the initial value is not important,
1287 * as long as the values are unique:
1288 */
1289 tag = UGETDW(sc->cbw.dCBWTag) + 1;
1290
1291 USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
1292 USETDW(sc->cbw.dCBWTag, tag);
1293
1294 /*
1295 * dCBWDataTransferLength:
1296 * This field indicates the number of bytes of data that the host
1297 * intends to transfer on the IN or OUT Bulk endpoint(as indicated by
1298 * the Direction bit) during the execution of this command. If this
1299 * field is set to 0, the device will expect that no data will be
1300 * transferred IN or OUT during this command, regardless of the value
1301 * of the Direction bit defined in dCBWFlags.
1302 */
1303 USETDW(sc->cbw.dCBWDataTransferLength, sc->sc_transfer.data_len);
1304
1305 /*
1306 * dCBWFlags:
1307 * The bits of the Flags field are defined as follows:
1308 * Bits 0-6 reserved
1309 * Bit 7 Direction - this bit shall be ignored if the
1310 * dCBWDataTransferLength field is zero.
1311 * 0 = data Out from host to device
1312 * 1 = data In from device to host
1313 */
1314 sc->cbw.bCBWFlags = ((sc->sc_transfer.dir == DIR_IN) ?
1316 sc->cbw.bCBWLUN = sc->sc_transfer.lun;
1317
1318 if (sc->sc_transfer.cmd_len > sizeof(sc->cbw.CBWCDB)) {
1319 sc->sc_transfer.cmd_len = sizeof(sc->cbw.CBWCDB);
1320 DPRINTF(sc, UDMASS_BBB, "Truncating long command!\n");
1321 }
1322 sc->cbw.bCDBLength = sc->sc_transfer.cmd_len;
1323
1324 /* copy SCSI command data */
1325 memcpy(sc->cbw.CBWCDB, sc->sc_transfer.cmd_data,
1326 sc->sc_transfer.cmd_len);
1327
1328 /* clear remaining command area */
1329 memset(sc->cbw.CBWCDB +
1330 sc->sc_transfer.cmd_len, 0,
1331 sizeof(sc->cbw.CBWCDB) -
1332 sc->sc_transfer.cmd_len);
1333
1334 DIF(UDMASS_BBB, umass_bbb_dump_cbw(sc, &sc->cbw));
1335
1336 pc = usbd_xfer_get_frame(xfer, 0);
1337 usbd_copy_in(pc, 0, &sc->cbw, sizeof(sc->cbw));
1338 usbd_xfer_set_frame_len(xfer, 0, sizeof(sc->cbw));
1339
1341 }
1342 return;
1343
1344 default: /* Error */
1345 umass_tr_error(xfer, error);
1346 return;
1347 }
1348}
1349
1350static void
1352{
1353 struct umass_softc *sc = usbd_xfer_softc(xfer);
1354 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1355 int actlen, sumlen;
1356
1357 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1358
1359 switch (USB_GET_STATE(xfer)) {
1360 case USB_ST_TRANSFERRED:
1363 sc->sc_transfer.actlen += actlen;
1364
1365 if (actlen < sumlen) {
1366 /* short transfer */
1367 sc->sc_transfer.data_rem = 0;
1368 }
1369 case USB_ST_SETUP:
1370 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n",
1371 max_bulk, sc->sc_transfer.data_rem);
1372
1373 if (sc->sc_transfer.data_rem == 0) {
1375 return;
1376 }
1377 if (max_bulk > sc->sc_transfer.data_rem) {
1378 max_bulk = sc->sc_transfer.data_rem;
1379 }
1381
1383 max_bulk);
1384
1386 return;
1387
1388 default: /* Error */
1389 if (error == USB_ERR_CANCELLED) {
1390 umass_tr_error(xfer, error);
1391 } else {
1393 }
1394 return;
1395 }
1396}
1397
1398static void
1400{
1403}
1404
1405static void
1407{
1408 struct umass_softc *sc = usbd_xfer_softc(xfer);
1409 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1410 int actlen, sumlen;
1411
1412 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1413
1414 switch (USB_GET_STATE(xfer)) {
1415 case USB_ST_TRANSFERRED:
1418 sc->sc_transfer.actlen += actlen;
1419
1420 if (actlen < sumlen) {
1421 /* short transfer */
1422 sc->sc_transfer.data_rem = 0;
1423 }
1424 case USB_ST_SETUP:
1425 DPRINTF(sc, UDMASS_BBB, "max_bulk=%d, data_rem=%d\n",
1426 max_bulk, sc->sc_transfer.data_rem);
1427
1428 if (sc->sc_transfer.data_rem == 0) {
1430 return;
1431 }
1432 if (max_bulk > sc->sc_transfer.data_rem) {
1433 max_bulk = sc->sc_transfer.data_rem;
1434 }
1436
1438 max_bulk);
1439
1441 return;
1442
1443 default: /* Error */
1444 if (error == USB_ERR_CANCELLED) {
1445 umass_tr_error(xfer, error);
1446 } else {
1448 }
1449 return;
1450 }
1451}
1452
1453static void
1455{
1458}
1459
1460static void
1462{
1463 struct umass_softc *sc = usbd_xfer_softc(xfer);
1464 union ccb *ccb = sc->sc_transfer.ccb;
1465 struct usb_page_cache *pc;
1466 uint32_t residue;
1467 int actlen;
1468
1469 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1470
1471 switch (USB_GET_STATE(xfer)) {
1472 case USB_ST_TRANSFERRED:
1473
1474 /*
1475 * Do a full reset if there is something wrong with the CSW:
1476 */
1477 sc->sc_status_try = 1;
1478
1479 /* Zero missing parts of the CSW: */
1480
1481 if (actlen < (int)sizeof(sc->csw))
1482 memset(&sc->csw, 0, sizeof(sc->csw));
1483
1484 pc = usbd_xfer_get_frame(xfer, 0);
1485 usbd_copy_out(pc, 0, &sc->csw, actlen);
1486
1487 DIF(UDMASS_BBB, umass_bbb_dump_csw(sc, &sc->csw));
1488
1489 residue = UGETDW(sc->csw.dCSWDataResidue);
1490
1491 if ((!residue) || (sc->sc_quirks & IGNORE_RESIDUE)) {
1492 residue = (sc->sc_transfer.data_len -
1493 sc->sc_transfer.actlen);
1494 }
1495 if (residue > sc->sc_transfer.data_len) {
1496 DPRINTF(sc, UDMASS_BBB, "truncating residue from %d "
1497 "to %d bytes\n", residue, sc->sc_transfer.data_len);
1498 residue = sc->sc_transfer.data_len;
1499 }
1500 /* translate weird command-status signatures: */
1501 if (sc->sc_quirks & WRONG_CSWSIG) {
1502 uint32_t temp = UGETDW(sc->csw.dCSWSignature);
1503
1504 if ((temp == CSWSIGNATURE_OLYMPUS_C1) ||
1506 USETDW(sc->csw.dCSWSignature, CSWSIGNATURE);
1507 }
1508 }
1509 /* check CSW and handle eventual error */
1510 if (UGETDW(sc->csw.dCSWSignature) != CSWSIGNATURE) {
1511 DPRINTF(sc, UDMASS_BBB, "bad CSW signature 0x%08x != 0x%08x\n",
1512 UGETDW(sc->csw.dCSWSignature), CSWSIGNATURE);
1513 /*
1514 * Invalid CSW: Wrong signature or wrong tag might
1515 * indicate that we lost synchronization. Reset the
1516 * device.
1517 */
1518 goto tr_error;
1519 } else if (UGETDW(sc->csw.dCSWTag) != UGETDW(sc->cbw.dCBWTag)) {
1520 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: tag 0x%08x should be "
1521 "0x%08x\n", UGETDW(sc->csw.dCSWTag),
1522 UGETDW(sc->cbw.dCBWTag));
1523 goto tr_error;
1524 } else if (sc->csw.bCSWStatus > CSWSTATUS_PHASE) {
1525 DPRINTF(sc, UDMASS_BBB, "Invalid CSW: status %d > %d\n",
1526 sc->csw.bCSWStatus, CSWSTATUS_PHASE);
1527 goto tr_error;
1528 } else if (sc->csw.bCSWStatus == CSWSTATUS_PHASE) {
1529 DPRINTF(sc, UDMASS_BBB, "Phase error, residue = "
1530 "%d\n", residue);
1531 goto tr_error;
1532 } else if (sc->sc_transfer.actlen > sc->sc_transfer.data_len) {
1533 DPRINTF(sc, UDMASS_BBB, "Buffer overrun %d > %d\n",
1535 goto tr_error;
1536 } else if (sc->csw.bCSWStatus == CSWSTATUS_FAILED) {
1537 DPRINTF(sc, UDMASS_BBB, "Command failed, residue = "
1538 "%d\n", residue);
1539
1540 sc->sc_transfer.ccb = NULL;
1541
1543
1544 (sc->sc_transfer.callback)
1545 (sc, ccb, residue, STATUS_CMD_FAILED);
1546 } else {
1547 sc->sc_transfer.ccb = NULL;
1548
1550
1551 (sc->sc_transfer.callback)
1552 (sc, ccb, residue, STATUS_CMD_OK);
1553 }
1554 return;
1555
1556 case USB_ST_SETUP:
1559 return;
1560
1561 default:
1562tr_error:
1563 DPRINTF(sc, UDMASS_BBB, "Failed to read CSW: %s, try %d\n",
1565
1566 if ((error == USB_ERR_CANCELLED) ||
1567 (sc->sc_status_try)) {
1568 umass_tr_error(xfer, error);
1569 } else {
1570 sc->sc_status_try = 1;
1572 }
1573 return;
1574 }
1575}
1576
1577static void
1578umass_command_start(struct umass_softc *sc, uint8_t dir,
1579 void *data_ptr, uint32_t data_len,
1580 uint32_t data_timeout, umass_callback_t *callback,
1581 union ccb *ccb)
1582{
1583 sc->sc_transfer.lun = ccb->ccb_h.target_lun;
1584
1585 /*
1586 * NOTE: assumes that "sc->sc_transfer.cmd_data" and
1587 * "sc->sc_transfer.cmd_len" has been properly
1588 * initialized.
1589 */
1590
1591 sc->sc_transfer.dir = data_len ? dir : DIR_NONE;
1592 sc->sc_transfer.data_ptr = data_ptr;
1593 sc->sc_transfer.data_len = data_len;
1594 sc->sc_transfer.data_rem = data_len;
1595 sc->sc_transfer.data_timeout = (data_timeout + UMASS_TIMEOUT);
1596
1597 sc->sc_transfer.actlen = 0;
1598 sc->sc_transfer.callback = callback;
1599 sc->sc_transfer.ccb = ccb;
1600
1601 if (sc->sc_xfer[sc->sc_last_xfer_index]) {
1603 } else {
1604 umass_cancel_ccb(sc);
1605 }
1606}
1607
1608static uint8_t
1610{
1611 struct usb_device_request req;
1612 usb_error_t err;
1613 uint8_t buf = 0;
1614
1615 /* The Get Max Lun command is a class-specific request. */
1616 req.bmRequestType = UT_READ_CLASS_INTERFACE;
1617 req.bRequest = UR_BBB_GET_MAX_LUN;
1618 USETW(req.wValue, 0);
1619 req.wIndex[0] = sc->sc_iface_no;
1620 req.wIndex[1] = 0;
1621 USETW(req.wLength, 1);
1622
1623 err = usbd_do_request(sc->sc_udev, NULL, &req, &buf);
1624 if (err) {
1625 buf = 0;
1626
1627 /* Device doesn't support Get Max Lun request. */
1628 printf("%s: Get Max Lun not supported (%s)\n",
1629 sc->sc_name, usbd_errstr(err));
1630 }
1631 return (buf);
1632}
1633
1634/*
1635 * Command/Bulk/Interrupt (CBI) specific functions
1636 */
1637
1638static void
1640{
1641 if (sc->sc_xfer[UMASS_T_CBI_STATUS]) {
1643 } else {
1644 union ccb *ccb = sc->sc_transfer.ccb;
1645
1646 sc->sc_transfer.ccb = NULL;
1647
1649
1650 (sc->sc_transfer.callback)
1651 (sc, ccb, (sc->sc_transfer.data_len -
1653 }
1654}
1655
1656static void
1658{
1659 struct umass_softc *sc = usbd_xfer_softc(xfer);
1660 struct usb_device_request req;
1661 struct usb_page_cache *pc;
1662 uint8_t buf[UMASS_CBI_DIAGNOSTIC_CMDLEN];
1663
1664 uint8_t i;
1665
1666 switch (USB_GET_STATE(xfer)) {
1667 case USB_ST_TRANSFERRED:
1669 break;
1670
1671 case USB_ST_SETUP:
1672 /*
1673 * Command Block Reset Protocol
1674 *
1675 * First send a reset request to the device. Then clear
1676 * any possibly stalled bulk endpoints.
1677 *
1678 * This is done in 3 steps, using 3 transfers:
1679 * UMASS_T_CBI_RESET1
1680 * UMASS_T_CBI_RESET2
1681 * UMASS_T_CBI_RESET3
1682 * UMASS_T_CBI_RESET4 (only if there is an interrupt endpoint)
1683 */
1684
1685 DPRINTF(sc, UDMASS_CBI, "CBI reset!\n");
1686
1687 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1688 req.bRequest = UR_CBI_ADSC;
1689 USETW(req.wValue, 0);
1690 req.wIndex[0] = sc->sc_iface_no;
1691 req.wIndex[1] = 0;
1693
1694 /*
1695 * The 0x1d code is the SEND DIAGNOSTIC command. To
1696 * distinguish between the two, the last 10 bytes of the CBL
1697 * is filled with 0xff (section 2.2 of the CBI
1698 * specification)
1699 */
1700 buf[0] = 0x1d; /* Command Block Reset */
1701 buf[1] = 0x04;
1702
1703 for (i = 2; i < UMASS_CBI_DIAGNOSTIC_CMDLEN; i++) {
1704 buf[i] = 0xff;
1705 }
1706
1707 pc = usbd_xfer_get_frame(xfer, 0);
1708 usbd_copy_in(pc, 0, &req, sizeof(req));
1709 pc = usbd_xfer_get_frame(xfer, 1);
1710 usbd_copy_in(pc, 0, buf, sizeof(buf));
1711
1712 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1713 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf));
1714 usbd_xfer_set_frames(xfer, 2);
1716 break;
1717
1718 default: /* Error */
1719 if (error == USB_ERR_CANCELLED)
1720 umass_tr_error(xfer, error);
1721 else
1723 break;
1724 }
1725}
1726
1727static void
1729{
1732}
1733
1734static void
1736{
1737 struct umass_softc *sc = usbd_xfer_softc(xfer);
1738
1740 (xfer, (sc->sc_xfer[UMASS_T_CBI_RESET4] &&
1744}
1745
1746static void
1748{
1751}
1752
1753static void
1755 uint8_t next_xfer, uint8_t stall_xfer, usb_error_t error)
1756{
1757 struct umass_softc *sc = usbd_xfer_softc(xfer);
1758
1759 switch (USB_GET_STATE(xfer)) {
1760 case USB_ST_TRANSFERRED:
1761tr_transferred:
1762 if (next_xfer == UMASS_T_CBI_STATUS) {
1764 } else {
1765 umass_transfer_start(sc, next_xfer);
1766 }
1767 break;
1768
1769 case USB_ST_SETUP:
1770 if (usbd_clear_stall_callback(xfer, sc->sc_xfer[stall_xfer])) {
1771 goto tr_transferred; /* should not happen */
1772 }
1773 break;
1774
1775 default: /* Error */
1776 umass_tr_error(xfer, error);
1777 break;
1778 }
1779}
1780
1781static void
1783{
1784 struct umass_softc *sc = usbd_xfer_softc(xfer);
1785 union ccb *ccb = sc->sc_transfer.ccb;
1786 struct usb_device_request req;
1787 struct usb_page_cache *pc;
1788
1789 switch (USB_GET_STATE(xfer)) {
1790 case USB_ST_TRANSFERRED:
1791
1792 if (sc->sc_transfer.dir == DIR_NONE) {
1794 } else {
1796 (sc, (sc->sc_transfer.dir == DIR_IN) ?
1798 }
1799 break;
1800
1801 case USB_ST_SETUP:
1802
1803 if (ccb) {
1804 /*
1805 * do a CBI transfer with cmd_len bytes from
1806 * cmd_data, possibly a data phase of data_len
1807 * bytes from/to the device and finally a status
1808 * read phase.
1809 */
1810
1811 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
1812 req.bRequest = UR_CBI_ADSC;
1813 USETW(req.wValue, 0);
1814 req.wIndex[0] = sc->sc_iface_no;
1815 req.wIndex[1] = 0;
1816 req.wLength[0] = sc->sc_transfer.cmd_len;
1817 req.wLength[1] = 0;
1818
1819 pc = usbd_xfer_get_frame(xfer, 0);
1820 usbd_copy_in(pc, 0, &req, sizeof(req));
1821 pc = usbd_xfer_get_frame(xfer, 1);
1823 sc->sc_transfer.cmd_len);
1824
1825 usbd_xfer_set_frame_len(xfer, 0, sizeof(req));
1828 sc->sc_transfer.cmd_len ? 2 : 1);
1829
1830 DIF(UDMASS_CBI,
1831 umass_cbi_dump_cmd(sc,
1833 sc->sc_transfer.cmd_len));
1834
1836 }
1837 break;
1838
1839 default: /* Error */
1840 /*
1841 * STALL on the control pipe can be result of the command error.
1842 * Attempt to clear this STALL same as for bulk pipe also
1843 * results in command completion interrupt, but ASC/ASCQ there
1844 * look like not always valid, so don't bother about it.
1845 */
1846 if ((error == USB_ERR_STALLED) ||
1847 (sc->sc_transfer.callback == &umass_cam_cb)) {
1848 sc->sc_transfer.ccb = NULL;
1849 (sc->sc_transfer.callback)
1850 (sc, ccb, sc->sc_transfer.data_len,
1852 } else {
1853 umass_tr_error(xfer, error);
1854 /* skip reset */
1856 }
1857 break;
1858 }
1859}
1860
1861static void
1863{
1864 struct umass_softc *sc = usbd_xfer_softc(xfer);
1865 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1866 int actlen, sumlen;
1867
1868 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1869
1870 switch (USB_GET_STATE(xfer)) {
1871 case USB_ST_TRANSFERRED:
1874 sc->sc_transfer.actlen += actlen;
1875
1876 if (actlen < sumlen) {
1877 /* short transfer */
1878 sc->sc_transfer.data_rem = 0;
1879 }
1880 case USB_ST_SETUP:
1881 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n",
1882 max_bulk, sc->sc_transfer.data_rem);
1883
1884 if (sc->sc_transfer.data_rem == 0) {
1886 break;
1887 }
1888 if (max_bulk > sc->sc_transfer.data_rem) {
1889 max_bulk = sc->sc_transfer.data_rem;
1890 }
1892
1894 max_bulk);
1895
1897 break;
1898
1899 default: /* Error */
1900 if ((error == USB_ERR_CANCELLED) ||
1901 (sc->sc_transfer.callback != &umass_cam_cb)) {
1902 umass_tr_error(xfer, error);
1903 } else {
1905 }
1906 break;
1907 }
1908}
1909
1910static void
1912{
1915}
1916
1917static void
1919{
1920 struct umass_softc *sc = usbd_xfer_softc(xfer);
1921 uint32_t max_bulk = usbd_xfer_max_len(xfer);
1922 int actlen, sumlen;
1923
1924 usbd_xfer_status(xfer, &actlen, &sumlen, NULL, NULL);
1925
1926 switch (USB_GET_STATE(xfer)) {
1927 case USB_ST_TRANSFERRED:
1930 sc->sc_transfer.actlen += actlen;
1931
1932 if (actlen < sumlen) {
1933 /* short transfer */
1934 sc->sc_transfer.data_rem = 0;
1935 }
1936 case USB_ST_SETUP:
1937 DPRINTF(sc, UDMASS_CBI, "max_bulk=%d, data_rem=%d\n",
1938 max_bulk, sc->sc_transfer.data_rem);
1939
1940 if (sc->sc_transfer.data_rem == 0) {
1942 break;
1943 }
1944 if (max_bulk > sc->sc_transfer.data_rem) {
1945 max_bulk = sc->sc_transfer.data_rem;
1946 }
1948
1950 max_bulk);
1951
1953 break;
1954
1955 default: /* Error */
1956 if ((error == USB_ERR_CANCELLED) ||
1957 (sc->sc_transfer.callback != &umass_cam_cb)) {
1958 umass_tr_error(xfer, error);
1959 } else {
1961 }
1962 break;
1963 }
1964}
1965
1966static void
1968{
1971}
1972
1973static void
1975{
1976 struct umass_softc *sc = usbd_xfer_softc(xfer);
1977 union ccb *ccb = sc->sc_transfer.ccb;
1978 struct usb_page_cache *pc;
1979 uint32_t residue;
1980 uint8_t status;
1981 int actlen;
1982
1983 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
1984
1985 switch (USB_GET_STATE(xfer)) {
1986 case USB_ST_TRANSFERRED:
1987
1988 if (actlen < (int)sizeof(sc->sbl)) {
1989 goto tr_setup;
1990 }
1991 pc = usbd_xfer_get_frame(xfer, 0);
1992 usbd_copy_out(pc, 0, &sc->sbl, sizeof(sc->sbl));
1993
1994 residue = (sc->sc_transfer.data_len -
1995 sc->sc_transfer.actlen);
1996
1997 /* dissect the information in the buffer */
1998
1999 if (sc->sc_proto & UMASS_PROTO_UFI) {
2000 /*
2001 * Section 3.4.3.1.3 specifies that the UFI command
2002 * protocol returns an ASC and ASCQ in the interrupt
2003 * data block.
2004 */
2005
2006 DPRINTF(sc, UDMASS_CBI, "UFI CCI, ASC = 0x%02x, "
2007 "ASCQ = 0x%02x\n", sc->sbl.ufi.asc,
2008 sc->sbl.ufi.ascq);
2009
2010 status = (((sc->sbl.ufi.asc == 0) &&
2011 (sc->sbl.ufi.ascq == 0)) ?
2013
2014 sc->sc_transfer.ccb = NULL;
2015
2017
2018 (sc->sc_transfer.callback)
2019 (sc, ccb, residue, status);
2020
2021 break;
2022
2023 } else {
2024 /* Command Interrupt Data Block */
2025
2026 DPRINTF(sc, UDMASS_CBI, "type=0x%02x, value=0x%02x\n",
2027 sc->sbl.common.type, sc->sbl.common.value);
2028
2029 if (sc->sbl.common.type == IDB_TYPE_CCI) {
2030 status = (sc->sbl.common.value & IDB_VALUE_STATUS_MASK);
2031
2036
2037 sc->sc_transfer.ccb = NULL;
2038
2040
2041 (sc->sc_transfer.callback)
2042 (sc, ccb, residue, status);
2043
2044 break;
2045 }
2046 }
2047
2048 /* fallthrough */
2049
2050 case USB_ST_SETUP:
2051tr_setup:
2054 break;
2055
2056 default: /* Error */
2057 DPRINTF(sc, UDMASS_CBI, "Failed to read CSW: %s\n",
2059 umass_tr_error(xfer, error);
2060 break;
2061 }
2062}
2063
2064/*
2065 * CAM specific functions (used by SCSI, UFI, 8070i (ATAPI))
2066 */
2067
2068static int
2070{
2071 struct cam_devq *devq; /* Per device Queue */
2072 cam_status status;
2073
2074 /*
2075 * A HBA is attached to the CAM layer.
2076 *
2077 * The CAM layer will then after a while start probing for devices on
2078 * the bus. The number of SIMs is limited to one.
2079 */
2080
2081 devq = cam_simq_alloc(1 /* maximum openings */ );
2082 if (devq == NULL) {
2083 return (ENOMEM);
2084 }
2085 sc->sc_sim = cam_sim_alloc
2088 sc /* priv */ ,
2089 sc->sc_unit /* unit number */ ,
2090 &sc->sc_mtx /* mutex */ ,
2091 1 /* maximum device openings */ ,
2092 0 /* maximum tagged device openings */ ,
2093 devq);
2094
2095 if (sc->sc_sim == NULL) {
2096 cam_simq_free(devq);
2097 return (ENOMEM);
2098 }
2099
2100 mtx_lock(&sc->sc_mtx);
2101 status = xpt_bus_register(sc->sc_sim, sc->sc_dev, sc->sc_unit);
2102 if (status != CAM_SUCCESS) {
2103 cam_sim_free(sc->sc_sim, /* free_devq */ TRUE);
2104 mtx_unlock(&sc->sc_mtx);
2105 printf("%s: xpt_bus_register failed with status %#x\n",
2106 __func__, status);
2107 return (ENOMEM);
2108 }
2109 mtx_unlock(&sc->sc_mtx);
2110
2111 return (0);
2112}
2113
2114static void
2116{
2117#ifndef USB_DEBUG
2118 if (bootverbose)
2119#endif
2120 printf("%s:%d:%d: Attached to scbus%d\n",
2121 sc->sc_name, cam_sim_path(sc->sc_sim),
2122 sc->sc_unit, cam_sim_path(sc->sc_sim));
2123}
2124
2125/* umass_cam_detach
2126 * detach from the CAM layer
2127 */
2128
2129static void
2131{
2132 int error;
2133
2134 if (sc->sc_sim != NULL) {
2135 error = xpt_bus_deregister(cam_sim_path(sc->sc_sim));
2136 if (error == 0) {
2137 /* accessing the softc is not possible after this */
2138 sc->sc_sim->softc = NULL;
2139 DPRINTF(sc, UDMASS_SCSI, "%s: %s:%d:%d caling "
2140 "cam_sim_free sim %p refc %u mtx %p\n",
2141 __func__, sc->sc_name, cam_sim_path(sc->sc_sim),
2142 sc->sc_unit, sc->sc_sim,
2143 sc->sc_sim->refcount, sc->sc_sim->mtx);
2144 cam_sim_free(sc->sc_sim, /* free_devq */ TRUE);
2145 } else {
2146 panic("%s: %s: CAM layer is busy: errno %d\n",
2147 __func__, sc->sc_name, error);
2148 }
2149 sc->sc_sim = NULL;
2150 }
2151}
2152
2153/* umass_cam_action
2154 * CAM requests for action come through here
2155 */
2156
2157static void
2158umass_cam_action(struct cam_sim *sim, union ccb *ccb)
2159{
2160 struct umass_softc *sc = cam_sim_softc(sim);
2161
2162 if (sc == NULL) {
2163 ccb->ccb_h.status = CAM_SEL_TIMEOUT;
2164 xpt_done(ccb);
2165 return;
2166 }
2167
2168 /* Perform the requested action */
2169 switch (ccb->ccb_h.func_code) {
2170 case XPT_SCSI_IO:
2171 {
2172 uint8_t *cmd;
2173 uint8_t dir;
2174
2175 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) {
2176 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr);
2177 } else {
2178 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes);
2179 }
2180
2181 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_SCSI_IO: "
2182 "cmd: 0x%02x, flags: 0x%02x, "
2183 "%db cmd/%db data/%db sense\n",
2184 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2185 (uintmax_t)ccb->ccb_h.target_lun, cmd[0],
2186 ccb->ccb_h.flags & CAM_DIR_MASK, ccb->csio.cdb_len,
2187 ccb->csio.dxfer_len, ccb->csio.sense_len);
2188
2189 if (sc->sc_transfer.ccb) {
2190 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_SCSI_IO: "
2191 "I/O in progress, deferring\n",
2192 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2193 (uintmax_t)ccb->ccb_h.target_lun);
2194 ccb->ccb_h.status = CAM_SCSI_BUSY;
2195 xpt_done(ccb);
2196 goto done;
2197 }
2198 switch (ccb->ccb_h.flags & CAM_DIR_MASK) {
2199 case CAM_DIR_IN:
2200 dir = DIR_IN;
2201 break;
2202 case CAM_DIR_OUT:
2203 dir = DIR_OUT;
2204 DIF(UDMASS_SCSI,
2205 umass_dump_buffer(sc, ccb->csio.data_ptr,
2206 ccb->csio.dxfer_len, 48));
2207 break;
2208 default:
2209 dir = DIR_NONE;
2210 }
2211
2212 ccb->ccb_h.status = CAM_REQ_INPROG | CAM_SIM_QUEUED;
2213
2214 /*
2215 * sc->sc_transform will convert the command to the
2216 * command format needed by the specific command set
2217 * and return the converted command in
2218 * "sc->sc_transfer.cmd_data"
2219 */
2220 if (umass_std_transform(sc, ccb, cmd, ccb->csio.cdb_len)) {
2221 if (sc->sc_transfer.cmd_data[0] == INQUIRY) {
2222 const char *pserial;
2223
2224 pserial = usb_get_serial(sc->sc_udev);
2225
2226 /*
2227 * Umass devices don't generally report their serial numbers
2228 * in the usual SCSI way. Emulate it here.
2229 */
2230 if ((sc->sc_transfer.cmd_data[1] & SI_EVPD) &&
2231 (sc->sc_transfer.cmd_data[2] == SVPD_UNIT_SERIAL_NUMBER) &&
2232 (pserial[0] != '\0')) {
2233 struct scsi_vpd_unit_serial_number *vpd_serial;
2234
2235 vpd_serial = (struct scsi_vpd_unit_serial_number *)ccb->csio.data_ptr;
2236 vpd_serial->length = strlen(pserial);
2237 if (vpd_serial->length > sizeof(vpd_serial->serial_num))
2238 vpd_serial->length = sizeof(vpd_serial->serial_num);
2239 memcpy(vpd_serial->serial_num, pserial, vpd_serial->length);
2240 ccb->csio.scsi_status = SCSI_STATUS_OK;
2241 ccb->ccb_h.status = CAM_REQ_CMP;
2242 xpt_done(ccb);
2243 goto done;
2244 }
2245
2246 /*
2247 * Handle EVPD inquiry for broken devices first
2248 * NO_INQUIRY also implies NO_INQUIRY_EVPD
2249 */
2250 if ((sc->sc_quirks & (NO_INQUIRY_EVPD | NO_INQUIRY)) &&
2251 (sc->sc_transfer.cmd_data[1] & SI_EVPD)) {
2252 scsi_set_sense_data(&ccb->csio.sense_data,
2253 /*sense_format*/ SSD_TYPE_NONE,
2254 /*current_error*/ 1,
2255 /*sense_key*/ SSD_KEY_ILLEGAL_REQUEST,
2256 /*asc*/ 0x24,
2257 /*ascq*/ 0x00,
2258 /*extra args*/ SSD_ELEM_NONE);
2259 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2260 ccb->ccb_h.status =
2261 CAM_SCSI_STATUS_ERROR |
2262 CAM_AUTOSNS_VALID |
2263 CAM_DEV_QFRZN;
2264 xpt_freeze_devq(ccb->ccb_h.path, 1);
2265 xpt_done(ccb);
2266 goto done;
2267 }
2268 /*
2269 * Return fake inquiry data for
2270 * broken devices
2271 */
2272 if (sc->sc_quirks & NO_INQUIRY) {
2273 memcpy(ccb->csio.data_ptr, &fake_inq_data,
2274 sizeof(fake_inq_data));
2275 ccb->csio.scsi_status = SCSI_STATUS_OK;
2276 ccb->ccb_h.status = CAM_REQ_CMP;
2277 xpt_done(ccb);
2278 goto done;
2279 }
2280 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2281 ccb->csio.dxfer_len = SHORT_INQUIRY_LENGTH;
2282 }
2283 } else if (sc->sc_transfer.cmd_data[0] == PREVENT_ALLOW) {
2284 if (sc->sc_quirks & NO_PREVENT_ALLOW) {
2285 ccb->csio.scsi_status = SCSI_STATUS_OK;
2286 ccb->ccb_h.status = CAM_REQ_CMP;
2287 xpt_done(ccb);
2288 goto done;
2289 }
2290 } else if (sc->sc_transfer.cmd_data[0] == SYNCHRONIZE_CACHE) {
2291 if (sc->sc_quirks & NO_SYNCHRONIZE_CACHE) {
2292 ccb->csio.scsi_status = SCSI_STATUS_OK;
2293 ccb->ccb_h.status = CAM_REQ_CMP;
2294 xpt_done(ccb);
2295 goto done;
2296 }
2297 } else if (sc->sc_transfer.cmd_data[0] == START_STOP_UNIT) {
2298 if (sc->sc_quirks & NO_START_STOP) {
2299 ccb->csio.scsi_status = SCSI_STATUS_OK;
2300 ccb->ccb_h.status = CAM_REQ_CMP;
2301 xpt_done(ccb);
2302 goto done;
2303 }
2304 }
2305 umass_command_start(sc, dir, ccb->csio.data_ptr,
2306 ccb->csio.dxfer_len,
2307 ccb->ccb_h.timeout,
2308 &umass_cam_cb, ccb);
2309 }
2310 break;
2311 }
2312 case XPT_PATH_INQ:
2313 {
2314 struct ccb_pathinq *cpi = &ccb->cpi;
2315
2316 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_PATH_INQ:.\n",
2317 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2318 (uintmax_t)ccb->ccb_h.target_lun);
2319
2320 /* host specific information */
2321 cpi->version_num = 1;
2322 cpi->hba_inquiry = 0;
2323 cpi->target_sprt = 0;
2324 cpi->hba_misc = PIM_NO_6_BYTE;
2325 cpi->hba_eng_cnt = 0;
2326 cpi->max_target = UMASS_SCSIID_MAX; /* one target */
2327 cpi->initiator_id = UMASS_SCSIID_HOST;
2328 strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2329 strlcpy(cpi->hba_vid, "USB SCSI", HBA_IDLEN);
2330 strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2331 cpi->unit_number = cam_sim_unit(sim);
2332 cpi->bus_id = sc->sc_unit;
2333 cpi->protocol = PROTO_SCSI;
2334 cpi->protocol_version = SCSI_REV_2;
2335 cpi->transport = XPORT_USB;
2336 cpi->transport_version = 0;
2337
2338 if (sc == NULL) {
2339 cpi->base_transfer_speed = 0;
2340 cpi->max_lun = 0;
2341 } else {
2342 if (sc->sc_quirks & FLOPPY_SPEED) {
2343 cpi->base_transfer_speed =
2345 } else {
2346 switch (usbd_get_speed(sc->sc_udev)) {
2347 case USB_SPEED_SUPER:
2348 cpi->base_transfer_speed =
2350 cpi->maxio = maxphys;
2351 break;
2352 case USB_SPEED_HIGH:
2353 cpi->base_transfer_speed =
2355 break;
2356 default:
2357 cpi->base_transfer_speed =
2359 break;
2360 }
2361 }
2362 cpi->max_lun = sc->sc_maxlun;
2363 }
2364
2365 cpi->ccb_h.status = CAM_REQ_CMP;
2366 xpt_done(ccb);
2367 break;
2368 }
2369 case XPT_RESET_DEV:
2370 {
2371 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_RESET_DEV:.\n",
2372 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2373 (uintmax_t)ccb->ccb_h.target_lun);
2374
2375 umass_reset(sc);
2376
2377 ccb->ccb_h.status = CAM_REQ_CMP;
2378 xpt_done(ccb);
2379 break;
2380 }
2381 case XPT_GET_TRAN_SETTINGS:
2382 {
2383 struct ccb_trans_settings *cts = &ccb->cts;
2384
2385 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_GET_TRAN_SETTINGS:.\n",
2386 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2387 (uintmax_t)ccb->ccb_h.target_lun);
2388
2389 cts->protocol = PROTO_SCSI;
2390 cts->protocol_version = SCSI_REV_2;
2391 cts->transport = XPORT_USB;
2392 cts->transport_version = 0;
2393 cts->xport_specific.valid = 0;
2394
2395 ccb->ccb_h.status = CAM_REQ_CMP;
2396 xpt_done(ccb);
2397 break;
2398 }
2399 case XPT_SET_TRAN_SETTINGS:
2400 {
2401 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_SET_TRAN_SETTINGS:.\n",
2402 cam_sim_path(sc->sc_sim), ccb->ccb_h.target_id,
2403 (uintmax_t)ccb->ccb_h.target_lun);
2404
2405 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2406 xpt_done(ccb);
2407 break;
2408 }
2409 case XPT_CALC_GEOMETRY:
2410 {
2411 cam_calc_geometry(&ccb->ccg, /* extended */ 1);
2412 xpt_done(ccb);
2413 break;
2414 }
2415 case XPT_NOOP:
2416 {
2417 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:XPT_NOOP:.\n",
2418 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2419 (uintmax_t)ccb->ccb_h.target_lun);
2420
2421 ccb->ccb_h.status = CAM_REQ_CMP;
2422 xpt_done(ccb);
2423 break;
2424 }
2425 default:
2426 DPRINTF(sc, UDMASS_SCSI, "%d:%d:%jx:func_code 0x%04x: "
2427 "Not implemented\n",
2428 sc ? cam_sim_path(sc->sc_sim) : -1, ccb->ccb_h.target_id,
2429 (uintmax_t)ccb->ccb_h.target_lun, ccb->ccb_h.func_code);
2430
2431 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
2432 xpt_done(ccb);
2433 break;
2434 }
2435
2436done:
2437 return;
2438}
2439
2440static void
2441umass_cam_poll(struct cam_sim *sim)
2442{
2443 struct umass_softc *sc = cam_sim_softc(sim);
2444
2445 if (sc == NULL)
2446 return;
2447
2448 DPRINTF(sc, UDMASS_SCSI, "CAM poll\n");
2449
2451}
2452
2453/* umass_cam_cb
2454 * finalise a completed CAM command
2455 */
2456
2457static void
2458umass_cam_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2459 uint8_t status)
2460{
2461 ccb->csio.resid = residue;
2462
2463 switch (status) {
2464 case STATUS_CMD_OK:
2465 ccb->ccb_h.status = CAM_REQ_CMP;
2466 if ((sc->sc_quirks & READ_CAPACITY_OFFBY1) &&
2467 (ccb->ccb_h.func_code == XPT_SCSI_IO) &&
2468 (ccb->csio.cdb_io.cdb_bytes[0] == READ_CAPACITY)) {
2469 struct scsi_read_capacity_data *rcap;
2470 uint32_t maxsector;
2471
2472 rcap = (void *)(ccb->csio.data_ptr);
2473 maxsector = scsi_4btoul(rcap->addr) - 1;
2474 scsi_ulto4b(maxsector, rcap->addr);
2475 }
2476 /*
2477 * We have to add SVPD_UNIT_SERIAL_NUMBER to the list
2478 * of pages supported by the device - otherwise, CAM
2479 * will never ask us for the serial number if the
2480 * device cannot handle that by itself.
2481 */
2482 if (ccb->ccb_h.func_code == XPT_SCSI_IO &&
2483 sc->sc_transfer.cmd_data[0] == INQUIRY &&
2484 (sc->sc_transfer.cmd_data[1] & SI_EVPD) &&
2485 sc->sc_transfer.cmd_data[2] == SVPD_SUPPORTED_PAGE_LIST &&
2486 (usb_get_serial(sc->sc_udev)[0] != '\0')) {
2487 struct ccb_scsiio *csio;
2488 struct scsi_vpd_supported_page_list *page_list;
2489
2490 csio = &ccb->csio;
2491 page_list = (struct scsi_vpd_supported_page_list *)csio->data_ptr;
2492 if (page_list->length + 1 < SVPD_SUPPORTED_PAGES_SIZE) {
2493 page_list->list[page_list->length] = SVPD_UNIT_SERIAL_NUMBER;
2494 page_list->length++;
2495 }
2496 }
2497 xpt_done(ccb);
2498 break;
2499
2500 case STATUS_CMD_UNKNOWN:
2501 case STATUS_CMD_FAILED:
2502
2503 /* fetch sense data */
2504
2505 /* the rest of the command was filled in at attach */
2506 sc->cam_scsi_sense.length = ccb->csio.sense_len;
2507
2508 DPRINTF(sc, UDMASS_SCSI, "Fetching %d bytes of "
2509 "sense data\n", ccb->csio.sense_len);
2510
2511 if (umass_std_transform(sc, ccb, &sc->cam_scsi_sense.opcode,
2512 sizeof(sc->cam_scsi_sense))) {
2513 if ((sc->sc_quirks & FORCE_SHORT_INQUIRY) &&
2514 (sc->sc_transfer.cmd_data[0] == INQUIRY)) {
2515 ccb->csio.sense_len = SHORT_INQUIRY_LENGTH;
2516 }
2517 umass_command_start(sc, DIR_IN, &ccb->csio.sense_data.error_code,
2518 ccb->csio.sense_len, ccb->ccb_h.timeout,
2519 &umass_cam_sense_cb, ccb);
2520 }
2521 break;
2522
2523 default:
2524 /*
2525 * The wire protocol failed and will hopefully have
2526 * recovered. We return an error to CAM and let CAM
2527 * retry the command if necessary.
2528 */
2529 xpt_freeze_devq(ccb->ccb_h.path, 1);
2530 ccb->ccb_h.status = CAM_REQ_CMP_ERR | CAM_DEV_QFRZN;
2531 xpt_done(ccb);
2532 break;
2533 }
2534}
2535
2536/*
2537 * Finalise a completed autosense operation
2538 */
2539static void
2540umass_cam_sense_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2541 uint8_t status)
2542{
2543 uint8_t *cmd;
2544
2545 switch (status) {
2546 case STATUS_CMD_OK:
2547 case STATUS_CMD_UNKNOWN:
2548 case STATUS_CMD_FAILED: {
2549 int key, sense_len;
2550
2551 ccb->csio.sense_resid = residue;
2552 sense_len = ccb->csio.sense_len - ccb->csio.sense_resid;
2553 key = scsi_get_sense_key(&ccb->csio.sense_data, sense_len,
2554 /*show_errors*/ 1);
2555
2556 if (ccb->csio.ccb_h.flags & CAM_CDB_POINTER) {
2557 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_ptr);
2558 } else {
2559 cmd = (uint8_t *)(ccb->csio.cdb_io.cdb_bytes);
2560 }
2561
2562 /*
2563 * Getting sense data always succeeds (apart from wire
2564 * failures):
2565 */
2566 if ((sc->sc_quirks & RS_NO_CLEAR_UA) &&
2567 (cmd[0] == INQUIRY) &&
2568 (key == SSD_KEY_UNIT_ATTENTION)) {
2569 /*
2570 * Ignore unit attention errors in the case where
2571 * the Unit Attention state is not cleared on
2572 * REQUEST SENSE. They will appear again at the next
2573 * command.
2574 */
2575 ccb->ccb_h.status = CAM_REQ_CMP;
2576 } else if (key == SSD_KEY_NO_SENSE) {
2577 /*
2578 * No problem after all (in the case of CBI without
2579 * CCI)
2580 */
2581 ccb->ccb_h.status = CAM_REQ_CMP;
2582 } else if ((sc->sc_quirks & RS_NO_CLEAR_UA) &&
2583 (cmd[0] == READ_CAPACITY) &&
2584 (key == SSD_KEY_UNIT_ATTENTION)) {
2585 /*
2586 * Some devices do not clear the unit attention error
2587 * on request sense. We insert a test unit ready
2588 * command to make sure we clear the unit attention
2589 * condition, then allow the retry to proceed as
2590 * usual.
2591 */
2592
2593 xpt_freeze_devq(ccb->ccb_h.path, 1);
2594 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2595 | CAM_AUTOSNS_VALID | CAM_DEV_QFRZN;
2596 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2597
2598#if 0
2599 DELAY(300000);
2600#endif
2601 DPRINTF(sc, UDMASS_SCSI, "Doing a sneaky"
2602 "TEST_UNIT_READY\n");
2603
2604 /* the rest of the command was filled in at attach */
2605
2606 if ((sc->sc_transform)(sc,
2607 &sc->cam_scsi_test_unit_ready.opcode,
2608 sizeof(sc->cam_scsi_test_unit_ready)) == 1) {
2609 umass_command_start(sc, DIR_NONE, NULL, 0,
2610 ccb->ccb_h.timeout,
2611 &umass_cam_quirk_cb, ccb);
2612 break;
2613 }
2614 } else {
2615 xpt_freeze_devq(ccb->ccb_h.path, 1);
2616 if (key >= 0) {
2617 ccb->ccb_h.status = CAM_SCSI_STATUS_ERROR
2618 | CAM_AUTOSNS_VALID | CAM_DEV_QFRZN;
2619 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
2620 } else
2621 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL
2622 | CAM_DEV_QFRZN;
2623 }
2624 xpt_done(ccb);
2625 break;
2626 }
2627 default:
2628 DPRINTF(sc, UDMASS_SCSI, "Autosense failed, "
2629 "status %d\n", status);
2630 xpt_freeze_devq(ccb->ccb_h.path, 1);
2631 ccb->ccb_h.status = CAM_AUTOSENSE_FAIL | CAM_DEV_QFRZN;
2632 xpt_done(ccb);
2633 }
2634}
2635
2636/*
2637 * This completion code just handles the fact that we sent a test-unit-ready
2638 * after having previously failed a READ CAPACITY with CHECK_COND. The CCB
2639 * status for CAM is already set earlier.
2640 */
2641static void
2642umass_cam_quirk_cb(struct umass_softc *sc, union ccb *ccb, uint32_t residue,
2643 uint8_t status)
2644{
2645 DPRINTF(sc, UDMASS_SCSI, "Test unit ready "
2646 "returned status %d\n", status);
2647
2648 xpt_done(ccb);
2649}
2650
2651/*
2652 * SCSI specific functions
2653 */
2654
2655static uint8_t
2656umass_scsi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2657 uint8_t cmd_len)
2658{
2659 if ((cmd_len == 0) ||
2660 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2661 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2662 "length: %d bytes\n", cmd_len);
2663 return (0); /* failure */
2664 }
2665 sc->sc_transfer.cmd_len = cmd_len;
2666
2667 switch (cmd_ptr[0]) {
2668 case TEST_UNIT_READY:
2669 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2670 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY "
2671 "to START_UNIT\n");
2672 memset(sc->sc_transfer.cmd_data, 0, cmd_len);
2673 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2674 sc->sc_transfer.cmd_data[4] = SSS_START;
2675 return (1);
2676 }
2677 break;
2678
2679 case INQUIRY:
2680 /*
2681 * some drives wedge when asked for full inquiry
2682 * information.
2683 */
2684 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2685 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2686 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH;
2687 return (1);
2688 }
2689 break;
2690 }
2691
2692 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2693 return (1);
2694}
2695
2696static uint8_t
2697umass_rbc_transform(struct umass_softc *sc, uint8_t *cmd_ptr, uint8_t cmd_len)
2698{
2699 if ((cmd_len == 0) ||
2700 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2701 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2702 "length: %d bytes\n", cmd_len);
2703 return (0); /* failure */
2704 }
2705 switch (cmd_ptr[0]) {
2706 /* these commands are defined in RBC: */
2707 case READ_10:
2708 case READ_CAPACITY:
2709 case START_STOP_UNIT:
2710 case SYNCHRONIZE_CACHE:
2711 case WRITE_10:
2712 case VERIFY_10:
2713 case INQUIRY:
2714 case MODE_SELECT_10:
2715 case MODE_SENSE_10:
2716 case TEST_UNIT_READY:
2717 case WRITE_BUFFER:
2718 /*
2719 * The following commands are not listed in my copy of the
2720 * RBC specs. CAM however seems to want those, and at least
2721 * the Sony DSC device appears to support those as well
2722 */
2723 case REQUEST_SENSE:
2724 case PREVENT_ALLOW:
2725
2726 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2727
2728 if ((sc->sc_quirks & RBC_PAD_TO_12) && (cmd_len < 12)) {
2729 memset(sc->sc_transfer.cmd_data + cmd_len,
2730 0, 12 - cmd_len);
2731 cmd_len = 12;
2732 }
2733 sc->sc_transfer.cmd_len = cmd_len;
2734 return (1); /* success */
2735
2736 /* All other commands are not legal in RBC */
2737 default:
2738 DPRINTF(sc, UDMASS_SCSI, "Unsupported RBC "
2739 "command 0x%02x\n", cmd_ptr[0]);
2740 return (0); /* failure */
2741 }
2742}
2743
2744static uint8_t
2745umass_ufi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2746 uint8_t cmd_len)
2747{
2748 if ((cmd_len == 0) ||
2749 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2750 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2751 "length: %d bytes\n", cmd_len);
2752 return (0); /* failure */
2753 }
2754 /* An UFI command is always 12 bytes in length */
2756
2757 /* Zero the command data */
2758 memset(sc->sc_transfer.cmd_data, 0, UFI_COMMAND_LENGTH);
2759
2760 switch (cmd_ptr[0]) {
2761 /*
2762 * Commands of which the format has been verified. They
2763 * should work. Copy the command into the (zeroed out)
2764 * destination buffer.
2765 */
2766 case TEST_UNIT_READY:
2767 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2768 /*
2769 * Some devices do not support this command. Start
2770 * Stop Unit should give the same results
2771 */
2772 DPRINTF(sc, UDMASS_UFI, "Converted TEST_UNIT_READY "
2773 "to START_UNIT\n");
2774
2775 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2776 sc->sc_transfer.cmd_data[4] = SSS_START;
2777 return (1);
2778 }
2779 break;
2780
2781 case REZERO_UNIT:
2782 case REQUEST_SENSE:
2783 case FORMAT_UNIT:
2784 case INQUIRY:
2785 case START_STOP_UNIT:
2786 case SEND_DIAGNOSTIC:
2787 case PREVENT_ALLOW:
2788 case READ_CAPACITY:
2789 case READ_10:
2790 case WRITE_10:
2791 case POSITION_TO_ELEMENT: /* SEEK_10 */
2792 case WRITE_AND_VERIFY:
2793 case VERIFY:
2794 case MODE_SELECT_10:
2795 case MODE_SENSE_10:
2796 case READ_12:
2797 case WRITE_12:
2798 case READ_FORMAT_CAPACITIES:
2799 break;
2800
2801 /*
2802 * SYNCHRONIZE_CACHE isn't supported by UFI, nor should it be
2803 * required for UFI devices, so it is appropriate to fake
2804 * success.
2805 */
2806 case SYNCHRONIZE_CACHE:
2807 return (2);
2808
2809 default:
2810 DPRINTF(sc, UDMASS_SCSI, "Unsupported UFI "
2811 "command 0x%02x\n", cmd_ptr[0]);
2812 return (0); /* failure */
2813 }
2814
2815 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2816 return (1); /* success */
2817}
2818
2819/*
2820 * 8070i (ATAPI) specific functions
2821 */
2822static uint8_t
2823umass_atapi_transform(struct umass_softc *sc, uint8_t *cmd_ptr,
2824 uint8_t cmd_len)
2825{
2826 if ((cmd_len == 0) ||
2827 (cmd_len > sizeof(sc->sc_transfer.cmd_data))) {
2828 DPRINTF(sc, UDMASS_SCSI, "Invalid command "
2829 "length: %d bytes\n", cmd_len);
2830 return (0); /* failure */
2831 }
2832 /* An ATAPI command is always 12 bytes in length. */
2834
2835 /* Zero the command data */
2837
2838 switch (cmd_ptr[0]) {
2839 /*
2840 * Commands of which the format has been verified. They
2841 * should work. Copy the command into the destination
2842 * buffer.
2843 */
2844 case INQUIRY:
2845 /*
2846 * some drives wedge when asked for full inquiry
2847 * information.
2848 */
2849 if (sc->sc_quirks & FORCE_SHORT_INQUIRY) {
2850 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2851
2852 sc->sc_transfer.cmd_data[4] = SHORT_INQUIRY_LENGTH;
2853 return (1);
2854 }
2855 break;
2856
2857 case TEST_UNIT_READY:
2858 if (sc->sc_quirks & NO_TEST_UNIT_READY) {
2859 DPRINTF(sc, UDMASS_SCSI, "Converted TEST_UNIT_READY "
2860 "to START_UNIT\n");
2861 sc->sc_transfer.cmd_data[0] = START_STOP_UNIT;
2862 sc->sc_transfer.cmd_data[4] = SSS_START;
2863 return (1);
2864 }
2865 break;
2866
2867 case REZERO_UNIT:
2868 case REQUEST_SENSE:
2869 case START_STOP_UNIT:
2870 case SEND_DIAGNOSTIC:
2871 case PREVENT_ALLOW:
2872 case READ_CAPACITY:
2873 case READ_10:
2874 case WRITE_10:
2875 case POSITION_TO_ELEMENT: /* SEEK_10 */
2876 case SYNCHRONIZE_CACHE:
2877 case MODE_SELECT_10:
2878 case MODE_SENSE_10:
2879 case READ_BUFFER:
2880 case 0x42: /* READ_SUBCHANNEL */
2881 case 0x43: /* READ_TOC */
2882 case 0x44: /* READ_HEADER */
2883 case 0x47: /* PLAY_MSF (Play Minute/Second/Frame) */
2884 case 0x48: /* PLAY_TRACK */
2885 case 0x49: /* PLAY_TRACK_REL */
2886 case 0x4b: /* PAUSE */
2887 case 0x51: /* READ_DISK_INFO */
2888 case 0x52: /* READ_TRACK_INFO */
2889 case 0x54: /* SEND_OPC */
2890 case 0x59: /* READ_MASTER_CUE */
2891 case 0x5b: /* CLOSE_TR_SESSION */
2892 case 0x5c: /* READ_BUFFER_CAP */
2893 case 0x5d: /* SEND_CUE_SHEET */
2894 case 0xa1: /* BLANK */
2895 case 0xa5: /* PLAY_12 */
2896 case 0xa6: /* EXCHANGE_MEDIUM */
2897 case 0xad: /* READ_DVD_STRUCTURE */
2898 case 0xbb: /* SET_CD_SPEED */
2899 case 0xe5: /* READ_TRACK_INFO_PHILIPS */
2900 break;
2901
2902 case READ_12:
2903 case WRITE_12:
2904 default:
2905 DPRINTF(sc, UDMASS_SCSI, "Unsupported ATAPI "
2906 "command 0x%02x - trying anyway\n",
2907 cmd_ptr[0]);
2908 break;
2909 }
2910
2911 memcpy(sc->sc_transfer.cmd_data, cmd_ptr, cmd_len);
2912 return (1); /* success */
2913}
2914
2915static uint8_t
2916umass_no_transform(struct umass_softc *sc, uint8_t *cmd,
2917 uint8_t cmdlen)
2918{
2919 return (0); /* failure */
2920}
2921
2922static uint8_t
2923umass_std_transform(struct umass_softc *sc, union ccb *ccb,
2924 uint8_t *cmd, uint8_t cmdlen)
2925{
2926 uint8_t retval;
2927
2928 retval = (sc->sc_transform) (sc, cmd, cmdlen);
2929
2930 if (retval == 2) {
2931 ccb->ccb_h.status = CAM_REQ_CMP;
2932 xpt_done(ccb);
2933 return (0);
2934 } else if (retval == 0) {
2935 xpt_freeze_devq(ccb->ccb_h.path, 1);
2936 ccb->ccb_h.status = CAM_REQ_INVALID | CAM_DEV_QFRZN;
2937 xpt_done(ccb);
2938 return (0);
2939 }
2940 /* Command should be executed */
2941 return (1);
2942}
2943
2944#ifdef USB_DEBUG
2945static void
2946umass_bbb_dump_cbw(struct umass_softc *sc, umass_bbb_cbw_t *cbw)
2947{
2948 uint8_t *c = cbw->CBWCDB;
2949
2950 uint32_t dlen = UGETDW(cbw->dCBWDataTransferLength);
2951 uint32_t tag = UGETDW(cbw->dCBWTag);
2952
2953 uint8_t clen = cbw->bCDBLength;
2954 uint8_t flags = cbw->bCBWFlags;
2955 uint8_t lun = cbw->bCBWLUN;
2956
2957 DPRINTF(sc, UDMASS_BBB, "CBW %d: cmd = %db "
2958 "(0x%02x%02x%02x%02x%02x%02x%s), "
2959 "data = %db, lun = %d, dir = %s\n",
2960 tag, clen,
2961 c[0], c[1], c[2], c[3], c[4], c[5], (clen > 6 ? "..." : ""),
2962 dlen, lun, (flags == CBWFLAGS_IN ? "in" :
2963 (flags == CBWFLAGS_OUT ? "out" : "<invalid>")));
2964}
2965
2966static void
2967umass_bbb_dump_csw(struct umass_softc *sc, umass_bbb_csw_t *csw)
2968{
2969 uint32_t sig = UGETDW(csw->dCSWSignature);
2970 uint32_t tag = UGETDW(csw->dCSWTag);
2971 uint32_t res = UGETDW(csw->dCSWDataResidue);
2972 uint8_t status = csw->bCSWStatus;
2973
2974 DPRINTF(sc, UDMASS_BBB, "CSW %d: sig = 0x%08x (%s), tag = 0x%08x, "
2975 "res = %d, status = 0x%02x (%s)\n",
2976 tag, sig, (sig == CSWSIGNATURE ? "valid" : "invalid"),
2977 tag, res,
2978 status, (status == CSWSTATUS_GOOD ? "good" :
2979 (status == CSWSTATUS_FAILED ? "failed" :
2980 (status == CSWSTATUS_PHASE ? "phase" : "<invalid>"))));
2981}
2982
2983static void
2984umass_cbi_dump_cmd(struct umass_softc *sc, void *cmd, uint8_t cmdlen)
2985{
2986 uint8_t *c = cmd;
2987 uint8_t dir = sc->sc_transfer.dir;
2988
2989 DPRINTF(sc, UDMASS_BBB, "cmd = %db "
2990 "(0x%02x%02x%02x%02x%02x%02x%s), "
2991 "data = %db, dir = %s\n",
2992 cmdlen,
2993 c[0], c[1], c[2], c[3], c[4], c[5], (cmdlen > 6 ? "..." : ""),
2995 (dir == DIR_IN ? "in" :
2996 (dir == DIR_OUT ? "out" :
2997 (dir == DIR_NONE ? "no data phase" : "<invalid>"))));
2998}
2999
3000static void
3001umass_dump_buffer(struct umass_softc *sc, uint8_t *buffer, uint32_t buflen,
3002 uint32_t printlen)
3003{
3004 uint32_t i, j;
3005 char s1[40];
3006 char s2[40];
3007 char s3[5];
3008
3009 s1[0] = '\0';
3010 s3[0] = '\0';
3011
3012 sprintf(s2, " buffer=%p, buflen=%d", buffer, buflen);
3013 for (i = 0; (i < buflen) && (i < printlen); i++) {
3014 j = i % 16;
3015 if (j == 0 && i != 0) {
3016 DPRINTF(sc, UDMASS_GEN, "0x %s%s\n",
3017 s1, s2);
3018 s2[0] = '\0';
3019 }
3020 sprintf(&s1[j * 2], "%02x", buffer[i] & 0xff);
3021 }
3022 if (buflen > printlen)
3023 sprintf(s3, " ...");
3024 DPRINTF(sc, UDMASS_GEN, "0x %s%s%s\n",
3025 s1, s2, s3);
3026}
3027
3028#endif
static int debug
Definition: cfumass.c:73
static SYSCTL_NODE(_hw_usb, OID_AUTO, dwc_otg, CTLFLAG_RW|CTLFLAG_MPSAFE, 0, "USB DWC OTG")
SYSCTL_INT(_hw_usb_dwc_otg, OID_AUTO, phy_type, CTLFLAG_RDTUN, &dwc_otg_phy_type, 0, "DWC OTG PHY TYPE - 0/1/2/3 - ULPI/HSIC/INTERNAL/UTMI+")
struct @109 error
uint8_t id
Definition: if_usievar.h:4
device_t dev
uDWord dCBWSignature
Definition: umass.c:244
uDWord dCSWDataResidue
Definition: umass.c:266
uDWord dCBWDataTransferLength
Definition: umass.c:247
uDWord dCSWTag
Definition: umass.c:265
uByte bCSWStatus
Definition: umass.c:267
uDWord dCBWTag
Definition: umass.c:246
uint8_t type
Definition: umass.c:281
uByte bCBWLUN
Definition: umass.c:251
uint8_t ascq
Definition: umass.c:293
uByte bCDBLength
Definition: umass.c:252
uint8_t asc
Definition: umass.c:292
uByte bCBWFlags
Definition: umass.c:248
uDWord dCSWSignature
Definition: umass.c:261
uint8_t value
Definition: umass.c:283
uint32_t quirks
Definition: umass.c:422
uint32_t proto
Definition: umass.c:423
uint8_t dir
Definition: umass.c:388
uint32_t sc_proto
Definition: umass.c:412
uint8_t cmd_data[UMASS_MAX_CMDLEN]
Definition: umass.c:386
uint8_t sc_maxlun
Definition: umass.c:416
struct scsi_sense cam_scsi_sense
Definition: umass.c:373
union ccb * ccb
Definition: umass.c:378
uint32_t actlen
Definition: umass.c:384
uint32_t sc_quirks
Definition: umass.c:411
uint32_t data_timeout
Definition: umass.c:383
struct mtx sc_mtx
Definition: umass.c:375
uint32_t data_len
Definition: umass.c:381
umass_cbi_sbl_t sbl
Definition: umass.c:397
device_t sc_dev
Definition: umass.c:399
struct usb_xfer * sc_xfer[UMASS_T_MAX]
Definition: umass.c:402
uint8_t cmd_len
Definition: umass.c:387
struct cam_sim * sc_sim
Definition: umass.c:401
struct umass_softc::@71 sc_transfer
umass_callback_t * callback
Definition: umass.c:379
struct scsi_test_unit_ready cam_scsi_test_unit_ready
Definition: umass.c:374
uint8_t sc_last_xfer_index
Definition: umass.c:417
umass_transform_t * sc_transform
Definition: umass.c:408
uint32_t data_rem
Definition: umass.c:382
uint8_t sc_status_try
Definition: umass.c:418
uint32_t sc_unit
Definition: umass.c:410
umass_bbb_csw_t csw
Definition: umass.c:394
uint8_t lun
Definition: umass.c:389
struct usb_device * sc_udev
Definition: umass.c:400
umass_bbb_cbw_t cbw
Definition: umass.c:393
uint8_t * data_ptr
Definition: umass.c:377
uint8_t sc_iface_no
Definition: umass.c:415
uint8_t sc_name[16]
Definition: umass.c:414
enum usb_hc_mode usb_mode
Definition: usbdi.h:432
struct usbd_lookup_info info
Definition: usbdi.h:426
struct usb_interface * iface
Definition: usbdi.h:431
struct usb_device * device
Definition: usbdi.h:430
uint8_t type
Definition: usbdi.h:238
uint8_t bIfaceIndex
Definition: usbdi.h:417
static usb_callback_t umass_t_bbb_command_callback
Definition: umass.c:438
static void umass_t_cbi_data_clear_stall_callback(struct usb_xfer *, uint8_t, uint8_t, usb_error_t)
Definition: umass.c:1754
#define CSWSTATUS_PHASE
Definition: umass.c:270
#define UMASS_PROTO_CBI
Definition: umass.c:312
#define DIF(...)
Definition: umass.c:178
static void umass_cam_quirk_cb(struct umass_softc *, union ccb *, uint32_t, uint8_t)
Definition: umass.c:2642
#define IDB_VALUE_STATUS_MASK
Definition: umass.c:288
static void umass_t_bbb_data_clear_stall_callback(struct usb_xfer *, uint8_t, uint8_t, usb_error_t)
Definition: umass.c:1241
#define UMASS_T_BBB_RESET1
Definition: umass.c:188
#define CSWSTATUS_GOOD
Definition: umass.c:268
static uint8_t umass_bbb_get_max_lun(struct umass_softc *)
Definition: umass.c:1609
static devclass_t umass_devclass
Definition: umass.c:692
#define UMASS_BULK_SIZE
Definition: umass.c:182
#define ALT_IFACE_1
Definition: umass.c:341
static usb_callback_t umass_t_cbi_command_callback
Definition: umass.c:448
#define CBWSIGNATURE
Definition: umass.c:245
static void umass_cam_action(struct cam_sim *, union ccb *)
Definition: umass.c:2158
#define UMASS_PROTO_CBI_I
Definition: umass.c:313
#define UMASS_PROTO_UFI
Definition: umass.c:317
uint8_t() umass_transform_t(struct umass_softc *sc, uint8_t *cmd_ptr, uint8_t cmd_len)
Definition: umass.c:307
USB_PNP_HOST_INFO(umass_devs)
static void umass_reset(struct umass_softc *)
Definition: umass.c:1131
#define STATUS_CMD_OK
Definition: umass.c:302
#define UMASS_TIMEOUT
Definition: umass.c:230
#define CBWCDBLENGTH
Definition: umass.c:253
static uint8_t umass_rbc_transform(struct umass_softc *, uint8_t *, uint8_t)
Definition: umass.c:2697
#define UMASS_T_CBI_DATA_WRITE
Definition: umass.c:205
#define RBC_PAD_TO_12
Definition: umass.c:355
static void umass_init_shuttle(struct umass_softc *)
Definition: umass.c:1091
static device_probe_t umass_probe
Definition: umass.c:430
static usb_callback_t umass_t_cbi_reset2_callback
Definition: umass.c:445
#define UMASS_T_BBB_DATA_READ
Definition: umass.c:192
#define STATUS_CMD_FAILED
Definition: umass.c:304
static void umass_cam_sense_cb(struct umass_softc *, union ccb *, uint32_t, uint8_t)
Definition: umass.c:2540
#define UMASS_PROTO_SCSI
Definition: umass.c:315
static usb_callback_t umass_t_cbi_data_write_callback
Definition: umass.c:451
#define CSWSIGNATURE_IMAGINATION_DBX1
Definition: umass.c:263
static const STRUCT_USB_HOST_ID __used umass_devs[]
Definition: umass.c:709
static usb_callback_t umass_t_cbi_data_read_callback
Definition: umass.c:449
static void umass_cam_attach(struct umass_softc *)
Definition: umass.c:2115
#define FLOPPY_SPEED
Definition: umass.c:343
#define UMASS_T_CBI_STATUS
Definition: umass.c:207
static driver_t umass_driver
Definition: umass.c:703
static usb_callback_t umass_t_cbi_status_callback
Definition: umass.c:453
#define NO_TEST_UNIT_READY
Definition: umass.c:326
#define DEVNAME_SIM
Definition: umass.c:222
static void umass_cbi_start_status(struct umass_softc *)
Definition: umass.c:1639
static usb_callback_t umass_t_bbb_data_write_callback
Definition: umass.c:441
#define NO_INQUIRY
Definition: umass.c:351
#define UMASS_T_CBI_DATA_RD_CS
Definition: umass.c:204
static usb_callback_t umass_t_bbb_data_rd_cs_callback
Definition: umass.c:440
static usb_callback_t umass_t_bbb_reset2_callback
Definition: umass.c:436
#define UMASS_FULL_TRANSFER_SPEED
Definition: umass.c:225
MODULE_DEPEND(umass, usb, 1, 1, 1)
#define NO_SYNCHRONIZE_CACHE
Definition: umass.c:368
#define UMASS_T_CBI_RESET4
Definition: umass.c:208
#define DIR_NONE
Definition: umass.c:216
static uint8_t umass_atapi_transform(struct umass_softc *, uint8_t *, uint8_t)
Definition: umass.c:2823
#define UR_BBB_GET_MAX_LUN
Definition: umass.c:240
static usb_callback_t umass_t_cbi_data_wr_cs_callback
Definition: umass.c:452
#define UMASS_T_CBI_RESET1
Definition: umass.c:199
#define CSWSIGNATURE
Definition: umass.c:262
#define FORCE_SHORT_INQUIRY
Definition: umass.c:337
static void umass_transfer_start(struct umass_softc *sc, uint8_t xfer_index)
Definition: umass.c:1117
#define UR_CBI_ADSC
Definition: umass.c:277
#define IDB_TYPE_CCI
Definition: umass.c:282
static uint8_t umass_no_transform(struct umass_softc *, uint8_t *, uint8_t)
Definition: umass.c:2916
#define UMASS_FLOPPY_TRANSFER_SPEED
Definition: umass.c:228
#define UMASS_T_BBB_RESET2
Definition: umass.c:189
#define WRONG_CSWSIG
Definition: umass.c:349
static void umass_cam_poll(struct cam_sim *)
Definition: umass.c:2441
#define SHUTTLE_INIT
Definition: umass.c:339
static struct usb_config umass_cbi_config[UMASS_T_CBI_MAX]
Definition: umass.c:583
static struct umass_probe_proto umass_probe_proto(device_t dev, struct usb_attach_arg *uaa)
Definition: umass.c:778
static usb_callback_t umass_tr_error
Definition: umass.c:434
static uint8_t umass_ufi_transform(struct umass_softc *, uint8_t *, uint8_t)
Definition: umass.c:2745
#define IDB_VALUE_FAIL
Definition: umass.c:285
#define NO_PREVENT_ALLOW
Definition: umass.c:370
#define READ_CAPACITY_OFFBY1
Definition: umass.c:360
#define UFI_COMMAND_LENGTH
Definition: umass.c:689
static void umass_cam_detach_sim(struct umass_softc *)
Definition: umass.c:2130
static uint16_t umass_get_proto(struct usb_interface *iface)
Definition: umass.c:725
__FBSDID("$FreeBSD$")
#define NO_START_STOP
Definition: umass.c:335
MODULE_VERSION(umass, 1)
static uint8_t umass_std_transform(struct umass_softc *, union ccb *, uint8_t *, uint8_t)
Definition: umass.c:2923
#define NO_QUIRKS
Definition: umass.c:322
#define UMASS_T_BBB_STATUS
Definition: umass.c:196
#define DIR_OUT
Definition: umass.c:218
static void umass_command_start(struct umass_softc *, uint8_t, void *, uint32_t, uint32_t, umass_callback_t *, union ccb *)
Definition: umass.c:1578
#define UMASS_T_BBB_DATA_WR_CS
Definition: umass.c:195
#define UMASS_SCSIID_MAX
Definition: umass.c:234
static usb_callback_t umass_t_bbb_data_read_callback
Definition: umass.c:439
static const uint8_t fake_inq_data[SHORT_INQUIRY_LENGTH]
Definition: umass.c:684
static usb_callback_t umass_t_cbi_reset3_callback
Definition: umass.c:446
#define UMASS_T_BBB_DATA_RD_CS
Definition: umass.c:193
#define NO_INQUIRY_EVPD
Definition: umass.c:353
static struct usb_config umass_bbb_config[UMASS_T_BBB_MAX]
Definition: umass.c:494
static usb_callback_t umass_t_cbi_reset1_callback
Definition: umass.c:444
#define UMASS_T_CBI_RESET3
Definition: umass.c:201
#define UMASS_PROTO_BBB
Definition: umass.c:311
#define UMASS_SUPER_TRANSFER_SPEED
Definition: umass.c:227
static uint8_t umass_scsi_transform(struct umass_softc *, uint8_t *, uint8_t)
Definition: umass.c:2656
#define DPRINTF(...)
Definition: umass.c:179
static usb_callback_t umass_t_cbi_reset4_callback
Definition: umass.c:447
#define UMASS_PROTO_RBC
Definition: umass.c:318
#define ATAPI_COMMAND_LENGTH
Definition: umass.c:690
#define RS_NO_CLEAR_UA
Definition: umass.c:333
#define UMASS_T_BBB_COMMAND
Definition: umass.c:191
#define UR_BBB_RESET
Definition: umass.c:239
static device_detach_t umass_detach
Definition: umass.c:432
#define UMASS_HIGH_TRANSFER_SPEED
Definition: umass.c:226
#define UMASS_MAX_CMDLEN
Definition: umass.c:184
#define UMASS_T_CBI_MAX
Definition: umass.c:209
#define UMASS_PROTO_ATAPI
Definition: umass.c:316
static usb_callback_t umass_t_bbb_reset1_callback
Definition: umass.c:435
DRIVER_MODULE(umass, uhub, umass_driver, umass_devclass, NULL, 0)
#define UMASS_PROTO_WIRE
Definition: umass.c:314
#define UMASS_T_CBI_RESET2
Definition: umass.c:200
#define STATUS_CMD_UNKNOWN
Definition: umass.c:303
#define UMASS_CBI_DIAGNOSTIC_CMDLEN
Definition: umass.c:183
static usb_callback_t umass_t_bbb_status_callback
Definition: umass.c:443
#define CSWSIGNATURE_OLYMPUS_C1
Definition: umass.c:264
#define UMASS_T_BBB_DATA_WRITE
Definition: umass.c:194
static device_method_t umass_methods[]
Definition: umass.c:694
#define UMASS_T_BBB_MAX
Definition: umass.c:197
void() umass_callback_t(struct umass_softc *sc, union ccb *ccb, uint32_t residue, uint8_t status)
Definition: umass.c:299
#define IGNORE_RESIDUE
Definition: umass.c:345
#define UMASS_PROTO_COMMAND
Definition: umass.c:319
#define UMASS_T_CBI_DATA_READ
Definition: umass.c:203
#define CBWFLAGS_OUT
Definition: umass.c:249
static usb_callback_t umass_t_cbi_data_rd_cs_callback
Definition: umass.c:450
#define DIR_IN
Definition: umass.c:217
static int umass_cam_attach_sim(struct umass_softc *)
Definition: umass.c:2069
static usb_callback_t umass_t_bbb_data_wr_cs_callback
Definition: umass.c:442
#define NO_GETMAXLUN
Definition: umass.c:347
#define UMASS_T_CBI_DATA_WR_CS
Definition: umass.c:206
#define IDB_VALUE_PERSISTENT
Definition: umass.c:287
#define UMASS_T_CBI_COMMAND
Definition: umass.c:202
#define CBWFLAGS_IN
Definition: umass.c:250
static void umass_cancel_ccb(struct umass_softc *)
Definition: umass.c:1143
#define CSWSTATUS_FAILED
Definition: umass.c:269
#define UMASS_T_MAX
Definition: umass.c:211
static void umass_cam_cb(struct umass_softc *, union ccb *, uint32_t, uint8_t)
Definition: umass.c:2458
#define STATUS_WIRE_FAILED
Definition: umass.c:305
#define IDB_VALUE_PASS
Definition: umass.c:284
#define UMASS_T_BBB_RESET3
Definition: umass.c:190
#define UMASS_SCSIID_HOST
Definition: umass.c:235
static usb_callback_t umass_t_bbb_reset3_callback
Definition: umass.c:437
static device_attach_t umass_attach
Definition: umass.c:431
#define UE_INTERRUPT
Definition: usb.h:544
#define UE_DIR_ANY
Definition: usb.h:535
#define UIPROTO_MASS_BBB
Definition: usb.h:477
#define UE_ADDR_ANY
Definition: usb.h:537
#define UE_BULK
Definition: usb.h:543
#define UISUBCLASS_SCSI
Definition: usb.h:473
#define UT_READ_CLASS_INTERFACE
Definition: usb.h:173
#define UISUBCLASS_SFF8070I
Definition: usb.h:472
#define UT_READ_VENDOR_DEVICE
Definition: usb.h:180
#define UE_DIR_IN
Definition: usb.h:531
@ USB_SPEED_HIGH
Definition: usb.h:755
@ USB_SPEED_SUPER
Definition: usb.h:756
#define UE_DIR_OUT
Definition: usb.h:532
@ USB_MODE_HOST
Definition: usb.h:778
#define UISUBCLASS_SFF8020I
Definition: usb.h:469
#define UT_WRITE_CLASS_INTERFACE
Definition: usb.h:177
#define UISUBCLASS_UFI
Definition: usb.h:471
#define UE_CONTROL
Definition: usb.h:541
#define UISUBCLASS_RBC
Definition: usb.h:468
#define UICLASS_MASS
Definition: usb.h:467
#define UIPROTO_MASS_BBB_OLD
Definition: usb.h:476
#define UIPROTO_MASS_CBI_I
Definition: usb.h:474
#define UIPROTO_MASS_CBI
Definition: usb.h:475
void usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset, const void *ptr, usb_frlength_t len)
Definition: usb_busdma.c:166
void usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset, void *ptr, usb_frlength_t len)
Definition: usb_busdma.c:283
usb_error_t usbd_set_alt_interface_index(struct usb_device *udev, uint8_t iface_index, uint8_t alt_index)
Definition: usb_device.c:1034
struct usb_interface_descriptor * usbd_get_interface_descriptor(struct usb_interface *iface)
Definition: usb_device.c:2654
const char * usb_get_serial(struct usb_device *udev)
Definition: usb_device.c:293
enum usb_dev_speed usbd_get_speed(struct usb_device *udev)
Definition: usb_device.c:2589
uint8_t uByte
Definition: usb_endian.h:41
#define USETW(w, v)
Definition: usb_endian.h:77
#define USETDW(w, v)
Definition: usb_endian.h:82
#define UGETDW(w)
Definition: usb_endian.h:57
uint8_t uDWord[4]
Definition: usb_endian.h:43
const char * usbd_errstr(usb_error_t err)
Definition: usb_error.c:93
const void * req
Definition: usb_if.m:51
INTERFACE usb
Definition: usb_if.m:35
static uint8_t scsi_test_unit_ready[]
Definition: usb_msctest.c:95
@ UQ_MSC_FORCE_PROTO_ATAPI
Definition: usb_quirk.h:93
@ UQ_MSC_NO_TEST_UNIT_READY
Definition: usb_quirk.h:73
@ UQ_MSC_NO_START_STOP
Definition: usb_quirk.h:75
@ UQ_MSC_SHUTTLE_INIT
Definition: usb_quirk.h:81
@ UQ_MSC_NO_INQUIRY
Definition: usb_quirk.h:77
@ UQ_MSC_FORCE_PROTO_SCSI
Definition: usb_quirk.h:92
@ UQ_MSC_NO_PREVENT_ALLOW
Definition: usb_quirk.h:79
@ UQ_MSC_IGNORE_RESIDUE
Definition: usb_quirk.h:84
@ UQ_MSC_ALT_IFACE_1
Definition: usb_quirk.h:82
@ UQ_MSC_FORCE_WIRE_CBI_I
Definition: usb_quirk.h:91
@ UQ_MSC_FORCE_WIRE_CBI
Definition: usb_quirk.h:90
@ UQ_MSC_WRONG_CSWSIG
Definition: usb_quirk.h:85
@ UQ_MSC_NO_GETMAXLUN
Definition: usb_quirk.h:76
@ UQ_MSC_RBC_PAD_TO_12
Definition: usb_quirk.h:86
@ UQ_MSC_FORCE_SHORT_INQ
Definition: usb_quirk.h:88
@ UQ_MSC_NO_SYNC_CACHE
Definition: usb_quirk.h:80
@ UQ_MSC_NO_RS_CLEAR_UA
Definition: usb_quirk.h:74
@ UQ_MSC_NO_INQUIRY_EVPD
Definition: usb_quirk.h:78
@ UQ_MSC_FORCE_WIRE_BBB
Definition: usb_quirk.h:89
@ UQ_MSC_READ_CAP_OFFBY1
Definition: usb_quirk.h:87
@ UQ_MSC_FORCE_PROTO_UFI
Definition: usb_quirk.h:94
@ UQ_MSC_FLOPPY_SPEED
Definition: usb_quirk.h:83
@ UQ_MSC_FORCE_PROTO_RBC
Definition: usb_quirk.h:95
@ UQ_MSC_IGNORE
Definition: usb_quirk.h:96
uint8_t usb_test_quirk(const struct usb_attach_arg *uaa, uint16_t quirk)
Definition: usb_device.c:2631
void usbd_xfer_set_timeout(struct usb_xfer *xfer, int t)
void usbd_transfer_submit(struct usb_xfer *xfer)
void usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n)
void usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup)
void usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, void *ptr, usb_frlength_t len)
void usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex, usb_frlength_t len)
uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1, struct usb_xfer *xfer2)
struct usb_page_cache * usbd_xfer_get_frame(struct usb_xfer *xfer, usb_frcount_t frindex)
usb_error_t usbd_transfer_setup(struct usb_device *udev, const uint8_t *ifaces, struct usb_xfer **ppxfer, const struct usb_config *setup_start, uint16_t n_setup, void *priv_sc, struct mtx *xfer_mtx)
Definition: usb_transfer.c:987
void usbd_transfer_start(struct usb_xfer *xfer)
void usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max)
void * usbd_xfer_softc(struct usb_xfer *xfer)
void usbd_xfer_set_interval(struct usb_xfer *xfer, int i)
void usbd_transfer_stop(struct usb_xfer *xfer)
void usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes, int *nframes)
usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer)
void device_set_usb_desc(device_t dev)
Definition: usb_util.c:73
#define USB_MTX_ASSERT(_m, _t)
Definition: usbdi.h:450
#define USB_ST_SETUP
Definition: usbdi.h:502
usb_error_t
Definition: usbdi.h:45
@ USB_ERR_STALLED
Definition: usbdi.h:68
@ USB_ERR_CANCELLED
Definition: usbdi.h:51
@ USB_ERR_INVAL
Definition: usbdi.h:49
#define USB_IFACE_CLASS(ic)
Definition: usbdi.h:385
#define USB_ST_TRANSFERRED
Definition: usbdi.h:503
void() usb_callback_t(struct usb_xfer *, usb_error_t)
Definition: usbdi.h:94
#define STRUCT_USB_HOST_ID
Definition: usbdi.h:258
#define USB_GET_STATE(xfer)
Definition: usbdi.h:515
#define usbd_do_request(u, m, r, d)
Definition: usbdi.h:596
uint8_t status
Definition: xhci.h:14