2 * Most of this source has been derived from the Linux USB
4 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
5 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
6 * (c) 1999 Michael Gee (michael@linuxspecific.com)
7 * (c) 2000 Yggdrasil Computing, Inc.
11 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
13 * For BBB support (C) Copyright 2003
14 * Gary Jennejohn, DENX Software Engineering <garyj@denx.de>
16 * BBB support based on /sys/dev/usb/umass.c from
19 * SPDX-License-Identifier: GPL-2.0+
23 * Currently only the CBI transport protocoll has been implemented, and it
24 * is only tested with a TEAC USB Floppy. Other Massstorages with CBI or CB
25 * transport protocoll may work as well.
29 * Support for USB Mass Storage Devices (BBB) has been added. It has
30 * only been tested with USB memory sticks.
37 #include <asm/byteorder.h>
38 #include <asm/processor.h>
43 #undef BBB_COMDAT_TRACE
44 #undef BBB_XPORT_TRACE
47 /* direction table -- this indicates the direction of the data
48 * transfer for each command code -- a 1 indicates input
50 static const unsigned char us_direction[256/8] = {
51 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
52 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
53 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
54 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
56 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
58 static ccb usb_ccb __attribute__((aligned(ARCH_DMA_MINALIGN)));
69 #define US_BBB_RESET 0xff
70 #define US_BBB_GET_MAX_LUN 0xfe
72 /* Command Block Wrapper */
75 # define CBWSIGNATURE 0x43425355
77 __u32 dCBWDataTransferLength;
79 # define CBWFLAGS_OUT 0x00
80 # define CBWFLAGS_IN 0x80
83 # define CBWCDBLENGTH 16
84 __u8 CBWCDB[CBWCDBLENGTH];
86 #define UMASS_BBB_CBW_SIZE 31
89 /* Command Status Wrapper */
92 # define CSWSIGNATURE 0x53425355
94 __u32 dCSWDataResidue;
96 # define CSWSTATUS_GOOD 0x0
97 # define CSWSTATUS_FAILED 0x1
98 # define CSWSTATUS_PHASE 0x2
100 #define UMASS_BBB_CSW_SIZE 13
102 #define USB_MAX_STOR_DEV 5
103 static int usb_max_devs; /* number of highest available usb device */
105 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
108 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
109 typedef int (*trans_reset)(struct us_data *data);
112 struct usb_device *pusb_dev; /* this usb_device */
114 unsigned int flags; /* from filter initially */
115 # define USB_READY (1 << 0)
116 unsigned char ifnum; /* interface number */
117 unsigned char ep_in; /* in endpoint */
118 unsigned char ep_out; /* out ....... */
119 unsigned char ep_int; /* interrupt . */
120 unsigned char subclass; /* as in overview */
121 unsigned char protocol; /* .............. */
122 unsigned char attention_done; /* force attn on first cmd */
123 unsigned short ip_data; /* interrupt data */
124 int action; /* what to do */
125 int ip_wanted; /* needed */
126 int *irq_handle; /* for USB int requests */
127 unsigned int irqpipe; /* pipe for release_irq */
128 unsigned char irqmaxp; /* max packed for irq Pipe */
129 unsigned char irqinterval; /* Intervall for IRQ Pipe */
130 ccb *srb; /* current srb */
131 trans_reset transport_reset; /* reset routine */
132 trans_cmnd transport; /* transport routine */
135 #ifdef CONFIG_USB_EHCI
137 * The U-Boot EHCI driver can handle any transfer length as long as there is
138 * enough free heap space left, but the SCSI READ(10) and WRITE(10) commands are
139 * limited to 65535 blocks.
141 #define USB_MAX_XFER_BLK 65535
143 #define USB_MAX_XFER_BLK 20
146 static struct us_data usb_stor[USB_MAX_STOR_DEV];
149 #define USB_STOR_TRANSPORT_GOOD 0
150 #define USB_STOR_TRANSPORT_FAILED -1
151 #define USB_STOR_TRANSPORT_ERROR -2
153 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
154 block_dev_desc_t *dev_desc);
155 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
157 unsigned long usb_stor_read(int device, lbaint_t blknr,
158 lbaint_t blkcnt, void *buffer);
159 unsigned long usb_stor_write(int device, lbaint_t blknr,
160 lbaint_t blkcnt, const void *buffer);
161 struct usb_device * usb_get_dev_index(int index);
162 void uhci_show_temp_int_td(void);
164 #ifdef CONFIG_PARTITIONS
165 block_dev_desc_t *usb_stor_get_dev(int index)
167 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
171 static void usb_show_progress(void)
176 /*******************************************************************************
177 * show info on storage devices; 'usb start/init' must be invoked earlier
178 * as we only retrieve structures populated during devices initialization
180 int usb_stor_info(void)
184 if (usb_max_devs > 0) {
185 for (i = 0; i < usb_max_devs; i++) {
186 printf(" Device %d: ", i);
187 dev_print(&usb_dev_desc[i]);
192 printf("No storage devices, perhaps not 'usb start'ed..?\n");
196 static unsigned int usb_get_max_lun(struct us_data *us)
199 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
200 len = usb_control_msg(us->pusb_dev,
201 usb_rcvctrlpipe(us->pusb_dev, 0),
203 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
205 result, sizeof(char),
206 USB_CNTL_TIMEOUT * 5);
207 debug("Get Max LUN -> len = %i, result = %i\n", len, (int) *result);
208 return (len > 0) ? *result : 0;
211 static int usb_storage_register(struct usb_device *dev, unsigned char iface)
213 int lun, max_lun, start = usb_max_devs;
216 if (!usb_storage_probe(dev, iface, &usb_stor[usb_max_devs]))
220 * OK, it's a storage device. Iterate over its LUNs
221 * and populate `usb_dev_desc'.
223 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
224 for (lun = 0; lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV; lun++) {
225 usb_dev_desc[usb_max_devs].lun = lun;
226 if (usb_stor_get_info(dev, &usb_stor[start],
227 &usb_dev_desc[usb_max_devs]) == 1) {
235 /*******************************************************************************
236 * scan the usb and reports device info
237 * to the user if mode = 1
238 * returns current device or -1 if no
240 int usb_stor_scan(int mode)
242 unsigned char i, iface;
243 struct usb_device *dev;
246 printf(" scanning usb for storage devices... ");
248 usb_disable_asynch(1); /* asynch transfer not allowed */
250 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
251 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
252 usb_dev_desc[i].if_type = IF_TYPE_USB;
253 usb_dev_desc[i].dev = i;
254 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
255 usb_dev_desc[i].target = 0xff;
256 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
257 usb_dev_desc[i].block_read = usb_stor_read;
258 usb_dev_desc[i].block_write = usb_stor_write;
262 for (i = 0; i < USB_MAX_DEVICE; i++) {
263 dev = usb_get_dev_index(i); /* get device */
266 break; /* no more devices available */
268 for (iface = 0; iface < dev->config.no_of_if; iface++) {
269 usb_max_devs += usb_storage_register(dev, iface);
272 /* if storage device */
273 if (usb_max_devs == USB_MAX_STOR_DEV) {
274 printf("max USB Storage Device reached: %d stopping\n",
280 usb_disable_asynch(0); /* asynch transfer allowed */
281 printf("%d Storage Device(s) found\n", usb_max_devs);
282 if (usb_max_devs > 0)
287 static int usb_stor_irq(struct usb_device *dev)
290 us = (struct us_data *)dev->privptr;
300 static void usb_show_srb(ccb *pccb)
303 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
304 for (i = 0; i < 12; i++)
305 printf("%02X ", pccb->cmd[i]);
309 static void display_int_status(unsigned long tmp)
311 printf("Status: %s %s %s %s %s %s %s\n",
312 (tmp & USB_ST_ACTIVE) ? "Active" : "",
313 (tmp & USB_ST_STALLED) ? "Stalled" : "",
314 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
315 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
316 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
317 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
318 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
321 /***********************************************************************
322 * Data transfer routines
323 ***********************************************************************/
325 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
334 /* determine the maximum packet size for these transfers */
335 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
337 /* while we have data left to transfer */
340 /* calculate how long this will be -- maximum or a remainder */
341 this_xfer = length > max_size ? max_size : length;
344 /* setup the retry counter */
347 /* set up the transfer loop */
349 /* transfer the data */
350 debug("Bulk xfer 0x%x(%d) try #%d\n",
351 (unsigned int)buf, this_xfer, 11 - maxtry);
352 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
354 USB_CNTL_TIMEOUT * 5);
355 debug("bulk_msg returned %d xferred %d/%d\n",
356 result, partial, this_xfer);
357 if (us->pusb_dev->status != 0) {
358 /* if we stall, we need to clear it before
362 display_int_status(us->pusb_dev->status);
364 if (us->pusb_dev->status & USB_ST_STALLED) {
365 debug("stalled ->clearing endpoint" \
366 "halt for pipe 0x%x\n", pipe);
367 stat = us->pusb_dev->status;
368 usb_clear_halt(us->pusb_dev, pipe);
369 us->pusb_dev->status = stat;
370 if (this_xfer == partial) {
371 debug("bulk transferred" \
374 us->pusb_dev->status);
380 if (us->pusb_dev->status & USB_ST_NAK_REC) {
381 debug("Device NAKed bulk_msg\n");
384 debug("bulk transferred with error");
385 if (this_xfer == partial) {
386 debug(" %ld, but data ok\n",
387 us->pusb_dev->status);
390 /* if our try counter reaches 0, bail out */
391 debug(" %ld, data %d\n",
392 us->pusb_dev->status, partial);
396 /* update to show what data was transferred */
397 this_xfer -= partial;
399 /* continue until this transfer is done */
403 /* if we get here, we're done and successful */
407 static int usb_stor_BBB_reset(struct us_data *us)
413 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
415 * For Reset Recovery the host shall issue in the following order:
416 * a) a Bulk-Only Mass Storage Reset
417 * b) a Clear Feature HALT to the Bulk-In endpoint
418 * c) a Clear Feature HALT to the Bulk-Out endpoint
420 * This is done in 3 steps.
422 * If the reset doesn't succeed, the device should be port reset.
424 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
426 debug("BBB_reset\n");
427 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
429 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
430 0, us->ifnum, NULL, 0, USB_CNTL_TIMEOUT * 5);
432 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
433 debug("RESET:stall\n");
437 /* long wait for reset */
439 debug("BBB_reset result %d: status %lX reset\n",
440 result, us->pusb_dev->status);
441 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
442 result = usb_clear_halt(us->pusb_dev, pipe);
443 /* long wait for reset */
445 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
446 result, us->pusb_dev->status);
447 /* long wait for reset */
448 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
449 result = usb_clear_halt(us->pusb_dev, pipe);
451 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
452 result, us->pusb_dev->status);
453 debug("BBB_reset done\n");
457 /* FIXME: this reset function doesn't really reset the port, and it
458 * should. Actually it should probably do what it's doing here, and
459 * reset the port physically
461 static int usb_stor_CB_reset(struct us_data *us)
463 unsigned char cmd[12];
467 memset(cmd, 0xff, sizeof(cmd));
468 cmd[0] = SCSI_SEND_DIAG;
470 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
472 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
473 0, us->ifnum, cmd, sizeof(cmd),
474 USB_CNTL_TIMEOUT * 5);
476 /* long wait for reset */
478 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
479 result, us->pusb_dev->status);
480 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
481 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
483 debug("CB_reset done\n");
488 * Set up the command for a BBB device. Note that the actual SCSI
489 * command is copied into cbw.CBWCDB.
491 static int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
497 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_cbw_t, cbw, 1);
499 dir_in = US_DIRECTION(srb->cmd[0]);
501 #ifdef BBB_COMDAT_TRACE
502 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
503 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
506 for (result = 0; result < srb->cmdlen; result++)
507 printf("cmd[%d] %#x ", result, srb->cmd[result]);
512 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
513 debug("usb_stor_BBB_comdat:cmdlen too large\n");
517 /* always OUT to the ep */
518 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
520 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
521 cbw->dCBWTag = cpu_to_le32(CBWTag++);
522 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
523 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
524 cbw->bCBWLUN = srb->lun;
525 cbw->bCDBLength = srb->cmdlen;
526 /* copy the command data into the CBW command data buffer */
528 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
529 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
530 &actlen, USB_CNTL_TIMEOUT * 5);
532 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
536 /* FIXME: we also need a CBI_command which sets up the completion
537 * interrupt, and waits for it
539 static int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
544 unsigned long status;
547 dir_in = US_DIRECTION(srb->cmd[0]);
550 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
552 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
555 debug("CBI gets a command: Try %d\n", 5 - retry);
559 /* let's send the command via the control pipe */
560 result = usb_control_msg(us->pusb_dev,
561 usb_sndctrlpipe(us->pusb_dev , 0),
563 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
565 srb->cmd, srb->cmdlen,
566 USB_CNTL_TIMEOUT * 5);
567 debug("CB_transport: control msg returned %d, status %lX\n",
568 result, us->pusb_dev->status);
569 /* check the return code for the command */
571 if (us->pusb_dev->status & USB_ST_STALLED) {
572 status = us->pusb_dev->status;
573 debug(" stall during command found," \
575 usb_clear_halt(us->pusb_dev,
576 usb_sndctrlpipe(us->pusb_dev, 0));
577 us->pusb_dev->status = status;
579 debug(" error during command %02X" \
580 " Stat = %lX\n", srb->cmd[0],
581 us->pusb_dev->status);
584 /* transfer the data payload for this command, if one exists*/
586 debug("CB_transport: control msg returned %d," \
587 " direction is %s to go 0x%lx\n", result,
588 dir_in ? "IN" : "OUT", srb->datalen);
590 result = us_one_transfer(us, pipe, (char *)srb->pdata,
592 debug("CBI attempted to transfer data," \
593 " result is %d status %lX, len %d\n",
594 result, us->pusb_dev->status,
595 us->pusb_dev->act_len);
596 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
598 } /* if (srb->datalen) */
608 static int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
613 submit_int_msg(us->pusb_dev, us->irqpipe,
614 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
617 if ((volatile int *) us->ip_wanted == NULL)
622 printf(" Did not get interrupt on CBI\n");
624 return USB_STOR_TRANSPORT_ERROR;
626 debug("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
627 us->ip_data, us->pusb_dev->irq_act_len,
628 us->pusb_dev->irq_status);
629 /* UFI gives us ASC and ASCQ, like a request sense */
630 if (us->subclass == US_SC_UFI) {
631 if (srb->cmd[0] == SCSI_REQ_SENSE ||
632 srb->cmd[0] == SCSI_INQUIRY)
633 return USB_STOR_TRANSPORT_GOOD; /* Good */
634 else if (us->ip_data)
635 return USB_STOR_TRANSPORT_FAILED;
637 return USB_STOR_TRANSPORT_GOOD;
639 /* otherwise, we interpret the data normally */
640 switch (us->ip_data) {
642 return USB_STOR_TRANSPORT_GOOD;
644 return USB_STOR_TRANSPORT_FAILED;
646 return USB_STOR_TRANSPORT_ERROR;
648 return USB_STOR_TRANSPORT_ERROR;
651 #define USB_TRANSPORT_UNKNOWN_RETRY 5
652 #define USB_TRANSPORT_NOT_READY_RETRY 10
654 /* clear a stall on an endpoint - special for BBB devices */
655 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
659 /* ENDPOINT_HALT = 0, so set value to 0 */
660 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
661 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
662 0, endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
666 static int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
670 int actlen, data_actlen;
671 unsigned int pipe, pipein, pipeout;
672 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_csw_t, csw, 1);
673 #ifdef BBB_XPORT_TRACE
678 dir_in = US_DIRECTION(srb->cmd[0]);
681 debug("COMMAND phase\n");
682 result = usb_stor_BBB_comdat(srb, us);
684 debug("failed to send CBW status %ld\n",
685 us->pusb_dev->status);
686 usb_stor_BBB_reset(us);
687 return USB_STOR_TRANSPORT_FAILED;
689 if (!(us->flags & USB_READY))
691 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
692 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
693 /* DATA phase + error handling */
695 /* no data, go immediately to the STATUS phase */
696 if (srb->datalen == 0)
698 debug("DATA phase\n");
703 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
704 &data_actlen, USB_CNTL_TIMEOUT * 5);
705 /* special handling of STALL in DATA phase */
706 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
707 debug("DATA:stall\n");
708 /* clear the STALL on the endpoint */
709 result = usb_stor_BBB_clear_endpt_stall(us,
710 dir_in ? us->ep_in : us->ep_out);
712 /* continue on to STATUS phase */
716 debug("usb_bulk_msg error status %ld\n",
717 us->pusb_dev->status);
718 usb_stor_BBB_reset(us);
719 return USB_STOR_TRANSPORT_FAILED;
721 #ifdef BBB_XPORT_TRACE
722 for (index = 0; index < data_actlen; index++)
723 printf("pdata[%d] %#x ", index, srb->pdata[index]);
726 /* STATUS phase + error handling */
730 debug("STATUS phase\n");
731 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
732 &actlen, USB_CNTL_TIMEOUT*5);
734 /* special handling of STALL in STATUS phase */
735 if ((result < 0) && (retry < 1) &&
736 (us->pusb_dev->status & USB_ST_STALLED)) {
737 debug("STATUS:stall\n");
738 /* clear the STALL on the endpoint */
739 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
740 if (result >= 0 && (retry++ < 1))
745 debug("usb_bulk_msg error status %ld\n",
746 us->pusb_dev->status);
747 usb_stor_BBB_reset(us);
748 return USB_STOR_TRANSPORT_FAILED;
750 #ifdef BBB_XPORT_TRACE
751 ptr = (unsigned char *)csw;
752 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
753 printf("ptr[%d] %#x ", index, ptr[index]);
756 /* misuse pipe to get the residue */
757 pipe = le32_to_cpu(csw->dCSWDataResidue);
758 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
759 pipe = srb->datalen - data_actlen;
760 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
761 debug("!CSWSIGNATURE\n");
762 usb_stor_BBB_reset(us);
763 return USB_STOR_TRANSPORT_FAILED;
764 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
766 usb_stor_BBB_reset(us);
767 return USB_STOR_TRANSPORT_FAILED;
768 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
770 usb_stor_BBB_reset(us);
771 return USB_STOR_TRANSPORT_FAILED;
772 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
774 usb_stor_BBB_reset(us);
775 return USB_STOR_TRANSPORT_FAILED;
776 } else if (data_actlen > srb->datalen) {
777 debug("transferred %dB instead of %ldB\n",
778 data_actlen, srb->datalen);
779 return USB_STOR_TRANSPORT_FAILED;
780 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
782 return USB_STOR_TRANSPORT_FAILED;
788 static int usb_stor_CB_transport(ccb *srb, struct us_data *us)
796 status = USB_STOR_TRANSPORT_GOOD;
799 /* issue the command */
801 result = usb_stor_CB_comdat(srb, us);
802 debug("command / Data returned %d, status %lX\n",
803 result, us->pusb_dev->status);
804 /* if this is an CBI Protocol, get IRQ */
805 if (us->protocol == US_PR_CBI) {
806 status = usb_stor_CBI_get_status(srb, us);
807 /* if the status is error, report it */
808 if (status == USB_STOR_TRANSPORT_ERROR) {
809 debug(" USB CBI Command Error\n");
812 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
813 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
815 /* if the status is good, report it */
816 if (status == USB_STOR_TRANSPORT_GOOD) {
817 debug(" USB CBI Command Good\n");
822 /* do we have to issue an auto request? */
823 /* HERE we have to check the result */
824 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
825 debug("ERROR %lX\n", us->pusb_dev->status);
826 us->transport_reset(us);
827 return USB_STOR_TRANSPORT_ERROR;
829 if ((us->protocol == US_PR_CBI) &&
830 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
831 (srb->cmd[0] == SCSI_INQUIRY))) {
832 /* do not issue an autorequest after request sense */
833 debug("No auto request and good\n");
834 return USB_STOR_TRANSPORT_GOOD;
836 /* issue an request_sense */
837 memset(&psrb->cmd[0], 0, 12);
838 psrb->cmd[0] = SCSI_REQ_SENSE;
839 psrb->cmd[1] = srb->lun << 5;
842 psrb->pdata = &srb->sense_buf[0];
844 /* issue the command */
845 result = usb_stor_CB_comdat(psrb, us);
846 debug("auto request returned %d\n", result);
847 /* if this is an CBI Protocol, get IRQ */
848 if (us->protocol == US_PR_CBI)
849 status = usb_stor_CBI_get_status(psrb, us);
851 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
852 debug(" AUTO REQUEST ERROR %ld\n",
853 us->pusb_dev->status);
854 return USB_STOR_TRANSPORT_ERROR;
856 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
857 srb->sense_buf[0], srb->sense_buf[2],
858 srb->sense_buf[12], srb->sense_buf[13]);
859 /* Check the auto request result */
860 if ((srb->sense_buf[2] == 0) &&
861 (srb->sense_buf[12] == 0) &&
862 (srb->sense_buf[13] == 0)) {
864 return USB_STOR_TRANSPORT_GOOD;
867 /* Check the auto request result */
868 switch (srb->sense_buf[2]) {
870 /* Recovered Error */
871 return USB_STOR_TRANSPORT_GOOD;
875 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
876 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
877 " 0x%02X (NOT READY)\n", srb->cmd[0],
878 srb->sense_buf[0], srb->sense_buf[2],
879 srb->sense_buf[12], srb->sense_buf[13]);
880 return USB_STOR_TRANSPORT_FAILED;
887 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
888 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
889 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
890 srb->sense_buf[2], srb->sense_buf[12],
892 return USB_STOR_TRANSPORT_FAILED;
897 return USB_STOR_TRANSPORT_FAILED;
901 static int usb_inquiry(ccb *srb, struct us_data *ss)
906 memset(&srb->cmd[0], 0, 12);
907 srb->cmd[0] = SCSI_INQUIRY;
908 srb->cmd[1] = srb->lun << 5;
912 i = ss->transport(srb, ss);
913 debug("inquiry returns %d\n", i);
919 printf("error in inquiry\n");
925 static int usb_request_sense(ccb *srb, struct us_data *ss)
929 ptr = (char *)srb->pdata;
930 memset(&srb->cmd[0], 0, 12);
931 srb->cmd[0] = SCSI_REQ_SENSE;
932 srb->cmd[1] = srb->lun << 5;
935 srb->pdata = &srb->sense_buf[0];
937 ss->transport(srb, ss);
938 debug("Request Sense returned %02X %02X %02X\n",
939 srb->sense_buf[2], srb->sense_buf[12],
941 srb->pdata = (uchar *)ptr;
945 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
950 memset(&srb->cmd[0], 0, 12);
951 srb->cmd[0] = SCSI_TST_U_RDY;
952 srb->cmd[1] = srb->lun << 5;
955 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
956 ss->flags |= USB_READY;
959 usb_request_sense(srb, ss);
961 * Check the Key Code Qualifier, if it matches
962 * "Not Ready - medium not present"
963 * (the sense Key equals 0x2 and the ASC is 0x3a)
964 * return immediately as the medium being absent won't change
965 * unless there is a user action.
967 if ((srb->sense_buf[2] == 0x02) &&
968 (srb->sense_buf[12] == 0x3a))
976 static int usb_read_capacity(ccb *srb, struct us_data *ss)
982 memset(&srb->cmd[0], 0, 12);
983 srb->cmd[0] = SCSI_RD_CAPAC;
984 srb->cmd[1] = srb->lun << 5;
987 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
994 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
995 unsigned short blocks)
997 memset(&srb->cmd[0], 0, 12);
998 srb->cmd[0] = SCSI_READ10;
999 srb->cmd[1] = srb->lun << 5;
1000 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1001 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1002 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1003 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1004 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1005 srb->cmd[8] = (unsigned char) blocks & 0xff;
1007 debug("read10: start %lx blocks %x\n", start, blocks);
1008 return ss->transport(srb, ss);
1011 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
1012 unsigned short blocks)
1014 memset(&srb->cmd[0], 0, 12);
1015 srb->cmd[0] = SCSI_WRITE10;
1016 srb->cmd[1] = srb->lun << 5;
1017 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1018 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1019 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1020 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1021 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1022 srb->cmd[8] = (unsigned char) blocks & 0xff;
1024 debug("write10: start %lx blocks %x\n", start, blocks);
1025 return ss->transport(srb, ss);
1029 #ifdef CONFIG_USB_BIN_FIXUP
1031 * Some USB storage devices queried for SCSI identification data respond with
1032 * binary strings, which if output to the console freeze the terminal. The
1033 * workaround is to modify the vendor and product strings read from such
1034 * device with proper values (as reported by 'usb info').
1036 * Vendor and product length limits are taken from the definition of
1037 * block_dev_desc_t in include/part.h.
1039 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1040 unsigned char vendor[],
1041 unsigned char product[]) {
1042 const unsigned char max_vendor_len = 40;
1043 const unsigned char max_product_len = 20;
1044 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1045 strncpy((char *)vendor, "SMSC", max_vendor_len);
1046 strncpy((char *)product, "Flash Media Cntrller",
1050 #endif /* CONFIG_USB_BIN_FIXUP */
1052 unsigned long usb_stor_read(int device, lbaint_t blknr,
1053 lbaint_t blkcnt, void *buffer)
1055 lbaint_t start, blks;
1057 unsigned short smallblks;
1058 struct usb_device *dev;
1061 ccb *srb = &usb_ccb;
1068 debug("\nusb_read: dev %d \n", device);
1070 for (i = 0; i < USB_MAX_DEVICE; i++) {
1071 dev = usb_get_dev_index(i);
1074 if (dev->devnum == usb_dev_desc[device].target)
1077 ss = (struct us_data *)dev->privptr;
1079 usb_disable_asynch(1); /* asynch transfer not allowed */
1080 srb->lun = usb_dev_desc[device].lun;
1081 buf_addr = (unsigned long)buffer;
1085 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF
1086 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1089 /* XXX need some comment here */
1091 srb->pdata = (unsigned char *)buf_addr;
1092 if (blks > USB_MAX_XFER_BLK)
1093 smallblks = USB_MAX_XFER_BLK;
1095 smallblks = (unsigned short) blks;
1097 if (smallblks == USB_MAX_XFER_BLK)
1098 usb_show_progress();
1099 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1100 srb->pdata = (unsigned char *)buf_addr;
1101 if (usb_read_10(srb, ss, start, smallblks)) {
1102 debug("Read ERROR\n");
1103 usb_request_sense(srb, ss);
1111 buf_addr += srb->datalen;
1112 } while (blks != 0);
1113 ss->flags &= ~USB_READY;
1115 debug("usb_read: end startblk " LBAF
1116 ", blccnt %x buffer %" PRIxPTR "\n",
1117 start, smallblks, buf_addr);
1119 usb_disable_asynch(0); /* asynch transfer allowed */
1120 if (blkcnt >= USB_MAX_XFER_BLK)
1125 unsigned long usb_stor_write(int device, lbaint_t blknr,
1126 lbaint_t blkcnt, const void *buffer)
1128 lbaint_t start, blks;
1130 unsigned short smallblks;
1131 struct usb_device *dev;
1134 ccb *srb = &usb_ccb;
1141 debug("\nusb_write: dev %d \n", device);
1143 for (i = 0; i < USB_MAX_DEVICE; i++) {
1144 dev = usb_get_dev_index(i);
1147 if (dev->devnum == usb_dev_desc[device].target)
1150 ss = (struct us_data *)dev->privptr;
1152 usb_disable_asynch(1); /* asynch transfer not allowed */
1154 srb->lun = usb_dev_desc[device].lun;
1155 buf_addr = (unsigned long)buffer;
1159 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF
1160 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1163 /* If write fails retry for max retry count else
1164 * return with number of blocks written successfully.
1167 srb->pdata = (unsigned char *)buf_addr;
1168 if (blks > USB_MAX_XFER_BLK)
1169 smallblks = USB_MAX_XFER_BLK;
1171 smallblks = (unsigned short) blks;
1173 if (smallblks == USB_MAX_XFER_BLK)
1174 usb_show_progress();
1175 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1176 srb->pdata = (unsigned char *)buf_addr;
1177 if (usb_write_10(srb, ss, start, smallblks)) {
1178 debug("Write ERROR\n");
1179 usb_request_sense(srb, ss);
1187 buf_addr += srb->datalen;
1188 } while (blks != 0);
1189 ss->flags &= ~USB_READY;
1191 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %"
1192 PRIxPTR "\n", start, smallblks, buf_addr);
1194 usb_disable_asynch(0); /* asynch transfer allowed */
1195 if (blkcnt >= USB_MAX_XFER_BLK)
1201 /* Probe to see if a new device is actually a Storage device */
1202 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1205 struct usb_interface *iface;
1207 struct usb_endpoint_descriptor *ep_desc;
1208 unsigned int flags = 0;
1213 /* let's examine the device now */
1214 iface = &dev->config.if_desc[ifnum];
1217 /* this is the place to patch some storage devices */
1218 debug("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1219 dev->descriptor.idProduct);
1221 if ((dev->descriptor.idVendor) == 0x066b &&
1222 (dev->descriptor.idProduct) == 0x0103) {
1223 debug("patched for E-USB\n");
1224 protocol = US_PR_CB;
1225 subclass = US_SC_UFI; /* an assumption */
1229 if (dev->descriptor.bDeviceClass != 0 ||
1230 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1231 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1232 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1233 /* if it's not a mass storage, we go no further */
1237 memset(ss, 0, sizeof(struct us_data));
1239 /* At this point, we know we've got a live one */
1240 debug("\n\nUSB Mass Storage device detected\n");
1242 /* Initialize the us_data structure with some useful info */
1246 ss->attention_done = 0;
1248 /* If the device has subclass and protocol, then use that. Otherwise,
1249 * take data from the specific interface.
1252 ss->subclass = subclass;
1253 ss->protocol = protocol;
1255 ss->subclass = iface->desc.bInterfaceSubClass;
1256 ss->protocol = iface->desc.bInterfaceProtocol;
1259 /* set the handler pointers based on the protocol */
1260 debug("Transport: ");
1261 switch (ss->protocol) {
1263 debug("Control/Bulk\n");
1264 ss->transport = usb_stor_CB_transport;
1265 ss->transport_reset = usb_stor_CB_reset;
1269 debug("Control/Bulk/Interrupt\n");
1270 ss->transport = usb_stor_CB_transport;
1271 ss->transport_reset = usb_stor_CB_reset;
1274 debug("Bulk/Bulk/Bulk\n");
1275 ss->transport = usb_stor_BBB_transport;
1276 ss->transport_reset = usb_stor_BBB_reset;
1279 printf("USB Storage Transport unknown / not yet implemented\n");
1285 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1286 * An optional interrupt is OK (necessary for CBI protocol).
1287 * We will ignore any others.
1289 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1290 ep_desc = &iface->ep_desc[i];
1291 /* is it an BULK endpoint? */
1292 if ((ep_desc->bmAttributes &
1293 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1294 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1295 ss->ep_in = ep_desc->bEndpointAddress &
1296 USB_ENDPOINT_NUMBER_MASK;
1299 ep_desc->bEndpointAddress &
1300 USB_ENDPOINT_NUMBER_MASK;
1303 /* is it an interrupt endpoint? */
1304 if ((ep_desc->bmAttributes &
1305 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1306 ss->ep_int = ep_desc->bEndpointAddress &
1307 USB_ENDPOINT_NUMBER_MASK;
1308 ss->irqinterval = ep_desc->bInterval;
1311 debug("Endpoints In %d Out %d Int %d\n",
1312 ss->ep_in, ss->ep_out, ss->ep_int);
1314 /* Do some basic sanity checks, and bail if we find a problem */
1315 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1316 !ss->ep_in || !ss->ep_out ||
1317 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1318 debug("Problems with device\n");
1321 /* set class specific stuff */
1322 /* We only handle certain protocols. Currently, these are
1324 * The SFF8070 accepts the requests used in u-boot
1326 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1327 ss->subclass != US_SC_8070) {
1328 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1332 /* we had found an interrupt endpoint, prepare irq pipe
1333 * set up the IRQ pipe and handler
1335 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1336 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1337 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1338 dev->irq_handle = usb_stor_irq;
1340 dev->privptr = (void *)ss;
1344 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1345 block_dev_desc_t *dev_desc)
1347 unsigned char perq, modi;
1348 ALLOC_CACHE_ALIGN_BUFFER(unsigned long, cap, 2);
1349 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, usb_stor_buf, 36);
1350 unsigned long *capacity, *blksz;
1351 ccb *pccb = &usb_ccb;
1353 pccb->pdata = usb_stor_buf;
1355 dev_desc->target = dev->devnum;
1356 pccb->lun = dev_desc->lun;
1357 debug(" address %d\n", dev_desc->target);
1359 if (usb_inquiry(pccb, ss))
1362 perq = usb_stor_buf[0];
1363 modi = usb_stor_buf[1];
1366 * Skip unknown devices (0x1f) and enclosure service devices (0x0d),
1367 * they would not respond to test_unit_ready .
1369 if (((perq & 0x1f) == 0x1f) || ((perq & 0x1f) == 0x0d)) {
1372 if ((modi&0x80) == 0x80) {
1373 /* drive is removable */
1374 dev_desc->removable = 1;
1376 memcpy(&dev_desc->vendor[0], (const void *) &usb_stor_buf[8], 8);
1377 memcpy(&dev_desc->product[0], (const void *) &usb_stor_buf[16], 16);
1378 memcpy(&dev_desc->revision[0], (const void *) &usb_stor_buf[32], 4);
1379 dev_desc->vendor[8] = 0;
1380 dev_desc->product[16] = 0;
1381 dev_desc->revision[4] = 0;
1382 #ifdef CONFIG_USB_BIN_FIXUP
1383 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1384 (uchar *)dev_desc->product);
1385 #endif /* CONFIG_USB_BIN_FIXUP */
1386 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1388 if (usb_test_unit_ready(pccb, ss)) {
1389 printf("Device NOT ready\n"
1390 " Request Sense returned %02X %02X %02X\n",
1391 pccb->sense_buf[2], pccb->sense_buf[12],
1392 pccb->sense_buf[13]);
1393 if (dev_desc->removable == 1) {
1394 dev_desc->type = perq;
1399 pccb->pdata = (unsigned char *)&cap[0];
1400 memset(pccb->pdata, 0, 8);
1401 if (usb_read_capacity(pccb, ss) != 0) {
1402 printf("READ_CAP ERROR\n");
1406 ss->flags &= ~USB_READY;
1407 debug("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0], cap[1]);
1409 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1412 cap[0] = cpu_to_be32(cap[0]);
1413 cap[1] = cpu_to_be32(cap[1]);
1415 /* this assumes bigendian! */
1419 debug("Capacity = 0x%lx, blocksz = 0x%lx\n", *capacity, *blksz);
1420 dev_desc->lba = *capacity;
1421 dev_desc->blksz = *blksz;
1422 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1423 dev_desc->type = perq;
1424 debug(" address %d\n", dev_desc->target);
1425 debug("partype: %d\n", dev_desc->part_type);
1427 init_part(dev_desc);
1429 debug("partype: %d\n", dev_desc->part_type);