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 ccb usb_ccb __attribute__((aligned(ARCH_DMA_MINALIGN)));
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 */
159 * The U-Boot EHCI driver cannot handle more than 5 page aligned buffers
160 * of 4096 bytes in a transfer without running itself out of qt_buffers
162 #define USB_MAX_XFER_BLK(start, blksz) (((4096 * 5) - (start % 4096)) / blksz)
164 static struct us_data usb_stor[USB_MAX_STOR_DEV];
167 #define USB_STOR_TRANSPORT_GOOD 0
168 #define USB_STOR_TRANSPORT_FAILED -1
169 #define USB_STOR_TRANSPORT_ERROR -2
171 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
172 block_dev_desc_t *dev_desc);
173 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
175 unsigned long usb_stor_read(int device, unsigned long blknr,
176 unsigned long blkcnt, void *buffer);
177 unsigned long usb_stor_write(int device, unsigned long blknr,
178 unsigned long blkcnt, const void *buffer);
179 struct usb_device * usb_get_dev_index(int index);
180 void uhci_show_temp_int_td(void);
182 #ifdef CONFIG_PARTITIONS
183 block_dev_desc_t *usb_stor_get_dev(int index)
185 return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
189 void usb_show_progress(void)
194 /*******************************************************************************
195 * show info on storage devices; 'usb start/init' must be invoked earlier
196 * as we only retrieve structures populated during devices initialization
198 int usb_stor_info(void)
202 if (usb_max_devs > 0) {
203 for (i = 0; i < usb_max_devs; i++) {
204 printf(" Device %d: ", i);
205 dev_print(&usb_dev_desc[i]);
210 printf("No storage devices, perhaps not 'usb start'ed..?\n");
214 static unsigned int usb_get_max_lun(struct us_data *us)
217 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, result, 1);
218 len = usb_control_msg(us->pusb_dev,
219 usb_rcvctrlpipe(us->pusb_dev, 0),
221 USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
223 result, sizeof(char),
224 USB_CNTL_TIMEOUT * 5);
225 USB_STOR_PRINTF("Get Max LUN -> len = %i, result = %i\n",
227 return (len > 0) ? *result : 0;
230 /*******************************************************************************
231 * scan the usb and reports device info
232 * to the user if mode = 1
233 * returns current device or -1 if no
235 int usb_stor_scan(int mode)
238 struct usb_device *dev;
241 printf(" scanning bus for storage devices... ");
243 usb_disable_asynch(1); /* asynch transfer not allowed */
245 for (i = 0; i < USB_MAX_STOR_DEV; i++) {
246 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
247 usb_dev_desc[i].if_type = IF_TYPE_USB;
248 usb_dev_desc[i].dev = i;
249 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
250 usb_dev_desc[i].target = 0xff;
251 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
252 usb_dev_desc[i].block_read = usb_stor_read;
253 usb_dev_desc[i].block_write = usb_stor_write;
257 for (i = 0; i < USB_MAX_DEVICE; i++) {
258 dev = usb_get_dev_index(i); /* get device */
259 USB_STOR_PRINTF("i=%d\n", i);
261 break; /* no more devices available */
263 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
264 /* OK, it's a storage device. Iterate over its LUNs
265 * and populate `usb_dev_desc'.
267 int lun, max_lun, start = usb_max_devs;
269 max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
271 lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
273 usb_dev_desc[usb_max_devs].lun = lun;
274 if (usb_stor_get_info(dev, &usb_stor[start],
275 &usb_dev_desc[usb_max_devs]) == 1) {
280 /* if storage device */
281 if (usb_max_devs == USB_MAX_STOR_DEV) {
282 printf("max USB Storage Device reached: %d stopping\n",
288 usb_disable_asynch(0); /* asynch transfer allowed */
289 printf("%d Storage Device(s) found\n", usb_max_devs);
290 if (usb_max_devs > 0)
295 static int usb_stor_irq(struct usb_device *dev)
298 us = (struct us_data *)dev->privptr;
306 #ifdef USB_STOR_DEBUG
308 static void usb_show_srb(ccb *pccb)
311 printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
312 for (i = 0; i < 12; i++)
313 printf("%02X ", pccb->cmd[i]);
317 static void display_int_status(unsigned long tmp)
319 printf("Status: %s %s %s %s %s %s %s\n",
320 (tmp & USB_ST_ACTIVE) ? "Active" : "",
321 (tmp & USB_ST_STALLED) ? "Stalled" : "",
322 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
323 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
324 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
325 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
326 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
329 /***********************************************************************
330 * Data transfer routines
331 ***********************************************************************/
333 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
342 /* determine the maximum packet size for these transfers */
343 max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
345 /* while we have data left to transfer */
348 /* calculate how long this will be -- maximum or a remainder */
349 this_xfer = length > max_size ? max_size : length;
352 /* setup the retry counter */
355 /* set up the transfer loop */
357 /* transfer the data */
358 USB_STOR_PRINTF("Bulk xfer 0x%x(%d) try #%d\n",
359 (unsigned int)buf, this_xfer, 11 - maxtry);
360 result = usb_bulk_msg(us->pusb_dev, pipe, buf,
362 USB_CNTL_TIMEOUT * 5);
363 USB_STOR_PRINTF("bulk_msg returned %d xferred %d/%d\n",
364 result, partial, this_xfer);
365 if (us->pusb_dev->status != 0) {
366 /* if we stall, we need to clear it before
369 #ifdef USB_STOR_DEBUG
370 display_int_status(us->pusb_dev->status);
372 if (us->pusb_dev->status & USB_ST_STALLED) {
373 USB_STOR_PRINTF("stalled ->clearing endpoint halt for pipe 0x%x\n", pipe);
374 stat = us->pusb_dev->status;
375 usb_clear_halt(us->pusb_dev, pipe);
376 us->pusb_dev->status = stat;
377 if (this_xfer == partial) {
378 USB_STOR_PRINTF("bulk transferred with error %lX, but data ok\n", us->pusb_dev->status);
384 if (us->pusb_dev->status & USB_ST_NAK_REC) {
385 USB_STOR_PRINTF("Device NAKed bulk_msg\n");
388 USB_STOR_PRINTF("bulk transferred with error");
389 if (this_xfer == partial) {
390 USB_STOR_PRINTF(" %ld, but data ok\n",
391 us->pusb_dev->status);
394 /* if our try counter reaches 0, bail out */
395 USB_STOR_PRINTF(" %ld, data %d\n",
396 us->pusb_dev->status, partial);
400 /* update to show what data was transferred */
401 this_xfer -= partial;
403 /* continue until this transfer is done */
407 /* if we get here, we're done and successful */
411 static int usb_stor_BBB_reset(struct us_data *us)
417 * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
419 * For Reset Recovery the host shall issue in the following order:
420 * a) a Bulk-Only Mass Storage Reset
421 * b) a Clear Feature HALT to the Bulk-In endpoint
422 * c) a Clear Feature HALT to the Bulk-Out endpoint
424 * This is done in 3 steps.
426 * If the reset doesn't succeed, the device should be port reset.
428 * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
430 USB_STOR_PRINTF("BBB_reset\n");
431 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
433 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
434 0, us->ifnum, 0, 0, USB_CNTL_TIMEOUT * 5);
436 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
437 USB_STOR_PRINTF("RESET:stall\n");
441 /* long wait for reset */
443 USB_STOR_PRINTF("BBB_reset result %d: status %lX reset\n", result,
444 us->pusb_dev->status);
445 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
446 result = usb_clear_halt(us->pusb_dev, pipe);
447 /* long wait for reset */
449 USB_STOR_PRINTF("BBB_reset result %d: status %lX clearing IN endpoint\n",
450 result, us->pusb_dev->status);
451 /* long wait for reset */
452 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
453 result = usb_clear_halt(us->pusb_dev, pipe);
455 USB_STOR_PRINTF("BBB_reset result %d: status %lX"
456 " clearing OUT endpoint\n", result,
457 us->pusb_dev->status);
458 USB_STOR_PRINTF("BBB_reset done\n");
462 /* FIXME: this reset function doesn't really reset the port, and it
463 * should. Actually it should probably do what it's doing here, and
464 * reset the port physically
466 static int usb_stor_CB_reset(struct us_data *us)
468 unsigned char cmd[12];
471 USB_STOR_PRINTF("CB_reset\n");
472 memset(cmd, 0xff, sizeof(cmd));
473 cmd[0] = SCSI_SEND_DIAG;
475 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
477 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
478 0, us->ifnum, cmd, sizeof(cmd),
479 USB_CNTL_TIMEOUT * 5);
481 /* long wait for reset */
483 USB_STOR_PRINTF("CB_reset result %d: status %lX"
484 " clearing endpoint halt\n", result,
485 us->pusb_dev->status);
486 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
487 usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
489 USB_STOR_PRINTF("CB_reset done\n");
494 * Set up the command for a BBB device. Note that the actual SCSI
495 * command is copied into cbw.CBWCDB.
497 int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
503 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_cbw_t, cbw, 1);
505 dir_in = US_DIRECTION(srb->cmd[0]);
507 #ifdef BBB_COMDAT_TRACE
508 printf("dir %d lun %d cmdlen %d cmd %p datalen %d pdata %p\n",
509 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
512 for (result = 0; result < srb->cmdlen; result++)
513 printf("cmd[%d] %#x ", result, srb->cmd[result]);
518 if (!(srb->cmdlen <= CBWCDBLENGTH)) {
519 USB_STOR_PRINTF("usb_stor_BBB_comdat:cmdlen too large\n");
523 /* always OUT to the ep */
524 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
526 cbw->dCBWSignature = cpu_to_le32(CBWSIGNATURE);
527 cbw->dCBWTag = cpu_to_le32(CBWTag++);
528 cbw->dCBWDataTransferLength = cpu_to_le32(srb->datalen);
529 cbw->bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
530 cbw->bCBWLUN = srb->lun;
531 cbw->bCDBLength = srb->cmdlen;
532 /* copy the command data into the CBW command data buffer */
534 memcpy(cbw->CBWCDB, srb->cmd, srb->cmdlen);
535 result = usb_bulk_msg(us->pusb_dev, pipe, cbw, UMASS_BBB_CBW_SIZE,
536 &actlen, USB_CNTL_TIMEOUT * 5);
538 USB_STOR_PRINTF("usb_stor_BBB_comdat:usb_bulk_msg error\n");
542 /* FIXME: we also need a CBI_command which sets up the completion
543 * interrupt, and waits for it
545 int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
550 unsigned long status;
553 dir_in = US_DIRECTION(srb->cmd[0]);
556 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
558 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
561 USB_STOR_PRINTF("CBI gets a command: Try %d\n", 5 - retry);
562 #ifdef USB_STOR_DEBUG
565 /* let's send the command via the control pipe */
566 result = usb_control_msg(us->pusb_dev,
567 usb_sndctrlpipe(us->pusb_dev , 0),
569 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
571 srb->cmd, srb->cmdlen,
572 USB_CNTL_TIMEOUT * 5);
573 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
574 " status %lX\n", result, us->pusb_dev->status);
575 /* check the return code for the command */
577 if (us->pusb_dev->status & USB_ST_STALLED) {
578 status = us->pusb_dev->status;
579 USB_STOR_PRINTF(" stall during command found,"
581 usb_clear_halt(us->pusb_dev,
582 usb_sndctrlpipe(us->pusb_dev, 0));
583 us->pusb_dev->status = status;
585 USB_STOR_PRINTF(" error during command %02X"
586 " Stat = %lX\n", srb->cmd[0],
587 us->pusb_dev->status);
590 /* transfer the data payload for this command, if one exists*/
592 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
593 " direction is %s to go 0x%lx\n", result,
594 dir_in ? "IN" : "OUT", srb->datalen);
596 result = us_one_transfer(us, pipe, (char *)srb->pdata,
598 USB_STOR_PRINTF("CBI attempted to transfer data,"
599 " result is %d status %lX, len %d\n",
600 result, us->pusb_dev->status,
601 us->pusb_dev->act_len);
602 if (!(us->pusb_dev->status & USB_ST_NAK_REC))
604 } /* if (srb->datalen) */
614 int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
619 submit_int_msg(us->pusb_dev, us->irqpipe,
620 (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
623 if ((volatile int *) us->ip_wanted == 0)
628 printf(" Did not get interrupt on CBI\n");
630 return USB_STOR_TRANSPORT_ERROR;
633 ("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
634 us->ip_data, us->pusb_dev->irq_act_len,
635 us->pusb_dev->irq_status);
636 /* UFI gives us ASC and ASCQ, like a request sense */
637 if (us->subclass == US_SC_UFI) {
638 if (srb->cmd[0] == SCSI_REQ_SENSE ||
639 srb->cmd[0] == SCSI_INQUIRY)
640 return USB_STOR_TRANSPORT_GOOD; /* Good */
641 else if (us->ip_data)
642 return USB_STOR_TRANSPORT_FAILED;
644 return USB_STOR_TRANSPORT_GOOD;
646 /* otherwise, we interpret the data normally */
647 switch (us->ip_data) {
649 return USB_STOR_TRANSPORT_GOOD;
651 return USB_STOR_TRANSPORT_FAILED;
653 return USB_STOR_TRANSPORT_ERROR;
655 return USB_STOR_TRANSPORT_ERROR;
658 #define USB_TRANSPORT_UNKNOWN_RETRY 5
659 #define USB_TRANSPORT_NOT_READY_RETRY 10
661 /* clear a stall on an endpoint - special for BBB devices */
662 int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
666 /* ENDPOINT_HALT = 0, so set value to 0 */
667 result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
668 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
669 0, endpt, 0, 0, USB_CNTL_TIMEOUT * 5);
673 int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
677 int actlen, data_actlen;
678 unsigned int pipe, pipein, pipeout;
679 ALLOC_CACHE_ALIGN_BUFFER(umass_bbb_csw_t, csw, 1);
680 #ifdef BBB_XPORT_TRACE
685 dir_in = US_DIRECTION(srb->cmd[0]);
688 USB_STOR_PRINTF("COMMAND phase\n");
689 result = usb_stor_BBB_comdat(srb, us);
691 USB_STOR_PRINTF("failed to send CBW status %ld\n",
692 us->pusb_dev->status);
693 usb_stor_BBB_reset(us);
694 return USB_STOR_TRANSPORT_FAILED;
697 pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
698 pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
699 /* DATA phase + error handling */
701 /* no data, go immediately to the STATUS phase */
702 if (srb->datalen == 0)
704 USB_STOR_PRINTF("DATA phase\n");
709 result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
710 &data_actlen, USB_CNTL_TIMEOUT * 5);
711 /* special handling of STALL in DATA phase */
712 if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
713 USB_STOR_PRINTF("DATA:stall\n");
714 /* clear the STALL on the endpoint */
715 result = usb_stor_BBB_clear_endpt_stall(us,
716 dir_in ? us->ep_in : us->ep_out);
718 /* continue on to STATUS phase */
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 for (index = 0; index < data_actlen; index++)
729 printf("pdata[%d] %#x ", index, srb->pdata[index]);
732 /* STATUS phase + error handling */
736 USB_STOR_PRINTF("STATUS phase\n");
737 result = usb_bulk_msg(us->pusb_dev, pipein, csw, UMASS_BBB_CSW_SIZE,
738 &actlen, USB_CNTL_TIMEOUT*5);
740 /* special handling of STALL in STATUS phase */
741 if ((result < 0) && (retry < 1) &&
742 (us->pusb_dev->status & USB_ST_STALLED)) {
743 USB_STOR_PRINTF("STATUS:stall\n");
744 /* clear the STALL on the endpoint */
745 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
746 if (result >= 0 && (retry++ < 1))
751 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
752 us->pusb_dev->status);
753 usb_stor_BBB_reset(us);
754 return USB_STOR_TRANSPORT_FAILED;
756 #ifdef BBB_XPORT_TRACE
757 ptr = (unsigned char *)csw;
758 for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
759 printf("ptr[%d] %#x ", index, ptr[index]);
762 /* misuse pipe to get the residue */
763 pipe = le32_to_cpu(csw->dCSWDataResidue);
764 if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
765 pipe = srb->datalen - data_actlen;
766 if (CSWSIGNATURE != le32_to_cpu(csw->dCSWSignature)) {
767 USB_STOR_PRINTF("!CSWSIGNATURE\n");
768 usb_stor_BBB_reset(us);
769 return USB_STOR_TRANSPORT_FAILED;
770 } else if ((CBWTag - 1) != le32_to_cpu(csw->dCSWTag)) {
771 USB_STOR_PRINTF("!Tag\n");
772 usb_stor_BBB_reset(us);
773 return USB_STOR_TRANSPORT_FAILED;
774 } else if (csw->bCSWStatus > CSWSTATUS_PHASE) {
775 USB_STOR_PRINTF(">PHASE\n");
776 usb_stor_BBB_reset(us);
777 return USB_STOR_TRANSPORT_FAILED;
778 } else if (csw->bCSWStatus == CSWSTATUS_PHASE) {
779 USB_STOR_PRINTF("=PHASE\n");
780 usb_stor_BBB_reset(us);
781 return USB_STOR_TRANSPORT_FAILED;
782 } else if (data_actlen > srb->datalen) {
783 USB_STOR_PRINTF("transferred %dB instead of %ldB\n",
784 data_actlen, srb->datalen);
785 return USB_STOR_TRANSPORT_FAILED;
786 } else if (csw->bCSWStatus == CSWSTATUS_FAILED) {
787 USB_STOR_PRINTF("FAILED\n");
788 return USB_STOR_TRANSPORT_FAILED;
794 int usb_stor_CB_transport(ccb *srb, struct us_data *us)
802 status = USB_STOR_TRANSPORT_GOOD;
805 /* issue the command */
807 result = usb_stor_CB_comdat(srb, us);
808 USB_STOR_PRINTF("command / Data returned %d, status %lX\n",
809 result, us->pusb_dev->status);
810 /* if this is an CBI Protocol, get IRQ */
811 if (us->protocol == US_PR_CBI) {
812 status = usb_stor_CBI_get_status(srb, us);
813 /* if the status is error, report it */
814 if (status == USB_STOR_TRANSPORT_ERROR) {
815 USB_STOR_PRINTF(" USB CBI Command Error\n");
818 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
819 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
821 /* if the status is good, report it */
822 if (status == USB_STOR_TRANSPORT_GOOD) {
823 USB_STOR_PRINTF(" USB CBI Command Good\n");
828 /* do we have to issue an auto request? */
829 /* HERE we have to check the result */
830 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
831 USB_STOR_PRINTF("ERROR %lX\n", us->pusb_dev->status);
832 us->transport_reset(us);
833 return USB_STOR_TRANSPORT_ERROR;
835 if ((us->protocol == US_PR_CBI) &&
836 ((srb->cmd[0] == SCSI_REQ_SENSE) ||
837 (srb->cmd[0] == SCSI_INQUIRY))) {
838 /* do not issue an autorequest after request sense */
839 USB_STOR_PRINTF("No auto request and good\n");
840 return USB_STOR_TRANSPORT_GOOD;
842 /* issue an request_sense */
843 memset(&psrb->cmd[0], 0, 12);
844 psrb->cmd[0] = SCSI_REQ_SENSE;
845 psrb->cmd[1] = srb->lun << 5;
848 psrb->pdata = &srb->sense_buf[0];
850 /* issue the command */
851 result = usb_stor_CB_comdat(psrb, us);
852 USB_STOR_PRINTF("auto request returned %d\n", result);
853 /* if this is an CBI Protocol, get IRQ */
854 if (us->protocol == US_PR_CBI)
855 status = usb_stor_CBI_get_status(psrb, us);
857 if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
858 USB_STOR_PRINTF(" AUTO REQUEST ERROR %ld\n",
859 us->pusb_dev->status);
860 return USB_STOR_TRANSPORT_ERROR;
862 USB_STOR_PRINTF("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
863 srb->sense_buf[0], srb->sense_buf[2],
864 srb->sense_buf[12], srb->sense_buf[13]);
865 /* Check the auto request result */
866 if ((srb->sense_buf[2] == 0) &&
867 (srb->sense_buf[12] == 0) &&
868 (srb->sense_buf[13] == 0)) {
870 return USB_STOR_TRANSPORT_GOOD;
873 /* Check the auto request result */
874 switch (srb->sense_buf[2]) {
876 /* Recovered Error */
877 return USB_STOR_TRANSPORT_GOOD;
881 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
882 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
883 " 0x%02X (NOT READY)\n", srb->cmd[0],
884 srb->sense_buf[0], srb->sense_buf[2],
885 srb->sense_buf[12], srb->sense_buf[13]);
886 return USB_STOR_TRANSPORT_FAILED;
893 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
894 printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
895 " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
896 srb->sense_buf[2], srb->sense_buf[12],
898 return USB_STOR_TRANSPORT_FAILED;
903 return USB_STOR_TRANSPORT_FAILED;
907 static int usb_inquiry(ccb *srb, struct us_data *ss)
912 memset(&srb->cmd[0], 0, 12);
913 srb->cmd[0] = SCSI_INQUIRY;
914 srb->cmd[1] = srb->lun << 5;
918 i = ss->transport(srb, ss);
919 USB_STOR_PRINTF("inquiry returns %d\n", i);
925 printf("error in inquiry\n");
931 static int usb_request_sense(ccb *srb, struct us_data *ss)
935 ptr = (char *)srb->pdata;
936 memset(&srb->cmd[0], 0, 12);
937 srb->cmd[0] = SCSI_REQ_SENSE;
938 srb->cmd[1] = srb->lun << 5;
941 srb->pdata = &srb->sense_buf[0];
943 ss->transport(srb, ss);
944 USB_STOR_PRINTF("Request Sense returned %02X %02X %02X\n",
945 srb->sense_buf[2], srb->sense_buf[12],
947 srb->pdata = (uchar *)ptr;
951 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
956 memset(&srb->cmd[0], 0, 12);
957 srb->cmd[0] = SCSI_TST_U_RDY;
958 srb->cmd[1] = srb->lun << 5;
961 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
963 usb_request_sense(srb, ss);
970 static int usb_read_capacity(ccb *srb, struct us_data *ss)
976 memset(&srb->cmd[0], 0, 12);
977 srb->cmd[0] = SCSI_RD_CAPAC;
978 srb->cmd[1] = srb->lun << 5;
981 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
988 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
989 unsigned short blocks)
991 memset(&srb->cmd[0], 0, 12);
992 srb->cmd[0] = SCSI_READ10;
993 srb->cmd[1] = srb->lun << 5;
994 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
995 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
996 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
997 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
998 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
999 srb->cmd[8] = (unsigned char) blocks & 0xff;
1001 USB_STOR_PRINTF("read10: start %lx blocks %x\n", start, blocks);
1002 return ss->transport(srb, ss);
1005 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
1006 unsigned short blocks)
1008 memset(&srb->cmd[0], 0, 12);
1009 srb->cmd[0] = SCSI_WRITE10;
1010 srb->cmd[1] = srb->lun << 5;
1011 srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1012 srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1013 srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1014 srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1015 srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1016 srb->cmd[8] = (unsigned char) blocks & 0xff;
1018 USB_STOR_PRINTF("write10: start %lx blocks %x\n", start, blocks);
1019 return ss->transport(srb, ss);
1023 #ifdef CONFIG_USB_BIN_FIXUP
1025 * Some USB storage devices queried for SCSI identification data respond with
1026 * binary strings, which if output to the console freeze the terminal. The
1027 * workaround is to modify the vendor and product strings read from such
1028 * device with proper values (as reported by 'usb info').
1030 * Vendor and product length limits are taken from the definition of
1031 * block_dev_desc_t in include/part.h.
1033 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1034 unsigned char vendor[],
1035 unsigned char product[]) {
1036 const unsigned char max_vendor_len = 40;
1037 const unsigned char max_product_len = 20;
1038 if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1039 strncpy((char *)vendor, "SMSC", max_vendor_len);
1040 strncpy((char *)product, "Flash Media Cntrller",
1044 #endif /* CONFIG_USB_BIN_FIXUP */
1046 unsigned long usb_stor_read(int device, unsigned long blknr,
1047 unsigned long blkcnt, void *buffer)
1049 unsigned long start, blks, buf_addr, max_xfer_blk;
1050 unsigned short smallblks;
1051 struct usb_device *dev;
1054 ccb *srb = &usb_ccb;
1061 USB_STOR_PRINTF("\nusb_read: dev %d \n", device);
1063 for (i = 0; i < USB_MAX_DEVICE; i++) {
1064 dev = usb_get_dev_index(i);
1067 if (dev->devnum == usb_dev_desc[device].target)
1070 ss = (struct us_data *)dev->privptr;
1072 usb_disable_asynch(1); /* asynch transfer not allowed */
1073 srb->lun = usb_dev_desc[device].lun;
1074 buf_addr = (unsigned long)buffer;
1077 if (usb_test_unit_ready(srb, ss)) {
1078 printf("Device NOT ready\n Request Sense returned %02X %02X"
1079 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1080 srb->sense_buf[13]);
1084 USB_STOR_PRINTF("\nusb_read: dev %d startblk %lx, blccnt %lx"
1085 " buffer %lx\n", device, start, blks, buf_addr);
1088 /* XXX need some comment here */
1090 srb->pdata = (unsigned char *)buf_addr;
1091 max_xfer_blk = USB_MAX_XFER_BLK(buf_addr,
1092 usb_dev_desc[device].blksz);
1093 if (blks > max_xfer_blk)
1094 smallblks = (unsigned short) max_xfer_blk;
1096 smallblks = (unsigned short) blks;
1098 if (smallblks == max_xfer_blk)
1099 usb_show_progress();
1100 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1101 srb->pdata = (unsigned char *)buf_addr;
1102 if (usb_read_10(srb, ss, start, smallblks)) {
1103 USB_STOR_PRINTF("Read ERROR\n");
1104 usb_request_sense(srb, ss);
1112 buf_addr += srb->datalen;
1113 } while (blks != 0);
1115 USB_STOR_PRINTF("usb_read: end startblk %lx, blccnt %x buffer %lx\n",
1116 start, smallblks, buf_addr);
1118 usb_disable_asynch(0); /* asynch transfer allowed */
1119 if (blkcnt >= max_xfer_blk)
1124 unsigned long usb_stor_write(int device, unsigned long blknr,
1125 unsigned long blkcnt, const void *buffer)
1127 unsigned long start, blks, buf_addr, max_xfer_blk;
1128 unsigned short smallblks;
1129 struct usb_device *dev;
1132 ccb *srb = &usb_ccb;
1139 USB_STOR_PRINTF("\nusb_write: dev %d \n", device);
1141 for (i = 0; i < USB_MAX_DEVICE; i++) {
1142 dev = usb_get_dev_index(i);
1145 if (dev->devnum == usb_dev_desc[device].target)
1148 ss = (struct us_data *)dev->privptr;
1150 usb_disable_asynch(1); /* asynch transfer not allowed */
1152 srb->lun = usb_dev_desc[device].lun;
1153 buf_addr = (unsigned long)buffer;
1156 if (usb_test_unit_ready(srb, ss)) {
1157 printf("Device NOT ready\n Request Sense returned %02X %02X"
1158 " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1159 srb->sense_buf[13]);
1163 USB_STOR_PRINTF("\nusb_write: dev %d startblk %lx, blccnt %lx"
1164 " buffer %lx\n", device, start, blks, buf_addr);
1167 /* If write fails retry for max retry count else
1168 * return with number of blocks written successfully.
1171 srb->pdata = (unsigned char *)buf_addr;
1172 max_xfer_blk = USB_MAX_XFER_BLK(buf_addr,
1173 usb_dev_desc[device].blksz);
1174 if (blks > max_xfer_blk)
1175 smallblks = (unsigned short) max_xfer_blk;
1177 smallblks = (unsigned short) blks;
1179 if (smallblks == max_xfer_blk)
1180 usb_show_progress();
1181 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1182 srb->pdata = (unsigned char *)buf_addr;
1183 if (usb_write_10(srb, ss, start, smallblks)) {
1184 USB_STOR_PRINTF("Write ERROR\n");
1185 usb_request_sense(srb, ss);
1193 buf_addr += srb->datalen;
1194 } while (blks != 0);
1196 USB_STOR_PRINTF("usb_write: end startblk %lx, blccnt %x buffer %lx\n",
1197 start, smallblks, buf_addr);
1199 usb_disable_asynch(0); /* asynch transfer allowed */
1200 if (blkcnt >= max_xfer_blk)
1206 /* Probe to see if a new device is actually a Storage device */
1207 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1210 struct usb_interface *iface;
1212 unsigned int flags = 0;
1217 /* let's examine the device now */
1218 iface = &dev->config.if_desc[ifnum];
1221 /* this is the place to patch some storage devices */
1222 USB_STOR_PRINTF("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1223 dev->descriptor.idProduct);
1225 if ((dev->descriptor.idVendor) == 0x066b &&
1226 (dev->descriptor.idProduct) == 0x0103) {
1227 USB_STOR_PRINTF("patched for E-USB\n");
1228 protocol = US_PR_CB;
1229 subclass = US_SC_UFI; /* an assumption */
1233 if (dev->descriptor.bDeviceClass != 0 ||
1234 iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1235 iface->desc.bInterfaceSubClass < US_SC_MIN ||
1236 iface->desc.bInterfaceSubClass > US_SC_MAX) {
1237 /* if it's not a mass storage, we go no further */
1241 memset(ss, 0, sizeof(struct us_data));
1243 /* At this point, we know we've got a live one */
1244 USB_STOR_PRINTF("\n\nUSB Mass Storage device detected\n");
1246 /* Initialize the us_data structure with some useful info */
1250 ss->attention_done = 0;
1252 /* If the device has subclass and protocol, then use that. Otherwise,
1253 * take data from the specific interface.
1256 ss->subclass = subclass;
1257 ss->protocol = protocol;
1259 ss->subclass = iface->desc.bInterfaceSubClass;
1260 ss->protocol = iface->desc.bInterfaceProtocol;
1263 /* set the handler pointers based on the protocol */
1264 USB_STOR_PRINTF("Transport: ");
1265 switch (ss->protocol) {
1267 USB_STOR_PRINTF("Control/Bulk\n");
1268 ss->transport = usb_stor_CB_transport;
1269 ss->transport_reset = usb_stor_CB_reset;
1273 USB_STOR_PRINTF("Control/Bulk/Interrupt\n");
1274 ss->transport = usb_stor_CB_transport;
1275 ss->transport_reset = usb_stor_CB_reset;
1278 USB_STOR_PRINTF("Bulk/Bulk/Bulk\n");
1279 ss->transport = usb_stor_BBB_transport;
1280 ss->transport_reset = usb_stor_BBB_reset;
1283 printf("USB Storage Transport unknown / not yet implemented\n");
1289 * We are expecting a minimum of 2 endpoints - in and out (bulk).
1290 * An optional interrupt is OK (necessary for CBI protocol).
1291 * We will ignore any others.
1293 for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1294 /* is it an BULK endpoint? */
1295 if ((iface->ep_desc[i].bmAttributes &
1296 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1297 if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
1298 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
1299 USB_ENDPOINT_NUMBER_MASK;
1302 iface->ep_desc[i].bEndpointAddress &
1303 USB_ENDPOINT_NUMBER_MASK;
1306 /* is it an interrupt endpoint? */
1307 if ((iface->ep_desc[i].bmAttributes &
1308 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1309 ss->ep_int = iface->ep_desc[i].bEndpointAddress &
1310 USB_ENDPOINT_NUMBER_MASK;
1311 ss->irqinterval = iface->ep_desc[i].bInterval;
1314 USB_STOR_PRINTF("Endpoints In %d Out %d Int %d\n",
1315 ss->ep_in, ss->ep_out, ss->ep_int);
1317 /* Do some basic sanity checks, and bail if we find a problem */
1318 if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1319 !ss->ep_in || !ss->ep_out ||
1320 (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1321 USB_STOR_PRINTF("Problems with device\n");
1324 /* set class specific stuff */
1325 /* We only handle certain protocols. Currently, these are
1327 * The SFF8070 accepts the requests used in u-boot
1329 if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1330 ss->subclass != US_SC_8070) {
1331 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1335 /* we had found an interrupt endpoint, prepare irq pipe
1336 * set up the IRQ pipe and handler
1338 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1339 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1340 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1341 dev->irq_handle = usb_stor_irq;
1343 dev->privptr = (void *)ss;
1347 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1348 block_dev_desc_t *dev_desc)
1350 unsigned char perq, modi;
1351 ALLOC_CACHE_ALIGN_BUFFER(unsigned long, cap, 2);
1352 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, usb_stor_buf, 36);
1353 unsigned long *capacity, *blksz;
1354 ccb *pccb = &usb_ccb;
1356 pccb->pdata = usb_stor_buf;
1358 dev_desc->target = dev->devnum;
1359 pccb->lun = dev_desc->lun;
1360 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1362 if (usb_inquiry(pccb, ss))
1365 perq = usb_stor_buf[0];
1366 modi = usb_stor_buf[1];
1368 if ((perq & 0x1f) == 0x1f) {
1369 /* skip unknown devices */
1372 if ((modi&0x80) == 0x80) {
1373 /* drive is removable */
1374 dev_desc->removable = 1;
1376 memcpy(&dev_desc->vendor[0], (const void *) &usb_stor_buf[8], 8);
1377 memcpy(&dev_desc->product[0], (const void *) &usb_stor_buf[16], 16);
1378 memcpy(&dev_desc->revision[0], (const void *) &usb_stor_buf[32], 4);
1379 dev_desc->vendor[8] = 0;
1380 dev_desc->product[16] = 0;
1381 dev_desc->revision[4] = 0;
1382 #ifdef CONFIG_USB_BIN_FIXUP
1383 usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1384 (uchar *)dev_desc->product);
1385 #endif /* CONFIG_USB_BIN_FIXUP */
1386 USB_STOR_PRINTF("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1388 if (usb_test_unit_ready(pccb, ss)) {
1389 printf("Device NOT ready\n"
1390 " Request Sense returned %02X %02X %02X\n",
1391 pccb->sense_buf[2], pccb->sense_buf[12],
1392 pccb->sense_buf[13]);
1393 if (dev_desc->removable == 1) {
1394 dev_desc->type = perq;
1399 pccb->pdata = (unsigned char *)&cap[0];
1400 memset(pccb->pdata, 0, 8);
1401 if (usb_read_capacity(pccb, ss) != 0) {
1402 printf("READ_CAP ERROR\n");
1406 USB_STOR_PRINTF("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0],
1409 if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1412 cap[0] = cpu_to_be32(cap[0]);
1413 cap[1] = cpu_to_be32(cap[1]);
1415 /* this assumes bigendian! */
1419 USB_STOR_PRINTF("Capacity = 0x%lx, blocksz = 0x%lx\n",
1421 dev_desc->lba = *capacity;
1422 dev_desc->blksz = *blksz;
1423 dev_desc->type = perq;
1424 USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1425 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1427 init_part(dev_desc);
1429 USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);