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>
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 unsigned long usb_stor_write(int device, unsigned long blknr,
172 unsigned long blkcnt, const void *buffer);
173 struct usb_device * usb_get_dev_index(int index);
174 void uhci_show_temp_int_td(void);
176 block_dev_desc_t *usb_stor_get_dev(int index)
178 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
182 void usb_show_progress(void)
187 /*******************************************************************************
188 * show info on storage devices; 'usb start/init' must be invoked earlier
189 * as we only retrieve structures populated during devices initialization
191 int usb_stor_info(void)
195 if (usb_max_devs > 0) {
196 for (i = 0; i < usb_max_devs; i++) {
197 printf(" Device %d: ", i);
198 dev_print(&usb_dev_desc[i]);
203 printf("No storage devices, perhaps not 'usb start'ed..?\n");
207 /*******************************************************************************
208 * scan the usb and reports device info
209 * to the user if mode = 1
210 * returns current device or -1 if no
212 int usb_stor_scan(int mode)
215 struct usb_device *dev;
218 memset(usb_stor_buf, 0, sizeof(usb_stor_buf));
221 printf(" scanning bus for storage devices... ");
223 usb_disable_asynch(1); /* asynch transfer not allowed */
225 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
226 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
227 usb_dev_desc[i].if_type = IF_TYPE_USB;
228 usb_dev_desc[i].dev = i;
229 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
230 usb_dev_desc[i].target = 0xff;
231 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
232 usb_dev_desc[i].block_read = usb_stor_read;
233 usb_dev_desc[i].block_write = usb_stor_write;
237 for (i = 0; i < USB_MAX_DEVICE; i++) {
238 dev = usb_get_dev_index(i); /* get device */
239 USB_STOR_PRINTF("i=%d\n", i);
241 break; /* no more devices avaiable */
243 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
244 /* ok, it is a storage devices
245 * get info and fill it in
247 if (usb_stor_get_info(dev, &usb_stor[usb_max_devs],
248 &usb_dev_desc[usb_max_devs]) == 1)
251 /* if storage device */
252 if (usb_max_devs == USB_MAX_STOR_DEV) {
253 printf("max USB Storage Device reached: %d stopping\n",
259 usb_disable_asynch(0); /* asynch transfer allowed */
260 printf("%d Storage Device(s) found\n", usb_max_devs);
261 if (usb_max_devs > 0)
266 static int usb_stor_irq(struct usb_device *dev)
269 us = (struct us_data *)dev->privptr;
277 #ifdef USB_STOR_DEBUG
279 static void usb_show_srb(ccb *pccb)
282 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
283 for (i = 0; i < 12; i++)
284 printf("%02X ", pccb->cmd[i]);
288 static void display_int_status(unsigned long tmp)
290 printf("Status: %s %s %s %s %s %s %s\n",
291 (tmp & USB_ST_ACTIVE) ? "Active" : "",
292 (tmp & USB_ST_STALLED) ? "Stalled" : "",
293 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
294 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
295 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
296 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
297 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
300 /***********************************************************************
301 * Data transfer routines
302 ***********************************************************************/
304 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
313 /* determine the maximum packet size for these transfers */
314 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
316 /* while we have data left to transfer */
319 /* calculate how long this will be -- maximum or a remainder */
320 this_xfer = length > max_size ? max_size : length;
323 /* setup the retry counter */
326 /* set up the transfer loop */
328 /* transfer the data */
329 USB_STOR_PRINTF("Bulk xfer 0x%x(%d) try #%d\n",
330 (unsigned int)buf, this_xfer, 11 - maxtry);
331 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
333 USB_CNTL_TIMEOUT * 5);
334 USB_STOR_PRINTF("bulk_msg returned %d xferred %d/%d\n",
335 result, partial, this_xfer);
336 if (us->pusb_dev->status != 0) {
337 /* if we stall, we need to clear it before
340 #ifdef USB_STOR_DEBUG
341 display_int_status(us->pusb_dev->status);
343 if (us->pusb_dev->status & USB_ST_STALLED) {
344 USB_STOR_PRINTF("stalled ->clearing endpoint halt for pipe 0x%x\n", pipe);
345 stat = us->pusb_dev->status;
346 usb_clear_halt(us->pusb_dev, pipe);
347 us->pusb_dev->status = stat;
348 if (this_xfer == partial) {
349 USB_STOR_PRINTF("bulk transferred with error %X, but data ok\n", us->pusb_dev->status);
355 if (us->pusb_dev->status & USB_ST_NAK_REC) {
356 USB_STOR_PRINTF("Device NAKed bulk_msg\n");
359 USB_STOR_PRINTF("bulk transferred with error");
360 if (this_xfer == partial) {
361 USB_STOR_PRINTF(" %d, but data ok\n",
362 us->pusb_dev->status);
365 /* if our try counter reaches 0, bail out */
366 USB_STOR_PRINTF(" %d, data %d\n",
367 us->pusb_dev->status, partial);
371 /* update to show what data was transferred */
372 this_xfer -= partial;
374 /* continue until this transfer is done */
378 /* if we get here, we're done and successful */
382 static int usb_stor_BBB_reset(struct us_data *us)
388 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
390 * For Reset Recovery the host shall issue in the following order:
391 * a) a Bulk-Only Mass Storage Reset
392 * b) a Clear Feature HALT to the Bulk-In endpoint
393 * c) a Clear Feature HALT to the Bulk-Out endpoint
395 * This is done in 3 steps.
397 * If the reset doesn't succeed, the device should be port reset.
399 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
401 USB_STOR_PRINTF("BBB_reset\n");
402 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
404 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
405 0, us->ifnum, 0, 0, USB_CNTL_TIMEOUT * 5);
407 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
408 USB_STOR_PRINTF("RESET:stall\n");
412 /* long wait for reset */
414 USB_STOR_PRINTF("BBB_reset result %d: status %X reset\n", result,
415 us->pusb_dev->status);
416 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
417 result = usb_clear_halt(us->pusb_dev, pipe);
418 /* long wait for reset */
420 USB_STOR_PRINTF("BBB_reset result %d: status %X clearing IN endpoint\n",
421 result, us->pusb_dev->status);
422 /* long wait for reset */
423 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
424 result = usb_clear_halt(us->pusb_dev, pipe);
426 USB_STOR_PRINTF("BBB_reset result %d: status %X"
427 " clearing OUT endpoint\n", result,
428 us->pusb_dev->status);
429 USB_STOR_PRINTF("BBB_reset done\n");
433 /* FIXME: this reset function doesn't really reset the port, and it
434 * should. Actually it should probably do what it's doing here, and
435 * reset the port physically
437 static int usb_stor_CB_reset(struct us_data *us)
439 unsigned char cmd[12];
442 USB_STOR_PRINTF("CB_reset\n");
443 memset(cmd, 0xff, sizeof(cmd));
444 cmd[0] = SCSI_SEND_DIAG;
446 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
448 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
449 0, us->ifnum, cmd, sizeof(cmd),
450 USB_CNTL_TIMEOUT * 5);
452 /* long wait for reset */
454 USB_STOR_PRINTF("CB_reset result %d: status %X"
455 " clearing endpoint halt\n", result,
456 us->pusb_dev->status);
457 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
458 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
460 USB_STOR_PRINTF("CB_reset done\n");
465 * Set up the command for a BBB device. Note that the actual SCSI
466 * command is copied into cbw.CBWCDB.
468 int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
476 dir_in = US_DIRECTION(srb->cmd[0]);
478 #ifdef BBB_COMDAT_TRACE
479 printf("dir %d lun %d cmdlen %d cmd %p datalen %d pdata %p\n",
480 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
483 for (result = 0; result < srb->cmdlen; result++)
484 printf("cmd[%d] %#x ", result, srb->cmd[result]);
489 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
490 USB_STOR_PRINTF("usb_stor_BBB_comdat:cmdlen too large\n");
494 /* always OUT to the ep */
495 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
497 cbw.dCBWSignature = cpu_to_le32(CBWSIGNATURE);
498 cbw.dCBWTag = cpu_to_le32(CBWTag++);
499 cbw.dCBWDataTransferLength = cpu_to_le32(srb->datalen);
500 cbw.bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
501 cbw.bCBWLUN = srb->lun;
502 cbw.bCDBLength = srb->cmdlen;
503 /* copy the command data into the CBW command data buffer */
505 memcpy(cbw.CBWCDB, srb->cmd, srb->cmdlen);
506 result = usb_bulk_msg(us->pusb_dev, pipe, &cbw, UMASS_BBB_CBW_SIZE,
507 &actlen, USB_CNTL_TIMEOUT * 5);
509 USB_STOR_PRINTF("usb_stor_BBB_comdat:usb_bulk_msg error\n");
513 /* FIXME: we also need a CBI_command which sets up the completion
514 * interrupt, and waits for it
516 int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
521 unsigned long status;
524 dir_in = US_DIRECTION(srb->cmd[0]);
527 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
529 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
532 USB_STOR_PRINTF("CBI gets a command: Try %d\n", 5 - retry);
533 #ifdef USB_STOR_DEBUG
536 /* let's send the command via the control pipe */
537 result = usb_control_msg(us->pusb_dev,
538 usb_sndctrlpipe(us->pusb_dev , 0),
540 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
542 srb->cmd, srb->cmdlen,
543 USB_CNTL_TIMEOUT * 5);
544 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
545 " status %X\n", result, us->pusb_dev->status);
546 /* check the return code for the command */
548 if (us->pusb_dev->status & USB_ST_STALLED) {
549 status = us->pusb_dev->status;
550 USB_STOR_PRINTF(" stall during command found,"
552 usb_clear_halt(us->pusb_dev,
553 usb_sndctrlpipe(us->pusb_dev, 0));
554 us->pusb_dev->status = status;
556 USB_STOR_PRINTF(" error during command %02X"
557 " Stat = %X\n", srb->cmd[0],
558 us->pusb_dev->status);
561 /* transfer the data payload for this command, if one exists*/
563 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
564 " direction is %s to go 0x%lx\n", result,
565 dir_in ? "IN" : "OUT", srb->datalen);
567 result = us_one_transfer(us, pipe, (char *)srb->pdata,
569 USB_STOR_PRINTF("CBI attempted to transfer data,"
570 " result is %d status %lX, len %d\n",
571 result, us->pusb_dev->status,
572 us->pusb_dev->act_len);
573 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
575 } /* if (srb->datalen) */
585 int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
590 submit_int_msg(us->pusb_dev, us->irqpipe,
591 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
594 if ((volatile int *) us->ip_wanted == 0)
599 printf(" Did not get interrupt on CBI\n");
601 return USB_STOR_TRANSPORT_ERROR;
604 ("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
605 us->ip_data, us->pusb_dev->irq_act_len,
606 us->pusb_dev->irq_status);
607 /* UFI gives us ASC and ASCQ, like a request sense */
608 if (us->subclass == US_SC_UFI) {
609 if (srb->cmd[0] == SCSI_REQ_SENSE ||
610 srb->cmd[0] == SCSI_INQUIRY)
611 return USB_STOR_TRANSPORT_GOOD; /* Good */
612 else if (us->ip_data)
613 return USB_STOR_TRANSPORT_FAILED;
615 return USB_STOR_TRANSPORT_GOOD;
617 /* otherwise, we interpret the data normally */
618 switch (us->ip_data) {
620 return USB_STOR_TRANSPORT_GOOD;
622 return USB_STOR_TRANSPORT_FAILED;
624 return USB_STOR_TRANSPORT_ERROR;
626 return USB_STOR_TRANSPORT_ERROR;
629 #define USB_TRANSPORT_UNKNOWN_RETRY 5
630 #define USB_TRANSPORT_NOT_READY_RETRY 10
632 /* clear a stall on an endpoint - special for BBB devices */
633 int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
637 /* ENDPOINT_HALT = 0, so set value to 0 */
638 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
639 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
640 0, endpt, 0, 0, USB_CNTL_TIMEOUT * 5);
644 int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
648 int actlen, data_actlen;
649 unsigned int pipe, pipein, pipeout;
651 #ifdef BBB_XPORT_TRACE
656 dir_in = US_DIRECTION(srb->cmd[0]);
659 USB_STOR_PRINTF("COMMAND phase\n");
660 result = usb_stor_BBB_comdat(srb, us);
662 USB_STOR_PRINTF("failed to send CBW status %ld\n",
663 us->pusb_dev->status);
664 usb_stor_BBB_reset(us);
665 return USB_STOR_TRANSPORT_FAILED;
668 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
669 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
670 /* DATA phase + error handling */
672 /* no data, go immediately to the STATUS phase */
673 if (srb->datalen == 0)
675 USB_STOR_PRINTF("DATA phase\n");
680 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
681 &data_actlen, USB_CNTL_TIMEOUT * 5);
682 /* special handling of STALL in DATA phase */
683 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
684 USB_STOR_PRINTF("DATA:stall\n");
685 /* clear the STALL on the endpoint */
686 result = usb_stor_BBB_clear_endpt_stall(us,
687 dir_in ? us->ep_in : us->ep_out);
689 /* continue on to STATUS phase */
693 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
694 us->pusb_dev->status);
695 usb_stor_BBB_reset(us);
696 return USB_STOR_TRANSPORT_FAILED;
698 #ifdef BBB_XPORT_TRACE
699 for (index = 0; index < data_actlen; index++)
700 printf("pdata[%d] %#x ", index, srb->pdata[index]);
703 /* STATUS phase + error handling */
707 USB_STOR_PRINTF("STATUS phase\n");
708 result = usb_bulk_msg(us->pusb_dev, pipein, &csw, UMASS_BBB_CSW_SIZE,
709 &actlen, USB_CNTL_TIMEOUT*5);
711 /* special handling of STALL in STATUS phase */
712 if ((result < 0) && (retry < 1) &&
713 (us->pusb_dev->status & USB_ST_STALLED)) {
714 USB_STOR_PRINTF("STATUS:stall\n");
715 /* clear the STALL on the endpoint */
716 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
717 if (result >= 0 && (retry++ < 1))
722 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
723 us->pusb_dev->status);
724 usb_stor_BBB_reset(us);
725 return USB_STOR_TRANSPORT_FAILED;
727 #ifdef BBB_XPORT_TRACE
728 ptr = (unsigned char *)&csw;
729 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
730 printf("ptr[%d] %#x ", index, ptr[index]);
733 /* misuse pipe to get the residue */
734 pipe = le32_to_cpu(csw.dCSWDataResidue);
735 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
736 pipe = srb->datalen - data_actlen;
737 if (CSWSIGNATURE != le32_to_cpu(csw.dCSWSignature)) {
738 USB_STOR_PRINTF("!CSWSIGNATURE\n");
739 usb_stor_BBB_reset(us);
740 return USB_STOR_TRANSPORT_FAILED;
741 } else if ((CBWTag - 1) != le32_to_cpu(csw.dCSWTag)) {
742 USB_STOR_PRINTF("!Tag\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 (csw.bCSWStatus == CSWSTATUS_PHASE) {
750 USB_STOR_PRINTF("=PHASE\n");
751 usb_stor_BBB_reset(us);
752 return USB_STOR_TRANSPORT_FAILED;
753 } else if (data_actlen > srb->datalen) {
754 USB_STOR_PRINTF("transferred %dB instead of %dB\n",
755 data_actlen, srb->datalen);
756 return USB_STOR_TRANSPORT_FAILED;
757 } else if (csw.bCSWStatus == CSWSTATUS_FAILED) {
758 USB_STOR_PRINTF("FAILED\n");
759 return USB_STOR_TRANSPORT_FAILED;
765 int usb_stor_CB_transport(ccb *srb, struct us_data *us)
773 status = USB_STOR_TRANSPORT_GOOD;
776 /* issue the command */
778 result = usb_stor_CB_comdat(srb, us);
779 USB_STOR_PRINTF("command / Data returned %d, status %X\n",
780 result, us->pusb_dev->status);
781 /* if this is an CBI Protocol, get IRQ */
782 if (us->protocol == US_PR_CBI) {
783 status = usb_stor_CBI_get_status(srb, us);
784 /* if the status is error, report it */
785 if (status == USB_STOR_TRANSPORT_ERROR) {
786 USB_STOR_PRINTF(" USB CBI Command Error\n");
789 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
790 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
792 /* if the status is good, report it */
793 if (status == USB_STOR_TRANSPORT_GOOD) {
794 USB_STOR_PRINTF(" USB CBI Command Good\n");
799 /* do we have to issue an auto request? */
800 /* HERE we have to check the result */
801 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
802 USB_STOR_PRINTF("ERROR %X\n", us->pusb_dev->status);
803 us->transport_reset(us);
804 return USB_STOR_TRANSPORT_ERROR;
806 if ((us->protocol == US_PR_CBI) &&
807 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
808 (srb->cmd[0] == SCSI_INQUIRY))) {
809 /* do not issue an autorequest after request sense */
810 USB_STOR_PRINTF("No auto request and good\n");
811 return USB_STOR_TRANSPORT_GOOD;
813 /* issue an request_sense */
814 memset(&psrb->cmd[0], 0, 12);
815 psrb->cmd[0] = SCSI_REQ_SENSE;
816 psrb->cmd[1] = srb->lun << 5;
819 psrb->pdata = &srb->sense_buf[0];
821 /* issue the command */
822 result = usb_stor_CB_comdat(psrb, us);
823 USB_STOR_PRINTF("auto request returned %d\n", result);
824 /* if this is an CBI Protocol, get IRQ */
825 if (us->protocol == US_PR_CBI)
826 status = usb_stor_CBI_get_status(psrb, us);
828 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
829 USB_STOR_PRINTF(" AUTO REQUEST ERROR %d\n",
830 us->pusb_dev->status);
831 return USB_STOR_TRANSPORT_ERROR;
833 USB_STOR_PRINTF("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
834 srb->sense_buf[0], srb->sense_buf[2],
835 srb->sense_buf[12], srb->sense_buf[13]);
836 /* Check the auto request result */
837 if ((srb->sense_buf[2] == 0) &&
838 (srb->sense_buf[12] == 0) &&
839 (srb->sense_buf[13] == 0)) {
841 return USB_STOR_TRANSPORT_GOOD;
844 /* Check the auto request result */
845 switch (srb->sense_buf[2]) {
847 /* Recovered Error */
848 return USB_STOR_TRANSPORT_GOOD;
852 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
853 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
854 " 0x%02X (NOT READY)\n", srb->cmd[0],
855 srb->sense_buf[0], srb->sense_buf[2],
856 srb->sense_buf[12], srb->sense_buf[13]);
857 return USB_STOR_TRANSPORT_FAILED;
864 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
865 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
866 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
867 srb->sense_buf[2], srb->sense_buf[12],
869 return USB_STOR_TRANSPORT_FAILED;
874 return USB_STOR_TRANSPORT_FAILED;
878 static int usb_inquiry(ccb *srb, struct us_data *ss)
883 memset(&srb->cmd[0], 0, 12);
884 srb->cmd[0] = SCSI_INQUIRY;
888 i = ss->transport(srb, ss);
889 USB_STOR_PRINTF("inquiry returns %d\n", i);
895 printf("error in inquiry\n");
901 static int usb_request_sense(ccb *srb, struct us_data *ss)
905 ptr = (char *)srb->pdata;
906 memset(&srb->cmd[0], 0, 12);
907 srb->cmd[0] = SCSI_REQ_SENSE;
910 srb->pdata = &srb->sense_buf[0];
912 ss->transport(srb, ss);
913 USB_STOR_PRINTF("Request Sense returned %02X %02X %02X\n",
914 srb->sense_buf[2], srb->sense_buf[12],
916 srb->pdata = (uchar *)ptr;
920 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
925 memset(&srb->cmd[0], 0, 12);
926 srb->cmd[0] = SCSI_TST_U_RDY;
929 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
931 usb_request_sense(srb, ss);
938 static int usb_read_capacity(ccb *srb, struct us_data *ss)
944 memset(&srb->cmd[0], 0, 12);
945 srb->cmd[0] = SCSI_RD_CAPAC;
948 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
955 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
956 unsigned short blocks)
958 memset(&srb->cmd[0], 0, 12);
959 srb->cmd[0] = SCSI_READ10;
960 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
961 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
962 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
963 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
964 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
965 srb->cmd[8] = (unsigned char) blocks & 0xff;
967 USB_STOR_PRINTF("read10: start %lx blocks %x\n", start, blocks);
968 return ss->transport(srb, ss);
971 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
972 unsigned short blocks)
974 memset(&srb->cmd[0], 0, 12);
975 srb->cmd[0] = SCSI_WRITE10;
976 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
977 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
978 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
979 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
980 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
981 srb->cmd[8] = (unsigned char) blocks & 0xff;
983 USB_STOR_PRINTF("write10: start %lx blocks %x\n", start, blocks);
984 return ss->transport(srb, ss);
988 #ifdef CONFIG_USB_BIN_FIXUP
990 * Some USB storage devices queried for SCSI identification data respond with
991 * binary strings, which if output to the console freeze the terminal. The
992 * workaround is to modify the vendor and product strings read from such
993 * device with proper values (as reported by 'usb info').
995 * Vendor and product length limits are taken from the definition of
996 * block_dev_desc_t in include/part.h.
998 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
999 unsigned char vendor[],
1000 unsigned char product[]) {
1001 const unsigned char max_vendor_len = 40;
1002 const unsigned char max_product_len = 20;
1003 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1004 strncpy((char *)vendor, "SMSC", max_vendor_len);
1005 strncpy((char *)product, "Flash Media Cntrller",
1009 #endif /* CONFIG_USB_BIN_FIXUP */
1011 #define USB_MAX_READ_BLK 20
1013 unsigned long usb_stor_read(int device, unsigned long blknr,
1014 unsigned long blkcnt, void *buffer)
1016 unsigned long start, blks, buf_addr;
1017 unsigned short smallblks;
1018 struct usb_device *dev;
1020 ccb *srb = &usb_ccb;
1027 USB_STOR_PRINTF("\nusb_read: dev %d \n", device);
1029 for (i = 0; i < USB_MAX_DEVICE; i++) {
1030 dev = usb_get_dev_index(i);
1033 if (dev->devnum == usb_dev_desc[device].target)
1037 usb_disable_asynch(1); /* asynch transfer not allowed */
1038 srb->lun = usb_dev_desc[device].lun;
1039 buf_addr = (unsigned long)buffer;
1042 if (usb_test_unit_ready(srb, (struct us_data *)dev->privptr)) {
1043 printf("Device NOT ready\n Request Sense returned %02X %02X"
1044 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1045 srb->sense_buf[13]);
1049 USB_STOR_PRINTF("\nusb_read: dev %d startblk %lx, blccnt %lx"
1050 " buffer %lx\n", device, start, blks, buf_addr);
1053 /* XXX need some comment here */
1055 srb->pdata = (unsigned char *)buf_addr;
1056 if (blks > USB_MAX_READ_BLK)
1057 smallblks = USB_MAX_READ_BLK;
1059 smallblks = (unsigned short) blks;
1061 if (smallblks == USB_MAX_READ_BLK)
1062 usb_show_progress();
1063 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1064 srb->pdata = (unsigned char *)buf_addr;
1065 if (usb_read_10(srb, (struct us_data *)dev->privptr, start,
1067 USB_STOR_PRINTF("Read ERROR\n");
1068 usb_request_sense(srb, (struct us_data *)dev->privptr);
1076 buf_addr += srb->datalen;
1077 } while (blks != 0);
1079 USB_STOR_PRINTF("usb_read: end startblk %lx, blccnt %x buffer %lx\n",
1080 start, smallblks, buf_addr);
1082 usb_disable_asynch(0); /* asynch transfer allowed */
1083 if (blkcnt >= USB_MAX_READ_BLK)
1088 #define USB_MAX_WRITE_BLK 20
1090 unsigned long usb_stor_write(int device, unsigned long blknr,
1091 unsigned long blkcnt, const void *buffer)
1093 unsigned long start, blks, buf_addr;
1094 unsigned short smallblks;
1095 struct usb_device *dev;
1097 ccb *srb = &usb_ccb;
1104 USB_STOR_PRINTF("\nusb_write: dev %d \n", device);
1106 for (i = 0; i < USB_MAX_DEVICE; i++) {
1107 dev = usb_get_dev_index(i);
1110 if (dev->devnum == usb_dev_desc[device].target)
1114 usb_disable_asynch(1); /* asynch transfer not allowed */
1116 srb->lun = usb_dev_desc[device].lun;
1117 buf_addr = (unsigned long)buffer;
1120 if (usb_test_unit_ready(srb, (struct us_data *)dev->privptr)) {
1121 printf("Device NOT ready\n Request Sense returned %02X %02X"
1122 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1123 srb->sense_buf[13]);
1127 USB_STOR_PRINTF("\nusb_write: dev %d startblk %lx, blccnt %lx"
1128 " buffer %lx\n", device, start, blks, buf_addr);
1131 /* If write fails retry for max retry count else
1132 * return with number of blocks written successfully.
1135 srb->pdata = (unsigned char *)buf_addr;
1136 if (blks > USB_MAX_WRITE_BLK)
1137 smallblks = USB_MAX_WRITE_BLK;
1139 smallblks = (unsigned short) blks;
1141 if (smallblks == USB_MAX_WRITE_BLK)
1142 usb_show_progress();
1143 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1144 srb->pdata = (unsigned char *)buf_addr;
1145 if (usb_write_10(srb, (struct us_data *)dev->privptr, start,
1147 USB_STOR_PRINTF("Write ERROR\n");
1148 usb_request_sense(srb, (struct us_data *)dev->privptr);
1156 buf_addr += srb->datalen;
1157 } while (blks != 0);
1159 USB_STOR_PRINTF("usb_write: end startblk %lx, blccnt %x buffer %lx\n",
1160 start, smallblks, buf_addr);
1162 usb_disable_asynch(0); /* asynch transfer allowed */
1163 if (blkcnt >= USB_MAX_WRITE_BLK)
1169 /* Probe to see if a new device is actually a Storage device */
1170 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1173 struct usb_interface *iface;
1175 unsigned int flags = 0;
1180 /* let's examine the device now */
1181 iface = &dev->config.if_desc[ifnum];
1184 /* this is the place to patch some storage devices */
1185 USB_STOR_PRINTF("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1186 dev->descriptor.idProduct);
1188 if ((dev->descriptor.idVendor) == 0x066b &&
1189 (dev->descriptor.idProduct) == 0x0103) {
1190 USB_STOR_PRINTF("patched for E-USB\n");
1191 protocol = US_PR_CB;
1192 subclass = US_SC_UFI; /* an assumption */
1196 if (dev->descriptor.bDeviceClass != 0 ||
1197 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1198 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1199 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1200 /* if it's not a mass storage, we go no further */
1204 memset(ss, 0, sizeof(struct us_data));
1206 /* At this point, we know we've got a live one */
1207 USB_STOR_PRINTF("\n\nUSB Mass Storage device detected\n");
1209 /* Initialize the us_data structure with some useful info */
1213 ss->attention_done = 0;
1215 /* If the device has subclass and protocol, then use that. Otherwise,
1216 * take data from the specific interface.
1219 ss->subclass = subclass;
1220 ss->protocol = protocol;
1222 ss->subclass = iface->desc.bInterfaceSubClass;
1223 ss->protocol = iface->desc.bInterfaceProtocol;
1226 /* set the handler pointers based on the protocol */
1227 USB_STOR_PRINTF("Transport: ");
1228 switch (ss->protocol) {
1230 USB_STOR_PRINTF("Control/Bulk\n");
1231 ss->transport = usb_stor_CB_transport;
1232 ss->transport_reset = usb_stor_CB_reset;
1236 USB_STOR_PRINTF("Control/Bulk/Interrupt\n");
1237 ss->transport = usb_stor_CB_transport;
1238 ss->transport_reset = usb_stor_CB_reset;
1241 USB_STOR_PRINTF("Bulk/Bulk/Bulk\n");
1242 ss->transport = usb_stor_BBB_transport;
1243 ss->transport_reset = usb_stor_BBB_reset;
1246 printf("USB Storage Transport unknown / not yet implemented\n");
1252 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1253 * An optional interrupt is OK (necessary for CBI protocol).
1254 * We will ignore any others.
1256 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1257 /* is it an BULK endpoint? */
1258 if ((iface->ep_desc[i].bmAttributes &
1259 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1260 if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
1261 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
1262 USB_ENDPOINT_NUMBER_MASK;
1265 iface->ep_desc[i].bEndpointAddress &
1266 USB_ENDPOINT_NUMBER_MASK;
1269 /* is it an interrupt endpoint? */
1270 if ((iface->ep_desc[i].bmAttributes &
1271 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1272 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
1273 USB_ENDPOINT_NUMBER_MASK;
1274 ss->irqinterval = iface->ep_desc[i].bInterval;
1277 USB_STOR_PRINTF("Endpoints In %d Out %d Int %d\n",
1278 ss->ep_in, ss->ep_out, ss->ep_int);
1280 /* Do some basic sanity checks, and bail if we find a problem */
1281 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1282 !ss->ep_in || !ss->ep_out ||
1283 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1284 USB_STOR_PRINTF("Problems with device\n");
1287 /* set class specific stuff */
1288 /* We only handle certain protocols. Currently, these are
1290 * The SFF8070 accepts the requests used in u-boot
1292 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1293 ss->subclass != US_SC_8070) {
1294 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1298 /* we had found an interrupt endpoint, prepare irq pipe
1299 * set up the IRQ pipe and handler
1301 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1302 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1303 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1304 dev->irq_handle = usb_stor_irq;
1306 dev->privptr = (void *)ss;
1310 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1311 block_dev_desc_t *dev_desc)
1313 unsigned char perq, modi;
1314 unsigned long cap[2];
1315 unsigned long *capacity, *blksz;
1316 ccb *pccb = &usb_ccb;
1318 /* for some reasons a couple of devices would not survive this reset */
1321 (dev->descriptor.idVendor == 0x054c &&
1322 dev->descriptor.idProduct == 0x019e)
1324 /* USB007 Mini-USB2 Flash Drive */
1325 (dev->descriptor.idVendor == 0x066f &&
1326 dev->descriptor.idProduct == 0x2010)
1328 /* SanDisk Corporation Cruzer Micro 20044318410546613953 */
1329 (dev->descriptor.idVendor == 0x0781 &&
1330 dev->descriptor.idProduct == 0x5151)
1333 * SanDisk Corporation U3 Cruzer Micro 1/4GB
1334 * Flash Drive 000016244373FFB4
1336 (dev->descriptor.idVendor == 0x0781 &&
1337 dev->descriptor.idProduct == 0x5406)
1339 USB_STOR_PRINTF("usb_stor_get_info: skipping RESET..\n");
1341 ss->transport_reset(ss);
1343 pccb->pdata = usb_stor_buf;
1345 dev_desc->target = dev->devnum;
1346 pccb->lun = dev_desc->lun;
1347 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1349 if (usb_inquiry(pccb, ss))
1352 perq = usb_stor_buf[0];
1353 modi = usb_stor_buf[1];
1355 if ((perq & 0x1f) == 0x1f) {
1356 /* skip unknown devices */
1359 if ((modi&0x80) == 0x80) {
1360 /* drive is removable */
1361 dev_desc->removable = 1;
1363 memcpy(&dev_desc->vendor[0], &usb_stor_buf[8], 8);
1364 memcpy(&dev_desc->product[0], &usb_stor_buf[16], 16);
1365 memcpy(&dev_desc->revision[0], &usb_stor_buf[32], 4);
1366 dev_desc->vendor[8] = 0;
1367 dev_desc->product[16] = 0;
1368 dev_desc->revision[4] = 0;
1369 #ifdef CONFIG_USB_BIN_FIXUP
1370 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1371 (uchar *)dev_desc->product);
1372 #endif /* CONFIG_USB_BIN_FIXUP */
1373 USB_STOR_PRINTF("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1375 if (usb_test_unit_ready(pccb, ss)) {
1376 printf("Device NOT ready\n"
1377 " Request Sense returned %02X %02X %02X\n",
1378 pccb->sense_buf[2], pccb->sense_buf[12],
1379 pccb->sense_buf[13]);
1380 if (dev_desc->removable == 1) {
1381 dev_desc->type = perq;
1386 pccb->pdata = (unsigned char *)&cap[0];
1387 memset(pccb->pdata, 0, 8);
1388 if (usb_read_capacity(pccb, ss) != 0) {
1389 printf("READ_CAP ERROR\n");
1393 USB_STOR_PRINTF("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0],
1396 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1399 cap[0] = cpu_to_be32(cap[0]);
1400 cap[1] = cpu_to_be32(cap[1]);
1402 /* this assumes bigendian! */
1406 USB_STOR_PRINTF("Capacity = 0x%lx, blocksz = 0x%lx\n",
1408 dev_desc->lba = *capacity;
1409 dev_desc->blksz = *blksz;
1410 dev_desc->type = perq;
1411 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1412 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1414 init_part(dev_desc);
1416 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);