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