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