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.
39 #include <asm/byteorder.h>
40 #include <asm/processor.h>
45 #undef BBB_COMDAT_TRACE
46 #undef BBB_XPORT_TRACE
49 /* direction table -- this indicates the direction of the data
50 * transfer for each command code -- a 1 indicates input
52 static const unsigned char us_direction[256/8] = {
53 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
54 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
55 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
56 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
58 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
60 static ccb usb_ccb __attribute__((aligned(ARCH_DMA_MINALIGN)));
63 #define USB_MAX_STOR_DEV 5
64 static int usb_max_devs; /* number of highest available usb device */
66 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
69 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
70 typedef int (*trans_reset)(struct us_data *data);
73 struct usb_device *pusb_dev; /* this usb_device */
75 unsigned int flags; /* from filter initially */
76 # define USB_READY (1 << 0)
77 unsigned char ifnum; /* interface number */
78 unsigned char ep_in; /* in endpoint */
79 unsigned char ep_out; /* out ....... */
80 unsigned char ep_int; /* interrupt . */
81 unsigned char subclass; /* as in overview */
82 unsigned char protocol; /* .............. */
83 unsigned char attention_done; /* force attn on first cmd */
84 unsigned short ip_data; /* interrupt data */
85 int action; /* what to do */
86 int ip_wanted; /* needed */
87 int *irq_handle; /* for USB int requests */
88 unsigned int irqpipe; /* pipe for release_irq */
89 unsigned char irqmaxp; /* max packed for irq Pipe */
90 unsigned char irqinterval; /* Intervall for IRQ Pipe */
91 ccb *srb; /* current srb */
92 trans_reset transport_reset; /* reset routine */
93 trans_cmnd transport; /* transport routine */
96 #ifdef CONFIG_USB_EHCI
98 * The U-Boot EHCI driver can handle any transfer length as long as there is
99 * enough free heap space left, but the SCSI READ(10) and WRITE(10) commands are
100 * limited to 65535 blocks.
102 #define USB_MAX_XFER_BLK 65535
104 #define USB_MAX_XFER_BLK 20
107 static struct us_data usb_stor[USB_MAX_STOR_DEV];
110 #define USB_STOR_TRANSPORT_GOOD 0
111 #define USB_STOR_TRANSPORT_FAILED -1
112 #define USB_STOR_TRANSPORT_ERROR -2
114 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
115 block_dev_desc_t *dev_desc);
116 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
118 unsigned long usb_stor_read(int device, lbaint_t blknr,
119 lbaint_t blkcnt, void *buffer);
120 unsigned long usb_stor_write(int device, lbaint_t blknr,
121 lbaint_t blkcnt, const void *buffer);
122 struct usb_device * usb_get_dev_index(int index);
123 void uhci_show_temp_int_td(void);
125 #ifdef CONFIG_PARTITIONS
126 block_dev_desc_t *usb_stor_get_dev(int index)
128 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
132 static void usb_show_progress(void)
137 /*******************************************************************************
138 * show info on storage devices; 'usb start/init' must be invoked earlier
139 * as we only retrieve structures populated during devices initialization
141 int usb_stor_info(void)
145 if (usb_max_devs > 0) {
146 for (i = 0; i < usb_max_devs; i++) {
147 printf(" Device %d: ", i);
148 dev_print(&usb_dev_desc[i]);
153 printf("No storage devices, perhaps not 'usb start'ed..?\n");
157 static unsigned int usb_get_max_lun(struct us_data *us)
160 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
161 len = usb_control_msg(us->pusb_dev,
162 usb_rcvctrlpipe(us->pusb_dev, 0),
164 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
166 result, sizeof(char),
167 USB_CNTL_TIMEOUT * 5);
168 debug("Get Max LUN -> len = %i, result = %i\n", len, (int) *result);
169 return (len > 0) ? *result : 0;
172 static int usb_stor_probe_device(struct usb_device *dev)
175 return -ENOENT; /* no more devices available */
177 debug("\n\nProbing for storage\n");
178 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
179 /* OK, it's a storage device. Iterate over its LUNs
180 * and populate `usb_dev_desc'.
182 int lun, max_lun, start = usb_max_devs;
184 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
186 lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
188 struct block_dev_desc *blkdev;
190 blkdev = &usb_dev_desc[usb_max_devs];
191 memset(blkdev, '\0', sizeof(block_dev_desc_t));
192 blkdev->if_type = IF_TYPE_USB;
193 blkdev->dev = usb_max_devs;
194 blkdev->part_type = PART_TYPE_UNKNOWN;
195 blkdev->target = 0xff;
196 blkdev->type = DEV_TYPE_UNKNOWN;
197 blkdev->block_read = usb_stor_read;
198 blkdev->block_write = usb_stor_write;
202 if (usb_stor_get_info(dev, &usb_stor[start],
203 &usb_dev_desc[usb_max_devs]) ==
206 debug("%s: Found device %p\n", __func__, dev);
211 /* if storage device */
212 if (usb_max_devs == USB_MAX_STOR_DEV) {
213 printf("max USB Storage Device reached: %d stopping\n",
221 void usb_stor_reset(void)
226 /*******************************************************************************
227 * scan the usb and reports device info
228 * to the user if mode = 1
229 * returns current device or -1 if no
231 int usb_stor_scan(int mode)
236 printf(" scanning usb for storage devices... ");
238 usb_disable_asynch(1); /* asynch transfer not allowed */
241 for (i = 0; i < USB_MAX_DEVICE; i++) {
242 struct usb_device *dev;
244 dev = usb_get_dev_index(i); /* get device */
246 if (usb_stor_probe_device(dev))
250 usb_disable_asynch(0); /* asynch transfer allowed */
251 printf("%d Storage Device(s) found\n", usb_max_devs);
252 if (usb_max_devs > 0)
257 static int usb_stor_irq(struct usb_device *dev)
260 us = (struct us_data *)dev->privptr;
270 static void usb_show_srb(ccb *pccb)
273 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
274 for (i = 0; i < 12; i++)
275 printf("%02X ", pccb->cmd[i]);
279 static void display_int_status(unsigned long tmp)
281 printf("Status: %s %s %s %s %s %s %s\n",
282 (tmp & USB_ST_ACTIVE) ? "Active" : "",
283 (tmp & USB_ST_STALLED) ? "Stalled" : "",
284 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
285 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
286 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
287 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
288 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
291 /***********************************************************************
292 * Data transfer routines
293 ***********************************************************************/
295 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
304 /* determine the maximum packet size for these transfers */
305 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
307 /* while we have data left to transfer */
310 /* calculate how long this will be -- maximum or a remainder */
311 this_xfer = length > max_size ? max_size : length;
314 /* setup the retry counter */
317 /* set up the transfer loop */
319 /* transfer the data */
320 debug("Bulk xfer 0x%lx(%d) try #%d\n",
321 (ulong)map_to_sysmem(buf), this_xfer,
323 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
325 USB_CNTL_TIMEOUT * 5);
326 debug("bulk_msg returned %d xferred %d/%d\n",
327 result, partial, this_xfer);
328 if (us->pusb_dev->status != 0) {
329 /* if we stall, we need to clear it before
333 display_int_status(us->pusb_dev->status);
335 if (us->pusb_dev->status & USB_ST_STALLED) {
336 debug("stalled ->clearing endpoint" \
337 "halt for pipe 0x%x\n", pipe);
338 stat = us->pusb_dev->status;
339 usb_clear_halt(us->pusb_dev, pipe);
340 us->pusb_dev->status = stat;
341 if (this_xfer == partial) {
342 debug("bulk transferred" \
345 us->pusb_dev->status);
351 if (us->pusb_dev->status & USB_ST_NAK_REC) {
352 debug("Device NAKed bulk_msg\n");
355 debug("bulk transferred with error");
356 if (this_xfer == partial) {
357 debug(" %ld, but data ok\n",
358 us->pusb_dev->status);
361 /* if our try counter reaches 0, bail out */
362 debug(" %ld, data %d\n",
363 us->pusb_dev->status, partial);
367 /* update to show what data was transferred */
368 this_xfer -= partial;
370 /* continue until this transfer is done */
374 /* if we get here, we're done and successful */
378 static int usb_stor_BBB_reset(struct us_data *us)
384 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
386 * For Reset Recovery the host shall issue in the following order:
387 * a) a Bulk-Only Mass Storage Reset
388 * b) a Clear Feature HALT to the Bulk-In endpoint
389 * c) a Clear Feature HALT to the Bulk-Out endpoint
391 * This is done in 3 steps.
393 * If the reset doesn't succeed, the device should be port reset.
395 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
397 debug("BBB_reset\n");
398 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
400 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
401 0, us->ifnum, NULL, 0, USB_CNTL_TIMEOUT * 5);
403 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
404 debug("RESET:stall\n");
408 /* long wait for reset */
410 debug("BBB_reset result %d: status %lX reset\n",
411 result, us->pusb_dev->status);
412 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
413 result = usb_clear_halt(us->pusb_dev, pipe);
414 /* long wait for reset */
416 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
417 result, us->pusb_dev->status);
418 /* long wait for reset */
419 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
420 result = usb_clear_halt(us->pusb_dev, pipe);
422 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
423 result, us->pusb_dev->status);
424 debug("BBB_reset done\n");
428 /* FIXME: this reset function doesn't really reset the port, and it
429 * should. Actually it should probably do what it's doing here, and
430 * reset the port physically
432 static int usb_stor_CB_reset(struct us_data *us)
434 unsigned char cmd[12];
438 memset(cmd, 0xff, sizeof(cmd));
439 cmd[0] = SCSI_SEND_DIAG;
441 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
443 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
444 0, us->ifnum, cmd, sizeof(cmd),
445 USB_CNTL_TIMEOUT * 5);
447 /* long wait for reset */
449 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
450 result, us->pusb_dev->status);
451 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
452 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
454 debug("CB_reset done\n");
459 * Set up the command for a BBB device. Note that the actual SCSI
460 * command is copied into cbw.CBWCDB.
462 static int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
468 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_cbw, cbw, 1);
470 dir_in = US_DIRECTION(srb->cmd[0]);
472 #ifdef BBB_COMDAT_TRACE
473 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
474 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
477 for (result = 0; result < srb->cmdlen; result++)
478 printf("cmd[%d] %#x ", result, srb->cmd[result]);
483 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
484 debug("usb_stor_BBB_comdat:cmdlen too large\n");
488 /* always OUT to the ep */
489 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
491 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
492 cbw->dCBWTag = cpu_to_le32(CBWTag++);
493 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
494 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
495 cbw->bCBWLUN = srb->lun;
496 cbw->bCDBLength = srb->cmdlen;
497 /* copy the command data into the CBW command data buffer */
500 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
501 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
502 &actlen, USB_CNTL_TIMEOUT * 5);
504 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
508 /* FIXME: we also need a CBI_command which sets up the completion
509 * interrupt, and waits for it
511 static int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
516 unsigned long status;
519 dir_in = US_DIRECTION(srb->cmd[0]);
522 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
524 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
527 debug("CBI gets a command: Try %d\n", 5 - retry);
531 /* let's send the command via the control pipe */
532 result = usb_control_msg(us->pusb_dev,
533 usb_sndctrlpipe(us->pusb_dev , 0),
535 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
537 srb->cmd, srb->cmdlen,
538 USB_CNTL_TIMEOUT * 5);
539 debug("CB_transport: control msg returned %d, status %lX\n",
540 result, us->pusb_dev->status);
541 /* check the return code for the command */
543 if (us->pusb_dev->status & USB_ST_STALLED) {
544 status = us->pusb_dev->status;
545 debug(" stall during command found," \
547 usb_clear_halt(us->pusb_dev,
548 usb_sndctrlpipe(us->pusb_dev, 0));
549 us->pusb_dev->status = status;
551 debug(" error during command %02X" \
552 " Stat = %lX\n", srb->cmd[0],
553 us->pusb_dev->status);
556 /* transfer the data payload for this command, if one exists*/
558 debug("CB_transport: control msg returned %d," \
559 " direction is %s to go 0x%lx\n", result,
560 dir_in ? "IN" : "OUT", srb->datalen);
562 result = us_one_transfer(us, pipe, (char *)srb->pdata,
564 debug("CBI attempted to transfer data," \
565 " result is %d status %lX, len %d\n",
566 result, us->pusb_dev->status,
567 us->pusb_dev->act_len);
568 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
570 } /* if (srb->datalen) */
580 static int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
585 submit_int_msg(us->pusb_dev, us->irqpipe,
586 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
589 if (us->ip_wanted == 0)
594 printf(" Did not get interrupt on CBI\n");
596 return USB_STOR_TRANSPORT_ERROR;
598 debug("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
599 us->ip_data, us->pusb_dev->irq_act_len,
600 us->pusb_dev->irq_status);
601 /* UFI gives us ASC and ASCQ, like a request sense */
602 if (us->subclass == US_SC_UFI) {
603 if (srb->cmd[0] == SCSI_REQ_SENSE ||
604 srb->cmd[0] == SCSI_INQUIRY)
605 return USB_STOR_TRANSPORT_GOOD; /* Good */
606 else if (us->ip_data)
607 return USB_STOR_TRANSPORT_FAILED;
609 return USB_STOR_TRANSPORT_GOOD;
611 /* otherwise, we interpret the data normally */
612 switch (us->ip_data) {
614 return USB_STOR_TRANSPORT_GOOD;
616 return USB_STOR_TRANSPORT_FAILED;
618 return USB_STOR_TRANSPORT_ERROR;
620 return USB_STOR_TRANSPORT_ERROR;
623 #define USB_TRANSPORT_UNKNOWN_RETRY 5
624 #define USB_TRANSPORT_NOT_READY_RETRY 10
626 /* clear a stall on an endpoint - special for BBB devices */
627 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
631 /* ENDPOINT_HALT = 0, so set value to 0 */
632 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
633 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
634 0, endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
638 static int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
642 int actlen, data_actlen;
643 unsigned int pipe, pipein, pipeout;
644 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_csw, csw, 1);
645 #ifdef BBB_XPORT_TRACE
650 dir_in = US_DIRECTION(srb->cmd[0]);
653 debug("COMMAND phase\n");
654 result = usb_stor_BBB_comdat(srb, us);
656 debug("failed to send CBW status %ld\n",
657 us->pusb_dev->status);
658 usb_stor_BBB_reset(us);
659 return USB_STOR_TRANSPORT_FAILED;
661 if (!(us->flags & USB_READY))
663 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
664 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
665 /* DATA phase + error handling */
667 /* no data, go immediately to the STATUS phase */
668 if (srb->datalen == 0)
670 debug("DATA phase\n");
676 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
677 &data_actlen, USB_CNTL_TIMEOUT * 5);
678 /* special handling of STALL in DATA phase */
679 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
680 debug("DATA:stall\n");
681 /* clear the STALL on the endpoint */
682 result = usb_stor_BBB_clear_endpt_stall(us,
683 dir_in ? us->ep_in : us->ep_out);
685 /* continue on to STATUS phase */
689 debug("usb_bulk_msg error status %ld\n",
690 us->pusb_dev->status);
691 usb_stor_BBB_reset(us);
692 return USB_STOR_TRANSPORT_FAILED;
694 #ifdef BBB_XPORT_TRACE
695 for (index = 0; index < data_actlen; index++)
696 printf("pdata[%d] %#x ", index, srb->pdata[index]);
699 /* STATUS phase + error handling */
703 debug("STATUS phase\n");
704 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
705 &actlen, USB_CNTL_TIMEOUT*5);
707 /* special handling of STALL in STATUS phase */
708 if ((result < 0) && (retry < 1) &&
709 (us->pusb_dev->status & USB_ST_STALLED)) {
710 debug("STATUS:stall\n");
711 /* clear the STALL on the endpoint */
712 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
713 if (result >= 0 && (retry++ < 1))
718 debug("usb_bulk_msg error status %ld\n",
719 us->pusb_dev->status);
720 usb_stor_BBB_reset(us);
721 return USB_STOR_TRANSPORT_FAILED;
723 #ifdef BBB_XPORT_TRACE
724 ptr = (unsigned char *)csw;
725 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
726 printf("ptr[%d] %#x ", index, ptr[index]);
729 /* misuse pipe to get the residue */
730 pipe = le32_to_cpu(csw->dCSWDataResidue);
731 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
732 pipe = srb->datalen - data_actlen;
733 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
734 debug("!CSWSIGNATURE\n");
735 usb_stor_BBB_reset(us);
736 return USB_STOR_TRANSPORT_FAILED;
737 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
739 usb_stor_BBB_reset(us);
740 return USB_STOR_TRANSPORT_FAILED;
741 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
743 usb_stor_BBB_reset(us);
744 return USB_STOR_TRANSPORT_FAILED;
745 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
747 usb_stor_BBB_reset(us);
748 return USB_STOR_TRANSPORT_FAILED;
749 } else if (data_actlen > srb->datalen) {
750 debug("transferred %dB instead of %ldB\n",
751 data_actlen, srb->datalen);
752 return USB_STOR_TRANSPORT_FAILED;
753 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
755 return USB_STOR_TRANSPORT_FAILED;
761 static int usb_stor_CB_transport(ccb *srb, struct us_data *us)
769 status = USB_STOR_TRANSPORT_GOOD;
772 /* issue the command */
774 result = usb_stor_CB_comdat(srb, us);
775 debug("command / Data returned %d, status %lX\n",
776 result, us->pusb_dev->status);
777 /* if this is an CBI Protocol, get IRQ */
778 if (us->protocol == US_PR_CBI) {
779 status = usb_stor_CBI_get_status(srb, us);
780 /* if the status is error, report it */
781 if (status == USB_STOR_TRANSPORT_ERROR) {
782 debug(" USB CBI Command Error\n");
785 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
786 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
788 /* if the status is good, report it */
789 if (status == USB_STOR_TRANSPORT_GOOD) {
790 debug(" USB CBI Command Good\n");
795 /* do we have to issue an auto request? */
796 /* HERE we have to check the result */
797 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
798 debug("ERROR %lX\n", us->pusb_dev->status);
799 us->transport_reset(us);
800 return USB_STOR_TRANSPORT_ERROR;
802 if ((us->protocol == US_PR_CBI) &&
803 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
804 (srb->cmd[0] == SCSI_INQUIRY))) {
805 /* do not issue an autorequest after request sense */
806 debug("No auto request and good\n");
807 return USB_STOR_TRANSPORT_GOOD;
809 /* issue an request_sense */
810 memset(&psrb->cmd[0], 0, 12);
811 psrb->cmd[0] = SCSI_REQ_SENSE;
812 psrb->cmd[1] = srb->lun << 5;
815 psrb->pdata = &srb->sense_buf[0];
817 /* issue the command */
818 result = usb_stor_CB_comdat(psrb, us);
819 debug("auto request returned %d\n", result);
820 /* if this is an CBI Protocol, get IRQ */
821 if (us->protocol == US_PR_CBI)
822 status = usb_stor_CBI_get_status(psrb, us);
824 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
825 debug(" AUTO REQUEST ERROR %ld\n",
826 us->pusb_dev->status);
827 return USB_STOR_TRANSPORT_ERROR;
829 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
830 srb->sense_buf[0], srb->sense_buf[2],
831 srb->sense_buf[12], srb->sense_buf[13]);
832 /* Check the auto request result */
833 if ((srb->sense_buf[2] == 0) &&
834 (srb->sense_buf[12] == 0) &&
835 (srb->sense_buf[13] == 0)) {
837 return USB_STOR_TRANSPORT_GOOD;
840 /* Check the auto request result */
841 switch (srb->sense_buf[2]) {
843 /* Recovered Error */
844 return USB_STOR_TRANSPORT_GOOD;
848 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
849 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
850 " 0x%02X (NOT READY)\n", srb->cmd[0],
851 srb->sense_buf[0], srb->sense_buf[2],
852 srb->sense_buf[12], srb->sense_buf[13]);
853 return USB_STOR_TRANSPORT_FAILED;
860 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
861 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
862 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
863 srb->sense_buf[2], srb->sense_buf[12],
865 return USB_STOR_TRANSPORT_FAILED;
870 return USB_STOR_TRANSPORT_FAILED;
874 static int usb_inquiry(ccb *srb, struct us_data *ss)
879 memset(&srb->cmd[0], 0, 12);
880 srb->cmd[0] = SCSI_INQUIRY;
881 srb->cmd[1] = srb->lun << 5;
885 i = ss->transport(srb, ss);
886 debug("inquiry returns %d\n", i);
892 printf("error in inquiry\n");
898 static int usb_request_sense(ccb *srb, struct us_data *ss)
902 ptr = (char *)srb->pdata;
903 memset(&srb->cmd[0], 0, 12);
904 srb->cmd[0] = SCSI_REQ_SENSE;
905 srb->cmd[1] = srb->lun << 5;
908 srb->pdata = &srb->sense_buf[0];
910 ss->transport(srb, ss);
911 debug("Request Sense returned %02X %02X %02X\n",
912 srb->sense_buf[2], srb->sense_buf[12],
914 srb->pdata = (uchar *)ptr;
918 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
923 memset(&srb->cmd[0], 0, 12);
924 srb->cmd[0] = SCSI_TST_U_RDY;
925 srb->cmd[1] = srb->lun << 5;
928 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
929 ss->flags |= USB_READY;
932 usb_request_sense(srb, ss);
934 * Check the Key Code Qualifier, if it matches
935 * "Not Ready - medium not present"
936 * (the sense Key equals 0x2 and the ASC is 0x3a)
937 * return immediately as the medium being absent won't change
938 * unless there is a user action.
940 if ((srb->sense_buf[2] == 0x02) &&
941 (srb->sense_buf[12] == 0x3a))
949 static int usb_read_capacity(ccb *srb, struct us_data *ss)
955 memset(&srb->cmd[0], 0, 12);
956 srb->cmd[0] = SCSI_RD_CAPAC;
957 srb->cmd[1] = srb->lun << 5;
960 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
967 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
968 unsigned short blocks)
970 memset(&srb->cmd[0], 0, 12);
971 srb->cmd[0] = SCSI_READ10;
972 srb->cmd[1] = srb->lun << 5;
973 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
974 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
975 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
976 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
977 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
978 srb->cmd[8] = (unsigned char) blocks & 0xff;
980 debug("read10: start %lx blocks %x\n", start, blocks);
981 return ss->transport(srb, ss);
984 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
985 unsigned short blocks)
987 memset(&srb->cmd[0], 0, 12);
988 srb->cmd[0] = SCSI_WRITE10;
989 srb->cmd[1] = srb->lun << 5;
990 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
991 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
992 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
993 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
994 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
995 srb->cmd[8] = (unsigned char) blocks & 0xff;
997 debug("write10: start %lx blocks %x\n", start, blocks);
998 return ss->transport(srb, ss);
1002 #ifdef CONFIG_USB_BIN_FIXUP
1004 * Some USB storage devices queried for SCSI identification data respond with
1005 * binary strings, which if output to the console freeze the terminal. The
1006 * workaround is to modify the vendor and product strings read from such
1007 * device with proper values (as reported by 'usb info').
1009 * Vendor and product length limits are taken from the definition of
1010 * block_dev_desc_t in include/part.h.
1012 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1013 unsigned char vendor[],
1014 unsigned char product[]) {
1015 const unsigned char max_vendor_len = 40;
1016 const unsigned char max_product_len = 20;
1017 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1018 strncpy((char *)vendor, "SMSC", max_vendor_len);
1019 strncpy((char *)product, "Flash Media Cntrller",
1023 #endif /* CONFIG_USB_BIN_FIXUP */
1025 unsigned long usb_stor_read(int device, lbaint_t blknr,
1026 lbaint_t blkcnt, void *buffer)
1028 lbaint_t start, blks;
1030 unsigned short smallblks;
1031 struct usb_device *dev;
1034 ccb *srb = &usb_ccb;
1041 debug("\nusb_read: dev %d\n", device);
1042 dev = usb_dev_desc[device].priv;
1044 debug("%s: No device\n", __func__);
1047 ss = (struct us_data *)dev->privptr;
1049 usb_disable_asynch(1); /* asynch transfer not allowed */
1050 srb->lun = usb_dev_desc[device].lun;
1051 buf_addr = (uintptr_t)buffer;
1055 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF
1056 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1059 /* XXX need some comment here */
1061 srb->pdata = (unsigned char *)buf_addr;
1062 if (blks > USB_MAX_XFER_BLK)
1063 smallblks = USB_MAX_XFER_BLK;
1065 smallblks = (unsigned short) blks;
1067 if (smallblks == USB_MAX_XFER_BLK)
1068 usb_show_progress();
1069 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1070 srb->pdata = (unsigned char *)buf_addr;
1071 if (usb_read_10(srb, ss, start, smallblks)) {
1072 debug("Read ERROR\n");
1073 usb_request_sense(srb, ss);
1081 buf_addr += srb->datalen;
1082 } while (blks != 0);
1083 ss->flags &= ~USB_READY;
1085 debug("usb_read: end startblk " LBAF
1086 ", blccnt %x buffer %" PRIxPTR "\n",
1087 start, smallblks, buf_addr);
1089 usb_disable_asynch(0); /* asynch transfer allowed */
1090 if (blkcnt >= USB_MAX_XFER_BLK)
1095 unsigned long usb_stor_write(int device, lbaint_t blknr,
1096 lbaint_t blkcnt, const void *buffer)
1098 lbaint_t start, blks;
1100 unsigned short smallblks;
1101 struct usb_device *dev;
1104 ccb *srb = &usb_ccb;
1111 debug("\nusb_write: dev %d\n", device);
1112 dev = usb_dev_desc[device].priv;
1115 ss = (struct us_data *)dev->privptr;
1117 usb_disable_asynch(1); /* asynch transfer not allowed */
1119 srb->lun = usb_dev_desc[device].lun;
1120 buf_addr = (uintptr_t)buffer;
1124 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF
1125 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1128 /* If write fails retry for max retry count else
1129 * return with number of blocks written successfully.
1132 srb->pdata = (unsigned char *)buf_addr;
1133 if (blks > USB_MAX_XFER_BLK)
1134 smallblks = USB_MAX_XFER_BLK;
1136 smallblks = (unsigned short) blks;
1138 if (smallblks == USB_MAX_XFER_BLK)
1139 usb_show_progress();
1140 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1141 srb->pdata = (unsigned char *)buf_addr;
1142 if (usb_write_10(srb, ss, start, smallblks)) {
1143 debug("Write ERROR\n");
1144 usb_request_sense(srb, ss);
1152 buf_addr += srb->datalen;
1153 } while (blks != 0);
1154 ss->flags &= ~USB_READY;
1156 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %"
1157 PRIxPTR "\n", start, smallblks, buf_addr);
1159 usb_disable_asynch(0); /* asynch transfer allowed */
1160 if (blkcnt >= USB_MAX_XFER_BLK)
1166 /* Probe to see if a new device is actually a Storage device */
1167 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1170 struct usb_interface *iface;
1172 struct usb_endpoint_descriptor *ep_desc;
1173 unsigned int flags = 0;
1178 /* let's examine the device now */
1179 iface = &dev->config.if_desc[ifnum];
1182 /* this is the place to patch some storage devices */
1183 debug("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1184 dev->descriptor.idProduct);
1186 if ((dev->descriptor.idVendor) == 0x066b &&
1187 (dev->descriptor.idProduct) == 0x0103) {
1188 debug("patched for E-USB\n");
1189 protocol = US_PR_CB;
1190 subclass = US_SC_UFI; /* an assumption */
1194 if (dev->descriptor.bDeviceClass != 0 ||
1195 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1196 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1197 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1198 debug("Not mass storage\n");
1199 /* if it's not a mass storage, we go no further */
1203 memset(ss, 0, sizeof(struct us_data));
1205 /* At this point, we know we've got a live one */
1206 debug("\n\nUSB Mass Storage device detected\n");
1208 /* Initialize the us_data structure with some useful info */
1212 ss->attention_done = 0;
1214 /* If the device has subclass and protocol, then use that. Otherwise,
1215 * take data from the specific interface.
1218 ss->subclass = subclass;
1219 ss->protocol = protocol;
1221 ss->subclass = iface->desc.bInterfaceSubClass;
1222 ss->protocol = iface->desc.bInterfaceProtocol;
1225 /* set the handler pointers based on the protocol */
1226 debug("Transport: ");
1227 switch (ss->protocol) {
1229 debug("Control/Bulk\n");
1230 ss->transport = usb_stor_CB_transport;
1231 ss->transport_reset = usb_stor_CB_reset;
1235 debug("Control/Bulk/Interrupt\n");
1236 ss->transport = usb_stor_CB_transport;
1237 ss->transport_reset = usb_stor_CB_reset;
1240 debug("Bulk/Bulk/Bulk\n");
1241 ss->transport = usb_stor_BBB_transport;
1242 ss->transport_reset = usb_stor_BBB_reset;
1245 printf("USB Storage Transport unknown / not yet implemented\n");
1251 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1252 * An optional interrupt is OK (necessary for CBI protocol).
1253 * We will ignore any others.
1255 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1256 ep_desc = &iface->ep_desc[i];
1257 /* is it an BULK endpoint? */
1258 if ((ep_desc->bmAttributes &
1259 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1260 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1261 ss->ep_in = ep_desc->bEndpointAddress &
1262 USB_ENDPOINT_NUMBER_MASK;
1265 ep_desc->bEndpointAddress &
1266 USB_ENDPOINT_NUMBER_MASK;
1269 /* is it an interrupt endpoint? */
1270 if ((ep_desc->bmAttributes &
1271 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1272 ss->ep_int = ep_desc->bEndpointAddress &
1273 USB_ENDPOINT_NUMBER_MASK;
1274 ss->irqinterval = ep_desc->bInterval;
1277 debug("Endpoints In %d Out %d Int %d\n",
1278 ss->ep_in, ss->ep_out, ss->ep_int);
1280 /* Do some basic sanity checks, and bail if we find a problem */
1281 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1282 !ss->ep_in || !ss->ep_out ||
1283 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1284 debug("Problems with device\n");
1287 /* set class specific stuff */
1288 /* We only handle certain protocols. Currently, these are
1290 * The SFF8070 accepts the requests used in u-boot
1292 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1293 ss->subclass != US_SC_8070) {
1294 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1298 /* we had found an interrupt endpoint, prepare irq pipe
1299 * set up the IRQ pipe and handler
1301 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1302 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1303 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1304 dev->irq_handle = usb_stor_irq;
1306 dev->privptr = (void *)ss;
1310 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1311 block_dev_desc_t *dev_desc)
1313 unsigned char perq, modi;
1314 ALLOC_CACHE_ALIGN_BUFFER(u32, cap, 2);
1315 ALLOC_CACHE_ALIGN_BUFFER(u8, usb_stor_buf, 36);
1316 u32 capacity, blksz;
1317 ccb *pccb = &usb_ccb;
1319 pccb->pdata = usb_stor_buf;
1321 dev_desc->target = dev->devnum;
1322 pccb->lun = dev_desc->lun;
1323 debug(" address %d\n", dev_desc->target);
1325 if (usb_inquiry(pccb, ss)) {
1326 debug("%s: usb_inquiry() failed\n", __func__);
1330 perq = usb_stor_buf[0];
1331 modi = usb_stor_buf[1];
1334 * Skip unknown devices (0x1f) and enclosure service devices (0x0d),
1335 * they would not respond to test_unit_ready .
1337 if (((perq & 0x1f) == 0x1f) || ((perq & 0x1f) == 0x0d)) {
1338 debug("%s: unknown/unsupported device\n", __func__);
1341 if ((modi&0x80) == 0x80) {
1342 /* drive is removable */
1343 dev_desc->removable = 1;
1345 memcpy(dev_desc->vendor, (const void *)&usb_stor_buf[8], 8);
1346 memcpy(dev_desc->product, (const void *)&usb_stor_buf[16], 16);
1347 memcpy(dev_desc->revision, (const void *)&usb_stor_buf[32], 4);
1348 dev_desc->vendor[8] = 0;
1349 dev_desc->product[16] = 0;
1350 dev_desc->revision[4] = 0;
1351 #ifdef CONFIG_USB_BIN_FIXUP
1352 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1353 (uchar *)dev_desc->product);
1354 #endif /* CONFIG_USB_BIN_FIXUP */
1355 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1357 if (usb_test_unit_ready(pccb, ss)) {
1358 printf("Device NOT ready\n"
1359 " Request Sense returned %02X %02X %02X\n",
1360 pccb->sense_buf[2], pccb->sense_buf[12],
1361 pccb->sense_buf[13]);
1362 if (dev_desc->removable == 1) {
1363 dev_desc->type = perq;
1368 pccb->pdata = (unsigned char *)cap;
1369 memset(pccb->pdata, 0, 8);
1370 if (usb_read_capacity(pccb, ss) != 0) {
1371 printf("READ_CAP ERROR\n");
1375 ss->flags &= ~USB_READY;
1376 debug("Read Capacity returns: 0x%08x, 0x%08x\n", cap[0], cap[1]);
1378 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1381 cap[0] = cpu_to_be32(cap[0]);
1382 cap[1] = cpu_to_be32(cap[1]);
1385 capacity = be32_to_cpu(cap[0]) + 1;
1386 blksz = be32_to_cpu(cap[1]);
1388 debug("Capacity = 0x%08x, blocksz = 0x%08x\n", capacity, blksz);
1389 dev_desc->lba = capacity;
1390 dev_desc->blksz = blksz;
1391 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1392 dev_desc->type = perq;
1393 debug(" address %d\n", dev_desc->target);
1394 debug("partype: %d\n", dev_desc->part_type);
1396 init_part(dev_desc);
1398 debug("partype: %d\n", dev_desc->part_type);