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