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