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
12 * Driver model conversion:
13 * (C) Copyright 2015 Google, Inc
15 * For BBB support (C) Copyright 2003
16 * Gary Jennejohn, DENX Software Engineering <garyj@denx.de>
18 * BBB support based on /sys/dev/usb/umass.c from
21 * SPDX-License-Identifier: GPL-2.0+
25 * Currently only the CBI transport protocoll has been implemented, and it
26 * is only tested with a TEAC USB Floppy. Other Massstorages with CBI or CB
27 * transport protocoll may work as well.
31 * Support for USB Mass Storage Devices (BBB) has been added. It has
32 * only been tested with USB memory sticks.
43 #include <asm/byteorder.h>
44 #include <asm/processor.h>
45 #include <dm/device-internal.h>
51 #undef BBB_COMDAT_TRACE
52 #undef BBB_XPORT_TRACE
55 /* direction table -- this indicates the direction of the data
56 * transfer for each command code -- a 1 indicates input
58 static const unsigned char us_direction[256/8] = {
59 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
60 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
61 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
62 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
64 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
66 static struct scsi_cmd usb_ccb __aligned(ARCH_DMA_MINALIGN);
69 static int usb_max_devs; /* number of highest available usb device */
72 static struct blk_desc usb_dev_desc[USB_MAX_STOR_DEV];
76 typedef int (*trans_cmnd)(struct scsi_cmd *cb, struct us_data *data);
77 typedef int (*trans_reset)(struct us_data *data);
80 struct usb_device *pusb_dev; /* this usb_device */
82 unsigned int flags; /* from filter initially */
83 # define USB_READY (1 << 0)
84 unsigned char ifnum; /* interface number */
85 unsigned char ep_in; /* in endpoint */
86 unsigned char ep_out; /* out ....... */
87 unsigned char ep_int; /* interrupt . */
88 unsigned char subclass; /* as in overview */
89 unsigned char protocol; /* .............. */
90 unsigned char attention_done; /* force attn on first cmd */
91 unsigned short ip_data; /* interrupt data */
92 int action; /* what to do */
93 int ip_wanted; /* needed */
94 int *irq_handle; /* for USB int requests */
95 unsigned int irqpipe; /* pipe for release_irq */
96 unsigned char irqmaxp; /* max packed for irq Pipe */
97 unsigned char irqinterval; /* Intervall for IRQ Pipe */
98 struct scsi_cmd *srb; /* current srb */
99 trans_reset transport_reset; /* reset routine */
100 trans_cmnd transport; /* transport routine */
101 unsigned short max_xfer_blk; /* maximum transfer blocks */
105 static struct us_data usb_stor[USB_MAX_STOR_DEV];
108 #define USB_STOR_TRANSPORT_GOOD 0
109 #define USB_STOR_TRANSPORT_FAILED -1
110 #define USB_STOR_TRANSPORT_ERROR -2
112 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
113 struct blk_desc *dev_desc);
114 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
117 static unsigned long usb_stor_read(struct udevice *dev, lbaint_t blknr,
118 lbaint_t blkcnt, void *buffer);
119 static unsigned long usb_stor_write(struct udevice *dev, lbaint_t blknr,
120 lbaint_t blkcnt, const void *buffer);
122 static unsigned long usb_stor_read(struct blk_desc *block_dev, lbaint_t blknr,
123 lbaint_t blkcnt, void *buffer);
124 static unsigned long usb_stor_write(struct blk_desc *block_dev, lbaint_t blknr,
125 lbaint_t blkcnt, const void *buffer);
127 void uhci_show_temp_int_td(void);
129 static void usb_show_progress(void)
134 /*******************************************************************************
135 * show info on storage devices; 'usb start/init' must be invoked earlier
136 * as we only retrieve structures populated during devices initialization
138 int usb_stor_info(void)
144 for (blk_first_device(IF_TYPE_USB, &dev);
146 blk_next_device(&dev)) {
147 struct blk_desc *desc = dev_get_uclass_platdata(dev);
149 printf(" Device %d: ", desc->devnum);
156 if (usb_max_devs > 0) {
157 for (i = 0; i < usb_max_devs; i++) {
158 printf(" Device %d: ", i);
159 dev_print(&usb_dev_desc[i]);
165 printf("No storage devices, perhaps not 'usb start'ed..?\n");
172 static unsigned int usb_get_max_lun(struct us_data *us)
175 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
176 len = usb_control_msg(us->pusb_dev,
177 usb_rcvctrlpipe(us->pusb_dev, 0),
179 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
181 result, sizeof(char),
182 USB_CNTL_TIMEOUT * 5);
183 debug("Get Max LUN -> len = %i, result = %i\n", len, (int) *result);
184 return (len > 0) ? *result : 0;
187 static int usb_stor_probe_device(struct usb_device *udev)
192 struct us_data *data;
198 return -ENOENT; /* no more devices available */
201 debug("\n\nProbing for storage\n");
204 * We store the us_data in the mass storage device's platdata. It
205 * is shared by all LUNs (block devices) attached to this mass storage
208 data = dev_get_platdata(udev->dev);
209 if (!usb_storage_probe(udev, 0, data))
211 max_lun = usb_get_max_lun(data);
212 for (lun = 0; lun <= max_lun; lun++) {
213 struct blk_desc *blkdev;
217 snprintf(str, sizeof(str), "lun%d", lun);
218 ret = blk_create_devicef(udev->dev, "usb_storage_blk", str,
219 IF_TYPE_USB, usb_max_devs, 512, 0,
222 debug("Cannot bind driver\n");
226 blkdev = dev_get_uclass_platdata(dev);
227 blkdev->target = 0xff;
230 ret = usb_stor_get_info(udev, data, blkdev);
232 ret = blk_prepare_device(dev);
235 debug("%s: Found device %p\n", __func__, udev);
237 debug("usb_stor_get_info: Invalid device\n");
238 ret = device_unbind(dev);
244 /* We don't have space to even probe if we hit the maximum */
245 if (usb_max_devs == USB_MAX_STOR_DEV) {
246 printf("max USB Storage Device reached: %d stopping\n",
251 if (!usb_storage_probe(udev, 0, &usb_stor[usb_max_devs]))
255 * OK, it's a storage device. Iterate over its LUNs and populate
258 start = usb_max_devs;
260 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
261 for (lun = 0; lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
263 struct blk_desc *blkdev;
265 blkdev = &usb_dev_desc[usb_max_devs];
266 memset(blkdev, '\0', sizeof(struct blk_desc));
267 blkdev->if_type = IF_TYPE_USB;
268 blkdev->devnum = usb_max_devs;
269 blkdev->part_type = PART_TYPE_UNKNOWN;
270 blkdev->target = 0xff;
271 blkdev->type = DEV_TYPE_UNKNOWN;
272 blkdev->block_read = usb_stor_read;
273 blkdev->block_write = usb_stor_write;
277 if (usb_stor_get_info(udev, &usb_stor[start],
278 &usb_dev_desc[usb_max_devs]) == 1) {
279 debug("partype: %d\n", blkdev->part_type);
281 debug("partype: %d\n", blkdev->part_type);
283 debug("%s: Found device %p\n", __func__, udev);
291 void usb_stor_reset(void)
296 /*******************************************************************************
297 * scan the usb and reports device info
298 * to the user if mode = 1
299 * returns current device or -1 if no
301 int usb_stor_scan(int mode)
304 printf(" scanning usb for storage devices... ");
306 #ifndef CONFIG_DM_USB
309 usb_disable_asynch(1); /* asynch transfer not allowed */
312 for (i = 0; i < USB_MAX_DEVICE; i++) {
313 struct usb_device *dev;
315 dev = usb_get_dev_index(i); /* get device */
317 if (usb_stor_probe_device(dev))
321 usb_disable_asynch(0); /* asynch transfer allowed */
323 printf("%d Storage Device(s) found\n", usb_max_devs);
324 if (usb_max_devs > 0)
329 static int usb_stor_irq(struct usb_device *dev)
332 us = (struct us_data *)dev->privptr;
342 static void usb_show_srb(struct scsi_cmd *pccb)
345 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
346 for (i = 0; i < 12; i++)
347 printf("%02X ", pccb->cmd[i]);
351 static void display_int_status(unsigned long tmp)
353 printf("Status: %s %s %s %s %s %s %s\n",
354 (tmp & USB_ST_ACTIVE) ? "Active" : "",
355 (tmp & USB_ST_STALLED) ? "Stalled" : "",
356 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
357 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
358 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
359 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
360 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
363 /***********************************************************************
364 * Data transfer routines
365 ***********************************************************************/
367 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
376 /* determine the maximum packet size for these transfers */
377 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
379 /* while we have data left to transfer */
382 /* calculate how long this will be -- maximum or a remainder */
383 this_xfer = length > max_size ? max_size : length;
386 /* setup the retry counter */
389 /* set up the transfer loop */
391 /* transfer the data */
392 debug("Bulk xfer 0x%lx(%d) try #%d\n",
393 (ulong)map_to_sysmem(buf), this_xfer,
395 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
397 USB_CNTL_TIMEOUT * 5);
398 debug("bulk_msg returned %d xferred %d/%d\n",
399 result, partial, this_xfer);
400 if (us->pusb_dev->status != 0) {
401 /* if we stall, we need to clear it before
405 display_int_status(us->pusb_dev->status);
407 if (us->pusb_dev->status & USB_ST_STALLED) {
408 debug("stalled ->clearing endpoint" \
409 "halt for pipe 0x%x\n", pipe);
410 stat = us->pusb_dev->status;
411 usb_clear_halt(us->pusb_dev, pipe);
412 us->pusb_dev->status = stat;
413 if (this_xfer == partial) {
414 debug("bulk transferred" \
417 us->pusb_dev->status);
423 if (us->pusb_dev->status & USB_ST_NAK_REC) {
424 debug("Device NAKed bulk_msg\n");
427 debug("bulk transferred with error");
428 if (this_xfer == partial) {
429 debug(" %ld, but data ok\n",
430 us->pusb_dev->status);
433 /* if our try counter reaches 0, bail out */
434 debug(" %ld, data %d\n",
435 us->pusb_dev->status, partial);
439 /* update to show what data was transferred */
440 this_xfer -= partial;
442 /* continue until this transfer is done */
446 /* if we get here, we're done and successful */
450 static int usb_stor_BBB_reset(struct us_data *us)
456 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
458 * For Reset Recovery the host shall issue in the following order:
459 * a) a Bulk-Only Mass Storage Reset
460 * b) a Clear Feature HALT to the Bulk-In endpoint
461 * c) a Clear Feature HALT to the Bulk-Out endpoint
463 * This is done in 3 steps.
465 * If the reset doesn't succeed, the device should be port reset.
467 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
469 debug("BBB_reset\n");
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, NULL, 0, USB_CNTL_TIMEOUT * 5);
475 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
476 debug("RESET:stall\n");
480 /* long wait for reset */
482 debug("BBB_reset result %d: status %lX reset\n",
483 result, us->pusb_dev->status);
484 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
485 result = usb_clear_halt(us->pusb_dev, pipe);
486 /* long wait for reset */
488 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
489 result, us->pusb_dev->status);
490 /* long wait for reset */
491 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
492 result = usb_clear_halt(us->pusb_dev, pipe);
494 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
495 result, us->pusb_dev->status);
496 debug("BBB_reset done\n");
500 /* FIXME: this reset function doesn't really reset the port, and it
501 * should. Actually it should probably do what it's doing here, and
502 * reset the port physically
504 static int usb_stor_CB_reset(struct us_data *us)
506 unsigned char cmd[12];
510 memset(cmd, 0xff, sizeof(cmd));
511 cmd[0] = SCSI_SEND_DIAG;
513 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
515 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
516 0, us->ifnum, cmd, sizeof(cmd),
517 USB_CNTL_TIMEOUT * 5);
519 /* long wait for reset */
521 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
522 result, us->pusb_dev->status);
523 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
524 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
526 debug("CB_reset done\n");
531 * Set up the command for a BBB device. Note that the actual SCSI
532 * command is copied into cbw.CBWCDB.
534 static int usb_stor_BBB_comdat(struct scsi_cmd *srb, struct us_data *us)
540 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_cbw, cbw, 1);
542 dir_in = US_DIRECTION(srb->cmd[0]);
544 #ifdef BBB_COMDAT_TRACE
545 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
546 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
549 for (result = 0; result < srb->cmdlen; result++)
550 printf("cmd[%d] %#x ", result, srb->cmd[result]);
555 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
556 debug("usb_stor_BBB_comdat:cmdlen too large\n");
560 /* always OUT to the ep */
561 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
563 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
564 cbw->dCBWTag = cpu_to_le32(CBWTag++);
565 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
566 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
567 cbw->bCBWLUN = srb->lun;
568 cbw->bCDBLength = srb->cmdlen;
569 /* copy the command data into the CBW command data buffer */
572 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
573 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
574 &actlen, USB_CNTL_TIMEOUT * 5);
576 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
580 /* FIXME: we also need a CBI_command which sets up the completion
581 * interrupt, and waits for it
583 static int usb_stor_CB_comdat(struct scsi_cmd *srb, struct us_data *us)
588 unsigned long status;
591 dir_in = US_DIRECTION(srb->cmd[0]);
594 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
596 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
599 debug("CBI gets a command: Try %d\n", 5 - retry);
603 /* let's send the command via the control pipe */
604 result = usb_control_msg(us->pusb_dev,
605 usb_sndctrlpipe(us->pusb_dev , 0),
607 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
609 srb->cmd, srb->cmdlen,
610 USB_CNTL_TIMEOUT * 5);
611 debug("CB_transport: control msg returned %d, status %lX\n",
612 result, us->pusb_dev->status);
613 /* check the return code for the command */
615 if (us->pusb_dev->status & USB_ST_STALLED) {
616 status = us->pusb_dev->status;
617 debug(" stall during command found," \
619 usb_clear_halt(us->pusb_dev,
620 usb_sndctrlpipe(us->pusb_dev, 0));
621 us->pusb_dev->status = status;
623 debug(" error during command %02X" \
624 " Stat = %lX\n", srb->cmd[0],
625 us->pusb_dev->status);
628 /* transfer the data payload for this command, if one exists*/
630 debug("CB_transport: control msg returned %d," \
631 " direction is %s to go 0x%lx\n", result,
632 dir_in ? "IN" : "OUT", srb->datalen);
634 result = us_one_transfer(us, pipe, (char *)srb->pdata,
636 debug("CBI attempted to transfer data," \
637 " result is %d status %lX, len %d\n",
638 result, us->pusb_dev->status,
639 us->pusb_dev->act_len);
640 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
642 } /* if (srb->datalen) */
652 static int usb_stor_CBI_get_status(struct scsi_cmd *srb, struct us_data *us)
657 submit_int_msg(us->pusb_dev, us->irqpipe,
658 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
661 if (us->ip_wanted == 0)
666 printf(" Did not get interrupt on CBI\n");
668 return USB_STOR_TRANSPORT_ERROR;
670 debug("Got interrupt data 0x%x, transferred %d status 0x%lX\n",
671 us->ip_data, us->pusb_dev->irq_act_len,
672 us->pusb_dev->irq_status);
673 /* UFI gives us ASC and ASCQ, like a request sense */
674 if (us->subclass == US_SC_UFI) {
675 if (srb->cmd[0] == SCSI_REQ_SENSE ||
676 srb->cmd[0] == SCSI_INQUIRY)
677 return USB_STOR_TRANSPORT_GOOD; /* Good */
678 else if (us->ip_data)
679 return USB_STOR_TRANSPORT_FAILED;
681 return USB_STOR_TRANSPORT_GOOD;
683 /* otherwise, we interpret the data normally */
684 switch (us->ip_data) {
686 return USB_STOR_TRANSPORT_GOOD;
688 return USB_STOR_TRANSPORT_FAILED;
690 return USB_STOR_TRANSPORT_ERROR;
692 return USB_STOR_TRANSPORT_ERROR;
695 #define USB_TRANSPORT_UNKNOWN_RETRY 5
696 #define USB_TRANSPORT_NOT_READY_RETRY 10
698 /* clear a stall on an endpoint - special for BBB devices */
699 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
701 /* ENDPOINT_HALT = 0, so set value to 0 */
702 return usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
703 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
704 endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
707 static int usb_stor_BBB_transport(struct scsi_cmd *srb, struct us_data *us)
711 int actlen, data_actlen;
712 unsigned int pipe, pipein, pipeout;
713 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_csw, csw, 1);
714 #ifdef BBB_XPORT_TRACE
719 dir_in = US_DIRECTION(srb->cmd[0]);
722 debug("COMMAND phase\n");
723 result = usb_stor_BBB_comdat(srb, us);
725 debug("failed to send CBW status %ld\n",
726 us->pusb_dev->status);
727 usb_stor_BBB_reset(us);
728 return USB_STOR_TRANSPORT_FAILED;
730 if (!(us->flags & USB_READY))
732 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
733 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
734 /* DATA phase + error handling */
736 /* no data, go immediately to the STATUS phase */
737 if (srb->datalen == 0)
739 debug("DATA phase\n");
745 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
746 &data_actlen, USB_CNTL_TIMEOUT * 5);
747 /* special handling of STALL in DATA phase */
748 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
749 debug("DATA:stall\n");
750 /* clear the STALL on the endpoint */
751 result = usb_stor_BBB_clear_endpt_stall(us,
752 dir_in ? us->ep_in : us->ep_out);
754 /* continue on to STATUS phase */
758 debug("usb_bulk_msg error status %ld\n",
759 us->pusb_dev->status);
760 usb_stor_BBB_reset(us);
761 return USB_STOR_TRANSPORT_FAILED;
763 #ifdef BBB_XPORT_TRACE
764 for (index = 0; index < data_actlen; index++)
765 printf("pdata[%d] %#x ", index, srb->pdata[index]);
768 /* STATUS phase + error handling */
772 debug("STATUS phase\n");
773 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
774 &actlen, USB_CNTL_TIMEOUT*5);
776 /* special handling of STALL in STATUS phase */
777 if ((result < 0) && (retry < 1) &&
778 (us->pusb_dev->status & USB_ST_STALLED)) {
779 debug("STATUS:stall\n");
780 /* clear the STALL on the endpoint */
781 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
782 if (result >= 0 && (retry++ < 1))
787 debug("usb_bulk_msg error status %ld\n",
788 us->pusb_dev->status);
789 usb_stor_BBB_reset(us);
790 return USB_STOR_TRANSPORT_FAILED;
792 #ifdef BBB_XPORT_TRACE
793 ptr = (unsigned char *)csw;
794 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
795 printf("ptr[%d] %#x ", index, ptr[index]);
798 /* misuse pipe to get the residue */
799 pipe = le32_to_cpu(csw->dCSWDataResidue);
800 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
801 pipe = srb->datalen - data_actlen;
802 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
803 debug("!CSWSIGNATURE\n");
804 usb_stor_BBB_reset(us);
805 return USB_STOR_TRANSPORT_FAILED;
806 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
808 usb_stor_BBB_reset(us);
809 return USB_STOR_TRANSPORT_FAILED;
810 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
812 usb_stor_BBB_reset(us);
813 return USB_STOR_TRANSPORT_FAILED;
814 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
816 usb_stor_BBB_reset(us);
817 return USB_STOR_TRANSPORT_FAILED;
818 } else if (data_actlen > srb->datalen) {
819 debug("transferred %dB instead of %ldB\n",
820 data_actlen, srb->datalen);
821 return USB_STOR_TRANSPORT_FAILED;
822 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
824 return USB_STOR_TRANSPORT_FAILED;
830 static int usb_stor_CB_transport(struct scsi_cmd *srb, struct us_data *us)
833 struct scsi_cmd *psrb;
834 struct scsi_cmd reqsrb;
838 status = USB_STOR_TRANSPORT_GOOD;
841 /* issue the command */
843 result = usb_stor_CB_comdat(srb, us);
844 debug("command / Data returned %d, status %lX\n",
845 result, us->pusb_dev->status);
846 /* if this is an CBI Protocol, get IRQ */
847 if (us->protocol == US_PR_CBI) {
848 status = usb_stor_CBI_get_status(srb, us);
849 /* if the status is error, report it */
850 if (status == USB_STOR_TRANSPORT_ERROR) {
851 debug(" USB CBI Command Error\n");
854 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
855 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
857 /* if the status is good, report it */
858 if (status == USB_STOR_TRANSPORT_GOOD) {
859 debug(" USB CBI Command Good\n");
864 /* do we have to issue an auto request? */
865 /* HERE we have to check the result */
866 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
867 debug("ERROR %lX\n", us->pusb_dev->status);
868 us->transport_reset(us);
869 return USB_STOR_TRANSPORT_ERROR;
871 if ((us->protocol == US_PR_CBI) &&
872 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
873 (srb->cmd[0] == SCSI_INQUIRY))) {
874 /* do not issue an autorequest after request sense */
875 debug("No auto request and good\n");
876 return USB_STOR_TRANSPORT_GOOD;
878 /* issue an request_sense */
879 memset(&psrb->cmd[0], 0, 12);
880 psrb->cmd[0] = SCSI_REQ_SENSE;
881 psrb->cmd[1] = srb->lun << 5;
884 psrb->pdata = &srb->sense_buf[0];
886 /* issue the command */
887 result = usb_stor_CB_comdat(psrb, us);
888 debug("auto request returned %d\n", result);
889 /* if this is an CBI Protocol, get IRQ */
890 if (us->protocol == US_PR_CBI)
891 status = usb_stor_CBI_get_status(psrb, us);
893 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
894 debug(" AUTO REQUEST ERROR %ld\n",
895 us->pusb_dev->status);
896 return USB_STOR_TRANSPORT_ERROR;
898 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
899 srb->sense_buf[0], srb->sense_buf[2],
900 srb->sense_buf[12], srb->sense_buf[13]);
901 /* Check the auto request result */
902 if ((srb->sense_buf[2] == 0) &&
903 (srb->sense_buf[12] == 0) &&
904 (srb->sense_buf[13] == 0)) {
906 return USB_STOR_TRANSPORT_GOOD;
909 /* Check the auto request result */
910 switch (srb->sense_buf[2]) {
912 /* Recovered Error */
913 return USB_STOR_TRANSPORT_GOOD;
917 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
918 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
919 " 0x%02X (NOT READY)\n", srb->cmd[0],
920 srb->sense_buf[0], srb->sense_buf[2],
921 srb->sense_buf[12], srb->sense_buf[13]);
922 return USB_STOR_TRANSPORT_FAILED;
929 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
930 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
931 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
932 srb->sense_buf[2], srb->sense_buf[12],
934 return USB_STOR_TRANSPORT_FAILED;
939 return USB_STOR_TRANSPORT_FAILED;
942 static void usb_stor_set_max_xfer_blk(struct usb_device *udev,
946 size_t __maybe_unused size;
947 int __maybe_unused ret;
949 #ifndef CONFIG_DM_USB
950 #ifdef CONFIG_USB_EHCI_HCD
952 * The U-Boot EHCI driver can handle any transfer length as long as
953 * there is enough free heap space left, but the SCSI READ(10) and
954 * WRITE(10) commands are limited to 65535 blocks.
961 ret = usb_get_max_xfer_size(udev, (size_t *)&size);
963 /* unimplemented, let's use default 20 */
966 if (size > USHRT_MAX * 512)
967 size = USHRT_MAX * 512;
972 us->max_xfer_blk = blk;
975 static int usb_inquiry(struct scsi_cmd *srb, struct us_data *ss)
980 memset(&srb->cmd[0], 0, 12);
981 srb->cmd[0] = SCSI_INQUIRY;
982 srb->cmd[1] = srb->lun << 5;
986 i = ss->transport(srb, ss);
987 debug("inquiry returns %d\n", i);
993 printf("error in inquiry\n");
999 static int usb_request_sense(struct scsi_cmd *srb, struct us_data *ss)
1003 ptr = (char *)srb->pdata;
1004 memset(&srb->cmd[0], 0, 12);
1005 srb->cmd[0] = SCSI_REQ_SENSE;
1006 srb->cmd[1] = srb->lun << 5;
1009 srb->pdata = &srb->sense_buf[0];
1011 ss->transport(srb, ss);
1012 debug("Request Sense returned %02X %02X %02X\n",
1013 srb->sense_buf[2], srb->sense_buf[12],
1014 srb->sense_buf[13]);
1015 srb->pdata = (uchar *)ptr;
1019 static int usb_test_unit_ready(struct scsi_cmd *srb, struct us_data *ss)
1024 memset(&srb->cmd[0], 0, 12);
1025 srb->cmd[0] = SCSI_TST_U_RDY;
1026 srb->cmd[1] = srb->lun << 5;
1029 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
1030 ss->flags |= USB_READY;
1033 usb_request_sense(srb, ss);
1035 * Check the Key Code Qualifier, if it matches
1036 * "Not Ready - medium not present"
1037 * (the sense Key equals 0x2 and the ASC is 0x3a)
1038 * return immediately as the medium being absent won't change
1039 * unless there is a user action.
1041 if ((srb->sense_buf[2] == 0x02) &&
1042 (srb->sense_buf[12] == 0x3a))
1045 } while (retries--);
1050 static int usb_read_capacity(struct scsi_cmd *srb, struct us_data *ss)
1056 memset(&srb->cmd[0], 0, 12);
1057 srb->cmd[0] = SCSI_RD_CAPAC;
1058 srb->cmd[1] = srb->lun << 5;
1061 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
1068 static int usb_read_10(struct scsi_cmd *srb, struct us_data *ss,
1069 unsigned long start, unsigned short blocks)
1071 memset(&srb->cmd[0], 0, 12);
1072 srb->cmd[0] = SCSI_READ10;
1073 srb->cmd[1] = srb->lun << 5;
1074 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1075 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1076 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1077 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1078 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1079 srb->cmd[8] = (unsigned char) blocks & 0xff;
1081 debug("read10: start %lx blocks %x\n", start, blocks);
1082 return ss->transport(srb, ss);
1085 static int usb_write_10(struct scsi_cmd *srb, struct us_data *ss,
1086 unsigned long start, unsigned short blocks)
1088 memset(&srb->cmd[0], 0, 12);
1089 srb->cmd[0] = SCSI_WRITE10;
1090 srb->cmd[1] = srb->lun << 5;
1091 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1092 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1093 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1094 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1095 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1096 srb->cmd[8] = (unsigned char) blocks & 0xff;
1098 debug("write10: start %lx blocks %x\n", start, blocks);
1099 return ss->transport(srb, ss);
1103 #ifdef CONFIG_USB_BIN_FIXUP
1105 * Some USB storage devices queried for SCSI identification data respond with
1106 * binary strings, which if output to the console freeze the terminal. The
1107 * workaround is to modify the vendor and product strings read from such
1108 * device with proper values (as reported by 'usb info').
1110 * Vendor and product length limits are taken from the definition of
1111 * struct blk_desc in include/part.h.
1113 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1114 unsigned char vendor[],
1115 unsigned char product[]) {
1116 const unsigned char max_vendor_len = 40;
1117 const unsigned char max_product_len = 20;
1118 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1119 strncpy((char *)vendor, "SMSC", max_vendor_len);
1120 strncpy((char *)product, "Flash Media Cntrller",
1124 #endif /* CONFIG_USB_BIN_FIXUP */
1127 static unsigned long usb_stor_read(struct udevice *dev, lbaint_t blknr,
1128 lbaint_t blkcnt, void *buffer)
1130 static unsigned long usb_stor_read(struct blk_desc *block_dev, lbaint_t blknr,
1131 lbaint_t blkcnt, void *buffer)
1134 lbaint_t start, blks;
1136 unsigned short smallblks;
1137 struct usb_device *udev;
1140 struct scsi_cmd *srb = &usb_ccb;
1142 struct blk_desc *block_dev;
1149 block_dev = dev_get_uclass_platdata(dev);
1150 udev = dev_get_parent_priv(dev_get_parent(dev));
1151 debug("\nusb_read: udev %d\n", block_dev->devnum);
1153 debug("\nusb_read: udev %d\n", block_dev->devnum);
1154 udev = usb_dev_desc[block_dev->devnum].priv;
1156 debug("%s: No device\n", __func__);
1160 ss = (struct us_data *)udev->privptr;
1162 usb_disable_asynch(1); /* asynch transfer not allowed */
1163 srb->lun = block_dev->lun;
1164 buf_addr = (uintptr_t)buffer;
1168 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF " buffer %"
1169 PRIxPTR "\n", block_dev->devnum, start, blks, buf_addr);
1172 /* XXX need some comment here */
1174 srb->pdata = (unsigned char *)buf_addr;
1175 if (blks > ss->max_xfer_blk)
1176 smallblks = ss->max_xfer_blk;
1178 smallblks = (unsigned short) blks;
1180 if (smallblks == ss->max_xfer_blk)
1181 usb_show_progress();
1182 srb->datalen = block_dev->blksz * smallblks;
1183 srb->pdata = (unsigned char *)buf_addr;
1184 if (usb_read_10(srb, ss, start, smallblks)) {
1185 debug("Read ERROR\n");
1186 usb_request_sense(srb, ss);
1194 buf_addr += srb->datalen;
1195 } while (blks != 0);
1196 ss->flags &= ~USB_READY;
1198 debug("usb_read: end startblk " LBAF
1199 ", blccnt %x buffer %" PRIxPTR "\n",
1200 start, smallblks, buf_addr);
1202 usb_disable_asynch(0); /* asynch transfer allowed */
1203 if (blkcnt >= ss->max_xfer_blk)
1209 static unsigned long usb_stor_write(struct udevice *dev, lbaint_t blknr,
1210 lbaint_t blkcnt, const void *buffer)
1212 static unsigned long usb_stor_write(struct blk_desc *block_dev, lbaint_t blknr,
1213 lbaint_t blkcnt, const void *buffer)
1216 lbaint_t start, blks;
1218 unsigned short smallblks;
1219 struct usb_device *udev;
1222 struct scsi_cmd *srb = &usb_ccb;
1224 struct blk_desc *block_dev;
1232 block_dev = dev_get_uclass_platdata(dev);
1233 udev = dev_get_parent_priv(dev_get_parent(dev));
1234 debug("\nusb_read: udev %d\n", block_dev->devnum);
1236 debug("\nusb_read: udev %d\n", block_dev->devnum);
1237 udev = usb_dev_desc[block_dev->devnum].priv;
1239 debug("%s: No device\n", __func__);
1243 ss = (struct us_data *)udev->privptr;
1245 usb_disable_asynch(1); /* asynch transfer not allowed */
1247 srb->lun = block_dev->lun;
1248 buf_addr = (uintptr_t)buffer;
1252 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF " buffer %"
1253 PRIxPTR "\n", block_dev->devnum, start, blks, buf_addr);
1256 /* If write fails retry for max retry count else
1257 * return with number of blocks written successfully.
1260 srb->pdata = (unsigned char *)buf_addr;
1261 if (blks > ss->max_xfer_blk)
1262 smallblks = ss->max_xfer_blk;
1264 smallblks = (unsigned short) blks;
1266 if (smallblks == ss->max_xfer_blk)
1267 usb_show_progress();
1268 srb->datalen = block_dev->blksz * smallblks;
1269 srb->pdata = (unsigned char *)buf_addr;
1270 if (usb_write_10(srb, ss, start, smallblks)) {
1271 debug("Write ERROR\n");
1272 usb_request_sense(srb, ss);
1280 buf_addr += srb->datalen;
1281 } while (blks != 0);
1282 ss->flags &= ~USB_READY;
1284 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %"
1285 PRIxPTR "\n", start, smallblks, buf_addr);
1287 usb_disable_asynch(0); /* asynch transfer allowed */
1288 if (blkcnt >= ss->max_xfer_blk)
1294 /* Probe to see if a new device is actually a Storage device */
1295 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1298 struct usb_interface *iface;
1300 struct usb_endpoint_descriptor *ep_desc;
1301 unsigned int flags = 0;
1303 /* let's examine the device now */
1304 iface = &dev->config.if_desc[ifnum];
1306 if (dev->descriptor.bDeviceClass != 0 ||
1307 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1308 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1309 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1310 debug("Not mass storage\n");
1311 /* if it's not a mass storage, we go no further */
1315 memset(ss, 0, sizeof(struct us_data));
1317 /* At this point, we know we've got a live one */
1318 debug("\n\nUSB Mass Storage device detected\n");
1320 /* Initialize the us_data structure with some useful info */
1324 ss->attention_done = 0;
1325 ss->subclass = iface->desc.bInterfaceSubClass;
1326 ss->protocol = iface->desc.bInterfaceProtocol;
1328 /* set the handler pointers based on the protocol */
1329 debug("Transport: ");
1330 switch (ss->protocol) {
1332 debug("Control/Bulk\n");
1333 ss->transport = usb_stor_CB_transport;
1334 ss->transport_reset = usb_stor_CB_reset;
1338 debug("Control/Bulk/Interrupt\n");
1339 ss->transport = usb_stor_CB_transport;
1340 ss->transport_reset = usb_stor_CB_reset;
1343 debug("Bulk/Bulk/Bulk\n");
1344 ss->transport = usb_stor_BBB_transport;
1345 ss->transport_reset = usb_stor_BBB_reset;
1348 printf("USB Storage Transport unknown / not yet implemented\n");
1354 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1355 * An optional interrupt is OK (necessary for CBI protocol).
1356 * We will ignore any others.
1358 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1359 ep_desc = &iface->ep_desc[i];
1360 /* is it an BULK endpoint? */
1361 if ((ep_desc->bmAttributes &
1362 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1363 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1364 ss->ep_in = ep_desc->bEndpointAddress &
1365 USB_ENDPOINT_NUMBER_MASK;
1368 ep_desc->bEndpointAddress &
1369 USB_ENDPOINT_NUMBER_MASK;
1372 /* is it an interrupt endpoint? */
1373 if ((ep_desc->bmAttributes &
1374 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1375 ss->ep_int = ep_desc->bEndpointAddress &
1376 USB_ENDPOINT_NUMBER_MASK;
1377 ss->irqinterval = ep_desc->bInterval;
1380 debug("Endpoints In %d Out %d Int %d\n",
1381 ss->ep_in, ss->ep_out, ss->ep_int);
1383 /* Do some basic sanity checks, and bail if we find a problem */
1384 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1385 !ss->ep_in || !ss->ep_out ||
1386 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1387 debug("Problems with device\n");
1390 /* set class specific stuff */
1391 /* We only handle certain protocols. Currently, these are
1393 * The SFF8070 accepts the requests used in u-boot
1395 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1396 ss->subclass != US_SC_8070) {
1397 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1401 /* we had found an interrupt endpoint, prepare irq pipe
1402 * set up the IRQ pipe and handler
1404 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1405 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1406 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1407 dev->irq_handle = usb_stor_irq;
1410 /* Set the maximum transfer size per host controller setting */
1411 usb_stor_set_max_xfer_blk(dev, ss);
1413 dev->privptr = (void *)ss;
1417 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1418 struct blk_desc *dev_desc)
1420 unsigned char perq, modi;
1421 ALLOC_CACHE_ALIGN_BUFFER(u32, cap, 2);
1422 ALLOC_CACHE_ALIGN_BUFFER(u8, usb_stor_buf, 36);
1423 u32 capacity, blksz;
1424 struct scsi_cmd *pccb = &usb_ccb;
1426 pccb->pdata = usb_stor_buf;
1428 dev_desc->target = dev->devnum;
1429 pccb->lun = dev_desc->lun;
1430 debug(" address %d\n", dev_desc->target);
1432 if (usb_inquiry(pccb, ss)) {
1433 debug("%s: usb_inquiry() failed\n", __func__);
1437 perq = usb_stor_buf[0];
1438 modi = usb_stor_buf[1];
1441 * Skip unknown devices (0x1f) and enclosure service devices (0x0d),
1442 * they would not respond to test_unit_ready .
1444 if (((perq & 0x1f) == 0x1f) || ((perq & 0x1f) == 0x0d)) {
1445 debug("%s: unknown/unsupported device\n", __func__);
1448 if ((modi&0x80) == 0x80) {
1449 /* drive is removable */
1450 dev_desc->removable = 1;
1452 memcpy(dev_desc->vendor, (const void *)&usb_stor_buf[8], 8);
1453 memcpy(dev_desc->product, (const void *)&usb_stor_buf[16], 16);
1454 memcpy(dev_desc->revision, (const void *)&usb_stor_buf[32], 4);
1455 dev_desc->vendor[8] = 0;
1456 dev_desc->product[16] = 0;
1457 dev_desc->revision[4] = 0;
1458 #ifdef CONFIG_USB_BIN_FIXUP
1459 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1460 (uchar *)dev_desc->product);
1461 #endif /* CONFIG_USB_BIN_FIXUP */
1462 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1464 if (usb_test_unit_ready(pccb, ss)) {
1465 printf("Device NOT ready\n"
1466 " Request Sense returned %02X %02X %02X\n",
1467 pccb->sense_buf[2], pccb->sense_buf[12],
1468 pccb->sense_buf[13]);
1469 if (dev_desc->removable == 1)
1470 dev_desc->type = perq;
1473 pccb->pdata = (unsigned char *)cap;
1474 memset(pccb->pdata, 0, 8);
1475 if (usb_read_capacity(pccb, ss) != 0) {
1476 printf("READ_CAP ERROR\n");
1480 ss->flags &= ~USB_READY;
1481 debug("Read Capacity returns: 0x%08x, 0x%08x\n", cap[0], cap[1]);
1483 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1486 cap[0] = cpu_to_be32(cap[0]);
1487 cap[1] = cpu_to_be32(cap[1]);
1490 capacity = be32_to_cpu(cap[0]) + 1;
1491 blksz = be32_to_cpu(cap[1]);
1493 debug("Capacity = 0x%08x, blocksz = 0x%08x\n", capacity, blksz);
1494 dev_desc->lba = capacity;
1495 dev_desc->blksz = blksz;
1496 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1497 dev_desc->type = perq;
1498 debug(" address %d\n", dev_desc->target);
1503 #ifdef CONFIG_DM_USB
1505 static int usb_mass_storage_probe(struct udevice *dev)
1507 struct usb_device *udev = dev_get_parent_priv(dev);
1510 usb_disable_asynch(1); /* asynch transfer not allowed */
1511 ret = usb_stor_probe_device(udev);
1512 usb_disable_asynch(0); /* asynch transfer allowed */
1517 static const struct udevice_id usb_mass_storage_ids[] = {
1518 { .compatible = "usb-mass-storage" },
1522 U_BOOT_DRIVER(usb_mass_storage) = {
1523 .name = "usb_mass_storage",
1524 .id = UCLASS_MASS_STORAGE,
1525 .of_match = usb_mass_storage_ids,
1526 .probe = usb_mass_storage_probe,
1528 .platdata_auto_alloc_size = sizeof(struct us_data),
1532 UCLASS_DRIVER(usb_mass_storage) = {
1533 .id = UCLASS_MASS_STORAGE,
1534 .name = "usb_mass_storage",
1537 static const struct usb_device_id mass_storage_id_table[] = {
1539 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
1540 .bInterfaceClass = USB_CLASS_MASS_STORAGE
1542 { } /* Terminating entry */
1545 U_BOOT_USB_DEVICE(usb_mass_storage, mass_storage_id_table);
1549 static const struct blk_ops usb_storage_ops = {
1550 .read = usb_stor_read,
1551 .write = usb_stor_write,
1554 U_BOOT_DRIVER(usb_storage_blk) = {
1555 .name = "usb_storage_blk",
1557 .ops = &usb_storage_ops,
1560 U_BOOT_LEGACY_BLK(usb) = {
1561 .if_typename = "usb",
1562 .if_type = IF_TYPE_USB,
1563 .max_devs = USB_MAX_STOR_DEV,
1564 .desc = usb_dev_desc,