xref: /titanic_51/usr/src/uts/common/sys/scsi/targets/sddef.h (revision aa1b14e7d68925d80eebf0ce8ed0b9cc55246546)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_SCSI_TARGETS_SDDEF_H
27 #define	_SYS_SCSI_TARGETS_SDDEF_H
28 
29 #include <sys/dktp/fdisk.h>
30 #include <sys/note.h>
31 #include <sys/mhd.h>
32 #include <sys/cmlb.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 
39 #if defined(_KERNEL) || defined(_KMEMUSER)
40 
41 
42 #define	SD_SUCCESS		0
43 #define	SD_FAILURE		(-1)
44 
45 #if defined(TRUE)
46 #undef TRUE
47 #endif
48 
49 #if defined(FALSE)
50 #undef FALSE
51 #endif
52 
53 #define	TRUE			1
54 #define	FALSE			0
55 
56 #if defined(VERBOSE)
57 #undef VERBOSE
58 #endif
59 
60 #if defined(SILENT)
61 #undef SILENT
62 #endif
63 
64 
65 /*
66  *  Fault Injection Flag for Inclusion of Code
67  *
68  *  This should only be defined when SDDEBUG is defined
69  * #if DEBUG || lint
70  * #define	SD_FAULT_INJECTION
71  * #endif
72  */
73 
74 #if DEBUG || lint
75 #define	SD_FAULT_INJECTION
76 #endif
77 #define	VERBOSE			1
78 #define	SILENT			0
79 
80 /*
81  * Structures for recording whether a device is fully open or closed.
82  * Assumptions:
83  *
84  *	+ There are only 8 (sparc) or 16 (x86) disk slices possible.
85  *	+ BLK, MNT, CHR, SWP don't change in some future release!
86  */
87 
88 #if defined(_SUNOS_VTOC_8)
89 
90 #define	SDUNIT_SHIFT	3
91 #define	SDPART_MASK	7
92 #define	NSDMAP		NDKMAP
93 
94 #elif defined(_SUNOS_VTOC_16)
95 
96 /*
97  * XXX - NSDMAP has multiple definitions, one more in cmlb_impl.h
98  * If they are coalesced into one, this definition will follow suit.
99  * FDISK partitions - 4 primary and MAX_EXT_PARTS number of Extended
100  * Partitions.
101  */
102 #define	FDISK_PARTS		(FD_NUMPART + MAX_EXT_PARTS)
103 
104 #define	SDUNIT_SHIFT	6
105 #define	SDPART_MASK	63
106 #define	NSDMAP		(NDKMAP + FDISK_PARTS + 1)
107 
108 #else
109 #error "No VTOC format defined."
110 #endif
111 
112 
113 #define	SDUNIT(dev)	(getminor((dev)) >> SDUNIT_SHIFT)
114 #define	SDPART(dev)	(getminor((dev)) &  SDPART_MASK)
115 
116 /*
117  * maximum number of partitions the driver keeps track of; with
118  * EFI this can be larger than the number of partitions accessible
119  * through the minor nodes.  It won't be used for keeping track
120  * of open counts, partition kstats, etc.
121  */
122 #define	MAXPART		(NSDMAP + 1)
123 
124 /*
125  * Macro to retrieve the DDI instance number from the given buf struct.
126  * The instance number is encoded in the minor device number.
127  */
128 #define	SD_GET_INSTANCE_FROM_BUF(bp)					\
129 	(getminor((bp)->b_edev) >> SDUNIT_SHIFT)
130 
131 
132 
133 struct ocinfo {
134 	/*
135 	 * Types BLK, MNT, CHR, SWP,
136 	 * assumed to be types 0-3.
137 	 */
138 	uint64_t  lyr_open[NSDMAP];
139 	uint64_t  reg_open[OTYPCNT - 1];
140 };
141 
142 #define	OCSIZE  sizeof (struct ocinfo)
143 
144 union ocmap {
145 	uchar_t chkd[OCSIZE];
146 	struct ocinfo rinfo;
147 };
148 
149 #define	lyropen rinfo.lyr_open
150 #define	regopen rinfo.reg_open
151 
152 
153 #define	SD_CDB_GROUP0		0
154 #define	SD_CDB_GROUP1		1
155 #define	SD_CDB_GROUP5		2
156 #define	SD_CDB_GROUP4		3
157 
158 struct sd_cdbinfo {
159 	uchar_t	 sc_grpcode;	/* CDB group code */
160 	uchar_t  sc_grpmask;	/* CDB group code mask (for cmd opcode) */
161 	uint64_t sc_maxlba;	/* Maximum logical block addr. supported */
162 	uint32_t sc_maxlen;	/* Maximum transfer length supported */
163 };
164 
165 
166 
167 /*
168  * The following declaration are for Non-512 byte block support for the
169  * removable devices. (ex - DVD RAM, MO).
170  * wm_state: This is an enumeration for the different states for
171  * manipalating write range list during the read-modify-write-operation.
172  */
173 typedef enum {
174 	SD_WM_CHK_LIST,		/* Check list for overlapping writes */
175 	SD_WM_WAIT_MAP,		/* Wait for an overlapping I/O to complete */
176 	SD_WM_LOCK_RANGE,	/* Lock the range of lba to be written */
177 	SD_WM_DONE		/* I/O complete */
178 } wm_state;
179 
180 /*
181  * sd_w_map: Every write I/O will get one w_map allocated for it which will tell
182  * the range on the media which is being written for that request.
183  */
184 struct sd_w_map {
185 	uint_t		wm_start;	/* Write start location */
186 	uint_t		wm_end;		/* Write end location */
187 	ushort_t	wm_flags;	/* State of the wmap */
188 	ushort_t	wm_wanted_count; /* # of threads waiting for region */
189 	void		*wm_private;	/* Used to store bp->b_private */
190 	struct buf	*wm_bufp;	/* to store buf pointer */
191 	struct sd_w_map	*wm_next;	/* Forward pointed to sd_w_map */
192 	struct sd_w_map	*wm_prev;	/* Back pointer to sd_w_map */
193 	kcondvar_t	wm_avail;	/* Sleep on this, while not available */
194 };
195 
196 _NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_w_map::wm_flags))
197 
198 
199 /*
200  * This is the struct for the layer-private data area for the
201  * mapblocksize layer.
202  */
203 
204 struct sd_mapblocksize_info {
205 	void		*mbs_oprivate;	/* saved value of xb_private */
206 	struct buf	*mbs_orig_bp;	/* ptr to original bp */
207 	struct sd_w_map	*mbs_wmp;	/* ptr to write-map struct for RMW */
208 	ssize_t		mbs_copy_offset;
209 	int		mbs_layer_index;	/* chain index for RMW */
210 };
211 
212 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_mapblocksize_info))
213 
214 
215 /*
216  * sd_lun: The main data structure for a scsi logical unit.
217  * Stored as the softstate structure for each device.
218  */
219 
220 struct sd_lun {
221 
222 	/* Back ptr to the SCSA scsi_device struct for this LUN */
223 	struct scsi_device	*un_sd;
224 
225 	/*
226 	 * Support for Auto-Request sense capability
227 	 */
228 	struct buf	*un_rqs_bp;	/* ptr to request sense bp */
229 	struct scsi_pkt	*un_rqs_pktp;	/* ptr to request sense scsi_pkt */
230 	int	un_sense_isbusy;	/* Busy flag for RQS buf */
231 
232 	/*
233 	 * These specify the layering chains to use with this instance. These
234 	 * are initialized according to the values in the sd_chain_index_map[]
235 	 * array. See the description of sd_chain_index_map[] for details.
236 	 */
237 	int un_buf_chain_type;
238 	int un_uscsi_chain_type;
239 	int un_direct_chain_type;
240 	int un_priority_chain_type;
241 
242 	/* Head & tail ptrs to the queue of bufs awaiting transport */
243 	struct buf	*un_waitq_headp;
244 	struct buf	*un_waitq_tailp;
245 
246 	/* Ptr to the buf currently being retried (NULL if none) */
247 	struct buf	*un_retry_bp;
248 
249 	/* This tracks the last kstat update for the un_retry_bp buf */
250 	void		(*un_retry_statp)(kstat_io_t *);
251 
252 	void		*un_xbuf_attr;	/* xbuf attribute struct */
253 
254 
255 	/* System logical block size, in bytes. (defaults to DEV_BSIZE.) */
256 	uint32_t	un_sys_blocksize;
257 
258 	/* The size of a logical block on the target, in bytes. */
259 	uint32_t	un_tgt_blocksize;
260 
261 	/*
262 	 * The number of logical blocks on the target. This is adjusted
263 	 * to be in terms of the block size specified by un_sys_blocksize
264 	 * (ie, the system block size).
265 	 */
266 	uint64_t	un_blockcount;
267 
268 	/*
269 	 * Various configuration data
270 	 */
271 	uchar_t	un_ctype;		/* Controller type */
272 	char 	*un_node_type;		/* minor node type */
273 	uchar_t	un_interconnect_type;	/* Interconnect for underlying HBA */
274 
275 	uint_t	un_notready_retry_count; /* Per disk notready retry count */
276 	uint_t	un_busy_retry_count;	/* Per disk BUSY retry count */
277 
278 	uint_t	un_retry_count;		/* Per disk retry count */
279 	uint_t	un_victim_retry_count;	/* Per disk victim retry count */
280 
281 	/* (4356701, 4367306) */
282 	uint_t	un_reset_retry_count; /* max io retries before issuing reset */
283 	ushort_t un_reserve_release_time; /* reservation release timeout */
284 
285 	uchar_t	un_reservation_type;	/* SCSI-3 or SCSI-2 */
286 	uint_t	un_max_xfer_size;	/* Maximum DMA transfer size */
287 	int	un_partial_dma_supported;
288 	int	un_buf_breakup_supported;
289 
290 	int	un_mincdb;		/* Smallest CDB to use */
291 	int	un_maxcdb;		/* Largest CDB to use */
292 	int	un_max_hba_cdb;		/* Largest CDB supported by HBA */
293 	int	un_status_len;
294 	int	un_pkt_flags;
295 
296 	/*
297 	 * Note: un_uscsi_timeout is a "mirror" of un_cmd_timeout, adjusted
298 	 * for ISCD().  Any updates to un_cmd_timeout MUST be reflected
299 	 * in un_uscsi_timeout as well!
300 	 */
301 	ushort_t un_cmd_timeout;	/* Timeout for completion */
302 	ushort_t un_uscsi_timeout;	/* Timeout for USCSI completion */
303 	ushort_t un_busy_timeout;	/* Timeout for busy retry */
304 
305 	/*
306 	 * Info on current states, statuses, etc. (Updated frequently)
307 	 */
308 	uchar_t	un_state;		/* current state */
309 	uchar_t	un_last_state;		/* last state */
310 	uchar_t	un_last_pkt_reason;	/* used to suppress multiple msgs */
311 	int	un_tagflags;		/* Pkt Flags for Tagged Queueing  */
312 	short	un_resvd_status;	/* Reservation Status */
313 	ulong_t	un_detach_count;	/* !0 if executing detach routine */
314 	ulong_t	un_layer_count;		/* Current total # of layered opens */
315 	ulong_t un_opens_in_progress;	/* Current # of threads in sdopen */
316 
317 	ksema_t	un_semoclose;		/* serialize opens/closes */
318 
319 	/*
320 	 * Control & status info for command throttling
321 	 */
322 	long	un_ncmds_in_driver;	/* number of cmds in driver */
323 	short	un_ncmds_in_transport;	/* number of cmds in transport */
324 	short	un_throttle;		/* max #cmds allowed in transport */
325 	short	un_saved_throttle;	/* saved value of un_throttle */
326 	short	un_busy_throttle;	/* saved un_throttle for BUSY */
327 	short	un_min_throttle;	/* min value of un_throttle */
328 	timeout_id_t	un_reset_throttle_timeid; /* timeout(9F) handle */
329 
330 	/*
331 	 * Multi-host (clustering) support
332 	 */
333 	opaque_t	un_mhd_token;		/* scsi watch request */
334 	timeout_id_t	un_resvd_timeid;	/* for resvd recover */
335 
336 	/* Event callback resources (photon) */
337 	ddi_eventcookie_t un_insert_event;	/* insert event */
338 	ddi_callback_id_t un_insert_cb_id;	/* insert callback */
339 	ddi_eventcookie_t un_remove_event;	/* remove event */
340 	ddi_callback_id_t un_remove_cb_id;	/* remove callback */
341 
342 	uint_t		un_start_stop_cycle_page;	/* Saves start/stop */
343 							/* cycle page */
344 	timeout_id_t	un_dcvb_timeid;		/* dlyd cv broadcast */
345 
346 	/*
347 	 * Data structures for open counts, partition info, VTOC,
348 	 * stats, and other such bookkeeping info.
349 	 */
350 	union	ocmap	un_ocmap;		/* open partition map */
351 	struct	kstat	*un_pstats[NSDMAP];	/* partition statistics */
352 	struct	kstat	*un_stats;		/* disk statistics */
353 	kstat_t		*un_errstats;		/* for error statistics */
354 	uint64_t	un_exclopen;		/* exclusive open bitmask */
355 	ddi_devid_t	un_devid;		/* device id */
356 	uint_t		un_vpd_page_mask;	/* Supported VPD pages */
357 
358 	/*
359 	 * Bit fields for various configuration/state/status info.
360 	 * Comments indicate the condition if the value of the
361 	 * variable is TRUE (nonzero).
362 	 */
363 	uint32_t
364 	    un_f_arq_enabled		:1,	/* Auto request sense is */
365 						/* currently enabled */
366 	    un_f_blockcount_is_valid	:1,	/* The un_blockcount */
367 						/* value is currently valid */
368 	    un_f_tgt_blocksize_is_valid	:1,	/* The un_tgt_blocksize */
369 						/* value is currently valid */
370 	    un_f_allow_bus_device_reset	:1,	/* Driver may issue a BDR as */
371 						/* a part of error recovery. */
372 	    un_f_is_fibre		:1,	/* The device supports fibre */
373 						/* channel */
374 	    un_f_sync_cache_supported	:1,	/* sync cache cmd supported */
375 						/* supported */
376 	    un_f_format_in_progress	:1,	/* The device is currently */
377 						/* executing a FORMAT cmd. */
378 	    un_f_opt_queueing		:1,	/* Enable Command Queuing to */
379 						/* Host Adapter */
380 	    un_f_opt_fab_devid		:1,	/* Disk has no valid/unique */
381 						/* serial number.  */
382 	    un_f_opt_disable_cache	:1,	/* Read/Write disk cache is */
383 						/* disabled.  */
384 	    un_f_cfg_is_atapi		:1,	/* This is an ATAPI device.  */
385 	    un_f_write_cache_enabled	:1,	/* device return success on */
386 						/* writes before transfer to */
387 						/* physical media complete */
388 	    un_f_cfg_playmsf_bcd	:1,	/* Play Audio, BCD params. */
389 	    un_f_cfg_readsub_bcd	:1,	/* READ SUBCHANNEL BCD resp. */
390 	    un_f_cfg_read_toc_trk_bcd	:1,	/* track # is BCD */
391 	    un_f_cfg_read_toc_addr_bcd	:1,	/* address is BCD */
392 	    un_f_cfg_no_read_header	:1,	/* READ HEADER not supported */
393 	    un_f_cfg_read_cd_xd4	:1,	/* READ CD opcode is 0xd4 */
394 	    un_f_mmc_cap		:1,	/* Device is MMC compliant */
395 	    un_f_mmc_writable_media	:1,	/* writable media in device */
396 	    un_f_dvdram_writable_device	:1,	/* DVDRAM device is writable */
397 	    un_f_cfg_cdda		:1,	/* READ CDDA supported */
398 	    un_f_cfg_tur_check		:1,	/* verify un_ncmds before tur */
399 
400 	    un_f_use_adaptive_throttle	:1,	/* enable/disable adaptive */
401 						/* throttling */
402 	    un_f_pm_is_enabled		:1,	/* PM is enabled on this */
403 						/* instance */
404 	    un_f_watcht_stopped		:1,	/* media watch thread flag */
405 	    un_f_pkstats_enabled	:1,	/* Flag to determine if */
406 						/* partition kstats are */
407 						/* enabled. */
408 	    un_f_disksort_disabled	:1,	/* Flag to disable disksort */
409 	    un_f_lun_reset_enabled	:1,	/* Set if target supports */
410 						/* SCSI Logical Unit Reset */
411 	    un_f_doorlock_supported	:1,	/* Device supports Doorlock */
412 	    un_f_start_stop_supported	:1,	/* device has motor */
413 	    un_f_reserved1		:1;
414 
415 	uint32_t
416 	    un_f_mboot_supported	:1,	/* mboot supported */
417 	    un_f_is_hotpluggable	:1,	/* hotpluggable */
418 	    un_f_has_removable_media	:1,	/* has removable media */
419 	    un_f_non_devbsize_supported	:1,	/* non-512 blocksize */
420 	    un_f_devid_supported	:1,	/* device ID supported */
421 	    un_f_eject_media_supported	:1,	/* media can be ejected */
422 	    un_f_chk_wp_open		:1,	/* check if write-protected */
423 						/* when being opened */
424 	    un_f_descr_format_supported	:1,	/* support descriptor format */
425 						/* for sense data */
426 	    un_f_check_start_stop	:1,	/* needs to check if */
427 						/* START-STOP command is */
428 						/* supported by hardware */
429 						/* before issuing it */
430 	    un_f_monitor_media_state	:1,	/* need a watch thread to */
431 						/* monitor device state */
432 	    un_f_attach_spinup		:1,	/* spin up once the */
433 						/* device is attached */
434 	    un_f_log_sense_supported	:1,	/* support log sense */
435 	    un_f_pm_supported		:1, 	/* support power-management */
436 	    un_f_cfg_is_lsi		:1,	/* Is LSI device, */
437 						/* default to NO */
438 	    un_f_wcc_inprog		:1,	/* write cache change in */
439 						/* progress */
440 	    un_f_ejecting		:1,	/* media is ejecting */
441 	    un_f_suppress_cache_flush	:1,	/* supress flush on */
442 						/* write cache */
443 	    un_f_sync_nv_supported	:1,	/* SYNC_NV */
444 						/* bit is supported */
445 	    un_f_sync_cache_required	:1,	/* flag to check if */
446 						/* SYNC CACHE needs to be */
447 						/* sent in sdclose */
448 	    un_f_devid_transport_defined :1,	/* devid defined by transport */
449 	    un_f_rmw_type		 :2,	/* RMW type */
450 	    un_f_reserved		:10;
451 
452 	/* Ptr to table of strings for ASC/ASCQ error message printing */
453 	struct scsi_asq_key_strings	*un_additional_codes;
454 
455 	/*
456 	 * Power Management support.
457 	 *
458 	 * un_pm_mutex protects, un_pm_count, un_pm_timeid, un_pm_busy,
459 	 * un_pm_busy_cv, and un_pm_idle_timeid.
460 	 * It's not required that SD_MUTEX be acquired before acquiring
461 	 * un_pm_mutex, however if they must both be held
462 	 * then acquire SD_MUTEX first.
463 	 *
464 	 * un_pm_count is used to indicate PM state as follows:
465 	 *	less than 0 the device is powered down,
466 	 *	transition from 0 ==> 1, mark the device as busy via DDI
467 	 *	transition from 1 ==> 0, mark the device as idle via DDI
468 	 */
469 	kmutex_t	un_pm_mutex;
470 	int		un_pm_count;		/* indicates pm state */
471 	timeout_id_t	un_pm_timeid;		/* timeout id for pm */
472 	uint_t		un_pm_busy;
473 	kcondvar_t	un_pm_busy_cv;
474 	short		un_power_level;		/* Power Level */
475 	uchar_t		un_save_state;
476 	kcondvar_t	un_suspend_cv;		/* power management */
477 	kcondvar_t	un_disk_busy_cv;	/* wait for IO completion */
478 
479 	/* Resources used for media change callback support */
480 	kcondvar_t	un_state_cv;		/* Cond Var on mediastate */
481 	enum dkio_state un_mediastate;		/* current media state */
482 	enum dkio_state un_specified_mediastate; /* expected state */
483 	opaque_t	un_swr_token;		/* scsi_watch request token */
484 
485 	/* Non-512 byte block support */
486 	struct kmem_cache *un_wm_cache;	/* fast alloc in non-512 write case */
487 	uint_t		un_rmw_count;	/* count of read-modify-writes */
488 	struct sd_w_map	*un_wm;		/* head of sd_w_map chain */
489 	uint64_t	un_rmw_incre_count;	/* count I/O */
490 	timeout_id_t	un_rmw_msg_timeid;	/* for RMW message control */
491 
492 	/* For timeout callback to issue a START STOP UNIT command */
493 	timeout_id_t	un_startstop_timeid;
494 
495 	/* Timeout callback handle for SD_PATH_DIRECT_PRIORITY cmd restarts */
496 	timeout_id_t	un_direct_priority_timeid;
497 
498 	/* TRAN_FATAL_ERROR count. Cleared by TRAN_ACCEPT from scsi_transport */
499 	ulong_t		un_tran_fatal_count;
500 
501 	timeout_id_t	un_retry_timeid;
502 
503 	time_t		un_pm_idle_time;
504 	timeout_id_t	un_pm_idle_timeid;
505 
506 	/*
507 	 * Count to determine if a Sonoma controller is in the process of
508 	 * failing over, and how many I/O's are failed with the 05/94/01
509 	 * sense code.
510 	 */
511 	uint_t		un_sonoma_failure_count;
512 
513 	/*
514 	 * Support for failfast operation.
515 	 */
516 	struct buf	*un_failfast_bp;
517 	struct buf	*un_failfast_headp;
518 	struct buf	*un_failfast_tailp;
519 	uint32_t	un_failfast_state;
520 	/* Callback routine active counter */
521 	short		un_in_callback;
522 
523 	kcondvar_t	un_wcc_cv;	/* synchronize changes to */
524 					/* un_f_write_cache_enabled */
525 
526 #ifdef SD_FAULT_INJECTION
527 	/* SD Fault Injection */
528 #define	SD_FI_MAX_BUF 65536
529 #define	SD_FI_MAX_ERROR 1024
530 	kmutex_t			un_fi_mutex;
531 	uint_t				sd_fi_buf_len;
532 	char				sd_fi_log[SD_FI_MAX_BUF];
533 	struct sd_fi_pkt	*sd_fi_fifo_pkt[SD_FI_MAX_ERROR];
534 	struct sd_fi_xb		*sd_fi_fifo_xb[SD_FI_MAX_ERROR];
535 	struct sd_fi_un		*sd_fi_fifo_un[SD_FI_MAX_ERROR];
536 	struct sd_fi_arq	*sd_fi_fifo_arq[SD_FI_MAX_ERROR];
537 	uint_t				sd_fi_fifo_start;
538 	uint_t				sd_fi_fifo_end;
539 	uint_t				sd_injection_mask;
540 
541 #endif
542 
543 	cmlb_handle_t	un_cmlbhandle;
544 
545 	/*
546 	 * Pointer to internal struct sd_fm_internal in which
547 	 * will pass necessary information for FMA ereport posting.
548 	 */
549 	void		*un_fm_private;
550 };
551 
552 #define	SD_IS_VALID_LABEL(un)  (cmlb_is_valid(un->un_cmlbhandle))
553 
554 /*
555  * Macros for conversions between "target" and "system" block sizes, and
556  * for conversion between block counts and byte counts.  As used here,
557  * "system" block size refers to the block size used by the kernel/
558  * filesystem (this includes the disk label). The "target" block size
559  * is the block size returned by the SCSI READ CAPACITY command.
560  *
561  * Note: These macros will round up to the next largest blocksize to accomodate
562  * the number of blocks specified.
563  */
564 
565 /* Convert a byte count to a number of target blocks */
566 #define	SD_BYTES2TGTBLOCKS(un, bytecount)				\
567 	((bytecount + (un->un_tgt_blocksize - 1))/un->un_tgt_blocksize)
568 
569 /* Convert a target block count to a number of bytes */
570 #define	SD_TGTBLOCKS2BYTES(un, blockcount)				\
571 	(blockcount * (un)->un_tgt_blocksize)
572 
573 /* Convert a byte count to a number of system blocks */
574 #define	SD_BYTES2SYSBLOCKS(bytecount)				\
575 	((bytecount + (DEV_BSIZE - 1))/DEV_BSIZE)
576 
577 /* Convert a system block count to a number of bytes */
578 #define	SD_SYSBLOCKS2BYTES(blockcount)				\
579 	(blockcount * DEV_BSIZE)
580 
581 /*
582  * Calculate the number of bytes needed to hold the requested number of bytes
583  * based upon the native target sector/block size
584  */
585 #define	SD_REQBYTES2TGTBYTES(un, bytecount)				\
586 	(SD_BYTES2TGTBLOCKS(un, bytecount) * (un)->un_tgt_blocksize)
587 
588 /*
589  * Calculate the byte offset from the beginning of the target block
590  * to the system block location.
591  */
592 #define	SD_TGTBYTEOFFSET(un, sysblk, tgtblk)				\
593 	(SD_SYSBLOCKS2BYTES(sysblk) - SD_TGTBLOCKS2BYTES(un, tgtblk))
594 
595 /*
596  * Calculate the target block location from the system block location
597  */
598 #define	SD_SYS2TGTBLOCK(un, blockcnt)					\
599 	(blockcnt / ((un)->un_tgt_blocksize / DEV_BSIZE))
600 
601 /*
602  * Calculate the target block location from the system block location
603  */
604 #define	SD_TGT2SYSBLOCK(un, blockcnt)					\
605 	(blockcnt * ((un)->un_tgt_blocksize / DEV_BSIZE))
606 
607 /*
608  * SD_DEFAULT_MAX_XFER_SIZE is the default value to bound the max xfer
609  * for physio, for devices without tagged queuing enabled.
610  * The default for devices with tagged queuing enabled is SD_MAX_XFER_SIZE
611  */
612 #if defined(__i386) || defined(__amd64)
613 #define	SD_DEFAULT_MAX_XFER_SIZE	(256 * 1024)
614 #endif
615 #define	SD_MAX_XFER_SIZE		(1024 * 1024)
616 
617 /*
618  * Warlock annotations
619  */
620 _NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_lun))
621 _NOTE(READ_ONLY_DATA(sd_lun::un_sd))
622 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_reservation_type))
623 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_mincdb))
624 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_maxcdb))
625 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_max_hba_cdb))
626 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_status_len))
627 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_f_arq_enabled))
628 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_ctype))
629 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_cmlbhandle))
630 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_fm_private))
631 
632 
633 _NOTE(SCHEME_PROTECTS_DATA("safe sharing",
634 	sd_lun::un_mhd_token
635 	sd_lun::un_state
636 	sd_lun::un_tagflags
637 	sd_lun::un_f_format_in_progress
638 	sd_lun::un_resvd_timeid
639 	sd_lun::un_reset_throttle_timeid
640 	sd_lun::un_startstop_timeid
641 	sd_lun::un_dcvb_timeid
642 	sd_lun::un_f_allow_bus_device_reset
643 	sd_lun::un_sys_blocksize
644 	sd_lun::un_tgt_blocksize
645 	sd_lun::un_additional_codes))
646 
647 _NOTE(SCHEME_PROTECTS_DATA("stable data",
648 	sd_lun::un_reserve_release_time
649 	sd_lun::un_max_xfer_size
650 	sd_lun::un_partial_dma_supported
651 	sd_lun::un_buf_breakup_supported
652 	sd_lun::un_f_is_fibre
653 	sd_lun::un_node_type
654 	sd_lun::un_buf_chain_type
655 	sd_lun::un_uscsi_chain_type
656 	sd_lun::un_direct_chain_type
657 	sd_lun::un_priority_chain_type
658 	sd_lun::un_xbuf_attr
659 	sd_lun::un_cmd_timeout
660 	sd_lun::un_pkt_flags))
661 
662 _NOTE(SCHEME_PROTECTS_DATA("Unshared data",
663 	block_descriptor
664 	buf
665 	cdrom_subchnl
666 	cdrom_tocentry
667 	cdrom_tochdr
668 	cdrom_read
669 	dk_cinfo
670 	dk_devid
671 	dk_label
672 	dk_map
673 	dk_temperature
674 	mhioc_inkeys
675 	mhioc_inresvs
676 	mode_caching
677 	mode_header
678 	mode_speed
679 	scsi_cdb
680 	scsi_arq_status
681 	scsi_extended_sense
682 	scsi_inquiry
683 	scsi_pkt
684 	uio
685 	uscsi_cmd))
686 
687 
688 _NOTE(SCHEME_PROTECTS_DATA("stable data", scsi_device dk_cinfo))
689 _NOTE(SCHEME_PROTECTS_DATA("unique per pkt", scsi_status scsi_cdb))
690 
691 _NOTE(MUTEX_PROTECTS_DATA(sd_lun::un_pm_mutex, sd_lun::un_pm_count
692 	sd_lun::un_pm_timeid sd_lun::un_pm_busy sd_lun::un_pm_busy_cv
693 	sd_lun::un_pm_idle_timeid))
694 
695 #ifdef SD_FAULT_INJECTION
696 _NOTE(MUTEX_PROTECTS_DATA(sd_lun::un_fi_mutex,
697 	sd_lun::sd_fi_buf_len sd_lun::sd_fi_log))
698 #endif
699 
700 /* _NOTE(LOCK_ORDER(sd_lun::un_sd.sd_mutex sd_lun::un_pm_mutex)) */
701 
702 
703 
704 /*
705  * Referenced for frequently-accessed members of the unit structure
706  */
707 #define	SD_SCSI_DEVP(un)	((un)->un_sd)
708 #define	SD_DEVINFO(un)		((un)->un_sd->sd_dev)
709 #define	SD_INQUIRY(un)		((un)->un_sd->sd_inq)
710 #define	SD_MUTEX(un)		(&((un)->un_sd->sd_mutex))
711 #define	SD_ADDRESS(un)		(&((un)->un_sd->sd_address))
712 #define	SD_GET_DEV(un)		(sd_make_device(SD_DEVINFO(un)))
713 #define	SD_FM_LOG(un)		(((struct sd_fm_internal *)\
714 				((un)->un_fm_private))->fm_log_level)
715 
716 
717 /*
718  * Values for un_ctype
719  */
720 #define	CTYPE_CDROM		0
721 #define	CTYPE_MD21		1	/* Obsolete! */
722 #define	CTYPE_CCS		2
723 #define	CTYPE_ROD		3
724 #define	CTYPE_PXRE		4	/* Obsolete! */
725 
726 #define	ISCD(un)		((un)->un_ctype == CTYPE_CDROM)
727 #define	ISROD(un)		((un)->un_ctype == CTYPE_ROD)
728 #define	ISPXRE(un)		((un)->un_ctype == CTYPE_PXRE)
729 
730 /*
731  * This macro checks the vendor of the device to see if it is LSI. Because
732  * LSI has some devices out there that return 'Symbios' or 'SYMBIOS', we
733  * need to check for those also.
734  *
735  * This is used in some vendor specific checks.
736  */
737 #define	SD_IS_LSI(un)	((un)->un_f_cfg_is_lsi == TRUE)
738 
739 /*
740  * Macros to check if the lun is a Sun T3 or a T4
741  */
742 #define	SD_IS_T3(un) \
743 	((bcmp(SD_INQUIRY(un)->inq_vid, "SUN", 3) == 0) && \
744 	(bcmp(SD_INQUIRY(un)->inq_pid, "T3", 2) == 0))
745 
746 #define	SD_IS_T4(un) \
747 	((bcmp(SD_INQUIRY(un)->inq_vid, "SUN", 3) == 0) && \
748 	(bcmp(SD_INQUIRY(un)->inq_pid, "T4", 2) == 0))
749 
750 /*
751  * Macros for non-512 byte writes to removable devices.
752  */
753 #define	NOT_DEVBSIZE(un)	\
754 	((un)->un_tgt_blocksize != (un)->un_sys_blocksize)
755 
756 /*
757  * Check that a write map, used for locking lba ranges for writes, is in
758  * the linked list.
759  */
760 #define	ONLIST(un, wmp)		\
761 	(((un)->un_wm == (wmp)) || ((wmp)->wm_prev != NULL))
762 
763 /*
764  * Free a write map which is on list. Basically make sure that nobody is
765  * sleeping on it before freeing it.
766  */
767 #define	FREE_ONLIST_WMAP(un, wmp)				\
768 	if (!(wmp)->wm_wanted_count) {				\
769 		sd_free_inlist_wmap((un), (wmp));		\
770 		(wmp) = NULL;					\
771 	}
772 
773 #define	CHK_N_FREEWMP(un, wmp)					\
774 	if (!ONLIST((un), (wmp))) {				\
775 		kmem_cache_free((un)->un_wm_cache, (wmp));	\
776 		(wmp) = NULL;					\
777 	} else {						\
778 		FREE_ONLIST_WMAP((un), (wmp));			\
779 	}
780 
781 /*
782  * Values used to in wm_flags field of sd_w_map.
783  */
784 #define	SD_WTYPE_SIMPLE	0x001	/* Write aligned at blksize boundary */
785 #define	SD_WTYPE_RMW	0x002	/* Write requires read-modify-write */
786 #define	SD_WM_BUSY		0x100	/* write-map is busy */
787 
788 /*
789  * RMW type
790  */
791 #define	SD_RMW_TYPE_DEFAULT	0	/* do rmw with warning message */
792 #define	SD_RMW_TYPE_NO_WARNING	1	/* do rmw without warning message */
793 #define	SD_RMW_TYPE_RETURN_ERROR	2	/* rmw disabled */
794 
795 /* Device error kstats */
796 struct sd_errstats {
797 	struct kstat_named	sd_softerrs;
798 	struct kstat_named	sd_harderrs;
799 	struct kstat_named	sd_transerrs;
800 	struct kstat_named	sd_vid;
801 	struct kstat_named	sd_pid;
802 	struct kstat_named	sd_revision;
803 	struct kstat_named	sd_serial;
804 	struct kstat_named	sd_capacity;
805 	struct kstat_named	sd_rq_media_err;
806 	struct kstat_named	sd_rq_ntrdy_err;
807 	struct kstat_named	sd_rq_nodev_err;
808 	struct kstat_named	sd_rq_recov_err;
809 	struct kstat_named	sd_rq_illrq_err;
810 	struct kstat_named	sd_rq_pfa_err;
811 };
812 
813 
814 /*
815  * Structs and definitions for SCSI-3 Persistent Reservation
816  */
817 typedef struct sd_prin_readkeys {
818 	uint32_t	generation;
819 	uint32_t	len;
820 	mhioc_resv_key_t *keylist;
821 } sd_prin_readkeys_t;
822 
823 typedef struct sd_readresv_desc {
824 	mhioc_resv_key_t	resvkey;
825 	uint32_t		scope_specific_addr;
826 	uint8_t			reserved_1;
827 #if defined(_BIT_FIELDS_LTOH)
828 	uint8_t			type:4,
829 				scope:4;
830 #elif defined(_BIT_FIELDS_HTOL)
831 	uint8_t			scope:4,
832 				type:4;
833 #else
834 #error	One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
835 #endif	/* _BIT_FIELDS_LTOH */
836 	uint8_t			reserved_2;
837 	uint8_t			reserved_3;
838 } sd_readresv_desc_t;
839 
840 typedef struct sd_prin_readresv {
841 	uint32_t		generation;
842 	uint32_t		len;
843 	sd_readresv_desc_t	*readresv_desc;
844 } sd_prin_readresv_t;
845 
846 typedef struct sd_prout {
847 	uchar_t		res_key[MHIOC_RESV_KEY_SIZE];
848 	uchar_t		service_key[MHIOC_RESV_KEY_SIZE];
849 	uint32_t	scope_address;
850 #if defined(_BIT_FIELDS_LTOH)
851 	uchar_t		aptpl:1,
852 			reserved:7;
853 #elif defined(_BIT_FIELDS_HTOL)
854 	uchar_t		reserved:7,
855 			aptpl:1;
856 #else
857 #error	One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined
858 #endif	/* _BIT_FIELDS_LTOH */
859 	uchar_t		reserved_1;
860 	uint16_t	ext_len;
861 } sd_prout_t;
862 
863 #define	SD_READ_KEYS			0x00
864 #define	SD_READ_RESV			0x01
865 
866 #define	SD_SCSI3_REGISTER		0x00
867 #define	SD_SCSI3_RESERVE		0x01
868 #define	SD_SCSI3_RELEASE		0x02
869 #define	SD_SCSI3_PREEMPTANDABORT	0x05
870 #define	SD_SCSI3_REGISTERANDIGNOREKEY	0x06
871 
872 /*
873  * Note: The default init of un_reservation_type is to the value of '0'
874  * (from the ddi_softs_state_zalloc) which means it is defaulting to SCSI-3
875  * reservation type. This is ok because during attach we use a SCSI-3
876  * PRIORITY RESERVE IN command to determine the reservation type, and set
877  * un_reservation_type for all cases.
878  */
879 #define	SD_SCSI3_RESERVATION		0x0
880 #define	SD_SCSI2_RESERVATION		0x1
881 #define	SCSI3_RESV_DESC_LEN		16
882 
883 /*
884  * Reservation Status's
885  */
886 #define	SD_RELEASE			0x0000
887 #define	SD_RESERVE			0x0001
888 #define	SD_TKOWN			0x0002
889 #define	SD_LOST_RESERVE			0x0004
890 #define	SD_FAILFAST			0x0080
891 #define	SD_WANT_RESERVE			0x0100
892 #define	SD_RESERVATION_CONFLICT		0x0200
893 #define	SD_PRIORITY_RESERVE		0x0400
894 
895 #define	SD_TARGET_IS_UNRESERVED		0
896 #define	SD_TARGET_IS_RESERVED		1
897 
898 /*
899  * Save page in mode_select
900  */
901 #define	SD_DONTSAVE_PAGE		0
902 #define	SD_SAVE_PAGE			1
903 
904 /*
905  * Delay before reclaiming reservation is 6 seconds, in units of micro seconds
906  */
907 #define	SD_REINSTATE_RESV_DELAY		6000000
908 
909 #define	SD_MODE2_BLKSIZE		2336	/* bytes */
910 
911 /*
912  * Resource type definitions for multi host control operations. Specifically,
913  * queue and request definitions for reservation request handling between the
914  * scsi facility callback function (sd_mhd_watch_cb) and the reservation
915  * reclaim thread (sd_resv_reclaim_thread)
916  */
917 struct sd_thr_request {
918 	dev_t	dev;
919 	struct	sd_thr_request	*sd_thr_req_next;
920 };
921 
922 struct sd_resv_reclaim_request {
923 	kthread_t		*srq_resv_reclaim_thread;
924 	struct	sd_thr_request	*srq_thr_req_head;
925 	struct	sd_thr_request	*srq_thr_cur_req;
926 	kcondvar_t		srq_inprocess_cv;
927 	kmutex_t		srq_resv_reclaim_mutex;
928 	kcondvar_t		srq_resv_reclaim_cv;
929 };
930 
931 _NOTE(MUTEX_PROTECTS_DATA(sd_resv_reclaim_request::srq_resv_reclaim_mutex,
932     sd_resv_reclaim_request))
933 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_thr_request))
934 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_prout))
935 
936 
937 
938 /*
939  * Driver Logging Components
940  *
941  * These components cover the functional entry points and areas of the
942  * driver.  A component value is used for the entry point and utility
943  * functions used by the entry point. The common component value is used
944  * in those routines that are called from many areas of the driver.
945  *
946  * This can be done by adding the following two lines to /etc/system:
947  * set sd:sd_component_mask=0x00080000
948  * set sd:sd_level_mask=0x00000008
949  */
950 #define	SD_LOG_PROBE			0x00000001
951 #define	SD_LOG_ATTACH_DETACH		0x00000002
952 #define	SD_LOG_OPEN_CLOSE		0x00000004
953 #define	SD_LOG_READ_WRITE		0x00000008
954 #define	SD_LOG_POWER			0x00000010
955 #define	SD_LOG_IOCTL			0x00000020
956 #define	SD_LOG_IOCTL_MHD		0x00000040
957 #define	SD_LOG_IOCTL_RMMEDIA		0x00000080
958 #define	SD_LOG_IOCTL_DKIO		0x00000100
959 #define	SD_LOG_IO			0x00000200
960 #define	SD_LOG_IO_CORE			0x00000400
961 #define	SD_LOG_IO_DISKSORT		0x00000800
962 #define	SD_LOG_IO_PARTITION		0x00001000
963 #define	SD_LOG_IO_RMMEDIA		0x00002000
964 #define	SD_LOG_IO_CHKSUM		0x00004000
965 #define	SD_LOG_IO_SDIOCTL		0x00008000
966 #define	SD_LOG_IO_PM			0x00010000
967 #define	SD_LOG_ERROR			0x00020000
968 #define	SD_LOG_DUMP			0x00040000
969 #define	SD_LOG_COMMON			0x00080000
970 #define	SD_LOG_SDTEST			0x00100000
971 #define	SD_LOG_IOERR			0x00200000
972 #define	SD_LOG_IO_FAILFAST		0x00400000
973 
974 /* Driver Logging Levels */
975 #define	SD_LOGMASK_ERROR		0x00000001
976 #define	SD_LOGMASK_DUMP_MEM		0x00000002
977 #define	SD_LOGMASK_INFO			0x00000004
978 #define	SD_LOGMASK_TRACE		0x00000008
979 #define	SD_LOGMASK_DIAG			0x00000010
980 
981 /* Driver Logging Formats */
982 #define	SD_LOG_HEX			0x00000001
983 #define	SD_LOG_CHAR			0x00000002
984 
985 /*
986  * The following macros should be used to log driver debug information
987  * only. The output is filtered according to the component and level mask
988  * values. Non-debug information, such as driver warnings intended for
989  * the user should be logged via the scsi_log facility to ensure that
990  * they are not filtered.
991  */
992 #if DEBUG || lint
993 #define	SDDEBUG
994 
995 /* SD_ERROR is called to log driver error conditions */
996 #define	SD_ERROR	sd_log_err
997 
998 /* SD_TRACE is called to log driver trace conditions (function entry/exit) */
999 #define	SD_TRACE	sd_log_trace
1000 
1001 /* SD_INFO is called to log general purpose driver info */
1002 #define	SD_INFO		sd_log_info
1003 
1004 /* SD_DUMP_MEMORY is called to dump a data buffer to the log */
1005 #define	SD_DUMP_MEMORY	sd_dump_memory
1006 
1007 /* RESET/ABORTS testing ioctls */
1008 #define	DKIOCRESET	(DKIOC|14)
1009 #define	DKIOCABORT	(DKIOC|15)
1010 
1011 #ifdef SD_FAULT_INJECTION
1012 /*
1013  * sd_fi_pkt replicates the variables that are exposed through pkt
1014  *
1015  * sd_fi_xb replicates the variables that are exposed through xb
1016  *
1017  * sd_fi_un replicates the variables that are exposed through un
1018  *
1019  * sd_fi_arq replicates the variables that are
1020  *           exposed for Auto-Reqeust-Sense
1021  *
1022  */
1023 struct sd_fi_pkt {
1024 	uint_t  pkt_flags;			/* flags */
1025 	uchar_t pkt_scbp;			/* pointer to status block */
1026 	uchar_t pkt_cdbp;			/* pointer to command block */
1027 	uint_t  pkt_state;			/* state of command */
1028 	uint_t  pkt_statistics;		/* statistics */
1029 	uchar_t pkt_reason;			/* reason completion called */
1030 };
1031 
1032 struct sd_fi_xb {
1033 	daddr_t xb_blkno;
1034 	ssize_t xb_dma_resid;
1035 	short	xb_retry_count;
1036 	short	xb_victim_retry_count;
1037 	uchar_t xb_sense_status;
1038 	uint_t  xb_sense_state;
1039 	ssize_t xb_sense_resid;
1040 	uchar_t xb_sense_data[SENSE_LENGTH];
1041 	uchar_t es_code;
1042 	uchar_t es_key;
1043 	uchar_t es_add_code;
1044 	uchar_t es_qual_code;
1045 };
1046 
1047 struct sd_fi_un {
1048 	uchar_t inq_rmb;
1049 	uchar_t un_ctype;
1050 	uint_t  un_notready_retry_count;
1051 	uint_t  un_reset_retry_count;
1052 	uchar_t un_reservation_type;
1053 	ushort_t un_notrdy_delay;
1054 	short   un_resvd_status;
1055 	uint32_t
1056 		un_f_arq_enabled,
1057 		un_f_allow_bus_device_reset,
1058 		un_f_opt_queueing;
1059 	timeout_id_t    un_restart_timeid;
1060 };
1061 
1062 struct sd_fi_arq {
1063 	struct scsi_status	sts_status;
1064 	struct scsi_status	sts_rqpkt_status;
1065 	uchar_t				sts_rqpkt_reason;
1066 	uchar_t				sts_rqpkt_resid;
1067 	uint_t				sts_rqpkt_state;
1068 	uint_t				sts_rqpkt_statistics;
1069 	struct scsi_extended_sense	sts_sensedata;
1070 };
1071 
1072 /*
1073  * Conditional set def
1074  */
1075 #define	SD_CONDSET(a, b, c, d)			\
1076 	{ \
1077 	a->c = ((fi_ ## b)->c);			\
1078 	SD_INFO(SD_LOG_IOERR, un,		\
1079 			"sd_fault_injection:"	\
1080 			"setting %s to %d\n", 	\
1081 			d, ((fi_ ## b)->c)); 	\
1082 	}
1083 
1084 /* SD FaultInjection ioctls */
1085 #define	SDIOC			('T'<<8)
1086 #define	SDIOCSTART		(SDIOC|1)
1087 #define	SDIOCSTOP		(SDIOC|2)
1088 #define	SDIOCINSERTPKT	(SDIOC|3)
1089 #define	SDIOCINSERTXB	(SDIOC|4)
1090 #define	SDIOCINSERTUN	(SDIOC|5)
1091 #define	SDIOCINSERTARQ	(SDIOC|6)
1092 #define	SDIOCPUSH		(SDIOC|7)
1093 #define	SDIOCRETRIEVE	(SDIOC|8)
1094 #define	SDIOCRUN		(SDIOC|9)
1095 #endif
1096 
1097 #else
1098 
1099 #undef	SDDEBUG
1100 #define	SD_ERROR	{ if (0) sd_log_err; }
1101 #define	SD_TRACE	{ if (0) sd_log_trace; }
1102 #define	SD_INFO		{ if (0) sd_log_info; }
1103 #define	SD_DUMP_MEMORY	{ if (0) sd_dump_memory; }
1104 #endif
1105 
1106 
1107 /*
1108  * Miscellaneous macros
1109  */
1110 
1111 #define	SD_USECTOHZ(x)			(drv_usectohz((x)*1000000))
1112 #define	SD_GET_PKT_STATUS(pktp)		((*(pktp)->pkt_scbp) & STATUS_MASK)
1113 
1114 #define	SD_BIOERROR(bp, errcode)					\
1115 	if ((bp)->b_resid == 0) {					\
1116 		(bp)->b_resid = (bp)->b_bcount;				\
1117 	}								\
1118 	if ((bp)->b_error == 0) {					\
1119 		bioerror(bp, errcode);					\
1120 	}								\
1121 	(bp)->b_flags |= B_ERROR;
1122 
1123 #define	SD_FILL_SCSI1_LUN_CDB(lunp, cdbp)				\
1124 	if (! (lunp)->un_f_is_fibre &&					\
1125 	    SD_INQUIRY((lunp))->inq_ansi == 0x01) {			\
1126 		int _lun = ddi_prop_get_int(DDI_DEV_T_ANY,		\
1127 		    SD_DEVINFO((lunp)), DDI_PROP_DONTPASS,		\
1128 		    SCSI_ADDR_PROP_LUN, 0);				\
1129 		if (_lun > 0) {						\
1130 			(cdbp)->scc_lun = _lun;				\
1131 		}							\
1132 	}
1133 
1134 #define	SD_FILL_SCSI1_LUN(lunp, pktp)					\
1135 	SD_FILL_SCSI1_LUN_CDB((lunp), (union scsi_cdb *)(pktp)->pkt_cdbp)
1136 
1137 /*
1138  * Disk driver states
1139  */
1140 
1141 #define	SD_STATE_NORMAL		0
1142 #define	SD_STATE_OFFLINE	1
1143 #define	SD_STATE_RWAIT		2
1144 #define	SD_STATE_DUMPING	3
1145 #define	SD_STATE_SUSPENDED	4
1146 #define	SD_STATE_PM_CHANGING	5
1147 
1148 /*
1149  * The table is to be interpreted as follows: The rows lists all the states
1150  * and each column is a state that a state in each row *can* reach. The entries
1151  * in the table list the event that cause that transition to take place.
1152  * For e.g.: To go from state RWAIT to SUSPENDED, event (d)-- which is the
1153  * invocation of DDI_SUSPEND-- has to take place. Note the same event could
1154  * cause the transition from one state to two different states. e.g., from
1155  * state SUSPENDED, when we get a DDI_RESUME, we just go back to the *last
1156  * state* whatever that might be. (NORMAL or OFFLINE).
1157  *
1158  *
1159  * State Transition Table:
1160  *
1161  *                    NORMAL  OFFLINE  RWAIT  DUMPING  SUSPENDED  PM_SUSPENDED
1162  *
1163  *   NORMAL              -      (a)      (b)     (c)      (d)       (h)
1164  *
1165  *   OFFLINE            (e)      -       (e)     (c)      (d)       NP
1166  *
1167  *   RWAIT              (f)     NP        -      (c)      (d)       (h)
1168  *
1169  *   DUMPING            NP      NP        NP      -        NP       NP
1170  *
1171  *   SUSPENDED          (g)     (g)       (b)     NP*      -        NP
1172  *
1173  *   PM_SUSPENDED       (i)     NP        (b)    (c)      (d)       -
1174  *
1175  *   NP :       Not Possible.
1176  *   (a):       Disk does not respond.
1177  *   (b):       Packet Allocation Fails
1178  *   (c):       Panic - Crash dump
1179  *   (d):       DDI_SUSPEND is called.
1180  *   (e):       Disk has a successful I/O completed.
1181  *   (f):       sdrunout() calls sdstart() which sets it NORMAL
1182  *   (g):       DDI_RESUME is called.
1183  *   (h):	Device threshold exceeded pm framework called power
1184  *		entry point or pm_lower_power called in detach.
1185  *   (i):	When new I/O come in.
1186  *    * :       When suspended, we dont change state during panic dump
1187  */
1188 
1189 
1190 #define	SD_MAX_THROTTLE		256
1191 #define	SD_MIN_THROTTLE		8
1192 /*
1193  * Lowest valid max. and min. throttle value.
1194  * This is set to 2 because if un_min_throttle were allowed to be 1 then
1195  * un_throttle would never get set to a value less than un_min_throttle
1196  * (0 is a special case) which means it would never get set back to
1197  * un_saved_throttle in routine sd_restore_throttle().
1198  */
1199 #define	SD_LOWEST_VALID_THROTTLE	2
1200 
1201 
1202 
1203 /* Return codes for sd_send_polled_cmd() and sd_scsi_poll() */
1204 #define	SD_CMD_SUCCESS			0
1205 #define	SD_CMD_FAILURE			1
1206 #define	SD_CMD_RESERVATION_CONFLICT	2
1207 #define	SD_CMD_ILLEGAL_REQUEST		3
1208 #define	SD_CMD_BECOMING_READY		4
1209 #define	SD_CMD_CHECK_CONDITION		5
1210 
1211 /* Return codes for sd_ready_and_valid */
1212 #define	SD_READY_VALID			0
1213 #define	SD_NOT_READY_VALID		1
1214 #define	SD_RESERVED_BY_OTHERS		2
1215 
1216 #define	SD_PATH_STANDARD		0
1217 #define	SD_PATH_DIRECT			1
1218 #define	SD_PATH_DIRECT_PRIORITY		2
1219 
1220 #define	SD_UNIT_ATTENTION_RETRY		40
1221 
1222 /*
1223  * The following three are bit flags passed into sd_send_scsi_TEST_UNIT_READY
1224  * to control specific behavior.
1225  */
1226 #define	SD_CHECK_FOR_MEDIA		0x01
1227 #define	SD_DONT_RETRY_TUR		0x02
1228 #define	SD_BYPASS_PM			0x04
1229 
1230 #define	SD_GROUP0_MAX_ADDRESS	(0x1fffff)
1231 #define	SD_GROUP0_MAXCOUNT	(0xff)
1232 #define	SD_GROUP1_MAX_ADDRESS	(0xffffffff)
1233 #define	SD_GROUP1_MAXCOUNT	(0xffff)
1234 
1235 #define	SD_BECOMING_ACTIVE	0x01
1236 #define	SD_REMOVAL_ALLOW	0
1237 #define	SD_REMOVAL_PREVENT	1
1238 
1239 #define	SD_GET_PKT_OPCODE(pktp)	\
1240 	(((union scsi_cdb *)((pktp)->pkt_cdbp))->cdb_un.cmd)
1241 
1242 
1243 #define	SD_NO_RETRY_ISSUED		0
1244 #define	SD_DELAYED_RETRY_ISSUED		1
1245 #define	SD_IMMEDIATE_RETRY_ISSUED	2
1246 
1247 #if defined(__i386) || defined(__amd64)
1248 #define	SD_UPDATE_B_RESID(bp, pktp)	\
1249 	((bp)->b_resid += (pktp)->pkt_resid + (SD_GET_XBUF(bp)->xb_dma_resid))
1250 #else
1251 #define	SD_UPDATE_B_RESID(bp, pktp)	\
1252 	((bp)->b_resid += (pktp)->pkt_resid)
1253 #endif
1254 
1255 
1256 #define	SD_RETRIES_MASK		0x00FF
1257 #define	SD_RETRIES_NOCHECK	0x0000
1258 #define	SD_RETRIES_STANDARD	0x0001
1259 #define	SD_RETRIES_VICTIM	0x0002
1260 #define	SD_RETRIES_BUSY		0x0003
1261 #define	SD_RETRIES_UA		0x0004
1262 #define	SD_RETRIES_ISOLATE	0x8000
1263 #define	SD_RETRIES_FAILFAST	0x4000
1264 
1265 #define	SD_UPDATE_RESERVATION_STATUS(un, pktp)				\
1266 if (((pktp)->pkt_reason == CMD_RESET) ||				\
1267 	((pktp)->pkt_statistics & (STAT_BUS_RESET | STAT_DEV_RESET))) { \
1268 	if (((un)->un_resvd_status & SD_RESERVE) == SD_RESERVE) {	\
1269 		(un)->un_resvd_status |=				\
1270 		    (SD_LOST_RESERVE | SD_WANT_RESERVE);		\
1271 	}								\
1272 }
1273 
1274 #define	SD_SENSE_DATA_IS_VALID		0
1275 #define	SD_SENSE_DATA_IS_INVALID	1
1276 
1277 /*
1278  * Delay (in seconds) before restoring the "throttle limit" back
1279  * to its maximum value.
1280  * 60 seconds is what we will wait for to reset the
1281  * throttle back to it SD_MAX_THROTTLE for TRAN_BUSY.
1282  * 10 seconds for STATUS_QFULL because QFULL will incrementally
1283  * increase the throttle limit until it reaches max value.
1284  */
1285 #define	SD_RESET_THROTTLE_TIMEOUT	60
1286 #define	SD_QFULL_THROTTLE_TIMEOUT	10
1287 
1288 #define	SD_THROTTLE_TRAN_BUSY		0
1289 #define	SD_THROTTLE_QFULL		1
1290 
1291 #define	SD_THROTTLE_RESET_INTERVAL	\
1292 	(sd_reset_throttle_timeout * drv_usectohz(1000000))
1293 
1294 #define	SD_QFULL_THROTTLE_RESET_INTERVAL	\
1295 	(sd_qfull_throttle_timeout * drv_usectohz(1000000))
1296 
1297 
1298 /*
1299  * xb_pkt_flags defines
1300  * SD_XB_DMA_FREED indicates the scsi_pkt has had its DMA resources freed
1301  * by a call to scsi_dmafree(9F). The resources must be reallocated before
1302  *   before a call to scsi_transport can be made again.
1303  * SD_XB_USCSICMD indicates the scsi request is a uscsi request
1304  * SD_XB_INITPKT_MASK: since this field is also used to store flags for
1305  *   a scsi_init_pkt(9F) call, we need a mask to make sure that we don't
1306  *   pass any unintended bits to scsi_init_pkt(9F) (ugly hack).
1307  */
1308 #define	SD_XB_DMA_FREED		0x20000000
1309 #define	SD_XB_USCSICMD		0x40000000
1310 #define	SD_XB_INITPKT_MASK	(PKT_CONSISTENT | PKT_DMA_PARTIAL)
1311 
1312 /*
1313  * Extension for the buf(9s) struct that we receive from a higher
1314  * layer. Located by b_private in the buf(9S).  (The previous contents
1315  * of b_private are saved & restored before calling biodone(9F).)
1316  */
1317 struct sd_xbuf {
1318 
1319 	struct sd_lun	*xb_un;		/* Ptr to associated sd_lun */
1320 	struct scsi_pkt	*xb_pktp;	/* Ptr to associated scsi_pkt */
1321 
1322 	/*
1323 	 * xb_pktinfo points to any optional data that may be needed
1324 	 * by the initpkt and/or destroypkt functions.  Typical
1325 	 * use might be to point to a struct uscsi_cmd.
1326 	 */
1327 	void	*xb_pktinfo;
1328 
1329 	/*
1330 	 * Layer-private data area. This may be used by any layer to store
1331 	 * layer-specific data on a per-IO basis. Typical usage is for an
1332 	 * iostart routine to save some info here for later use by its
1333 	 * partner iodone routine.  This area may be used to hold data or
1334 	 * a pointer to a data block that is allocated/freed by the layer's
1335 	 * iostart/iodone routines. Allocation & management policy for the
1336 	 * layer-private area is defined & implemented by each specific
1337 	 * layer as required.
1338 	 *
1339 	 * IMPORTANT: Since a higher layer may depend on the value in the
1340 	 * xb_private field, each layer must ensure that it returns the
1341 	 * buf/xbuf to the next higher layer (via SD_NEXT_IODONE()) with
1342 	 * the SAME VALUE in xb_private as when the buf/xbuf was first
1343 	 * received by the layer's iostart routine. Typically this is done
1344 	 * by the iostart routine saving the contents of xb_private into
1345 	 * a place in the layer-private data area, and the iodone routine
1346 	 * restoring the value of xb_private before deallocating the
1347 	 * layer-private data block and calling SD_NEXT_IODONE(). Of course,
1348 	 * if a layer never modifies xb_private in a buf/xbuf from a higher
1349 	 * layer, there will be no need to restore the value.
1350 	 *
1351 	 * Note that in the case where a layer _creates_ a buf/xbuf (such as
1352 	 * by calling sd_shadow_buf_alloc()) to pass to a lower layer, it is
1353 	 * not necessary to preserve the contents of xb_private as there is
1354 	 * no higher layer dependency on the value of xb_private. Such a
1355 	 * buf/xbuf must be deallocated by the layer that allocated it and
1356 	 * must *NEVER* be passed up to a higher layer.
1357 	 */
1358 	void	*xb_private;	/* Layer-private data block */
1359 
1360 	/*
1361 	 * We do not use the b_blkno provided in the buf(9S), as we need to
1362 	 * make adjustments to it in the driver, but it is not a field that
1363 	 * the driver owns or is free to modify.
1364 	 */
1365 	daddr_t	xb_blkno;		/* Absolute block # on target */
1366 	uint64_t xb_ena;		/* ena for a specific SCSI command */
1367 
1368 	int	xb_chain_iostart;	/* iostart side index */
1369 	int	xb_chain_iodone;	/* iodone side index */
1370 	int	xb_pkt_flags;		/* Flags for scsi_init_pkt() */
1371 	ssize_t	xb_dma_resid;
1372 	short	xb_retry_count;
1373 	short	xb_victim_retry_count;
1374 	short	xb_ua_retry_count;	/* unit_attention retry counter */
1375 	short	xb_nr_retry_count;	/* not ready retry counter */
1376 
1377 	/*
1378 	 * Various status and data used when a RQS command is run on
1379 	 * the behalf of this command.
1380 	 */
1381 	struct buf	*xb_sense_bp;	/* back ptr to buf, for RQS */
1382 	uint_t	xb_sense_state;		/* scsi_pkt state of RQS command */
1383 	ssize_t	xb_sense_resid;		/* residual of RQS command */
1384 	uchar_t	xb_sense_status;	/* scsi status byte of RQS command */
1385 	uchar_t	xb_sense_data[SENSE_LENGTH];	/* sense data from RQS cmd */
1386 	/*
1387 	 * Extra sense larger than SENSE_LENGTH will be allocated
1388 	 * right after xb_sense_data[SENSE_LENGTH]. Please do not
1389 	 * add any new field after it.
1390 	 */
1391 };
1392 
1393 _NOTE(SCHEME_PROTECTS_DATA("unique per pkt", sd_xbuf))
1394 
1395 #define	SD_PKT_ALLOC_SUCCESS			0
1396 #define	SD_PKT_ALLOC_FAILURE			1
1397 #define	SD_PKT_ALLOC_FAILURE_NO_DMA		2
1398 #define	SD_PKT_ALLOC_FAILURE_PKT_TOO_SMALL	3
1399 #define	SD_PKT_ALLOC_FAILURE_CDB_TOO_SMALL	4
1400 
1401 #define	SD_GET_XBUF(bp)		((struct sd_xbuf *)((bp)->b_private))
1402 #define	SD_GET_UN(bp)		((SD_GET_XBUF(bp))->xb_un)
1403 #define	SD_GET_PKTP(bp)		((SD_GET_XBUF(bp))->xb_pktp)
1404 #define	SD_GET_BLKNO(bp)	((SD_GET_XBUF(bp))->xb_blkno)
1405 
1406 /*
1407  * Special-purpose struct for sd_send_scsi_cmd() to pass command-specific
1408  * data through the layering chains to sd_initpkt_for_uscsi().
1409  */
1410 struct sd_uscsi_info {
1411 	int			ui_flags;
1412 	struct uscsi_cmd	*ui_cmdp;
1413 	/*
1414 	 * ui_dkc is used by sd_send_scsi_SYNCHRONIZE_CACHE() to allow
1415 	 * for async completion notification.
1416 	 */
1417 	struct dk_callback	ui_dkc;
1418 	/*
1419 	 * The following fields are to be used for FMA ereport generation.
1420 	 */
1421 	uchar_t			ui_pkt_reason;
1422 	uint32_t		ui_pkt_state;
1423 	uint32_t		ui_pkt_statistics;
1424 	uint64_t		ui_lba;
1425 	uint64_t		ui_ena;
1426 };
1427 
1428 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_uscsi_info))
1429 
1430 /*
1431  * This structure is used to issue 'internal' command sequences from the
1432  * driver's attach(9E)/open(9E)/etc entry points. It provides a common context
1433  * for issuing command sequences, with the ability to issue a command
1434  * and provide expected/unexpected assessment of results at any code
1435  * level within the sd_ssc_t scope and preserve the information needed
1436  * produce telemetry for the problem, when needed, from a single
1437  * outer-most-scope point.
1438  *
1439  * The sd_ssc_t abstraction should result in well-structured code where
1440  * the basic code structure is not jeprodized by future localized improvement.
1441  *
1442  *   o  Scope for a sequence of commands.
1443  *   o  Within a scoped sequence of commands, provides a single top-level
1444  *      location for initiating telementry generation from captured data.
1445  *   o  Provide a common place to capture command execution data and driver
1446  *      assessment information for delivery to telemetry generation point.
1447  *   o  Mechanism to get device-as-detector (dad) and transport telemetry
1448  *      information from interrupt context (sdintr) back to the internal
1449  *      command 'driver-assessment' code.
1450  *   o  Ability to record assessment, and return information back to
1451  *      top-level telemetry generation code when an unexpected condition
1452  *      occurs.
1453  *   o  For code paths were an command itself was successful but
1454  *      the data returned looks suspect, the ability to record
1455  *      'unexpected data' conditions.
1456  *   o  Record assessment of issuing the command and interpreting
1457  *      the returned data for consumption by top-level ereport telemetry
1458  *      generation code.
1459  *   o  All data required to produce telemetry available off single data
1460  *      structure.
1461  */
1462 typedef struct {
1463 	struct sd_lun		*ssc_un;
1464 	struct uscsi_cmd	*ssc_uscsi_cmd;
1465 	struct sd_uscsi_info	*ssc_uscsi_info;
1466 	int			ssc_flags; /* Bits for flags */
1467 	char			ssc_info[1024]; /* Buffer holding for info */
1468 } sd_ssc_t;
1469 
1470 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_ssc_t))
1471 
1472 /*
1473  * This struct switch different 'type-of-assessment'
1474  * as an input argument for sd_ssc_assessment
1475  *
1476  *
1477  * in sd_send_scsi_XXX or upper-level
1478  *
1479  * - SD_FMT_IGNORE
1480  *   when send uscsi command failed, and
1481  *   the following code check sense data properly.
1482  *   we use 'ignore' to let sd_ssc_assessment
1483  *   trust current and do not do additional
1484  *   checking for the uscsi command.
1485  *
1486  * - SD_FMT_IGNORE_COMPROMISE
1487  *   when send uscsi command failed, and
1488  *   the code does not check sense data or we don't
1489  *   think the checking is 100% coverage. We mark it
1490  *   as 'compromise' to indicate that we need to
1491  *   enhance current code in the future.
1492  *
1493  * - SD_FMT_STATUS_CHECK
1494  *   when send uscsi command failed and cause sd entries
1495  *   failed finally, we need to send out real reason against
1496  *   status of uscsi command no matter if there is sense back
1497  *   or not.
1498  *
1499  * - SD_FMT_STANDARD
1500  *   when send uscsi command succeeded, and
1501  *   the code does not check sense data, we need to check
1502  *   it to make sure there is no 'fault'.
1503  */
1504 enum sd_type_assessment {
1505 	SD_FMT_IGNORE = 0,
1506 	SD_FMT_IGNORE_COMPROMISE,
1507 	SD_FMT_STATUS_CHECK,
1508 	SD_FMT_STANDARD
1509 };
1510 
1511 /*
1512  * The following declaration are used as hints of severities when posting
1513  * SCSI FMA ereport.
1514  * - SD_FM_DRV_FATAL
1515  *   When posting ereport with SD_FM_DRV_FATAL, the payload
1516  *   "driver-assessment" will be "fail" or "fatal" depending on the
1517  *   sense-key value. If driver-assessment is "fail", it will be
1518  *   propagated to an upset, otherwise, a fault will be propagated.
1519  * - SD_FM_DRV_RETRY
1520  *   When posting ereport with SD_FM_DRV_RETRY, the payload
1521  *   "driver-assessment" will be "retry", and it will be propagated to an
1522  *   upset.
1523  * - SD_FM_DRV_RECOVERY
1524  *   When posting ereport with SD_FM_DRV_RECOVERY, the payload
1525  *   "driver-assessment" will be "recovered", and it will be propagated to
1526  *   an upset.
1527  * - SD_FM_DRV_NOTICE
1528  *   When posting ereport with SD_FM_DRV_NOTICE, the payload
1529  *   "driver-assessment" will be "info", and it will be propagated to an
1530  *   upset.
1531  */
1532 enum sd_driver_assessment {
1533 	SD_FM_DRV_FATAL = 0,
1534 	SD_FM_DRV_RETRY,
1535 	SD_FM_DRV_RECOVERY,
1536 	SD_FM_DRV_NOTICE
1537 };
1538 
1539 /*
1540  * The following structure is used as a buffer when posting SCSI FMA
1541  * ereport for raw i/o. It will be allocated per sd_lun when entering
1542  * sd_unit_attach and will be deallocated when entering sd_unit_detach.
1543  */
1544 struct sd_fm_internal {
1545 	sd_ssc_t fm_ssc;
1546 	struct uscsi_cmd fm_ucmd;
1547 	struct sd_uscsi_info fm_uinfo;
1548 	int fm_log_level;
1549 };
1550 
1551 /*
1552  * Bits in ssc_flags
1553  * sd_ssc_init will mark ssc_flags = SSC_FLAGS_UNKNOWN
1554  * sd_ssc_send will mark ssc_flags = SSC_FLAGS_CMD_ISSUED &
1555  *                                   SSC_FLAGS_NEED_ASSESSMENT
1556  * sd_ssc_assessment will clear SSC_FLAGS_CMD_ISSUED and
1557  * SSC_FLAGS_NEED_ASSESSMENT bits of ssc_flags.
1558  * SSC_FLAGS_CMD_ISSUED is to indicate whether the SCSI command has been
1559  * sent out.
1560  * SSC_FLAGS_NEED_ASSESSMENT is to guarantee we will not miss any
1561  * assessment point.
1562  */
1563 #define		SSC_FLAGS_UNKNOWN		0x00000000
1564 #define		SSC_FLAGS_CMD_ISSUED		0x00000001
1565 #define		SSC_FLAGS_NEED_ASSESSMENT	0x00000002
1566 #define		SSC_FLAGS_TRAN_ABORT		0x00000004
1567 
1568 /*
1569  * The following bits in ssc_flags are for detecting unexpected data.
1570  */
1571 #define		SSC_FLAGS_INVALID_PKT_REASON	0x00000010
1572 #define		SSC_FLAGS_INVALID_STATUS	0x00000020
1573 #define		SSC_FLAGS_INVALID_SENSE		0x00000040
1574 #define		SSC_FLAGS_INVALID_DATA		0x00000080
1575 
1576 /*
1577  * The following are the values available for sd_fm_internal::fm_log_level.
1578  * SD_FM_LOG_NSUP	The driver will log things in traditional way as if
1579  * 			the SCSI FMA feature is unavailable.
1580  * SD_FM_LOG_SILENT	The driver will not print out syslog for FMA error
1581  * 			telemetry, all the error telemetries will go into
1582  * 			FMA error log.
1583  * SD_FM_LOG_EREPORT	The driver will both print the FMA error telemetry
1584  * 			and post the error report, but the traditional
1585  * 			syslog for error telemetry will be suppressed.
1586  */
1587 #define		SD_FM_LOG_NSUP		0
1588 #define		SD_FM_LOG_SILENT	1
1589 #define		SD_FM_LOG_EREPORT	2
1590 
1591 /*
1592  * Macros and definitions for driver kstats and errstats
1593  *
1594  * Some third-party layered drivers (they know who they are) do not maintain
1595  * their open/close counts correctly which causes our kstat reporting to get
1596  * messed up & results in panics. These macros will update the driver kstats
1597  * only if the counts are valid.
1598  */
1599 #define	SD_UPDATE_COMMON_KSTATS(kstat_function, kstatp)			\
1600 	if ((kstat_function)  == kstat_runq_exit ||			\
1601 	    ((kstat_function) == kstat_runq_back_to_waitq)) { 		\
1602 		if (((kstat_io_t *)(kstatp))->rcnt) {			\
1603 			kstat_function((kstatp));			\
1604 		} else {						\
1605 			cmn_err(CE_WARN,				\
1606 		"kstat rcnt == 0 when exiting runq, please check\n");	\
1607 		}							\
1608 	} else if ((kstat_function) == kstat_waitq_exit ||		\
1609 	    ((kstat_function) == kstat_waitq_to_runq)) {		\
1610 		if (((kstat_io_t *)(kstatp))->wcnt) {			\
1611 			kstat_function(kstatp);				\
1612 		} else {						\
1613 			cmn_err(CE_WARN,				\
1614 		"kstat wcnt == 0 when exiting waitq, please check\n");	\
1615 		}							\
1616 	} else {							\
1617 		kstat_function(kstatp);					\
1618 	}
1619 
1620 #define	SD_UPDATE_KSTATS(un, kstat_function, bp)			\
1621 	ASSERT(SD_GET_XBUF(bp) != NULL);				\
1622 	if (SD_IS_BUFIO(SD_GET_XBUF(bp))) {				\
1623 		struct kstat *pksp =					\
1624 			(un)->un_pstats[SDPART((bp)->b_edev)];		\
1625 		ASSERT(mutex_owned(SD_MUTEX(un)));			\
1626 		if ((un)->un_stats != NULL) {				\
1627 			kstat_io_t *kip = KSTAT_IO_PTR((un)->un_stats);	\
1628 			SD_UPDATE_COMMON_KSTATS(kstat_function, kip);	\
1629 		}							\
1630 		if (pksp != NULL) {					\
1631 			kstat_io_t *kip = KSTAT_IO_PTR(pksp);		\
1632 			SD_UPDATE_COMMON_KSTATS(kstat_function, kip);	\
1633 		}							\
1634 	}
1635 
1636 #define	SD_UPDATE_ERRSTATS(un, x)					\
1637 	if ((un)->un_errstats != NULL) {				\
1638 		struct sd_errstats *stp;				\
1639 		ASSERT(mutex_owned(SD_MUTEX(un)));			\
1640 		stp = (struct sd_errstats *)(un)->un_errstats->ks_data;	\
1641 		stp->x.value.ui32++;					\
1642 	}
1643 
1644 #define	SD_UPDATE_RDWR_STATS(un, bp)					\
1645 	if ((un)->un_stats != NULL) {					\
1646 		kstat_io_t *kip = KSTAT_IO_PTR((un)->un_stats);		\
1647 		size_t n_done = (bp)->b_bcount - (bp)->b_resid;		\
1648 		if ((bp)->b_flags & B_READ) {				\
1649 			kip->reads++;					\
1650 			kip->nread += n_done;				\
1651 		} else {						\
1652 			kip->writes++;					\
1653 			kip->nwritten += n_done;			\
1654 		}							\
1655 	}
1656 
1657 #define	SD_UPDATE_PARTITION_STATS(un, bp)				\
1658 {									\
1659 	struct kstat *pksp = (un)->un_pstats[SDPART((bp)->b_edev)];	\
1660 	if (pksp != NULL) {						\
1661 		kstat_io_t *kip = KSTAT_IO_PTR(pksp);			\
1662 		size_t n_done = (bp)->b_bcount - (bp)->b_resid;		\
1663 		if ((bp)->b_flags & B_READ) {				\
1664 			kip->reads++;					\
1665 			kip->nread += n_done;				\
1666 		} else {						\
1667 			kip->writes++;					\
1668 			kip->nwritten += n_done;			\
1669 		}							\
1670 	}								\
1671 }
1672 
1673 
1674 #endif	/* defined(_KERNEL) || defined(_KMEMUSER) */
1675 
1676 
1677 /*
1678  * 60 seconds is a *very* reasonable amount of time for most slow CD
1679  * operations.
1680  */
1681 #define	SD_IO_TIME			60
1682 
1683 /*
1684  * 2 hours is an excessively reasonable amount of time for format operations.
1685  */
1686 #define	SD_FMT_TIME			(120 * 60)
1687 
1688 /*
1689  * 5 seconds is what we'll wait if we get a Busy Status back
1690  */
1691 #define	SD_BSY_TIMEOUT			(drv_usectohz(5 * 1000000))
1692 
1693 /*
1694  * 100 msec. is what we'll wait if we get Unit Attention.
1695  */
1696 #define	SD_UA_RETRY_DELAY		(drv_usectohz((clock_t)100000))
1697 
1698 /*
1699  * 100 msec. is what we'll wait for restarted commands.
1700  */
1701 #define	SD_RESTART_TIMEOUT		(drv_usectohz((clock_t)100000))
1702 
1703 /*
1704  * 10s misaligned I/O warning message interval
1705  */
1706 #define	SD_RMW_MSG_PRINT_TIMEOUT	(drv_usectohz((clock_t)10000000))
1707 
1708 /*
1709  * 100 msec. is what we'll wait for certain retries for fibre channel
1710  * targets, 0 msec for parallel SCSI.
1711  */
1712 #if defined(__fibre)
1713 #define	SD_RETRY_DELAY			(drv_usectohz(100000))
1714 #else
1715 #define	SD_RETRY_DELAY			((clock_t)0)
1716 #endif
1717 
1718 /*
1719  * 60 seconds is what we will wait for to reset the
1720  * throttle back to it SD_MAX_THROTTLE.
1721  */
1722 #define	SD_RESET_THROTTLE_TIMEOUT	60
1723 
1724 /*
1725  * Number of times we'll retry a normal operation.
1726  *
1727  * This includes retries due to transport failure
1728  * (need to distinguish between Target and Transport failure)
1729  *
1730  */
1731 #if defined(__fibre)
1732 #define	SD_RETRY_COUNT			3
1733 #else
1734 #define	SD_RETRY_COUNT			5
1735 #endif
1736 
1737 /*
1738  * Number of times we will retry for unit attention.
1739  */
1740 #define	SD_UA_RETRY_COUNT		600
1741 
1742 #define	SD_VICTIM_RETRY_COUNT(un)	(un->un_victim_retry_count)
1743 #define	CD_NOT_READY_RETRY_COUNT(un)	(un->un_retry_count * 2)
1744 #define	DISK_NOT_READY_RETRY_COUNT(un)	(un->un_retry_count / 2)
1745 
1746 
1747 /*
1748  * Maximum number of units we can support
1749  * (controlled by room in minor device byte)
1750  *
1751  * Note: this value is out of date.
1752  */
1753 #define	SD_MAXUNIT			32
1754 
1755 /*
1756  * 30 seconds is what we will wait for the IO to finish
1757  * before we fail the DDI_SUSPEND
1758  */
1759 #define	SD_WAIT_CMDS_COMPLETE		30
1760 
1761 /*
1762  * Prevent/allow media removal flags
1763  */
1764 #define	SD_REMOVAL_ALLOW		0
1765 #define	SD_REMOVAL_PREVENT		1
1766 
1767 
1768 /*
1769  * Drive Types (and characteristics)
1770  */
1771 #define	VIDMAX				8
1772 #define	PIDMAX				16
1773 
1774 
1775 /*
1776  * The following #defines and type definitions for the property
1777  * processing component of the sd driver.
1778  */
1779 
1780 
1781 /* Miscellaneous Definitions */
1782 #define	SD_CONF_VERSION_1		1
1783 #define	SD_CONF_NOT_USED		32
1784 
1785 /*
1786  * Return values from "pm-capable" property
1787  */
1788 #define	SD_PM_CAPABLE_UNDEFINED		-1
1789 #define	SD_PM_CAPABLE_FALSE		0
1790 #define	SD_PM_CAPABLE_TRUE		1
1791 
1792 /*
1793  * Property data values used in static configuration table
1794  * These are all based on device characteristics.
1795  * For fibre channel devices, the throttle value is usually
1796  * derived from the devices cmd Q depth divided by the number
1797  * of supported initiators.
1798  */
1799 #define	ELITE_THROTTLE_VALUE		10
1800 #define	SEAGATE_THROTTLE_VALUE		15
1801 #define	IBM_THROTTLE_VALUE		15
1802 #define	ST31200N_THROTTLE_VALUE		8
1803 #define	FUJITSU_THROTTLE_VALUE		15
1804 #define	SYMBIOS_THROTTLE_VALUE		16
1805 #define	SYMBIOS_NOTREADY_RETRIES	24
1806 #define	LSI_THROTTLE_VALUE		16
1807 #define	LSI_NOTREADY_RETRIES		24
1808 #define	LSI_OEM_NOTREADY_RETRIES	36
1809 #define	PURPLE_THROTTLE_VALUE		64
1810 #define	PURPLE_BUSY_RETRIES		60
1811 #define	PURPLE_RESET_RETRY_COUNT	36
1812 #define	PURPLE_RESERVE_RELEASE_TIME	60
1813 #define	SVE_BUSY_RETRIES		60
1814 #define	SVE_RESET_RETRY_COUNT		36
1815 #define	SVE_RESERVE_RELEASE_TIME	60
1816 #define	SVE_THROTTLE_VALUE		10
1817 #define	SVE_MIN_THROTTLE_VALUE		2
1818 #define	SVE_DISKSORT_DISABLED_FLAG	1
1819 #define	MASERATI_DISKSORT_DISABLED_FLAG	1
1820 #define	MASERATI_LUN_RESET_ENABLED_FLAG	1
1821 #define	PIRUS_THROTTLE_VALUE		64
1822 #define	PIRUS_NRR_COUNT			60
1823 #define	PIRUS_BUSY_RETRIES		60
1824 #define	PIRUS_RESET_RETRY_COUNT		36
1825 #define	PIRUS_MIN_THROTTLE_VALUE	16
1826 #define	PIRUS_DISKSORT_DISABLED_FLAG	0
1827 #define	PIRUS_LUN_RESET_ENABLED_FLAG	1
1828 
1829 /*
1830  * Driver Property Bit Flag definitions
1831  *
1832  * Unfortunately, for historical reasons, the bit-flag definitions are
1833  * different on SPARC, INTEL, & FIBRE platforms.
1834  */
1835 
1836 /*
1837  * Bit flag telling driver to set throttle from sd.conf sd-config-list
1838  * and driver table.
1839  *
1840  * The max throttle (q-depth) property implementation is for support of
1841  * fibre channel devices that can drop an i/o request when a queue fills
1842  * up. The number of commands sent to the disk from this driver is
1843  * regulated such that queue overflows are avoided.
1844  */
1845 #define	SD_CONF_SET_THROTTLE		0
1846 #define	SD_CONF_BSET_THROTTLE		(1 << SD_CONF_SET_THROTTLE)
1847 
1848 /*
1849  * Bit flag telling driver to set the controller type from sd.conf
1850  * sd-config-list and driver table.
1851  */
1852 #if defined(__i386) || defined(__amd64)
1853 #define	SD_CONF_SET_CTYPE		1
1854 #elif defined(__fibre)
1855 #define	SD_CONF_SET_CTYPE		5
1856 #else
1857 #define	SD_CONF_SET_CTYPE		1
1858 #endif
1859 #define	SD_CONF_BSET_CTYPE		(1 << SD_CONF_SET_CTYPE)
1860 
1861 /*
1862  * Bit flag telling driver to set the not ready retry count for a device from
1863  * sd.conf sd-config-list and driver table.
1864  */
1865 #if defined(__i386) || defined(__amd64)
1866 #define	SD_CONF_SET_NOTREADY_RETRIES	10
1867 #elif defined(__fibre)
1868 #define	SD_CONF_SET_NOTREADY_RETRIES	1
1869 #else
1870 #define	SD_CONF_SET_NOTREADY_RETRIES	2
1871 #endif
1872 #define	SD_CONF_BSET_NRR_COUNT		(1 << SD_CONF_SET_NOTREADY_RETRIES)
1873 
1874 /*
1875  * Bit flag telling driver to set SCSI status BUSY Retries from sd.conf
1876  * sd-config-list and driver table.
1877  */
1878 #if defined(__i386) || defined(__amd64)
1879 #define	SD_CONF_SET_BUSY_RETRIES 	11
1880 #elif defined(__fibre)
1881 #define	SD_CONF_SET_BUSY_RETRIES 	2
1882 #else
1883 #define	SD_CONF_SET_BUSY_RETRIES 	5
1884 #endif
1885 #define	SD_CONF_BSET_BSY_RETRY_COUNT	(1 << SD_CONF_SET_BUSY_RETRIES)
1886 
1887 /*
1888  * Bit flag telling driver that device does not have a valid/unique serial
1889  * number.
1890  */
1891 #if defined(__i386) || defined(__amd64)
1892 #define	SD_CONF_SET_FAB_DEVID		2
1893 #else
1894 #define	SD_CONF_SET_FAB_DEVID		3
1895 #endif
1896 #define	SD_CONF_BSET_FAB_DEVID   	(1 << SD_CONF_SET_FAB_DEVID)
1897 
1898 /*
1899  * Bit flag telling driver to disable all caching for disk device.
1900  */
1901 #if defined(__i386) || defined(__amd64)
1902 #define	SD_CONF_SET_NOCACHE		3
1903 #else
1904 #define	SD_CONF_SET_NOCACHE		4
1905 #endif
1906 #define	SD_CONF_BSET_NOCACHE		(1 << SD_CONF_SET_NOCACHE)
1907 
1908 /*
1909  * Bit flag telling driver that the PLAY AUDIO command requires parms in BCD
1910  * format rather than binary.
1911  */
1912 #if defined(__i386) || defined(__amd64)
1913 #define	SD_CONF_SET_PLAYMSF_BCD		4
1914 #else
1915 #define	SD_CONF_SET_PLAYMSF_BCD		6
1916 #endif
1917 #define	SD_CONF_BSET_PLAYMSF_BCD    	(1 << SD_CONF_SET_PLAYMSF_BCD)
1918 
1919 /*
1920  * Bit flag telling driver that the response from the READ SUBCHANNEL command
1921  * has BCD fields rather than binary.
1922  */
1923 #if defined(__i386) || defined(__amd64)
1924 #define	SD_CONF_SET_READSUB_BCD		5
1925 #else
1926 #define	SD_CONF_SET_READSUB_BCD		7
1927 #endif
1928 #define	SD_CONF_BSET_READSUB_BCD	(1 << SD_CONF_SET_READSUB_BCD)
1929 
1930 /*
1931  * Bit in flags telling driver that the track number fields in the READ TOC
1932  * request and respone are in BCD rather than binary.
1933  */
1934 #if defined(__i386) || defined(__amd64)
1935 #define	SD_CONF_SET_READ_TOC_TRK_BCD	6
1936 #else
1937 #define	SD_CONF_SET_READ_TOC_TRK_BCD	8
1938 #endif
1939 #define	SD_CONF_BSET_READ_TOC_TRK_BCD	(1 << SD_CONF_SET_READ_TOC_TRK_BCD)
1940 
1941 /*
1942  * Bit flag telling driver that the address fields in the READ TOC request and
1943  * respone are in BCD rather than binary.
1944  */
1945 #if defined(__i386) || defined(__amd64)
1946 #define	SD_CONF_SET_READ_TOC_ADDR_BCD	7
1947 #else
1948 #define	SD_CONF_SET_READ_TOC_ADDR_BCD	9
1949 #endif
1950 #define	SD_CONF_BSET_READ_TOC_ADDR_BCD	(1 << SD_CONF_SET_READ_TOC_ADDR_BCD)
1951 
1952 /*
1953  * Bit flag telling the driver that the device doesn't support the READ HEADER
1954  * command.
1955  */
1956 #if defined(__i386) || defined(__amd64)
1957 #define	SD_CONF_SET_NO_READ_HEADER	8
1958 #else
1959 #define	SD_CONF_SET_NO_READ_HEADER	10
1960 #endif
1961 #define	SD_CONF_BSET_NO_READ_HEADER 	(1 << SD_CONF_SET_NO_READ_HEADER)
1962 
1963 /*
1964  * Bit flag telling the driver that for the READ CD command the device uses
1965  * opcode 0xd4 rather than 0xbe.
1966  */
1967 #if defined(__i386) || defined(__amd64)
1968 #define	SD_CONF_SET_READ_CD_XD4		9
1969 #else
1970 #define	SD_CONF_SET_READ_CD_XD4 	11
1971 #endif
1972 #define	SD_CONF_BSET_READ_CD_XD4	(1 << SD_CONF_SET_READ_CD_XD4)
1973 
1974 /*
1975  * Bit flag telling the driver to set SCSI status Reset Retries
1976  * (un_reset_retry_count) from sd.conf sd-config-list and driver table (4356701)
1977  */
1978 #define	SD_CONF_SET_RST_RETRIES		12
1979 #define	SD_CONF_BSET_RST_RETRIES	(1 << SD_CONF_SET_RST_RETRIES)
1980 
1981 /*
1982  * Bit flag telling the driver to set the reservation release timeout value
1983  * from sd.conf sd-config-list and driver table. (4367306)
1984  */
1985 #define	SD_CONF_SET_RSV_REL_TIME	13
1986 #define	SD_CONF_BSET_RSV_REL_TIME	(1 << SD_CONF_SET_RSV_REL_TIME)
1987 
1988 /*
1989  * Bit flag telling the driver to verify that no commands are pending for a
1990  * device before issuing a Test Unit Ready. This is a fw workaround for Seagate
1991  * eliteI drives. (4392016)
1992  */
1993 #define	SD_CONF_SET_TUR_CHECK		14
1994 #define	SD_CONF_BSET_TUR_CHECK		(1 << SD_CONF_SET_TUR_CHECK)
1995 
1996 /*
1997  * Bit in flags telling driver to set min. throttle from ssd.conf
1998  * ssd-config-list and driver table.
1999  */
2000 #define	SD_CONF_SET_MIN_THROTTLE	15
2001 #define	SD_CONF_BSET_MIN_THROTTLE	(1 << SD_CONF_SET_MIN_THROTTLE)
2002 
2003 /*
2004  * Bit in flags telling driver to set disksort disable flag from ssd.conf
2005  * ssd-config-list and driver table.
2006  */
2007 #define	SD_CONF_SET_DISKSORT_DISABLED	16
2008 #define	SD_CONF_BSET_DISKSORT_DISABLED	(1 << SD_CONF_SET_DISKSORT_DISABLED)
2009 
2010 /*
2011  * Bit in flags telling driver to set LUN Reset enable flag from [s]sd.conf
2012  * [s]sd-config-list and driver table.
2013  */
2014 #define	SD_CONF_SET_LUN_RESET_ENABLED	17
2015 #define	SD_CONF_BSET_LUN_RESET_ENABLED	(1 << SD_CONF_SET_LUN_RESET_ENABLED)
2016 
2017 /*
2018  * Bit in flags telling driver that the write cache on the device is
2019  * non-volatile.
2020  */
2021 #define	SD_CONF_SET_CACHE_IS_NV	18
2022 #define	SD_CONF_BSET_CACHE_IS_NV	(1 << SD_CONF_SET_CACHE_IS_NV)
2023 
2024 /*
2025  * This is the number of items currently settable in the sd.conf
2026  * sd-config-list.  The mask value is defined for parameter checking. The
2027  * item count and mask should be updated when new properties are added.
2028  */
2029 #define	SD_CONF_MAX_ITEMS		19
2030 #define	SD_CONF_BIT_MASK		0x0007FFFF
2031 
2032 typedef struct {
2033 	int sdt_throttle;
2034 	int sdt_ctype;
2035 	int sdt_not_rdy_retries;
2036 	int sdt_busy_retries;
2037 	int sdt_reset_retries;
2038 	int sdt_reserv_rel_time;
2039 	int sdt_min_throttle;
2040 	int sdt_disk_sort_dis;
2041 	int sdt_lun_reset_enable;
2042 	int sdt_suppress_cache_flush;
2043 } sd_tunables;
2044 
2045 /* Type definition for static configuration table entries */
2046 typedef struct sd_disk_config {
2047 	char	device_id[25];
2048 	uint_t	flags;
2049 	sd_tunables *properties;
2050 } sd_disk_config_t;
2051 
2052 /*
2053  * byte 4 options for 1bh command
2054  */
2055 #define	SD_TARGET_STOP			0x00
2056 #define	SD_TARGET_START			0x01
2057 #define	SD_TARGET_EJECT			0x02
2058 #define	SD_TARGET_CLOSE			0x03
2059 
2060 
2061 #define	SD_MODE_SENSE_PAGE3_CODE	0x03
2062 #define	SD_MODE_SENSE_PAGE4_CODE	0x04
2063 
2064 #define	SD_MODE_SENSE_PAGE3_LENGTH					\
2065 	(sizeof (struct mode_format) + MODE_PARAM_LENGTH)
2066 #define	SD_MODE_SENSE_PAGE4_LENGTH					\
2067 	(sizeof (struct mode_geometry) + MODE_PARAM_LENGTH)
2068 
2069 /*
2070  * These command codes need to be moved to sys/scsi/generic/commands.h
2071  */
2072 
2073 /* Both versions of the Read CD command */
2074 
2075 /* the official SCMD_READ_CD now comes from cdio.h */
2076 #define	SCMD_READ_CDD4		0xd4	/* the one used by some first */
2077 					/* generation ATAPI CD drives */
2078 
2079 /* expected sector type filter values for Play and Read CD CDBs */
2080 #define	CDROM_SECTOR_TYPE_CDDA		(1<<2)	/* IEC 908:1987 (CDDA) */
2081 #define	CDROM_SECTOR_TYPE_MODE1		(2<<2)	/* Yellow book 2048 bytes */
2082 #define	CDROM_SECTOR_TYPE_MODE2		(3<<2)	/* Yellow book 2335 bytes */
2083 #define	CDROM_SECTOR_TYPE_MODE2_FORM1	(4<<2)	/* 2048 bytes */
2084 #define	CDROM_SECTOR_TYPE_MODE2_FORM2	(5<<2)	/* 2324 bytes */
2085 
2086 /* READ CD filter bits (cdb[9]) */
2087 #define	CDROM_READ_CD_SYNC	0x80	/* read sync field */
2088 #define	CDROM_READ_CD_HDR	0x20	/* read four byte header */
2089 #define	CDROM_READ_CD_SUBHDR	0x40	/* read sub-header */
2090 #define	CDROM_READ_CD_ALLHDRS	0x60	/* read header and sub-header */
2091 #define	CDROM_READ_CD_USERDATA	0x10	/* read user data */
2092 #define	CDROM_READ_CD_EDC_ECC	0x08	/* read EDC and ECC field */
2093 #define	CDROM_READ_CD_C2	0x02	/* read C2 error data */
2094 #define	CDROM_READ_CD_C2_BEB	0x04	/* read C2 and Block Error Bits */
2095 
2096 
2097 /*
2098  * These belong in sys/scsi/generic/mode.h
2099  */
2100 
2101 /*
2102  * Mode Sense/Select Header response for Group 2 CDB.
2103  */
2104 
2105 struct mode_header_grp2 {
2106 	uchar_t length_msb;		/* MSB - number of bytes following */
2107 	uchar_t length_lsb;
2108 	uchar_t medium_type;		/* device specific */
2109 	uchar_t device_specific;	/* device specfic parameters */
2110 	uchar_t resv[2];		/* reserved */
2111 	uchar_t bdesc_length_hi;	/* length of block descriptor(s) */
2112 					/* (if any) */
2113 	uchar_t bdesc_length_lo;
2114 };
2115 
2116 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", mode_header_grp2))
2117 
2118 /*
2119  * Length of the Mode Parameter Header for the Group 2 Mode Select command
2120  */
2121 #define	MODE_HEADER_LENGTH_GRP2	(sizeof (struct mode_header_grp2))
2122 #define	MODE_PARAM_LENGTH_GRP2 (MODE_HEADER_LENGTH_GRP2 + MODE_BLK_DESC_LENGTH)
2123 
2124 /*
2125  * Mode Page 1 - Error Recovery Page
2126  */
2127 #define	MODEPAGE_ERR_RECOVER		1
2128 
2129 /*
2130  * The following buffer length define is 8 bytes for the Group 2 mode page
2131  * header, 8 bytes for the block descriptor and 26 bytes for the cdrom
2132  * capabilities page (per MMC-2)
2133  */
2134 #define	MODEPAGE_CDROM_CAP		0x2A
2135 #define	MODEPAGE_CDROM_CAP_LEN		26
2136 #define	BUFLEN_MODE_CDROM_CAP		(MODEPAGE_CDROM_CAP_LEN + \
2137 	MODE_HEADER_LENGTH_GRP2 + MODE_BLK_DESC_LENGTH)
2138 
2139 
2140 /*
2141  * Power management defines
2142  */
2143 #define	SD_SPINDLE_UNINIT	(-1)
2144 #define	SD_SPINDLE_OFF		0
2145 #define	SD_SPINDLE_ON		1
2146 #define	SD_PM_NOT_SUPPORTED	2
2147 
2148 
2149 /*
2150  * No Need to resume if already in PM_SUSPEND state because the thread
2151  * was suspended in sdpower. It will be resumed when sdpower is invoked to make
2152  * the device active.
2153  * When the thread is suspended, the watch thread is terminated and
2154  * the token is NULLed so check for this condition.
2155  * If there's a thread that can be resumed, ie. token is not NULL, then
2156  * it can be resumed.
2157  */
2158 #define	SD_OK_TO_RESUME_SCSI_WATCHER(un)	(un->un_swr_token != NULL)
2159 /*
2160  * No Need to resume if already in PM_SUSPEND state because the thread
2161  * was suspended in sdpower. It will be resumed when sdpower is invoked to make
2162  * the device active.
2163  * When the thread is suspended, the watch thread is terminated and
2164  * the token is NULLed so check for this condition.
2165  */
2166 #define	SD_OK_TO_SUSPEND_SCSI_WATCHER(un)	(un->un_swr_token != NULL)
2167 #define	SD_DEVICE_IS_IN_LOW_POWER(un)		((un->un_f_pm_is_enabled) && \
2168 						    (un->un_pm_count < 0))
2169 /*
2170  * Could move this define to some thing like log sense.h in SCSA headers
2171  * But for now let it live here.
2172  */
2173 #define	START_STOP_CYCLE_COUNTER_PAGE_SIZE	0x28
2174 #define	START_STOP_CYCLE_PAGE			0x0E
2175 #define	START_STOP_CYCLE_VU_PAGE		0x31
2176 
2177 /* CD-ROM Error Recovery Parameters page (0x01) */
2178 #define	MODEPAGE_ERR_RECOV	0x1
2179 #define	BUFLEN_CHG_BLK_MODE	MODE_HEADER_LENGTH + MODE_BLK_DESC_LENGTH
2180 
2181 /*
2182  * Vendor Specific (Toshiba) CD-ROM Speed page (0x31)
2183  *
2184  * The following buffer length define is 4 bytes for the Group 0 mode page
2185  * header, 8 bytes for the block descriptor and 4 bytes for the mode speed page.
2186  */
2187 #define	MODEPAGE_CDROM_SPEED_LEN	4
2188 #define	BUFLEN_MODE_CDROM_SPEED		MODEPAGE_CDROM_SPEED_LEN +\
2189 					MODE_HEADER_LENGTH +\
2190 					MODE_BLK_DESC_LENGTH
2191 #define	SD_SPEED_1X			176
2192 
2193 /* CD-ROM Audio Control Parameters page (0x0E) */
2194 #define	MODEPAGE_AUDIO_CTRL		0x0E
2195 #define	MODEPAGE_AUDIO_CTRL_LEN		16
2196 
2197 /* CD-ROM Sony Read Offset Defines */
2198 #define	SONY_SESSION_OFFSET_LEN		12
2199 #define	SONY_SESSION_OFFSET_KEY		0x40
2200 #define	SONY_SESSION_OFFSET_VALID	0x0a
2201 
2202 /*
2203  * CD-ROM Write Protect Defines
2204  *
2205  * Bit 7 of the device specific field of the mode page header is the write
2206  * protect bit.
2207  */
2208 #define	WRITE_PROTECT 0x80
2209 
2210 /*
2211  * Define for the length of a profile header returned in response to the
2212  * GET CONFIGURATION command
2213  */
2214 #define	SD_PROFILE_HEADER_LEN		8	/* bytes */
2215 
2216 /*
2217  * Define the length of the data in response to the GET CONFIGURATION
2218  * command.  The 3rd byte of the feature descriptor contains the
2219  * current feature field that is of interest.  This field begins
2220  * after the feature header which is 8 bytes.  This variable length
2221  * was increased in size from 11 to 24 because some devices became
2222  * unresponsive with the smaller size.
2223  */
2224 #define	SD_CURRENT_FEATURE_LEN		24	/* bytes */
2225 
2226 /*
2227  * Feature codes associated with GET CONFIGURATION command for supported
2228  * devices.
2229  */
2230 #define	RANDOM_WRITABLE			0x20
2231 #define	HARDWARE_DEFECT_MANAGEMENT	0x24
2232 
2233 /*
2234  * Could move this define to some thing like log sense.h in SCSA headers
2235  * But for now let it live here.
2236  */
2237 #define	TEMPERATURE_PAGE			0x0D
2238 #define	TEMPERATURE_PAGE_SIZE			16	/* bytes */
2239 
2240 /* delay time used for sd_media_watch_cb delayed cv broadcast */
2241 #define	MEDIA_ACCESS_DELAY 2000000
2242 
2243 
2244 /* SCSI power on or bus device reset additional sense code */
2245 #define	SD_SCSI_RESET_SENSE_CODE	0x29
2246 
2247 /*
2248  * These defines are for the Vital Product Data Pages in the inquiry command.
2249  * They are the bits in the un_vpd_page mask, telling the supported pages.
2250  */
2251 #define	SD_VPD_SUPPORTED_PG	0x01	/* 0x00 - Supported VPD pages */
2252 #define	SD_VPD_UNIT_SERIAL_PG	0x02	/* 0x80 - Unit Serial Number */
2253 #define	SD_VPD_OPERATING_PG	0x04	/* 0x81 - Implemented Op Defs */
2254 #define	SD_VPD_ASCII_OP_PG	0x08	/* 0x82 - ASCII Op Defs */
2255 #define	SD_VPD_DEVID_WWN_PG	0x10	/* 0x83 - Device Identification */
2256 #define	SD_VPD_EXTENDED_DATA_PG	0x80	/* 0x86 - Extended data about the lun */
2257 
2258 /*
2259  * Non-volatile cache support
2260  *
2261  * Bit 1 of the byte 6 in the Extended INQUIRY data VPD page
2262  * is NV_SUP bit: An NV_SUP bit set to one indicates that
2263  * the device server supports a non-volatile cache.  An
2264  * NV_SUP bit set to zero indicates that the device
2265  * server may or may not support a non-volatile cache.
2266  *
2267  * Bit 2 of the byte 1 in the SYNC CACHE command is SYNC_NV
2268  * bit: The SYNC_NV bit specifies whether the device server
2269  * is required to synchronize volatile and non-volatile
2270  * caches.
2271  */
2272 #define	SD_VPD_NV_SUP	0x02
2273 #define	SD_SYNC_NV_BIT 0x04
2274 
2275 /*
2276  * Addition from sddef.intel.h
2277  */
2278 #if defined(__i386) || defined(__amd64)
2279 
2280 #define	P0_RAW_DISK	(NDKMAP)
2281 #define	FDISK_P1	(NDKMAP+1)
2282 #define	FDISK_P2	(NDKMAP+2)
2283 #define	FDISK_P3	(NDKMAP+3)
2284 #define	FDISK_P4	(NDKMAP+4)
2285 
2286 #endif	/* __i386 || __amd64 */
2287 
2288 #ifdef	__cplusplus
2289 }
2290 #endif
2291 
2292 
2293 #endif	/* _SYS_SCSI_TARGETS_SDDEF_H */
2294