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