src/usb-msc.c

   1 // Code for handling USB Mass Storage Controller devices.
   2 //
   3 // Copyright (C) 2010  Kevin O'Connor <kevin@koconnor.net>
   4 //
   5 // This file may be distributed under the terms of the GNU LGPLv3 license.
   6
   7 #include "util.h" // dprintf
   8 #include "config.h" // CONFIG_USB_MSC
   9 #include "usb-msc.h" // usb_msc_init
  10 #include "usb.h" // struct usb_s
  11 #include "biosvar.h" // GET_GLOBAL
  12 #include "blockcmd.h" // cdb_read
  13 #include "disk.h" // DTYPE_USB
  14 #include "boot.h" // boot_add_hd
  15
  16 struct usbdrive_s {
  17     struct drive_s drive;
  18     struct usb_pipe *bulkin, *bulkout;
  19 };
  20
  21
  22 /****************************************************************
  23  * Bulk-only drive command processing
  24  ****************************************************************/
  25
  26 #define USB_CDB_SIZE 12
  27
  28 #define CBW_SIGNATURE 0x43425355 // USBC
  29
  30 struct cbw_s {
  31     u32 dCBWSignature;
  32     u32 dCBWTag;
  33     u32 dCBWDataTransferLength;
  34     u8 bmCBWFlags;
  35     u8 bCBWLUN;
  36     u8 bCBWCBLength;
  37     u8 CBWCB[16];
  38 } PACKED;
  39
  40 #define CSW_SIGNATURE 0x53425355 // USBS
  41
  42 struct csw_s {
  43     u32 dCSWSignature;
  44     u32 dCSWTag;
  45     u32 dCSWDataResidue;
  46     u8 bCSWStatus;
  47 } PACKED;
  48
  49 static int
  50 usb_msc_send(struct usbdrive_s *udrive_g, int dir, void *buf, u32 bytes)
  51 {
  52     struct usb_pipe *pipe;
  53     if (dir == USB_DIR_OUT)
  54         pipe = GET_GLOBAL(udrive_g->bulkout);
  55     else
  56         pipe = GET_GLOBAL(udrive_g->bulkin);
  57     return usb_send_bulk(pipe, dir, buf, bytes);
  58 }
  59
  60 // Low-level usb command transmit function.
  61 int
  62 usb_cmd_data(struct disk_op_s *op, void *cdbcmd, u16 blocksize)
  63 {
  64     if (!CONFIG_USB_MSC)
  65         return 0;
  66
  67     dprintf(16, "usb_cmd_data id=%p write=%d count=%d bs=%d buf=%p\n"
  68             , op->drive_g, 0, op->count, blocksize, op->buf_fl);
  69     struct usbdrive_s *udrive_g = container_of(
  70         op->drive_g, struct usbdrive_s, drive);
  71
  72     // Setup command block wrapper.
  73     u32 bytes = blocksize * op->count;
  74     struct cbw_s cbw;
  75     memset(&cbw, 0, sizeof(cbw));
  76     memcpy(cbw.CBWCB, cdbcmd, USB_CDB_SIZE);
  77     cbw.dCBWSignature = CBW_SIGNATURE;
  78     cbw.dCBWTag = 999; // XXX
  79     cbw.dCBWDataTransferLength = bytes;
  80     cbw.bmCBWFlags = (cbw.CBWCB[0] == CDB_CMD_WRITE_10) ? USB_DIR_OUT : USB_DIR_IN;
  81     cbw.bCBWLUN = 0; // XXX
  82     cbw.bCBWCBLength = USB_CDB_SIZE;
  83
  84     // Transfer cbw to device.
  85     int ret = usb_msc_send(udrive_g, USB_DIR_OUT
  86                             , MAKE_FLATPTR(GET_SEG(SS), &cbw), sizeof(cbw));
  87     if (ret)
  88         goto fail;
  89
  90     // Transfer data to/from device.
  91     if (bytes) {
  92         ret = usb_msc_send(udrive_g, cbw.bmCBWFlags, op->buf_fl, bytes);
  93         if (ret)
  94             goto fail;
  95     }
  96
  97     // Transfer csw info.
  98     struct csw_s csw;
  99     ret = usb_msc_send(udrive_g, USB_DIR_IN
 100                         , MAKE_FLATPTR(GET_SEG(SS), &csw), sizeof(csw));
 101     if (ret)
 102         goto fail;
 103
 104     if (!csw.bCSWStatus)
 105         return DISK_RET_SUCCESS;
 106     if (csw.bCSWStatus == 2)
 107         goto fail;
 108
 109     if (blocksize)
 110         op->count -= csw.dCSWDataResidue / blocksize;
 111     return DISK_RET_EBADTRACK;
 112
 113 fail:
 114     // XXX - reset connection
 115     dprintf(1, "USB transmission failed\n");
 116     op->count = 0;
 117     return DISK_RET_EBADTRACK;
 118 }
 119
 120
 121 /****************************************************************
 122  * Drive ops
 123  ****************************************************************/
 124
 125 // 16bit command demuxer for ATAPI cdroms.
 126 int
 127 process_usb_op(struct disk_op_s *op)
 128 {
 129     if (!CONFIG_USB_MSC)
 130         return 0;
 131     switch (op->command) {
 132     case CMD_READ:
 133         return cdb_read(op);
 134     case CMD_WRITE:
 135         return cdb_write(op);
 136     case CMD_FORMAT:
 137     case CMD_RESET:
 138     case CMD_ISREADY:
 139     case CMD_VERIFY:
 140     case CMD_SEEK:
 141         return DISK_RET_SUCCESS;
 142     default:
 143         op->count = 0;
 144         return DISK_RET_EPARAM;
 145     }
 146 }
 147
 148
 149 /****************************************************************
 150  * Setup
 151  ****************************************************************/
 152
 153 static int
 154 setup_drive_cdrom(struct drive_s *drive, char *desc)
 155 {
 156     drive->sectors = (u64)-1;
 157     struct usb_pipe *pipe = container_of(
 158         drive, struct usbdrive_s, drive)->bulkout;
 159     int prio = bootprio_find_usb(pipe->cntl->pci, pipe->path);
 160     boot_add_cd(drive, desc, prio);
 161     return 0;
 162 }
 163
 164 static int
 165 setup_drive_hd(struct drive_s *drive, char *desc)
 166 {
 167     if (drive->blksize != DISK_SECTOR_SIZE) {
 168         dprintf(1, "Unsupported USB MSC block size %d\n", drive->blksize);
 169         return -1;
 170     }
 171
 172     // Register with bcv system.
 173     struct usb_pipe *pipe = container_of(
 174         drive, struct usbdrive_s, drive)->bulkout;
 175     int prio = bootprio_find_usb(pipe->cntl->pci, pipe->path);
 176     boot_add_hd(drive, desc, prio);
 177     return 0;
 178 }
 179
 180 // Configure a usb msc device.
 181 int
 182 usb_msc_init(struct usb_pipe *pipe
 183              , struct usb_interface_descriptor *iface, int imax)
 184 {
 185     if (!CONFIG_USB_MSC)
 186         return -1;
 187
 188     // Verify right kind of device
 189     if ((iface->bInterfaceSubClass != US_SC_SCSI &&
 190          iface->bInterfaceSubClass != US_SC_ATAPI_8070 &&
 191          iface->bInterfaceSubClass != US_SC_ATAPI_8020)
 192         || iface->bInterfaceProtocol != US_PR_BULK) {
 193         dprintf(1, "Unsupported MSC USB device (subclass=%02x proto=%02x)\n"
 194                 , iface->bInterfaceSubClass, iface->bInterfaceProtocol);
 195         return -1;
 196     }
 197
 198     // Allocate drive structure.
 199     struct usbdrive_s *udrive_g = malloc_fseg(sizeof(*udrive_g));
 200     if (!udrive_g) {
 201         warn_noalloc();
 202         goto fail;
 203     }
 204     memset(udrive_g, 0, sizeof(*udrive_g));
 205     udrive_g->drive.type = DTYPE_USB;
 206
 207     // Find bulk in and bulk out endpoints.
 208     struct usb_endpoint_descriptor *indesc = findEndPointDesc(
 209         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_IN);
 210     struct usb_endpoint_descriptor *outdesc = findEndPointDesc(
 211         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT);
 212     if (!indesc || !outdesc)
 213         goto fail;
 214     udrive_g->bulkin = alloc_bulk_pipe(pipe, indesc);
 215     udrive_g->bulkout = alloc_bulk_pipe(pipe, outdesc);
 216     if (!udrive_g->bulkin || !udrive_g->bulkout)
 217         goto fail;
 218
 219     // Validate drive and find block size and sector count.
 220     struct disk_op_s dop;
 221     memset(&dop, 0, sizeof(dop));
 222     dop.drive_g = &udrive_g->drive;
 223     struct cdbres_inquiry data;
 224     int ret = cdb_get_inquiry(&dop, &data);
 225     if (ret)
 226         goto fail;
 227     char vendor[sizeof(data.vendor)+1], product[sizeof(data.product)+1];
 228     char rev[sizeof(data.rev)+1];
 229     strtcpy(vendor, data.vendor, sizeof(vendor));
 230     nullTrailingSpace(vendor);
 231     strtcpy(product, data.product, sizeof(product));
 232     nullTrailingSpace(product);
 233     strtcpy(rev, data.rev, sizeof(rev));
 234     nullTrailingSpace(rev);
 235     int pdt = data.pdt & 0x1f;
 236     int removable = !!(data.removable & 0x80);
 237     dprintf(1, "USB MSC vendor='%s' product='%s' rev='%s' type=%d removable=%d\n"
 238             , vendor, product, rev, pdt, removable);
 239     udrive_g->drive.removable = removable;
 240
 241     if (pdt == SCSI_TYPE_CDROM) {
 242         char *desc = znprintf(MAXDESCSIZE, "DVD/CD [USB Drive %s %s %s]"
 243                               , vendor, product, rev);
 244         ret = setup_drive_cdrom(&udrive_g->drive, desc);
 245     } else {
 246         struct cdbres_read_capacity capdata;
 247         ret = cdb_read_capacity(&dop, &capdata);
 248         if (ret)
 249             return ret;
 250         // XXX - retry for some timeout?
 251
 252         // READ CAPACITY returns the address of the last block
 253         udrive_g->drive.blksize = ntohl(capdata.blksize);
 254         udrive_g->drive.sectors = ntohl(capdata.sectors) + 1;
 255         dprintf(1, "USB MSC blksize=%d sectors=%d\n",
 256                 udrive_g->drive.blksize, (int)udrive_g->drive.sectors);
 257
 258         char *desc = znprintf(MAXDESCSIZE, "USB Drive %s %s %s"
 259                               , vendor, product, rev);
 260         ret = setup_drive_hd(&udrive_g->drive, desc);
 261     }
 262     if (ret)
 263         goto fail;
 264
 265     return 0;
 266 fail:
 267     dprintf(1, "Unable to configure USB MSC device.\n");
 268     free(udrive_g);
 269     return -1;
 270 }