source: mainline/uspace/drv/bus/usb/usbmast/scsi_ms.c@ 45cae6b

/*
 * Copyright (c) 2011 Vojtech Horky
 * Copyright (c) 2011 Jiri Svoboda
 * 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
 * SCSI functions for USB mass storage driver.
 */
#include <bitops.h>
#include <byteorder.h>
#include <inttypes.h>
#include <macros.h>
#include <usb/dev/driver.h>
#include <usb/debug.h>
#include <errno.h>
#include <str_error.h>
#include <str.h>
#include <scsi/sbc.h>
#include <scsi/spc.h>
#include "cmdw.h"
#include "bo_trans.h"
#include "scsi_ms.h"
#include "usbmast.h"

/** Get string representation for SCSI peripheral device type.
 *
 * @param type          SCSI peripheral device type code.
 * @return              String representation.
 */
const char *usbmast_scsi_dev_type_str(unsigned type)
{
        return scsi_get_dev_type_str(type);
}

static void usbmast_dump_sense(usbmast_fun_t *mfun)
{
        scsi_sense_data_t sense_buf;
        int rc;

        rc = usbmast_request_sense(mfun, &sense_buf, sizeof(sense_buf));
        if (rc == EOK) {
                printf("Got sense data (sense_key=0x%x, asc=0x%02x, "
                    "ascq=0x%02x.\n", sense_buf.flags_key & 0x0f,
                    sense_buf.additional_code,
                    sense_buf.additional_cqual);
        } else {
                printf("Failed to read sense data.\n");
        }
}

/** Perform SCSI Inquiry command on USB mass storage device.
 *
 * @param mfun          Mass storage function
 * @param inquiry_result Where to store parsed inquiry result
 * @return              Error code
 */
int usbmast_inquiry(usbmast_fun_t *mfun, usbmast_inquiry_data_t *inq_res)
{
        scsi_std_inquiry_data_t inq_data;
        size_t response_len;
        scsi_cdb_inquiry_t cdb;
        cmd_status_t status;
        int rc;

        memset(&cdb, 0, sizeof(cdb));
        cdb.op_code = SCSI_CMD_INQUIRY;
        cdb.alloc_len = host2uint16_t_be(sizeof(inq_data));

        rc = usb_massstor_data_in(mfun, 0xDEADBEEF, (uint8_t *) &cdb,
            sizeof(cdb), &inq_data, sizeof(inq_data), &response_len, &status);

        if (rc != EOK) {
                usb_log_error("Inquiry transport failed, device %s: %s.\n",
                   mfun->mdev->ddf_dev->name, str_error(rc));
                return rc;
        }

        if (status != CMDS_GOOD) {
                usb_log_error("Inquiry command failed, device %s.\n",
                   mfun->mdev->ddf_dev->name);
                usbmast_dump_sense(mfun);
                return EIO;
        }

        if (response_len < SCSI_STD_INQUIRY_DATA_MIN_SIZE) {
                usb_log_error("SCSI Inquiry response too short (%zu).\n",
                    response_len);
                return EIO;
        }

        /*
         * Parse inquiry data and fill in the result structure.
         */

        bzero(inq_res, sizeof(*inq_res));

        inq_res->device_type = BIT_RANGE_EXTRACT(uint8_t,
            inq_data.pqual_devtype, SCSI_PQDT_DEV_TYPE_h, SCSI_PQDT_DEV_TYPE_l);

        inq_res->removable = BIT_RANGE_EXTRACT(uint8_t,
            inq_data.rmb, SCSI_RMB_RMB, SCSI_RMB_RMB);

        spascii_to_str(inq_res->vendor, SCSI_INQ_VENDOR_STR_BUFSIZE,
            inq_data.vendor, sizeof(inq_data.vendor));

        spascii_to_str(inq_res->product, SCSI_INQ_PRODUCT_STR_BUFSIZE,
            inq_data.product, sizeof(inq_data.product));

        spascii_to_str(inq_res->revision, SCSI_INQ_REVISION_STR_BUFSIZE,
            inq_data.revision, sizeof(inq_data.revision));

        return EOK;
}

/** Perform SCSI Request Sense command on USB mass storage device.
 *
 * @param mfun          Mass storage function
 * @param buf           Destination buffer
 * @param size          Size of @a buf
 *
 * @return              Error code.
 */
int usbmast_request_sense(usbmast_fun_t *mfun, void *buf, size_t size)
{
        scsi_cdb_request_sense_t cdb;
        size_t data_len;
        cmd_status_t status;
        int rc;

        memset(&cdb, 0, sizeof(cdb));
        cdb.op_code = SCSI_CMD_REQUEST_SENSE;
        cdb.alloc_len = min(size, SCSI_SENSE_DATA_MAX_SIZE);

        rc = usb_massstor_data_in(mfun, 0xDEADBEEF, (uint8_t *) &cdb,
            sizeof(cdb), buf, size, &data_len, &status);

        if (rc != EOK || status != CMDS_GOOD) {
                usb_log_error("Request Sense failed, device %s: %s.\n",
                   mfun->mdev->ddf_dev->name, str_error(rc));
                return rc;
        }

        if (data_len < SCSI_SENSE_DATA_MIN_SIZE) {
                /* The missing bytes should be considered to be zeroes. */
                memset((uint8_t *)buf + data_len, 0,
                    SCSI_SENSE_DATA_MIN_SIZE - data_len);
        }

        return EOK;
}

/** Perform SCSI Read Capacity command on USB mass storage device.
 *
 * @param mfun          Mass storage function
 * @param nblocks       Output, number of blocks
 * @param block_size    Output, block size in bytes
 *
 * @return              Error code.
 */
int usbmast_read_capacity(usbmast_fun_t *mfun, uint32_t *nblocks,
    uint32_t *block_size)
{
        scsi_cdb_read_capacity_10_t cdb;
        scsi_read_capacity_10_data_t data;
        size_t data_len;
        cmd_status_t status;
        int rc;

        memset(&cdb, 0, sizeof(cdb));
        cdb.op_code = SCSI_CMD_READ_CAPACITY_10;

        rc = usb_massstor_data_in(mfun, 0xDEADBEEF, (uint8_t *) &cdb,
            sizeof(cdb), &data, sizeof(data), &data_len, &status);

        if (rc != EOK) {
                usb_log_error("Read Capacity (10) transport failed, device %s: %s.\n",
                   mfun->mdev->ddf_dev->name, str_error(rc));
                return rc;
        }

        if (status != CMDS_GOOD) {
                usb_log_error("Read Capacity (10) command failed, device %s.\n",
                   mfun->mdev->ddf_dev->name);
                usbmast_dump_sense(mfun);
                return EIO;
        }

        if (data_len < sizeof(data)) {
                usb_log_error("SCSI Read Capacity response too short (%zu).\n",
                    data_len);
                return EIO;
        }

        *nblocks = uint32_t_be2host(data.last_lba) + 1;
        *block_size = uint32_t_be2host(data.block_size);

        return EOK;
}

/** Perform SCSI Read command on USB mass storage device.
 *
 * @param mfun          Mass storage function
 * @param ba            Address of first block
 * @param nblocks       Number of blocks to read
 *
 * @return              Error code
 */
int usbmast_read(usbmast_fun_t *mfun, uint64_t ba, size_t nblocks, void *buf)
{
        scsi_cdb_read_12_t cdb;
        size_t data_len;
        cmd_status_t status;
        int rc;

        /* XXX Need softstate to store block size. */

        if (ba > UINT32_MAX)
                return ELIMIT;

        if ((uint64_t)nblocks * mfun->block_size > UINT32_MAX)
                return ELIMIT;

        memset(&cdb, 0, sizeof(cdb));
        cdb.op_code = SCSI_CMD_READ_12;
        cdb.lba = host2uint32_t_be(ba);
        cdb.xfer_len = host2uint32_t_be(nblocks);

        rc = usb_massstor_data_in(mfun, 0xDEADBEEF, (uint8_t *) &cdb,
            sizeof(cdb), buf, nblocks * mfun->block_size, &data_len, &status);

        if (rc != EOK) {
                usb_log_error("Read (12) transport failed, device %s: %s.\n",
                   mfun->mdev->ddf_dev->name, str_error(rc));
                return rc;
        }

        if (status != CMDS_GOOD) {
                usb_log_error("Read (12) command failed, device %s.\n",
                   mfun->mdev->ddf_dev->name);
                usbmast_dump_sense(mfun);
                return EIO;
        }

        if (data_len < nblocks * mfun->block_size) {
                usb_log_error("SCSI Read response too short (%zu).\n",
                    data_len);
                return EIO;
        }

        return EOK;
}

/** Perform SCSI Write command on USB mass storage device.
 *
 * @param mfun          Mass storage function
 * @param ba            Address of first block
 * @param nblocks       Number of blocks to read
 * @param data          Data to write
 *
 * @return              Error code
 */
int usbmast_write(usbmast_fun_t *mfun, uint64_t ba, size_t nblocks,
    const void *data)
{
        scsi_cdb_write_12_t cdb;
        size_t sent_len;
        cmd_status_t status;
        int rc;

        if (ba > UINT32_MAX)
                return ELIMIT;

        if ((uint64_t)nblocks * mfun->block_size > UINT32_MAX)
                return ELIMIT;

        memset(&cdb, 0, sizeof(cdb));
        cdb.op_code = SCSI_CMD_WRITE_12;
        cdb.lba = host2uint32_t_be(ba);
        cdb.xfer_len = host2uint32_t_be(nblocks);

        rc = usb_massstor_data_out(mfun, 0xDEADBEEF, (uint8_t *) &cdb,
            sizeof(cdb), data, nblocks * mfun->block_size, &sent_len, &status);

        if (rc != EOK) {
                usb_log_error("Write (12) transport failed, device %s: %s.\n",
                   mfun->mdev->ddf_dev->name, str_error(rc));
                return rc;
        }

        if (status != CMDS_GOOD) {
                usb_log_error("Write (12) command failed, device %s.\n",
                   mfun->mdev->ddf_dev->name);
                usbmast_dump_sense(mfun);
                return EIO;
        }

        if (sent_len < nblocks * mfun->block_size) {
                usb_log_error("SCSI Write not all bytes transferred (%zu).\n",
                    sent_len);
                return EIO;
        }

        return EOK;
}

/**
 * @}
 */