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