1 // Code for handling USB Mass Storage Controller devices.
3 // Copyright (C) 2010 Kevin O'Connor <kevin@koconnor.net>
5 // This file may be distributed under the terms of the GNU LGPLv3 license.
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
18 struct usb_pipe *bulkin, *bulkout;
22 /****************************************************************
23 * Bulk-only drive command processing
24 ****************************************************************/
26 #define USB_CDB_SIZE 12
28 #define CBW_SIGNATURE 0x43425355 // USBC
33 u32 dCBWDataTransferLength;
40 #define CSW_SIGNATURE 0x53425355 // USBS
50 usb_msc_send(struct usbdrive_s *udrive_g, int dir, void *buf, u32 bytes)
52 struct usb_pipe *pipe;
53 if (dir == USB_DIR_OUT)
54 pipe = GET_GLOBAL(udrive_g->bulkout);
56 pipe = GET_GLOBAL(udrive_g->bulkin);
57 return usb_send_bulk(pipe, dir, buf, bytes);
60 // Low-level usb command transmit function.
62 usb_cmd_data(struct disk_op_s *op, void *cdbcmd, u16 blocksize)
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);
72 // Setup command block wrapper.
73 u32 bytes = blocksize * op->count;
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;
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));
90 // Transfer data to/from device.
92 ret = usb_msc_send(udrive_g, cbw.bmCBWFlags, op->buf_fl, bytes);
99 ret = usb_msc_send(udrive_g, USB_DIR_IN
100 , MAKE_FLATPTR(GET_SEG(SS), &csw), sizeof(csw));
105 return DISK_RET_SUCCESS;
106 if (csw.bCSWStatus == 2)
110 op->count -= csw.dCSWDataResidue / blocksize;
111 return DISK_RET_EBADTRACK;
114 // XXX - reset connection
115 dprintf(1, "USB transmission failed\n");
117 return DISK_RET_EBADTRACK;
121 /****************************************************************
123 ****************************************************************/
126 setup_drive_cdrom(struct drive_s *drive, char *desc)
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);
137 setup_drive_hd(struct drive_s *drive, char *desc)
139 if (drive->blksize != DISK_SECTOR_SIZE) {
140 dprintf(1, "Unsupported USB MSC block size %d\n", drive->blksize);
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);
152 // Configure a usb msc device.
154 usb_msc_init(struct usb_pipe *pipe
155 , struct usb_interface_descriptor *iface, int imax)
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);
170 // Allocate drive structure.
171 struct usbdrive_s *udrive_g = malloc_fseg(sizeof(*udrive_g));
176 memset(udrive_g, 0, sizeof(*udrive_g));
177 udrive_g->drive.type = DTYPE_USB;
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)
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)
193 ret = scsi_init_drive(&udrive_g->drive, "USB MSC", &pdt, &desc);
197 if (pdt == SCSI_TYPE_CDROM)
198 ret = setup_drive_cdrom(&udrive_g->drive, desc);
200 ret = setup_drive_hd(&udrive_g->drive, desc);
207 dprintf(1, "Unable to configure USB MSC device.\n");