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