HelenOS sources

root/uspace/drv/block/usbmast/scsi_ms.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM


/*
 * 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
 * SCSI functions for USB mass storage.
 */

#ifndef USB_USBMAST_SCSI_MS_H_
#define USB_USBMAST_SCSI_MS_H_

#include <scsi/spc.h>
#include <stddef.h>
#include <stdint.h>
#include <usb/usb.h>
#include <usb/dev/driver.h>

/** Result of SCSI Inquiry command.
 * This is already parsed structure, not the original buffer returned by
 * the device.
 */
typedef struct {
        /** SCSI peripheral device type */
        unsigned device_type;
        /** Whether the device is removable */
        bool removable;
        /** Vendor ID string */
        char vendor[SCSI_INQ_VENDOR_STR_BUFSIZE];
        /** Product ID string */
        char product[SCSI_INQ_PRODUCT_STR_BUFSIZE];
        /** Revision string */
        char revision[SCSI_INQ_REVISION_STR_BUFSIZE];
} usbmast_inquiry_data_t;

extern errno_t usbmast_inquiry(usbmast_fun_t *, usbmast_inquiry_data_t *);
extern errno_t usbmast_request_sense(usbmast_fun_t *, void *, size_t);
extern errno_t usbmast_read_capacity(usbmast_fun_t *, uint32_t *, uint32_t *);
extern errno_t usbmast_read(usbmast_fun_t *, uint64_t, size_t, void *);
extern errno_t usbmast_write(usbmast_fun_t *, uint64_t, size_t, const void *);
extern errno_t usbmast_sync_cache(usbmast_fun_t *, uint64_t, size_t);
extern const char *usbmast_scsi_dev_type_str(unsigned);

#endif

/**
 * @}
 */

/* [<][>][^][v][top][bottom][index][help] */
HelenOS homepage, sources at GitHub