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" // add_bcv_internal
  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 // Low-level usb command transmit function.
  50 int
  51 usb_cmd_data(struct disk_op_s *op, void *cdbcmd, u16 blocksize)
  52 {
  53     dprintf(16, "usb_cmd_data id=%p write=%d count=%d bs=%d buf=%p\n"
  54             , op->drive_g, 0, op->count, blocksize, op->buf_fl);
  55     struct usbdrive_s *udrive_g = container_of(
  56         op->drive_g, struct usbdrive_s, drive);
  57     struct usb_pipe *bulkin = GET_GLOBAL(udrive_g->bulkin);
  58     struct usb_pipe *bulkout = GET_GLOBAL(udrive_g->bulkout);
  59
  60     // Setup command block wrapper.
  61     u32 bytes = blocksize * op->count;
  62     struct cbw_s cbw;
  63     memset(&cbw, 0, sizeof(cbw));
  64     cbw.dCBWSignature = CBW_SIGNATURE;
  65     cbw.dCBWTag = 999; // XXX
  66     cbw.dCBWDataTransferLength = bytes;
  67     cbw.bmCBWFlags = USB_DIR_IN; // XXX
  68     cbw.bCBWLUN = 0; // XXX
  69     cbw.bCBWCBLength = USB_CDB_SIZE;
  70     memcpy(cbw.CBWCB, cdbcmd, USB_CDB_SIZE);
  71
  72     // Transfer cbw to device.
  73     int ret = usb_send_bulk(bulkout, USB_DIR_OUT
  74                             , MAKE_FLATPTR(GET_SEG(SS), &cbw), sizeof(cbw));
  75     if (ret)
  76         goto fail;
  77
  78     // Transfer data from device.
  79     ret = usb_send_bulk(bulkin, USB_DIR_IN, op->buf_fl, bytes);
  80     if (ret)
  81         goto fail;
  82
  83     // Transfer csw info.
  84     struct csw_s csw;
  85     ret = usb_send_bulk(bulkin, USB_DIR_IN
  86                         , MAKE_FLATPTR(GET_SEG(SS), &csw), sizeof(csw));
  87     if (ret)
  88         goto fail;
  89
  90     if (!csw.bCSWStatus)
  91         return DISK_RET_SUCCESS;
  92     if (csw.bCSWStatus == 2)
  93         goto fail;
  94
  95     op->count -= csw.dCSWDataResidue / blocksize;
  96     return DISK_RET_EBADTRACK;
  97
  98 fail:
  99     // XXX - reset connection
 100     dprintf(1, "USB transmission failed\n");
 101     op->count = 0;
 102     return DISK_RET_EBADTRACK;
 103 }
 104
 105
 106 /****************************************************************
 107  * Drive ops
 108  ****************************************************************/
 109
 110 // 16bit command demuxer for ATAPI cdroms.
 111 int
 112 process_usb_op(struct disk_op_s *op)
 113 {
 114     if (!CONFIG_USB_MSC)
 115         return 0;
 116     switch (op->command) {
 117     case CMD_READ:
 118         return cdb_read(op);
 119     case CMD_FORMAT:
 120     case CMD_WRITE:
 121         return DISK_RET_EWRITEPROTECT;
 122     case CMD_RESET:
 123     case CMD_ISREADY:
 124     case CMD_VERIFY:
 125     case CMD_SEEK:
 126         return DISK_RET_SUCCESS;
 127     default:
 128         op->count = 0;
 129         return DISK_RET_EPARAM;
 130     }
 131 }
 132
 133
 134 /****************************************************************
 135  * Setup
 136  ****************************************************************/
 137
 138 static int
 139 setup_drive_cdrom(struct disk_op_s *op)
 140 {
 141     op->drive_g->blksize = CDROM_SECTOR_SIZE;
 142     op->drive_g->sectors = (u64)-1;
 143     map_cd_drive(op->drive_g);
 144     return 0;
 145 }
 146
 147 static int
 148 setup_drive_hd(struct disk_op_s *op)
 149 {
 150     struct cdbres_read_capacity info;
 151     int ret = cdb_read_capacity(op, &info);
 152     if (ret)
 153         return ret;
 154     // XXX - retry for some timeout?
 155
 156     u32 blksize = ntohl(info.blksize), sectors = ntohl(info.sectors);
 157     if (blksize != DISK_SECTOR_SIZE) {
 158         if (blksize == CDROM_SECTOR_SIZE)
 159             return setup_drive_cdrom(op);
 160         dprintf(1, "Unsupported USB MSC block size %d\n", blksize);
 161         return -1;
 162     }
 163     op->drive_g->blksize = blksize;
 164     op->drive_g->sectors = sectors;
 165     dprintf(1, "USB MSC blksize=%d sectors=%d\n", blksize, sectors);
 166
 167     // Setup disk geometry translation.
 168     setup_translation(op->drive_g);
 169
 170     // Register with bcv system.
 171     add_bcv_internal(op->drive_g);
 172
 173     return 0;
 174 }
 175
 176 // Configure a usb msc device.
 177 int
 178 usb_msc_init(struct usb_pipe *pipe
 179              , struct usb_interface_descriptor *iface, int imax)
 180 {
 181     if (!CONFIG_USB_MSC)
 182         return -1;
 183
 184     // Verify right kind of device
 185     if ((iface->bInterfaceSubClass != US_SC_SCSI &&
 186          iface->bInterfaceSubClass != US_SC_ATAPI_8070 &&
 187          iface->bInterfaceSubClass != US_SC_ATAPI_8020)
 188         || iface->bInterfaceProtocol != US_PR_BULK) {
 189         dprintf(1, "Unsupported MSC USB device (subclass=%02x proto=%02x)\n"
 190                 , iface->bInterfaceSubClass, iface->bInterfaceProtocol);
 191         return -1;
 192     }
 193
 194     // Allocate drive structure.
 195     char *desc = malloc_tmphigh(MAXDESCSIZE);
 196     struct usbdrive_s *udrive_g = malloc_fseg(sizeof(*udrive_g));
 197     if (!udrive_g || !desc) {
 198         warn_noalloc();
 199         goto fail;
 200     }
 201     memset(udrive_g, 0, sizeof(*udrive_g));
 202     udrive_g->drive.type = DTYPE_USB;
 203
 204     // Find bulk in and bulk out endpoints.
 205     struct usb_endpoint_descriptor *indesc = findEndPointDesc(
 206         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_IN);
 207     struct usb_endpoint_descriptor *outdesc = findEndPointDesc(
 208         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT);
 209     if (!indesc || !outdesc)
 210         goto fail;
 211     udrive_g->bulkin = alloc_bulk_pipe(pipe, indesc);
 212     udrive_g->bulkout = alloc_bulk_pipe(pipe, outdesc);
 213     if (!udrive_g->bulkin || !udrive_g->bulkout)
 214         goto fail;
 215
 216     // Validate drive and find block size and sector count.
 217     struct disk_op_s dop;
 218     memset(&dop, 0, sizeof(dop));
 219     dop.drive_g = &udrive_g->drive;
 220     struct cdbres_inquiry data;
 221     int ret = cdb_get_inquiry(&dop, &data);
 222     if (ret)
 223         goto fail;
 224     char vendor[sizeof(data.vendor)+1], product[sizeof(data.product)+1];
 225     char rev[sizeof(data.rev)+1];
 226     int pdt = data.pdt & 0x1f;
 227     int removable = !!(data.removable & 0x80);
 228     dprintf(1, "USB MSC vendor='%s' product='%s' rev='%s'"
 229             " type=%d removable=%d\n"
 230             , strtcpy(vendor, data.vendor, sizeof(vendor))
 231             , strtcpy(product, data.product, sizeof(product))
 232             , strtcpy(rev, data.rev, sizeof(rev))
 233             , pdt, removable);
 234     udrive_g->drive.removable = removable;
 235
 236     if (pdt == USB_MSC_TYPE_CDROM)
 237         ret = setup_drive_cdrom(&dop);
 238     else
 239         ret = setup_drive_hd(&dop);
 240     if (ret)
 241         goto fail;
 242
 243     snprintf(desc, MAXDESCSIZE, "USB Drive %s %s %s", vendor, product, rev);
 244     udrive_g->drive.desc = desc;
 245
 246     return 0;
 247 fail:
 248     dprintf(1, "Unable to configure USB MSC device.\n");
 249     free(desc);
 250     free(udrive_g);
 251     return -1;
 252 }