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