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  * Setup
 123  ****************************************************************/
 124
 125 static int
 126 setup_drive_cdrom(struct drive_s *drive, char *desc)
 127 {
 128     drive->sectors = (u64)-1;
 129     struct usb_pipe *pipe = container_of(
 130         drive, struct usbdrive_s, drive)->bulkout;
 131     int prio = bootprio_find_usb(pipe->cntl->pci, pipe->path);
 132     boot_add_cd(drive, desc, prio);
 133     return 0;
 134 }
 135
 136 static int
 137 setup_drive_hd(struct drive_s *drive, char *desc)
 138 {
 139     if (drive->blksize != DISK_SECTOR_SIZE) {
 140         dprintf(1, "Unsupported USB MSC block size %d\n", drive->blksize);
 141         return -1;
 142     }
 143
 144     // Register with bcv system.
 145     struct usb_pipe *pipe = container_of(
 146         drive, struct usbdrive_s, drive)->bulkout;
 147     int prio = bootprio_find_usb(pipe->cntl->pci, pipe->path);
 148     boot_add_hd(drive, desc, prio);
 149     return 0;
 150 }
 151
 152 // Configure a usb msc device.
 153 int
 154 usb_msc_init(struct usb_pipe *pipe
 155              , struct usb_interface_descriptor *iface, int imax)
 156 {
 157     if (!CONFIG_USB_MSC)
 158         return -1;
 159
 160     // Verify right kind of device
 161     if ((iface->bInterfaceSubClass != US_SC_SCSI &&
 162          iface->bInterfaceSubClass != US_SC_ATAPI_8070 &&
 163          iface->bInterfaceSubClass != US_SC_ATAPI_8020)
 164         || iface->bInterfaceProtocol != US_PR_BULK) {
 165         dprintf(1, "Unsupported MSC USB device (subclass=%02x proto=%02x)\n"
 166                 , iface->bInterfaceSubClass, iface->bInterfaceProtocol);
 167         return -1;
 168     }
 169
 170     // Allocate drive structure.
 171     struct usbdrive_s *udrive_g = malloc_fseg(sizeof(*udrive_g));
 172     if (!udrive_g) {
 173         warn_noalloc();
 174         goto fail;
 175     }
 176     memset(udrive_g, 0, sizeof(*udrive_g));
 177     udrive_g->drive.type = DTYPE_USB;
 178
 179     // Find bulk in and bulk out endpoints.
 180     struct usb_endpoint_descriptor *indesc = findEndPointDesc(
 181         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_IN);
 182     struct usb_endpoint_descriptor *outdesc = findEndPointDesc(
 183         iface, imax, USB_ENDPOINT_XFER_BULK, USB_DIR_OUT);
 184     if (!indesc || !outdesc)
 185         goto fail;
 186     udrive_g->bulkin = alloc_bulk_pipe(pipe, indesc);
 187     udrive_g->bulkout = alloc_bulk_pipe(pipe, outdesc);
 188     if (!udrive_g->bulkin || !udrive_g->bulkout)
 189         goto fail;
 190
 191     int ret, pdt;
 192     char *desc = NULL;
 193     ret = scsi_init_drive(&udrive_g->drive, "USB MSC", &pdt, &desc);
 194     if (ret)
 195         goto fail;
 196
 197     if (pdt == SCSI_TYPE_CDROM)
 198         ret = setup_drive_cdrom(&udrive_g->drive, desc);
 199     else
 200         ret = setup_drive_hd(&udrive_g->drive, desc);
 201
 202     if (ret)
 203         goto fail;
 204
 205     return 0;
 206 fail:
 207     dprintf(1, "Unable to configure USB MSC device.\n");
 208     free(udrive_g);
 209     return -1;
 210 }