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