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