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