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