Index: uspace/drv/bus/usb/usbmast/Makefile =================================================================== --- uspace/drv/bus/usb/usbmast/Makefile (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ uspace/drv/bus/usb/usbmast/Makefile (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -44,7 +44,7 @@ SOURCES = \ - cmds.c \ + bo_trans.c \ + cmdw.c \ main.c \ - mast.c \ scsi_ms.c Index: uspace/drv/bus/usb/usbmast/bo_trans.c =================================================================== --- uspace/drv/bus/usb/usbmast/bo_trans.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) +++ uspace/drv/bus/usb/usbmast/bo_trans.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmast + * @{ + */ +/** + * @file + * USB mass storage bulk-only transport. + */ +#include +#include +#include +#include +#include + +#include "bo_trans.h" +#include "cmdw.h" + +bool usb_mast_verbose = false; + +#define MASTLOG(format, ...) \ + do { \ + if (usb_mast_verbose) { \ + usb_log_debug2("USB cl08: " format, ##__VA_ARGS__); \ + } \ + } while (false) + +/** Send command via bulk-only transport. + * + * @param tag Command block wrapper tag (automatically compared + * with answer) + * @param lun LUN + * @param cmd Command block + * @param cmd_size Command block size in bytes + * @param ddir Direction in which data will be transferred + * @param dbuf Data send/receive buffer + * @param dbuf_size Size of the data buffer + * @param xferred_size Number of bytes actually transferred + * + * @return Error code + */ +static int usb_massstor_cmd(usb_device_t *dev, uint32_t tag, uint8_t lun, + const void *cmd, size_t cmd_size, usb_direction_t ddir, void *dbuf, + size_t dbuf_size, size_t *xferred_size) +{ + int rc; + size_t act_size; + usb_pipe_t *bulk_in_pipe = dev->pipes[BULK_IN_EP].pipe; + usb_pipe_t *bulk_out_pipe = dev->pipes[BULK_OUT_EP].pipe; + + /* Prepare CBW - command block wrapper */ + usb_massstor_cbw_t cbw; + usb_massstor_cbw_prepare(&cbw, tag, dbuf_size, ddir, lun, cmd_size, + cmd); + + /* Send the CBW. */ + rc = usb_pipe_write(bulk_out_pipe, &cbw, sizeof(cbw)); + MASTLOG("CBW '%s' sent: %s.\n", + usb_debug_str_buffer((uint8_t *) &cbw, sizeof(cbw), 0), + str_error(rc)); + if (rc != EOK) { + return rc; + } + + if (ddir == USB_DIRECTION_IN) { + /* Recieve data from the device. */ + rc = usb_pipe_read(bulk_in_pipe, dbuf, dbuf_size, &act_size); + MASTLOG("Received %zu bytes (%s): %s.\n", act_size, + usb_debug_str_buffer((uint8_t *) dbuf, act_size, 0), + str_error(rc)); + } else { + /* Send data to the device. */ + rc = usb_pipe_write(bulk_out_pipe, dbuf, dbuf_size); + MASTLOG("Sent %zu bytes (%s): %s.\n", act_size, + usb_debug_str_buffer((uint8_t *) dbuf, act_size, 0), + str_error(rc)); + } + + if (rc != EOK) { + /* + * XXX If the pipe is stalled, we should clear it + * and read CSW. + */ + return rc; + } + + /* Read CSW. */ + usb_massstor_csw_t csw; + size_t csw_size; + rc = usb_pipe_read(bulk_in_pipe, &csw, sizeof(csw), &csw_size); + MASTLOG("CSW '%s' received (%zu bytes): %s.\n", + usb_debug_str_buffer((uint8_t *) &csw, csw_size, 0), csw_size, + str_error(rc)); + if (rc != EOK) { + MASTLOG("rc != EOK\n"); + return rc; + } + + if (csw_size != sizeof(csw)) { + MASTLOG("csw_size != sizeof(csw)\n"); + return ERANGE; + } + + if (csw.dCSWTag != tag) { + MASTLOG("csw.dCSWTag != tag\n"); + return EBADCHECKSUM; + } + + /* + * Determine the actual return value from the CSW. + */ + if (csw.dCSWStatus != 0) { + MASTLOG("csw.dCSWStatus != 0\n"); + // FIXME: better error code + // FIXME: distinguish 0x01 and 0x02 + return EXDEV; + } + + size_t residue = (size_t) uint32_usb2host(csw.dCSWDataResidue); + if (residue > dbuf_size) { + MASTLOG("residue > dbuf_size\n"); + return ERANGE; + } + + /* + * When the device has less data to send than requested (or cannot + * receive moredata), it can either stall the pipe or send garbage + * (ignore data) and indicate that via the residue field in CSW. + * That means dbuf_size - residue is the authoritative size of data + * received (sent). + */ + + if (xferred_size != NULL) + *xferred_size = dbuf_size - residue; + + return EOK; +} + +/** Perform data-in command. + * + * @param tag Command block wrapper tag (automatically compared with + * answer) + * @param lun LUN + * @param cmd CDB (Command Descriptor) + * @param cmd_size CDB length in bytes + * @param dbuf Data receive buffer + * @param dbuf_size Data receive buffer size in bytes + * @param proc_size Number of bytes actually processed by device + * + * @return Error code + */ +int usb_massstor_data_in(usb_device_t *dev, uint32_t tag, uint8_t lun, + const void *cmd, size_t cmd_size, void *dbuf, size_t dbuf_size, size_t *proc_size) +{ + return usb_massstor_cmd(dev, tag, lun, cmd, cmd_size, USB_DIRECTION_IN, + dbuf, dbuf_size, proc_size); +} + +/** Perform data-out command. + * + * @param tag Command block wrapper tag (automatically compared with + * answer) + * @param lun LUN + * @param cmd CDB (Command Descriptor) + * @param cmd_size CDB length in bytes + * @param data Command data + * @param data_size Size of @a data in bytes + * @param proc_size Number of bytes actually processed by device + * + * @return Error code + */ +int usb_massstor_data_out(usb_device_t *dev, uint32_t tag, uint8_t lun, + const void *cmd, size_t cmd_size, const void *data, size_t data_size, + size_t *proc_size) +{ + return usb_massstor_cmd(dev, tag, lun, cmd, cmd_size, USB_DIRECTION_OUT, + (void *) data, data_size, proc_size); +} + +/** Perform bulk-only mass storage reset. + * + * @param dev Device to be reseted. + * @return Error code. + */ +int usb_massstor_reset(usb_device_t *dev) +{ + return usb_control_request_set(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + 0xFF, 0, dev->interface_no, NULL, 0); +} + +/** Perform complete reset recovery of bulk-only mass storage. + * + * Notice that no error is reported because if this fails, the error + * would reappear on next transaction somehow. + * + * @param dev Device to be reseted. + */ +void usb_massstor_reset_recovery(usb_device_t *dev) +{ + /* We would ignore errors here because if this fails + * we are doomed anyway and any following transaction would fail. + */ + usb_massstor_reset(dev); + usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[BULK_IN_EP].pipe); + usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[BULK_OUT_EP].pipe); +} + +/** Get max LUN of a mass storage device. + * + * @see usb_masstor_get_lun_count + * + * @warning Error from this command does not necessarily indicate malfunction + * of the device. Device does not need to support this request. + * You shall rather use usb_masstor_get_lun_count. + * + * @param dev Mass storage device. + * @return Error code of maximum LUN (index, not count). + */ +int usb_massstor_get_max_lun(usb_device_t *dev) +{ + uint8_t max_lun; + size_t data_recv_len; + int rc = usb_control_request_get(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + 0xFE, 0, dev->interface_no, &max_lun, 1, &data_recv_len); + if (rc != EOK) { + return rc; + } + if (data_recv_len != 1) { + return EEMPTY; + } + return (int) max_lun; +} + +/** Get number of LUNs supported by mass storage device. + * + * @warning This function hides any error during the request + * (typically that shall not be a problem). + * + * @param dev Mass storage device. + * @return Number of LUNs. + */ +size_t usb_masstor_get_lun_count(usb_device_t *dev) +{ + int max_lun = usb_massstor_get_max_lun(dev); + if (max_lun < 0) { + max_lun = 1; + } else { + max_lun++; + } + + return (size_t) max_lun; +} + +/** + * @} + */ Index: uspace/drv/bus/usb/usbmast/bo_trans.h =================================================================== --- uspace/drv/bus/usb/usbmast/bo_trans.h (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) +++ uspace/drv/bus/usb/usbmast/bo_trans.h (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmast + * @{ + */ +/** @file + * USB mass storage bulk-only transport. + */ + +#ifndef BO_TRANS_H_ +#define BO_TRANS_H_ + +#include +#include +#include +#include +#include + +#define BULK_IN_EP 0 +#define BULK_OUT_EP 1 + +extern int usb_massstor_data_in(usb_device_t *, uint32_t, uint8_t, const void *, + size_t, void *, size_t, size_t *); +extern int usb_massstor_data_out(usb_device_t *, uint32_t, uint8_t, const void *, + size_t, const void *, size_t, size_t *); +extern int usb_massstor_reset(usb_device_t *); +extern void usb_massstor_reset_recovery(usb_device_t *); +extern int usb_massstor_get_max_lun(usb_device_t *); +extern size_t usb_masstor_get_lun_count(usb_device_t *); + +#endif + +/** + * @} + */ Index: pace/drv/bus/usb/usbmast/cmds.c =================================================================== --- uspace/drv/bus/usb/usbmast/cmds.c (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ (revision ) @@ -1,66 +1,0 @@ -/* - * Copyright (c) 2011 Vojtech Horky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbmast - * @{ - */ -/** @file - * USB mass storage commands. - */ - -#include -#include -#include -#include -#include "cmds.h" - -void usb_massstor_cbw_prepare(usb_massstor_cbw_t *cbw, - uint32_t tag, uint32_t transfer_length, usb_direction_t dir, - uint8_t lun, uint8_t cmd_len, const uint8_t *cmd) -{ - cbw->dCBWSignature = uint32_host2usb(0x43425355); - cbw->dCBWTag = tag; - cbw->dCBWDataTransferLength = transfer_length; - - cbw->bmCBWFlags = 0; - if (dir == USB_DIRECTION_IN) { - cbw->bmCBWFlags |= (1 << 7); - } - - /* Only lowest 4 bits. */ - cbw->bCBWLUN = lun & 0x0F; - - /* Only lowest 5 bits. */ - cbw->bCBWBLength = cmd_len & 0x1F; - - memcpy(cbw->CBWCB, cmd, cbw->bCBWBLength); -} - -/** - * @} - */ Index: pace/drv/bus/usb/usbmast/cmds.h =================================================================== --- uspace/drv/bus/usb/usbmast/cmds.h (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ (revision ) @@ -1,66 +1,0 @@ -/* - * Copyright (c) 2011 Vojtech Horky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbmast - * @{ - */ -/** @file - * USB mass storage commands. - */ - -#ifndef USB_USBMAST_CMDS_H_ -#define USB_USBMAST_CMDS_H_ - -#include -#include - -typedef struct { - uint32_t dCBWSignature; - uint32_t dCBWTag; - uint32_t dCBWDataTransferLength; - uint8_t bmCBWFlags; - uint8_t bCBWLUN; - uint8_t bCBWBLength; - uint8_t CBWCB[16]; -} __attribute__((packed)) usb_massstor_cbw_t; - -typedef struct { - uint32_t dCSWSignature; - uint32_t dCSWTag; - uint32_t dCSWDataResidue; - uint8_t dCSWStatus; -} __attribute__((packed)) usb_massstor_csw_t; - -extern void usb_massstor_cbw_prepare(usb_massstor_cbw_t *, uint32_t, uint32_t, - usb_direction_t, uint8_t, uint8_t, const uint8_t *); - -#endif - -/** - * @} - */ Index: uspace/drv/bus/usb/usbmast/cmdw.c =================================================================== --- uspace/drv/bus/usb/usbmast/cmdw.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) +++ uspace/drv/bus/usb/usbmast/cmdw.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmast + * @{ + */ +/** @file + * USB mass storage commands. + */ + +#include +#include +#include +#include +#include "cmdw.h" + +void usb_massstor_cbw_prepare(usb_massstor_cbw_t *cbw, + uint32_t tag, uint32_t transfer_length, usb_direction_t dir, + uint8_t lun, uint8_t cmd_len, const uint8_t *cmd) +{ + cbw->dCBWSignature = uint32_host2usb(0x43425355); + cbw->dCBWTag = tag; + cbw->dCBWDataTransferLength = transfer_length; + + cbw->bmCBWFlags = 0; + if (dir == USB_DIRECTION_IN) { + cbw->bmCBWFlags |= (1 << 7); + } + + /* Only lowest 4 bits. */ + cbw->bCBWLUN = lun & 0x0F; + + /* Only lowest 5 bits. */ + cbw->bCBWBLength = cmd_len & 0x1F; + + memcpy(cbw->CBWCB, cmd, cbw->bCBWBLength); +} + +/** + * @} + */ Index: uspace/drv/bus/usb/usbmast/cmdw.h =================================================================== --- uspace/drv/bus/usb/usbmast/cmdw.h (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) +++ uspace/drv/bus/usb/usbmast/cmdw.h (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmast + * @{ + */ +/** @file + * USB mass storage commands. + */ + +#ifndef CMDW_H_ +#define CMDW_H_ + +#include +#include + +typedef struct { + uint32_t dCBWSignature; + uint32_t dCBWTag; + uint32_t dCBWDataTransferLength; + uint8_t bmCBWFlags; + uint8_t bCBWLUN; + uint8_t bCBWBLength; + uint8_t CBWCB[16]; +} __attribute__((packed)) usb_massstor_cbw_t; + +typedef struct { + uint32_t dCSWSignature; + uint32_t dCSWTag; + uint32_t dCSWDataResidue; + uint8_t dCSWStatus; +} __attribute__((packed)) usb_massstor_csw_t; + +extern void usb_massstor_cbw_prepare(usb_massstor_cbw_t *, uint32_t, uint32_t, + usb_direction_t, uint8_t, uint8_t, const uint8_t *); + +#endif + +/** + * @} + */ Index: uspace/drv/bus/usb/usbmast/main.c =================================================================== --- uspace/drv/bus/usb/usbmast/main.c (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ uspace/drv/bus/usb/usbmast/main.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -45,6 +45,6 @@ #include #include -#include "cmds.h" -#include "mast.h" +#include "cmdw.h" +#include "bo_trans.h" #include "scsi_ms.h" Index: pace/drv/bus/usb/usbmast/mast.c =================================================================== --- uspace/drv/bus/usb/usbmast/mast.c (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ (revision ) @@ -1,283 +1,0 @@ -/* - * Copyright (c) 2011 Vojtech Horky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbmast - * @{ - */ -/** - * @file - * Generic functions for USB mass storage (implementation). - */ -#include "mast.h" -#include "cmds.h" -#include -#include -#include -#include -#include - -bool usb_mast_verbose = false; - -#define MASTLOG(format, ...) \ - do { \ - if (usb_mast_verbose) { \ - usb_log_debug2("USB cl08: " format, ##__VA_ARGS__); \ - } \ - } while (false) - -/** Send command via bulk-only transport. - * - * @param tag Command block wrapper tag (automatically compared - * with answer) - * @param lun LUN - * @param cmd Command block - * @param cmd_size Command block size in bytes - * @param ddir Direction in which data will be transferred - * @param dbuf Data send/receive buffer - * @param dbuf_size Size of the data buffer - * @param xferred_size Number of bytes actually transferred - * - * @return Error code - */ -static int usb_massstor_cmd(usb_device_t *dev, uint32_t tag, uint8_t lun, - const void *cmd, size_t cmd_size, usb_direction_t ddir, void *dbuf, - size_t dbuf_size, size_t *xferred_size) -{ - int rc; - size_t act_size; - usb_pipe_t *bulk_in_pipe = dev->pipes[BULK_IN_EP].pipe; - usb_pipe_t *bulk_out_pipe = dev->pipes[BULK_OUT_EP].pipe; - - /* Prepare CBW - command block wrapper */ - usb_massstor_cbw_t cbw; - usb_massstor_cbw_prepare(&cbw, tag, dbuf_size, ddir, lun, cmd_size, - cmd); - - /* Send the CBW. */ - rc = usb_pipe_write(bulk_out_pipe, &cbw, sizeof(cbw)); - MASTLOG("CBW '%s' sent: %s.\n", - usb_debug_str_buffer((uint8_t *) &cbw, sizeof(cbw), 0), - str_error(rc)); - if (rc != EOK) { - return rc; - } - - if (ddir == USB_DIRECTION_IN) { - /* Recieve data from the device. */ - rc = usb_pipe_read(bulk_in_pipe, dbuf, dbuf_size, &act_size); - MASTLOG("Received %zu bytes (%s): %s.\n", act_size, - usb_debug_str_buffer((uint8_t *) dbuf, act_size, 0), - str_error(rc)); - } else { - /* Send data to the device. */ - rc = usb_pipe_write(bulk_out_pipe, dbuf, dbuf_size); - MASTLOG("Sent %zu bytes (%s): %s.\n", act_size, - usb_debug_str_buffer((uint8_t *) dbuf, act_size, 0), - str_error(rc)); - } - - if (rc != EOK) { - /* - * XXX If the pipe is stalled, we should clear it - * and read CSW. - */ - return rc; - } - - /* Read CSW. */ - usb_massstor_csw_t csw; - size_t csw_size; - rc = usb_pipe_read(bulk_in_pipe, &csw, sizeof(csw), &csw_size); - MASTLOG("CSW '%s' received (%zu bytes): %s.\n", - usb_debug_str_buffer((uint8_t *) &csw, csw_size, 0), csw_size, - str_error(rc)); - if (rc != EOK) { - MASTLOG("rc != EOK\n"); - return rc; - } - - if (csw_size != sizeof(csw)) { - MASTLOG("csw_size != sizeof(csw)\n"); - return ERANGE; - } - - if (csw.dCSWTag != tag) { - MASTLOG("csw.dCSWTag != tag\n"); - return EBADCHECKSUM; - } - - /* - * Determine the actual return value from the CSW. - */ - if (csw.dCSWStatus != 0) { - MASTLOG("csw.dCSWStatus != 0\n"); - // FIXME: better error code - // FIXME: distinguish 0x01 and 0x02 - return EXDEV; - } - - size_t residue = (size_t) uint32_usb2host(csw.dCSWDataResidue); - if (residue > dbuf_size) { - MASTLOG("residue > dbuf_size\n"); - return ERANGE; - } - - /* - * When the device has less data to send than requested (or cannot - * receive moredata), it can either stall the pipe or send garbage - * (ignore data) and indicate that via the residue field in CSW. - * That means dbuf_size - residue is the authoritative size of data - * received (sent). - */ - - if (xferred_size != NULL) - *xferred_size = dbuf_size - residue; - - return EOK; -} - -/** Perform data-in command. - * - * @param tag Command block wrapper tag (automatically compared with - * answer) - * @param lun LUN - * @param cmd CDB (Command Descriptor) - * @param cmd_size CDB length in bytes - * @param dbuf Data receive buffer - * @param dbuf_size Data receive buffer size in bytes - * @param proc_size Number of bytes actually processed by device - * - * @return Error code - */ -int usb_massstor_data_in(usb_device_t *dev, uint32_t tag, uint8_t lun, - const void *cmd, size_t cmd_size, void *dbuf, size_t dbuf_size, size_t *proc_size) -{ - return usb_massstor_cmd(dev, tag, lun, cmd, cmd_size, USB_DIRECTION_IN, - dbuf, dbuf_size, proc_size); -} - -/** Perform data-out command. - * - * @param tag Command block wrapper tag (automatically compared with - * answer) - * @param lun LUN - * @param cmd CDB (Command Descriptor) - * @param cmd_size CDB length in bytes - * @param data Command data - * @param data_size Size of @a data in bytes - * @param proc_size Number of bytes actually processed by device - * - * @return Error code - */ -int usb_massstor_data_out(usb_device_t *dev, uint32_t tag, uint8_t lun, - const void *cmd, size_t cmd_size, const void *data, size_t data_size, - size_t *proc_size) -{ - return usb_massstor_cmd(dev, tag, lun, cmd, cmd_size, USB_DIRECTION_OUT, - (void *) data, data_size, proc_size); -} - -/** Perform bulk-only mass storage reset. - * - * @param dev Device to be reseted. - * @return Error code. - */ -int usb_massstor_reset(usb_device_t *dev) -{ - return usb_control_request_set(&dev->ctrl_pipe, - USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, - 0xFF, 0, dev->interface_no, NULL, 0); -} - -/** Perform complete reset recovery of bulk-only mass storage. - * - * Notice that no error is reported because if this fails, the error - * would reappear on next transaction somehow. - * - * @param dev Device to be reseted. - */ -void usb_massstor_reset_recovery(usb_device_t *dev) -{ - /* We would ignore errors here because if this fails - * we are doomed anyway and any following transaction would fail. - */ - usb_massstor_reset(dev); - usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[BULK_IN_EP].pipe); - usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[BULK_OUT_EP].pipe); -} - -/** Get max LUN of a mass storage device. - * - * @see usb_masstor_get_lun_count - * - * @warning Error from this command does not necessarily indicate malfunction - * of the device. Device does not need to support this request. - * You shall rather use usb_masstor_get_lun_count. - * - * @param dev Mass storage device. - * @return Error code of maximum LUN (index, not count). - */ -int usb_massstor_get_max_lun(usb_device_t *dev) -{ - uint8_t max_lun; - size_t data_recv_len; - int rc = usb_control_request_get(&dev->ctrl_pipe, - USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, - 0xFE, 0, dev->interface_no, &max_lun, 1, &data_recv_len); - if (rc != EOK) { - return rc; - } - if (data_recv_len != 1) { - return EEMPTY; - } - return (int) max_lun; -} - -/** Get number of LUNs supported by mass storage device. - * - * @warning This function hides any error during the request - * (typically that shall not be a problem). - * - * @param dev Mass storage device. - * @return Number of LUNs. - */ -size_t usb_masstor_get_lun_count(usb_device_t *dev) -{ - int max_lun = usb_massstor_get_max_lun(dev); - if (max_lun < 0) { - max_lun = 1; - } else { - max_lun++; - } - - return (size_t) max_lun; -} - -/** - * @} - */ Index: pace/drv/bus/usb/usbmast/mast.h =================================================================== --- uspace/drv/bus/usb/usbmast/mast.h (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ (revision ) @@ -1,61 +1,0 @@ -/* - * Copyright (c) 2011 Vojtech Horky - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * - The name of the author may not be used to endorse or promote products - * derived from this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR - * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. - * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF - * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -/** @addtogroup drvusbmast - * @{ - */ -/** @file - * Generic functions for USB mass storage. - */ - -#ifndef USB_USBMAST_MAST_H_ -#define USB_USBMAST_MAST_H_ - -#include -#include -#include -#include -#include - -#define BULK_IN_EP 0 -#define BULK_OUT_EP 1 - -extern int usb_massstor_data_in(usb_device_t *, uint32_t, uint8_t, const void *, - size_t, void *, size_t, size_t *); -extern int usb_massstor_data_out(usb_device_t *, uint32_t, uint8_t, const void *, - size_t, const void *, size_t, size_t *); -extern int usb_massstor_reset(usb_device_t *); -extern void usb_massstor_reset_recovery(usb_device_t *); -extern int usb_massstor_get_max_lun(usb_device_t *); -extern size_t usb_masstor_get_lun_count(usb_device_t *); - -#endif - -/** - * @} - */ Index: uspace/drv/bus/usb/usbmast/scsi_ms.c =================================================================== --- uspace/drv/bus/usb/usbmast/scsi_ms.c (revision dcbb3ec691e6fffe0faf86d8f40f4b4d6860848a) +++ uspace/drv/bus/usb/usbmast/scsi_ms.c (revision 89d3f3c712097d9131bb5031c9cb5f09c1a288ec) @@ -46,6 +46,6 @@ #include #include -#include "cmds.h" -#include "mast.h" +#include "cmdw.h" +#include "bo_trans.h" #include "scsi_ms.h"