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