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