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 <gj@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>
60 #undef BBB_COMDAT_TRACE
61 #undef BBB_XPORT_TRACE
64 #define USB_STOR_PRINTF(fmt, args...) printf(fmt , ##args)
66 #define USB_STOR_PRINTF(fmt, args...)
70 /* direction table -- this indicates the direction of the data
71 * transfer for each command code -- a 1 indicates input
73 unsigned char us_direction[256/8] = {
74 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
75 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
76 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
77 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
79 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
81 static unsigned char usb_stor_buf[512];
93 #define US_BBB_RESET 0xff
94 #define US_BBB_GET_MAX_LUN 0xfe
96 /* Command Block Wrapper */
99 # define CBWSIGNATURE 0x43425355
101 __u32 dCBWDataTransferLength;
103 # define CBWFLAGS_OUT 0x00
104 # define CBWFLAGS_IN 0x80
107 # define CBWCDBLENGTH 16
108 __u8 CBWCDB[CBWCDBLENGTH];
110 #define UMASS_BBB_CBW_SIZE 31
113 /* Command Status Wrapper */
116 # define CSWSIGNATURE 0x53425355
118 __u32 dCSWDataResidue;
120 # define CSWSTATUS_GOOD 0x0
121 # define CSWSTATUS_FAILED 0x1
122 # define CSWSTATUS_PHASE 0x2
124 #define UMASS_BBB_CSW_SIZE 13
126 #define USB_MAX_STOR_DEV 5
127 static int usb_max_devs; /* number of highest available usb device */
129 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
132 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
133 typedef int (*trans_reset)(struct us_data *data);
136 struct usb_device *pusb_dev; /* this usb_device */
138 unsigned int flags; /* from filter initially */
139 unsigned char ifnum; /* interface number */
140 unsigned char ep_in; /* in endpoint */
141 unsigned char ep_out; /* out ....... */
142 unsigned char ep_int; /* interrupt . */
143 unsigned char subclass; /* as in overview */
144 unsigned char protocol; /* .............. */
145 unsigned char attention_done; /* force attn on first cmd */
146 unsigned short ip_data; /* interrupt data */
147 int action; /* what to do */
148 int ip_wanted; /* needed */
149 int *irq_handle; /* for USB int requests */
150 unsigned int irqpipe; /* pipe for release_irq */
151 unsigned char irqmaxp; /* max packed for irq Pipe */
152 unsigned char irqinterval; /* Intervall for IRQ Pipe */
153 ccb *srb; /* current srb */
154 trans_reset transport_reset; /* reset routine */
155 trans_cmnd transport; /* transport routine */
158 static struct us_data usb_stor[USB_MAX_STOR_DEV];
161 #define USB_STOR_TRANSPORT_GOOD 0
162 #define USB_STOR_TRANSPORT_FAILED -1
163 #define USB_STOR_TRANSPORT_ERROR -2
165 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
166 block_dev_desc_t *dev_desc);
167 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
169 unsigned long usb_stor_read(int device, unsigned long blknr,
170 unsigned long blkcnt, void *buffer);
171 struct usb_device * usb_get_dev_index(int index);
172 void uhci_show_temp_int_td(void);
174 block_dev_desc_t *usb_stor_get_dev(int index)
176 return (index < USB_MAX_STOR_DEV) ? &usb_dev_desc[index] : NULL;
180 void usb_show_progress(void)
185 /*******************************************************************************
186 * show info on storage devices; 'usb start/init' must be invoked earlier
187 * as we only retrieve structures populated during devices initialization
189 int usb_stor_info(void)
193 if (usb_max_devs > 0) {
194 for (i = 0; i < usb_max_devs; i++) {
195 printf(" Device %d: ", i);
196 dev_print(&usb_dev_desc[i]);
201 printf("No storage devices, perhaps not 'usb start'ed..?\n");
205 /*******************************************************************************
206 * scan the usb and reports device info
207 * to the user if mode = 1
208 * returns current device or -1 if no
210 int usb_stor_scan(int mode)
213 struct usb_device *dev;
216 memset(usb_stor_buf, 0, sizeof(usb_stor_buf));
219 printf(" scanning bus for storage devices... ");
221 usb_disable_asynch(1); /* asynch transfer not allowed */
223 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
224 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
225 usb_dev_desc[i].target = 0xff;
226 usb_dev_desc[i].if_type = IF_TYPE_USB;
227 usb_dev_desc[i].dev = i;
228 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
229 usb_dev_desc[i].block_read = usb_stor_read;
233 for (i = 0; i < USB_MAX_DEVICE; i++) {
234 dev = usb_get_dev_index(i); /* get device */
235 USB_STOR_PRINTF("i=%d\n", i);
237 break; /* no more devices avaiable */
239 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
240 /* ok, it is a storage devices
241 * get info and fill it in
243 if (usb_stor_get_info(dev, &usb_stor[usb_max_devs],
244 &usb_dev_desc[usb_max_devs]))
247 /* if storage device */
248 if (usb_max_devs == USB_MAX_STOR_DEV) {
249 printf("max USB Storage Device reached: %d stopping\n",
255 usb_disable_asynch(0); /* asynch transfer allowed */
256 printf("%d Storage Device(s) found\n", usb_max_devs);
257 if (usb_max_devs > 0)
262 static int usb_stor_irq(struct usb_device *dev)
265 us = (struct us_data *)dev->privptr;
273 #ifdef USB_STOR_DEBUG
275 static void usb_show_srb(ccb *pccb)
278 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
279 for (i = 0; i < 12; i++)
280 printf("%02X ", pccb->cmd[i]);
284 static void display_int_status(unsigned long tmp)
286 printf("Status: %s %s %s %s %s %s %s\n",
287 (tmp & USB_ST_ACTIVE) ? "Active" : "",
288 (tmp & USB_ST_STALLED) ? "Stalled" : "",
289 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
290 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
291 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
292 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
293 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
296 /***********************************************************************
297 * Data transfer routines
298 ***********************************************************************/
300 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
309 /* determine the maximum packet size for these transfers */
310 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
312 /* while we have data left to transfer */
315 /* calculate how long this will be -- maximum or a remainder */
316 this_xfer = length > max_size ? max_size : length;
319 /* setup the retry counter */
322 /* set up the transfer loop */
324 /* transfer the data */
325 USB_STOR_PRINTF("Bulk xfer 0x%x(%d) try #%d\n",
326 (unsigned int)buf, this_xfer, 11 - maxtry);
327 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
329 USB_CNTL_TIMEOUT * 5);
330 USB_STOR_PRINTF("bulk_msg returned %d xferred %d/%d\n",
331 result, partial, this_xfer);
332 if (us->pusb_dev->status != 0) {
333 /* if we stall, we need to clear it before
336 #ifdef USB_STOR_DEBUG
337 display_int_status(us->pusb_dev->status);
339 if (us->pusb_dev->status & USB_ST_STALLED) {
340 USB_STOR_PRINTF("stalled ->clearing endpoint halt for pipe 0x%x\n", pipe);
341 stat = us->pusb_dev->status;
342 usb_clear_halt(us->pusb_dev, pipe);
343 us->pusb_dev->status = stat;
344 if (this_xfer == partial) {
345 USB_STOR_PRINTF("bulk transferred with error %X, but data ok\n", us->pusb_dev->status);
351 if (us->pusb_dev->status & USB_ST_NAK_REC) {
352 USB_STOR_PRINTF("Device NAKed bulk_msg\n");
355 USB_STOR_PRINTF("bulk transferred with error");
356 if (this_xfer == partial) {
357 USB_STOR_PRINTF(" %d, but data ok\n",
358 us->pusb_dev->status);
361 /* if our try counter reaches 0, bail out */
362 USB_STOR_PRINTF(" %d, data %d\n",
363 us->pusb_dev->status, partial);
367 /* update to show what data was transferred */
368 this_xfer -= partial;
370 /* continue until this transfer is done */
374 /* if we get here, we're done and successful */
378 static int usb_stor_BBB_reset(struct us_data *us)
384 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
386 * For Reset Recovery the host shall issue in the following order:
387 * a) a Bulk-Only Mass Storage Reset
388 * b) a Clear Feature HALT to the Bulk-In endpoint
389 * c) a Clear Feature HALT to the Bulk-Out endpoint
391 * This is done in 3 steps.
393 * If the reset doesn't succeed, the device should be port reset.
395 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
397 USB_STOR_PRINTF("BBB_reset\n");
398 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
400 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
401 0, us->ifnum, 0, 0, USB_CNTL_TIMEOUT * 5);
403 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
404 USB_STOR_PRINTF("RESET:stall\n");
408 /* long wait for reset */
410 USB_STOR_PRINTF("BBB_reset result %d: status %X reset\n", result,
411 us->pusb_dev->status);
412 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
413 result = usb_clear_halt(us->pusb_dev, pipe);
414 /* long wait for reset */
416 USB_STOR_PRINTF("BBB_reset result %d: status %X clearing IN endpoint\n",
417 result, us->pusb_dev->status);
418 /* long wait for reset */
419 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
420 result = usb_clear_halt(us->pusb_dev, pipe);
422 USB_STOR_PRINTF("BBB_reset result %d: status %X"
423 " clearing OUT endpoint\n", result,
424 us->pusb_dev->status);
425 USB_STOR_PRINTF("BBB_reset done\n");
429 /* FIXME: this reset function doesn't really reset the port, and it
430 * should. Actually it should probably do what it's doing here, and
431 * reset the port physically
433 static int usb_stor_CB_reset(struct us_data *us)
435 unsigned char cmd[12];
438 USB_STOR_PRINTF("CB_reset\n");
439 memset(cmd, 0xff, sizeof(cmd));
440 cmd[0] = SCSI_SEND_DIAG;
442 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
444 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
445 0, us->ifnum, cmd, sizeof(cmd),
446 USB_CNTL_TIMEOUT * 5);
448 /* long wait for reset */
450 USB_STOR_PRINTF("CB_reset result %d: status %X"
451 " clearing endpoint halt\n", result,
452 us->pusb_dev->status);
453 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
454 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
456 USB_STOR_PRINTF("CB_reset done\n");
461 * Set up the command for a BBB device. Note that the actual SCSI
462 * command is copied into cbw.CBWCDB.
464 int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
472 dir_in = US_DIRECTION(srb->cmd[0]);
474 #ifdef BBB_COMDAT_TRACE
475 printf("dir %d lun %d cmdlen %d cmd %p datalen %d pdata %p\n",
476 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
479 for (result = 0; result < srb->cmdlen; result++)
480 printf("cmd[%d] %#x ", result, srb->cmd[result]);
485 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
486 USB_STOR_PRINTF("usb_stor_BBB_comdat:cmdlen too large\n");
490 /* always OUT to the ep */
491 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
493 cbw.dCBWSignature = cpu_to_le32(CBWSIGNATURE);
494 cbw.dCBWTag = cpu_to_le32(CBWTag++);
495 cbw.dCBWDataTransferLength = cpu_to_le32(srb->datalen);
496 cbw.bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
497 cbw.bCBWLUN = srb->lun;
498 cbw.bCDBLength = srb->cmdlen;
499 /* copy the command data into the CBW command data buffer */
501 memcpy(cbw.CBWCDB, srb->cmd, srb->cmdlen);
502 result = usb_bulk_msg(us->pusb_dev, pipe, &cbw, UMASS_BBB_CBW_SIZE,
503 &actlen, USB_CNTL_TIMEOUT * 5);
505 USB_STOR_PRINTF("usb_stor_BBB_comdat:usb_bulk_msg error\n");
509 /* FIXME: we also need a CBI_command which sets up the completion
510 * interrupt, and waits for it
512 int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
517 unsigned long status;
520 dir_in = US_DIRECTION(srb->cmd[0]);
523 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
525 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
528 USB_STOR_PRINTF("CBI gets a command: Try %d\n", 5 - retry);
529 #ifdef USB_STOR_DEBUG
532 /* let's send the command via the control pipe */
533 result = usb_control_msg(us->pusb_dev,
534 usb_sndctrlpipe(us->pusb_dev , 0),
536 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
538 srb->cmd, srb->cmdlen,
539 USB_CNTL_TIMEOUT * 5);
540 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
541 " status %X\n", result, us->pusb_dev->status);
542 /* check the return code for the command */
544 if (us->pusb_dev->status & USB_ST_STALLED) {
545 status = us->pusb_dev->status;
546 USB_STOR_PRINTF(" stall during command found,"
548 usb_clear_halt(us->pusb_dev,
549 usb_sndctrlpipe(us->pusb_dev, 0));
550 us->pusb_dev->status = status;
552 USB_STOR_PRINTF(" error during command %02X"
553 " Stat = %X\n", srb->cmd[0],
554 us->pusb_dev->status);
557 /* transfer the data payload for this command, if one exists*/
559 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
560 " direction is %s to go 0x%lx\n", result,
561 dir_in ? "IN" : "OUT", srb->datalen);
563 result = us_one_transfer(us, pipe, (char *)srb->pdata,
565 USB_STOR_PRINTF("CBI attempted to transfer data,"
566 " result is %d status %lX, len %d\n",
567 result, us->pusb_dev->status,
568 us->pusb_dev->act_len);
569 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
571 } /* if (srb->datalen) */
581 int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
586 submit_int_msg(us->pusb_dev, us->irqpipe,
587 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
590 if ((volatile int *) us->ip_wanted == 0)
595 printf(" Did not get interrupt on CBI\n");
597 return USB_STOR_TRANSPORT_ERROR;
600 ("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
601 us->ip_data, us->pusb_dev->irq_act_len,
602 us->pusb_dev->irq_status);
603 /* UFI gives us ASC and ASCQ, like a request sense */
604 if (us->subclass == US_SC_UFI) {
605 if (srb->cmd[0] == SCSI_REQ_SENSE ||
606 srb->cmd[0] == SCSI_INQUIRY)
607 return USB_STOR_TRANSPORT_GOOD; /* Good */
608 else if (us->ip_data)
609 return USB_STOR_TRANSPORT_FAILED;
611 return USB_STOR_TRANSPORT_GOOD;
613 /* otherwise, we interpret the data normally */
614 switch (us->ip_data) {
616 return USB_STOR_TRANSPORT_GOOD;
618 return USB_STOR_TRANSPORT_FAILED;
620 return USB_STOR_TRANSPORT_ERROR;
622 return USB_STOR_TRANSPORT_ERROR;
625 #define USB_TRANSPORT_UNKNOWN_RETRY 5
626 #define USB_TRANSPORT_NOT_READY_RETRY 10
628 /* clear a stall on an endpoint - special for BBB devices */
629 int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
633 /* ENDPOINT_HALT = 0, so set value to 0 */
634 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
635 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
636 0, endpt, 0, 0, USB_CNTL_TIMEOUT * 5);
640 int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
644 int actlen, data_actlen;
645 unsigned int pipe, pipein, pipeout;
647 #ifdef BBB_XPORT_TRACE
652 dir_in = US_DIRECTION(srb->cmd[0]);
655 USB_STOR_PRINTF("COMMAND phase\n");
656 result = usb_stor_BBB_comdat(srb, us);
658 USB_STOR_PRINTF("failed to send CBW status %ld\n",
659 us->pusb_dev->status);
660 usb_stor_BBB_reset(us);
661 return USB_STOR_TRANSPORT_FAILED;
664 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
665 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
666 /* DATA phase + error handling */
668 /* no data, go immediately to the STATUS phase */
669 if (srb->datalen == 0)
671 USB_STOR_PRINTF("DATA phase\n");
676 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
677 &data_actlen, USB_CNTL_TIMEOUT * 5);
678 /* special handling of STALL in DATA phase */
679 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
680 USB_STOR_PRINTF("DATA:stall\n");
681 /* clear the STALL on the endpoint */
682 result = usb_stor_BBB_clear_endpt_stall(us,
683 dir_in ? us->ep_in : us->ep_out);
685 /* continue on to STATUS phase */
689 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
690 us->pusb_dev->status);
691 usb_stor_BBB_reset(us);
692 return USB_STOR_TRANSPORT_FAILED;
694 #ifdef BBB_XPORT_TRACE
695 for (index = 0; index < data_actlen; index++)
696 printf("pdata[%d] %#x ", index, srb->pdata[index]);
699 /* STATUS phase + error handling */
703 USB_STOR_PRINTF("STATUS phase\n");
704 result = usb_bulk_msg(us->pusb_dev, pipein, &csw, UMASS_BBB_CSW_SIZE,
705 &actlen, USB_CNTL_TIMEOUT*5);
707 /* special handling of STALL in STATUS phase */
708 if ((result < 0) && (retry < 1) &&
709 (us->pusb_dev->status & USB_ST_STALLED)) {
710 USB_STOR_PRINTF("STATUS:stall\n");
711 /* clear the STALL on the endpoint */
712 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
713 if (result >= 0 && (retry++ < 1))
718 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
719 us->pusb_dev->status);
720 usb_stor_BBB_reset(us);
721 return USB_STOR_TRANSPORT_FAILED;
723 #ifdef BBB_XPORT_TRACE
724 ptr = (unsigned char *)&csw;
725 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
726 printf("ptr[%d] %#x ", index, ptr[index]);
729 /* misuse pipe to get the residue */
730 pipe = le32_to_cpu(csw.dCSWDataResidue);
731 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
732 pipe = srb->datalen - data_actlen;
733 if (CSWSIGNATURE != le32_to_cpu(csw.dCSWSignature)) {
734 USB_STOR_PRINTF("!CSWSIGNATURE\n");
735 usb_stor_BBB_reset(us);
736 return USB_STOR_TRANSPORT_FAILED;
737 } else if ((CBWTag - 1) != le32_to_cpu(csw.dCSWTag)) {
738 USB_STOR_PRINTF("!Tag\n");
739 usb_stor_BBB_reset(us);
740 return USB_STOR_TRANSPORT_FAILED;
741 } else if (csw.bCSWStatus > CSWSTATUS_PHASE) {
742 USB_STOR_PRINTF(">PHASE\n");
743 usb_stor_BBB_reset(us);
744 return USB_STOR_TRANSPORT_FAILED;
745 } else if (csw.bCSWStatus == CSWSTATUS_PHASE) {
746 USB_STOR_PRINTF("=PHASE\n");
747 usb_stor_BBB_reset(us);
748 return USB_STOR_TRANSPORT_FAILED;
749 } else if (data_actlen > srb->datalen) {
750 USB_STOR_PRINTF("transferred %dB instead of %dB\n",
751 data_actlen, srb->datalen);
752 return USB_STOR_TRANSPORT_FAILED;
753 } else if (csw.bCSWStatus == CSWSTATUS_FAILED) {
754 USB_STOR_PRINTF("FAILED\n");
755 return USB_STOR_TRANSPORT_FAILED;
761 int usb_stor_CB_transport(ccb *srb, struct us_data *us)
769 status = USB_STOR_TRANSPORT_GOOD;
772 /* issue the command */
774 result = usb_stor_CB_comdat(srb, us);
775 USB_STOR_PRINTF("command / Data returned %d, status %X\n",
776 result, us->pusb_dev->status);
777 /* if this is an CBI Protocol, get IRQ */
778 if (us->protocol == US_PR_CBI) {
779 status = usb_stor_CBI_get_status(srb, us);
780 /* if the status is error, report it */
781 if (status == USB_STOR_TRANSPORT_ERROR) {
782 USB_STOR_PRINTF(" USB CBI Command Error\n");
785 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
786 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
788 /* if the status is good, report it */
789 if (status == USB_STOR_TRANSPORT_GOOD) {
790 USB_STOR_PRINTF(" USB CBI Command Good\n");
795 /* do we have to issue an auto request? */
796 /* HERE we have to check the result */
797 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
798 USB_STOR_PRINTF("ERROR %X\n", us->pusb_dev->status);
799 us->transport_reset(us);
800 return USB_STOR_TRANSPORT_ERROR;
802 if ((us->protocol == US_PR_CBI) &&
803 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
804 (srb->cmd[0] == SCSI_INQUIRY))) {
805 /* do not issue an autorequest after request sense */
806 USB_STOR_PRINTF("No auto request and good\n");
807 return USB_STOR_TRANSPORT_GOOD;
809 /* issue an request_sense */
810 memset(&psrb->cmd[0], 0, 12);
811 psrb->cmd[0] = SCSI_REQ_SENSE;
812 psrb->cmd[1] = srb->lun << 5;
815 psrb->pdata = &srb->sense_buf[0];
817 /* issue the command */
818 result = usb_stor_CB_comdat(psrb, us);
819 USB_STOR_PRINTF("auto request returned %d\n", result);
820 /* if this is an CBI Protocol, get IRQ */
821 if (us->protocol == US_PR_CBI)
822 status = usb_stor_CBI_get_status(psrb, us);
824 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
825 USB_STOR_PRINTF(" AUTO REQUEST ERROR %d\n",
826 us->pusb_dev->status);
827 return USB_STOR_TRANSPORT_ERROR;
829 USB_STOR_PRINTF("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
830 srb->sense_buf[0], srb->sense_buf[2],
831 srb->sense_buf[12], srb->sense_buf[13]);
832 /* Check the auto request result */
833 if ((srb->sense_buf[2] == 0) &&
834 (srb->sense_buf[12] == 0) &&
835 (srb->sense_buf[13] == 0)) {
837 return USB_STOR_TRANSPORT_GOOD;
840 /* Check the auto request result */
841 switch (srb->sense_buf[2]) {
843 /* Recovered Error */
844 return USB_STOR_TRANSPORT_GOOD;
848 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
849 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
850 " 0x%02X (NOT READY)\n", srb->cmd[0],
851 srb->sense_buf[0], srb->sense_buf[2],
852 srb->sense_buf[12], srb->sense_buf[13]);
853 return USB_STOR_TRANSPORT_FAILED;
860 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
861 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
862 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
863 srb->sense_buf[2], srb->sense_buf[12],
865 return USB_STOR_TRANSPORT_FAILED;
870 return USB_STOR_TRANSPORT_FAILED;
874 static int usb_inquiry(ccb *srb, struct us_data *ss)
879 memset(&srb->cmd[0], 0, 12);
880 srb->cmd[0] = SCSI_INQUIRY;
884 i = ss->transport(srb, ss);
885 USB_STOR_PRINTF("inquiry returns %d\n", i);
891 printf("error in inquiry\n");
897 static int usb_request_sense(ccb *srb, struct us_data *ss)
901 ptr = (char *)srb->pdata;
902 memset(&srb->cmd[0], 0, 12);
903 srb->cmd[0] = SCSI_REQ_SENSE;
906 srb->pdata = &srb->sense_buf[0];
908 ss->transport(srb, ss);
909 USB_STOR_PRINTF("Request Sense returned %02X %02X %02X\n",
910 srb->sense_buf[2], srb->sense_buf[12],
912 srb->pdata = (uchar *)ptr;
916 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
921 memset(&srb->cmd[0], 0, 12);
922 srb->cmd[0] = SCSI_TST_U_RDY;
925 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
927 usb_request_sense(srb, ss);
934 static int usb_read_capacity(ccb *srb, struct us_data *ss)
940 memset(&srb->cmd[0], 0, 12);
941 srb->cmd[0] = SCSI_RD_CAPAC;
944 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
951 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
952 unsigned short blocks)
954 memset(&srb->cmd[0], 0, 12);
955 srb->cmd[0] = SCSI_READ10;
956 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
957 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
958 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
959 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
960 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
961 srb->cmd[8] = (unsigned char) blocks & 0xff;
963 USB_STOR_PRINTF("read10: start %lx blocks %x\n", start, blocks);
964 return ss->transport(srb, ss);
968 #ifdef CONFIG_USB_BIN_FIXUP
970 * Some USB storage devices queried for SCSI identification data respond with
971 * binary strings, which if output to the console freeze the terminal. The
972 * workaround is to modify the vendor and product strings read from such
973 * device with proper values (as reported by 'usb info').
975 * Vendor and product length limits are taken from the definition of
976 * block_dev_desc_t in include/part.h.
978 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
979 unsigned char vendor[],
980 unsigned char product[]) {
981 const unsigned char max_vendor_len = 40;
982 const unsigned char max_product_len = 20;
983 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
984 strncpy((char *)vendor, "SMSC", max_vendor_len);
985 strncpy((char *)product, "Flash Media Cntrller",
989 #endif /* CONFIG_USB_BIN_FIXUP */
991 #define USB_MAX_READ_BLK 20
993 unsigned long usb_stor_read(int device, unsigned long blknr,
994 unsigned long blkcnt, void *buffer)
996 unsigned long start, blks, buf_addr;
997 unsigned short smallblks;
998 struct usb_device *dev;
1000 ccb *srb = &usb_ccb;
1007 USB_STOR_PRINTF("\nusb_read: dev %d \n", device);
1009 for (i = 0; i < USB_MAX_DEVICE; i++) {
1010 dev = usb_get_dev_index(i);
1013 if (dev->devnum == usb_dev_desc[device].target)
1017 usb_disable_asynch(1); /* asynch transfer not allowed */
1018 srb->lun = usb_dev_desc[device].lun;
1019 buf_addr = (unsigned long)buffer;
1022 if (usb_test_unit_ready(srb, (struct us_data *)dev->privptr)) {
1023 printf("Device NOT ready\n Request Sense returned %02X %02X"
1024 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1025 srb->sense_buf[13]);
1029 USB_STOR_PRINTF("\nusb_read: dev %d startblk %lx, blccnt %lx"
1030 " buffer %lx\n", device, start, blks, buf_addr);
1033 /* XXX need some comment here */
1035 srb->pdata = (unsigned char *)buf_addr;
1036 if (blks > USB_MAX_READ_BLK)
1037 smallblks = USB_MAX_READ_BLK;
1039 smallblks = (unsigned short) blks;
1041 if (smallblks == USB_MAX_READ_BLK)
1042 usb_show_progress();
1043 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1044 srb->pdata = (unsigned char *)buf_addr;
1045 if (usb_read_10(srb, (struct us_data *)dev->privptr, start,
1047 USB_STOR_PRINTF("Read ERROR\n");
1048 usb_request_sense(srb, (struct us_data *)dev->privptr);
1056 buf_addr += srb->datalen;
1057 } while (blks != 0);
1059 USB_STOR_PRINTF("usb_read: end startblk %lx, blccnt %x buffer %lx\n",
1060 start, smallblks, buf_addr);
1062 usb_disable_asynch(0); /* asynch transfer allowed */
1063 if (blkcnt >= USB_MAX_READ_BLK)
1069 /* Probe to see if a new device is actually a Storage device */
1070 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1073 struct usb_interface_descriptor *iface;
1075 unsigned int flags = 0;
1080 /* let's examine the device now */
1081 iface = &dev->config.if_desc[ifnum];
1084 /* this is the place to patch some storage devices */
1085 USB_STOR_PRINTF("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1086 dev->descriptor.idProduct);
1088 if ((dev->descriptor.idVendor) == 0x066b &&
1089 (dev->descriptor.idProduct) == 0x0103) {
1090 USB_STOR_PRINTF("patched for E-USB\n");
1091 protocol = US_PR_CB;
1092 subclass = US_SC_UFI; /* an assumption */
1096 if (dev->descriptor.bDeviceClass != 0 ||
1097 iface->bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1098 iface->bInterfaceSubClass < US_SC_MIN ||
1099 iface->bInterfaceSubClass > US_SC_MAX) {
1100 /* if it's not a mass storage, we go no further */
1104 memset(ss, 0, sizeof(struct us_data));
1106 /* At this point, we know we've got a live one */
1107 USB_STOR_PRINTF("\n\nUSB Mass Storage device detected\n");
1109 /* Initialize the us_data structure with some useful info */
1113 ss->attention_done = 0;
1115 /* If the device has subclass and protocol, then use that. Otherwise,
1116 * take data from the specific interface.
1119 ss->subclass = subclass;
1120 ss->protocol = protocol;
1122 ss->subclass = iface->bInterfaceSubClass;
1123 ss->protocol = iface->bInterfaceProtocol;
1126 /* set the handler pointers based on the protocol */
1127 USB_STOR_PRINTF("Transport: ");
1128 switch (ss->protocol) {
1130 USB_STOR_PRINTF("Control/Bulk\n");
1131 ss->transport = usb_stor_CB_transport;
1132 ss->transport_reset = usb_stor_CB_reset;
1136 USB_STOR_PRINTF("Control/Bulk/Interrupt\n");
1137 ss->transport = usb_stor_CB_transport;
1138 ss->transport_reset = usb_stor_CB_reset;
1141 USB_STOR_PRINTF("Bulk/Bulk/Bulk\n");
1142 ss->transport = usb_stor_BBB_transport;
1143 ss->transport_reset = usb_stor_BBB_reset;
1146 printf("USB Storage Transport unknown / not yet implemented\n");
1152 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1153 * An optional interrupt is OK (necessary for CBI protocol).
1154 * We will ignore any others.
1156 for (i = 0; i < iface->bNumEndpoints; i++) {
1157 /* is it an BULK endpoint? */
1158 if ((iface->ep_desc[i].bmAttributes &
1159 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1160 if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
1161 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
1162 USB_ENDPOINT_NUMBER_MASK;
1165 iface->ep_desc[i].bEndpointAddress &
1166 USB_ENDPOINT_NUMBER_MASK;
1169 /* is it an interrupt endpoint? */
1170 if ((iface->ep_desc[i].bmAttributes &
1171 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1172 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
1173 USB_ENDPOINT_NUMBER_MASK;
1174 ss->irqinterval = iface->ep_desc[i].bInterval;
1177 USB_STOR_PRINTF("Endpoints In %d Out %d Int %d\n",
1178 ss->ep_in, ss->ep_out, ss->ep_int);
1180 /* Do some basic sanity checks, and bail if we find a problem */
1181 if (usb_set_interface(dev, iface->bInterfaceNumber, 0) ||
1182 !ss->ep_in || !ss->ep_out ||
1183 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1184 USB_STOR_PRINTF("Problems with device\n");
1187 /* set class specific stuff */
1188 /* We only handle certain protocols. Currently, these are
1190 * The SFF8070 accepts the requests used in u-boot
1192 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1193 ss->subclass != US_SC_8070) {
1194 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1198 /* we had found an interrupt endpoint, prepare irq pipe
1199 * set up the IRQ pipe and handler
1201 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1202 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1203 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1204 dev->irq_handle = usb_stor_irq;
1206 dev->privptr = (void *)ss;
1210 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1211 block_dev_desc_t *dev_desc)
1213 unsigned char perq, modi;
1214 unsigned long cap[2];
1215 unsigned long *capacity, *blksz;
1216 ccb *pccb = &usb_ccb;
1218 /* for some reasons a couple of devices would not survive this reset */
1221 (dev->descriptor.idVendor == 0x054c &&
1222 dev->descriptor.idProduct == 0x019e)
1224 /* USB007 Mini-USB2 Flash Drive */
1225 (dev->descriptor.idVendor == 0x066f &&
1226 dev->descriptor.idProduct == 0x2010)
1228 /* SanDisk Corporation Cruzer Micro 20044318410546613953 */
1229 (dev->descriptor.idVendor == 0x0781 &&
1230 dev->descriptor.idProduct == 0x5151)
1233 * SanDisk Corporation U3 Cruzer Micro 1/4GB
1234 * Flash Drive 000016244373FFB4
1236 (dev->descriptor.idVendor == 0x0781 &&
1237 dev->descriptor.idProduct == 0x5406)
1239 USB_STOR_PRINTF("usb_stor_get_info: skipping RESET..\n");
1241 ss->transport_reset(ss);
1243 pccb->pdata = usb_stor_buf;
1245 dev_desc->target = dev->devnum;
1246 pccb->lun = dev_desc->lun;
1247 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1249 if (usb_inquiry(pccb, ss))
1252 perq = usb_stor_buf[0];
1253 modi = usb_stor_buf[1];
1255 if ((perq & 0x1f) == 0x1f) {
1256 /* skip unknown devices */
1259 if ((modi&0x80) == 0x80) {
1260 /* drive is removable */
1261 dev_desc->removable = 1;
1263 memcpy(&dev_desc->vendor[0], &usb_stor_buf[8], 8);
1264 memcpy(&dev_desc->product[0], &usb_stor_buf[16], 16);
1265 memcpy(&dev_desc->revision[0], &usb_stor_buf[32], 4);
1266 dev_desc->vendor[8] = 0;
1267 dev_desc->product[16] = 0;
1268 dev_desc->revision[4] = 0;
1269 #ifdef CONFIG_USB_BIN_FIXUP
1270 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1271 (uchar *)dev_desc->product);
1272 #endif /* CONFIG_USB_BIN_FIXUP */
1273 USB_STOR_PRINTF("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1275 if (usb_test_unit_ready(pccb, ss)) {
1276 printf("Device NOT ready\n"
1277 " Request Sense returned %02X %02X %02X\n",
1278 pccb->sense_buf[2], pccb->sense_buf[12],
1279 pccb->sense_buf[13]);
1280 if (dev_desc->removable == 1) {
1281 dev_desc->type = perq;
1286 pccb->pdata = (unsigned char *)&cap[0];
1287 memset(pccb->pdata, 0, 8);
1288 if (usb_read_capacity(pccb, ss) != 0) {
1289 printf("READ_CAP ERROR\n");
1293 USB_STOR_PRINTF("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0],
1296 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1299 cap[0] = cpu_to_be32(cap[0]);
1300 cap[1] = cpu_to_be32(cap[1]);
1302 /* this assumes bigendian! */
1306 USB_STOR_PRINTF("Capacity = 0x%lx, blocksz = 0x%lx\n",
1308 dev_desc->lba = *capacity;
1309 dev_desc->blksz = *blksz;
1310 dev_desc->type = perq;
1311 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1312 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1314 init_part(dev_desc);
1316 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);