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 * See file CREDITS for list of people who contributed to this
22 * This program is free software; you can redistribute it and/or
23 * modify it under the terms of the GNU General Public License as
24 * published by the Free Software Foundation; either version 2 of
25 * the License, or (at your option) any later version.
27 * This program is distributed in the hope that it will be useful,
28 * but WITHOUT ANY WARRANTY; without even the implied warranty of
29 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 * GNU General Public License for more details.
32 * You should have received a copy of the GNU General Public License
33 * along with this program; if not, write to the Free Software
34 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
40 * Currently only the CBI transport protocoll has been implemented, and it
41 * is only tested with a TEAC USB Floppy. Other Massstorages with CBI or CB
42 * transport protocoll may work as well.
46 * Support for USB Mass Storage Devices (BBB) has been added. It has
47 * only been tested with USB memory sticks.
53 #include <asm/byteorder.h>
54 #include <asm/processor.h>
59 #undef BBB_COMDAT_TRACE
60 #undef BBB_XPORT_TRACE
63 /* direction table -- this indicates the direction of the data
64 * transfer for each command code -- a 1 indicates input
66 static const unsigned char us_direction[256/8] = {
67 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
68 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
69 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
70 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
72 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
74 static ccb usb_ccb __attribute__((aligned(ARCH_DMA_MINALIGN)));
85 #define US_BBB_RESET 0xff
86 #define US_BBB_GET_MAX_LUN 0xfe
88 /* Command Block Wrapper */
91 # define CBWSIGNATURE 0x43425355
93 __u32 dCBWDataTransferLength;
95 # define CBWFLAGS_OUT 0x00
96 # define CBWFLAGS_IN 0x80
99 # define CBWCDBLENGTH 16
100 __u8 CBWCDB[CBWCDBLENGTH];
102 #define UMASS_BBB_CBW_SIZE 31
105 /* Command Status Wrapper */
108 # define CSWSIGNATURE 0x53425355
110 __u32 dCSWDataResidue;
112 # define CSWSTATUS_GOOD 0x0
113 # define CSWSTATUS_FAILED 0x1
114 # define CSWSTATUS_PHASE 0x2
116 #define UMASS_BBB_CSW_SIZE 13
118 #define USB_MAX_STOR_DEV 5
119 static int usb_max_devs; /* number of highest available usb device */
121 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
124 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
125 typedef int (*trans_reset)(struct us_data *data);
128 struct usb_device *pusb_dev; /* this usb_device */
130 unsigned int flags; /* from filter initially */
131 # define USB_READY (1 << 0)
132 unsigned char ifnum; /* interface number */
133 unsigned char ep_in; /* in endpoint */
134 unsigned char ep_out; /* out ....... */
135 unsigned char ep_int; /* interrupt . */
136 unsigned char subclass; /* as in overview */
137 unsigned char protocol; /* .............. */
138 unsigned char attention_done; /* force attn on first cmd */
139 unsigned short ip_data; /* interrupt data */
140 int action; /* what to do */
141 int ip_wanted; /* needed */
142 int *irq_handle; /* for USB int requests */
143 unsigned int irqpipe; /* pipe for release_irq */
144 unsigned char irqmaxp; /* max packed for irq Pipe */
145 unsigned char irqinterval; /* Intervall for IRQ Pipe */
146 ccb *srb; /* current srb */
147 trans_reset transport_reset; /* reset routine */
148 trans_cmnd transport; /* transport routine */
151 #ifdef CONFIG_USB_EHCI
153 * The U-Boot EHCI driver can handle any transfer length as long as there is
154 * enough free heap space left, but the SCSI READ(10) and WRITE(10) commands are
155 * limited to 65535 blocks.
157 #define USB_MAX_XFER_BLK 65535
159 #define USB_MAX_XFER_BLK 20
162 static struct us_data usb_stor[USB_MAX_STOR_DEV];
165 #define USB_STOR_TRANSPORT_GOOD 0
166 #define USB_STOR_TRANSPORT_FAILED -1
167 #define USB_STOR_TRANSPORT_ERROR -2
169 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
170 block_dev_desc_t *dev_desc);
171 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
173 unsigned long usb_stor_read(int device, unsigned long blknr,
174 lbaint_t blkcnt, void *buffer);
175 unsigned long usb_stor_write(int device, unsigned long blknr,
176 lbaint_t blkcnt, const void *buffer);
177 struct usb_device * usb_get_dev_index(int index);
178 void uhci_show_temp_int_td(void);
180 #ifdef CONFIG_PARTITIONS
181 block_dev_desc_t *usb_stor_get_dev(int index)
183 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
187 static void usb_show_progress(void)
192 /*******************************************************************************
193 * show info on storage devices; 'usb start/init' must be invoked earlier
194 * as we only retrieve structures populated during devices initialization
196 int usb_stor_info(void)
200 if (usb_max_devs > 0) {
201 for (i = 0; i < usb_max_devs; i++) {
202 printf(" Device %d: ", i);
203 dev_print(&usb_dev_desc[i]);
208 printf("No storage devices, perhaps not 'usb start'ed..?\n");
212 static unsigned int usb_get_max_lun(struct us_data *us)
215 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
216 len = usb_control_msg(us->pusb_dev,
217 usb_rcvctrlpipe(us->pusb_dev, 0),
219 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
221 result, sizeof(char),
222 USB_CNTL_TIMEOUT * 5);
223 debug("Get Max LUN -> len = %i, result = %i\n", len, (int) *result);
224 return (len > 0) ? *result : 0;
227 /*******************************************************************************
228 * scan the usb and reports device info
229 * to the user if mode = 1
230 * returns current device or -1 if no
232 int usb_stor_scan(int mode)
235 struct usb_device *dev;
238 printf(" scanning usb for storage devices... ");
240 usb_disable_asynch(1); /* asynch transfer not allowed */
242 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
243 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
244 usb_dev_desc[i].if_type = IF_TYPE_USB;
245 usb_dev_desc[i].dev = i;
246 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
247 usb_dev_desc[i].target = 0xff;
248 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
249 usb_dev_desc[i].block_read = usb_stor_read;
250 usb_dev_desc[i].block_write = usb_stor_write;
254 for (i = 0; i < USB_MAX_DEVICE; i++) {
255 dev = usb_get_dev_index(i); /* get device */
258 break; /* no more devices available */
260 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
261 /* OK, it's a storage device. Iterate over its LUNs
262 * and populate `usb_dev_desc'.
264 int lun, max_lun, start = usb_max_devs;
266 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
268 lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
270 usb_dev_desc[usb_max_devs].lun = lun;
271 if (usb_stor_get_info(dev, &usb_stor[start],
272 &usb_dev_desc[usb_max_devs]) == 1) {
277 /* if storage device */
278 if (usb_max_devs == USB_MAX_STOR_DEV) {
279 printf("max USB Storage Device reached: %d stopping\n",
285 usb_disable_asynch(0); /* asynch transfer allowed */
286 printf("%d Storage Device(s) found\n", usb_max_devs);
287 if (usb_max_devs > 0)
292 static int usb_stor_irq(struct usb_device *dev)
295 us = (struct us_data *)dev->privptr;
305 static void usb_show_srb(ccb *pccb)
308 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
309 for (i = 0; i < 12; i++)
310 printf("%02X ", pccb->cmd[i]);
314 static void display_int_status(unsigned long tmp)
316 printf("Status: %s %s %s %s %s %s %s\n",
317 (tmp & USB_ST_ACTIVE) ? "Active" : "",
318 (tmp & USB_ST_STALLED) ? "Stalled" : "",
319 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
320 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
321 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
322 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
323 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
326 /***********************************************************************
327 * Data transfer routines
328 ***********************************************************************/
330 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
339 /* determine the maximum packet size for these transfers */
340 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
342 /* while we have data left to transfer */
345 /* calculate how long this will be -- maximum or a remainder */
346 this_xfer = length > max_size ? max_size : length;
349 /* setup the retry counter */
352 /* set up the transfer loop */
354 /* transfer the data */
355 debug("Bulk xfer 0x%x(%d) try #%d\n",
356 (unsigned int)buf, this_xfer, 11 - maxtry);
357 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
359 USB_CNTL_TIMEOUT * 5);
360 debug("bulk_msg returned %d xferred %d/%d\n",
361 result, partial, this_xfer);
362 if (us->pusb_dev->status != 0) {
363 /* if we stall, we need to clear it before
367 display_int_status(us->pusb_dev->status);
369 if (us->pusb_dev->status & USB_ST_STALLED) {
370 debug("stalled ->clearing endpoint" \
371 "halt for pipe 0x%x\n", pipe);
372 stat = us->pusb_dev->status;
373 usb_clear_halt(us->pusb_dev, pipe);
374 us->pusb_dev->status = stat;
375 if (this_xfer == partial) {
376 debug("bulk transferred" \
379 us->pusb_dev->status);
385 if (us->pusb_dev->status & USB_ST_NAK_REC) {
386 debug("Device NAKed bulk_msg\n");
389 debug("bulk transferred with error");
390 if (this_xfer == partial) {
391 debug(" %ld, but data ok\n",
392 us->pusb_dev->status);
395 /* if our try counter reaches 0, bail out */
396 debug(" %ld, data %d\n",
397 us->pusb_dev->status, partial);
401 /* update to show what data was transferred */
402 this_xfer -= partial;
404 /* continue until this transfer is done */
408 /* if we get here, we're done and successful */
412 static int usb_stor_BBB_reset(struct us_data *us)
418 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
420 * For Reset Recovery the host shall issue in the following order:
421 * a) a Bulk-Only Mass Storage Reset
422 * b) a Clear Feature HALT to the Bulk-In endpoint
423 * c) a Clear Feature HALT to the Bulk-Out endpoint
425 * This is done in 3 steps.
427 * If the reset doesn't succeed, the device should be port reset.
429 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
431 debug("BBB_reset\n");
432 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
434 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
435 0, us->ifnum, NULL, 0, USB_CNTL_TIMEOUT * 5);
437 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
438 debug("RESET:stall\n");
442 /* long wait for reset */
444 debug("BBB_reset result %d: status %lX reset\n",
445 result, us->pusb_dev->status);
446 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
447 result = usb_clear_halt(us->pusb_dev, pipe);
448 /* long wait for reset */
450 debug("BBB_reset result %d: status %lX clearing IN endpoint\n",
451 result, us->pusb_dev->status);
452 /* long wait for reset */
453 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
454 result = usb_clear_halt(us->pusb_dev, pipe);
456 debug("BBB_reset result %d: status %lX clearing OUT endpoint\n",
457 result, us->pusb_dev->status);
458 debug("BBB_reset done\n");
462 /* FIXME: this reset function doesn't really reset the port, and it
463 * should. Actually it should probably do what it's doing here, and
464 * reset the port physically
466 static int usb_stor_CB_reset(struct us_data *us)
468 unsigned char cmd[12];
472 memset(cmd, 0xff, sizeof(cmd));
473 cmd[0] = SCSI_SEND_DIAG;
475 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
477 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
478 0, us->ifnum, cmd, sizeof(cmd),
479 USB_CNTL_TIMEOUT * 5);
481 /* long wait for reset */
483 debug("CB_reset result %d: status %lX clearing endpoint halt\n",
484 result, us->pusb_dev->status);
485 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
486 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
488 debug("CB_reset done\n");
493 * Set up the command for a BBB device. Note that the actual SCSI
494 * command is copied into cbw.CBWCDB.
496 static int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
502 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_cbw_t, cbw, 1);
504 dir_in = US_DIRECTION(srb->cmd[0]);
506 #ifdef BBB_COMDAT_TRACE
507 printf("dir %d lun %d cmdlen %d cmd %p datalen %lu pdata %p\n",
508 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
511 for (result = 0; result < srb->cmdlen; result++)
512 printf("cmd[%d] %#x ", result, srb->cmd[result]);
517 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
518 debug("usb_stor_BBB_comdat:cmdlen too large\n");
522 /* always OUT to the ep */
523 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
525 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
526 cbw->dCBWTag = cpu_to_le32(CBWTag++);
527 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
528 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
529 cbw->bCBWLUN = srb->lun;
530 cbw->bCDBLength = srb->cmdlen;
531 /* copy the command data into the CBW command data buffer */
533 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
534 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
535 &actlen, USB_CNTL_TIMEOUT * 5);
537 debug("usb_stor_BBB_comdat:usb_bulk_msg error\n");
541 /* FIXME: we also need a CBI_command which sets up the completion
542 * interrupt, and waits for it
544 static int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
549 unsigned long status;
552 dir_in = US_DIRECTION(srb->cmd[0]);
555 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
557 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
560 debug("CBI gets a command: Try %d\n", 5 - retry);
564 /* let's send the command via the control pipe */
565 result = usb_control_msg(us->pusb_dev,
566 usb_sndctrlpipe(us->pusb_dev , 0),
568 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
570 srb->cmd, srb->cmdlen,
571 USB_CNTL_TIMEOUT * 5);
572 debug("CB_transport: control msg returned %d, status %lX\n",
573 result, us->pusb_dev->status);
574 /* check the return code for the command */
576 if (us->pusb_dev->status & USB_ST_STALLED) {
577 status = us->pusb_dev->status;
578 debug(" stall during command found," \
580 usb_clear_halt(us->pusb_dev,
581 usb_sndctrlpipe(us->pusb_dev, 0));
582 us->pusb_dev->status = status;
584 debug(" error during command %02X" \
585 " Stat = %lX\n", srb->cmd[0],
586 us->pusb_dev->status);
589 /* transfer the data payload for this command, if one exists*/
591 debug("CB_transport: control msg returned %d," \
592 " direction is %s to go 0x%lx\n", result,
593 dir_in ? "IN" : "OUT", srb->datalen);
595 result = us_one_transfer(us, pipe, (char *)srb->pdata,
597 debug("CBI attempted to transfer data," \
598 " result is %d status %lX, len %d\n",
599 result, us->pusb_dev->status,
600 us->pusb_dev->act_len);
601 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
603 } /* if (srb->datalen) */
613 static int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
618 submit_int_msg(us->pusb_dev, us->irqpipe,
619 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
622 if ((volatile int *) us->ip_wanted == NULL)
627 printf(" Did not get interrupt on CBI\n");
629 return USB_STOR_TRANSPORT_ERROR;
631 debug("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
632 us->ip_data, us->pusb_dev->irq_act_len,
633 us->pusb_dev->irq_status);
634 /* UFI gives us ASC and ASCQ, like a request sense */
635 if (us->subclass == US_SC_UFI) {
636 if (srb->cmd[0] == SCSI_REQ_SENSE ||
637 srb->cmd[0] == SCSI_INQUIRY)
638 return USB_STOR_TRANSPORT_GOOD; /* Good */
639 else if (us->ip_data)
640 return USB_STOR_TRANSPORT_FAILED;
642 return USB_STOR_TRANSPORT_GOOD;
644 /* otherwise, we interpret the data normally */
645 switch (us->ip_data) {
647 return USB_STOR_TRANSPORT_GOOD;
649 return USB_STOR_TRANSPORT_FAILED;
651 return USB_STOR_TRANSPORT_ERROR;
653 return USB_STOR_TRANSPORT_ERROR;
656 #define USB_TRANSPORT_UNKNOWN_RETRY 5
657 #define USB_TRANSPORT_NOT_READY_RETRY 10
659 /* clear a stall on an endpoint - special for BBB devices */
660 static int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
664 /* ENDPOINT_HALT = 0, so set value to 0 */
665 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
666 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
667 0, endpt, NULL, 0, USB_CNTL_TIMEOUT * 5);
671 static int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
675 int actlen, data_actlen;
676 unsigned int pipe, pipein, pipeout;
677 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_csw_t, csw, 1);
678 #ifdef BBB_XPORT_TRACE
683 dir_in = US_DIRECTION(srb->cmd[0]);
686 debug("COMMAND phase\n");
687 result = usb_stor_BBB_comdat(srb, us);
689 debug("failed to send CBW status %ld\n",
690 us->pusb_dev->status);
691 usb_stor_BBB_reset(us);
692 return USB_STOR_TRANSPORT_FAILED;
694 if (!(us->flags & USB_READY))
696 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
697 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
698 /* DATA phase + error handling */
700 /* no data, go immediately to the STATUS phase */
701 if (srb->datalen == 0)
703 debug("DATA phase\n");
708 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
709 &data_actlen, USB_CNTL_TIMEOUT * 5);
710 /* special handling of STALL in DATA phase */
711 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
712 debug("DATA:stall\n");
713 /* clear the STALL on the endpoint */
714 result = usb_stor_BBB_clear_endpt_stall(us,
715 dir_in ? us->ep_in : us->ep_out);
717 /* continue on to STATUS phase */
721 debug("usb_bulk_msg error status %ld\n",
722 us->pusb_dev->status);
723 usb_stor_BBB_reset(us);
724 return USB_STOR_TRANSPORT_FAILED;
726 #ifdef BBB_XPORT_TRACE
727 for (index = 0; index < data_actlen; index++)
728 printf("pdata[%d] %#x ", index, srb->pdata[index]);
731 /* STATUS phase + error handling */
735 debug("STATUS phase\n");
736 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
737 &actlen, USB_CNTL_TIMEOUT*5);
739 /* special handling of STALL in STATUS phase */
740 if ((result < 0) && (retry < 1) &&
741 (us->pusb_dev->status & USB_ST_STALLED)) {
742 debug("STATUS:stall\n");
743 /* clear the STALL on the endpoint */
744 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
745 if (result >= 0 && (retry++ < 1))
750 debug("usb_bulk_msg error status %ld\n",
751 us->pusb_dev->status);
752 usb_stor_BBB_reset(us);
753 return USB_STOR_TRANSPORT_FAILED;
755 #ifdef BBB_XPORT_TRACE
756 ptr = (unsigned char *)csw;
757 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
758 printf("ptr[%d] %#x ", index, ptr[index]);
761 /* misuse pipe to get the residue */
762 pipe = le32_to_cpu(csw->dCSWDataResidue);
763 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
764 pipe = srb->datalen - data_actlen;
765 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
766 debug("!CSWSIGNATURE\n");
767 usb_stor_BBB_reset(us);
768 return USB_STOR_TRANSPORT_FAILED;
769 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
771 usb_stor_BBB_reset(us);
772 return USB_STOR_TRANSPORT_FAILED;
773 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
775 usb_stor_BBB_reset(us);
776 return USB_STOR_TRANSPORT_FAILED;
777 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
779 usb_stor_BBB_reset(us);
780 return USB_STOR_TRANSPORT_FAILED;
781 } else if (data_actlen > srb->datalen) {
782 debug("transferred %dB instead of %ldB\n",
783 data_actlen, srb->datalen);
784 return USB_STOR_TRANSPORT_FAILED;
785 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
787 return USB_STOR_TRANSPORT_FAILED;
793 static int usb_stor_CB_transport(ccb *srb, struct us_data *us)
801 status = USB_STOR_TRANSPORT_GOOD;
804 /* issue the command */
806 result = usb_stor_CB_comdat(srb, us);
807 debug("command / Data returned %d, status %lX\n",
808 result, us->pusb_dev->status);
809 /* if this is an CBI Protocol, get IRQ */
810 if (us->protocol == US_PR_CBI) {
811 status = usb_stor_CBI_get_status(srb, us);
812 /* if the status is error, report it */
813 if (status == USB_STOR_TRANSPORT_ERROR) {
814 debug(" USB CBI Command Error\n");
817 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
818 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
820 /* if the status is good, report it */
821 if (status == USB_STOR_TRANSPORT_GOOD) {
822 debug(" USB CBI Command Good\n");
827 /* do we have to issue an auto request? */
828 /* HERE we have to check the result */
829 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
830 debug("ERROR %lX\n", us->pusb_dev->status);
831 us->transport_reset(us);
832 return USB_STOR_TRANSPORT_ERROR;
834 if ((us->protocol == US_PR_CBI) &&
835 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
836 (srb->cmd[0] == SCSI_INQUIRY))) {
837 /* do not issue an autorequest after request sense */
838 debug("No auto request and good\n");
839 return USB_STOR_TRANSPORT_GOOD;
841 /* issue an request_sense */
842 memset(&psrb->cmd[0], 0, 12);
843 psrb->cmd[0] = SCSI_REQ_SENSE;
844 psrb->cmd[1] = srb->lun << 5;
847 psrb->pdata = &srb->sense_buf[0];
849 /* issue the command */
850 result = usb_stor_CB_comdat(psrb, us);
851 debug("auto request returned %d\n", result);
852 /* if this is an CBI Protocol, get IRQ */
853 if (us->protocol == US_PR_CBI)
854 status = usb_stor_CBI_get_status(psrb, us);
856 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
857 debug(" AUTO REQUEST ERROR %ld\n",
858 us->pusb_dev->status);
859 return USB_STOR_TRANSPORT_ERROR;
861 debug("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
862 srb->sense_buf[0], srb->sense_buf[2],
863 srb->sense_buf[12], srb->sense_buf[13]);
864 /* Check the auto request result */
865 if ((srb->sense_buf[2] == 0) &&
866 (srb->sense_buf[12] == 0) &&
867 (srb->sense_buf[13] == 0)) {
869 return USB_STOR_TRANSPORT_GOOD;
872 /* Check the auto request result */
873 switch (srb->sense_buf[2]) {
875 /* Recovered Error */
876 return USB_STOR_TRANSPORT_GOOD;
880 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
881 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
882 " 0x%02X (NOT READY)\n", srb->cmd[0],
883 srb->sense_buf[0], srb->sense_buf[2],
884 srb->sense_buf[12], srb->sense_buf[13]);
885 return USB_STOR_TRANSPORT_FAILED;
892 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
893 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
894 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
895 srb->sense_buf[2], srb->sense_buf[12],
897 return USB_STOR_TRANSPORT_FAILED;
902 return USB_STOR_TRANSPORT_FAILED;
906 static int usb_inquiry(ccb *srb, struct us_data *ss)
911 memset(&srb->cmd[0], 0, 12);
912 srb->cmd[0] = SCSI_INQUIRY;
913 srb->cmd[1] = srb->lun << 5;
917 i = ss->transport(srb, ss);
918 debug("inquiry returns %d\n", i);
924 printf("error in inquiry\n");
930 static int usb_request_sense(ccb *srb, struct us_data *ss)
934 ptr = (char *)srb->pdata;
935 memset(&srb->cmd[0], 0, 12);
936 srb->cmd[0] = SCSI_REQ_SENSE;
937 srb->cmd[1] = srb->lun << 5;
940 srb->pdata = &srb->sense_buf[0];
942 ss->transport(srb, ss);
943 debug("Request Sense returned %02X %02X %02X\n",
944 srb->sense_buf[2], srb->sense_buf[12],
946 srb->pdata = (uchar *)ptr;
950 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
955 memset(&srb->cmd[0], 0, 12);
956 srb->cmd[0] = SCSI_TST_U_RDY;
957 srb->cmd[1] = srb->lun << 5;
960 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD) {
961 ss->flags |= USB_READY;
964 usb_request_sense(srb, ss);
966 * Check the Key Code Qualifier, if it matches
967 * "Not Ready - medium not present"
968 * (the sense Key equals 0x2 and the ASC is 0x3a)
969 * return immediately as the medium being absent won't change
970 * unless there is a user action.
972 if ((srb->sense_buf[2] == 0x02) &&
973 (srb->sense_buf[12] == 0x3a))
981 static int usb_read_capacity(ccb *srb, struct us_data *ss)
987 memset(&srb->cmd[0], 0, 12);
988 srb->cmd[0] = SCSI_RD_CAPAC;
989 srb->cmd[1] = srb->lun << 5;
992 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
999 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
1000 unsigned short blocks)
1002 memset(&srb->cmd[0], 0, 12);
1003 srb->cmd[0] = SCSI_READ10;
1004 srb->cmd[1] = srb->lun << 5;
1005 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1006 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1007 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1008 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1009 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1010 srb->cmd[8] = (unsigned char) blocks & 0xff;
1012 debug("read10: start %lx blocks %x\n", start, blocks);
1013 return ss->transport(srb, ss);
1016 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
1017 unsigned short blocks)
1019 memset(&srb->cmd[0], 0, 12);
1020 srb->cmd[0] = SCSI_WRITE10;
1021 srb->cmd[1] = srb->lun << 5;
1022 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1023 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1024 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1025 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1026 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1027 srb->cmd[8] = (unsigned char) blocks & 0xff;
1029 debug("write10: start %lx blocks %x\n", start, blocks);
1030 return ss->transport(srb, ss);
1034 #ifdef CONFIG_USB_BIN_FIXUP
1036 * Some USB storage devices queried for SCSI identification data respond with
1037 * binary strings, which if output to the console freeze the terminal. The
1038 * workaround is to modify the vendor and product strings read from such
1039 * device with proper values (as reported by 'usb info').
1041 * Vendor and product length limits are taken from the definition of
1042 * block_dev_desc_t in include/part.h.
1044 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1045 unsigned char vendor[],
1046 unsigned char product[]) {
1047 const unsigned char max_vendor_len = 40;
1048 const unsigned char max_product_len = 20;
1049 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1050 strncpy((char *)vendor, "SMSC", max_vendor_len);
1051 strncpy((char *)product, "Flash Media Cntrller",
1055 #endif /* CONFIG_USB_BIN_FIXUP */
1057 unsigned long usb_stor_read(int device, unsigned long blknr,
1058 lbaint_t blkcnt, void *buffer)
1060 lbaint_t start, blks;
1062 unsigned short smallblks;
1063 struct usb_device *dev;
1066 ccb *srb = &usb_ccb;
1073 debug("\nusb_read: dev %d \n", device);
1075 for (i = 0; i < USB_MAX_DEVICE; i++) {
1076 dev = usb_get_dev_index(i);
1079 if (dev->devnum == usb_dev_desc[device].target)
1082 ss = (struct us_data *)dev->privptr;
1084 usb_disable_asynch(1); /* asynch transfer not allowed */
1085 srb->lun = usb_dev_desc[device].lun;
1086 buf_addr = (unsigned long)buffer;
1090 debug("\nusb_read: dev %d startblk " LBAF ", blccnt " LBAF
1091 " buffer %lx\n", device, start, blks, buf_addr);
1094 /* XXX need some comment here */
1096 srb->pdata = (unsigned char *)buf_addr;
1097 if (blks > USB_MAX_XFER_BLK)
1098 smallblks = USB_MAX_XFER_BLK;
1100 smallblks = (unsigned short) blks;
1102 if (smallblks == USB_MAX_XFER_BLK)
1103 usb_show_progress();
1104 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1105 srb->pdata = (unsigned char *)buf_addr;
1106 if (usb_read_10(srb, ss, start, smallblks)) {
1107 debug("Read ERROR\n");
1108 usb_request_sense(srb, ss);
1116 buf_addr += srb->datalen;
1117 } while (blks != 0);
1118 ss->flags &= ~USB_READY;
1120 debug("usb_read: end startblk " LBAF
1121 ", blccnt %x buffer %lx\n",
1122 start, smallblks, buf_addr);
1124 usb_disable_asynch(0); /* asynch transfer allowed */
1125 if (blkcnt >= USB_MAX_XFER_BLK)
1130 unsigned long usb_stor_write(int device, unsigned long blknr,
1131 lbaint_t blkcnt, const void *buffer)
1133 lbaint_t start, blks;
1135 unsigned short smallblks;
1136 struct usb_device *dev;
1139 ccb *srb = &usb_ccb;
1146 debug("\nusb_write: dev %d \n", device);
1148 for (i = 0; i < USB_MAX_DEVICE; i++) {
1149 dev = usb_get_dev_index(i);
1152 if (dev->devnum == usb_dev_desc[device].target)
1155 ss = (struct us_data *)dev->privptr;
1157 usb_disable_asynch(1); /* asynch transfer not allowed */
1159 srb->lun = usb_dev_desc[device].lun;
1160 buf_addr = (unsigned long)buffer;
1164 debug("\nusb_write: dev %d startblk " LBAF ", blccnt " LBAF
1165 " buffer %lx\n", device, start, blks, buf_addr);
1168 /* If write fails retry for max retry count else
1169 * return with number of blocks written successfully.
1172 srb->pdata = (unsigned char *)buf_addr;
1173 if (blks > USB_MAX_XFER_BLK)
1174 smallblks = USB_MAX_XFER_BLK;
1176 smallblks = (unsigned short) blks;
1178 if (smallblks == USB_MAX_XFER_BLK)
1179 usb_show_progress();
1180 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1181 srb->pdata = (unsigned char *)buf_addr;
1182 if (usb_write_10(srb, ss, start, smallblks)) {
1183 debug("Write ERROR\n");
1184 usb_request_sense(srb, ss);
1192 buf_addr += srb->datalen;
1193 } while (blks != 0);
1194 ss->flags &= ~USB_READY;
1196 debug("usb_write: end startblk " LBAF ", blccnt %x buffer %lx\n",
1197 start, smallblks, buf_addr);
1199 usb_disable_asynch(0); /* asynch transfer allowed */
1200 if (blkcnt >= USB_MAX_XFER_BLK)
1206 /* Probe to see if a new device is actually a Storage device */
1207 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1210 struct usb_interface *iface;
1212 struct usb_endpoint_descriptor *ep_desc;
1213 unsigned int flags = 0;
1218 /* let's examine the device now */
1219 iface = &dev->config.if_desc[ifnum];
1222 /* this is the place to patch some storage devices */
1223 debug("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1224 dev->descriptor.idProduct);
1226 if ((dev->descriptor.idVendor) == 0x066b &&
1227 (dev->descriptor.idProduct) == 0x0103) {
1228 debug("patched for E-USB\n");
1229 protocol = US_PR_CB;
1230 subclass = US_SC_UFI; /* an assumption */
1234 if (dev->descriptor.bDeviceClass != 0 ||
1235 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1236 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1237 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1238 /* if it's not a mass storage, we go no further */
1242 memset(ss, 0, sizeof(struct us_data));
1244 /* At this point, we know we've got a live one */
1245 debug("\n\nUSB Mass Storage device detected\n");
1247 /* Initialize the us_data structure with some useful info */
1251 ss->attention_done = 0;
1253 /* If the device has subclass and protocol, then use that. Otherwise,
1254 * take data from the specific interface.
1257 ss->subclass = subclass;
1258 ss->protocol = protocol;
1260 ss->subclass = iface->desc.bInterfaceSubClass;
1261 ss->protocol = iface->desc.bInterfaceProtocol;
1264 /* set the handler pointers based on the protocol */
1265 debug("Transport: ");
1266 switch (ss->protocol) {
1268 debug("Control/Bulk\n");
1269 ss->transport = usb_stor_CB_transport;
1270 ss->transport_reset = usb_stor_CB_reset;
1274 debug("Control/Bulk/Interrupt\n");
1275 ss->transport = usb_stor_CB_transport;
1276 ss->transport_reset = usb_stor_CB_reset;
1279 debug("Bulk/Bulk/Bulk\n");
1280 ss->transport = usb_stor_BBB_transport;
1281 ss->transport_reset = usb_stor_BBB_reset;
1284 printf("USB Storage Transport unknown / not yet implemented\n");
1290 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1291 * An optional interrupt is OK (necessary for CBI protocol).
1292 * We will ignore any others.
1294 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1295 ep_desc = &iface->ep_desc[i];
1296 /* is it an BULK endpoint? */
1297 if ((ep_desc->bmAttributes &
1298 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1299 if (ep_desc->bEndpointAddress & USB_DIR_IN)
1300 ss->ep_in = ep_desc->bEndpointAddress &
1301 USB_ENDPOINT_NUMBER_MASK;
1304 ep_desc->bEndpointAddress &
1305 USB_ENDPOINT_NUMBER_MASK;
1308 /* is it an interrupt endpoint? */
1309 if ((ep_desc->bmAttributes &
1310 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1311 ss->ep_int = ep_desc->bEndpointAddress &
1312 USB_ENDPOINT_NUMBER_MASK;
1313 ss->irqinterval = ep_desc->bInterval;
1316 debug("Endpoints In %d Out %d Int %d\n",
1317 ss->ep_in, ss->ep_out, ss->ep_int);
1319 /* Do some basic sanity checks, and bail if we find a problem */
1320 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1321 !ss->ep_in || !ss->ep_out ||
1322 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1323 debug("Problems with device\n");
1326 /* set class specific stuff */
1327 /* We only handle certain protocols. Currently, these are
1329 * The SFF8070 accepts the requests used in u-boot
1331 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1332 ss->subclass != US_SC_8070) {
1333 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1337 /* we had found an interrupt endpoint, prepare irq pipe
1338 * set up the IRQ pipe and handler
1340 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1341 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1342 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1343 dev->irq_handle = usb_stor_irq;
1345 dev->privptr = (void *)ss;
1349 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1350 block_dev_desc_t *dev_desc)
1352 unsigned char perq, modi;
1353 ALLOC_CACHE_ALIGN_BUFFER(unsigned long, cap, 2);
1354 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, usb_stor_buf, 36);
1355 unsigned long *capacity, *blksz;
1356 ccb *pccb = &usb_ccb;
1358 pccb->pdata = usb_stor_buf;
1360 dev_desc->target = dev->devnum;
1361 pccb->lun = dev_desc->lun;
1362 debug(" address %d\n", dev_desc->target);
1364 if (usb_inquiry(pccb, ss))
1367 perq = usb_stor_buf[0];
1368 modi = usb_stor_buf[1];
1370 if ((perq & 0x1f) == 0x1f) {
1371 /* skip unknown devices */
1374 if ((modi&0x80) == 0x80) {
1375 /* drive is removable */
1376 dev_desc->removable = 1;
1378 memcpy(&dev_desc->vendor[0], (const void *) &usb_stor_buf[8], 8);
1379 memcpy(&dev_desc->product[0], (const void *) &usb_stor_buf[16], 16);
1380 memcpy(&dev_desc->revision[0], (const void *) &usb_stor_buf[32], 4);
1381 dev_desc->vendor[8] = 0;
1382 dev_desc->product[16] = 0;
1383 dev_desc->revision[4] = 0;
1384 #ifdef CONFIG_USB_BIN_FIXUP
1385 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1386 (uchar *)dev_desc->product);
1387 #endif /* CONFIG_USB_BIN_FIXUP */
1388 debug("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1390 if (usb_test_unit_ready(pccb, ss)) {
1391 printf("Device NOT ready\n"
1392 " Request Sense returned %02X %02X %02X\n",
1393 pccb->sense_buf[2], pccb->sense_buf[12],
1394 pccb->sense_buf[13]);
1395 if (dev_desc->removable == 1) {
1396 dev_desc->type = perq;
1401 pccb->pdata = (unsigned char *)&cap[0];
1402 memset(pccb->pdata, 0, 8);
1403 if (usb_read_capacity(pccb, ss) != 0) {
1404 printf("READ_CAP ERROR\n");
1408 ss->flags &= ~USB_READY;
1409 debug("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0], cap[1]);
1411 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1414 cap[0] = cpu_to_be32(cap[0]);
1415 cap[1] = cpu_to_be32(cap[1]);
1417 /* this assumes bigendian! */
1421 debug("Capacity = 0x%lx, blocksz = 0x%lx\n", *capacity, *blksz);
1422 dev_desc->lba = *capacity;
1423 dev_desc->blksz = *blksz;
1424 dev_desc->log2blksz = LOG2(dev_desc->blksz);
1425 dev_desc->type = perq;
1426 debug(" address %d\n", dev_desc->target);
1427 debug("partype: %d\n", dev_desc->part_type);
1429 init_part(dev_desc);
1431 debug("partype: %d\n", dev_desc->part_type);