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 static int usb_storage_register(struct usb_device *dev, unsigned char iface)
173 int lun, max_lun, start = usb_max_devs;
176 if (!usb_storage_probe(dev, iface, &usb_stor[usb_max_devs]))
180 * OK, it's a storage device. Iterate over its LUNs
181 * and populate `usb_dev_desc'.
183 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
184 for (lun = 0; lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV; lun++) {
185 usb_dev_desc[usb_max_devs].lun = lun;
186 if (usb_stor_get_info(dev, &usb_stor[start],
187 &usb_dev_desc[usb_max_devs]) == 1) {
195 /*******************************************************************************
196 * scan the usb and reports device info
197 * to the user if mode = 1
198 * returns current device or -1 if no
200 int usb_stor_scan(int mode)
202 unsigned char i, iface;
203 struct usb_device *dev;
206 printf(" scanning usb for storage devices... ");
208 usb_disable_asynch(1); /* asynch transfer not allowed */
210 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
211 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
212 usb_dev_desc[i].if_type = IF_TYPE_USB;
213 usb_dev_desc[i].dev = i;
214 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
215 usb_dev_desc[i].target = 0xff;
216 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
217 usb_dev_desc[i].block_read = usb_stor_read;
218 usb_dev_desc[i].block_write = usb_stor_write;
222 for (i = 0; i < USB_MAX_DEVICE; i++) {
223 dev = usb_get_dev_index(i); /* get device */
226 break; /* no more devices available */
228 for (iface = 0; iface < dev->config.no_of_if; iface++) {
229 usb_max_devs += usb_storage_register(dev, iface);
232 /* if storage device */
233 if (usb_max_devs == USB_MAX_STOR_DEV) {
234 printf("max USB Storage Device reached: %d stopping\n",
240 usb_disable_asynch(0); /* asynch transfer allowed */
241 printf("%d Storage Device(s) found\n", usb_max_devs);
242 if (usb_max_devs > 0)
247 static int usb_stor_irq(struct usb_device *dev)
250 us = (struct us_data *)dev->privptr;
260 static void usb_show_srb(ccb *pccb)
263 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
264 for (i = 0; i < 12; i++)
265 printf("%02X ", pccb->cmd[i]);
269 static void display_int_status(unsigned long tmp)
271 printf("Status: %s %s %s %s %s %s %s\n",
272 (tmp & USB_ST_ACTIVE) ? "Active" : "",
273 (tmp & USB_ST_STALLED) ? "Stalled" : "",
274 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
275 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
276 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
277 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
278 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
281 /***********************************************************************
282 * Data transfer routines
283 ***********************************************************************/
285 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
294 /* determine the maximum packet size for these transfers */
295 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
297 /* while we have data left to transfer */
300 /* calculate how long this will be -- maximum or a remainder */
301 this_xfer = length > max_size ? max_size : length;
304 /* setup the retry counter */
307 /* set up the transfer loop */
309 /* transfer the data */
310 debug("Bulk xfer 0x%lx(%d) try #%d\n",
311 (ulong)map_to_sysmem(buf), this_xfer,
313 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
315 USB_CNTL_TIMEOUT * 5);
316 debug("bulk_msg returned %d xferred %d/%d\n",
317 result, partial, this_xfer);
318 if (us->pusb_dev->status != 0) {
319 /* if we stall, we need to clear it before
323 display_int_status(us->pusb_dev->status);
325 if (us->pusb_dev->status & USB_ST_STALLED) {
326 debug("stalled ->clearing endpoint" \
327 "halt for pipe 0x%x\n", pipe);
328 stat = us->pusb_dev->status;
329 usb_clear_halt(us->pusb_dev, pipe);
330 us->pusb_dev->status = stat;
331 if (this_xfer == partial) {
332 debug("bulk transferred" \
335 us->pusb_dev->status);
341 if (us->pusb_dev->status & USB_ST_NAK_REC) {
342 debug("Device NAKed bulk_msg\n");
345 debug("bulk transferred with error");
346 if (this_xfer == partial) {
347 debug(" %ld, but data ok\n",
348 us->pusb_dev->status);
351 /* if our try counter reaches 0, bail out */
352 debug(" %ld, data %d\n",
353 us->pusb_dev->status, partial);
357 /* update to show what data was transferred */
358 this_xfer -= partial;
360 /* continue until this transfer is done */
364 /* if we get here, we're done and successful */
368 static int usb_stor_BBB_reset(struct us_data *us)
374 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
376 * For Reset Recovery the host shall issue in the following order:
377 * a) a Bulk-Only Mass Storage Reset
378 * b) a Clear Feature HALT to the Bulk-In endpoint
379 * c) a Clear Feature HALT to the Bulk-Out endpoint
381 * This is done in 3 steps.
383 * If the reset doesn't succeed, the device should be port reset.
385 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
387 debug("BBB_reset\n");
388 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
390 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
391 0, us->ifnum, NULL, 0, USB_CNTL_TIMEOUT * 5);
393 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
394 debug("RESET:stall\n");
398 /* long wait for reset */
400 debug("BBB_reset result %d: status %lX reset\n",
401 result, us->pusb_dev->status);
402 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
403 result = usb_clear_halt(us->pusb_dev, pipe);
404 /* long wait for reset */
406 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
407 result, us->pusb_dev->status);
408 /* long wait for reset */
409 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
410 result = usb_clear_halt(us->pusb_dev, pipe);
412 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
413 result, us->pusb_dev->status);
414 debug("BBB_reset done\n");
418 /* FIXME: this reset function doesn't really reset the port, and it
419 * should. Actually it should probably do what it's doing here, and
420 * reset the port physically
422 static int usb_stor_CB_reset(struct us_data *us)
424 unsigned char cmd[12];
428 memset(cmd, 0xff, sizeof(cmd));
429 cmd[0] = SCSI_SEND_DIAG;
431 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
433 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
434 0, us->ifnum, cmd, sizeof(cmd),
435 USB_CNTL_TIMEOUT * 5);
437 /* long wait for reset */
439 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
440 result, us->pusb_dev->status);
441 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
442 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
444 debug("CB_reset done\n");
449 * Set up the command for a BBB device. Note that the actual SCSI
450 * command is copied into cbw.CBWCDB.
452 static int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
458 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_cbw, cbw, 1);
460 dir_in = US_DIRECTION(srb->cmd[0]);
462 #ifdef BBB_COMDAT_TRACE
463 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
464 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
467 for (result = 0; result < srb->cmdlen; result++)
468 printf("cmd[%d] %#x ", result, srb->cmd[result]);
473 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
474 debug("usb_stor_BBB_comdat:cmdlen too large\n");
478 /* always OUT to the ep */
479 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
481 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
482 cbw->dCBWTag = cpu_to_le32(CBWTag++);
483 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
484 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
485 cbw->bCBWLUN = srb->lun;
486 cbw->bCDBLength = srb->cmdlen;
487 /* copy the command data into the CBW command data buffer */
490 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
491 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
492 &actlen, USB_CNTL_TIMEOUT * 5);
494 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
498 /* FIXME: we also need a CBI_command which sets up the completion
499 * interrupt, and waits for it
501 static int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
506 unsigned long status;
509 dir_in = US_DIRECTION(srb->cmd[0]);
512 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
514 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
517 debug("CBI gets a command: Try %d\n", 5 - retry);
521 /* let's send the command via the control pipe */
522 result = usb_control_msg(us->pusb_dev,
523 usb_sndctrlpipe(us->pusb_dev , 0),
525 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
527 srb->cmd, srb->cmdlen,
528 USB_CNTL_TIMEOUT * 5);
529 debug("CB_transport: control msg returned %d, status %lX\n",
530 result, us->pusb_dev->status);
531 /* check the return code for the command */
533 if (us->pusb_dev->status & USB_ST_STALLED) {
534 status = us->pusb_dev->status;
535 debug(" stall during command found," \
537 usb_clear_halt(us->pusb_dev,
538 usb_sndctrlpipe(us->pusb_dev, 0));
539 us->pusb_dev->status = status;
541 debug(" error during command %02X" \
542 " Stat = %lX\n", srb->cmd[0],
543 us->pusb_dev->status);
546 /* transfer the data payload for this command, if one exists*/
548 debug("CB_transport: control msg returned %d," \
549 " direction is %s to go 0x%lx\n", result,
550 dir_in ? "IN" : "OUT", srb->datalen);
552 result = us_one_transfer(us, pipe, (char *)srb->pdata,
554 debug("CBI attempted to transfer data," \
555 " result is %d status %lX, len %d\n",
556 result, us->pusb_dev->status,
557 us->pusb_dev->act_len);
558 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
560 } /* if (srb->datalen) */
570 static int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
575 submit_int_msg(us->pusb_dev, us->irqpipe,
576 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
579 if (us->ip_wanted == 0)
584 printf(" Did not get interrupt on CBI\n");
586 return USB_STOR_TRANSPORT_ERROR;
588 debug("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
589 us->ip_data, us->pusb_dev->irq_act_len,
590 us->pusb_dev->irq_status);
591 /* UFI gives us ASC and ASCQ, like a request sense */
592 if (us->subclass == US_SC_UFI) {
593 if (srb->cmd[0] == SCSI_REQ_SENSE ||
594 srb->cmd[0] == SCSI_INQUIRY)
595 return USB_STOR_TRANSPORT_GOOD; /* Good */
596 else if (us->ip_data)
597 return USB_STOR_TRANSPORT_FAILED;
599 return USB_STOR_TRANSPORT_GOOD;
601 /* otherwise, we interpret the data normally */
602 switch (us->ip_data) {
604 return USB_STOR_TRANSPORT_GOOD;
606 return USB_STOR_TRANSPORT_FAILED;
608 return USB_STOR_TRANSPORT_ERROR;
610 return USB_STOR_TRANSPORT_ERROR;
613 #define USB_TRANSPORT_UNKNOWN_RETRY 5
614 #define USB_TRANSPORT_NOT_READY_RETRY 10
616 /* clear a stall on an endpoint - special for BBB devices */
617 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
621 /* ENDPOINT_HALT = 0, so set value to 0 */
622 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
623 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
624 0, endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
628 static int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
632 int actlen, data_actlen;
633 unsigned int pipe, pipein, pipeout;
634 ALLOC_CACHE_ALIGN_BUFFER(struct umass_bbb_csw, csw, 1);
635 #ifdef BBB_XPORT_TRACE
640 dir_in = US_DIRECTION(srb->cmd[0]);
643 debug("COMMAND phase\n");
644 result = usb_stor_BBB_comdat(srb, us);
646 debug("failed to send CBW status %ld\n",
647 us->pusb_dev->status);
648 usb_stor_BBB_reset(us);
649 return USB_STOR_TRANSPORT_FAILED;
651 if (!(us->flags & USB_READY))
653 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
654 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
655 /* DATA phase + error handling */
657 /* no data, go immediately to the STATUS phase */
658 if (srb->datalen == 0)
660 debug("DATA phase\n");
666 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
667 &data_actlen, USB_CNTL_TIMEOUT * 5);
668 /* special handling of STALL in DATA phase */
669 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
670 debug("DATA:stall\n");
671 /* clear the STALL on the endpoint */
672 result = usb_stor_BBB_clear_endpt_stall(us,
673 dir_in ? us->ep_in : us->ep_out);
675 /* continue on to STATUS phase */
679 debug("usb_bulk_msg error status %ld\n",
680 us->pusb_dev->status);
681 usb_stor_BBB_reset(us);
682 return USB_STOR_TRANSPORT_FAILED;
684 #ifdef BBB_XPORT_TRACE
685 for (index = 0; index < data_actlen; index++)
686 printf("pdata[%d] %#x ", index, srb->pdata[index]);
689 /* STATUS phase + error handling */
693 debug("STATUS phase\n");
694 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
695 &actlen, USB_CNTL_TIMEOUT*5);
697 /* special handling of STALL in STATUS phase */
698 if ((result < 0) && (retry < 1) &&
699 (us->pusb_dev->status & USB_ST_STALLED)) {
700 debug("STATUS:stall\n");
701 /* clear the STALL on the endpoint */
702 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
703 if (result >= 0 && (retry++ < 1))
708 debug("usb_bulk_msg error status %ld\n",
709 us->pusb_dev->status);
710 usb_stor_BBB_reset(us);
711 return USB_STOR_TRANSPORT_FAILED;
713 #ifdef BBB_XPORT_TRACE
714 ptr = (unsigned char *)csw;
715 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
716 printf("ptr[%d] %#x ", index, ptr[index]);
719 /* misuse pipe to get the residue */
720 pipe = le32_to_cpu(csw->dCSWDataResidue);
721 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
722 pipe = srb->datalen - data_actlen;
723 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
724 debug("!CSWSIGNATURE\n");
725 usb_stor_BBB_reset(us);
726 return USB_STOR_TRANSPORT_FAILED;
727 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
729 usb_stor_BBB_reset(us);
730 return USB_STOR_TRANSPORT_FAILED;
731 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
733 usb_stor_BBB_reset(us);
734 return USB_STOR_TRANSPORT_FAILED;
735 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
737 usb_stor_BBB_reset(us);
738 return USB_STOR_TRANSPORT_FAILED;
739 } else if (data_actlen > srb->datalen) {
740 debug("transferred %dB instead of %ldB\n",
741 data_actlen, srb->datalen);
742 return USB_STOR_TRANSPORT_FAILED;
743 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
745 return USB_STOR_TRANSPORT_FAILED;
751 static int usb_stor_CB_transport(ccb *srb, struct us_data *us)
759 status = USB_STOR_TRANSPORT_GOOD;
762 /* issue the command */
764 result = usb_stor_CB_comdat(srb, us);
765 debug("command / Data returned %d, status %lX\n",
766 result, us->pusb_dev->status);
767 /* if this is an CBI Protocol, get IRQ */
768 if (us->protocol == US_PR_CBI) {
769 status = usb_stor_CBI_get_status(srb, us);
770 /* if the status is error, report it */
771 if (status == USB_STOR_TRANSPORT_ERROR) {
772 debug(" USB CBI Command Error\n");
775 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
776 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
778 /* if the status is good, report it */
779 if (status == USB_STOR_TRANSPORT_GOOD) {
780 debug(" USB CBI Command Good\n");
785 /* do we have to issue an auto request? */
786 /* HERE we have to check the result */
787 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
788 debug("ERROR %lX\n", us->pusb_dev->status);
789 us->transport_reset(us);
790 return USB_STOR_TRANSPORT_ERROR;
792 if ((us->protocol == US_PR_CBI) &&
793 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
794 (srb->cmd[0] == SCSI_INQUIRY))) {
795 /* do not issue an autorequest after request sense */
796 debug("No auto request and good\n");
797 return USB_STOR_TRANSPORT_GOOD;
799 /* issue an request_sense */
800 memset(&psrb->cmd[0], 0, 12);
801 psrb->cmd[0] = SCSI_REQ_SENSE;
802 psrb->cmd[1] = srb->lun << 5;
805 psrb->pdata = &srb->sense_buf[0];
807 /* issue the command */
808 result = usb_stor_CB_comdat(psrb, us);
809 debug("auto request returned %d\n", result);
810 /* if this is an CBI Protocol, get IRQ */
811 if (us->protocol == US_PR_CBI)
812 status = usb_stor_CBI_get_status(psrb, us);
814 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
815 debug(" AUTO REQUEST ERROR %ld\n",
816 us->pusb_dev->status);
817 return USB_STOR_TRANSPORT_ERROR;
819 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
820 srb->sense_buf[0], srb->sense_buf[2],
821 srb->sense_buf[12], srb->sense_buf[13]);
822 /* Check the auto request result */
823 if ((srb->sense_buf[2] == 0) &&
824 (srb->sense_buf[12] == 0) &&
825 (srb->sense_buf[13] == 0)) {
827 return USB_STOR_TRANSPORT_GOOD;
830 /* Check the auto request result */
831 switch (srb->sense_buf[2]) {
833 /* Recovered Error */
834 return USB_STOR_TRANSPORT_GOOD;
838 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
839 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
840 " 0x%02X (NOT READY)\n", srb->cmd[0],
841 srb->sense_buf[0], srb->sense_buf[2],
842 srb->sense_buf[12], srb->sense_buf[13]);
843 return USB_STOR_TRANSPORT_FAILED;
850 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
851 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
852 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
853 srb->sense_buf[2], srb->sense_buf[12],
855 return USB_STOR_TRANSPORT_FAILED;
860 return USB_STOR_TRANSPORT_FAILED;
864 static int usb_inquiry(ccb *srb, struct us_data *ss)
869 memset(&srb->cmd[0], 0, 12);
870 srb->cmd[0] = SCSI_INQUIRY;
871 srb->cmd[1] = srb->lun << 5;
875 i = ss->transport(srb, ss);
876 debug("inquiry returns %d\n", i);
882 printf("error in inquiry\n");
888 static int usb_request_sense(ccb *srb, struct us_data *ss)
892 ptr = (char *)srb->pdata;
893 memset(&srb->cmd[0], 0, 12);
894 srb->cmd[0] = SCSI_REQ_SENSE;
895 srb->cmd[1] = srb->lun << 5;
898 srb->pdata = &srb->sense_buf[0];
900 ss->transport(srb, ss);
901 debug("Request Sense returned %02X %02X %02X\n",
902 srb->sense_buf[2], srb->sense_buf[12],
904 srb->pdata = (uchar *)ptr;
908 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
913 memset(&srb->cmd[0], 0, 12);
914 srb->cmd[0] = SCSI_TST_U_RDY;
915 srb->cmd[1] = srb->lun << 5;
918 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
919 ss->flags |= USB_READY;
922 usb_request_sense(srb, ss);
924 * Check the Key Code Qualifier, if it matches
925 * "Not Ready - medium not present"
926 * (the sense Key equals 0x2 and the ASC is 0x3a)
927 * return immediately as the medium being absent won't change
928 * unless there is a user action.
930 if ((srb->sense_buf[2] == 0x02) &&
931 (srb->sense_buf[12] == 0x3a))
939 static int usb_read_capacity(ccb *srb, struct us_data *ss)
945 memset(&srb->cmd[0], 0, 12);
946 srb->cmd[0] = SCSI_RD_CAPAC;
947 srb->cmd[1] = srb->lun << 5;
950 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
957 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
958 unsigned short blocks)
960 memset(&srb->cmd[0], 0, 12);
961 srb->cmd[0] = SCSI_READ10;
962 srb->cmd[1] = srb->lun << 5;
963 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
964 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
965 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
966 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
967 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
968 srb->cmd[8] = (unsigned char) blocks & 0xff;
970 debug("read10: start %lx blocks %x\n", start, blocks);
971 return ss->transport(srb, ss);
974 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
975 unsigned short blocks)
977 memset(&srb->cmd[0], 0, 12);
978 srb->cmd[0] = SCSI_WRITE10;
979 srb->cmd[1] = srb->lun << 5;
980 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
981 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
982 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
983 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
984 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
985 srb->cmd[8] = (unsigned char) blocks & 0xff;
987 debug("write10: start %lx blocks %x\n", start, blocks);
988 return ss->transport(srb, ss);
992 #ifdef CONFIG_USB_BIN_FIXUP
994 * Some USB storage devices queried for SCSI identification data respond with
995 * binary strings, which if output to the console freeze the terminal. The
996 * workaround is to modify the vendor and product strings read from such
997 * device with proper values (as reported by 'usb info').
999 * Vendor and product length limits are taken from the definition of
1000 * block_dev_desc_t in include/part.h.
1002 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1003 unsigned char vendor[],
1004 unsigned char product[]) {
1005 const unsigned char max_vendor_len = 40;
1006 const unsigned char max_product_len = 20;
1007 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1008 strncpy((char *)vendor, "SMSC", max_vendor_len);
1009 strncpy((char *)product, "Flash Media Cntrller",
1013 #endif /* CONFIG_USB_BIN_FIXUP */
1015 unsigned long usb_stor_read(int device, lbaint_t blknr,
1016 lbaint_t blkcnt, void *buffer)
1018 lbaint_t start, blks;
1020 unsigned short smallblks;
1021 struct usb_device *dev;
1024 ccb *srb = &usb_ccb;
1031 debug("\nusb_read: dev %d\n", device);
1032 dev = usb_dev_desc[device].priv;
1034 debug("%s: No device\n", __func__);
1037 ss = (struct us_data *)dev->privptr;
1039 usb_disable_asynch(1); /* asynch transfer not allowed */
1040 srb->lun = usb_dev_desc[device].lun;
1041 buf_addr = (uintptr_t)buffer;
1045 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF
1046 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1049 /* XXX need some comment here */
1051 srb->pdata = (unsigned char *)buf_addr;
1052 if (blks > USB_MAX_XFER_BLK)
1053 smallblks = USB_MAX_XFER_BLK;
1055 smallblks = (unsigned short) blks;
1057 if (smallblks == USB_MAX_XFER_BLK)
1058 usb_show_progress();
1059 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1060 srb->pdata = (unsigned char *)buf_addr;
1061 if (usb_read_10(srb, ss, start, smallblks)) {
1062 debug("Read ERROR\n");
1063 usb_request_sense(srb, ss);
1071 buf_addr += srb->datalen;
1072 } while (blks != 0);
1073 ss->flags &= ~USB_READY;
1075 debug("usb_read: end startblk " LBAF
1076 ", blccnt %x buffer %" PRIxPTR "\n",
1077 start, smallblks, buf_addr);
1079 usb_disable_asynch(0); /* asynch transfer allowed */
1080 if (blkcnt >= USB_MAX_XFER_BLK)
1085 unsigned long usb_stor_write(int device, lbaint_t blknr,
1086 lbaint_t blkcnt, const void *buffer)
1088 lbaint_t start, blks;
1090 unsigned short smallblks;
1091 struct usb_device *dev;
1094 ccb *srb = &usb_ccb;
1101 debug("\nusb_write: dev %d\n", device);
1102 dev = usb_dev_desc[device].priv;
1105 ss = (struct us_data *)dev->privptr;
1107 usb_disable_asynch(1); /* asynch transfer not allowed */
1109 srb->lun = usb_dev_desc[device].lun;
1110 buf_addr = (uintptr_t)buffer;
1114 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF
1115 " buffer %" PRIxPTR "\n", device, start, blks, buf_addr);
1118 /* If write fails retry for max retry count else
1119 * return with number of blocks written successfully.
1122 srb->pdata = (unsigned char *)buf_addr;
1123 if (blks > USB_MAX_XFER_BLK)
1124 smallblks = USB_MAX_XFER_BLK;
1126 smallblks = (unsigned short) blks;
1128 if (smallblks == USB_MAX_XFER_BLK)
1129 usb_show_progress();
1130 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1131 srb->pdata = (unsigned char *)buf_addr;
1132 if (usb_write_10(srb, ss, start, smallblks)) {
1133 debug("Write ERROR\n");
1134 usb_request_sense(srb, ss);
1142 buf_addr += srb->datalen;
1143 } while (blks != 0);
1144 ss->flags &= ~USB_READY;
1146 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %"
1147 PRIxPTR "\n", start, smallblks, buf_addr);
1149 usb_disable_asynch(0); /* asynch transfer allowed */
1150 if (blkcnt >= USB_MAX_XFER_BLK)
1156 /* Probe to see if a new device is actually a Storage device */
1157 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1160 struct usb_interface *iface;
1162 struct usb_endpoint_descriptor *ep_desc;
1163 unsigned int flags = 0;
1168 /* let's examine the device now */
1169 iface = &dev->config.if_desc[ifnum];
1172 /* this is the place to patch some storage devices */
1173 debug("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1174 dev->descriptor.idProduct);
1176 if ((dev->descriptor.idVendor) == 0x066b &&
1177 (dev->descriptor.idProduct) == 0x0103) {
1178 debug("patched for E-USB\n");
1179 protocol = US_PR_CB;
1180 subclass = US_SC_UFI; /* an assumption */
1184 if (dev->descriptor.bDeviceClass != 0 ||
1185 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1186 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1187 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1188 debug("Not mass storage\n");
1189 /* if it's not a mass storage, we go no further */
1193 memset(ss, 0, sizeof(struct us_data));
1195 /* At this point, we know we've got a live one */
1196 debug("\n\nUSB Mass Storage device detected\n");
1198 /* Initialize the us_data structure with some useful info */
1202 ss->attention_done = 0;
1204 /* If the device has subclass and protocol, then use that. Otherwise,
1205 * take data from the specific interface.
1208 ss->subclass = subclass;
1209 ss->protocol = protocol;
1211 ss->subclass = iface->desc.bInterfaceSubClass;
1212 ss->protocol = iface->desc.bInterfaceProtocol;
1215 /* set the handler pointers based on the protocol */
1216 debug("Transport: ");
1217 switch (ss->protocol) {
1219 debug("Control/Bulk\n");
1220 ss->transport = usb_stor_CB_transport;
1221 ss->transport_reset = usb_stor_CB_reset;
1225 debug("Control/Bulk/Interrupt\n");
1226 ss->transport = usb_stor_CB_transport;
1227 ss->transport_reset = usb_stor_CB_reset;
1230 debug("Bulk/Bulk/Bulk\n");
1231 ss->transport = usb_stor_BBB_transport;
1232 ss->transport_reset = usb_stor_BBB_reset;
1235 printf("USB Storage Transport unknown / not yet implemented\n");
1241 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1242 * An optional interrupt is OK (necessary for CBI protocol).
1243 * We will ignore any others.
1245 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1246 ep_desc = &iface->ep_desc[i];
1247 /* is it an BULK endpoint? */
1248 if ((ep_desc->bmAttributes &
1249 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1250 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1251 ss->ep_in = ep_desc->bEndpointAddress &
1252 USB_ENDPOINT_NUMBER_MASK;
1255 ep_desc->bEndpointAddress &
1256 USB_ENDPOINT_NUMBER_MASK;
1259 /* is it an interrupt endpoint? */
1260 if ((ep_desc->bmAttributes &
1261 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1262 ss->ep_int = ep_desc->bEndpointAddress &
1263 USB_ENDPOINT_NUMBER_MASK;
1264 ss->irqinterval = ep_desc->bInterval;
1267 debug("Endpoints In %d Out %d Int %d\n",
1268 ss->ep_in, ss->ep_out, ss->ep_int);
1270 /* Do some basic sanity checks, and bail if we find a problem */
1271 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1272 !ss->ep_in || !ss->ep_out ||
1273 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1274 debug("Problems with device\n");
1277 /* set class specific stuff */
1278 /* We only handle certain protocols. Currently, these are
1280 * The SFF8070 accepts the requests used in u-boot
1282 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1283 ss->subclass != US_SC_8070) {
1284 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1288 /* we had found an interrupt endpoint, prepare irq pipe
1289 * set up the IRQ pipe and handler
1291 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1292 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1293 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1294 dev->irq_handle = usb_stor_irq;
1296 dev->privptr = (void *)ss;
1300 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1301 block_dev_desc_t *dev_desc)
1303 unsigned char perq, modi;
1304 ALLOC_CACHE_ALIGN_BUFFER(u32, cap, 2);
1305 ALLOC_CACHE_ALIGN_BUFFER(u8, usb_stor_buf, 36);
1306 u32 capacity, blksz;
1307 ccb *pccb = &usb_ccb;
1309 pccb->pdata = usb_stor_buf;
1311 dev_desc->target = dev->devnum;
1312 pccb->lun = dev_desc->lun;
1313 debug(" address %d\n", dev_desc->target);
1315 if (usb_inquiry(pccb, ss)) {
1316 debug("%s: usb_inquiry() failed\n", __func__);
1320 perq = usb_stor_buf[0];
1321 modi = usb_stor_buf[1];
1324 * Skip unknown devices (0x1f) and enclosure service devices (0x0d),
1325 * they would not respond to test_unit_ready .
1327 if (((perq & 0x1f) == 0x1f) || ((perq & 0x1f) == 0x0d)) {
1328 debug("%s: unknown/unsupported device\n", __func__);
1331 if ((modi&0x80) == 0x80) {
1332 /* drive is removable */
1333 dev_desc->removable = 1;
1335 memcpy(dev_desc->vendor, (const void *)&usb_stor_buf[8], 8);
1336 memcpy(dev_desc->product, (const void *)&usb_stor_buf[16], 16);
1337 memcpy(dev_desc->revision, (const void *)&usb_stor_buf[32], 4);
1338 dev_desc->vendor[8] = 0;
1339 dev_desc->product[16] = 0;
1340 dev_desc->revision[4] = 0;
1341 #ifdef CONFIG_USB_BIN_FIXUP
1342 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1343 (uchar *)dev_desc->product);
1344 #endif /* CONFIG_USB_BIN_FIXUP */
1345 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1347 if (usb_test_unit_ready(pccb, ss)) {
1348 printf("Device NOT ready\n"
1349 " Request Sense returned %02X %02X %02X\n",
1350 pccb->sense_buf[2], pccb->sense_buf[12],
1351 pccb->sense_buf[13]);
1352 if (dev_desc->removable == 1) {
1353 dev_desc->type = perq;
1358 pccb->pdata = (unsigned char *)cap;
1359 memset(pccb->pdata, 0, 8);
1360 if (usb_read_capacity(pccb, ss) != 0) {
1361 printf("READ_CAP ERROR\n");
1365 ss->flags &= ~USB_READY;
1366 debug("Read Capacity returns: 0x%08x, 0x%08x\n", cap[0], cap[1]);
1368 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1371 cap[0] = cpu_to_be32(cap[0]);
1372 cap[1] = cpu_to_be32(cap[1]);
1375 capacity = be32_to_cpu(cap[0]) + 1;
1376 blksz = be32_to_cpu(cap[1]);
1378 debug("Capacity = 0x%08x, blocksz = 0x%08x\n", capacity, blksz);
1379 dev_desc->lba = capacity;
1380 dev_desc->blksz = blksz;
1381 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1382 dev_desc->type = perq;
1383 debug(" address %d\n", dev_desc->target);
1384 debug("partype: %d\n", dev_desc->part_type);
1386 init_part(dev_desc);
1388 debug("partype: %d\n", dev_desc->part_type);