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