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 #define USB_BLK_DEBUG 1
65 #define USB_BLK_DEBUG 0
68 #define USB_STOR_PRINTF(fmt, args...) debug_cond(USB_BLK_DEBUG, fmt, ##args)
71 /* direction table -- this indicates the direction of the data
72 * transfer for each command code -- a 1 indicates input
74 static const unsigned char us_direction[256/8] = {
75 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
76 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
77 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
78 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
80 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
82 static unsigned char usb_stor_buf[512];
94 #define US_BBB_RESET 0xff
95 #define US_BBB_GET_MAX_LUN 0xfe
97 /* Command Block Wrapper */
100 # define CBWSIGNATURE 0x43425355
102 __u32 dCBWDataTransferLength;
104 # define CBWFLAGS_OUT 0x00
105 # define CBWFLAGS_IN 0x80
108 # define CBWCDBLENGTH 16
109 __u8 CBWCDB[CBWCDBLENGTH];
111 #define UMASS_BBB_CBW_SIZE 31
114 /* Command Status Wrapper */
117 # define CSWSIGNATURE 0x53425355
119 __u32 dCSWDataResidue;
121 # define CSWSTATUS_GOOD 0x0
122 # define CSWSTATUS_FAILED 0x1
123 # define CSWSTATUS_PHASE 0x2
125 #define UMASS_BBB_CSW_SIZE 13
127 #define USB_MAX_STOR_DEV 5
128 static int usb_max_devs; /* number of highest available usb device */
130 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
133 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
134 typedef int (*trans_reset)(struct us_data *data);
137 struct usb_device *pusb_dev; /* this usb_device */
139 unsigned int flags; /* from filter initially */
140 unsigned char ifnum; /* interface number */
141 unsigned char ep_in; /* in endpoint */
142 unsigned char ep_out; /* out ....... */
143 unsigned char ep_int; /* interrupt . */
144 unsigned char subclass; /* as in overview */
145 unsigned char protocol; /* .............. */
146 unsigned char attention_done; /* force attn on first cmd */
147 unsigned short ip_data; /* interrupt data */
148 int action; /* what to do */
149 int ip_wanted; /* needed */
150 int *irq_handle; /* for USB int requests */
151 unsigned int irqpipe; /* pipe for release_irq */
152 unsigned char irqmaxp; /* max packed for irq Pipe */
153 unsigned char irqinterval; /* Intervall for IRQ Pipe */
154 ccb *srb; /* current srb */
155 trans_reset transport_reset; /* reset routine */
156 trans_cmnd transport; /* transport routine */
159 static struct us_data usb_stor[USB_MAX_STOR_DEV];
162 #define USB_STOR_TRANSPORT_GOOD 0
163 #define USB_STOR_TRANSPORT_FAILED -1
164 #define USB_STOR_TRANSPORT_ERROR -2
166 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
167 block_dev_desc_t *dev_desc);
168 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
170 unsigned long usb_stor_read(int device, unsigned long blknr,
171 unsigned long blkcnt, void *buffer);
172 unsigned long usb_stor_write(int device, unsigned long blknr,
173 unsigned long blkcnt, const void *buffer);
174 struct usb_device * usb_get_dev_index(int index);
175 void uhci_show_temp_int_td(void);
177 #ifdef CONFIG_PARTITIONS
178 block_dev_desc_t *usb_stor_get_dev(int index)
180 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
184 void usb_show_progress(void)
189 /*******************************************************************************
190 * show info on storage devices; 'usb start/init' must be invoked earlier
191 * as we only retrieve structures populated during devices initialization
193 int usb_stor_info(void)
197 if (usb_max_devs > 0) {
198 for (i = 0; i < usb_max_devs; i++) {
199 printf(" Device %d: ", i);
200 dev_print(&usb_dev_desc[i]);
205 printf("No storage devices, perhaps not 'usb start'ed..?\n");
209 static unsigned int usb_get_max_lun(struct us_data *us)
212 unsigned char result;
213 len = usb_control_msg(us->pusb_dev,
214 usb_rcvctrlpipe(us->pusb_dev, 0),
216 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
218 &result, sizeof(result),
219 USB_CNTL_TIMEOUT * 5);
220 USB_STOR_PRINTF("Get Max LUN -> len = %i, result = %i\n",
222 return (len > 0) ? result : 0;
225 /*******************************************************************************
226 * scan the usb and reports device info
227 * to the user if mode = 1
228 * returns current device or -1 if no
230 int usb_stor_scan(int mode)
233 struct usb_device *dev;
236 memset(usb_stor_buf, 0, sizeof(usb_stor_buf));
239 printf(" scanning bus for storage devices... ");
241 usb_disable_asynch(1); /* asynch transfer not allowed */
243 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
244 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
245 usb_dev_desc[i].if_type = IF_TYPE_USB;
246 usb_dev_desc[i].dev = i;
247 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
248 usb_dev_desc[i].target = 0xff;
249 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
250 usb_dev_desc[i].block_read = usb_stor_read;
251 usb_dev_desc[i].block_write = usb_stor_write;
255 for (i = 0; i < USB_MAX_DEVICE; i++) {
256 dev = usb_get_dev_index(i); /* get device */
257 USB_STOR_PRINTF("i=%d\n", i);
259 break; /* no more devices available */
261 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
262 /* OK, it's a storage device. Iterate over its LUNs
263 * and populate `usb_dev_desc'.
265 int lun, max_lun, start = usb_max_devs;
267 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
269 lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
271 usb_dev_desc[usb_max_devs].lun = lun;
272 if (usb_stor_get_info(dev, &usb_stor[start],
273 &usb_dev_desc[usb_max_devs]) == 1) {
278 /* if storage device */
279 if (usb_max_devs == USB_MAX_STOR_DEV) {
280 printf("max USB Storage Device reached: %d stopping\n",
286 usb_disable_asynch(0); /* asynch transfer allowed */
287 printf("%d Storage Device(s) found\n", usb_max_devs);
288 if (usb_max_devs > 0)
293 static int usb_stor_irq(struct usb_device *dev)
296 us = (struct us_data *)dev->privptr;
304 #ifdef USB_STOR_DEBUG
306 static void usb_show_srb(ccb *pccb)
309 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
310 for (i = 0; i < 12; i++)
311 printf("%02X ", pccb->cmd[i]);
315 static void display_int_status(unsigned long tmp)
317 printf("Status: %s %s %s %s %s %s %s\n",
318 (tmp & USB_ST_ACTIVE) ? "Active" : "",
319 (tmp & USB_ST_STALLED) ? "Stalled" : "",
320 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
321 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
322 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
323 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
324 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
327 /***********************************************************************
328 * Data transfer routines
329 ***********************************************************************/
331 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
340 /* determine the maximum packet size for these transfers */
341 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
343 /* while we have data left to transfer */
346 /* calculate how long this will be -- maximum or a remainder */
347 this_xfer = length > max_size ? max_size : length;
350 /* setup the retry counter */
353 /* set up the transfer loop */
355 /* transfer the data */
356 USB_STOR_PRINTF("Bulk xfer 0x%x(%d) try #%d\n",
357 (unsigned int)buf, this_xfer, 11 - maxtry);
358 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
360 USB_CNTL_TIMEOUT * 5);
361 USB_STOR_PRINTF("bulk_msg returned %d xferred %d/%d\n",
362 result, partial, this_xfer);
363 if (us->pusb_dev->status != 0) {
364 /* if we stall, we need to clear it before
367 #ifdef USB_STOR_DEBUG
368 display_int_status(us->pusb_dev->status);
370 if (us->pusb_dev->status & USB_ST_STALLED) {
371 USB_STOR_PRINTF("stalled ->clearing endpoint 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 USB_STOR_PRINTF("bulk transferred with error %lX, but data ok\n", us->pusb_dev->status);
382 if (us->pusb_dev->status & USB_ST_NAK_REC) {
383 USB_STOR_PRINTF("Device NAKed bulk_msg\n");
386 USB_STOR_PRINTF("bulk transferred with error");
387 if (this_xfer == partial) {
388 USB_STOR_PRINTF(" %ld, but data ok\n",
389 us->pusb_dev->status);
392 /* if our try counter reaches 0, bail out */
393 USB_STOR_PRINTF(" %ld, data %d\n",
394 us->pusb_dev->status, partial);
398 /* update to show what data was transferred */
399 this_xfer -= partial;
401 /* continue until this transfer is done */
405 /* if we get here, we're done and successful */
409 static int usb_stor_BBB_reset(struct us_data *us)
415 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
417 * For Reset Recovery the host shall issue in the following order:
418 * a) a Bulk-Only Mass Storage Reset
419 * b) a Clear Feature HALT to the Bulk-In endpoint
420 * c) a Clear Feature HALT to the Bulk-Out endpoint
422 * This is done in 3 steps.
424 * If the reset doesn't succeed, the device should be port reset.
426 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
428 USB_STOR_PRINTF("BBB_reset\n");
429 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
431 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
432 0, us->ifnum, 0, 0, USB_CNTL_TIMEOUT * 5);
434 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
435 USB_STOR_PRINTF("RESET:stall\n");
439 /* long wait for reset */
441 USB_STOR_PRINTF("BBB_reset result %d: status %lX reset\n", result,
442 us->pusb_dev->status);
443 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
444 result = usb_clear_halt(us->pusb_dev, pipe);
445 /* long wait for reset */
447 USB_STOR_PRINTF("BBB_reset result %d: status %lX clearing IN endpoint\n",
448 result, us->pusb_dev->status);
449 /* long wait for reset */
450 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
451 result = usb_clear_halt(us->pusb_dev, pipe);
453 USB_STOR_PRINTF("BBB_reset result %d: status %lX"
454 " clearing OUT endpoint\n", result,
455 us->pusb_dev->status);
456 USB_STOR_PRINTF("BBB_reset done\n");
460 /* FIXME: this reset function doesn't really reset the port, and it
461 * should. Actually it should probably do what it's doing here, and
462 * reset the port physically
464 static int usb_stor_CB_reset(struct us_data *us)
466 unsigned char cmd[12];
469 USB_STOR_PRINTF("CB_reset\n");
470 memset(cmd, 0xff, sizeof(cmd));
471 cmd[0] = SCSI_SEND_DIAG;
473 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
475 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
476 0, us->ifnum, cmd, sizeof(cmd),
477 USB_CNTL_TIMEOUT * 5);
479 /* long wait for reset */
481 USB_STOR_PRINTF("CB_reset result %d: status %lX"
482 " clearing endpoint halt\n", result,
483 us->pusb_dev->status);
484 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
485 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
487 USB_STOR_PRINTF("CB_reset done\n");
492 * Set up the command for a BBB device. Note that the actual SCSI
493 * command is copied into cbw.CBWCDB.
495 int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
503 dir_in = US_DIRECTION(srb->cmd[0]);
505 #ifdef BBB_COMDAT_TRACE
506 printf("dir %d lun %d cmdlen %d cmd %p datalen %d pdata %p\n",
507 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
510 for (result = 0; result < srb->cmdlen; result++)
511 printf("cmd[%d] %#x ", result, srb->cmd[result]);
516 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
517 USB_STOR_PRINTF("usb_stor_BBB_comdat:cmdlen too large\n");
521 /* always OUT to the ep */
522 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
524 cbw.dCBWSignature = cpu_to_le32(CBWSIGNATURE);
525 cbw.dCBWTag = cpu_to_le32(CBWTag++);
526 cbw.dCBWDataTransferLength = cpu_to_le32(srb->datalen);
527 cbw.bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
528 cbw.bCBWLUN = srb->lun;
529 cbw.bCDBLength = srb->cmdlen;
530 /* copy the command data into the CBW command data buffer */
532 memcpy(cbw.CBWCDB, srb->cmd, srb->cmdlen);
533 result = usb_bulk_msg(us->pusb_dev, pipe, &cbw, UMASS_BBB_CBW_SIZE,
534 &actlen, USB_CNTL_TIMEOUT * 5);
536 USB_STOR_PRINTF("usb_stor_BBB_comdat:usb_bulk_msg error\n");
540 /* FIXME: we also need a CBI_command which sets up the completion
541 * interrupt, and waits for it
543 int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
548 unsigned long status;
551 dir_in = US_DIRECTION(srb->cmd[0]);
554 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
556 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
559 USB_STOR_PRINTF("CBI gets a command: Try %d\n", 5 - retry);
560 #ifdef USB_STOR_DEBUG
563 /* let's send the command via the control pipe */
564 result = usb_control_msg(us->pusb_dev,
565 usb_sndctrlpipe(us->pusb_dev , 0),
567 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
569 srb->cmd, srb->cmdlen,
570 USB_CNTL_TIMEOUT * 5);
571 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
572 " status %lX\n", result, us->pusb_dev->status);
573 /* check the return code for the command */
575 if (us->pusb_dev->status & USB_ST_STALLED) {
576 status = us->pusb_dev->status;
577 USB_STOR_PRINTF(" stall during command found,"
579 usb_clear_halt(us->pusb_dev,
580 usb_sndctrlpipe(us->pusb_dev, 0));
581 us->pusb_dev->status = status;
583 USB_STOR_PRINTF(" error during command %02X"
584 " Stat = %lX\n", srb->cmd[0],
585 us->pusb_dev->status);
588 /* transfer the data payload for this command, if one exists*/
590 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
591 " direction is %s to go 0x%lx\n", result,
592 dir_in ? "IN" : "OUT", srb->datalen);
594 result = us_one_transfer(us, pipe, (char *)srb->pdata,
596 USB_STOR_PRINTF("CBI attempted to transfer data,"
597 " result is %d status %lX, len %d\n",
598 result, us->pusb_dev->status,
599 us->pusb_dev->act_len);
600 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
602 } /* if (srb->datalen) */
612 int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
617 submit_int_msg(us->pusb_dev, us->irqpipe,
618 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
621 if ((volatile int *) us->ip_wanted == 0)
626 printf(" Did not get interrupt on CBI\n");
628 return USB_STOR_TRANSPORT_ERROR;
631 ("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 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, 0, 0, USB_CNTL_TIMEOUT * 5);
671 int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
675 int actlen, data_actlen;
676 unsigned int pipe, pipein, pipeout;
678 #ifdef BBB_XPORT_TRACE
683 dir_in = US_DIRECTION(srb->cmd[0]);
686 USB_STOR_PRINTF("COMMAND phase\n");
687 result = usb_stor_BBB_comdat(srb, us);
689 USB_STOR_PRINTF("failed to send CBW status %ld\n",
690 us->pusb_dev->status);
691 usb_stor_BBB_reset(us);
692 return USB_STOR_TRANSPORT_FAILED;
695 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
696 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
697 /* DATA phase + error handling */
699 /* no data, go immediately to the STATUS phase */
700 if (srb->datalen == 0)
702 USB_STOR_PRINTF("DATA phase\n");
707 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
708 &data_actlen, USB_CNTL_TIMEOUT * 5);
709 /* special handling of STALL in DATA phase */
710 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
711 USB_STOR_PRINTF("DATA:stall\n");
712 /* clear the STALL on the endpoint */
713 result = usb_stor_BBB_clear_endpt_stall(us,
714 dir_in ? us->ep_in : us->ep_out);
716 /* continue on to STATUS phase */
720 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
721 us->pusb_dev->status);
722 usb_stor_BBB_reset(us);
723 return USB_STOR_TRANSPORT_FAILED;
725 #ifdef BBB_XPORT_TRACE
726 for (index = 0; index < data_actlen; index++)
727 printf("pdata[%d] %#x ", index, srb->pdata[index]);
730 /* STATUS phase + error handling */
734 USB_STOR_PRINTF("STATUS phase\n");
735 result = usb_bulk_msg(us->pusb_dev, pipein, &csw, UMASS_BBB_CSW_SIZE,
736 &actlen, USB_CNTL_TIMEOUT*5);
738 /* special handling of STALL in STATUS phase */
739 if ((result < 0) && (retry < 1) &&
740 (us->pusb_dev->status & USB_ST_STALLED)) {
741 USB_STOR_PRINTF("STATUS:stall\n");
742 /* clear the STALL on the endpoint */
743 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
744 if (result >= 0 && (retry++ < 1))
749 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
750 us->pusb_dev->status);
751 usb_stor_BBB_reset(us);
752 return USB_STOR_TRANSPORT_FAILED;
754 #ifdef BBB_XPORT_TRACE
755 ptr = (unsigned char *)&csw;
756 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
757 printf("ptr[%d] %#x ", index, ptr[index]);
760 /* misuse pipe to get the residue */
761 pipe = le32_to_cpu(csw.dCSWDataResidue);
762 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
763 pipe = srb->datalen - data_actlen;
764 if (CSWSIGNATURE != le32_to_cpu(csw.dCSWSignature)) {
765 USB_STOR_PRINTF("!CSWSIGNATURE\n");
766 usb_stor_BBB_reset(us);
767 return USB_STOR_TRANSPORT_FAILED;
768 } else if ((CBWTag - 1) != le32_to_cpu(csw.dCSWTag)) {
769 USB_STOR_PRINTF("!Tag\n");
770 usb_stor_BBB_reset(us);
771 return USB_STOR_TRANSPORT_FAILED;
772 } else if (csw.bCSWStatus > CSWSTATUS_PHASE) {
773 USB_STOR_PRINTF(">PHASE\n");
774 usb_stor_BBB_reset(us);
775 return USB_STOR_TRANSPORT_FAILED;
776 } else if (csw.bCSWStatus == CSWSTATUS_PHASE) {
777 USB_STOR_PRINTF("=PHASE\n");
778 usb_stor_BBB_reset(us);
779 return USB_STOR_TRANSPORT_FAILED;
780 } else if (data_actlen > srb->datalen) {
781 USB_STOR_PRINTF("transferred %dB instead of %ldB\n",
782 data_actlen, srb->datalen);
783 return USB_STOR_TRANSPORT_FAILED;
784 } else if (csw.bCSWStatus == CSWSTATUS_FAILED) {
785 USB_STOR_PRINTF("FAILED\n");
786 return USB_STOR_TRANSPORT_FAILED;
792 int usb_stor_CB_transport(ccb *srb, struct us_data *us)
800 status = USB_STOR_TRANSPORT_GOOD;
803 /* issue the command */
805 result = usb_stor_CB_comdat(srb, us);
806 USB_STOR_PRINTF("command / Data returned %d, status %lX\n",
807 result, us->pusb_dev->status);
808 /* if this is an CBI Protocol, get IRQ */
809 if (us->protocol == US_PR_CBI) {
810 status = usb_stor_CBI_get_status(srb, us);
811 /* if the status is error, report it */
812 if (status == USB_STOR_TRANSPORT_ERROR) {
813 USB_STOR_PRINTF(" USB CBI Command Error\n");
816 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
817 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
819 /* if the status is good, report it */
820 if (status == USB_STOR_TRANSPORT_GOOD) {
821 USB_STOR_PRINTF(" USB CBI Command Good\n");
826 /* do we have to issue an auto request? */
827 /* HERE we have to check the result */
828 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
829 USB_STOR_PRINTF("ERROR %lX\n", us->pusb_dev->status);
830 us->transport_reset(us);
831 return USB_STOR_TRANSPORT_ERROR;
833 if ((us->protocol == US_PR_CBI) &&
834 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
835 (srb->cmd[0] == SCSI_INQUIRY))) {
836 /* do not issue an autorequest after request sense */
837 USB_STOR_PRINTF("No auto request and good\n");
838 return USB_STOR_TRANSPORT_GOOD;
840 /* issue an request_sense */
841 memset(&psrb->cmd[0], 0, 12);
842 psrb->cmd[0] = SCSI_REQ_SENSE;
843 psrb->cmd[1] = srb->lun << 5;
846 psrb->pdata = &srb->sense_buf[0];
848 /* issue the command */
849 result = usb_stor_CB_comdat(psrb, us);
850 USB_STOR_PRINTF("auto request returned %d\n", result);
851 /* if this is an CBI Protocol, get IRQ */
852 if (us->protocol == US_PR_CBI)
853 status = usb_stor_CBI_get_status(psrb, us);
855 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
856 USB_STOR_PRINTF(" AUTO REQUEST ERROR %ld\n",
857 us->pusb_dev->status);
858 return USB_STOR_TRANSPORT_ERROR;
860 USB_STOR_PRINTF("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
861 srb->sense_buf[0], srb->sense_buf[2],
862 srb->sense_buf[12], srb->sense_buf[13]);
863 /* Check the auto request result */
864 if ((srb->sense_buf[2] == 0) &&
865 (srb->sense_buf[12] == 0) &&
866 (srb->sense_buf[13] == 0)) {
868 return USB_STOR_TRANSPORT_GOOD;
871 /* Check the auto request result */
872 switch (srb->sense_buf[2]) {
874 /* Recovered Error */
875 return USB_STOR_TRANSPORT_GOOD;
879 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
880 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
881 " 0x%02X (NOT READY)\n", srb->cmd[0],
882 srb->sense_buf[0], srb->sense_buf[2],
883 srb->sense_buf[12], srb->sense_buf[13]);
884 return USB_STOR_TRANSPORT_FAILED;
891 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
892 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
893 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
894 srb->sense_buf[2], srb->sense_buf[12],
896 return USB_STOR_TRANSPORT_FAILED;
901 return USB_STOR_TRANSPORT_FAILED;
905 static int usb_inquiry(ccb *srb, struct us_data *ss)
910 memset(&srb->cmd[0], 0, 12);
911 srb->cmd[0] = SCSI_INQUIRY;
912 srb->cmd[1] = srb->lun << 5;
916 i = ss->transport(srb, ss);
917 USB_STOR_PRINTF("inquiry returns %d\n", i);
923 printf("error in inquiry\n");
929 static int usb_request_sense(ccb *srb, struct us_data *ss)
933 ptr = (char *)srb->pdata;
934 memset(&srb->cmd[0], 0, 12);
935 srb->cmd[0] = SCSI_REQ_SENSE;
936 srb->cmd[1] = srb->lun << 5;
939 srb->pdata = &srb->sense_buf[0];
941 ss->transport(srb, ss);
942 USB_STOR_PRINTF("Request Sense returned %02X %02X %02X\n",
943 srb->sense_buf[2], srb->sense_buf[12],
945 srb->pdata = (uchar *)ptr;
949 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
954 memset(&srb->cmd[0], 0, 12);
955 srb->cmd[0] = SCSI_TST_U_RDY;
956 srb->cmd[1] = srb->lun << 5;
959 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
961 usb_request_sense(srb, ss);
968 static int usb_read_capacity(ccb *srb, struct us_data *ss)
974 memset(&srb->cmd[0], 0, 12);
975 srb->cmd[0] = SCSI_RD_CAPAC;
976 srb->cmd[1] = srb->lun << 5;
979 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
986 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
987 unsigned short blocks)
989 memset(&srb->cmd[0], 0, 12);
990 srb->cmd[0] = SCSI_READ10;
991 srb->cmd[1] = srb->lun << 5;
992 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
993 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
994 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
995 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
996 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
997 srb->cmd[8] = (unsigned char) blocks & 0xff;
999 USB_STOR_PRINTF("read10: start %lx blocks %x\n", start, blocks);
1000 return ss->transport(srb, ss);
1003 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
1004 unsigned short blocks)
1006 memset(&srb->cmd[0], 0, 12);
1007 srb->cmd[0] = SCSI_WRITE10;
1008 srb->cmd[1] = srb->lun << 5;
1009 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1010 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1011 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1012 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1013 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1014 srb->cmd[8] = (unsigned char) blocks & 0xff;
1016 USB_STOR_PRINTF("write10: start %lx blocks %x\n", start, blocks);
1017 return ss->transport(srb, ss);
1021 #ifdef CONFIG_USB_BIN_FIXUP
1023 * Some USB storage devices queried for SCSI identification data respond with
1024 * binary strings, which if output to the console freeze the terminal. The
1025 * workaround is to modify the vendor and product strings read from such
1026 * device with proper values (as reported by 'usb info').
1028 * Vendor and product length limits are taken from the definition of
1029 * block_dev_desc_t in include/part.h.
1031 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1032 unsigned char vendor[],
1033 unsigned char product[]) {
1034 const unsigned char max_vendor_len = 40;
1035 const unsigned char max_product_len = 20;
1036 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1037 strncpy((char *)vendor, "SMSC", max_vendor_len);
1038 strncpy((char *)product, "Flash Media Cntrller",
1042 #endif /* CONFIG_USB_BIN_FIXUP */
1044 #define USB_MAX_READ_BLK 20
1046 unsigned long usb_stor_read(int device, unsigned long blknr,
1047 unsigned long blkcnt, void *buffer)
1049 unsigned long start, blks, buf_addr;
1050 unsigned short smallblks;
1051 struct usb_device *dev;
1053 ccb *srb = &usb_ccb;
1060 USB_STOR_PRINTF("\nusb_read: dev %d \n", device);
1062 for (i = 0; i < USB_MAX_DEVICE; i++) {
1063 dev = usb_get_dev_index(i);
1066 if (dev->devnum == usb_dev_desc[device].target)
1070 usb_disable_asynch(1); /* asynch transfer not allowed */
1071 srb->lun = usb_dev_desc[device].lun;
1072 buf_addr = (unsigned long)buffer;
1075 if (usb_test_unit_ready(srb, (struct us_data *)dev->privptr)) {
1076 printf("Device NOT ready\n Request Sense returned %02X %02X"
1077 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1078 srb->sense_buf[13]);
1082 USB_STOR_PRINTF("\nusb_read: dev %d startblk %lx, blccnt %lx"
1083 " buffer %lx\n", device, start, blks, buf_addr);
1086 /* XXX need some comment here */
1088 srb->pdata = (unsigned char *)buf_addr;
1089 if (blks > USB_MAX_READ_BLK)
1090 smallblks = USB_MAX_READ_BLK;
1092 smallblks = (unsigned short) blks;
1094 if (smallblks == USB_MAX_READ_BLK)
1095 usb_show_progress();
1096 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1097 srb->pdata = (unsigned char *)buf_addr;
1098 if (usb_read_10(srb, (struct us_data *)dev->privptr, start,
1100 USB_STOR_PRINTF("Read ERROR\n");
1101 usb_request_sense(srb, (struct us_data *)dev->privptr);
1109 buf_addr += srb->datalen;
1110 } while (blks != 0);
1112 USB_STOR_PRINTF("usb_read: end startblk %lx, blccnt %x buffer %lx\n",
1113 start, smallblks, buf_addr);
1115 usb_disable_asynch(0); /* asynch transfer allowed */
1116 if (blkcnt >= USB_MAX_READ_BLK)
1121 #define USB_MAX_WRITE_BLK 20
1123 unsigned long usb_stor_write(int device, unsigned long blknr,
1124 unsigned long blkcnt, const void *buffer)
1126 unsigned long start, blks, buf_addr;
1127 unsigned short smallblks;
1128 struct usb_device *dev;
1130 ccb *srb = &usb_ccb;
1137 USB_STOR_PRINTF("\nusb_write: dev %d \n", device);
1139 for (i = 0; i < USB_MAX_DEVICE; i++) {
1140 dev = usb_get_dev_index(i);
1143 if (dev->devnum == usb_dev_desc[device].target)
1147 usb_disable_asynch(1); /* asynch transfer not allowed */
1149 srb->lun = usb_dev_desc[device].lun;
1150 buf_addr = (unsigned long)buffer;
1153 if (usb_test_unit_ready(srb, (struct us_data *)dev->privptr)) {
1154 printf("Device NOT ready\n Request Sense returned %02X %02X"
1155 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1156 srb->sense_buf[13]);
1160 USB_STOR_PRINTF("\nusb_write: dev %d startblk %lx, blccnt %lx"
1161 " buffer %lx\n", device, start, blks, buf_addr);
1164 /* If write fails retry for max retry count else
1165 * return with number of blocks written successfully.
1168 srb->pdata = (unsigned char *)buf_addr;
1169 if (blks > USB_MAX_WRITE_BLK)
1170 smallblks = USB_MAX_WRITE_BLK;
1172 smallblks = (unsigned short) blks;
1174 if (smallblks == USB_MAX_WRITE_BLK)
1175 usb_show_progress();
1176 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1177 srb->pdata = (unsigned char *)buf_addr;
1178 if (usb_write_10(srb, (struct us_data *)dev->privptr, start,
1180 USB_STOR_PRINTF("Write ERROR\n");
1181 usb_request_sense(srb, (struct us_data *)dev->privptr);
1189 buf_addr += srb->datalen;
1190 } while (blks != 0);
1192 USB_STOR_PRINTF("usb_write: end startblk %lx, blccnt %x buffer %lx\n",
1193 start, smallblks, buf_addr);
1195 usb_disable_asynch(0); /* asynch transfer allowed */
1196 if (blkcnt >= USB_MAX_WRITE_BLK)
1202 /* Probe to see if a new device is actually a Storage device */
1203 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1206 struct usb_interface *iface;
1208 unsigned int flags = 0;
1213 /* let's examine the device now */
1214 iface = &dev->config.if_desc[ifnum];
1217 /* this is the place to patch some storage devices */
1218 USB_STOR_PRINTF("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1219 dev->descriptor.idProduct);
1221 if ((dev->descriptor.idVendor) == 0x066b &&
1222 (dev->descriptor.idProduct) == 0x0103) {
1223 USB_STOR_PRINTF("patched for E-USB\n");
1224 protocol = US_PR_CB;
1225 subclass = US_SC_UFI; /* an assumption */
1229 if (dev->descriptor.bDeviceClass != 0 ||
1230 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1231 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1232 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1233 /* if it's not a mass storage, we go no further */
1237 memset(ss, 0, sizeof(struct us_data));
1239 /* At this point, we know we've got a live one */
1240 USB_STOR_PRINTF("\n\nUSB Mass Storage device detected\n");
1242 /* Initialize the us_data structure with some useful info */
1246 ss->attention_done = 0;
1248 /* If the device has subclass and protocol, then use that. Otherwise,
1249 * take data from the specific interface.
1252 ss->subclass = subclass;
1253 ss->protocol = protocol;
1255 ss->subclass = iface->desc.bInterfaceSubClass;
1256 ss->protocol = iface->desc.bInterfaceProtocol;
1259 /* set the handler pointers based on the protocol */
1260 USB_STOR_PRINTF("Transport: ");
1261 switch (ss->protocol) {
1263 USB_STOR_PRINTF("Control/Bulk\n");
1264 ss->transport = usb_stor_CB_transport;
1265 ss->transport_reset = usb_stor_CB_reset;
1269 USB_STOR_PRINTF("Control/Bulk/Interrupt\n");
1270 ss->transport = usb_stor_CB_transport;
1271 ss->transport_reset = usb_stor_CB_reset;
1274 USB_STOR_PRINTF("Bulk/Bulk/Bulk\n");
1275 ss->transport = usb_stor_BBB_transport;
1276 ss->transport_reset = usb_stor_BBB_reset;
1279 printf("USB Storage Transport unknown / not yet implemented\n");
1285 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1286 * An optional interrupt is OK (necessary for CBI protocol).
1287 * We will ignore any others.
1289 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1290 /* is it an BULK endpoint? */
1291 if ((iface->ep_desc[i].bmAttributes &
1292 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1293 if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
1294 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
1295 USB_ENDPOINT_NUMBER_MASK;
1298 iface->ep_desc[i].bEndpointAddress &
1299 USB_ENDPOINT_NUMBER_MASK;
1302 /* is it an interrupt endpoint? */
1303 if ((iface->ep_desc[i].bmAttributes &
1304 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1305 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
1306 USB_ENDPOINT_NUMBER_MASK;
1307 ss->irqinterval = iface->ep_desc[i].bInterval;
1310 USB_STOR_PRINTF("Endpoints In %d Out %d Int %d\n",
1311 ss->ep_in, ss->ep_out, ss->ep_int);
1313 /* Do some basic sanity checks, and bail if we find a problem */
1314 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1315 !ss->ep_in || !ss->ep_out ||
1316 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1317 USB_STOR_PRINTF("Problems with device\n");
1320 /* set class specific stuff */
1321 /* We only handle certain protocols. Currently, these are
1323 * The SFF8070 accepts the requests used in u-boot
1325 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1326 ss->subclass != US_SC_8070) {
1327 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1331 /* we had found an interrupt endpoint, prepare irq pipe
1332 * set up the IRQ pipe and handler
1334 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1335 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1336 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1337 dev->irq_handle = usb_stor_irq;
1339 dev->privptr = (void *)ss;
1343 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1344 block_dev_desc_t *dev_desc)
1346 unsigned char perq, modi;
1347 unsigned long cap[2];
1348 unsigned long *capacity, *blksz;
1349 ccb *pccb = &usb_ccb;
1351 pccb->pdata = usb_stor_buf;
1353 dev_desc->target = dev->devnum;
1354 pccb->lun = dev_desc->lun;
1355 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1357 if (usb_inquiry(pccb, ss))
1360 perq = usb_stor_buf[0];
1361 modi = usb_stor_buf[1];
1363 if ((perq & 0x1f) == 0x1f) {
1364 /* skip unknown devices */
1367 if ((modi&0x80) == 0x80) {
1368 /* drive is removable */
1369 dev_desc->removable = 1;
1371 memcpy(&dev_desc->vendor[0], &usb_stor_buf[8], 8);
1372 memcpy(&dev_desc->product[0], &usb_stor_buf[16], 16);
1373 memcpy(&dev_desc->revision[0], &usb_stor_buf[32], 4);
1374 dev_desc->vendor[8] = 0;
1375 dev_desc->product[16] = 0;
1376 dev_desc->revision[4] = 0;
1377 #ifdef CONFIG_USB_BIN_FIXUP
1378 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1379 (uchar *)dev_desc->product);
1380 #endif /* CONFIG_USB_BIN_FIXUP */
1381 USB_STOR_PRINTF("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1383 if (usb_test_unit_ready(pccb, ss)) {
1384 printf("Device NOT ready\n"
1385 " Request Sense returned %02X %02X %02X\n",
1386 pccb->sense_buf[2], pccb->sense_buf[12],
1387 pccb->sense_buf[13]);
1388 if (dev_desc->removable == 1) {
1389 dev_desc->type = perq;
1394 pccb->pdata = (unsigned char *)&cap[0];
1395 memset(pccb->pdata, 0, 8);
1396 if (usb_read_capacity(pccb, ss) != 0) {
1397 printf("READ_CAP ERROR\n");
1401 USB_STOR_PRINTF("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0],
1404 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1407 cap[0] = cpu_to_be32(cap[0]);
1408 cap[1] = cpu_to_be32(cap[1]);
1410 /* this assumes bigendian! */
1414 USB_STOR_PRINTF("Capacity = 0x%lx, blocksz = 0x%lx\n",
1416 dev_desc->lba = *capacity;
1417 dev_desc->blksz = *blksz;
1418 dev_desc->type = perq;
1419 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1420 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1422 init_part(dev_desc);
1424 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);