usbms.c 21.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/* usbms.c - USB Mass Storage Support.  */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2008  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <grub/dl.h>
#include <grub/mm.h>
#include <grub/usb.h>
#include <grub/scsi.h>
#include <grub/scsicmd.h>
#include <grub/misc.h>

27 28
GRUB_MOD_LICENSE ("GPLv3+");

29 30
#define GRUB_USBMS_DIRECTION_BIT	7

starous's avatar
starous committed
31 32 33 34 35 36
/* Length of CBI command should be always 12 bytes */
#define GRUB_USBMS_CBI_CMD_SIZE         12
/* CBI class-specific USB request ADSC - it sends CBI (scsi) command to
 * device in DATA stage */
#define GRUB_USBMS_CBI_ADSC_REQ         0x00

37 38 39 40 41 42 43 44 45 46
/* The USB Mass Storage Command Block Wrapper.  */
struct grub_usbms_cbw
{
  grub_uint32_t signature;
  grub_uint32_t tag;
  grub_uint32_t transfer_length;
  grub_uint8_t flags;
  grub_uint8_t lun;
  grub_uint8_t length;
  grub_uint8_t cbwcb[16];
47
} GRUB_PACKED;
48 49 50 51 52 53 54

struct grub_usbms_csw
{
  grub_uint32_t signature;
  grub_uint32_t tag;
  grub_uint32_t residue;
  grub_uint8_t status;
55
} GRUB_PACKED;
56 57 58 59 60 61 62

struct grub_usbms_dev
{
  struct grub_usb_device *dev;

  int luns;

63
  int config;
64 65 66 67
  int interface;
  struct grub_usb_desc_endp *in;
  struct grub_usb_desc_endp *out;

starous's avatar
starous committed
68 69 70
  int subclass;
  int protocol;
  struct grub_usb_desc_endp *intrpt;
71 72 73
};
typedef struct grub_usbms_dev *grub_usbms_dev_t;

74 75 76
/* FIXME: remove limit.  */
#define MAX_USBMS_DEVICES 128
static grub_usbms_dev_t grub_usbms_devices[MAX_USBMS_DEVICES];
77
static int first_available_slot = 0;
78

79
static grub_usb_err_t
starous's avatar
starous committed
80 81 82 83 84 85 86 87 88
grub_usbms_cbi_cmd (grub_usb_device_t dev, int interface,
                    grub_uint8_t *cbicb)
{
  return grub_usb_control_msg (dev,
                               GRUB_USB_REQTYPE_CLASS_INTERFACE_OUT,
                               GRUB_USBMS_CBI_ADSC_REQ, 0, interface,
                               GRUB_USBMS_CBI_CMD_SIZE, (char*)cbicb);
}

89
static grub_usb_err_t
starous's avatar
starous committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
grub_usbms_cbi_reset (grub_usb_device_t dev, int interface)
{
  /* Prepare array with Command Block Reset (=CBR) */
  /* CBI specific communication reset command should be send to device
   * via CBI USB class specific request ADCS */
  struct grub_cbi_reset
    {
      grub_uint8_t opcode; /* 0x1d = SEND DIAGNOSTIC */
      grub_uint8_t lun; /* 7-5 LUN, 4-0 flags - for CBR always = 0x04 */
      grub_uint8_t pad[10];
      /* XXX: There is collision between CBI and UFI specifications:
       *      CBI says 0xff, UFI says 0x00 ... probably it does
       *      not matter ... (?) */
    } cbicb = { 0x1d, 0x04,
                { 0xff, 0xff, 0xff, 0xff, 0xff,
                  0xff, 0xff, 0xff, 0xff, 0xff }
              };
  
  return grub_usbms_cbi_cmd (dev, interface, (grub_uint8_t *)&cbicb);
}

111
static grub_usb_err_t
starous's avatar
starous committed
112
grub_usbms_bo_reset (grub_usb_device_t dev, int interface)
113
{
114
  return grub_usb_control_msg (dev, 0x21, 255, 0, interface, 0, 0);
115 116
}

117
static grub_usb_err_t
starous's avatar
starous committed
118 119 120 121 122 123 124 125
grub_usbms_reset (grub_usbms_dev_t dev)
{
  if (dev->protocol == GRUB_USBMS_PROTOCOL_BULK)
    return grub_usbms_bo_reset (dev->dev, dev->interface);
  else
    return grub_usbms_cbi_reset (dev->dev, dev->interface);
}

126
static void
127
grub_usbms_detach (grub_usb_device_t usbdev, int config, int interface)
128
{
129 130 131 132 133 134 135 136 137 138
  unsigned i;
  for (i = 0; i < ARRAY_SIZE (grub_usbms_devices); i++)
    if (grub_usbms_devices[i] && grub_usbms_devices[i]->dev == usbdev
	&& grub_usbms_devices[i]->interface == interface
	&& grub_usbms_devices[i]->config == config)
      {
	grub_free (grub_usbms_devices[i]);
	grub_usbms_devices[i] = 0;
      }
}
139

140 141 142 143 144 145 146 147
static int
grub_usbms_attach (grub_usb_device_t usbdev, int configno, int interfno)
{
  struct grub_usb_desc_if *interf
    = usbdev->config[configno].interf[interfno].descif;
  int j;
  grub_uint8_t luns = 0;
  unsigned curnum;
148
  grub_usb_err_t err = GRUB_USB_ERR_NONE;
149

150 151
  grub_boot_time ("Attaching USB mass storage");

152
  if (first_available_slot == ARRAY_SIZE (grub_usbms_devices))
153 154
    return 0;

155 156 157
  curnum = first_available_slot;
  first_available_slot++;

158 159 160 161 162 163 164 165
  interf = usbdev->config[configno].interf[interfno].descif;

  if ((interf->subclass != GRUB_USBMS_SUBCLASS_BULK
       /* Experimental support of RBC, MMC-2, UFI, SFF-8070i devices */
       && interf->subclass != GRUB_USBMS_SUBCLASS_RBC
       && interf->subclass != GRUB_USBMS_SUBCLASS_MMC2
       && interf->subclass != GRUB_USBMS_SUBCLASS_UFI 
       && interf->subclass != GRUB_USBMS_SUBCLASS_SFF8070 )
starous's avatar
starous committed
166 167 168
      || (interf->protocol != GRUB_USBMS_PROTOCOL_BULK
          && interf->protocol != GRUB_USBMS_PROTOCOL_CBI
          && interf->protocol != GRUB_USBMS_PROTOCOL_CB))
169 170 171 172 173 174 175 176
    return 0;

  grub_usbms_devices[curnum] = grub_zalloc (sizeof (struct grub_usbms_dev));
  if (! grub_usbms_devices[curnum])
    return 0;

  grub_usbms_devices[curnum]->dev = usbdev;
  grub_usbms_devices[curnum]->interface = interfno;
starous's avatar
starous committed
177 178
  grub_usbms_devices[curnum]->subclass = interf->subclass;
  grub_usbms_devices[curnum]->protocol = interf->protocol;
179

180
  grub_dprintf ("usbms", "alive\n");
181

182 183 184 185 186 187
  /* Iterate over all endpoints of this interface, at least a
     IN and OUT bulk endpoint are required.  */
  for (j = 0; j < interf->endpointcnt; j++)
    {
      struct grub_usb_desc_endp *endp;
      endp = &usbdev->config[0].interf[interfno].descendp[j];
188

189
      if ((endp->endp_addr & 128) && (endp->attrib & 3) == 2)
starous's avatar
starous committed
190 191
	/* Bulk IN endpoint.  */
	grub_usbms_devices[curnum]->in = endp;
192
      else if (!(endp->endp_addr & 128) && (endp->attrib & 3) == 2)
starous's avatar
starous committed
193 194 195 196 197
        /* Bulk OUT endpoint.  */
	grub_usbms_devices[curnum]->out = endp;
      else if ((endp->endp_addr & 128) && (endp->attrib & 3) == 3)
        /* Interrupt (IN) endpoint.  */
	grub_usbms_devices[curnum]->intrpt = endp;
198
    }
199

starous's avatar
starous committed
200 201 202
  if (!grub_usbms_devices[curnum]->in || !grub_usbms_devices[curnum]->out
      || ((grub_usbms_devices[curnum]->protocol == GRUB_USBMS_PROTOCOL_CBI)
          && !grub_usbms_devices[curnum]->intrpt))
203 204 205
    {
      grub_free (grub_usbms_devices[curnum]);
      grub_usbms_devices[curnum] = 0;
206 207
      return 0;
    }
208

209
  grub_dprintf ("usbms", "alive\n");
210

211 212 213 214
  /* XXX: Activate the first configuration.  */
  grub_usb_set_configuration (usbdev, 1);

  /* Query the amount of LUNs.  */
starous's avatar
starous committed
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
  if (grub_usbms_devices[curnum]->protocol == GRUB_USBMS_PROTOCOL_BULK)
    { /* Only Bulk only devices support Get Max LUN command */
      err = grub_usb_control_msg (usbdev, 0xA1, 254, 0, interfno, 1, (char *) &luns);
  		
      if (err)
        {
          /* In case of a stall, clear the stall.  */
          if (err == GRUB_USB_ERR_STALL)
	    {
	      grub_usb_clear_halt (usbdev, grub_usbms_devices[curnum]->in->endp_addr);
	      grub_usb_clear_halt (usbdev, grub_usbms_devices[curnum]->out->endp_addr);
	    }
          /* Just set the amount of LUNs to one.  */
          grub_errno = GRUB_ERR_NONE;
          grub_usbms_devices[curnum]->luns = 1;
        }
      else
        /* luns = 0 means one LUN with ID 0 present ! */
        /* We get from device not number of LUNs but highest
         * LUN number. LUNs are numbered from 0, 
         * i.e. number of LUNs is luns+1 ! */
        grub_usbms_devices[curnum]->luns = luns + 1;
237 238
    }
  else
starous's avatar
starous committed
239 240 241 242
    /* XXX: Does CBI devices support multiple LUNs ?
     * I.e., should we detect number of device's LUNs ? (How?) */
    grub_usbms_devices[curnum]->luns = 1;
    
243 244
  grub_dprintf ("usbms", "alive\n");

245 246
  usbdev->config[configno].interf[interfno].detach_hook = grub_usbms_detach;

247 248
  grub_boot_time ("Attached USB mass storage");

249 250 251 252 253 254 255 256 257 258 259 260 261 262
#if 0 /* All this part should be probably deleted.
       * This make trouble on some devices if they are not in
       * Phase Error state - and there they should be not in such state...
       * Bulk only mass storage reset procedure should be used only
       * on place and in time when it is really necessary. */
  /* Reset recovery procedure */
  /* Bulk-Only Mass Storage Reset, after the reset commands
     will be accepted.  */
  grub_usbms_reset (usbdev, i);
  grub_usb_clear_halt (usbdev, usbms->in->endp_addr);
  grub_usb_clear_halt (usbdev, usbms->out->endp_addr);
#endif

  return 1;
263 264 265 266 267
}



static int
268
grub_usbms_iterate (grub_scsi_dev_iterate_hook_t hook, void *hook_data,
269
		    grub_disk_pull_t pull)
270
{
271
  unsigned i;
272

273 274 275
  if (pull != GRUB_DISK_PULL_NONE)
    return 0;

276
  grub_usb_poll_devices (1);
277

278 279 280
  for (i = 0; i < ARRAY_SIZE (grub_usbms_devices); i++)
    if (grub_usbms_devices[i])
      {
281 282
	if (hook (GRUB_SCSI_SUBSYSTEM_USBMS, i, grub_usbms_devices[i]->luns,
		  hook_data))
283
	  return 1;
284
      }
285 286 287 288 289

  return 0;
}

static grub_err_t
starous's avatar
starous committed
290 291
grub_usbms_transfer_bo (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
		        grub_size_t size, char *buf, int read_write)
292 293 294 295 296
{
  struct grub_usbms_cbw cbw;
  grub_usbms_dev_t dev = (grub_usbms_dev_t) scsi->data;
  struct grub_usbms_csw status;
  static grub_uint32_t tag = 0;
297
  grub_usb_err_t err = GRUB_USB_ERR_NONE;
298
  grub_usb_err_t errCSW = GRUB_USB_ERR_NONE;
299
  int retrycnt = 3 + 1;
starous's avatar
starous committed
300
  
301 302
  tag++;

303
 retry:
304
  retrycnt--;
305
  if (retrycnt == 0)
306
    return grub_error (GRUB_ERR_IO, "USB Mass Storage stalled");
307 308 309

  /* Setup the request.  */
  grub_memset (&cbw, 0, sizeof (cbw));
310
  cbw.signature = grub_cpu_to_le32_compile_time (0x43425355);
311
  cbw.tag = tag;
312 313
  cbw.transfer_length = grub_cpu_to_le32 (size);
  cbw.flags = (!read_write) << GRUB_USBMS_DIRECTION_BIT;
314
  cbw.lun = scsi->lun; /* In USB MS CBW are LUN bits on another place than in SCSI CDB, both should be set correctly. */
315 316
  cbw.length = cmdsize;
  grub_memcpy (cbw.cbwcb, cmd, cmdsize);
317 318 319 320 321 322 323 324 325 326 327 328 329 330
  
  /* Debug print of CBW content. */
  grub_dprintf ("usb", "CBW: sign=0x%08x tag=0x%08x len=0x%08x\n",
  	cbw.signature, cbw.tag, cbw.transfer_length);
  grub_dprintf ("usb", "CBW: flags=0x%02x lun=0x%02x CB_len=0x%02x\n",
  	cbw.flags, cbw.lun, cbw.length);
  grub_dprintf ("usb", "CBW: cmd:\n %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
  	cbw.cbwcb[ 0], cbw.cbwcb[ 1], cbw.cbwcb[ 2], cbw.cbwcb[ 3],
  	cbw.cbwcb[ 4], cbw.cbwcb[ 5], cbw.cbwcb[ 6], cbw.cbwcb[ 7],
  	cbw.cbwcb[ 8], cbw.cbwcb[ 9], cbw.cbwcb[10], cbw.cbwcb[11],
  	cbw.cbwcb[12], cbw.cbwcb[13], cbw.cbwcb[14], cbw.cbwcb[15]);

  /* Write the request.
   * XXX: Error recovery is maybe still not fully correct. */
331
  err = grub_usb_bulk_write (dev->dev, dev->out,
332 333 334 335 336 337
			     sizeof (cbw), (char *) &cbw);
  if (err)
    {
      if (err == GRUB_USB_ERR_STALL)
	{
	  grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
338
	  goto CheckCSW;
339
	}
340
      goto retry;
341 342
    }

343 344
  /* Read/write the data, (maybe) according to specification.  */
  if (size && (read_write == 0))
345
    {
346
      err = grub_usb_bulk_read (dev->dev, dev->in, size, buf);
347
      grub_dprintf ("usb", "read: %d %d\n", err, GRUB_USB_ERR_STALL); 
348 349 350 351 352 353
      if (err)
        {
          if (err == GRUB_USB_ERR_STALL)
	    grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
          goto CheckCSW;
        }
354
      /* Debug print of received data. */
355 356 357 358 359 360 361 362 363
      grub_dprintf ("usb", "buf:\n");
      if (size <= 64)
	{
	  unsigned i;
	  for (i = 0; i < size; i++)
	    grub_dprintf ("usb", "0x%02x: 0x%02x\n", i, buf[i]);
	}
      else
          grub_dprintf ("usb", "Too much data for debug print...\n");
364
    }
365
  else if (size)
366
    {
367
      err = grub_usb_bulk_write (dev->dev, dev->out, size, buf);
368
      grub_dprintf ("usb", "write: %d %d\n", err, GRUB_USB_ERR_STALL);
369 370 371 372 373
      grub_dprintf ("usb", "First 16 bytes of sent data:\n %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
  	buf[ 0], buf[ 1], buf[ 2], buf[ 3],
  	buf[ 4], buf[ 5], buf[ 6], buf[ 7],
  	buf[ 8], buf[ 9], buf[10], buf[11],
  	buf[12], buf[13], buf[14], buf[15]);
374 375 376 377 378 379
      if (err)
        {
          if (err == GRUB_USB_ERR_STALL)
	    grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
          goto CheckCSW;
        }
380 381 382 383 384 385 386 387 388
      /* Debug print of sent data. */
      if (size <= 256)
	{
	  unsigned i;
	  for (i=0; i<size; i++)
	    grub_dprintf ("usb", "0x%02x: 0x%02x\n", i, buf[i]);
	}
      else
          grub_dprintf ("usb", "Too much data for debug print...\n");
389 390
    }

391 392
  /* Read the status - (maybe) according to specification.  */
CheckCSW:
393
  errCSW = grub_usb_bulk_read (dev->dev, dev->in,
394
		    sizeof (status), (char *) &status);
395
  if (errCSW)
396
    {
397
      grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
398
      errCSW = grub_usb_bulk_read (dev->dev, dev->in,
399
			        sizeof (status), (char *) &status);
400
      if (errCSW)
401
        { /* Bulk-only reset device. */
402
          grub_dprintf ("usb", "Bulk-only reset device - errCSW\n");
starous's avatar
starous committed
403
          grub_usbms_reset (dev);
404 405
          grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
          grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
406
	  goto retry;
407
        }
408 409
    }

410 411 412 413 414
  /* Debug print of CSW content. */
  grub_dprintf ("usb", "CSW: sign=0x%08x tag=0x%08x resid=0x%08x\n",
  	status.signature, status.tag, status.residue);
  grub_dprintf ("usb", "CSW: status=0x%02x\n", status.status);
  
415 416
  /* If phase error or not valid signature, do bulk-only reset device. */
  if ((status.status == 2) ||
417
      (status.signature != grub_cpu_to_le32_compile_time(0x53425355)))
418 419
    { /* Bulk-only reset device. */
      grub_dprintf ("usb", "Bulk-only reset device - bad status\n");
starous's avatar
starous committed
420
      grub_usbms_reset (dev);
421 422 423
      grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
      grub_usb_clear_halt (dev->dev, dev->out->endp_addr);

424
      goto retry;
425 426
    }

427 428
  /* If "command failed" status or data transfer failed -> error */
  if ((status.status || err) && !read_write)
429 430
    return grub_error (GRUB_ERR_READ_ERROR,
		       "error communication with USB Mass Storage device");
431 432 433
  else if ((status.status || err) && read_write)
    return grub_error (GRUB_ERR_WRITE_ERROR,
		       "error communication with USB Mass Storage device");
434 435 436 437

  return GRUB_ERR_NONE;
}

starous's avatar
starous committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
static grub_err_t
grub_usbms_transfer_cbi (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
		        grub_size_t size, char *buf, int read_write)
{
  grub_usbms_dev_t dev = (grub_usbms_dev_t) scsi->data;
  int retrycnt = 3 + 1;
  grub_usb_err_t err = GRUB_USB_ERR_NONE;
  grub_uint8_t cbicb[GRUB_USBMS_CBI_CMD_SIZE];
  grub_uint16_t status;
  
 retry:
  retrycnt--;
  if (retrycnt == 0)
    return grub_error (GRUB_ERR_IO, "USB Mass Storage CBI failed");

  /* Setup the request.  */
  grub_memset (cbicb, 0, sizeof (cbicb));
  grub_memcpy (cbicb, cmd,
               cmdsize >= GRUB_USBMS_CBI_CMD_SIZE
                 ? GRUB_USBMS_CBI_CMD_SIZE
                 : cmdsize);
  
  /* Debug print of CBIcb content. */
  grub_dprintf ("usb", "cbicb:\n %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
  	cbicb[ 0], cbicb[ 1], cbicb[ 2], cbicb[ 3],
  	cbicb[ 4], cbicb[ 5], cbicb[ 6], cbicb[ 7],
  	cbicb[ 8], cbicb[ 9], cbicb[10], cbicb[11]);

  /* Write the request.
   * XXX: Error recovery is maybe not correct. */
  err = grub_usbms_cbi_cmd (dev->dev, dev->interface, cbicb);
  if (err)
    {
      grub_dprintf ("usb", "CBI cmdcb setup err=%d\n", err);
      if (err == GRUB_USB_ERR_STALL)
	{
	  /* Stall in this place probably means bad or unsupported
	   * command, so we will not try it again. */
         return grub_error (GRUB_ERR_IO, "USB Mass Storage CBI request failed");
	}
      else if (dev->protocol == GRUB_USBMS_PROTOCOL_CBI)
        {
          /* Try to get status from interrupt pipe */
481
          err = grub_usb_bulk_read (dev->dev, dev->intrpt,
starous's avatar
starous committed
482 483 484 485 486 487 488 489 490 491
                                    2, (char*)&status);
          grub_dprintf ("usb", "CBI cmdcb setup status: err=%d, status=0x%x\n", err, status);
        }
        /* Any other error could be transport problem, try it again */
        goto retry;
    }

  /* Read/write the data, (maybe) according to specification.  */
  if (size && (read_write == 0))
    {
492
      err = grub_usb_bulk_read (dev->dev, dev->in, size, buf);
starous's avatar
starous committed
493 494 495 496 497 498 499 500 501 502
      grub_dprintf ("usb", "read: %d\n", err); 
      if (err)
        {
          if (err == GRUB_USB_ERR_STALL)
            grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
          goto retry;
        }
    }
  else if (size)
    {
503
      err = grub_usb_bulk_write (dev->dev, dev->out, size, buf);
starous's avatar
starous committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
      grub_dprintf ("usb", "write: %d\n", err);
      if (err)
        {
          if (err == GRUB_USB_ERR_STALL)
	    grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
          goto retry;
        }
    }

  /* XXX: It is not clear to me yet, how to check status of CBI
   * data transfer on devices without interrupt pipe.
   * AFAIK there is probably no status phase to indicate possibly
   * bad transported data.
   * Maybe we should do check on higher level, i.e. issue RequestSense
   * command (we do it already in scsi.c) and check returned values
   * (we do not it yet) - ? */
  if (dev->protocol == GRUB_USBMS_PROTOCOL_CBI)
    { /* Check status in interrupt pipe */
522
      err = grub_usb_bulk_read (dev->dev, dev->intrpt,
starous's avatar
starous committed
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
                                2, (char*)&status);
      grub_dprintf ("usb", "read status: %d\n", err);
      if (err)
        {
          /* Try to reset device, because it is probably not standard
           * situation */
          grub_usbms_reset (dev);
          grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
          grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
          grub_usb_clear_halt (dev->dev, dev->intrpt->endp_addr);
          goto retry;
        }
      if (dev->subclass == GRUB_USBMS_SUBCLASS_UFI)
        {
          /* These devices should return bASC and bASCQ */
          if (status != 0)
            /* Some error, currently we don't care what it is... */
            goto retry;
        }
      else if (dev->subclass == GRUB_USBMS_SUBCLASS_RBC)
        {
          /* XXX: I don't understand what returns RBC subclass devices,
           * so I don't check it - maybe somebody helps ? */
        }
      else
        {
          /* Any other device should return bType = 0 and some bValue */
          if (status & 0xff)
            return grub_error (GRUB_ERR_IO, "USB Mass Storage CBI status type != 0");
          status = (status & 0x0300) >> 8;
          switch (status)
            {
              case 0 : /* OK */
                break;
              case 1 : /* Fail */
                goto retry;
                break;
              case 2 : /* Phase error */
              case 3 : /* Persistent Failure */
                grub_dprintf ("usb", "CBI reset device - phase error or persistent failure\n");
                grub_usbms_reset (dev);
                grub_usb_clear_halt (dev->dev, dev->in->endp_addr);
                grub_usb_clear_halt (dev->dev, dev->out->endp_addr);
                grub_usb_clear_halt (dev->dev, dev->intrpt->endp_addr);
                goto retry;
                break;
            }
        }
    }
572 573 574

  if (err)
    return grub_error (GRUB_ERR_IO, "USB error %d", err);
starous's avatar
starous committed
575
    
576
  return GRUB_ERR_NONE;
starous's avatar
starous committed
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
}


static grub_err_t
grub_usbms_transfer (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
		        grub_size_t size, char *buf, int read_write)
{
  grub_usbms_dev_t dev = (grub_usbms_dev_t) scsi->data;

  if (dev->protocol == GRUB_USBMS_PROTOCOL_BULK)
    return grub_usbms_transfer_bo (scsi, cmdsize, cmd, size, buf,
                                   read_write);
  else
    return grub_usbms_transfer_cbi (scsi, cmdsize, cmd, size, buf,
                                    read_write);
}
593 594 595 596 597

static grub_err_t
grub_usbms_read (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
		 grub_size_t size, char *buf)
{
598
  return grub_usbms_transfer (scsi, cmdsize, cmd, size, buf, 0);
599 600 601 602
}

static grub_err_t
grub_usbms_write (struct grub_scsi *scsi, grub_size_t cmdsize, char *cmd,
603
		  grub_size_t size, const char *buf)
604
{
605
  return grub_usbms_transfer (scsi, cmdsize, cmd, size, (char *) buf, 1);
606 607 608
}

static grub_err_t
609
grub_usbms_open (int id, int devnum, struct grub_scsi *scsi)
610
{
611 612 613 614
  if (id != GRUB_SCSI_SUBSYSTEM_USBMS)
    return grub_error (GRUB_ERR_UNKNOWN_DEVICE,
		       "not USB Mass Storage device");

615 616
  if (!grub_usbms_devices[devnum])
    grub_usb_poll_devices (1);
617

618 619
  if (!grub_usbms_devices[devnum])
    return grub_error (GRUB_ERR_UNKNOWN_DEVICE,
620
		       "unknown USB Mass Storage device");
621

622 623
  scsi->data = grub_usbms_devices[devnum];
  scsi->luns = grub_usbms_devices[devnum]->luns;
624

625
  return GRUB_ERR_NONE;
626 627 628 629 630 631 632 633
}

static struct grub_scsi_dev grub_usbms_dev =
  {
    .iterate = grub_usbms_iterate,
    .open = grub_usbms_open,
    .read = grub_usbms_read,
    .write = grub_usbms_write
634
  };
635

636
static struct grub_usb_attach_desc attach_hook =
637 638 639 640 641
{
  .class = GRUB_USB_CLASS_MASS_STORAGE,
  .hook = grub_usbms_attach
};

642 643
GRUB_MOD_INIT(usbms)
{
644
  grub_usb_register_attach_hook_class (&attach_hook);
645 646 647 648 649
  grub_scsi_dev_register (&grub_usbms_dev);
}

GRUB_MOD_FINI(usbms)
{
650 651 652 653 654 655 656 657 658
  unsigned i;
  for (i = 0; i < ARRAY_SIZE (grub_usbms_devices); i++)
    {
      grub_usbms_devices[i]->dev->config[grub_usbms_devices[i]->config]
	.interf[grub_usbms_devices[i]->interface].detach_hook = 0;
      grub_usbms_devices[i]->dev->config[grub_usbms_devices[i]->config]
	.interf[grub_usbms_devices[i]->interface].attached = 0;
    }
  grub_usb_unregister_attach_hook_class (&attach_hook);
659 660
  grub_scsi_dev_unregister (&grub_usbms_dev);
}