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