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