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