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