]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - common/usb_storage.c
merged current version of git://git.denx.de/u-boot
[karo-tx-uboot.git] / common / usb_storage.c
1 /*
2  * Most of this source has been derived from the Linux USB
3  * project:
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.
8  *
9  *
10  * Adapted for U-Boot:
11  *   (C) Copyright 2001 Denis Peter, MPL AG Switzerland
12  *
13  * For BBB support (C) Copyright 2003
14  * Gary Jennejohn, DENX Software Engineering <garyj@denx.de>
15  *
16  * BBB support based on /sys/dev/usb/umass.c from
17  * FreeBSD.
18  *
19  * See file CREDITS for list of people who contributed to this
20  * project.
21  *
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.
26  *
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.
31  *
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,
35  * MA 02111-1307 USA
36  *
37  */
38
39 /* Note:
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.
43  */
44 /*
45  * New Note:
46  * Support for USB Mass Storage Devices (BBB) has been added. It has
47  * only been tested with USB memory sticks.
48  */
49
50
51 #include <common.h>
52 #include <command.h>
53 #include <asm/byteorder.h>
54 #include <asm/processor.h>
55
56 #include <part.h>
57 #include <usb.h>
58
59 #undef BBB_COMDAT_TRACE
60 #undef BBB_XPORT_TRACE
61
62 #ifdef  USB_STOR_DEBUG
63 #define USB_BLK_DEBUG   1
64 #else
65 #define USB_BLK_DEBUG   0
66 #endif
67
68 #define USB_STOR_PRINTF(fmt, args...)   debug_cond(USB_BLK_DEBUG, fmt, ##args)
69
70 #include <scsi.h>
71 /* direction table -- this indicates the direction of the data
72  * transfer for each command code -- a 1 indicates input
73  */
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
79 };
80 #define US_DIRECTION(x) ((us_direction[x>>3] >> (x & 7)) & 1)
81
82 static unsigned char usb_stor_buf[512];
83 static ccb usb_ccb;
84
85 /*
86  * CBI style
87  */
88
89 #define US_CBI_ADSC             0
90
91 /*
92  * BULK only
93  */
94 #define US_BBB_RESET            0xff
95 #define US_BBB_GET_MAX_LUN      0xfe
96
97 /* Command Block Wrapper */
98 typedef struct {
99         __u32           dCBWSignature;
100 #       define CBWSIGNATURE     0x43425355
101         __u32           dCBWTag;
102         __u32           dCBWDataTransferLength;
103         __u8            bCBWFlags;
104 #       define CBWFLAGS_OUT     0x00
105 #       define CBWFLAGS_IN      0x80
106         __u8            bCBWLUN;
107         __u8            bCDBLength;
108 #       define CBWCDBLENGTH     16
109         __u8            CBWCDB[CBWCDBLENGTH];
110 } umass_bbb_cbw_t;
111 #define UMASS_BBB_CBW_SIZE      31
112 static __u32 CBWTag;
113
114 /* Command Status Wrapper */
115 typedef struct {
116         __u32           dCSWSignature;
117 #       define CSWSIGNATURE     0x53425355
118         __u32           dCSWTag;
119         __u32           dCSWDataResidue;
120         __u8            bCSWStatus;
121 #       define CSWSTATUS_GOOD   0x0
122 #       define CSWSTATUS_FAILED 0x1
123 #       define CSWSTATUS_PHASE  0x2
124 } umass_bbb_csw_t;
125 #define UMASS_BBB_CSW_SIZE      13
126
127 #define USB_MAX_STOR_DEV 5
128 static int usb_max_devs; /* number of highest available usb device */
129
130 static block_dev_desc_t usb_dev_desc[USB_MAX_STOR_DEV];
131
132 struct us_data;
133 typedef int (*trans_cmnd)(ccb *cb, struct us_data *data);
134 typedef int (*trans_reset)(struct us_data *data);
135
136 struct us_data {
137         struct usb_device *pusb_dev;     /* this usb_device */
138
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         unsigned long   max_xfer_blk;           /* Max blocks per xfer */
155         ccb             *srb;                   /* current srb */
156         trans_reset     transport_reset;        /* reset routine */
157         trans_cmnd      transport;              /* transport routine */
158 };
159
160 static struct us_data usb_stor[USB_MAX_STOR_DEV];
161
162
163 #define USB_STOR_TRANSPORT_GOOD    0
164 #define USB_STOR_TRANSPORT_FAILED -1
165 #define USB_STOR_TRANSPORT_ERROR  -2
166
167 int usb_stor_get_info(struct usb_device *dev, struct us_data *us,
168                       block_dev_desc_t *dev_desc);
169 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
170                       struct us_data *ss);
171 unsigned long usb_stor_read(int device, unsigned long blknr,
172                             unsigned long blkcnt, void *buffer);
173 unsigned long usb_stor_write(int device, unsigned long blknr,
174                              unsigned long blkcnt, const void *buffer);
175 struct usb_device * usb_get_dev_index(int index);
176 void uhci_show_temp_int_td(void);
177
178 #ifdef CONFIG_PARTITIONS
179 block_dev_desc_t *usb_stor_get_dev(int index)
180 {
181         return (index < usb_max_devs) ? &usb_dev_desc[index] : NULL;
182 }
183 #endif
184
185 void usb_show_progress(void)
186 {
187         debug(".");
188 }
189
190 /*******************************************************************************
191  * show info on storage devices; 'usb start/init' must be invoked earlier
192  * as we only retrieve structures populated during devices initialization
193  */
194 int usb_stor_info(void)
195 {
196         int i;
197
198         if (usb_max_devs > 0) {
199                 for (i = 0; i < usb_max_devs; i++) {
200                         printf("  Device %d: ", i);
201                         dev_print(&usb_dev_desc[i]);
202                 }
203                 return 0;
204         }
205
206         printf("No storage devices, perhaps not 'usb start'ed..?\n");
207         return 1;
208 }
209
210 static unsigned int usb_get_max_lun(struct us_data *us)
211 {
212         int len;
213         unsigned char result;
214         len = usb_control_msg(us->pusb_dev,
215                               usb_rcvctrlpipe(us->pusb_dev, 0),
216                               US_BBB_GET_MAX_LUN,
217                               USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
218                               0, us->ifnum,
219                               &result, sizeof(result),
220                               USB_CNTL_TIMEOUT * 5);
221         USB_STOR_PRINTF("Get Max LUN -> len = %i, result = %i\n",
222                         len, (int) result);
223         return (len > 0) ? result : 0;
224 }
225
226 /*******************************************************************************
227  * scan the usb and reports device info
228  * to the user if mode = 1
229  * returns current device or -1 if no
230  */
231 int usb_stor_scan(int mode)
232 {
233         unsigned char i;
234         struct usb_device *dev;
235
236         /* GJ */
237         memset(usb_stor_buf, 0, sizeof(usb_stor_buf));
238
239         if (mode == 1)
240                 printf("       scanning bus for storage devices... ");
241
242         usb_disable_asynch(1); /* asynch transfer not allowed */
243
244         for (i = 0; i < USB_MAX_STOR_DEV; i++) {
245                 memset(&usb_dev_desc[i], 0, sizeof(block_dev_desc_t));
246                 usb_dev_desc[i].if_type = IF_TYPE_USB;
247                 usb_dev_desc[i].dev = i;
248                 usb_dev_desc[i].part_type = PART_TYPE_UNKNOWN;
249                 usb_dev_desc[i].target = 0xff;
250                 usb_dev_desc[i].type = DEV_TYPE_UNKNOWN;
251                 usb_dev_desc[i].block_read = usb_stor_read;
252                 usb_dev_desc[i].block_write = usb_stor_write;
253         }
254
255         usb_max_devs = 0;
256         for (i = 0; i < USB_MAX_DEVICE; i++) {
257                 dev = usb_get_dev_index(i); /* get device */
258                 USB_STOR_PRINTF("i=%d\n", i);
259                 if (dev == NULL)
260                         break; /* no more devices available */
261
262                 if (usb_storage_probe(dev, 0, &usb_stor[usb_max_devs])) {
263                         /* OK, it's a storage device.  Iterate over its LUNs
264                          * and populate `usb_dev_desc'.
265                          */
266                         int lun, max_lun, start = usb_max_devs;
267
268                         max_lun = usb_get_max_lun(&usb_stor[usb_max_devs]);
269                         for (lun = 0;
270                              lun <= max_lun && usb_max_devs < USB_MAX_STOR_DEV;
271                              lun++) {
272                                 usb_dev_desc[usb_max_devs].lun = lun;
273                                 if (usb_stor_get_info(dev, &usb_stor[start],
274                                                       &usb_dev_desc[usb_max_devs]) == 1) {
275                                 usb_max_devs++;
276                 }
277                         }
278                 }
279                 /* if storage device */
280                 if (usb_max_devs == USB_MAX_STOR_DEV) {
281                         printf("max USB Storage Device reached: %d stopping\n",
282                                 usb_max_devs);
283                         break;
284                 }
285         } /* for */
286
287         usb_disable_asynch(0); /* asynch transfer allowed */
288         printf("%d Storage Device(s) found\n", usb_max_devs);
289         if (usb_max_devs > 0)
290                 return 0;
291         return -1;
292 }
293
294 static int usb_stor_irq(struct usb_device *dev)
295 {
296         struct us_data *us;
297         us = (struct us_data *)dev->privptr;
298
299         if (us->ip_wanted)
300                 us->ip_wanted = 0;
301         return 0;
302 }
303
304
305 #ifdef  USB_STOR_DEBUG
306
307 static void usb_show_srb(ccb *pccb)
308 {
309         int i;
310         printf("SRB: len %d datalen 0x%lX\n ", pccb->cmdlen, pccb->datalen);
311         for (i = 0; i < 12; i++)
312                 printf("%02X ", pccb->cmd[i]);
313         printf("\n");
314 }
315
316 static void display_int_status(unsigned long tmp)
317 {
318         printf("Status: %s %s %s %s %s %s %s\n",
319                 (tmp & USB_ST_ACTIVE) ? "Active" : "",
320                 (tmp & USB_ST_STALLED) ? "Stalled" : "",
321                 (tmp & USB_ST_BUF_ERR) ? "Buffer Error" : "",
322                 (tmp & USB_ST_BABBLE_DET) ? "Babble Det" : "",
323                 (tmp & USB_ST_NAK_REC) ? "NAKed" : "",
324                 (tmp & USB_ST_CRC_ERR) ? "CRC Error" : "",
325                 (tmp & USB_ST_BIT_ERR) ? "Bitstuff Error" : "");
326 }
327 #endif
328 /***********************************************************************
329  * Data transfer routines
330  ***********************************************************************/
331
332 static int us_one_transfer(struct us_data *us, int pipe, char *buf, int length)
333 {
334         int max_size;
335         int this_xfer;
336         int result;
337         int partial;
338         int maxtry;
339         int stat;
340
341         /* determine the maximum packet size for these transfers */
342         max_size = usb_maxpacket(us->pusb_dev, pipe) * 16;
343
344         /* while we have data left to transfer */
345         while (length) {
346
347                 /* calculate how long this will be -- maximum or a remainder */
348                 this_xfer = length > max_size ? max_size : length;
349                 length -= this_xfer;
350
351                 /* setup the retry counter */
352                 maxtry = 10;
353
354                 /* set up the transfer loop */
355                 do {
356                         /* transfer the data */
357                         USB_STOR_PRINTF("Bulk xfer 0x%x(%d) try #%d\n",
358                                   (unsigned int)buf, this_xfer, 11 - maxtry);
359                         result = usb_bulk_msg(us->pusb_dev, pipe, buf,
360                                               this_xfer, &partial,
361                                               USB_CNTL_TIMEOUT * 5);
362                         USB_STOR_PRINTF("bulk_msg returned %d xferred %d/%d\n",
363                                   result, partial, this_xfer);
364                         if (us->pusb_dev->status != 0) {
365                                 /* if we stall, we need to clear it before
366                                  * we go on
367                                  */
368 #ifdef USB_STOR_DEBUG
369                                 display_int_status(us->pusb_dev->status);
370 #endif
371                                 if (us->pusb_dev->status & USB_ST_STALLED) {
372                                         USB_STOR_PRINTF("stalled ->clearing endpoint halt for pipe 0x%x\n", pipe);
373                                         stat = us->pusb_dev->status;
374                                         usb_clear_halt(us->pusb_dev, pipe);
375                                         us->pusb_dev->status = stat;
376                                         if (this_xfer == partial) {
377                                                 USB_STOR_PRINTF("bulk transferred with error %lX, but data ok\n", us->pusb_dev->status);
378                                                 return 0;
379                                         }
380                                         else
381                                                 return result;
382                                 }
383                                 if (us->pusb_dev->status & USB_ST_NAK_REC) {
384                                         USB_STOR_PRINTF("Device NAKed bulk_msg\n");
385                                         return result;
386                                 }
387                                 USB_STOR_PRINTF("bulk transferred with error");
388                                 if (this_xfer == partial) {
389                                         USB_STOR_PRINTF(" %ld, but data ok\n",
390                                                         us->pusb_dev->status);
391                                         return 0;
392                                 }
393                                 /* if our try counter reaches 0, bail out */
394                                         USB_STOR_PRINTF(" %ld, data %d\n",
395                                                 us->pusb_dev->status, partial);
396                                 if (!maxtry--)
397                                                 return result;
398                         }
399                         /* update to show what data was transferred */
400                         this_xfer -= partial;
401                         buf += partial;
402                         /* continue until this transfer is done */
403                 } while (this_xfer);
404         }
405
406         /* if we get here, we're done and successful */
407         return 0;
408 }
409
410 static int usb_stor_BBB_reset(struct us_data *us)
411 {
412         int result;
413         unsigned int pipe;
414
415         /*
416          * Reset recovery (5.3.4 in Universal Serial Bus Mass Storage Class)
417          *
418          * For Reset Recovery the host shall issue in the following order:
419          * a) a Bulk-Only Mass Storage Reset
420          * b) a Clear Feature HALT to the Bulk-In endpoint
421          * c) a Clear Feature HALT to the Bulk-Out endpoint
422          *
423          * This is done in 3 steps.
424          *
425          * If the reset doesn't succeed, the device should be port reset.
426          *
427          * This comment stolen from FreeBSD's /sys/dev/usb/umass.c.
428          */
429         USB_STOR_PRINTF("BBB_reset\n");
430         result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
431                                  US_BBB_RESET,
432                                  USB_TYPE_CLASS | USB_RECIP_INTERFACE,
433                                  0, us->ifnum, 0, 0, USB_CNTL_TIMEOUT * 5);
434
435         if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
436                 USB_STOR_PRINTF("RESET:stall\n");
437                 return -1;
438         }
439
440         /* long wait for reset */
441         wait_ms(150);
442         USB_STOR_PRINTF("BBB_reset result %d: status %lX reset\n", result,
443                         us->pusb_dev->status);
444         pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
445         result = usb_clear_halt(us->pusb_dev, pipe);
446         /* long wait for reset */
447         wait_ms(150);
448         USB_STOR_PRINTF("BBB_reset result %d: status %lX clearing IN endpoint\n",
449                         result, us->pusb_dev->status);
450         /* long wait for reset */
451         pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
452         result = usb_clear_halt(us->pusb_dev, pipe);
453         wait_ms(150);
454         USB_STOR_PRINTF("BBB_reset result %d: status %lX"
455                         " clearing OUT endpoint\n", result,
456                         us->pusb_dev->status);
457         USB_STOR_PRINTF("BBB_reset done\n");
458         return 0;
459 }
460
461 /* FIXME: this reset function doesn't really reset the port, and it
462  * should. Actually it should probably do what it's doing here, and
463  * reset the port physically
464  */
465 static int usb_stor_CB_reset(struct us_data *us)
466 {
467         unsigned char cmd[12];
468         int result;
469
470         USB_STOR_PRINTF("CB_reset\n");
471         memset(cmd, 0xff, sizeof(cmd));
472         cmd[0] = SCSI_SEND_DIAG;
473         cmd[1] = 4;
474         result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
475                                  US_CBI_ADSC,
476                                  USB_TYPE_CLASS | USB_RECIP_INTERFACE,
477                                  0, us->ifnum, cmd, sizeof(cmd),
478                                  USB_CNTL_TIMEOUT * 5);
479
480         /* long wait for reset */
481         wait_ms(1500);
482         USB_STOR_PRINTF("CB_reset result %d: status %lX"
483                         " clearing endpoint halt\n", result,
484                         us->pusb_dev->status);
485         usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_in));
486         usb_clear_halt(us->pusb_dev, usb_rcvbulkpipe(us->pusb_dev, us->ep_out));
487
488         USB_STOR_PRINTF("CB_reset done\n");
489         return 0;
490 }
491
492 /*
493  * Set up the command for a BBB device. Note that the actual SCSI
494  * command is copied into cbw.CBWCDB.
495  */
496 int usb_stor_BBB_comdat(ccb *srb, struct us_data *us)
497 {
498         int result;
499         int actlen;
500         int dir_in;
501         unsigned int pipe;
502         umass_bbb_cbw_t cbw;
503
504         dir_in = US_DIRECTION(srb->cmd[0]);
505
506 #ifdef BBB_COMDAT_TRACE
507         printf("dir %d lun %d cmdlen %d cmd %p datalen %d pdata %p\n",
508                 dir_in, srb->lun, srb->cmdlen, srb->cmd, srb->datalen,
509                 srb->pdata);
510         if (srb->cmdlen) {
511                 for (result = 0; result < srb->cmdlen; result++)
512                         printf("cmd[%d] %#x ", result, srb->cmd[result]);
513                 printf("\n");
514         }
515 #endif
516         /* sanity checks */
517         if (!(srb->cmdlen <= CBWCDBLENGTH)) {
518                 USB_STOR_PRINTF("usb_stor_BBB_comdat:cmdlen too large\n");
519                 return -1;
520         }
521
522         /* always OUT to the ep */
523         pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
524
525         cbw.dCBWSignature = cpu_to_le32(CBWSIGNATURE);
526         cbw.dCBWTag = cpu_to_le32(CBWTag++);
527         cbw.dCBWDataTransferLength = cpu_to_le32(srb->datalen);
528         cbw.bCBWFlags = (dir_in ? CBWFLAGS_IN : CBWFLAGS_OUT);
529         cbw.bCBWLUN = srb->lun;
530         cbw.bCDBLength = srb->cmdlen;
531         /* copy the command data into the CBW command data buffer */
532         /* DST SRC LEN!!! */
533         memcpy(cbw.CBWCDB, srb->cmd, srb->cmdlen);
534         result = usb_bulk_msg(us->pusb_dev, pipe, &cbw, UMASS_BBB_CBW_SIZE,
535                               &actlen, USB_CNTL_TIMEOUT * 5);
536         if (result < 0)
537                 USB_STOR_PRINTF("usb_stor_BBB_comdat:usb_bulk_msg error\n");
538         return result;
539 }
540
541 /* FIXME: we also need a CBI_command which sets up the completion
542  * interrupt, and waits for it
543  */
544 int usb_stor_CB_comdat(ccb *srb, struct us_data *us)
545 {
546         int result = 0;
547         int dir_in, retry;
548         unsigned int pipe;
549         unsigned long status;
550
551         retry = 5;
552         dir_in = US_DIRECTION(srb->cmd[0]);
553
554         if (dir_in)
555                 pipe = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
556         else
557                 pipe = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
558
559         while (retry--) {
560                 USB_STOR_PRINTF("CBI gets a command: Try %d\n", 5 - retry);
561 #ifdef USB_STOR_DEBUG
562                 usb_show_srb(srb);
563 #endif
564                 /* let's send the command via the control pipe */
565                 result = usb_control_msg(us->pusb_dev,
566                                          usb_sndctrlpipe(us->pusb_dev , 0),
567                                          US_CBI_ADSC,
568                                          USB_TYPE_CLASS | USB_RECIP_INTERFACE,
569                                          0, us->ifnum,
570                                          srb->cmd, srb->cmdlen,
571                                          USB_CNTL_TIMEOUT * 5);
572                 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
573                                 " status %lX\n", result, us->pusb_dev->status);
574                 /* check the return code for the command */
575                 if (result < 0) {
576                         if (us->pusb_dev->status & USB_ST_STALLED) {
577                                 status = us->pusb_dev->status;
578                                 USB_STOR_PRINTF(" stall during command found,"
579                                                 " clear pipe\n");
580                                 usb_clear_halt(us->pusb_dev,
581                                               usb_sndctrlpipe(us->pusb_dev, 0));
582                                 us->pusb_dev->status = status;
583                         }
584                         USB_STOR_PRINTF(" error during command %02X"
585                                         " Stat = %lX\n", srb->cmd[0],
586                                         us->pusb_dev->status);
587                         return result;
588                 }
589                 /* transfer the data payload for this command, if one exists*/
590
591                 USB_STOR_PRINTF("CB_transport: control msg returned %d,"
592                                 " direction is %s to go 0x%lx\n", result,
593                                 dir_in ? "IN" : "OUT", srb->datalen);
594                 if (srb->datalen) {
595                         result = us_one_transfer(us, pipe, (char *)srb->pdata,
596                                                  srb->datalen);
597                         USB_STOR_PRINTF("CBI attempted to transfer data,"
598                                         " result is %d status %lX, len %d\n",
599                                         result, us->pusb_dev->status,
600                                         us->pusb_dev->act_len);
601                         if (!(us->pusb_dev->status & USB_ST_NAK_REC))
602                                 break;
603                 } /* if (srb->datalen) */
604                 else
605                         break;
606         }
607         /* return result */
608
609         return result;
610 }
611
612
613 int usb_stor_CBI_get_status(ccb *srb, struct us_data *us)
614 {
615         int timeout;
616
617         us->ip_wanted = 1;
618         submit_int_msg(us->pusb_dev, us->irqpipe,
619                         (void *) &us->ip_data, us->irqmaxp, us->irqinterval);
620         timeout = 1000;
621         while (timeout--) {
622                 if ((volatile int *) us->ip_wanted == 0)
623                         break;
624                 wait_ms(10);
625         }
626         if (us->ip_wanted) {
627                 printf("        Did not get interrupt on CBI\n");
628                 us->ip_wanted = 0;
629                 return USB_STOR_TRANSPORT_ERROR;
630         }
631         USB_STOR_PRINTF
632                 ("Got interrupt data 0x%x, transfered %d status 0x%lX\n",
633                  us->ip_data, us->pusb_dev->irq_act_len,
634                  us->pusb_dev->irq_status);
635         /* UFI gives us ASC and ASCQ, like a request sense */
636         if (us->subclass == US_SC_UFI) {
637                 if (srb->cmd[0] == SCSI_REQ_SENSE ||
638                     srb->cmd[0] == SCSI_INQUIRY)
639                         return USB_STOR_TRANSPORT_GOOD; /* Good */
640                 else if (us->ip_data)
641                         return USB_STOR_TRANSPORT_FAILED;
642                 else
643                         return USB_STOR_TRANSPORT_GOOD;
644         }
645         /* otherwise, we interpret the data normally */
646         switch (us->ip_data) {
647         case 0x0001:
648                 return USB_STOR_TRANSPORT_GOOD;
649         case 0x0002:
650                 return USB_STOR_TRANSPORT_FAILED;
651         default:
652                 return USB_STOR_TRANSPORT_ERROR;
653         }                       /* switch */
654         return USB_STOR_TRANSPORT_ERROR;
655 }
656
657 #define USB_TRANSPORT_UNKNOWN_RETRY 5
658 #define USB_TRANSPORT_NOT_READY_RETRY 10
659
660 /* clear a stall on an endpoint - special for BBB devices */
661 int usb_stor_BBB_clear_endpt_stall(struct us_data *us, __u8 endpt)
662 {
663         int result;
664
665         /* ENDPOINT_HALT = 0, so set value to 0 */
666         result = usb_control_msg(us->pusb_dev, usb_sndctrlpipe(us->pusb_dev, 0),
667                                 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
668                                 0, endpt, 0, 0, USB_CNTL_TIMEOUT * 5);
669         return result;
670 }
671
672 int usb_stor_BBB_transport(ccb *srb, struct us_data *us)
673 {
674         int result, retry;
675         int dir_in;
676         int actlen, data_actlen;
677         unsigned int pipe, pipein, pipeout;
678         umass_bbb_csw_t csw;
679 #ifdef BBB_XPORT_TRACE
680         unsigned char *ptr;
681         int index;
682 #endif
683
684         dir_in = US_DIRECTION(srb->cmd[0]);
685
686         /* COMMAND phase */
687         USB_STOR_PRINTF("COMMAND phase\n");
688         result = usb_stor_BBB_comdat(srb, us);
689         if (result < 0) {
690                 USB_STOR_PRINTF("failed to send CBW status %ld\n",
691                         us->pusb_dev->status);
692                 usb_stor_BBB_reset(us);
693                 return USB_STOR_TRANSPORT_FAILED;
694         }
695         wait_ms(5);
696         pipein = usb_rcvbulkpipe(us->pusb_dev, us->ep_in);
697         pipeout = usb_sndbulkpipe(us->pusb_dev, us->ep_out);
698         /* DATA phase + error handling */
699         data_actlen = 0;
700         /* no data, go immediately to the STATUS phase */
701         if (srb->datalen == 0)
702                 goto st;
703         USB_STOR_PRINTF("DATA phase\n");
704         if (dir_in)
705                 pipe = pipein;
706         else
707                 pipe = pipeout;
708         result = usb_bulk_msg(us->pusb_dev, pipe, srb->pdata, srb->datalen,
709                               &data_actlen, USB_CNTL_TIMEOUT * 5);
710         /* special handling of STALL in DATA phase */
711         if ((result < 0) && (us->pusb_dev->status & USB_ST_STALLED)) {
712                 USB_STOR_PRINTF("DATA:stall\n");
713                 /* clear the STALL on the endpoint */
714                 result = usb_stor_BBB_clear_endpt_stall(us,
715                                         dir_in ? us->ep_in : us->ep_out);
716                 if (result >= 0)
717                         /* continue on to STATUS phase */
718                         goto st;
719         }
720         if (result < 0) {
721                 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
722                         us->pusb_dev->status);
723                 usb_stor_BBB_reset(us);
724                 return USB_STOR_TRANSPORT_FAILED;
725         }
726 #ifdef BBB_XPORT_TRACE
727         for (index = 0; index < data_actlen; index++)
728                 printf("pdata[%d] %#x ", index, srb->pdata[index]);
729         printf("\n");
730 #endif
731         /* STATUS phase + error handling */
732 st:
733         retry = 0;
734 again:
735         USB_STOR_PRINTF("STATUS phase\n");
736         result = usb_bulk_msg(us->pusb_dev, pipein, &csw, UMASS_BBB_CSW_SIZE,
737                                 &actlen, USB_CNTL_TIMEOUT*5);
738
739         /* special handling of STALL in STATUS phase */
740         if ((result < 0) && (retry < 1) &&
741             (us->pusb_dev->status & USB_ST_STALLED)) {
742                 USB_STOR_PRINTF("STATUS:stall\n");
743                 /* clear the STALL on the endpoint */
744                 result = usb_stor_BBB_clear_endpt_stall(us, us->ep_in);
745                 if (result >= 0 && (retry++ < 1))
746                         /* do a retry */
747                         goto again;
748         }
749         if (result < 0) {
750                 USB_STOR_PRINTF("usb_bulk_msg error status %ld\n",
751                         us->pusb_dev->status);
752                 usb_stor_BBB_reset(us);
753                 return USB_STOR_TRANSPORT_FAILED;
754         }
755 #ifdef BBB_XPORT_TRACE
756         ptr = (unsigned char *)&csw;
757         for (index = 0; index < UMASS_BBB_CSW_SIZE; index++)
758                 printf("ptr[%d] %#x ", index, ptr[index]);
759         printf("\n");
760 #endif
761         /* misuse pipe to get the residue */
762         pipe = le32_to_cpu(csw.dCSWDataResidue);
763         if (pipe == 0 && srb->datalen != 0 && srb->datalen - data_actlen != 0)
764                 pipe = srb->datalen - data_actlen;
765         if (CSWSIGNATURE != le32_to_cpu(csw.dCSWSignature)) {
766                 USB_STOR_PRINTF("!CSWSIGNATURE\n");
767                 usb_stor_BBB_reset(us);
768                 return USB_STOR_TRANSPORT_FAILED;
769         } else if ((CBWTag - 1) != le32_to_cpu(csw.dCSWTag)) {
770                 USB_STOR_PRINTF("!Tag\n");
771                 usb_stor_BBB_reset(us);
772                 return USB_STOR_TRANSPORT_FAILED;
773         } else if (csw.bCSWStatus > CSWSTATUS_PHASE) {
774                 USB_STOR_PRINTF(">PHASE\n");
775                 usb_stor_BBB_reset(us);
776                 return USB_STOR_TRANSPORT_FAILED;
777         } else if (csw.bCSWStatus == CSWSTATUS_PHASE) {
778                 USB_STOR_PRINTF("=PHASE\n");
779                 usb_stor_BBB_reset(us);
780                 return USB_STOR_TRANSPORT_FAILED;
781         } else if (data_actlen > srb->datalen) {
782                 USB_STOR_PRINTF("transferred %dB instead of %ldB\n",
783                         data_actlen, srb->datalen);
784                 return USB_STOR_TRANSPORT_FAILED;
785         } else if (csw.bCSWStatus == CSWSTATUS_FAILED) {
786                 USB_STOR_PRINTF("FAILED\n");
787                 return USB_STOR_TRANSPORT_FAILED;
788         }
789
790         return result;
791 }
792
793 int usb_stor_CB_transport(ccb *srb, struct us_data *us)
794 {
795         int result, status;
796         ccb *psrb;
797         ccb reqsrb;
798         int retry, notready;
799
800         psrb = &reqsrb;
801         status = USB_STOR_TRANSPORT_GOOD;
802         retry = 0;
803         notready = 0;
804         /* issue the command */
805 do_retry:
806         result = usb_stor_CB_comdat(srb, us);
807         USB_STOR_PRINTF("command / Data returned %d, status %lX\n",
808                         result, us->pusb_dev->status);
809         /* if this is an CBI Protocol, get IRQ */
810         if (us->protocol == US_PR_CBI) {
811                 status = usb_stor_CBI_get_status(srb, us);
812                 /* if the status is error, report it */
813                 if (status == USB_STOR_TRANSPORT_ERROR) {
814                         USB_STOR_PRINTF(" USB CBI Command Error\n");
815                         return status;
816                 }
817                 srb->sense_buf[12] = (unsigned char)(us->ip_data >> 8);
818                 srb->sense_buf[13] = (unsigned char)(us->ip_data & 0xff);
819                 if (!us->ip_data) {
820                         /* if the status is good, report it */
821                         if (status == USB_STOR_TRANSPORT_GOOD) {
822                                 USB_STOR_PRINTF(" USB CBI Command Good\n");
823                                 return status;
824                         }
825                 }
826         }
827         /* do we have to issue an auto request? */
828         /* HERE we have to check the result */
829         if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
830                 USB_STOR_PRINTF("ERROR %lX\n", us->pusb_dev->status);
831                 us->transport_reset(us);
832                 return USB_STOR_TRANSPORT_ERROR;
833         }
834         if ((us->protocol == US_PR_CBI) &&
835             ((srb->cmd[0] == SCSI_REQ_SENSE) ||
836             (srb->cmd[0] == SCSI_INQUIRY))) {
837                 /* do not issue an autorequest after request sense */
838                 USB_STOR_PRINTF("No auto request and good\n");
839                 return USB_STOR_TRANSPORT_GOOD;
840         }
841         /* issue an request_sense */
842         memset(&psrb->cmd[0], 0, 12);
843         psrb->cmd[0] = SCSI_REQ_SENSE;
844         psrb->cmd[1] = srb->lun << 5;
845         psrb->cmd[4] = 18;
846         psrb->datalen = 18;
847         psrb->pdata = &srb->sense_buf[0];
848         psrb->cmdlen = 12;
849         /* issue the command */
850         result = usb_stor_CB_comdat(psrb, us);
851         USB_STOR_PRINTF("auto request returned %d\n", result);
852         /* if this is an CBI Protocol, get IRQ */
853         if (us->protocol == US_PR_CBI)
854                 status = usb_stor_CBI_get_status(psrb, us);
855
856         if ((result < 0) && !(us->pusb_dev->status & USB_ST_STALLED)) {
857                 USB_STOR_PRINTF(" AUTO REQUEST ERROR %ld\n",
858                                 us->pusb_dev->status);
859                 return USB_STOR_TRANSPORT_ERROR;
860         }
861         USB_STOR_PRINTF("autorequest returned 0x%02X 0x%02X 0x%02X 0x%02X\n",
862                         srb->sense_buf[0], srb->sense_buf[2],
863                         srb->sense_buf[12], srb->sense_buf[13]);
864         /* Check the auto request result */
865         if ((srb->sense_buf[2] == 0) &&
866             (srb->sense_buf[12] == 0) &&
867             (srb->sense_buf[13] == 0)) {
868                 /* ok, no sense */
869                 return USB_STOR_TRANSPORT_GOOD;
870         }
871
872         /* Check the auto request result */
873         switch (srb->sense_buf[2]) {
874         case 0x01:
875                 /* Recovered Error */
876                 return USB_STOR_TRANSPORT_GOOD;
877                 break;
878         case 0x02:
879                 /* Not Ready */
880                 if (notready++ > USB_TRANSPORT_NOT_READY_RETRY) {
881                         printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
882                                " 0x%02X (NOT READY)\n", srb->cmd[0],
883                                 srb->sense_buf[0], srb->sense_buf[2],
884                                 srb->sense_buf[12], srb->sense_buf[13]);
885                         return USB_STOR_TRANSPORT_FAILED;
886                 } else {
887                         wait_ms(100);
888                         goto do_retry;
889                 }
890                 break;
891         default:
892                 if (retry++ > USB_TRANSPORT_UNKNOWN_RETRY) {
893                         printf("cmd 0x%02X returned 0x%02X 0x%02X 0x%02X"
894                                " 0x%02X\n", srb->cmd[0], srb->sense_buf[0],
895                                 srb->sense_buf[2], srb->sense_buf[12],
896                                 srb->sense_buf[13]);
897                         return USB_STOR_TRANSPORT_FAILED;
898                 } else
899                         goto do_retry;
900                 break;
901         }
902         return USB_STOR_TRANSPORT_FAILED;
903 }
904
905
906 static int usb_inquiry(ccb *srb, struct us_data *ss)
907 {
908         int retry, i;
909         retry = 5;
910         do {
911                 memset(&srb->cmd[0], 0, 12);
912                 srb->cmd[0] = SCSI_INQUIRY;
913                 srb->cmd[1] = srb->lun << 5;
914                 srb->cmd[4] = 36;
915                 srb->datalen = 36;
916                 srb->cmdlen = 12;
917                 i = ss->transport(srb, ss);
918                 USB_STOR_PRINTF("inquiry returns %d\n", i);
919                 if (i == 0)
920                         break;
921         } while (--retry);
922
923         if (!retry) {
924                 printf("error in inquiry\n");
925                 return -1;
926         }
927         return 0;
928 }
929
930 static int usb_request_sense(ccb *srb, struct us_data *ss)
931 {
932         char *ptr;
933
934         ptr = (char *)srb->pdata;
935         memset(&srb->cmd[0], 0, 12);
936         srb->cmd[0] = SCSI_REQ_SENSE;
937         srb->cmd[1] = srb->lun << 5;
938         srb->cmd[4] = 18;
939         srb->datalen = 18;
940         srb->pdata = &srb->sense_buf[0];
941         srb->cmdlen = 12;
942         ss->transport(srb, ss);
943         USB_STOR_PRINTF("Request Sense returned %02X %02X %02X\n",
944                         srb->sense_buf[2], srb->sense_buf[12],
945                         srb->sense_buf[13]);
946         srb->pdata = (uchar *)ptr;
947         return 0;
948 }
949
950 static int usb_test_unit_ready(ccb *srb, struct us_data *ss)
951 {
952         int retries = 10;
953
954         do {
955                 memset(&srb->cmd[0], 0, 12);
956                 srb->cmd[0] = SCSI_TST_U_RDY;
957                 srb->cmd[1] = srb->lun << 5;
958                 srb->datalen = 0;
959                 srb->cmdlen = 12;
960                 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
961                         return 0;
962                 usb_request_sense(srb, ss);
963                 wait_ms(100);
964         } while (retries--);
965
966         return -1;
967 }
968
969 static int usb_read_capacity(ccb *srb, struct us_data *ss)
970 {
971         int retry;
972         /* XXX retries */
973         retry = 3;
974         do {
975                 memset(&srb->cmd[0], 0, 12);
976                 srb->cmd[0] = SCSI_RD_CAPAC;
977                 srb->cmd[1] = srb->lun << 5;
978                 srb->datalen = 8;
979                 srb->cmdlen = 12;
980                 if (ss->transport(srb, ss) == USB_STOR_TRANSPORT_GOOD)
981                         return 0;
982         } while (retry--);
983
984         return -1;
985 }
986
987 static int usb_read_10(ccb *srb, struct us_data *ss, unsigned long start,
988                        unsigned short blocks)
989 {
990         memset(&srb->cmd[0], 0, 12);
991         srb->cmd[0] = SCSI_READ10;
992         srb->cmd[1] = srb->lun << 5;
993         srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
994         srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
995         srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
996         srb->cmd[5] = ((unsigned char) (start)) & 0xff;
997         srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
998         srb->cmd[8] = (unsigned char) blocks & 0xff;
999         srb->cmdlen = 12;
1000         USB_STOR_PRINTF("read10: start %lx blocks %x\n", start, blocks);
1001         return ss->transport(srb, ss);
1002 }
1003
1004 static int usb_write_10(ccb *srb, struct us_data *ss, unsigned long start,
1005                         unsigned short blocks)
1006 {
1007         memset(&srb->cmd[0], 0, 12);
1008         srb->cmd[0] = SCSI_WRITE10;
1009         srb->cmd[1] = srb->lun << 5;
1010         srb->cmd[2] = ((unsigned char) (start >> 24)) & 0xff;
1011         srb->cmd[3] = ((unsigned char) (start >> 16)) & 0xff;
1012         srb->cmd[4] = ((unsigned char) (start >> 8)) & 0xff;
1013         srb->cmd[5] = ((unsigned char) (start)) & 0xff;
1014         srb->cmd[7] = ((unsigned char) (blocks >> 8)) & 0xff;
1015         srb->cmd[8] = (unsigned char) blocks & 0xff;
1016         srb->cmdlen = 12;
1017         USB_STOR_PRINTF("write10: start %lx blocks %x\n", start, blocks);
1018         return ss->transport(srb, ss);
1019 }
1020
1021
1022 #ifdef CONFIG_USB_BIN_FIXUP
1023 /*
1024  * Some USB storage devices queried for SCSI identification data respond with
1025  * binary strings, which if output to the console freeze the terminal. The
1026  * workaround is to modify the vendor and product strings read from such
1027  * device with proper values (as reported by 'usb info').
1028  *
1029  * Vendor and product length limits are taken from the definition of
1030  * block_dev_desc_t in include/part.h.
1031  */
1032 static void usb_bin_fixup(struct usb_device_descriptor descriptor,
1033                                 unsigned char vendor[],
1034                                 unsigned char product[]) {
1035         const unsigned char max_vendor_len = 40;
1036         const unsigned char max_product_len = 20;
1037         if (descriptor.idVendor == 0x0424 && descriptor.idProduct == 0x223a) {
1038                 strncpy((char *)vendor, "SMSC", max_vendor_len);
1039                 strncpy((char *)product, "Flash Media Cntrller",
1040                         max_product_len);
1041         }
1042 }
1043 #endif /* CONFIG_USB_BIN_FIXUP */
1044
1045 unsigned long usb_stor_read(int device, unsigned long blknr,
1046                             unsigned long blkcnt, void *buffer)
1047 {
1048         unsigned long start, blks, buf_addr;
1049         unsigned short smallblks;
1050         struct usb_device *dev;
1051         struct us_data *ss;
1052         int retry, i;
1053         ccb *srb = &usb_ccb;
1054
1055         if (blkcnt == 0)
1056                 return 0;
1057
1058         device &= 0xff;
1059         /* Setup  device */
1060         USB_STOR_PRINTF("\nusb_read: dev %d \n", device);
1061         dev = NULL;
1062         for (i = 0; i < USB_MAX_DEVICE; i++) {
1063                 dev = usb_get_dev_index(i);
1064                 if (dev == NULL)
1065                         return 0;
1066                 if (dev->devnum == usb_dev_desc[device].target)
1067                         break;
1068         }
1069         ss = (struct us_data *)dev->privptr;
1070
1071         usb_disable_asynch(1); /* asynch transfer not allowed */
1072         srb->lun = usb_dev_desc[device].lun;
1073         buf_addr = (unsigned long)buffer;
1074         start = blknr;
1075         blks = blkcnt;
1076         if (usb_test_unit_ready(srb, ss)) {
1077                 printf("Device NOT ready\n   Request Sense returned %02X %02X"
1078                        " %02X\n", srb->sense_buf[2], srb->sense_buf[12],
1079                        srb->sense_buf[13]);
1080                 return 0;
1081         }
1082
1083         USB_STOR_PRINTF("\nusb_read: dev %d startblk %lx, blccnt %lx"
1084                         " buffer %lx\n", device, start, blks, buf_addr);
1085
1086         do {
1087                 /* XXX need some comment here */
1088                 retry = 2;
1089                 srb->pdata = (unsigned char *)buf_addr;
1090                 if (blks > ss->max_xfer_blk)
1091                         smallblks = ss->max_xfer_blk;
1092                 else
1093                         smallblks = (unsigned short) blks;
1094 retry_it:
1095                 if (smallblks == ss->max_xfer_blk)
1096                         usb_show_progress();
1097                 srb->datalen = usb_dev_desc[device].blksz * smallblks;
1098                 srb->pdata = (unsigned char *)buf_addr;
1099                 if (usb_read_10(srb, ss, start, smallblks)) {
1100                         USB_STOR_PRINTF("Read ERROR\n");
1101                         usb_request_sense(srb, ss);
1102                         if (retry--)
1103                                 goto retry_it;
1104                         blkcnt -= blks;
1105                         break;
1106                 }
1107                 start += smallblks;
1108                 blks -= smallblks;
1109                 buf_addr += srb->datalen;
1110         } while (blks != 0);
1111
1112         USB_STOR_PRINTF("usb_read: end startblk %lx, blccnt %x buffer %lx\n",
1113                         start, smallblks, buf_addr);
1114
1115         usb_disable_asynch(0); /* asynch transfer allowed */
1116         if (blkcnt >= ss->max_xfer_blk)
1117                 debug("\n");
1118         return blkcnt;
1119 }
1120
1121 unsigned long usb_stor_write(int device, unsigned long blknr,
1122                                 unsigned long blkcnt, const void *buffer)
1123 {
1124         unsigned long start, blks, buf_addr;
1125         unsigned short smallblks;
1126         struct usb_device *dev;
1127         struct us_data *ss;
1128         int retry, i;
1129         ccb *srb = &usb_ccb;
1130
1131         if (blkcnt == 0)
1132                 return 0;
1133
1134         device &= 0xff;
1135         /* Setup  device */
1136         USB_STOR_PRINTF("\nusb_write: dev %d \n", device);
1137         dev = NULL;
1138         for (i = 0; i < USB_MAX_DEVICE; i++) {
1139                 dev = usb_get_dev_index(i);
1140                 if (dev == NULL)
1141                         return 0;
1142                 if (dev->devnum == usb_dev_desc[device].target)
1143                         break;
1144         }
1145         ss = (struct us_data *)dev->privptr;
1146
1147         usb_disable_asynch(1); /* asynch transfer not allowed */
1148
1149         srb->lun = usb_dev_desc[device].lun;
1150         buf_addr = (unsigned long)buffer;
1151         start = blknr;
1152         blks = blkcnt;
1153         if (usb_test_unit_ready(srb, ss)) {
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]);
1157                 return 0;
1158         }
1159
1160         USB_STOR_PRINTF("\nusb_write: dev %d startblk %lx, blccnt %lx"
1161                         " buffer %lx\n", device, start, blks, buf_addr);
1162
1163         do {
1164                 /* If write fails retry for max retry count else
1165                  * return with number of blocks written successfully.
1166                  */
1167                 retry = 2;
1168                 srb->pdata = (unsigned char *)buf_addr;
1169                 if (blks > ss->max_xfer_blk)
1170                         smallblks = ss->max_xfer_blk;
1171                 else
1172                         smallblks = (unsigned short) blks;
1173 retry_it:
1174                 if (smallblks == ss->max_xfer_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, ss, start, smallblks)) {
1179                         USB_STOR_PRINTF("Write ERROR\n");
1180                         usb_request_sense(srb, ss);
1181                         if (retry--)
1182                                 goto retry_it;
1183                         blkcnt -= blks;
1184                         break;
1185                 }
1186                 start += smallblks;
1187                 blks -= smallblks;
1188                 buf_addr += srb->datalen;
1189         } while (blks != 0);
1190
1191         USB_STOR_PRINTF("usb_write: end startblk %lx, blccnt %x buffer %lx\n",
1192                         start, smallblks, buf_addr);
1193
1194         usb_disable_asynch(0); /* asynch transfer allowed */
1195         if (blkcnt >= ss->max_xfer_blk)
1196                 debug("\n");
1197         return blkcnt;
1198
1199 }
1200
1201 /* Probe to see if a new device is actually a Storage device */
1202 int usb_storage_probe(struct usb_device *dev, unsigned int ifnum,
1203                       struct us_data *ss)
1204 {
1205         struct usb_interface *iface;
1206         int i;
1207         unsigned int flags = 0;
1208
1209         int protocol = 0;
1210         int subclass = 0;
1211
1212         /* let's examine the device now */
1213         iface = &dev->config.if_desc[ifnum];
1214
1215 #if 0
1216         /* this is the place to patch some storage devices */
1217         USB_STOR_PRINTF("iVendor %X iProduct %X\n", dev->descriptor.idVendor,
1218                         dev->descriptor.idProduct);
1219
1220         if ((dev->descriptor.idVendor) == 0x066b &&
1221             (dev->descriptor.idProduct) == 0x0103) {
1222                 USB_STOR_PRINTF("patched for E-USB\n");
1223                 protocol = US_PR_CB;
1224                 subclass = US_SC_UFI;       /* an assumption */
1225         }
1226 #endif
1227
1228         if (dev->descriptor.bDeviceClass != 0 ||
1229                         iface->desc.bInterfaceClass != USB_CLASS_MASS_STORAGE ||
1230                         iface->desc.bInterfaceSubClass < US_SC_MIN ||
1231                         iface->desc.bInterfaceSubClass > US_SC_MAX) {
1232                 /* if it's not a mass storage, we go no further */
1233                 return 0;
1234         }
1235
1236         memset(ss, 0, sizeof(struct us_data));
1237
1238         /* At this point, we know we've got a live one */
1239         USB_STOR_PRINTF("\n\nUSB Mass Storage device detected\n");
1240
1241         /* Initialize the us_data structure with some useful info */
1242         ss->flags = flags;
1243         ss->ifnum = ifnum;
1244         ss->pusb_dev = dev;
1245         ss->attention_done = 0;
1246
1247         /* If the device has subclass and protocol, then use that.  Otherwise,
1248          * take data from the specific interface.
1249          */
1250         if (subclass) {
1251                 ss->subclass = subclass;
1252                 ss->protocol = protocol;
1253         } else {
1254                 ss->subclass = iface->desc.bInterfaceSubClass;
1255                 ss->protocol = iface->desc.bInterfaceProtocol;
1256         }
1257
1258         /* set the handler pointers based on the protocol */
1259         USB_STOR_PRINTF("Transport: ");
1260         switch (ss->protocol) {
1261         case US_PR_CB:
1262                 USB_STOR_PRINTF("Control/Bulk\n");
1263                 ss->transport = usb_stor_CB_transport;
1264                 ss->transport_reset = usb_stor_CB_reset;
1265                 break;
1266
1267         case US_PR_CBI:
1268                 USB_STOR_PRINTF("Control/Bulk/Interrupt\n");
1269                 ss->transport = usb_stor_CB_transport;
1270                 ss->transport_reset = usb_stor_CB_reset;
1271                 break;
1272         case US_PR_BULK:
1273                 USB_STOR_PRINTF("Bulk/Bulk/Bulk\n");
1274                 ss->transport = usb_stor_BBB_transport;
1275                 ss->transport_reset = usb_stor_BBB_reset;
1276                 break;
1277         default:
1278                 printf("USB Storage Transport unknown / not yet implemented\n");
1279                 return 0;
1280                 break;
1281         }
1282
1283         /*
1284          * We are expecting a minimum of 2 endpoints - in and out (bulk).
1285          * An optional interrupt is OK (necessary for CBI protocol).
1286          * We will ignore any others.
1287          */
1288         for (i = 0; i < iface->desc.bNumEndpoints; i++) {
1289                 /* is it an BULK endpoint? */
1290                 if ((iface->ep_desc[i].bmAttributes &
1291                      USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
1292                         if (iface->ep_desc[i].bEndpointAddress & USB_DIR_IN)
1293                                 ss->ep_in = iface->ep_desc[i].bEndpointAddress &
1294                                         USB_ENDPOINT_NUMBER_MASK;
1295                         else
1296                                 ss->ep_out =
1297                                         iface->ep_desc[i].bEndpointAddress &
1298                                         USB_ENDPOINT_NUMBER_MASK;
1299                 }
1300
1301                 /* is it an interrupt endpoint? */
1302                 if ((iface->ep_desc[i].bmAttributes &
1303                     USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
1304                         ss->ep_int = iface->ep_desc[i].bEndpointAddress &
1305                                 USB_ENDPOINT_NUMBER_MASK;
1306                         ss->irqinterval = iface->ep_desc[i].bInterval;
1307                 }
1308         }
1309         USB_STOR_PRINTF("Endpoints In %d Out %d Int %d\n",
1310                   ss->ep_in, ss->ep_out, ss->ep_int);
1311
1312         /* Do some basic sanity checks, and bail if we find a problem */
1313         if (usb_set_interface(dev, iface->desc.bInterfaceNumber, 0) ||
1314             !ss->ep_in || !ss->ep_out ||
1315             (ss->protocol == US_PR_CBI && ss->ep_int == 0)) {
1316                 USB_STOR_PRINTF("Problems with device\n");
1317                 return 0;
1318         }
1319         /* set class specific stuff */
1320         /* We only handle certain protocols.  Currently, these are
1321          * the only ones.
1322          * The SFF8070 accepts the requests used in u-boot
1323          */
1324         if (ss->subclass != US_SC_UFI && ss->subclass != US_SC_SCSI &&
1325             ss->subclass != US_SC_8070) {
1326                 printf("Sorry, protocol %d not yet supported.\n", ss->subclass);
1327                 return 0;
1328         }
1329         if (ss->ep_int) {
1330                 /* we had found an interrupt endpoint, prepare irq pipe
1331                  * set up the IRQ pipe and handler
1332                  */
1333                 ss->irqinterval = (ss->irqinterval > 0) ? ss->irqinterval : 255;
1334                 ss->irqpipe = usb_rcvintpipe(ss->pusb_dev, ss->ep_int);
1335                 ss->irqmaxp = usb_maxpacket(dev, ss->irqpipe);
1336                 dev->irq_handle = usb_stor_irq;
1337         }
1338         dev->privptr = (void *)ss;
1339         return 1;
1340 }
1341
1342 int usb_stor_get_info(struct usb_device *dev, struct us_data *ss,
1343                       block_dev_desc_t *dev_desc)
1344 {
1345         unsigned char perq, modi;
1346         unsigned long cap[2];
1347         unsigned long *capacity, *blksz;
1348         ccb *pccb = &usb_ccb;
1349
1350         pccb->pdata = usb_stor_buf;
1351
1352         dev_desc->target = dev->devnum;
1353         pccb->lun = dev_desc->lun;
1354         USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1355
1356         if (usb_inquiry(pccb, ss))
1357                 return -1;
1358
1359         perq = usb_stor_buf[0];
1360         modi = usb_stor_buf[1];
1361
1362         if ((perq & 0x1f) == 0x1f) {
1363                 /* skip unknown devices */
1364                 return 0;
1365         }
1366         if ((modi&0x80) == 0x80) {
1367                 /* drive is removable */
1368                 dev_desc->removable = 1;
1369         }
1370         memcpy(&dev_desc->vendor[0], &usb_stor_buf[8], 8);
1371         memcpy(&dev_desc->product[0], &usb_stor_buf[16], 16);
1372         memcpy(&dev_desc->revision[0], &usb_stor_buf[32], 4);
1373         dev_desc->vendor[8] = 0;
1374         dev_desc->product[16] = 0;
1375         dev_desc->revision[4] = 0;
1376 #ifdef CONFIG_USB_BIN_FIXUP
1377         usb_bin_fixup(dev->descriptor, (uchar *)dev_desc->vendor,
1378                       (uchar *)dev_desc->product);
1379 #endif /* CONFIG_USB_BIN_FIXUP */
1380         USB_STOR_PRINTF("ISO Vers %X, Response Data %X\n", usb_stor_buf[2],
1381                         usb_stor_buf[3]);
1382         if (usb_test_unit_ready(pccb, ss)) {
1383                 printf("Device NOT ready\n"
1384                        "   Request Sense returned %02X %02X %02X\n",
1385                        pccb->sense_buf[2], pccb->sense_buf[12],
1386                        pccb->sense_buf[13]);
1387                 if (dev_desc->removable == 1) {
1388                         dev_desc->type = perq;
1389                         return 1;
1390                 }
1391                 return 0;
1392         }
1393         pccb->pdata = (unsigned char *)&cap[0];
1394         memset(pccb->pdata, 0, 8);
1395         if (usb_read_capacity(pccb, ss) != 0) {
1396                 printf("READ_CAP ERROR\n");
1397                 cap[0] = 2880;
1398                 cap[1] = 0x200;
1399         }
1400         USB_STOR_PRINTF("Read Capacity returns: 0x%lx, 0x%lx\n", cap[0],
1401                         cap[1]);
1402 #if 0
1403         if (cap[0] > (0x200000 * 10)) /* greater than 10 GByte */
1404                 cap[0] >>= 16;
1405 #endif
1406         cap[0] = cpu_to_be32(cap[0]);
1407         cap[1] = cpu_to_be32(cap[1]);
1408
1409         /* this assumes bigendian! */
1410         cap[0] += 1;
1411         capacity = &cap[0];
1412         blksz = &cap[1];
1413         USB_STOR_PRINTF("Capacity = 0x%lx, blocksz = 0x%lx\n",
1414                         *capacity, *blksz);
1415         dev_desc->lba = *capacity;
1416         dev_desc->blksz = *blksz;
1417         dev_desc->type = perq;
1418         USB_STOR_PRINTF(" address %d\n", dev_desc->target);
1419         USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1420
1421         /*
1422          * The U-Boot EHCI driver cannot handle more than 4096 * 5 bytes in a
1423          * transfer without running itself out of qt_buffers.
1424          */
1425         ss->max_xfer_blk = (4096 * 5) / dev_desc->blksz;
1426
1427         init_part(dev_desc);
1428
1429         USB_STOR_PRINTF("partype: %d\n", dev_desc->part_type);
1430         return 1;
1431 }