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