libscsi.h revision 2
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * CDDL HEADER START
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * The contents of this file are subject to the terms of the
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * Common Development and Distribution License (the "License").
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * You may not use this file except in compliance with the License.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * See the License for the specific language governing permissions
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * and limitations under the License.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * When distributing Covered Code, include this CDDL HEADER in each
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * If applicable, add the following below this CDDL HEADER, with the
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * fields enclosed by brackets "[]" replaced with your own identifying
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * information: Portions Copyright [yyyy] [name of copyright owner]
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * CDDL HEADER END
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni#define LIBSCSI_STATUS_INVALID ((sam4_status_t)-1)
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni#define LIBSCSI_REASON_INVALID ((libscsi_reason_t)-1)
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni#define LIBSCSI_DEFAULT_ENGINE_PATH "/usr/lib/scsi/plugins/scsi/engines"
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * Flags for action creation. Selected to avoid overlap with the uscsi
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * flags with similar or identical meaning.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_ZERO_LENGTH, /* zero-length allocation requested */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_BADTARGET, /* invalid target specification */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_NOENGINE, /* engine library not found */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_ENGINE_INIT, /* engine initialization failed */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_ENGINE_VER, /* engine version mismatch */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_ENGINE_BADPATH, /* engine path contains no usable components */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_RANGE, /* parameter outside valid range */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni ESCSI_INQUIRY_FAILED, /* initial inquiry command failed */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni REASON_NONSPECIFIC, /* some non-specific reason... */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanonitypedef struct libscsi_target libscsi_target_t;
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanonitypedef struct libscsi_status {
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni uint64_t lss_status; /* SCSI status of this command */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni size_t lss_sense_len; /* Length in bytes of sense data */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni uint8_t *lss_sense_data; /* Pointer to sense data */
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanonitypedef struct libscsi_action libscsi_action_t;
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni void *(*lseo_open)(libscsi_hdl_t *, const void *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni int (*lseo_exec)(libscsi_hdl_t *, void *, libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni const char *(*lseo_target_name)(libscsi_hdl_t *, void *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanonitypedef struct libscsi_engine {
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_hdl_t *libscsi_init(uint_t, libscsi_errno_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_target_t *libscsi_open(libscsi_hdl_t *, const char *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni const void *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_close(libscsi_hdl_t *, libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_hdl_t *libscsi_get_handle(libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_target_name(libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_vendor(libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_product(libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_revision(libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_errno_t libscsi_errno(libscsi_hdl_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_errmsg(libscsi_hdl_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_strerror(libscsi_errno_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_errname(libscsi_errno_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_errno_t libscsi_errcode(const char *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_action_t *libscsi_action_alloc(libscsi_hdl_t *, spc3_cmd_t,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern sam4_status_t libscsi_action_get_status(const libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_reason_t libscsi_action_get_reason(const libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_action_set_timeout(libscsi_action_t *, uint32_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern uint32_t libscsi_action_get_timeout(const libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern uint_t libscsi_action_get_flags(const libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern uint8_t *libscsi_action_get_cdb(const libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_action_get_buffer(const libscsi_action_t *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_action_get_sense(const libscsi_action_t *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_action_parse_sense(const libscsi_action_t *, uint64_t *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_action_set_status(libscsi_action_t *, sam4_status_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_action_set_reason(libscsi_action_t *, libscsi_reason_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_action_set_datalen(libscsi_action_t *, size_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_action_set_senselen(libscsi_action_t *, size_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_exec(libscsi_action_t *, libscsi_target_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_action_free(libscsi_action_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_sense_key_name(uint64_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern const char *libscsi_sense_code_name(uint64_t, uint64_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * Interfaces for engine providers
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void *libscsi_alloc(libscsi_hdl_t *, size_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void *libscsi_zalloc(libscsi_hdl_t *, size_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern char *libscsi_strdup(libscsi_hdl_t *, const char *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_free(libscsi_hdl_t *, void *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern libscsi_status_t *libscsi_status_alloc(libscsi_hdl_t *, size_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_status_fill(libscsi_hdl_t *, libscsi_status_t *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern void libscsi_status_free(libscsi_hdl_t *, libscsi_status_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_set_errno(libscsi_hdl_t *, libscsi_errno_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_verror(libscsi_hdl_t *, libscsi_errno_t, const char *,
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern int libscsi_error(libscsi_hdl_t *, libscsi_errno_t, const char *, ...);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanonitypedef const libscsi_engine_t *(*libscsi_engine_init_f)(libscsi_hdl_t *);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni * Generic SCSI utility functions.
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoniextern size_t libscsi_cmd_cdblen(libscsi_hdl_t *, uint8_t);
b47b5b34b42fa8056577c43496cdb99a4c99f8d7Rafael Vanoni#endif /* _LIBSCSI_H */