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