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