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