common/usb_storage.c

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