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