sddef.h revision f85c7842adab30da40b7225f83b02f9df9fbb1f0
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_SCSI_TARGETS_SDDEF_H
#define _SYS_SCSI_TARGETS_SDDEF_H
#ifdef __cplusplus
extern "C" {
#endif
#define SD_SUCCESS 0
#define SD_FAILURE (-1)
#if defined(TRUE)
#endif
#if defined(FALSE)
#endif
#define TRUE 1
#define FALSE 0
#if defined(VERBOSE)
#endif
#if defined(SILENT)
#endif
/*
* Fault Injection Flag for Inclusion of Code
*
* This should only be defined when SDDEBUG is defined
* #if DEBUG || lint
* #define SD_FAULT_INJECTION
* #endif
*/
#define SD_FAULT_INJECTION
#endif
#define VERBOSE 1
#define SILENT 0
/*
* Structures for recording whether a device is fully open or closed.
* Assumptions:
*
* + There are only 8 (sparc) or 16 (x86) disk slices possible.
* + BLK, MNT, CHR, SWP don't change in some future release!
*/
#if defined(_SUNOS_VTOC_8)
#define SDUNIT_SHIFT 3
#define SDPART_MASK 7
#elif defined(_SUNOS_VTOC_16)
#define SDUNIT_SHIFT 6
#define SDPART_MASK 63
#else
#error "No VTOC format defined."
#endif
/*
* maximum number of partitions the driver keeps track of; with
* EFI this can be larger than the number of partitions accessible
* through the minor nodes. It won't be used for keeping track
* of open counts, partition kstats, etc.
*/
/*
* Macro to retrieve the DDI instance number from the given buf struct.
* The instance number is encoded in the minor device number.
*/
#define SD_GET_INSTANCE_FROM_BUF(bp) \
struct ocinfo {
/*
* Types BLK, MNT, CHR, SWP,
* assumed to be types 0-3.
*/
};
union ocmap {
};
#define SD_CDB_GROUP0 0
#define SD_CDB_GROUP1 1
#define SD_CDB_GROUP5 2
#define SD_CDB_GROUP4 3
struct sd_cdbinfo {
};
/*
* The following declaration are for Non-512 byte block support for the
* removable devices. (ex - DVD RAM, MO).
* wm_state: This is an enumeration for the different states for
* manipalating write range list during the read-modify-write-operation.
*/
typedef enum {
SD_WM_CHK_LIST, /* Check list for overlapping writes */
SD_WM_WAIT_MAP, /* Wait for an overlapping I/O to complete */
SD_WM_LOCK_RANGE, /* Lock the range of lba to be written */
SD_WM_DONE /* I/O complete */
} wm_state;
/*
* sd_w_map: Every write I/O will get one w_map allocated for it which will tell
* the range on the media which is being written for that request.
*/
struct sd_w_map {
void *wm_private; /* Used to store bp->b_private */
};
/*
* This is the struct for the layer-private data area for the
* mapblocksize layer.
*/
struct sd_mapblocksize_info {
void *mbs_oprivate; /* saved value of xb_private */
int mbs_layer_index; /* chain index for RMW */
};
/*
* sd_lun: The main data structure for a scsi logical unit.
* Stored as the softstate structure for each device.
*/
struct sd_lun {
/* Back ptr to the SCSA scsi_device struct for this LUN */
struct scsi_device *un_sd;
/*
* Support for Auto-Request sense capability
*/
int un_sense_isbusy; /* Busy flag for RQS buf */
/*
* These specify the layering chains to use with this instance. These
* are initialized according to the values in the sd_chain_index_map[]
* array. See the description of sd_chain_index_map[] for details.
*/
int un_buf_chain_type;
int un_uscsi_chain_type;
int un_direct_chain_type;
/* Head & tail ptrs to the queue of bufs awaiting transport */
struct buf *un_waitq_headp;
struct buf *un_waitq_tailp;
/* Ptr to the buf currently being retried (NULL if none) */
struct buf *un_retry_bp;
/* This tracks the last kstat update for the un_retry_bp buf */
void (*un_retry_statp)(kstat_io_t *);
void *un_xbuf_attr; /* xbuf attribute struct */
/* System logical block size, in bytes. (defaults to DEV_BSIZE.) */
/* The size of a logical block on the target, in bytes. */
/*
* The number of logical blocks on the target. This is adjusted
* to be in terms of the block size specified by un_sys_blocksize
* (ie, the system block size).
*/
/*
* Various configuration data
*/
char *un_node_type; /* minor node type */
/* (4356701, 4367306) */
int un_mincdb; /* Smallest CDB to use */
int un_maxcdb; /* Largest CDB to use */
int un_max_hba_cdb; /* Largest CDB supported by HBA */
int un_status_len;
int un_pkt_flags;
/*
* Note: un_uscsi_timeout is a "mirror" of un_cmd_timeout, adjusted
* for ISCD(). Any updates to un_cmd_timeout MUST be reflected
* in un_uscsi_timeout as well!
*/
/*
* Info on current states, statuses, etc. (Updated frequently)
*/
int un_tagflags; /* Pkt Flags for Tagged Queueing */
short un_resvd_status; /* Reservation Status */
/*
* Control & status info for command throttling
*/
long un_ncmds_in_driver; /* number of cmds in driver */
short un_ncmds_in_transport; /* number of cmds in transport */
short un_throttle; /* max #cmds allowed in transport */
short un_saved_throttle; /* saved value of un_throttle */
short un_busy_throttle; /* saved un_throttle for BUSY */
short un_min_throttle; /* min value of un_throttle */
/*
* Multi-host (clustering) support
*/
/* Event callback resources (photon) */
/* cycle page */
/*
* Data structures for open counts, partition info, VTOC,
* stats, and other such bookkeeping info.
*/
/*
* Bit fields for various configuration/state/status info.
* Comments indicate the condition if the value of the
* variable is TRUE (nonzero).
*/
/* currently enabled */
/* value is currently valid */
/* value is currently valid */
/* a part of error recovery. */
/* channel */
/* supported */
/* executing a FORMAT cmd. */
/* Host Adapter */
/* serial number. */
/* disabled. */
/* writes before transfer to */
/* physical media complete */
/* throttling */
/* instance */
/* partition kstats are */
/* enabled. */
/* SCSI Logical Unit Reset */
un_f_reserved1 :1;
/* when being opened */
/* for sense data */
/* START-STOP command is */
/* supported by hardware */
/* before issuing it */
/* monitor device state */
/* device is attached */
/* default to NO */
/* progress */
/* write cache */
/* bit is supported */
/* SYNC CACHE needs to be */
/* sent in sdclose */
un_f_reserved :13;
struct scsi_asq_key_strings *un_additional_codes;
/*
* Power Management support.
*
* un_pm_mutex protects, un_pm_count, un_pm_timeid, un_pm_busy,
* un_pm_busy_cv, and un_pm_idle_timeid.
* It's not required that SD_MUTEX be acquired before acquiring
* un_pm_mutex, however if they must both be held
* then acquire SD_MUTEX first.
*
* un_pm_count is used to indicate PM state as follows:
* less than 0 the device is powered down,
* transition from 0 ==> 1, mark the device as busy via DDI
* transition from 1 ==> 0, mark the device as idle via DDI
*/
int un_pm_count; /* indicates pm state */
short un_power_level; /* Power Level */
/* Resources used for media change callback support */
/* Non-512 byte block support */
/* For timeout callback to issue a START STOP UNIT command */
/* Timeout callback handle for SD_PATH_DIRECT_PRIORITY cmd restarts */
/* TRAN_FATAL_ERROR count. Cleared by TRAN_ACCEPT from scsi_transport */
/*
* Count to determine if a Sonoma controller is in the process of
* failing over, and how many I/O's are failed with the 05/94/01
* sense code.
*/
/*
* Support for failfast operation.
*/
struct buf *un_failfast_bp;
struct buf *un_failfast_headp;
struct buf *un_failfast_tailp;
/* Callback routine active counter */
short un_in_callback;
/* un_f_write_cache_enabled */
#ifdef SD_FAULT_INJECTION
/* SD Fault Injection */
#define SD_FI_MAX_BUF 65536
#define SD_FI_MAX_ERROR 1024
char sd_fi_log[SD_FI_MAX_BUF];
#endif
/*
* Pointer to internal struct sd_fm_internal in which
* will pass necessary information for FMA ereport posting.
*/
void *un_fm_private;
};
/*
* Macros for conversions between "target" and "system" block sizes, and
* for conversion between block counts and byte counts. As used here,
* "system" block size refers to the block size used by the kernel/
* filesystem (this includes the disk label). The "target" block size
* is the block size returned by the SCSI READ CAPACITY command.
*
* Note: These macros will round up to the next largest blocksize to accomodate
* the number of blocks specified.
*/
/* Convert a byte count to a number of target blocks */
/* Convert a target block count to a number of bytes */
/* Convert a byte count to a number of system blocks */
/* Convert a system block count to a number of bytes */
/*
* Calculate the number of bytes needed to hold the requested number of bytes
*/
/*
* Calculate the byte offset from the beginning of the target block
* to the system block location.
*/
/*
* Calculate the target block location from the system block location
*/
/*
* SD_DEFAULT_MAX_XFER_SIZE is the default value to bound the max xfer
* for physio, for devices without tagged queuing enabled.
* The default for devices with tagged queuing enabled is SD_MAX_XFER_SIZE
*/
#endif
/*
* Warlock annotations
*/
#ifdef SD_FAULT_INJECTION
#endif
/* _NOTE(LOCK_ORDER(sd_lun::un_sd.sd_mutex sd_lun::un_pm_mutex)) */
/*
* Referenced for frequently-accessed members of the unit structure
*/
/*
* Values for un_ctype
*/
#define CTYPE_CDROM 0
#define CTYPE_CCS 2
#define CTYPE_ROD 3
/*
* This macro checks the vendor of the device to see if it is LSI. Because
* LSI has some devices out there that return 'Symbios' or 'SYMBIOS', we
* need to check for those also.
*
* This is used in some vendor specific checks.
*/
/*
* Macros to check if the lun is a Sun T3 or a T4
*/
/*
* Macros for non-512 byte writes to removable devices.
*/
#define NOT_DEVBSIZE(un) \
/*
* Check that a write map, used for locking lba ranges for writes, is in
* the linked list.
*/
/*
* Free a write map which is on list. Basically make sure that nobody is
* sleeping on it before freeing it.
*/
if (!(wmp)->wm_wanted_count) { \
}
} else { \
}
/*
* Values used to in wm_flags field of sd_w_map.
*/
/* Device error kstats */
struct sd_errstats {
struct kstat_named sd_softerrs;
struct kstat_named sd_harderrs;
struct kstat_named sd_transerrs;
struct kstat_named sd_vid;
struct kstat_named sd_pid;
struct kstat_named sd_revision;
struct kstat_named sd_serial;
struct kstat_named sd_capacity;
struct kstat_named sd_rq_media_err;
struct kstat_named sd_rq_ntrdy_err;
struct kstat_named sd_rq_nodev_err;
struct kstat_named sd_rq_recov_err;
struct kstat_named sd_rq_illrq_err;
struct kstat_named sd_rq_pfa_err;
};
/*
* Structs and definitions for SCSI-3 Persistent Reservation
*/
typedef struct sd_prin_readkeys {
typedef struct sd_readresv_desc {
#if defined(_BIT_FIELDS_LTOH)
scope:4;
#elif defined(_BIT_FIELDS_HTOL)
type:4;
#else
#endif /* _BIT_FIELDS_LTOH */
typedef struct sd_prin_readresv {
typedef struct sd_prout {
#if defined(_BIT_FIELDS_LTOH)
reserved:7;
#elif defined(_BIT_FIELDS_HTOL)
aptpl:1;
#else
#endif /* _BIT_FIELDS_LTOH */
} sd_prout_t;
#define SD_READ_KEYS 0x00
#define SD_READ_RESV 0x01
#define SD_SCSI3_REGISTER 0x00
#define SD_SCSI3_RESERVE 0x01
#define SD_SCSI3_RELEASE 0x02
#define SD_SCSI3_PREEMPTANDABORT 0x05
#define SD_SCSI3_REGISTERANDIGNOREKEY 0x06
/*
* Note: The default init of un_reservation_type is to the value of '0'
* (from the ddi_softs_state_zalloc) which means it is defaulting to SCSI-3
* reservation type. This is ok because during attach we use a SCSI-3
* PRIORITY RESERVE IN command to determine the reservation type, and set
* un_reservation_type for all cases.
*/
#define SD_SCSI3_RESERVATION 0x0
#define SD_SCSI2_RESERVATION 0x1
#define SCSI3_RESV_DESC_LEN 16
/*
* Reservation Status's
*/
#define SD_RELEASE 0x0000
#define SD_RESERVE 0x0001
#define SD_TKOWN 0x0002
#define SD_LOST_RESERVE 0x0004
#define SD_FAILFAST 0x0080
#define SD_WANT_RESERVE 0x0100
#define SD_RESERVATION_CONFLICT 0x0200
#define SD_PRIORITY_RESERVE 0x0400
#define SD_TARGET_IS_UNRESERVED 0
#define SD_TARGET_IS_RESERVED 1
/*
* Save page in mode_select
*/
#define SD_DONTSAVE_PAGE 0
#define SD_SAVE_PAGE 1
/*
* Delay before reclaiming reservation is 6 seconds, in units of micro seconds
*/
#define SD_REINSTATE_RESV_DELAY 6000000
/*
* Resource type definitions for multi host control operations. Specifically,
* queue and request definitions for reservation request handling between the
* scsi facility callback function (sd_mhd_watch_cb) and the reservation
* reclaim thread (sd_resv_reclaim_thread)
*/
struct sd_thr_request {
struct sd_thr_request *sd_thr_req_next;
};
struct sd_resv_reclaim_request {
struct sd_thr_request *srq_thr_req_head;
struct sd_thr_request *srq_thr_cur_req;
};
/*
* Driver Logging Components
*
* These components cover the functional entry points and areas of the
* driver. A component value is used for the entry point and utility
* functions used by the entry point. The common component value is used
* in those routines that are called from many areas of the driver.
*
* set sd:sd_component_mask=0x00080000
* set sd:sd_level_mask=0x00000008
*/
#define SD_LOG_PROBE 0x00000001
#define SD_LOG_ATTACH_DETACH 0x00000002
#define SD_LOG_OPEN_CLOSE 0x00000004
#define SD_LOG_READ_WRITE 0x00000008
#define SD_LOG_POWER 0x00000010
#define SD_LOG_IOCTL 0x00000020
#define SD_LOG_IOCTL_MHD 0x00000040
#define SD_LOG_IOCTL_RMMEDIA 0x00000080
#define SD_LOG_IOCTL_DKIO 0x00000100
#define SD_LOG_IO 0x00000200
#define SD_LOG_IO_CORE 0x00000400
#define SD_LOG_IO_DISKSORT 0x00000800
#define SD_LOG_IO_PARTITION 0x00001000
#define SD_LOG_IO_RMMEDIA 0x00002000
#define SD_LOG_IO_CHKSUM 0x00004000
#define SD_LOG_IO_SDIOCTL 0x00008000
#define SD_LOG_IO_PM 0x00010000
#define SD_LOG_ERROR 0x00020000
#define SD_LOG_DUMP 0x00040000
#define SD_LOG_COMMON 0x00080000
#define SD_LOG_SDTEST 0x00100000
#define SD_LOG_IOERR 0x00200000
#define SD_LOG_IO_FAILFAST 0x00400000
/* Driver Logging Levels */
#define SD_LOGMASK_ERROR 0x00000001
#define SD_LOGMASK_DUMP_MEM 0x00000002
#define SD_LOGMASK_INFO 0x00000004
#define SD_LOGMASK_TRACE 0x00000008
#define SD_LOGMASK_DIAG 0x00000010
/* Driver Logging Formats */
#define SD_LOG_HEX 0x00000001
#define SD_LOG_CHAR 0x00000002
/*
* The following macros should be used to log driver debug information
* only. The output is filtered according to the component and level mask
* values. Non-debug information, such as driver warnings intended for
* the user should be logged via the scsi_log facility to ensure that
* they are not filtered.
*/
#define SDDEBUG
/* SD_ERROR is called to log driver error conditions */
#define SD_ERROR sd_log_err
#define SD_TRACE sd_log_trace
/* SD_INFO is called to log general purpose driver info */
#define SD_INFO sd_log_info
/* SD_DUMP_MEMORY is called to dump a data buffer to the log */
#define SD_DUMP_MEMORY sd_dump_memory
#ifdef SD_FAULT_INJECTION
/*
* sd_fi_pkt replicates the variables that are exposed through pkt
*
* sd_fi_xb replicates the variables that are exposed through xb
*
* sd_fi_un replicates the variables that are exposed through un
*
* sd_fi_arq replicates the variables that are
* exposed for Auto-Reqeust-Sense
*
*/
struct sd_fi_pkt {
};
struct sd_fi_xb {
short xb_retry_count;
short xb_victim_retry_count;
};
struct sd_fi_un {
short un_resvd_status;
};
struct sd_fi_arq {
struct scsi_status sts_status;
struct scsi_status sts_rqpkt_status;
struct scsi_extended_sense sts_sensedata;
};
/*
* Conditional set def
*/
#define SD_CONDSET(a, b, c, d) \
{ \
a->c = ((fi_ ## b)->c); \
"sd_fault_injection:" \
"setting %s to %d\n", \
d, ((fi_ ## b)->c)); \
}
/* SD FaultInjection ioctls */
#endif
#else
#define SD_ERROR { if (0) sd_log_err; }
#define SD_TRACE { if (0) sd_log_trace; }
#define SD_INFO { if (0) sd_log_info; }
#define SD_DUMP_MEMORY { if (0) sd_dump_memory; }
#endif
/*
* Miscellaneous macros
*/
} \
} \
if (! (lunp)->un_f_is_fibre && \
SCSI_ADDR_PROP_LUN, 0); \
if (_lun > 0) { \
} \
}
/*
* Disk driver states
*/
#define SD_STATE_NORMAL 0
#define SD_STATE_OFFLINE 1
#define SD_STATE_RWAIT 2
#define SD_STATE_DUMPING 3
#define SD_STATE_SUSPENDED 4
#define SD_STATE_PM_CHANGING 5
/*
* The table is to be interpreted as follows: The rows lists all the states
* and each column is a state that a state in each row *can* reach. The entries
* in the table list the event that cause that transition to take place.
* For e.g.: To go from state RWAIT to SUSPENDED, event (d)-- which is the
* invocation of DDI_SUSPEND-- has to take place. Note the same event could
* cause the transition from one state to two different states. e.g., from
* state SUSPENDED, when we get a DDI_RESUME, we just go back to the *last
* state* whatever that might be. (NORMAL or OFFLINE).
*
*
* State Transition Table:
*
* NORMAL OFFLINE RWAIT DUMPING SUSPENDED PM_SUSPENDED
*
* NORMAL - (a) (b) (c) (d) (h)
*
* OFFLINE (e) - (e) (c) (d) NP
*
* RWAIT (f) NP - (c) (d) (h)
*
* DUMPING NP NP NP - NP NP
*
* SUSPENDED (g) (g) (b) NP* - NP
*
* PM_SUSPENDED (i) NP (b) (c) (d) -
*
* NP : Not Possible.
* (a): Disk does not respond.
* (b): Packet Allocation Fails
* (c): Panic - Crash dump
* (d): DDI_SUSPEND is called.
* (e): Disk has a successful I/O completed.
* (f): sdrunout() calls sdstart() which sets it NORMAL
* (g): DDI_RESUME is called.
* (h): Device threshold exceeded pm framework called power
* entry point or pm_lower_power called in detach.
* (i): When new I/O come in.
* * : When suspended, we dont change state during panic dump
*/
#define SD_MAX_THROTTLE 256
#define SD_MIN_THROTTLE 8
/*
* Lowest valid max. and min. throttle value.
* This is set to 2 because if un_min_throttle were allowed to be 1 then
* un_throttle would never get set to a value less than un_min_throttle
* (0 is a special case) which means it would never get set back to
* un_saved_throttle in routine sd_restore_throttle().
*/
#define SD_LOWEST_VALID_THROTTLE 2
/* Return codes for sd_send_polled_cmd() and sd_scsi_poll() */
#define SD_CMD_SUCCESS 0
#define SD_CMD_FAILURE 1
#define SD_CMD_RESERVATION_CONFLICT 2
#define SD_CMD_ILLEGAL_REQUEST 3
#define SD_CMD_BECOMING_READY 4
#define SD_CMD_CHECK_CONDITION 5
/* Return codes for sd_ready_and_valid */
#define SD_READY_VALID 0
#define SD_NOT_READY_VALID 1
#define SD_RESERVED_BY_OTHERS 2
#define SD_PATH_STANDARD 0
#define SD_PATH_DIRECT 1
#define SD_PATH_DIRECT_PRIORITY 2
#define SD_UNIT_ATTENTION_RETRY 40
/*
* The following three are bit flags passed into sd_send_scsi_TEST_UNIT_READY
* to control specific behavior.
*/
#define SD_CHECK_FOR_MEDIA 0x01
#define SD_DONT_RETRY_TUR 0x02
#define SD_BYPASS_PM 0x04
#define SD_GROUP0_MAX_ADDRESS (0x1fffff)
#define SD_GROUP0_MAXCOUNT (0xff)
#define SD_GROUP1_MAX_ADDRESS (0xffffffff)
#define SD_GROUP1_MAXCOUNT (0xffff)
#define SD_BECOMING_ACTIVE 0x01
#define SD_REMOVAL_ALLOW 0
#define SD_REMOVAL_PREVENT 1
#define SD_GET_PKT_OPCODE(pktp) \
#define SD_NO_RETRY_ISSUED 0
#define SD_DELAYED_RETRY_ISSUED 1
#define SD_IMMEDIATE_RETRY_ISSUED 2
#else
#endif
#define SD_RETRIES_MASK 0x00FF
#define SD_RETRIES_NOCHECK 0x0000
#define SD_RETRIES_STANDARD 0x0001
#define SD_RETRIES_VICTIM 0x0002
#define SD_RETRIES_BUSY 0x0003
#define SD_RETRIES_UA 0x0004
#define SD_RETRIES_ISOLATE 0x8000
#define SD_RETRIES_FAILFAST 0x4000
(un)->un_resvd_status |= \
(SD_LOST_RESERVE | SD_WANT_RESERVE); \
} \
}
#define SD_SENSE_DATA_IS_VALID 0
#define SD_SENSE_DATA_IS_INVALID 1
/*
* Delay (in seconds) before restoring the "throttle limit" back
* to its maximum value.
* 60 seconds is what we will wait for to reset the
* throttle back to it SD_MAX_THROTTLE for TRAN_BUSY.
* 10 seconds for STATUS_QFULL because QFULL will incrementally
* increase the throttle limit until it reaches max value.
*/
#define SD_RESET_THROTTLE_TIMEOUT 60
#define SD_QFULL_THROTTLE_TIMEOUT 10
#define SD_THROTTLE_TRAN_BUSY 0
#define SD_THROTTLE_QFULL 1
#define SD_THROTTLE_RESET_INTERVAL \
#define SD_QFULL_THROTTLE_RESET_INTERVAL \
/*
* xb_pkt_flags defines
* SD_XB_DMA_FREED indicates the scsi_pkt has had its DMA resources freed
* by a call to scsi_dmafree(9F). The resources must be reallocated before
* before a call to scsi_transport can be made again.
* SD_XB_USCSICMD indicates the scsi request is a uscsi request
* SD_XB_INITPKT_MASK: since this field is also used to store flags for
* a scsi_init_pkt(9F) call, we need a mask to make sure that we don't
* pass any unintended bits to scsi_init_pkt(9F) (ugly hack).
*/
#define SD_XB_DMA_FREED 0x20000000
#define SD_XB_USCSICMD 0x40000000
/*
* Extension for the buf(9s) struct that we receive from a higher
* layer. Located by b_private in the buf(9S). (The previous contents
* of b_private are saved & restored before calling biodone(9F).)
*/
struct sd_xbuf {
/*
* xb_pktinfo points to any optional data that may be needed
* use might be to point to a struct uscsi_cmd.
*/
void *xb_pktinfo;
/*
* Layer-private data area. This may be used by any layer to store
* layer-specific data on a per-IO basis. Typical usage is for an
* iostart routine to save some info here for later use by its
* partner iodone routine. This area may be used to hold data or
* layer-private area is defined & implemented by each specific
* layer as required.
*
* IMPORTANT: Since a higher layer may depend on the value in the
* xb_private field, each layer must ensure that it returns the
* received by the layer's iostart routine. Typically this is done
* by the iostart routine saving the contents of xb_private into
* a place in the layer-private data area, and the iodone routine
* restoring the value of xb_private before deallocating the
* layer-private data block and calling SD_NEXT_IODONE(). Of course,
* layer, there will be no need to restore the value.
*
* by calling sd_shadow_buf_alloc()) to pass to a lower layer, it is
* not necessary to preserve the contents of xb_private as there is
* no higher layer dependency on the value of xb_private. Such a
* must *NEVER* be passed up to a higher layer.
*/
void *xb_private; /* Layer-private data block */
/*
* We do not use the b_blkno provided in the buf(9S), as we need to
* make adjustments to it in the driver, but it is not a field that
* the driver owns or is free to modify.
*/
int xb_chain_iostart; /* iostart side index */
int xb_chain_iodone; /* iodone side index */
int xb_pkt_flags; /* Flags for scsi_init_pkt() */
short xb_retry_count;
short xb_victim_retry_count;
short xb_ua_retry_count; /* unit_attention retry counter */
short xb_nr_retry_count; /* not ready retry counter */
/*
* Various status and data used when a RQS command is run on
* the behalf of this command.
*/
/*
* Extra sense larger than SENSE_LENGTH will be allocated
* right after xb_sense_data[SENSE_LENGTH]. Please do not
* add any new field after it.
*/
};
#define SD_PKT_ALLOC_SUCCESS 0
#define SD_PKT_ALLOC_FAILURE 1
#define SD_PKT_ALLOC_FAILURE_NO_DMA 2
#define SD_PKT_ALLOC_FAILURE_PKT_TOO_SMALL 3
#define SD_PKT_ALLOC_FAILURE_CDB_TOO_SMALL 4
/*
* Special-purpose struct for sd_send_scsi_cmd() to pass command-specific
* data through the layering chains to sd_initpkt_for_uscsi().
*/
struct sd_uscsi_info {
int ui_flags;
/*
* ui_dkc is used by sd_send_scsi_SYNCHRONIZE_CACHE() to allow
* for async completion notification.
*/
struct dk_callback ui_dkc;
/*
* The following fields are to be used for FMA ereport generation.
*/
};
/*
* This structure is used to issue 'internal' command sequences from the
* driver's attach(9E)/open(9E)/etc entry points. It provides a common context
* for issuing command sequences, with the ability to issue a command
* and provide expected/unexpected assessment of results at any code
* level within the sd_ssc_t scope and preserve the information needed
* produce telemetry for the problem, when needed, from a single
* outer-most-scope point.
*
* The sd_ssc_t abstraction should result in well-structured code where
* the basic code structure is not jeprodized by future localized improvement.
*
* o Scope for a sequence of commands.
* o Within a scoped sequence of commands, provides a single top-level
* location for initiating telementry generation from captured data.
* o Provide a common place to capture command execution data and driver
* assessment information for delivery to telemetry generation point.
* o Mechanism to get device-as-detector (dad) and transport telemetry
* information from interrupt context (sdintr) back to the internal
* command 'driver-assessment' code.
* o Ability to record assessment, and return information back to
* top-level telemetry generation code when an unexpected condition
* occurs.
* o For code paths were an command itself was successful but
* the data returned looks suspect, the ability to record
* 'unexpected data' conditions.
* o Record assessment of issuing the command and interpreting
* the returned data for consumption by top-level ereport telemetry
* generation code.
* o All data required to produce telemetry available off single data
* structure.
*/
typedef struct {
struct uscsi_cmd *ssc_uscsi_cmd;
struct sd_uscsi_info *ssc_uscsi_info;
int ssc_flags; /* Bits for flags */
} sd_ssc_t;
/*
* This struct switch different 'type-of-assessment'
* as an input argument for sd_ssc_assessment
*
*
* in sd_send_scsi_XXX or upper-level
*
* - SD_FMT_IGNORE
* when send uscsi command failed, and
* the following code check sense data properly.
* we use 'ignore' to let sd_ssc_assessment
* trust current and do not do additional
* checking for the uscsi command.
*
* - SD_FMT_IGNORE_COMPROMISE
* when send uscsi command failed, and
* the code does not check sense data or we don't
* think the checking is 100% coverage. We mark it
* as 'compromise' to indicate that we need to
* enhance current code in the future.
*
* - SD_FMT_STATUS_CHECK
* when send uscsi command failed and cause sd entries
* failed finally, we need to send out real reason against
* status of uscsi command no matter if there is sense back
* or not.
*
* - SD_FMT_STANDARD
* when send uscsi command succeeded, and
* the code does not check sense data, we need to check
* it to make sure there is no 'fault'.
*/
enum sd_type_assessment {
SD_FMT_IGNORE = 0,
};
/*
* The following declaration are used as hints of severities when posting
* SCSI FMA ereport.
* - SD_FM_DRV_FATAL
* When posting ereport with SD_FM_DRV_FATAL, the payload
* "driver-assessment" will be "fail" or "fatal" depending on the
* sense-key value. If driver-assessment is "fail", it will be
* propagated to an upset, otherwise, a fault will be propagated.
* - SD_FM_DRV_RETRY
* When posting ereport with SD_FM_DRV_RETRY, the payload
* "driver-assessment" will be "retry", and it will be propagated to an
* upset.
* - SD_FM_DRV_RECOVERY
* When posting ereport with SD_FM_DRV_RECOVERY, the payload
* "driver-assessment" will be "recovered", and it will be propagated to
* an upset.
* - SD_FM_DRV_NOTICE
* When posting ereport with SD_FM_DRV_NOTICE, the payload
* "driver-assessment" will be "info", and it will be propagated to an
* upset.
*/
enum sd_driver_assessment {
SD_FM_DRV_FATAL = 0,
};
/*
* The following structure is used as a buffer when posting SCSI FMA
* ereport for raw i/o. It will be allocated per sd_lun when entering
* sd_unit_attach and will be deallocated when entering sd_unit_detach.
*/
struct sd_fm_internal {
struct sd_uscsi_info fm_uinfo;
int fm_log_level;
};
/*
* Bits in ssc_flags
* sd_ssc_init will mark ssc_flags = SSC_FLAGS_UNKNOWN
* sd_ssc_send will mark ssc_flags = SSC_FLAGS_CMD_ISSUED &
* SSC_FLAGS_NEED_ASSESSMENT
* sd_ssc_assessment will clear SSC_FLAGS_CMD_ISSUED and
* SSC_FLAGS_NEED_ASSESSMENT bits of ssc_flags.
* SSC_FLAGS_CMD_ISSUED is to indicate whether the SCSI command has been
* sent out.
* SSC_FLAGS_NEED_ASSESSMENT is to guarantee we will not miss any
* assessment point.
*/
#define SSC_FLAGS_UNKNOWN 0x00000000
#define SSC_FLAGS_CMD_ISSUED 0x00000001
#define SSC_FLAGS_NEED_ASSESSMENT 0x00000002
#define SSC_FLAGS_TRAN_ABORT 0x00000004
/*
* The following bits in ssc_flags are for detecting unexpected data.
*/
#define SSC_FLAGS_INVALID_PKT_REASON 0x00000010
#define SSC_FLAGS_INVALID_STATUS 0x00000020
#define SSC_FLAGS_INVALID_SENSE 0x00000040
#define SSC_FLAGS_INVALID_DATA 0x00000080
/*
* The following are the values available for sd_fm_internal::fm_log_level.
* SD_FM_LOG_NSUP The driver will log things in traditional way as if
* the SCSI FMA feature is unavailable.
* SD_FM_LOG_SILENT The driver will not print out syslog for FMA error
* telemetry, all the error telemetries will go into
* FMA error log.
* SD_FM_LOG_EREPORT The driver will both print the FMA error telemetry
* and post the error report, but the traditional
* syslog for error telemetry will be suppressed.
*/
#define SD_FM_LOG_NSUP 0
#define SD_FM_LOG_SILENT 1
#define SD_FM_LOG_EREPORT 2
/*
* Macros and definitions for driver kstats and errstats
*
* Some third-party layered drivers (they know who they are) do not maintain
* messed up & results in panics. These macros will update the driver kstats
* only if the counts are valid.
*/
if ((kstat_function) == kstat_runq_exit || \
((kstat_function) == kstat_runq_back_to_waitq)) { \
kstat_function((kstatp)); \
} else { \
"kstat rcnt == 0 when exiting runq, please check\n"); \
} \
} else if ((kstat_function) == kstat_waitq_exit || \
((kstat_function) == kstat_waitq_to_runq)) { \
kstat_function(kstatp); \
} else { \
"kstat wcnt == 0 when exiting waitq, please check\n"); \
} \
} else { \
kstat_function(kstatp); \
}
} \
} \
}
#define SD_UPDATE_ERRSTATS(un, x) \
struct sd_errstats *stp; \
}
} else { \
} \
}
{ \
} else { \
} \
} \
}
#endif /* defined(_KERNEL) || defined(_KMEMUSER) */
/*
* 60 seconds is a *very* reasonable amount of time for most slow CD
* operations.
*/
#define SD_IO_TIME 60
/*
* 2 hours is an excessively reasonable amount of time for format operations.
*/
/*
* 5 seconds is what we'll wait if we get a Busy Status back
*/
/*
* 100 msec. is what we'll wait if we get Unit Attention.
*/
/*
* 100 msec. is what we'll wait for restarted commands.
*/
/*
* 100 msec. is what we'll wait for certain retries for fibre channel
* targets, 0 msec for parallel SCSI.
*/
#if defined(__fibre)
#else
#define SD_RETRY_DELAY ((clock_t)0)
#endif
/*
* 60 seconds is what we will wait for to reset the
* throttle back to it SD_MAX_THROTTLE.
*/
#define SD_RESET_THROTTLE_TIMEOUT 60
/*
* Number of times we'll retry a normal operation.
*
* This includes retries due to transport failure
* (need to distinguish between Target and Transport failure)
*
*/
#if defined(__fibre)
#define SD_RETRY_COUNT 3
#else
#define SD_RETRY_COUNT 5
#endif
/*
* Number of times we will retry for unit attention.
*/
#define SD_UA_RETRY_COUNT 600
/*
* Maximum number of units we can support
* (controlled by room in minor device byte)
*
* Note: this value is out of date.
*/
#define SD_MAXUNIT 32
/*
* 30 seconds is what we will wait for the IO to finish
* before we fail the DDI_SUSPEND
*/
#define SD_WAIT_CMDS_COMPLETE 30
/*
*/
#define SD_REMOVAL_ALLOW 0
#define SD_REMOVAL_PREVENT 1
/*
* Drive Types (and characteristics)
*/
#define VIDMAX 8
#define PIDMAX 16
/*
* The following #defines and type definitions for the property
* processing component of the sd driver.
*/
/* Miscellaneous Definitions */
#define SD_CONF_VERSION_1 1
#define SD_CONF_NOT_USED 32
/*
* Return values from "pm-capable" property
*/
#define SD_PM_CAPABLE_UNDEFINED -1
#define SD_PM_CAPABLE_FALSE 0
#define SD_PM_CAPABLE_TRUE 1
/*
* Property data values used in static configuration table
* These are all based on device characteristics.
* For fibre channel devices, the throttle value is usually
* derived from the devices cmd Q depth divided by the number
* of supported initiators.
*/
#define ELITE_THROTTLE_VALUE 10
#define SEAGATE_THROTTLE_VALUE 15
#define IBM_THROTTLE_VALUE 15
#define ST31200N_THROTTLE_VALUE 8
#define FUJITSU_THROTTLE_VALUE 15
#define SYMBIOS_THROTTLE_VALUE 16
#define SYMBIOS_NOTREADY_RETRIES 24
#define LSI_THROTTLE_VALUE 16
#define LSI_NOTREADY_RETRIES 24
#define LSI_OEM_NOTREADY_RETRIES 36
#define PURPLE_THROTTLE_VALUE 64
#define PURPLE_BUSY_RETRIES 60
#define PURPLE_RESET_RETRY_COUNT 36
#define PURPLE_RESERVE_RELEASE_TIME 60
#define SVE_BUSY_RETRIES 60
#define SVE_RESET_RETRY_COUNT 36
#define SVE_RESERVE_RELEASE_TIME 60
#define SVE_THROTTLE_VALUE 10
#define SVE_MIN_THROTTLE_VALUE 2
#define SVE_DISKSORT_DISABLED_FLAG 1
#define MASERATI_DISKSORT_DISABLED_FLAG 1
#define MASERATI_LUN_RESET_ENABLED_FLAG 1
#define PIRUS_THROTTLE_VALUE 64
#define PIRUS_NRR_COUNT 60
#define PIRUS_BUSY_RETRIES 60
#define PIRUS_RESET_RETRY_COUNT 36
#define PIRUS_MIN_THROTTLE_VALUE 16
#define PIRUS_DISKSORT_DISABLED_FLAG 0
#define PIRUS_LUN_RESET_ENABLED_FLAG 1
/*
* Driver Property Bit Flag definitions
*
* Unfortunately, for historical reasons, the bit-flag definitions are
* different on SPARC, INTEL, & FIBRE platforms.
*/
/*
* Bit flag telling driver to set throttle from sd.conf sd-config-list
* and driver table.
*
* The max throttle (q-depth) property implementation is for support of
* fibre channel devices that can drop an i/o request when a queue fills
* up. The number of commands sent to the disk from this driver is
* regulated such that queue overflows are avoided.
*/
#define SD_CONF_SET_THROTTLE 0
/*
* Bit flag telling driver to set the controller type from sd.conf
* sd-config-list and driver table.
*/
#define SD_CONF_SET_CTYPE 1
#define SD_CONF_SET_CTYPE 5
#else
#define SD_CONF_SET_CTYPE 1
#endif
/*
* Bit flag telling driver to set the not ready retry count for a device from
* sd.conf sd-config-list and driver table.
*/
#define SD_CONF_SET_NOTREADY_RETRIES 10
#define SD_CONF_SET_NOTREADY_RETRIES 1
#else
#define SD_CONF_SET_NOTREADY_RETRIES 2
#endif
/*
* Bit flag telling driver to set SCSI status BUSY Retries from sd.conf
* sd-config-list and driver table.
*/
#define SD_CONF_SET_BUSY_RETRIES 11
#define SD_CONF_SET_BUSY_RETRIES 2
#else
#define SD_CONF_SET_BUSY_RETRIES 5
#endif
/*
* number.
*/
#define SD_CONF_SET_FAB_DEVID 2
#else
#define SD_CONF_SET_FAB_DEVID 3
#endif
/*
* Bit flag telling driver to disable all caching for disk device.
*/
#define SD_CONF_SET_NOCACHE 3
#else
#define SD_CONF_SET_NOCACHE 4
#endif
/*
* Bit flag telling driver that the PLAY AUDIO command requires parms in BCD
* format rather than binary.
*/
#define SD_CONF_SET_PLAYMSF_BCD 4
#else
#define SD_CONF_SET_PLAYMSF_BCD 6
#endif
/*
* Bit flag telling driver that the response from the READ SUBCHANNEL command
* has BCD fields rather than binary.
*/
#define SD_CONF_SET_READSUB_BCD 5
#else
#define SD_CONF_SET_READSUB_BCD 7
#endif
/*
* Bit in flags telling driver that the track number fields in the READ TOC
* request and respone are in BCD rather than binary.
*/
#define SD_CONF_SET_READ_TOC_TRK_BCD 6
#else
#define SD_CONF_SET_READ_TOC_TRK_BCD 8
#endif
/*
* Bit flag telling driver that the address fields in the READ TOC request and
* respone are in BCD rather than binary.
*/
#define SD_CONF_SET_READ_TOC_ADDR_BCD 7
#else
#define SD_CONF_SET_READ_TOC_ADDR_BCD 9
#endif
/*
* Bit flag telling the driver that the device doesn't support the READ HEADER
* command.
*/
#define SD_CONF_SET_NO_READ_HEADER 8
#else
#define SD_CONF_SET_NO_READ_HEADER 10
#endif
/*
* Bit flag telling the driver that for the READ CD command the device uses
* opcode 0xd4 rather than 0xbe.
*/
#define SD_CONF_SET_READ_CD_XD4 9
#else
#define SD_CONF_SET_READ_CD_XD4 11
#endif
/*
* Bit flag telling the driver to set SCSI status Reset Retries
* (un_reset_retry_count) from sd.conf sd-config-list and driver table (4356701)
*/
#define SD_CONF_SET_RST_RETRIES 12
/*
* Bit flag telling the driver to set the reservation release timeout value
* from sd.conf sd-config-list and driver table. (4367306)
*/
#define SD_CONF_SET_RSV_REL_TIME 13
/*
* Bit flag telling the driver to verify that no commands are pending for a
* device before issuing a Test Unit Ready. This is a fw workaround for Seagate
* eliteI drives. (4392016)
*/
#define SD_CONF_SET_TUR_CHECK 14
/*
* Bit in flags telling driver to set min. throttle from ssd.conf
* ssd-config-list and driver table.
*/
#define SD_CONF_SET_MIN_THROTTLE 15
/*
* Bit in flags telling driver to set disksort disable flag from ssd.conf
* ssd-config-list and driver table.
*/
#define SD_CONF_SET_DISKSORT_DISABLED 16
/*
* Bit in flags telling driver to set LUN Reset enable flag from [s]sd.conf
* [s]sd-config-list and driver table.
*/
#define SD_CONF_SET_LUN_RESET_ENABLED 17
/*
* Bit in flags telling driver that the write cache on the device is
* non-volatile.
*/
#define SD_CONF_SET_CACHE_IS_NV 18
/*
* This is the number of items currently settable in the sd.conf
* sd-config-list. The mask value is defined for parameter checking. The
* item count and mask should be updated when new properties are added.
*/
#define SD_CONF_MAX_ITEMS 19
#define SD_CONF_BIT_MASK 0x0007FFFF
typedef struct {
int sdt_throttle;
int sdt_ctype;
int sdt_not_rdy_retries;
int sdt_busy_retries;
int sdt_reset_retries;
int sdt_reserv_rel_time;
int sdt_min_throttle;
int sdt_disk_sort_dis;
int sdt_lun_reset_enable;
} sd_tunables;
/* Type definition for static configuration table entries */
typedef struct sd_disk_config {
char device_id[25];
/*
* byte 4 options for 1bh command
*/
#define SD_TARGET_STOP 0x00
#define SD_TARGET_START 0x01
#define SD_TARGET_EJECT 0x02
#define SD_TARGET_CLOSE 0x03
#define SD_MODE_SENSE_PAGE3_CODE 0x03
#define SD_MODE_SENSE_PAGE4_CODE 0x04
#define SD_MODE_SENSE_PAGE3_LENGTH \
(sizeof (struct mode_format) + MODE_PARAM_LENGTH)
#define SD_MODE_SENSE_PAGE4_LENGTH \
(sizeof (struct mode_geometry) + MODE_PARAM_LENGTH)
/*
* These command codes need to be moved to sys/scsi/generic/commands.h
*/
/* Both versions of the Read CD command */
/* the official SCMD_READ_CD now comes from cdio.h */
/* generation ATAPI CD drives */
/* expected sector type filter values for Play and Read CD CDBs */
/* READ CD filter bits (cdb[9]) */
/*
*/
/*
*/
struct mode_header_grp2 {
/* (if any) */
};
/*
* Length of the Mode Parameter Header for the Group 2 Mode Select command
*/
#define MODE_HEADER_LENGTH_GRP2 (sizeof (struct mode_header_grp2))
/*
* Mode Page 1 - Error Recovery Page
*/
#define MODEPAGE_ERR_RECOVER 1
/*
* The following buffer length define is 8 bytes for the Group 2 mode page
* header, 8 bytes for the block descriptor and 26 bytes for the cdrom
* capabilities page (per MMC-2)
*/
#define MODEPAGE_CDROM_CAP 0x2A
#define MODEPAGE_CDROM_CAP_LEN 26
#define BUFLEN_MODE_CDROM_CAP (MODEPAGE_CDROM_CAP_LEN + \
/*
* Power management defines
*/
#define SD_SPINDLE_UNINIT (-1)
#define SD_SPINDLE_OFF 0
#define SD_SPINDLE_ON 1
#define SD_PM_NOT_SUPPORTED 2
/*
* No Need to resume if already in PM_SUSPEND state because the thread
* was suspended in sdpower. It will be resumed when sdpower is invoked to make
* the device active.
* When the thread is suspended, the watch thread is terminated and
* the token is NULLed so check for this condition.
* If there's a thread that can be resumed, ie. token is not NULL, then
* it can be resumed.
*/
/*
* No Need to resume if already in PM_SUSPEND state because the thread
* was suspended in sdpower. It will be resumed when sdpower is invoked to make
* the device active.
* When the thread is suspended, the watch thread is terminated and
* the token is NULLed so check for this condition.
*/
(un->un_pm_count < 0))
/*
* Could move this define to some thing like log sense.h in SCSA headers
* But for now let it live here.
*/
#define START_STOP_CYCLE_COUNTER_PAGE_SIZE 0x28
#define START_STOP_CYCLE_PAGE 0x0E
#define START_STOP_CYCLE_VU_PAGE 0x31
/* CD-ROM Error Recovery Parameters page (0x01) */
#define MODEPAGE_ERR_RECOV 0x1
/*
* Vendor Specific (Toshiba) CD-ROM Speed page (0x31)
*
* The following buffer length define is 4 bytes for the Group 0 mode page
* header, 8 bytes for the block descriptor and 4 bytes for the mode speed page.
*/
#define MODEPAGE_CDROM_SPEED_LEN 4
#define BUFLEN_MODE_CDROM_SPEED MODEPAGE_CDROM_SPEED_LEN +\
#define SD_SPEED_1X 176
/* CD-ROM Audio Control Parameters page (0x0E) */
#define MODEPAGE_AUDIO_CTRL 0x0E
#define MODEPAGE_AUDIO_CTRL_LEN 16
/* CD-ROM Sony Read Offset Defines */
#define SONY_SESSION_OFFSET_LEN 12
#define SONY_SESSION_OFFSET_KEY 0x40
#define SONY_SESSION_OFFSET_VALID 0x0a
/*
* CD-ROM Write Protect Defines
*
* Bit 7 of the device specific field of the mode page header is the write
* protect bit.
*/
#define WRITE_PROTECT 0x80
/*
* Define for the length of a profile header returned in response to the
* GET CONFIGURATION command
*/
/*
* Define the length of the data in response to the GET CONFIGURATION
* command. The 3rd byte of the feature descriptor contains the
* current feature field that is of interest. This field begins
* after the feature header which is 8 bytes. This variable length
* was increased in size from 11 to 24 because some devices became
* unresponsive with the smaller size.
*/
/*
* Feature codes associated with GET CONFIGURATION command for supported
* devices.
*/
#define RANDOM_WRITABLE 0x20
#define HARDWARE_DEFECT_MANAGEMENT 0x24
/*
* Could move this define to some thing like log sense.h in SCSA headers
* But for now let it live here.
*/
#define TEMPERATURE_PAGE 0x0D
/* delay time used for sd_media_watch_cb delayed cv broadcast */
#define MEDIA_ACCESS_DELAY 2000000
/* SCSI power on or bus device reset additional sense code */
#define SD_SCSI_RESET_SENSE_CODE 0x29
/*
* These defines are for the Vital Product Data Pages in the inquiry command.
* They are the bits in the un_vpd_page mask, telling the supported pages.
*/
/*
* Non-volatile cache support
*
* Bit 1 of the byte 6 in the Extended INQUIRY data VPD page
* is NV_SUP bit: An NV_SUP bit set to one indicates that
* the device server supports a non-volatile cache. An
* NV_SUP bit set to zero indicates that the device
* server may or may not support a non-volatile cache.
*
* Bit 2 of the byte 1 in the SYNC CACHE command is SYNC_NV
* bit: The SYNC_NV bit specifies whether the device server
* is required to synchronize volatile and non-volatile
* caches.
*/
#define SD_VPD_NV_SUP 0x02
#define SD_SYNC_NV_BIT 0x04
/*
* Addition from sddef.intel.h
*/
#define P0_RAW_DISK (NDKMAP)
#endif /* __i386 || __amd64 */
#ifdef __cplusplus
}
#endif
#endif /* _SYS_SCSI_TARGETS_SDDEF_H */