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