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