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.
38 #include <asm/byteorder.h>
39 #include <asm/processor.h>
44 #undef BBB_COMDAT_TRACE
45 #undef BBB_XPORT_TRACE
48 /* direction table -- this indicates the direction of the data
49 * transfer for each command code -- a 1 indicates input
51 static const unsigned char us_direction[256/8] = {
52 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
53 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
54 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
55 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
57 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
59 static ccb usb_ccb __attribute__((aligned(ARCH_DMA_MINALIGN)));
62 #define USB_MAX_STOR_DEV 5
63 static int usb_max_devs; /* number of highest available usb device */
65 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
68 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
69 typedef int (*trans_reset)(struct us_data *data);
72 struct usb_device *pusb_dev; /* this usb_device */
74 unsigned int flags; /* from filter initially */
75 # define USB_READY (1 << 0)
76 unsigned char ifnum; /* interface number */
77 unsigned char ep_in; /* in endpoint */
78 unsigned char ep_out; /* out ....... */
79 unsigned char ep_int; /* interrupt . */
80 unsigned char subclass; /* as in overview */
81 unsigned char protocol; /* .............. */
82 unsigned char attention_done; /* force attn on first cmd */
83 unsigned short ip_data; /* interrupt data */
84 int action; /* what to do */
85 int ip_wanted; /* needed */
86 int *irq_handle; /* for USB int requests */
87 unsigned int irqpipe; /* pipe for release_irq */
88 unsigned char irqmaxp; /* max packed for irq Pipe */
89 unsigned char irqinterval; /* Intervall for IRQ Pipe */
90 ccb *srb; /* current srb */
91 trans_reset transport_reset; /* reset routine */
92 trans_cmnd transport; /* transport routine */
95 #ifdef CONFIG_USB_EHCI
97 * The U-Boot EHCI driver can handle any transfer length as long as there is
98 * enough free heap space left, but the SCSI READ(10) and WRITE(10) commands are
99 * limited to 65535 blocks.
101 #define USB_MAX_XFER_BLK 65535
103 #define USB_MAX_XFER_BLK 20
106 static struct us_data usb_stor[USB_MAX_STOR_DEV];
109 #define USB_STOR_TRANSPORT_GOOD 0
110 #define USB_STOR_TRANSPORT_FAILED -1
111 #define USB_STOR_TRANSPORT_ERROR -2
113 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
114 block_dev_desc_t *dev_desc);
115 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
117 unsigned long usb_stor_read(int device, lbaint_t blknr,
118 lbaint_t blkcnt, void *buffer);
119 unsigned long usb_stor_write(int device, lbaint_t blknr,
120 lbaint_t blkcnt, const void *buffer);
121 struct usb_device * usb_get_dev_index(int index);
122 void uhci_show_temp_int_td(void);
124 #ifdef CONFIG_PARTITIONS
125 block_dev_desc_t *usb_stor_get_dev(int index)
127 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
131 static void usb_show_progress(void)
136 /*******************************************************************************
137 * show info on storage devices; 'usb start/init' must be invoked earlier
138 * as we only retrieve structures populated during devices initialization
140 int usb_stor_info(void)
144 if (usb_max_devs > 0) {
145 for (i = 0; i < usb_max_devs; i++) {
146 printf(" Device %d: ", i);
147 dev_print(&usb_dev_desc[i]);
152 printf("No storage devices, perhaps not 'usb start'ed..?\n");
156 static unsigned int usb_get_max_lun(struct us_data *us)
159 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
160 len = usb_control_msg(us->pusb_dev,
161 usb_rcvctrlpipe(us->pusb_dev, 0),
163 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
165 result, sizeof(char),
166 USB_CNTL_TIMEOUT * 5);
167 debug("Get Max LUN -> len = %i, result = %i\n", len, (int) *result);
168 return (len > 0) ? *result : 0;
171 /*******************************************************************************
172 * scan the usb and reports device info
173 * to the user if mode = 1
174 * returns current device or -1 if no
176 int usb_stor_scan(int mode)
179 struct usb_device *dev;
182 printf(" scanning usb for storage devices... ");
184 usb_disable_asynch(1); /* asynch transfer not allowed */
186 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
187 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
188 usb_dev_desc[i].if_type = IF_TYPE_USB;
189 usb_dev_desc[i].dev = i;
190 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
191 usb_dev_desc[i].target = 0xff;
192 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
193 usb_dev_desc[i].block_read = usb_stor_read;
194 usb_dev_desc[i].block_write = usb_stor_write;
198 for (i = 0; i < USB_MAX_DEVICE; i++) {
199 dev = usb_get_dev_index(i); /* get device */
202 break; /* no more devices available */
204 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
205 /* OK, it's a storage device. Iterate over its LUNs
206 * and populate `usb_dev_desc'.
208 int lun, max_lun, start = usb_max_devs;
210 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
212 lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
214 usb_dev_desc[usb_max_devs].lun = lun;
215 if (usb_stor_get_info(dev, &usb_stor[start],
216 &usb_dev_desc[usb_max_devs]) == 1) {
221 /* if storage device */
222 if (usb_max_devs == USB_MAX_STOR_DEV) {
223 printf("max USB Storage Device reached: %d stopping\n",
229 usb_disable_asynch(0); /* asynch transfer allowed */
230 printf("%d Storage Device(s) found\n", usb_max_devs);
231 if (usb_max_devs > 0)
236 static int usb_stor_irq(struct usb_device *dev)
239 us = (struct us_data *)dev->privptr;
249 static void usb_show_srb(ccb *pccb)
252 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
253 for (i = 0; i < 12; i++)
254 printf("%02X ", pccb->cmd[i]);
258 static void display_int_status(unsigned long tmp)
260 printf("Status: %s %s %s %s %s %s %s\n",
261 (tmp & USB_ST_ACTIVE) ? "Active" : "",
262 (tmp & USB_ST_STALLED) ? "Stalled" : "",
263 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
264 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
265 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
266 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
267 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
270 /***********************************************************************
271 * Data transfer routines
272 ***********************************************************************/
274 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
283 /* determine the maximum packet size for these transfers */
284 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
286 /* while we have data left to transfer */
289 /* calculate how long this will be -- maximum or a remainder */
290 this_xfer = length > max_size ? max_size : length;
293 /* setup the retry counter */
296 /* set up the transfer loop */
298 /* transfer the data */
299 debug("Bulk xfer 0x%lx(%d) try #%d\n",
300 (ulong)map_to_sysmem(buf), this_xfer,
302 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
304 USB_CNTL_TIMEOUT * 5);
305 debug("bulk_msg returned %d xferred %d/%d\n",
306 result, partial, this_xfer);
307 if (us->pusb_dev->status != 0) {
308 /* if we stall, we need to clear it before
312 display_int_status(us->pusb_dev->status);
314 if (us->pusb_dev->status & USB_ST_STALLED) {
315 debug("stalled ->clearing endpoint" \
316 "halt for pipe 0x%x\n", pipe);
317 stat = us->pusb_dev->status;
318 usb_clear_halt(us->pusb_dev, pipe);
319 us->pusb_dev->status = stat;
320 if (this_xfer == partial) {
321 debug("bulk transferred" \
324 us->pusb_dev->status);
330 if (us->pusb_dev->status & USB_ST_NAK_REC) {
331 debug("Device NAKed bulk_msg\n");
334 debug("bulk transferred with error");
335 if (this_xfer == partial) {
336 debug(" %ld, but data ok\n",
337 us->pusb_dev->status);
340 /* if our try counter reaches 0, bail out */
341 debug(" %ld, data %d\n",
342 us->pusb_dev->status, partial);
346 /* update to show what data was transferred */
347 this_xfer -= partial;
349 /* continue until this transfer is done */
353 /* if we get here, we're done and successful */
357 static int usb_stor_BBB_reset(struct us_data *us)
363 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
365 * For Reset Recovery the host shall issue in the following order:
366 * a) a Bulk-Only Mass Storage Reset
367 * b) a Clear Feature HALT to the Bulk-In endpoint
368 * c) a Clear Feature HALT to the Bulk-Out endpoint
370 * This is done in 3 steps.
372 * If the reset doesn't succeed, the device should be port reset.
374 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
376 debug("BBB_reset\n");
377 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
379 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
380 0, us->ifnum, NULL, 0, USB_CNTL_TIMEOUT * 5);
382 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
383 debug("RESET:stall\n");
387 /* long wait for reset */
389 debug("BBB_reset result %d: status %lX reset\n",
390 result, us->pusb_dev->status);
391 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
392 result = usb_clear_halt(us->pusb_dev, pipe);
393 /* long wait for reset */
395 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
396 result, us->pusb_dev->status);
397 /* long wait for reset */
398 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
399 result = usb_clear_halt(us->pusb_dev, pipe);
401 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
402 result, us->pusb_dev->status);
403 debug("BBB_reset done\n");
407 /* FIXME: this reset function doesn't really reset the port, and it
408 * should. Actually it should probably do what it's doing here, and
409 * reset the port physically
411 static int usb_stor_CB_reset(struct us_data *us)
413 unsigned char cmd[12];
417 memset(cmd, 0xff, sizeof(cmd));
418 cmd[0] = SCSI_SEND_DIAG;
420 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
422 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
423 0, us->ifnum, cmd, sizeof(cmd),
424 USB_CNTL_TIMEOUT * 5);
426 /* long wait for reset */
428 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
429 result, us->pusb_dev->status);
430 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
431 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
433 debug("CB_reset done\n");
438 * Set up the command for a BBB device. Note that the actual SCSI
439 * command is copied into cbw.CBWCDB.
441 static int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
447 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_cbw, cbw, 1);
449 dir_in = US_DIRECTION(srb->cmd[0]);
451 #ifdef BBB_COMDAT_TRACE
452 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
453 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
456 for (result = 0; result < srb->cmdlen; result++)
457 printf("cmd[%d] %#x ", result, srb->cmd[result]);
462 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
463 debug("usb_stor_BBB_comdat:cmdlen too large\n");
467 /* always OUT to the ep */
468 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
470 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
471 cbw->dCBWTag = cpu_to_le32(CBWTag++);
472 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
473 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
474 cbw->bCBWLUN = srb->lun;
475 cbw->bCDBLength = srb->cmdlen;
476 /* copy the command data into the CBW command data buffer */
479 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
480 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
481 &actlen, USB_CNTL_TIMEOUT * 5);
483 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
487 /* FIXME: we also need a CBI_command which sets up the completion
488 * interrupt, and waits for it
490 static int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
495 unsigned long status;
498 dir_in = US_DIRECTION(srb->cmd[0]);
501 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
503 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
506 debug("CBI gets a command: Try %d\n", 5 - retry);
510 /* let's send the command via the control pipe */
511 result = usb_control_msg(us->pusb_dev,
512 usb_sndctrlpipe(us->pusb_dev , 0),
514 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
516 srb->cmd, srb->cmdlen,
517 USB_CNTL_TIMEOUT * 5);
518 debug("CB_transport: control msg returned %d, status %lX\n",
519 result, us->pusb_dev->status);
520 /* check the return code for the command */
522 if (us->pusb_dev->status & USB_ST_STALLED) {
523 status = us->pusb_dev->status;
524 debug(" stall during command found," \
526 usb_clear_halt(us->pusb_dev,
527 usb_sndctrlpipe(us->pusb_dev, 0));
528 us->pusb_dev->status = status;
530 debug(" error during command %02X" \
531 " Stat = %lX\n", srb->cmd[0],
532 us->pusb_dev->status);
535 /* transfer the data payload for this command, if one exists*/
537 debug("CB_transport: control msg returned %d," \
538 " direction is %s to go 0x%lx\n", result,
539 dir_in ? "IN" : "OUT", srb->datalen);
541 result = us_one_transfer(us, pipe, (char *)srb->pdata,
543 debug("CBI attempted to transfer data," \
544 " result is %d status %lX, len %d\n",
545 result, us->pusb_dev->status,
546 us->pusb_dev->act_len);
547 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
549 } /* if (srb->datalen) */
559 static int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
564 submit_int_msg(us->pusb_dev, us->irqpipe,
565 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
568 if (us->ip_wanted == 0)
573 printf(" Did not get interrupt on CBI\n");
575 return USB_STOR_TRANSPORT_ERROR;
577 debug("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
578 us->ip_data, us->pusb_dev->irq_act_len,
579 us->pusb_dev->irq_status);
580 /* UFI gives us ASC and ASCQ, like a request sense */
581 if (us->subclass == US_SC_UFI) {
582 if (srb->cmd[0] == SCSI_REQ_SENSE ||
583 srb->cmd[0] == SCSI_INQUIRY)
584 return USB_STOR_TRANSPORT_GOOD; /* Good */
585 else if (us->ip_data)
586 return USB_STOR_TRANSPORT_FAILED;
588 return USB_STOR_TRANSPORT_GOOD;
590 /* otherwise, we interpret the data normally */
591 switch (us->ip_data) {
593 return USB_STOR_TRANSPORT_GOOD;
595 return USB_STOR_TRANSPORT_FAILED;
597 return USB_STOR_TRANSPORT_ERROR;
599 return USB_STOR_TRANSPORT_ERROR;
602 #define USB_TRANSPORT_UNKNOWN_RETRY 5
603 #define USB_TRANSPORT_NOT_READY_RETRY 10
605 /* clear a stall on an endpoint - special for BBB devices */
606 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
610 /* ENDPOINT_HALT = 0, so set value to 0 */
611 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
612 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
613 0, endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
617 static int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
621 int actlen, data_actlen;
622 unsigned int pipe, pipein, pipeout;
623 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_csw, csw, 1);
624 #ifdef BBB_XPORT_TRACE
629 dir_in = US_DIRECTION(srb->cmd[0]);
632 debug("COMMAND phase\n");
633 result = usb_stor_BBB_comdat(srb, us);
635 debug("failed to send CBW status %ld\n",
636 us->pusb_dev->status);
637 usb_stor_BBB_reset(us);
638 return USB_STOR_TRANSPORT_FAILED;
640 if (!(us->flags & USB_READY))
642 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
643 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
644 /* DATA phase + error handling */
646 /* no data, go immediately to the STATUS phase */
647 if (srb->datalen == 0)
649 debug("DATA phase\n");
655 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
656 &data_actlen, USB_CNTL_TIMEOUT * 5);
657 /* special handling of STALL in DATA phase */
658 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
659 debug("DATA:stall\n");
660 /* clear the STALL on the endpoint */
661 result = usb_stor_BBB_clear_endpt_stall(us,
662 dir_in ? us->ep_in : us->ep_out);
664 /* continue on to STATUS phase */
668 debug("usb_bulk_msg error status %ld\n",
669 us->pusb_dev->status);
670 usb_stor_BBB_reset(us);
671 return USB_STOR_TRANSPORT_FAILED;
673 #ifdef BBB_XPORT_TRACE
674 for (index = 0; index < data_actlen; index++)
675 printf("pdata[%d] %#x ", index, srb->pdata[index]);
678 /* STATUS phase + error handling */
682 debug("STATUS phase\n");
683 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
684 &actlen, USB_CNTL_TIMEOUT*5);
686 /* special handling of STALL in STATUS phase */
687 if ((result < 0) && (retry < 1) &&
688 (us->pusb_dev->status & USB_ST_STALLED)) {
689 debug("STATUS:stall\n");
690 /* clear the STALL on the endpoint */
691 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
692 if (result >= 0 && (retry++ < 1))
697 debug("usb_bulk_msg error status %ld\n",
698 us->pusb_dev->status);
699 usb_stor_BBB_reset(us);
700 return USB_STOR_TRANSPORT_FAILED;
702 #ifdef BBB_XPORT_TRACE
703 ptr = (unsigned char *)csw;
704 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
705 printf("ptr[%d] %#x ", index, ptr[index]);
708 /* misuse pipe to get the residue */
709 pipe = le32_to_cpu(csw->dCSWDataResidue);
710 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
711 pipe = srb->datalen - data_actlen;
712 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
713 debug("!CSWSIGNATURE\n");
714 usb_stor_BBB_reset(us);
715 return USB_STOR_TRANSPORT_FAILED;
716 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
718 usb_stor_BBB_reset(us);
719 return USB_STOR_TRANSPORT_FAILED;
720 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
722 usb_stor_BBB_reset(us);
723 return USB_STOR_TRANSPORT_FAILED;
724 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
726 usb_stor_BBB_reset(us);
727 return USB_STOR_TRANSPORT_FAILED;
728 } else if (data_actlen > srb->datalen) {
729 debug("transferred %dB instead of %ldB\n",
730 data_actlen, srb->datalen);
731 return USB_STOR_TRANSPORT_FAILED;
732 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
734 return USB_STOR_TRANSPORT_FAILED;
740 static int usb_stor_CB_transport(ccb *srb, struct us_data *us)
748 status = USB_STOR_TRANSPORT_GOOD;
751 /* issue the command */
753 result = usb_stor_CB_comdat(srb, us);
754 debug("command / Data returned %d, status %lX\n",
755 result, us->pusb_dev->status);
756 /* if this is an CBI Protocol, get IRQ */
757 if (us->protocol == US_PR_CBI) {
758 status = usb_stor_CBI_get_status(srb, us);
759 /* if the status is error, report it */
760 if (status == USB_STOR_TRANSPORT_ERROR) {
761 debug(" USB CBI Command Error\n");
764 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
765 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
767 /* if the status is good, report it */
768 if (status == USB_STOR_TRANSPORT_GOOD) {
769 debug(" USB CBI Command Good\n");
774 /* do we have to issue an auto request? */
775 /* HERE we have to check the result */
776 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
777 debug("ERROR %lX\n", us->pusb_dev->status);
778 us->transport_reset(us);
779 return USB_STOR_TRANSPORT_ERROR;
781 if ((us->protocol == US_PR_CBI) &&
782 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
783 (srb->cmd[0] == SCSI_INQUIRY))) {
784 /* do not issue an autorequest after request sense */
785 debug("No auto request and good\n");
786 return USB_STOR_TRANSPORT_GOOD;
788 /* issue an request_sense */
789 memset(&psrb->cmd[0], 0, 12);
790 psrb->cmd[0] = SCSI_REQ_SENSE;
791 psrb->cmd[1] = srb->lun << 5;
794 psrb->pdata = &srb->sense_buf[0];
796 /* issue the command */
797 result = usb_stor_CB_comdat(psrb, us);
798 debug("auto request returned %d\n", result);
799 /* if this is an CBI Protocol, get IRQ */
800 if (us->protocol == US_PR_CBI)
801 status = usb_stor_CBI_get_status(psrb, us);
803 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
804 debug(" AUTO REQUEST ERROR %ld\n",
805 us->pusb_dev->status);
806 return USB_STOR_TRANSPORT_ERROR;
808 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
809 srb->sense_buf[0], srb->sense_buf[2],
810 srb->sense_buf[12], srb->sense_buf[13]);
811 /* Check the auto request result */
812 if ((srb->sense_buf[2] == 0) &&
813 (srb->sense_buf[12] == 0) &&
814 (srb->sense_buf[13] == 0)) {
816 return USB_STOR_TRANSPORT_GOOD;
819 /* Check the auto request result */
820 switch (srb->sense_buf[2]) {
822 /* Recovered Error */
823 return USB_STOR_TRANSPORT_GOOD;
827 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
828 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
829 " 0x%02X (NOT READY)\n", srb->cmd[0],
830 srb->sense_buf[0], srb->sense_buf[2],
831 srb->sense_buf[12], srb->sense_buf[13]);
832 return USB_STOR_TRANSPORT_FAILED;
839 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
840 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
841 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
842 srb->sense_buf[2], srb->sense_buf[12],
844 return USB_STOR_TRANSPORT_FAILED;
849 return USB_STOR_TRANSPORT_FAILED;
853 static int usb_inquiry(ccb *srb, struct us_data *ss)
858 memset(&srb->cmd[0], 0, 12);
859 srb->cmd[0] = SCSI_INQUIRY;
860 srb->cmd[1] = srb->lun << 5;
864 i = ss->transport(srb, ss);
865 debug("inquiry returns %d\n", i);
871 printf("error in inquiry\n");
877 static int usb_request_sense(ccb *srb, struct us_data *ss)
881 ptr = (char *)srb->pdata;
882 memset(&srb->cmd[0], 0, 12);
883 srb->cmd[0] = SCSI_REQ_SENSE;
884 srb->cmd[1] = srb->lun << 5;
887 srb->pdata = &srb->sense_buf[0];
889 ss->transport(srb, ss);
890 debug("Request Sense returned %02X %02X %02X\n",
891 srb->sense_buf[2], srb->sense_buf[12],
893 srb->pdata = (uchar *)ptr;
897 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
902 memset(&srb->cmd[0], 0, 12);
903 srb->cmd[0] = SCSI_TST_U_RDY;
904 srb->cmd[1] = srb->lun << 5;
907 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
908 ss->flags |= USB_READY;
911 usb_request_sense(srb, ss);
913 * Check the Key Code Qualifier, if it matches
914 * "Not Ready - medium not present"
915 * (the sense Key equals 0x2 and the ASC is 0x3a)
916 * return immediately as the medium being absent won't change
917 * unless there is a user action.
919 if ((srb->sense_buf[2] == 0x02) &&
920 (srb->sense_buf[12] == 0x3a))
928 static int usb_read_capacity(ccb *srb, struct us_data *ss)
934 memset(&srb->cmd[0], 0, 12);
935 srb->cmd[0] = SCSI_RD_CAPAC;
936 srb->cmd[1] = srb->lun << 5;
939 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
946 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
947 unsigned short blocks)
949 memset(&srb->cmd[0], 0, 12);
950 srb->cmd[0] = SCSI_READ10;
951 srb->cmd[1] = srb->lun << 5;
952 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
953 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
954 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
955 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
956 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
957 srb->cmd[8] = (unsigned char) blocks & 0xff;
959 debug("read10: start %lx blocks %x\n", start, blocks);
960 return ss->transport(srb, ss);
963 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
964 unsigned short blocks)
966 memset(&srb->cmd[0], 0, 12);
967 srb->cmd[0] = SCSI_WRITE10;
968 srb->cmd[1] = srb->lun << 5;
969 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
970 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
971 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
972 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
973 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
974 srb->cmd[8] = (unsigned char) blocks & 0xff;
976 debug("write10: start %lx blocks %x\n", start, blocks);
977 return ss->transport(srb, ss);
981 #ifdef CONFIG_USB_BIN_FIXUP
983 * Some USB storage devices queried for SCSI identification data respond with
984 * binary strings, which if output to the console freeze the terminal. The
985 * workaround is to modify the vendor and product strings read from such
986 * device with proper values (as reported by 'usb info').
988 * Vendor and product length limits are taken from the definition of
989 * block_dev_desc_t in include/part.h.
991 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
992 unsigned char vendor[],
993 unsigned char product[]) {
994 const unsigned char max_vendor_len = 40;
995 const unsigned char max_product_len = 20;
996 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
997 strncpy((char *)vendor, "SMSC", max_vendor_len);
998 strncpy((char *)product, "Flash Media Cntrller",
1002 #endif /* CONFIG_USB_BIN_FIXUP */
1004 unsigned long usb_stor_read(int device, lbaint_t blknr,
1005 lbaint_t blkcnt, void *buffer)
1007 lbaint_t start, blks;
1009 unsigned short smallblks;
1010 struct usb_device *dev;
1013 ccb *srb = &usb_ccb;
1020 debug("\nusb_read: dev %d\n", device);
1021 dev = usb_dev_desc[device].priv;
1023 debug("%s: No device\n", __func__);
1026 ss = (struct us_data *)dev->privptr;
1028 usb_disable_asynch(1); /* asynch transfer not allowed */
1029 srb->lun = usb_dev_desc[device].lun;
1030 buf_addr = (uintptr_t)buffer;
1034 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF
1035 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1038 /* XXX need some comment here */
1040 srb->pdata = (unsigned char *)buf_addr;
1041 if (blks > USB_MAX_XFER_BLK)
1042 smallblks = USB_MAX_XFER_BLK;
1044 smallblks = (unsigned short) blks;
1046 if (smallblks == USB_MAX_XFER_BLK)
1047 usb_show_progress();
1048 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1049 srb->pdata = (unsigned char *)buf_addr;
1050 if (usb_read_10(srb, ss, start, smallblks)) {
1051 debug("Read ERROR\n");
1052 usb_request_sense(srb, ss);
1060 buf_addr += srb->datalen;
1061 } while (blks != 0);
1062 ss->flags &= ~USB_READY;
1064 debug("usb_read: end startblk " LBAF
1065 ", blccnt %x buffer %" PRIxPTR "\n",
1066 start, smallblks, buf_addr);
1068 usb_disable_asynch(0); /* asynch transfer allowed */
1069 if (blkcnt >= USB_MAX_XFER_BLK)
1074 unsigned long usb_stor_write(int device, lbaint_t blknr,
1075 lbaint_t blkcnt, const void *buffer)
1077 lbaint_t start, blks;
1079 unsigned short smallblks;
1080 struct usb_device *dev;
1083 ccb *srb = &usb_ccb;
1090 debug("\nusb_write: dev %d\n", device);
1091 dev = usb_dev_desc[device].priv;
1094 ss = (struct us_data *)dev->privptr;
1096 usb_disable_asynch(1); /* asynch transfer not allowed */
1098 srb->lun = usb_dev_desc[device].lun;
1099 buf_addr = (uintptr_t)buffer;
1103 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF
1104 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1107 /* If write fails retry for max retry count else
1108 * return with number of blocks written successfully.
1111 srb->pdata = (unsigned char *)buf_addr;
1112 if (blks > USB_MAX_XFER_BLK)
1113 smallblks = USB_MAX_XFER_BLK;
1115 smallblks = (unsigned short) blks;
1117 if (smallblks == USB_MAX_XFER_BLK)
1118 usb_show_progress();
1119 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1120 srb->pdata = (unsigned char *)buf_addr;
1121 if (usb_write_10(srb, ss, start, smallblks)) {
1122 debug("Write ERROR\n");
1123 usb_request_sense(srb, ss);
1131 buf_addr += srb->datalen;
1132 } while (blks != 0);
1133 ss->flags &= ~USB_READY;
1135 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %"
1136 PRIxPTR "\n", start, smallblks, buf_addr);
1138 usb_disable_asynch(0); /* asynch transfer allowed */
1139 if (blkcnt >= USB_MAX_XFER_BLK)
1145 /* Probe to see if a new device is actually a Storage device */
1146 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1149 struct usb_interface *iface;
1151 struct usb_endpoint_descriptor *ep_desc;
1152 unsigned int flags = 0;
1157 /* let's examine the device now */
1158 iface = &dev->config.if_desc[ifnum];
1161 /* this is the place to patch some storage devices */
1162 debug("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1163 dev->descriptor.idProduct);
1165 if ((dev->descriptor.idVendor) == 0x066b &&
1166 (dev->descriptor.idProduct) == 0x0103) {
1167 debug("patched for E-USB\n");
1168 protocol = US_PR_CB;
1169 subclass = US_SC_UFI; /* an assumption */
1173 if (dev->descriptor.bDeviceClass != 0 ||
1174 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1175 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1176 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1177 debug("Not mass storage\n");
1178 /* if it's not a mass storage, we go no further */
1182 memset(ss, 0, sizeof(struct us_data));
1184 /* At this point, we know we've got a live one */
1185 debug("\n\nUSB Mass Storage device detected\n");
1187 /* Initialize the us_data structure with some useful info */
1191 ss->attention_done = 0;
1193 /* If the device has subclass and protocol, then use that. Otherwise,
1194 * take data from the specific interface.
1197 ss->subclass = subclass;
1198 ss->protocol = protocol;
1200 ss->subclass = iface->desc.bInterfaceSubClass;
1201 ss->protocol = iface->desc.bInterfaceProtocol;
1204 /* set the handler pointers based on the protocol */
1205 debug("Transport: ");
1206 switch (ss->protocol) {
1208 debug("Control/Bulk\n");
1209 ss->transport = usb_stor_CB_transport;
1210 ss->transport_reset = usb_stor_CB_reset;
1214 debug("Control/Bulk/Interrupt\n");
1215 ss->transport = usb_stor_CB_transport;
1216 ss->transport_reset = usb_stor_CB_reset;
1219 debug("Bulk/Bulk/Bulk\n");
1220 ss->transport = usb_stor_BBB_transport;
1221 ss->transport_reset = usb_stor_BBB_reset;
1224 printf("USB Storage Transport unknown / not yet implemented\n");
1230 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1231 * An optional interrupt is OK (necessary for CBI protocol).
1232 * We will ignore any others.
1234 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1235 ep_desc = &iface->ep_desc[i];
1236 /* is it an BULK endpoint? */
1237 if ((ep_desc->bmAttributes &
1238 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1239 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1240 ss->ep_in = ep_desc->bEndpointAddress &
1241 USB_ENDPOINT_NUMBER_MASK;
1244 ep_desc->bEndpointAddress &
1245 USB_ENDPOINT_NUMBER_MASK;
1248 /* is it an interrupt endpoint? */
1249 if ((ep_desc->bmAttributes &
1250 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1251 ss->ep_int = ep_desc->bEndpointAddress &
1252 USB_ENDPOINT_NUMBER_MASK;
1253 ss->irqinterval = ep_desc->bInterval;
1256 debug("Endpoints In %d Out %d Int %d\n",
1257 ss->ep_in, ss->ep_out, ss->ep_int);
1259 /* Do some basic sanity checks, and bail if we find a problem */
1260 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1261 !ss->ep_in || !ss->ep_out ||
1262 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1263 debug("Problems with device\n");
1266 /* set class specific stuff */
1267 /* We only handle certain protocols. Currently, these are
1269 * The SFF8070 accepts the requests used in u-boot
1271 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1272 ss->subclass != US_SC_8070) {
1273 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1277 /* we had found an interrupt endpoint, prepare irq pipe
1278 * set up the IRQ pipe and handler
1280 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1281 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1282 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1283 dev->irq_handle = usb_stor_irq;
1285 dev->privptr = (void *)ss;
1289 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1290 block_dev_desc_t *dev_desc)
1292 unsigned char perq, modi;
1293 ALLOC_CACHE_ALIGN_BUFFER(u32, cap, 2);
1294 ALLOC_CACHE_ALIGN_BUFFER(u8, usb_stor_buf, 36);
1295 u32 capacity, blksz;
1296 ccb *pccb = &usb_ccb;
1298 pccb->pdata = usb_stor_buf;
1300 dev_desc->target = dev->devnum;
1301 pccb->lun = dev_desc->lun;
1302 debug(" address %d\n", dev_desc->target);
1304 if (usb_inquiry(pccb, ss)) {
1305 debug("%s: usb_inquiry() failed\n", __func__);
1309 perq = usb_stor_buf[0];
1310 modi = usb_stor_buf[1];
1313 * Skip unknown devices (0x1f) and enclosure service devices (0x0d),
1314 * they would not respond to test_unit_ready .
1316 if (((perq & 0x1f) == 0x1f) || ((perq & 0x1f) == 0x0d)) {
1317 debug("%s: unknown/unsupported device\n", __func__);
1320 if ((modi&0x80) == 0x80) {
1321 /* drive is removable */
1322 dev_desc->removable = 1;
1324 memcpy(dev_desc->vendor, (const void *)&usb_stor_buf[8], 8);
1325 memcpy(dev_desc->product, (const void *)&usb_stor_buf[16], 16);
1326 memcpy(dev_desc->revision, (const void *)&usb_stor_buf[32], 4);
1327 dev_desc->vendor[8] = 0;
1328 dev_desc->product[16] = 0;
1329 dev_desc->revision[4] = 0;
1330 #ifdef CONFIG_USB_BIN_FIXUP
1331 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1332 (uchar *)dev_desc->product);
1333 #endif /* CONFIG_USB_BIN_FIXUP */
1334 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1336 if (usb_test_unit_ready(pccb, ss)) {
1337 printf("Device NOT ready\n"
1338 " Request Sense returned %02X %02X %02X\n",
1339 pccb->sense_buf[2], pccb->sense_buf[12],
1340 pccb->sense_buf[13]);
1341 if (dev_desc->removable == 1) {
1342 dev_desc->type = perq;
1347 pccb->pdata = (unsigned char *)cap;
1348 memset(pccb->pdata, 0, 8);
1349 if (usb_read_capacity(pccb, ss) != 0) {
1350 printf("READ_CAP ERROR\n");
1354 ss->flags &= ~USB_READY;
1355 debug("Read Capacity returns: 0x%08x, 0x%08x\n", cap[0], cap[1]);
1357 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1360 cap[0] = cpu_to_be32(cap[0]);
1361 cap[1] = cpu_to_be32(cap[1]);
1364 capacity = be32_to_cpu(cap[0]) + 1;
1365 blksz = be32_to_cpu(cap[1]);
1367 debug("Capacity = 0x%08x, blocksz = 0x%08x\n", capacity, blksz);
1368 dev_desc->lba = capacity;
1369 dev_desc->blksz = blksz;
1370 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1371 dev_desc->type = perq;
1372 debug(" address %d\n", dev_desc->target);
1373 debug("partype: %d\n", dev_desc->part_type);
1375 init_part(dev_desc);
1377 debug("partype: %d\n", dev_desc->part_type);