9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * CDDL HEADER START
9a016c63ca347047a236dff12f0da83aac8981d1stevel *
9a016c63ca347047a236dff12f0da83aac8981d1stevel * The contents of this file are subject to the terms of the
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Common Development and Distribution License (the "License").
9a016c63ca347047a236dff12f0da83aac8981d1stevel * You may not use this file except in compliance with the License.
9a016c63ca347047a236dff12f0da83aac8981d1stevel *
9a016c63ca347047a236dff12f0da83aac8981d1stevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9a016c63ca347047a236dff12f0da83aac8981d1stevel * or http://www.opensolaris.org/os/licensing.
9a016c63ca347047a236dff12f0da83aac8981d1stevel * See the License for the specific language governing permissions
9a016c63ca347047a236dff12f0da83aac8981d1stevel * and limitations under the License.
9a016c63ca347047a236dff12f0da83aac8981d1stevel *
9a016c63ca347047a236dff12f0da83aac8981d1stevel * When distributing Covered Code, include this CDDL HEADER in each
9a016c63ca347047a236dff12f0da83aac8981d1stevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9a016c63ca347047a236dff12f0da83aac8981d1stevel * If applicable, add the following below this CDDL HEADER, with the
9a016c63ca347047a236dff12f0da83aac8981d1stevel * fields enclosed by brackets "[]" replaced with your own identifying
9a016c63ca347047a236dff12f0da83aac8981d1stevel * information: Portions Copyright [yyyy] [name of copyright owner]
9a016c63ca347047a236dff12f0da83aac8981d1stevel *
9a016c63ca347047a236dff12f0da83aac8981d1stevel * CDDL HEADER END
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Use is subject to license terms.
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Copyright Siemens 1999
9a016c63ca347047a236dff12f0da83aac8981d1stevel * All rights reserved.
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#ifndef _SYS_SCSI_TARGETS_SGENDEF_H
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define _SYS_SCSI_TARGETS_SGENDEF_H
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#pragma ident "%Z%%M% %I% %E% SMI"
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/types.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/kstat.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/condvar.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/mutex.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/buf.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel#include <sys/scsi/scsi.h>
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#ifdef __cplusplus
9a016c63ca347047a236dff12f0da83aac8981d1stevelextern "C" {
9a016c63ca347047a236dff12f0da83aac8981d1stevel#endif
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IOC (('S' << 16) | ('G' << 8))
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IOC_READY (SGEN_IOC | 0x01)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IOC_DIAG (SGEN_IOC | 0x02)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#if defined(_KERNEL)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_DIAG1 ((1 << 8) | CE_CONT)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_DIAG2 ((2 << 8) | CE_CONT)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_DIAG3 ((3 << 8) | CE_CONT)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevelstruct sgen_errstats {
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_trans_err; /* error trying to transport pkt */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_restart; /* command restart attempted */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_incmp_err; /* command failed to complete */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_autosen_rcv; /* autosense occurred */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_autosen_bad; /* autosense data looks malformed */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_sense_rcv; /* sense fetch occurred */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_sense_bad; /* sense data looks malformed */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_recov_err; /* sense key is KEY_RECOVERABLE */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_nosen_err; /* sense key is KEY_NO_SENSE */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_named_t sgen_unrecov_err; /* sense key indicates other err */
9a016c63ca347047a236dff12f0da83aac8981d1stevel};
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1steveltypedef struct sgen_state {
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct scsi_device *sgen_scsidev; /* pointer to scsi_device */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct uscsi_cmd *sgen_ucmd; /* uscsi command struct */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct buf *sgen_cmdbuf; /* xfer buffer */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct scsi_pkt *sgen_cmdpkt; /* scsi packet for command */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kcondvar_t sgen_cmdbuf_cv; /* cv for cmdbuf */
9a016c63ca347047a236dff12f0da83aac8981d1stevel int sgen_flags; /* see SGEN_FL_* */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct scsi_pkt *sgen_rqspkt; /* request sense packet */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct buf *sgen_rqsbuf; /* request sense xfer buffer */
9a016c63ca347047a236dff12f0da83aac8981d1stevel char *sgen_rqs_sen; /* sense buffer */
9a016c63ca347047a236dff12f0da83aac8981d1stevel int sgen_arq_enabled; /* auto request sense enabled */
9a016c63ca347047a236dff12f0da83aac8981d1stevel int sgen_diag; /* diagnostic output level */
9a016c63ca347047a236dff12f0da83aac8981d1stevel timeout_id_t sgen_restart_timeid; /* timeout for sgen_restart */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kstat_t *sgen_kstats; /* for error statistics */
9a016c63ca347047a236dff12f0da83aac8981d1stevel} sgen_state_t;
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Convenience accessors for sgen_state_t.
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define sgen_mutex sgen_scsidev->sd_mutex
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define sgen_devinfo sgen_scsidev->sd_dev
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define sgen_scsiaddr sgen_scsidev->sd_address
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define sgen_sense sgen_scsidev->sd_sense
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * sgen_flags accessors/mutators
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_FL_OPEN 0x01 /* instance is open */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_FL_SUSP 0x02 /* instance suspended */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_FL_BUSY 0x04 /* command buffer busy */
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define SGEN_FL_EXCL 0x08 /* exclusive open */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_SET_OPEN(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags |= SGEN_FL_OPEN)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_CLR_OPEN(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags &= ~SGEN_FL_OPEN)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IS_OPEN(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel ((((sgen_state_t *)(stp))->sgen_flags & SGEN_FL_OPEN) == SGEN_FL_OPEN)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_SET_SUSP(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags |= SGEN_FL_SUSP)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_CLR_SUSP(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags &= ~SGEN_FL_SUSP)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IS_SUSP(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel ((((sgen_state_t *)(stp))->sgen_flags & SGEN_FL_SUSP) == SGEN_FL_SUSP)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_SET_BUSY(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags |= SGEN_FL_BUSY)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_CLR_BUSY(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel (((sgen_state_t *)(stp))->sgen_flags &= ~SGEN_FL_BUSY)
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IS_BUSY(stp) \
9a016c63ca347047a236dff12f0da83aac8981d1stevel ((((sgen_state_t *)(stp))->sgen_flags & SGEN_FL_BUSY) == SGEN_FL_BUSY)
9a016c63ca347047a236dff12f0da83aac8981d1stevel
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define SGEN_SET_EXCL(stp) \
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock (((sgen_state_t *)(stp))->sgen_flags |= SGEN_FL_EXCL)
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define SGEN_CLR_EXCL(stp) \
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock (((sgen_state_t *)(stp))->sgen_flags &= ~SGEN_FL_EXCL)
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock#define SGEN_IS_EXCL(stp) \
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock ((((sgen_state_t *)(stp))->sgen_flags & SGEN_FL_EXCL) == SGEN_FL_EXCL)
275c9da86e89f8abf71135cf63d9fc23671b2e60eschrock
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * These structures form the driver's database of binding information.
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Inquiry strings and device types from the inquiry-config-list and
9a016c63ca347047a236dff12f0da83aac8981d1stevel * device-type-config-list properties are stored.
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1steveltypedef struct sgen_inq_node {
9a016c63ca347047a236dff12f0da83aac8981d1stevel char *node_vendor; /* up to 8 character vendor */
9a016c63ca347047a236dff12f0da83aac8981d1stevel char *node_product; /* up to 16 character product */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct sgen_inq_node *node_next;
9a016c63ca347047a236dff12f0da83aac8981d1stevel} sgen_inq_node_t;
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1steveltypedef struct sgen_type_node {
9a016c63ca347047a236dff12f0da83aac8981d1stevel uchar_t node_type; /* SCSI device type */
9a016c63ca347047a236dff12f0da83aac8981d1stevel struct sgen_type_node *node_next;
9a016c63ca347047a236dff12f0da83aac8981d1stevel} sgen_type_node_t;
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevelstruct sgen_binddb {
9a016c63ca347047a236dff12f0da83aac8981d1stevel int sdb_init; /* has this been initialized? */
9a016c63ca347047a236dff12f0da83aac8981d1stevel kmutex_t sdb_lock; /* protects this structure */
9a016c63ca347047a236dff12f0da83aac8981d1stevel sgen_inq_node_t *sdb_inq_nodes; /* inquiry binding nodes */
9a016c63ca347047a236dff12f0da83aac8981d1stevel sgen_type_node_t *sdb_type_nodes; /* dev-type binding nodes */
9a016c63ca347047a236dff12f0da83aac8981d1stevel};
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_ESTIMATED_NUM_DEVS 4 /* for soft-state allocation */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * Time to wait before a retry for commands returning Busy Status
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_BSY_TIMEOUT (drv_usectohz(5 * 1000000))
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SGEN_IO_TIME 60 /* seconds */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel/*
9a016c63ca347047a236dff12f0da83aac8981d1stevel * sgen_callback action codes
9a016c63ca347047a236dff12f0da83aac8981d1stevel */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define COMMAND_DONE 0 /* command completed, biodone it */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define COMMAND_DONE_ERROR 1 /* command completed, indicate error */
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define FETCH_SENSE 2 /* CHECK CONDITION, so initiate sense */
9a016c63ca347047a236dff12f0da83aac8981d1stevel /* fetch */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#define SET_BP_ERROR(bp, err) bioerror(bp, err);
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#endif /* defined(_KERNEL) */
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#ifdef __cplusplus
9a016c63ca347047a236dff12f0da83aac8981d1stevel}
9a016c63ca347047a236dff12f0da83aac8981d1stevel#endif
9a016c63ca347047a236dff12f0da83aac8981d1stevel
9a016c63ca347047a236dff12f0da83aac8981d1stevel#endif /* _SYS_SCSI_TARGETS_SGENDEF_H */