sddef.h revision 9e1c849eae563842996c64c805047e840c75fc79
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * CDDL HEADER START
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The contents of this file are subject to the terms of the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Common Development and Distribution License (the "License").
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * You may not use this file except in compliance with the License.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * See the License for the specific language governing permissions
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * and limitations under the License.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When distributing Covered Code, include this CDDL HEADER in each
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * If applicable, add the following below this CDDL HEADER, with the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * fields enclosed by brackets "[]" replaced with your own identifying
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * information: Portions Copyright [yyyy] [name of copyright owner]
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * CDDL HEADER END
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * Use is subject to license terms.
3db86aab554edbb4244c8d1a1c90f152eee768afstevelextern "C" {
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#if defined(TRUE)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#if defined(FALSE)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#if defined(SILENT)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Fault Injection Flag for Inclusion of Code
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This should only be defined when SDDEBUG is defined
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * #if DEBUG || lint
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * #define SD_FAULT_INJECTION
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * Structures for recording whether a device is fully open or closed.
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * + There are only 8 (sparc) or 16 (x86) disk slices possible.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * + BLK, MNT, CHR, SWP don't change in some future release!
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * maximum number of partitions the driver keeps track of; with
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * EFI this can be larger than the number of partitions accessible
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * through the minor nodes. It won't be used for keeping track
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * of open counts, partition kstats, etc.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Macro to retrieve the DDI instance number from the given buf struct.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The instance number is encoded in the minor device number.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Types BLK, MNT, CHR, SWP,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * assumed to be types 0-3.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uchar_t sc_grpmask; /* CDB group code mask (for cmd opcode) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint64_t sc_maxlba; /* Maximum logical block addr. supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint32_t sc_maxlen; /* Maximum transfer length supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following declaration are for Non-512 byte block support for the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * removable devices. (ex - DVD RAM, MO).
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * wm_state: This is an enumeration for the different states for
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * manipalating write range list during the read-modify-write-operation.
3db86aab554edbb4244c8d1a1c90f152eee768afsteveltypedef enum {
3db86aab554edbb4244c8d1a1c90f152eee768afstevel SD_WM_CHK_LIST, /* Check list for overlapping writes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel SD_WM_WAIT_MAP, /* Wait for an overlapping I/O to complete */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel SD_WM_LOCK_RANGE, /* Lock the range of lba to be written */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_w_map: Every write I/O will get one w_map allocated for it which will tell
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the range on the media which is being written for that request.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ushort_t wm_wanted_count; /* # of threads waiting for region */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct sd_w_map *wm_next; /* Forward pointed to sd_w_map */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct sd_w_map *wm_prev; /* Back pointer to sd_w_map */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel kcondvar_t wm_avail; /* Sleep on this, while not available */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_w_map::wm_flags))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This is the struct for the layer-private data area for the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * mapblocksize layer.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct sd_w_map *mbs_wmp; /* ptr to write-map struct for RMW */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_mapblocksize_info))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_lun: The main data structure for a scsi logical unit.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Stored as the softstate structure for each device.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Back ptr to the SCSA scsi_device struct for this LUN */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Support for Auto-Request sense capability
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct scsi_pkt *un_rqs_pktp; /* ptr to request sense scsi_pkt */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * These specify the layering chains to use with this instance. These
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * are initialized according to the values in the sd_chain_index_map[]
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * array. See the description of sd_chain_index_map[] for details.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Head & tail ptrs to the queue of bufs awaiting transport */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Ptr to the buf currently being retried (NULL if none) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* This tracks the last kstat update for the un_retry_bp buf */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* System logical block size, in bytes. (defaults to DEV_BSIZE.) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* The size of a logical block on the target, in bytes. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The number of logical blocks on the target. This is adjusted
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * to be in terms of the block size specified by un_sys_blocksize
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (ie, the system block size).
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Various configuration data
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uchar_t un_interconnect_type; /* Interconnect for underlying HBA */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_notready_retry_count; /* Per disk notready retry count */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_busy_retry_count; /* Per disk BUSY retry count */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_victim_retry_count; /* Per disk victim retry count */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* (4356701, 4367306) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_reset_retry_count; /* max io retries before issuing reset */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ushort_t un_reserve_release_time; /* reservation release timeout */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_max_xfer_size; /* Maximum DMA transfer size */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel int un_max_hba_cdb; /* Largest CDB supported by HBA */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Note: un_uscsi_timeout is a "mirror" of un_cmd_timeout, adjusted
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * for ISCD(). Any updates to un_cmd_timeout MUST be reflected
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * in un_uscsi_timeout as well!
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ushort_t un_cmd_timeout; /* Timeout for completion */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ushort_t un_uscsi_timeout; /* Timeout for USCSI completion */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ushort_t un_busy_timeout; /* Timeout for busy retry */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Info on current states, statuses, etc. (Updated frequently)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uchar_t un_last_pkt_reason; /* used to suppress multiple msgs */
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw ulong_t un_detach_count; /* !0 if executing detach routine */
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw ulong_t un_layer_count; /* Current total # of layered opens */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ulong_t un_opens_in_progress; /* Current # of threads in sdopen */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Control & status info for command throttling
3db86aab554edbb4244c8d1a1c90f152eee768afstevel long un_ncmds_in_driver; /* number of cmds in driver */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short un_ncmds_in_transport; /* number of cmds in transport */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short un_throttle; /* max #cmds allowed in transport */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short un_saved_throttle; /* saved value of un_throttle */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short un_busy_throttle; /* saved un_throttle for BUSY */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short un_min_throttle; /* min value of un_throttle */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel timeout_id_t un_reset_throttle_timeid; /* timeout(9F) handle */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Multi-host (clustering) support
3db86aab554edbb4244c8d1a1c90f152eee768afstevel timeout_id_t un_resvd_timeid; /* for resvd recover */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Event callback resources (photon) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ddi_eventcookie_t un_insert_event; /* insert event */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ddi_callback_id_t un_insert_cb_id; /* insert callback */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ddi_eventcookie_t un_remove_event; /* remove event */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ddi_callback_id_t un_remove_cb_id; /* remove callback */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t un_start_stop_cycle_page; /* Saves start/stop */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* cycle page */
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * Data structures for open counts, partition info, VTOC,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * stats, and other such bookkeeping info.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct kstat *un_pstats[NSDMAP]; /* partition statistics */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit fields for various configuration/state/status info.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Comments indicate the condition if the value of the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * variable is TRUE (nonzero).
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* currently enabled */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* value is currently valid */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_tgt_blocksize_is_valid :1, /* The un_tgt_blocksize */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* value is currently valid */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_allow_bus_device_reset :1, /* Driver may issue a BDR as */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* a part of error recovery. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* channel */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_sync_cache_supported :1, /* sync cache cmd supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_format_in_progress :1, /* The device is currently */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* executing a FORMAT cmd. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_opt_queueing :1, /* Enable Command Queuing to */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Host Adapter */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_opt_fab_devid :1, /* Disk has no valid/unique */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* serial number. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_opt_disable_cache :1, /* Read/Write disk cache is */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* disabled. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_write_cache_enabled :1, /* device return success on */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* writes before transfer to */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* physical media complete */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_cfg_playmsf_bcd :1, /* Play Audio, BCD params. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_cfg_readsub_bcd :1, /* READ SUBCHANNEL BCD resp. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_cfg_no_read_header :1, /* READ HEADER not supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_cfg_read_cd_xd4 :1, /* READ CD opcode is 0xd4 */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_mmc_writable_media :1, /* writable media in device */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_dvdram_writable_device :1, /* DVDRAM device is writable */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_cfg_tur_check :1, /* verify un_ncmds before tur */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_use_adaptive_throttle :1, /* enable/disable adaptive */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* throttling */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* instance */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_watcht_stopped :1, /* media watch thread flag */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* partition kstats are */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* enabled. */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_disksort_disabled :1, /* Flag to disable disksort */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_lun_reset_enabled :1, /* Set if target supports */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* SCSI Logical Unit Reset */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_doorlock_supported :1, /* Device supports Doorlock */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_has_removable_media :1, /* has removable media */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_non_devbsize_supported :1, /* non-512 blocksize */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_eject_media_supported :1, /* media can be ejected */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* when being opened */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_descr_format_supported :1, /* support descriptor format */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* for sense data */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* START-STOP command is */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* supported by hardware */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* before issuing it */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel un_f_monitor_media_state :1, /* need a watch thread to */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* monitor device state */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* device is attached */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* default to NO */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* progress */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* write cache */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* bit is supported */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* SYNC CACHE needs to be */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* sent in sdclose */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Ptr to table of strings for ASC/ASCQ error message printing */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Power Management support.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_pm_mutex protects, un_pm_count, un_pm_timeid, un_pm_busy,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_pm_busy_cv, and un_pm_idle_timeid.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * It's not required that SD_MUTEX be acquired before acquiring
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_pm_mutex, however if they must both be held
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * then acquire SD_MUTEX first.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_pm_count is used to indicate PM state as follows:
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * less than 0 the device is powered down,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * transition from 0 ==> 1, mark the device as busy via DDI
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * transition from 1 ==> 0, mark the device as idle via DDI
3db86aab554edbb4244c8d1a1c90f152eee768afstevel kcondvar_t un_disk_busy_cv; /* wait for IO completion */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Resources used for media change callback support */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel enum dkio_state un_mediastate; /* current media state */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel enum dkio_state un_specified_mediastate; /* expected state */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel opaque_t un_swr_token; /* scsi_watch request token */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Non-512 byte block support */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct kmem_cache *un_wm_cache; /* fast alloc in non-512 write case */
193974072f41a843678abf5f61979c748687e66bSherry Moore uint_t un_rmw_count; /* count of read-modify-writes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* For timeout callback to issue a START STOP UNIT command */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Timeout callback handle for SD_PATH_DIRECT_PRIORITY cmd restarts */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* TRAN_FATAL_ERROR count. Cleared by TRAN_ACCEPT from scsi_transport */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Count to determine if a Sonoma controller is in the process of
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * failing over, and how many I/O's are failed with the 05/94/01
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sense code.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Support for failfast operation.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* Callback routine active counter */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* un_f_write_cache_enabled */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* SD Fault Injection */
193974072f41a843678abf5f61979c748687e66bSherry Moore struct sd_fi_pkt *sd_fi_fifo_pkt[SD_FI_MAX_ERROR];
193974072f41a843678abf5f61979c748687e66bSherry Moore struct sd_fi_xb *sd_fi_fifo_xb[SD_FI_MAX_ERROR];
193974072f41a843678abf5f61979c748687e66bSherry Moore struct sd_fi_un *sd_fi_fifo_un[SD_FI_MAX_ERROR];
193974072f41a843678abf5f61979c748687e66bSherry Moore struct sd_fi_arq *sd_fi_fifo_arq[SD_FI_MAX_ERROR];
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Pointer to internal struct sd_fm_internal in which
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * will pass necessary information for FMA ereport posting.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_IS_VALID_LABEL(un) (cmlb_is_valid(un->un_cmlbhandle))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Macros for conversions between "target" and "system" block sizes, and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * for conversion between block counts and byte counts. As used here,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * "system" block size refers to the block size used by the kernel/
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * filesystem (this includes the disk label). The "target" block size
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * is the block size returned by the SCSI READ CAPACITY command.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Note: These macros will round up to the next largest blocksize to accomodate
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the number of blocks specified.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Convert a byte count to a number of target blocks */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ((bytecount + (un->un_tgt_blocksize - 1))/un->un_tgt_blocksize)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Convert a target block count to a number of bytes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Convert a byte count to a number of system blocks */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ((bytecount + (un->un_sys_blocksize - 1))/un->un_sys_blocksize)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Convert a system block count to a number of bytes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Calculate the number of bytes needed to hold the requested number of bytes
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * based upon the native target sector/block size
3db86aab554edbb4244c8d1a1c90f152eee768afstevel (SD_BYTES2TGTBLOCKS(un, bytecount) * (un)->un_tgt_blocksize)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Calculate the byte offset from the beginning of the target block
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * to the system block location.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel (SD_SYSBLOCKS2BYTES(un, sysblk) - SD_TGTBLOCKS2BYTES(un, tgtblk))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Calculate the target block location from the system block location
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ((blockcnt * un->un_sys_blocksize) / un->un_tgt_blocksize)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SD_DEFAULT_MAX_XFER_SIZE is the default value to bound the max xfer
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * for physio, for devices without tagged queuing enabled.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The default for devices with tagged queuing enabled is SD_MAX_XFER_SIZE
193974072f41a843678abf5f61979c748687e66bSherry Moore * Warlock annotations
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_lun))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_reservation_type))
193974072f41a843678abf5f61979c748687e66bSherry Moore_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_mincdb))
193974072f41a843678abf5f61979c748687e66bSherry Moore_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_maxcdb))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_max_hba_cdb))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_status_len))
193974072f41a843678abf5f61979c748687e66bSherry Moore_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_f_arq_enabled))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_cmlbhandle))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("stable data", scsi_device dk_cinfo))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("unique per pkt", scsi_status scsi_cdb))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(MUTEX_PROTECTS_DATA(sd_lun::un_pm_mutex, sd_lun::un_pm_count
3db86aab554edbb4244c8d1a1c90f152eee768afstevel sd_lun::un_pm_timeid sd_lun::un_pm_busy sd_lun::un_pm_busy_cv
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* _NOTE(LOCK_ORDER(sd_lun::un_sd.sd_mutex sd_lun::un_pm_mutex)) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Referenced for frequently-accessed members of the unit structure
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Values for un_ctype
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This macro checks the vendor of the device to see if it is LSI. Because
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * LSI has some devices out there that return 'Symbios' or 'SYMBIOS', we
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * need to check for those also.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This is used in some vendor specific checks.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Macros to check if the lun is a Sun T3 or a T4
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Macros for non-512 byte writes to removable devices.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Check that a write map, used for locking lba ranges for writes, is in
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the linked list.
193974072f41a843678abf5f61979c748687e66bSherry Moore * Free a write map which is on list. Basically make sure that nobody is
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sleeping on it before freeing it.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Values used to in wm_flags field of sd_w_map.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_WTYPE_SIMPLE 0x001 /* Write aligned at blksize boundary */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_WTYPE_RMW 0x002 /* Write requires read-modify-write */
193974072f41a843678abf5f61979c748687e66bSherry Moore/* Device error kstats */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Structs and definitions for SCSI-3 Persistent Reservation
b8a60a54bb33ac7b5184fd07e6a63ae6d365fd69rwtypedef struct sd_prin_readkeys {
3db86aab554edbb4244c8d1a1c90f152eee768afsteveltypedef struct sd_readresv_desc {
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#error One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#endif /* _BIT_FIELDS_LTOH */
3db86aab554edbb4244c8d1a1c90f152eee768afsteveltypedef struct sd_prin_readresv {
193974072f41a843678abf5f61979c748687e66bSherry Mooretypedef struct sd_prout {
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#error One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#endif /* _BIT_FIELDS_LTOH */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Note: The default init of un_reservation_type is to the value of '0'
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (from the ddi_softs_state_zalloc) which means it is defaulting to SCSI-3
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * reservation type. This is ok because during attach we use a SCSI-3
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * PRIORITY RESERVE IN command to determine the reservation type, and set
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_reservation_type for all cases.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Reservation Status's
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Save page in mode_select
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Delay before reclaiming reservation is 6 seconds, in units of micro seconds
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Resource type definitions for multi host control operations. Specifically,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * queue and request definitions for reservation request handling between the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * scsi facility callback function (sd_mhd_watch_cb) and the reservation
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * reclaim thread (sd_resv_reclaim_thread)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(MUTEX_PROTECTS_DATA(sd_resv_reclaim_request::srq_resv_reclaim_mutex,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_thr_request))
193974072f41a843678abf5f61979c748687e66bSherry Moore_NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_prout))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Driver Logging Components
193974072f41a843678abf5f61979c748687e66bSherry Moore * These components cover the functional entry points and areas of the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * driver. A component value is used for the entry point and utility
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * functions used by the entry point. The common component value is used
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * in those routines that are called from many areas of the driver.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This can be done by adding the following two lines to /etc/system:
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * set sd:sd_component_mask=0x00080000
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * set sd:sd_level_mask=0x00000008
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Driver Logging Levels */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Driver Logging Formats */
193974072f41a843678abf5f61979c748687e66bSherry Moore * The following macros should be used to log driver debug information
193974072f41a843678abf5f61979c748687e66bSherry Moore * only. The output is filtered according to the component and level mask
193974072f41a843678abf5f61979c748687e66bSherry Moore * values. Non-debug information, such as driver warnings intended for
193974072f41a843678abf5f61979c748687e66bSherry Moore * the user should be logged via the scsi_log facility to ensure that
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * they are not filtered.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SD_ERROR is called to log driver error conditions */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SD_TRACE is called to log driver trace conditions (function entry/exit) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SD_INFO is called to log general purpose driver info */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SD_DUMP_MEMORY is called to dump a data buffer to the log */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* RESET/ABORTS testing ioctls */
193974072f41a843678abf5f61979c748687e66bSherry Moore * sd_fi_pkt replicates the variables that are exposed through pkt
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_fi_xb replicates the variables that are exposed through xb
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_fi_un replicates the variables that are exposed through un
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_fi_arq replicates the variables that are
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * exposed for Auto-Reqeust-Sense
193974072f41a843678abf5f61979c748687e66bSherry Moore uchar_t pkt_scbp; /* pointer to status block */
193974072f41a843678abf5f61979c748687e66bSherry Moore uchar_t pkt_reason; /* reason completion called */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Conditional set def
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONDSET(a, b, c, d) \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel a->c = ((fi_ ## b)->c); \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel "sd_fault_injection:" \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel "setting %s to %d\n", \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel d, ((fi_ ## b)->c)); \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SD FaultInjection ioctls */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Miscellaneous macros
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_USECTOHZ(x) (drv_usectohz((x)*1000000))
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_GET_PKT_STATUS(pktp) ((*(pktp)->pkt_scbp) & STATUS_MASK)
193974072f41a843678abf5f61979c748687e66bSherry Moore if (_lun > 0) { \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel SD_FILL_SCSI1_LUN_CDB((lunp), (union scsi_cdb *)(pktp)->pkt_cdbp)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Disk driver states
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The table is to be interpreted as follows: The rows lists all the states
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * and each column is a state that a state in each row *can* reach. The entries
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * in the table list the event that cause that transition to take place.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * For e.g.: To go from state RWAIT to SUSPENDED, event (d)-- which is the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * invocation of DDI_SUSPEND-- has to take place. Note the same event could
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * cause the transition from one state to two different states. e.g., from
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * state SUSPENDED, when we get a DDI_RESUME, we just go back to the *last
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * state* whatever that might be. (NORMAL or OFFLINE).
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * State Transition Table:
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * NORMAL OFFLINE RWAIT DUMPING SUSPENDED PM_SUSPENDED
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * NORMAL - (a) (b) (c) (d) (h)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * OFFLINE (e) - (e) (c) (d) NP
193974072f41a843678abf5f61979c748687e66bSherry Moore * RWAIT (f) NP - (c) (d) (h)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * DUMPING NP NP NP - NP NP
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SUSPENDED (g) (g) (b) NP* - NP
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * PM_SUSPENDED (i) NP (b) (c) (d) -
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * NP : Not Possible.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (a): Disk does not respond.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (b): Packet Allocation Fails
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (c): Panic - Crash dump
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (d): DDI_SUSPEND is called.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (e): Disk has a successful I/O completed.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (f): sdrunout() calls sdstart() which sets it NORMAL
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (g): DDI_RESUME is called.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (h): Device threshold exceeded pm framework called power
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * entry point or pm_lower_power called in detach.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (i): When new I/O come in.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * * : When suspended, we dont change state during panic dump
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Lowest valid max. and min. throttle value.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This is set to 2 because if un_min_throttle were allowed to be 1 then
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_throttle would never get set to a value less than un_min_throttle
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (0 is a special case) which means it would never get set back to
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * un_saved_throttle in routine sd_restore_throttle().
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Return codes for sd_send_polled_cmd() and sd_scsi_poll() */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Return codes for sd_ready_and_valid */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following three are bit flags passed into sd_send_scsi_TEST_UNIT_READY
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * to control specific behavior.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ((bp)->b_resid += (pktp)->pkt_resid + (SD_GET_XBUF(bp)->xb_dma_resid))
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_UPDATE_RESERVATION_STATUS(un, pktp) \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ((pktp)->pkt_statistics & (STAT_BUS_RESET | STAT_DEV_RESET))) { \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel if (((un)->un_resvd_status & SD_RESERVE) == SD_RESERVE) { \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Delay (in seconds) before restoring the "throttle limit" back
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * to its maximum value.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 60 seconds is what we will wait for to reset the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * throttle back to it SD_MAX_THROTTLE for TRAN_BUSY.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 10 seconds for STATUS_QFULL because QFULL will incrementally
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * increase the throttle limit until it reaches max value.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * xb_pkt_flags defines
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SD_XB_DMA_FREED indicates the scsi_pkt has had its DMA resources freed
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * by a call to scsi_dmafree(9F). The resources must be reallocated before
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * before a call to scsi_transport can be made again.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SD_XB_USCSICMD indicates the scsi request is a uscsi request
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SD_XB_INITPKT_MASK: since this field is also used to store flags for
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * a scsi_init_pkt(9F) call, we need a mask to make sure that we don't
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * pass any unintended bits to scsi_init_pkt(9F) (ugly hack).
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_XB_INITPKT_MASK (PKT_CONSISTENT | PKT_DMA_PARTIAL)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Extension for the buf(9s) struct that we receive from a higher
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * layer. Located by b_private in the buf(9S). (The previous contents
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * of b_private are saved & restored before calling biodone(9F).)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct scsi_pkt *xb_pktp; /* Ptr to associated scsi_pkt */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * xb_pktinfo points to any optional data that may be needed
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * by the initpkt and/or destroypkt functions. Typical
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * use might be to point to a struct uscsi_cmd.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Layer-private data area. This may be used by any layer to store
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * layer-specific data on a per-IO basis. Typical usage is for an
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * iostart routine to save some info here for later use by its
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * partner iodone routine. This area may be used to hold data or
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * a pointer to a data block that is allocated/freed by the layer's
193974072f41a843678abf5f61979c748687e66bSherry Moore * iostart/iodone routines. Allocation & management policy for the
193974072f41a843678abf5f61979c748687e66bSherry Moore * layer-private area is defined & implemented by each specific
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * layer as required.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * IMPORTANT: Since a higher layer may depend on the value in the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * xb_private field, each layer must ensure that it returns the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * buf/xbuf to the next higher layer (via SD_NEXT_IODONE()) with
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the SAME VALUE in xb_private as when the buf/xbuf was first
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * received by the layer's iostart routine. Typically this is done
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * by the iostart routine saving the contents of xb_private into
193974072f41a843678abf5f61979c748687e66bSherry Moore * a place in the layer-private data area, and the iodone routine
193974072f41a843678abf5f61979c748687e66bSherry Moore * restoring the value of xb_private before deallocating the
193974072f41a843678abf5f61979c748687e66bSherry Moore * layer-private data block and calling SD_NEXT_IODONE(). Of course,
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * if a layer never modifies xb_private in a buf/xbuf from a higher
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * layer, there will be no need to restore the value.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Note that in the case where a layer _creates_ a buf/xbuf (such as
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * by calling sd_shadow_buf_alloc()) to pass to a lower layer, it is
193974072f41a843678abf5f61979c748687e66bSherry Moore * not necessary to preserve the contents of xb_private as there is
193974072f41a843678abf5f61979c748687e66bSherry Moore * no higher layer dependency on the value of xb_private. Such a
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * buf/xbuf must be deallocated by the layer that allocated it and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * must *NEVER* be passed up to a higher layer.
193974072f41a843678abf5f61979c748687e66bSherry Moore * We do not use the b_blkno provided in the buf(9S), as we need to
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * make adjustments to it in the driver, but it is not a field that
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the driver owns or is free to modify.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint64_t xb_ena; /* ena for a specific SCSI command */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short xb_ua_retry_count; /* unit_attention retry counter */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel short xb_nr_retry_count; /* not ready retry counter */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Various status and data used when a RQS command is run on
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the behalf of this command.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct buf *xb_sense_bp; /* back ptr to buf, for RQS */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uint_t xb_sense_state; /* scsi_pkt state of RQS command */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel ssize_t xb_sense_resid; /* residual of RQS command */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uchar_t xb_sense_status; /* scsi status byte of RQS command */
193974072f41a843678abf5f61979c748687e66bSherry Moore uchar_t xb_sense_data[SENSE_LENGTH]; /* sense data from RQS cmd */
193974072f41a843678abf5f61979c748687e66bSherry Moore * Extra sense larger than SENSE_LENGTH will be allocated
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * right after xb_sense_data[SENSE_LENGTH]. Please do not
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * add any new field after it.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("unique per pkt", sd_xbuf))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_GET_XBUF(bp) ((struct sd_xbuf *)((bp)->b_private))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_GET_BLKNO(bp) ((SD_GET_XBUF(bp))->xb_blkno)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Special-purpose struct for sd_send_scsi_cmd() to pass command-specific
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * data through the layering chains to sd_initpkt_for_uscsi().
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * ui_dkc is used by sd_send_scsi_SYNCHRONIZE_CACHE() to allow
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * for async completion notification.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following fields are to be used for FMA ereport generation.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_uscsi_info))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This structure is used to issue 'internal' command sequences from the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * driver's attach(9E)/open(9E)/etc entry points. It provides a common context
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * for issuing command sequences, with the ability to issue a command
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * and provide expected/unexpected assessment of results at any code
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * level within the sd_ssc_t scope and preserve the information needed
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * produce telemetry for the problem, when needed, from a single
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * outer-most-scope point.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The sd_ssc_t abstraction should result in well-structured code where
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the basic code structure is not jeprodized by future localized improvement.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Scope for a sequence of commands.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Within a scoped sequence of commands, provides a single top-level
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * location for initiating telementry generation from captured data.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Provide a common place to capture command execution data and driver
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * assessment information for delivery to telemetry generation point.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Mechanism to get device-as-detector (dad) and transport telemetry
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * information from interrupt context (sdintr) back to the internal
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * command 'driver-assessment' code.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Ability to record assessment, and return information back to
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * top-level telemetry generation code when an unexpected condition
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o For code paths were an command itself was successful but
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the data returned looks suspect, the ability to record
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 'unexpected data' conditions.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o Record assessment of issuing the command and interpreting
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the returned data for consumption by top-level ereport telemetry
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * generation code.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * o All data required to produce telemetry available off single data
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * structure.
3db86aab554edbb4244c8d1a1c90f152eee768afsteveltypedef struct {
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_ssc_t))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This struct switch different 'type-of-assessment'
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * as an input argument for sd_ssc_assessment
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * in sd_send_scsi_XXX or upper-level
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FMT_IGNORE
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * when send uscsi command failed, and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the following code check sense data properly.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * we use 'ignore' to let sd_ssc_assessment
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * trust current and do not do additional
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * checking for the uscsi command.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FMT_IGNORE_COMPROMISE
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * when send uscsi command failed, and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the code does not check sense data or we don't
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * think the checking is 100% coverage. We mark it
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * as 'compromise' to indicate that we need to
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * enhance current code in the future.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FMT_STATUS_CHECK
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * when send uscsi command failed and cause sd entries
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * failed finally, we need to send out real reason against
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * status of uscsi command no matter if there is sense back
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FMT_STANDARD
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * when send uscsi command succeeded, and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the code does not check sense data, we need to check
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * it to make sure there is no 'fault'.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following declaration are used as hints of severities when posting
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SCSI FMA ereport.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FM_DRV_FATAL
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When posting ereport with SD_FM_DRV_FATAL, the payload
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * "driver-assessment" will be "fail" or "fatal" depending on the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sense-key value. If driver-assessment is "fail", it will be
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * propagated to an upset, otherwise, a fault will be propagated.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FM_DRV_RETRY
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When posting ereport with SD_FM_DRV_RETRY, the payload
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * "driver-assessment" will be "retry", and it will be propagated to an
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FM_DRV_RECOVERY
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When posting ereport with SD_FM_DRV_RECOVERY, the payload
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * "driver-assessment" will be "recovered", and it will be propagated to
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * an upset.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * - SD_FM_DRV_NOTICE
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When posting ereport with SD_FM_DRV_NOTICE, the payload
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * "driver-assessment" will be "info", and it will be propagated to an
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following structure is used as a buffer when posting SCSI FMA
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * ereport for raw i/o. It will be allocated per sd_lun when entering
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_unit_attach and will be deallocated when entering sd_unit_detach.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bits in ssc_flags
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_ssc_init will mark ssc_flags = SSC_FLAGS_UNKNOWN
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_ssc_send will mark ssc_flags = SSC_FLAGS_CMD_ISSUED &
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SSC_FLAGS_NEED_ASSESSMENT
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd_ssc_assessment will clear SSC_FLAGS_CMD_ISSUED and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SSC_FLAGS_NEED_ASSESSMENT bits of ssc_flags.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SSC_FLAGS_CMD_ISSUED is to indicate whether the SCSI command has been
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sent out.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * SSC_FLAGS_NEED_ASSESSMENT is to guarantee we will not miss any
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * assessment point.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following bits in ssc_flags are for detecting unexpected data.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Macros and definitions for driver kstats and errstats
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Some third-party layered drivers (they know who they are) do not maintain
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * their open/close counts correctly which causes our kstat reporting to get
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * messed up & results in panics. These macros will update the driver kstats
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * only if the counts are valid.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_UPDATE_COMMON_KSTATS(kstat_function, kstatp) \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel "kstat rcnt == 0 when exiting runq, please check\n"); \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel "kstat wcnt == 0 when exiting waitq, please check\n"); \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel stp = (struct sd_errstats *)(un)->un_errstats->ks_data; \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel struct kstat *pksp = (un)->un_pstats[SDPART((bp)->b_edev)]; \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#endif /* defined(_KERNEL) || defined(_KMEMUSER) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 60 seconds is a *very* reasonable amount of time for most slow CD
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * operations.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 2 hours is an excessively reasonable amount of time for format operations.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 5 seconds is what we'll wait if we get a Busy Status back
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 100 msec. is what we'll wait if we get Unit Attention.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_UA_RETRY_DELAY (drv_usectohz((clock_t)100000))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 100 msec. is what we'll wait for restarted commands.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_RESTART_TIMEOUT (drv_usectohz((clock_t)100000))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 100 msec. is what we'll wait for certain retries for fibre channel
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * targets, 0 msec for parallel SCSI.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * 60 seconds is what we will wait for to reset the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * throttle back to it SD_MAX_THROTTLE.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Number of times we'll retry a normal operation.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * This includes retries due to transport failure
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (need to distinguish between Target and Transport failure)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Number of times we will retry for unit attention.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VICTIM_RETRY_COUNT(un) (un->un_victim_retry_count)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CD_NOT_READY_RETRY_COUNT(un) (un->un_retry_count * 2)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define DISK_NOT_READY_RETRY_COUNT(un) (un->un_retry_count / 2)
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * Maximum number of units we can support
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (controlled by room in minor device byte)
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * Note: this value is out of date.
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * 30 seconds is what we will wait for the IO to finish
11c2b4c0e543fe2e1e5910cde1f4422cc3218160rw * before we fail the DDI_SUSPEND
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Prevent/allow media removal flags
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Drive Types (and characteristics)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following #defines and type definitions for the property
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * processing component of the sd driver.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Miscellaneous Definitions */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Return values from "pm-capable" property
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Property data values used in static configuration table
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * These are all based on device characteristics.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * For fibre channel devices, the throttle value is usually
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * derived from the devices cmd Q depth divided by the number
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * of supported initiators.
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define MASERATI_DISKSORT_DISABLED_FLAG 1
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define MASERATI_LUN_RESET_ENABLED_FLAG 1
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define PIRUS_THROTTLE_VALUE 64
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define PIRUS_NRR_COUNT 60
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define PIRUS_BUSY_RETRIES 60
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define PIRUS_RESET_RETRY_COUNT 36
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define PIRUS_MIN_THROTTLE_VALUE 16
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Driver Property Bit Flag definitions
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Unfortunately, for historical reasons, the bit-flag definitions are
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * different on SPARC, INTEL, & FIBRE platforms.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver to set throttle from sd.conf sd-config-list
193974072f41a843678abf5f61979c748687e66bSherry Moore * and driver table.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The max throttle (q-depth) property implementation is for support of
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * fibre channel devices that can drop an i/o request when a queue fills
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * up. The number of commands sent to the disk from this driver is
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * regulated such that queue overflows are avoided.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_THROTTLE (1 << SD_CONF_SET_THROTTLE)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver to set the controller type from sd.conf
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd-config-list and driver table.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver to set the not ready retry count for a device from
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * sd.conf sd-config-list and driver table.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_NRR_COUNT (1 << SD_CONF_SET_NOTREADY_RETRIES)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit flag telling driver to set SCSI status BUSY Retries from sd.conf
193974072f41a843678abf5f61979c748687e66bSherry Moore * sd-config-list and driver table.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_BSY_RETRY_COUNT (1 << SD_CONF_SET_BUSY_RETRIES)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver that device does not have a valid/unique serial
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_CONF_BSET_FAB_DEVID (1 << SD_CONF_SET_FAB_DEVID)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver to disable all caching for disk device.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_NOCACHE (1 << SD_CONF_SET_NOCACHE)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit flag telling driver that the PLAY AUDIO command requires parms in BCD
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * format rather than binary.
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_CONF_BSET_PLAYMSF_BCD (1 << SD_CONF_SET_PLAYMSF_BCD)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling driver that the response from the READ SUBCHANNEL command
193974072f41a843678abf5f61979c748687e66bSherry Moore * has BCD fields rather than binary.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_READSUB_BCD (1 << SD_CONF_SET_READSUB_BCD)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit in flags telling driver that the track number fields in the READ TOC
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * request and respone are in BCD rather than binary.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_READ_TOC_TRK_BCD (1 << SD_CONF_SET_READ_TOC_TRK_BCD)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit flag telling driver that the address fields in the READ TOC request and
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * respone are in BCD rather than binary.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_READ_TOC_ADDR_BCD (1 << SD_CONF_SET_READ_TOC_ADDR_BCD)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling the driver that the device doesn't support the READ HEADER
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_NO_READ_HEADER (1 << SD_CONF_SET_NO_READ_HEADER)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling the driver that for the READ CD command the device uses
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * opcode 0xd4 rather than 0xbe.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_READ_CD_XD4 (1 << SD_CONF_SET_READ_CD_XD4)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling the driver to set SCSI status Reset Retries
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * (un_reset_retry_count) from sd.conf sd-config-list and driver table (4356701)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_RST_RETRIES (1 << SD_CONF_SET_RST_RETRIES)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling the driver to set the reservation release timeout value
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * from sd.conf sd-config-list and driver table. (4367306)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_RSV_REL_TIME (1 << SD_CONF_SET_RSV_REL_TIME)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit flag telling the driver to verify that no commands are pending for a
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * device before issuing a Test Unit Ready. This is a fw workaround for Seagate
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * eliteI drives. (4392016)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_CONF_BSET_TUR_CHECK (1 << SD_CONF_SET_TUR_CHECK)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit in flags telling driver to set min. throttle from ssd.conf
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * ssd-config-list and driver table.
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_CONF_BSET_MIN_THROTTLE (1 << SD_CONF_SET_MIN_THROTTLE)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit in flags telling driver to set disksort disable flag from ssd.conf
193974072f41a843678abf5f61979c748687e66bSherry Moore * ssd-config-list and driver table.
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_SET_DISKSORT_DISABLED 16
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_BSET_DISKSORT_DISABLED (1 << SD_CONF_SET_DISKSORT_DISABLED)
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * Bit in flags telling driver to set LUN Reset enable flag from [s]sd.conf
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * [s]sd-config-list and driver table.
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_BSET_LUN_RESET_ENABLED (1 << SD_CONF_SET_LUN_RESET_ENABLED)
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * Bit in flags telling driver that the write cache on the device is
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_SET_CACHE_IS_NV 18
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_BSET_CACHE_IS_NV (1 << SD_CONF_SET_CACHE_IS_NV)
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * This is the number of items currently settable in the sd.conf
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * sd-config-list. The mask value is defined for parameter checking. The
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * item count and mask should be updated when new properties are added.
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_MAX_ITEMS 19
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_CONF_BIT_MASK 0x0007FFFF
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_throttle;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_not_rdy_retries;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_busy_retries;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_reset_retries;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_lun_reset_enable;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China int sdt_suppress_cache_flush;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China/* Type definition for static configuration table entries */
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing Chinatypedef struct sd_disk_config {
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China char device_id[25];
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China sd_tunables *properties;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China} sd_disk_config_t;
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China * byte 4 options for 1bh command
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_TARGET_STOP 0x00
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_TARGET_START 0x01
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_TARGET_EJECT 0x02
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_TARGET_CLOSE 0x03
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SD_MODE_SENSE_PAGE3_CODE 0x03
193974072f41a843678abf5f61979c748687e66bSherry Moore (sizeof (struct mode_geometry) + MODE_PARAM_LENGTH)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * These command codes need to be moved to sys/scsi/generic/commands.h
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* Both versions of the Read CD command */
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China/* the official SCMD_READ_CD now comes from cdio.h */
e12b469ade633bb8f834d51aab6173e6f6f8c6d9rui wang - Sun Microsystems - Beijing China#define SCMD_READ_CDD4 0xd4 /* the one used by some first */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* generation ATAPI CD drives */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* expected sector type filter values for Play and Read CD CDBs */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_SECTOR_TYPE_CDDA (1<<2) /* IEC 908:1987 (CDDA) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_SECTOR_TYPE_MODE1 (2<<2) /* Yellow book 2048 bytes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_SECTOR_TYPE_MODE2 (3<<2) /* Yellow book 2335 bytes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_SECTOR_TYPE_MODE2_FORM1 (4<<2) /* 2048 bytes */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_SECTOR_TYPE_MODE2_FORM2 (5<<2) /* 2324 bytes */
193974072f41a843678abf5f61979c748687e66bSherry Moore/* READ CD filter bits (cdb[9]) */
193974072f41a843678abf5f61979c748687e66bSherry Moore#define CDROM_READ_CD_SYNC 0x80 /* read sync field */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_READ_CD_HDR 0x20 /* read four byte header */
193974072f41a843678abf5f61979c748687e66bSherry Moore#define CDROM_READ_CD_SUBHDR 0x40 /* read sub-header */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_READ_CD_ALLHDRS 0x60 /* read header and sub-header */
193974072f41a843678abf5f61979c748687e66bSherry Moore#define CDROM_READ_CD_USERDATA 0x10 /* read user data */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_READ_CD_EDC_ECC 0x08 /* read EDC and ECC field */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_READ_CD_C2 0x02 /* read C2 error data */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define CDROM_READ_CD_C2_BEB 0x04 /* read C2 and Block Error Bits */
193974072f41a843678abf5f61979c748687e66bSherry Moore * Mode Sense/Select Header response for Group 2 CDB.
193974072f41a843678abf5f61979c748687e66bSherry Moore uchar_t length_msb; /* MSB - number of bytes following */
193974072f41a843678abf5f61979c748687e66bSherry Moore uchar_t device_specific; /* device specfic parameters */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel uchar_t bdesc_length_hi; /* length of block descriptor(s) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel /* (if any) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel_NOTE(SCHEME_PROTECTS_DATA("Unshared data", mode_header_grp2))
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Length of the Mode Parameter Header for the Group 2 Mode Select command
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define MODE_HEADER_LENGTH_GRP2 (sizeof (struct mode_header_grp2))
193974072f41a843678abf5f61979c748687e66bSherry Moore#define MODE_PARAM_LENGTH_GRP2 (MODE_HEADER_LENGTH_GRP2 + MODE_BLK_DESC_LENGTH)
193974072f41a843678abf5f61979c748687e66bSherry Moore * Mode Page 1 - Error Recovery Page
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * The following buffer length define is 8 bytes for the Group 2 mode page
193974072f41a843678abf5f61979c748687e66bSherry Moore * header, 8 bytes for the block descriptor and 26 bytes for the cdrom
193974072f41a843678abf5f61979c748687e66bSherry Moore * capabilities page (per MMC-2)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define BUFLEN_MODE_CDROM_CAP (MODEPAGE_CDROM_CAP_LEN + \
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Power management defines
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * No Need to resume if already in PM_SUSPEND state because the thread
193974072f41a843678abf5f61979c748687e66bSherry Moore * was suspended in sdpower. It will be resumed when sdpower is invoked to make
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the device active.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When the thread is suspended, the watch thread is terminated and
193974072f41a843678abf5f61979c748687e66bSherry Moore * the token is NULLed so check for this condition.
193974072f41a843678abf5f61979c748687e66bSherry Moore * If there's a thread that can be resumed, ie. token is not NULL, then
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * it can be resumed.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_OK_TO_RESUME_SCSI_WATCHER(un) (un->un_swr_token != NULL)
193974072f41a843678abf5f61979c748687e66bSherry Moore * No Need to resume if already in PM_SUSPEND state because the thread
193974072f41a843678abf5f61979c748687e66bSherry Moore * was suspended in sdpower. It will be resumed when sdpower is invoked to make
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * the device active.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * When the thread is suspended, the watch thread is terminated and
193974072f41a843678abf5f61979c748687e66bSherry Moore * the token is NULLed so check for this condition.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_OK_TO_SUSPEND_SCSI_WATCHER(un) (un->un_swr_token != NULL)
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_DEVICE_IS_IN_LOW_POWER(un) ((un->un_f_pm_is_enabled) && \
193974072f41a843678abf5f61979c748687e66bSherry Moore * Could move this define to some thing like log sense.h in SCSA headers
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * But for now let it live here.
193974072f41a843678abf5f61979c748687e66bSherry Moore/* CD-ROM Error Recovery Parameters page (0x01) */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define BUFLEN_CHG_BLK_MODE MODE_HEADER_LENGTH + MODE_BLK_DESC_LENGTH
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Vendor Specific (Toshiba) CD-ROM Speed page (0x31)
bb3a048dd74d073e10c2a5d4aa060b4405ba7dfdrw * The following buffer length define is 4 bytes for the Group 0 mode page
bb3a048dd74d073e10c2a5d4aa060b4405ba7dfdrw * header, 8 bytes for the block descriptor and 4 bytes for the mode speed page.
bb3a048dd74d073e10c2a5d4aa060b4405ba7dfdrw#define BUFLEN_MODE_CDROM_SPEED MODEPAGE_CDROM_SPEED_LEN +\
bb3a048dd74d073e10c2a5d4aa060b4405ba7dfdrw/* CD-ROM Audio Control Parameters page (0x0E) */
bb3a048dd74d073e10c2a5d4aa060b4405ba7dfdrw/* CD-ROM Sony Read Offset Defines */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * CD-ROM Write Protect Defines
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit 7 of the device specific field of the mode page header is the write
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * protect bit.
193974072f41a843678abf5f61979c748687e66bSherry Moore * Define for the length of a profile header returned in response to the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * GET CONFIGURATION command
193974072f41a843678abf5f61979c748687e66bSherry Moore * Define the length of the data in response to the GET CONFIGURATION
193974072f41a843678abf5f61979c748687e66bSherry Moore * command. The 3rd byte of the feature descriptor contains the
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * current feature field that is of interest. This field begins
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * after the feature header which is 8 bytes. This variable length
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * was increased in size from 11 to 24 because some devices became
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * unresponsive with the smaller size.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Feature codes associated with GET CONFIGURATION command for supported
193974072f41a843678abf5f61979c748687e66bSherry Moore * Could move this define to some thing like log sense.h in SCSA headers
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * But for now let it live here.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* delay time used for sd_media_watch_cb delayed cv broadcast */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel/* SCSI power on or bus device reset additional sense code */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * These defines are for the Vital Product Data Pages in the inquiry command.
193974072f41a843678abf5f61979c748687e66bSherry Moore * They are the bits in the un_vpd_page mask, telling the supported pages.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VPD_SUPPORTED_PG 0x01 /* 0x00 - Supported VPD pages */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VPD_UNIT_SERIAL_PG 0x02 /* 0x80 - Unit Serial Number */
193974072f41a843678abf5f61979c748687e66bSherry Moore#define SD_VPD_OPERATING_PG 0x04 /* 0x81 - Implemented Op Defs */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VPD_ASCII_OP_PG 0x08 /* 0x82 - ASCII Op Defs */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VPD_DEVID_WWN_PG 0x10 /* 0x83 - Device Identification */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#define SD_VPD_EXTENDED_DATA_PG 0x80 /* 0x86 - Extended data about the lun */
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Non-volatile cache support
193974072f41a843678abf5f61979c748687e66bSherry Moore * Bit 1 of the byte 6 in the Extended INQUIRY data VPD page
193974072f41a843678abf5f61979c748687e66bSherry Moore * is NV_SUP bit: An NV_SUP bit set to one indicates that
193974072f41a843678abf5f61979c748687e66bSherry Moore * the device server supports a non-volatile cache. An
193974072f41a843678abf5f61979c748687e66bSherry Moore * NV_SUP bit set to zero indicates that the device
193974072f41a843678abf5f61979c748687e66bSherry Moore * server may or may not support a non-volatile cache.
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Bit 2 of the byte 1 in the SYNC CACHE command is SYNC_NV
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * bit: The SYNC_NV bit specifies whether the device server
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * is required to synchronize volatile and non-volatile
3db86aab554edbb4244c8d1a1c90f152eee768afstevel * Addition from sddef.intel.h
3db86aab554edbb4244c8d1a1c90f152eee768afstevel#endif /* __i386 || __amd64 */
193974072f41a843678abf5f61979c748687e66bSherry Moore#endif /* _SYS_SCSI_TARGETS_SDDEF_H */