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