2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A
2N/A/*
2N/A * Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
2N/A */
2N/A
2N/A#ifndef _LIBSCSI_H
2N/A#define _LIBSCSI_H
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A#include <sys/types.h>
2N/A#include <sys/sysmacros.h>
2N/A#include <sys/scsi/impl/spc3_types.h>
2N/A#include <stdarg.h>
2N/A
2N/A#define LIBSCSI_VERSION 1
2N/A#define LIBSCSI_STATUS_INVALID ((sam4_status_t)-1)
2N/A#define LIBSCSI_REASON_INVALID ((libscsi_reason_t)-1)
2N/A#define LIBSCSI_DEFAULT_ENGINE_PATH "/usr/lib/scsi/plugins/scsi/engines"
2N/A#define LIBSCSI_DEFAULT_ENGINE "uscsi"
2N/A
2N/A/*
2N/A * Flags for action creation. Selected to avoid overlap with the uscsi
2N/A * flags with similar or identical meaning.
2N/A */
2N/A#define LIBSCSI_AF_READ 0x80000000
2N/A#define LIBSCSI_AF_WRITE 0x40000000
2N/A#define LIBSCSI_AF_SILENT 0x20000000
2N/A#define LIBSCSI_AF_DIAGNOSE 0x10000000
2N/A#define LIBSCSI_AF_ISOLATE 0x08000000
2N/A#define LIBSCSI_AF_RQSENSE 0x04000000
2N/A
2N/Atypedef enum libscsi_errno {
2N/A ESCSI_NONE, /* no error */
2N/A ESCSI_NOMEM, /* no memory */
2N/A ESCSI_ZERO_LENGTH, /* zero-length allocation requested */
2N/A ESCSI_VERSION, /* library version mismatch */
2N/A ESCSI_BADTARGET, /* invalid target specification */
2N/A ESCSI_BADCMD, /* invalid SCSI command */
2N/A ESCSI_BADENGINE, /* engine library corrupt */
2N/A ESCSI_NOENGINE, /* engine library not found */
2N/A ESCSI_ENGINE_INIT, /* engine initialization failed */
2N/A ESCSI_ENGINE_VER, /* engine version mismatch */
2N/A ESCSI_ENGINE_BADPATH, /* engine path contains no usable components */
2N/A ESCSI_BADFLAGS, /* incorrect action flags */
2N/A ESCSI_BOGUSFLAGS, /* unknown flag value */
2N/A ESCSI_BADLENGTH, /* buffer length overflow */
2N/A ESCSI_NEEDBUF, /* missing required buffer */
2N/A ESCSI_IO, /* I/O operation failed */
2N/A ESCSI_SYS, /* system call failed */
2N/A ESCSI_PERM, /* insufficient permissions */
2N/A ESCSI_RANGE, /* parameter outside valid range */
2N/A ESCSI_NOTSUP, /* operation not supported */
2N/A ESCSI_UNKNOWN, /* error of unknown type */
2N/A ESCSI_INQUIRY_FAILED, /* initial inquiry command failed */
2N/A ESCSI_MAX /* maximum libscsi errno value */
2N/A} libscsi_errno_t;
2N/A
2N/Atypedef enum libscsi_reason {
2N/A REASON_NONE, /* no error */
2N/A REASON_NONSPECIFIC, /* some non-specific reason... */
2N/A REASON_TIMEOUT, /* timeout */
2N/A REASON_DEVGONE, /* device gone */
2N/A REASON_TRANSPORT, /* transport issue */
2N/A REASON_PROTOCOL /* protocol issue */
2N/A} libscsi_reason_t;
2N/A
2N/Astruct libscsi_hdl;
2N/Atypedef struct libscsi_hdl libscsi_hdl_t;
2N/A
2N/Astruct libscsi_target;
2N/Atypedef struct libscsi_target libscsi_target_t;
2N/A
2N/Atypedef struct libscsi_status {
2N/A uint64_t lss_status; /* SCSI status of this command */
2N/A size_t lss_sense_len; /* Length in bytes of sense data */
2N/A uint8_t *lss_sense_data; /* Pointer to sense data */
2N/A} libscsi_status_t;
2N/A
2N/Astruct libscsi_action;
2N/Atypedef struct libscsi_action libscsi_action_t;
2N/A
2N/Atypedef struct libscsi_engine_ops {
2N/A void *(*lseo_open)(libscsi_hdl_t *, const void *);
2N/A void (*lseo_close)(libscsi_hdl_t *, void *);
2N/A int (*lseo_exec)(libscsi_hdl_t *, void *, libscsi_action_t *);
2N/A const char *(*lseo_target_name)(libscsi_hdl_t *, void *);
2N/A} libscsi_engine_ops_t;
2N/A
2N/Atypedef struct libscsi_engine {
2N/A const char *lse_name;
2N/A uint_t lse_libversion;
2N/A const libscsi_engine_ops_t *lse_ops;
2N/A} libscsi_engine_t;
2N/A
2N/Aextern libscsi_hdl_t *libscsi_init(uint_t, libscsi_errno_t *);
2N/Aextern void libscsi_fini(libscsi_hdl_t *);
2N/A
2N/Aextern libscsi_target_t *libscsi_open(libscsi_hdl_t *, const char *,
2N/A const void *);
2N/Aextern void libscsi_close(libscsi_hdl_t *, libscsi_target_t *);
2N/Aextern libscsi_hdl_t *libscsi_get_handle(libscsi_target_t *);
2N/Aextern const char *libscsi_target_name(libscsi_target_t *);
2N/A
2N/Aextern const char *libscsi_vendor(libscsi_target_t *);
2N/Aextern const char *libscsi_product(libscsi_target_t *);
2N/Aextern const char *libscsi_revision(libscsi_target_t *);
2N/A
2N/Aextern libscsi_errno_t libscsi_errno(libscsi_hdl_t *);
2N/Aextern const char *libscsi_errmsg(libscsi_hdl_t *);
2N/Aextern const char *libscsi_strerror(libscsi_errno_t);
2N/Aextern const char *libscsi_errname(libscsi_errno_t);
2N/Aextern libscsi_errno_t libscsi_errcode(const char *);
2N/A
2N/Aextern libscsi_action_t *libscsi_action_alloc(libscsi_hdl_t *, spc3_cmd_t,
2N/A uint_t, void *, size_t);
2N/Aextern sam4_status_t libscsi_action_get_status(const libscsi_action_t *);
2N/Aextern libscsi_reason_t libscsi_action_get_reason(const libscsi_action_t *);
2N/Aextern void libscsi_action_set_timeout(libscsi_action_t *, uint32_t);
2N/Aextern uint32_t libscsi_action_get_timeout(const libscsi_action_t *);
2N/Aextern uint_t libscsi_action_get_flags(const libscsi_action_t *);
2N/Aextern uint8_t *libscsi_action_get_cdb(const libscsi_action_t *);
2N/Aextern int libscsi_action_get_buffer(const libscsi_action_t *,
2N/A uint8_t **, size_t *, size_t *);
2N/Aextern int libscsi_action_get_sense(const libscsi_action_t *,
2N/A uint8_t **, size_t *, size_t *);
2N/Aextern int libscsi_action_parse_sense(const libscsi_action_t *, uint64_t *,
2N/A uint64_t *, uint64_t *, diskaddr_t *);
2N/Aextern void libscsi_action_set_status(libscsi_action_t *, sam4_status_t);
2N/Aextern void libscsi_action_set_reason(libscsi_action_t *, libscsi_reason_t);
2N/Aextern int libscsi_action_set_datalen(libscsi_action_t *, size_t);
2N/Aextern int libscsi_action_set_senselen(libscsi_action_t *, size_t);
2N/Aextern int libscsi_exec(libscsi_action_t *, libscsi_target_t *);
2N/Aextern void libscsi_action_free(libscsi_action_t *);
2N/A
2N/Aextern const char *libscsi_sense_key_name(uint64_t);
2N/Aextern const char *libscsi_sense_code_name(uint64_t, uint64_t);
2N/A
2N/A/*
2N/A * Interfaces for engine providers
2N/A */
2N/Aextern void *libscsi_alloc(libscsi_hdl_t *, size_t);
2N/Aextern void *libscsi_zalloc(libscsi_hdl_t *, size_t);
2N/Aextern char *libscsi_strdup(libscsi_hdl_t *, const char *);
2N/Aextern void libscsi_free(libscsi_hdl_t *, void *);
2N/Aextern libscsi_status_t *libscsi_status_alloc(libscsi_hdl_t *, size_t);
2N/Aextern int libscsi_status_fill(libscsi_hdl_t *, libscsi_status_t *,
2N/A uint16_t, size_t);
2N/Aextern void libscsi_status_free(libscsi_hdl_t *, libscsi_status_t *);
2N/A
2N/Aextern int libscsi_set_errno(libscsi_hdl_t *, libscsi_errno_t);
2N/Aextern int libscsi_verror(libscsi_hdl_t *, libscsi_errno_t, const char *,
2N/A va_list);
2N/Aextern int libscsi_error(libscsi_hdl_t *, libscsi_errno_t, const char *, ...);
2N/A
2N/Atypedef const libscsi_engine_t *(*libscsi_engine_init_f)(libscsi_hdl_t *);
2N/A
2N/A/*
2N/A * Generic SCSI utility functions.
2N/A */
2N/Aextern size_t libscsi_cmd_cdblen(libscsi_hdl_t *, uint8_t);
2N/A
2N/A#ifdef __cplusplus
2N/A}
2N/A#endif
2N/A
2N/A#endif /* _LIBSCSI_H */