1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_SCSI_TARGETS_SDDEF_H 27 #define _SYS_SCSI_TARGETS_SDDEF_H 28 29 #include <sys/dktp/fdisk.h> 30 #include <sys/note.h> 31 #include <sys/mhd.h> 32 #include <sys/cmlb.h> 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 39 #if defined(_KERNEL) || defined(_KMEMUSER) 40 41 42 #define SD_SUCCESS 0 43 #define SD_FAILURE (-1) 44 45 #if defined(TRUE) 46 #undef TRUE 47 #endif 48 49 #if defined(FALSE) 50 #undef FALSE 51 #endif 52 53 #define TRUE 1 54 #define FALSE 0 55 56 #if defined(VERBOSE) 57 #undef VERBOSE 58 #endif 59 60 #if defined(SILENT) 61 #undef SILENT 62 #endif 63 64 65 /* 66 * Fault Injection Flag for Inclusion of Code 67 * 68 * This should only be defined when SDDEBUG is defined 69 * #if DEBUG || lint 70 * #define SD_FAULT_INJECTION 71 * #endif 72 */ 73 74 #if DEBUG || lint 75 #define SD_FAULT_INJECTION 76 #endif 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 /* 97 * XXX - NSDMAP has multiple definitions, one more in cmlb_impl.h 98 * If they are coalesced into one, this definition will follow suit. 99 * FDISK partitions - 4 primary and MAX_EXT_PARTS number of Extended 100 * Partitions. 101 */ 102 #define FDISK_PARTS (FD_NUMPART + MAX_EXT_PARTS) 103 104 #define SDUNIT_SHIFT 6 105 #define SDPART_MASK 63 106 #define NSDMAP (NDKMAP + FDISK_PARTS + 1) 107 108 #else 109 #error "No VTOC format defined." 110 #endif 111 112 113 #define SDUNIT(dev) (getminor((dev)) >> SDUNIT_SHIFT) 114 #define SDPART(dev) (getminor((dev)) & SDPART_MASK) 115 116 /* 117 * maximum number of partitions the driver keeps track of; with 118 * EFI this can be larger than the number of partitions accessible 119 * through the minor nodes. It won't be used for keeping track 120 * of open counts, partition kstats, etc. 121 */ 122 #define MAXPART (NSDMAP + 1) 123 124 /* 125 * Macro to retrieve the DDI instance number from the given buf struct. 126 * The instance number is encoded in the minor device number. 127 */ 128 #define SD_GET_INSTANCE_FROM_BUF(bp) \ 129 (getminor((bp)->b_edev) >> SDUNIT_SHIFT) 130 131 132 133 struct ocinfo { 134 /* 135 * Types BLK, MNT, CHR, SWP, 136 * assumed to be types 0-3. 137 */ 138 uint64_t lyr_open[NSDMAP]; 139 uint64_t reg_open[OTYPCNT - 1]; 140 }; 141 142 #define OCSIZE sizeof (struct ocinfo) 143 144 union ocmap { 145 uchar_t chkd[OCSIZE]; 146 struct ocinfo rinfo; 147 }; 148 149 #define lyropen rinfo.lyr_open 150 #define regopen rinfo.reg_open 151 152 153 #define SD_CDB_GROUP0 0 154 #define SD_CDB_GROUP1 1 155 #define SD_CDB_GROUP5 2 156 #define SD_CDB_GROUP4 3 157 158 struct sd_cdbinfo { 159 uchar_t sc_grpcode; /* CDB group code */ 160 uchar_t sc_grpmask; /* CDB group code mask (for cmd opcode) */ 161 uint64_t sc_maxlba; /* Maximum logical block addr. supported */ 162 uint32_t sc_maxlen; /* Maximum transfer length supported */ 163 }; 164 165 166 167 /* 168 * The following declaration are for Non-512 byte block support for the 169 * removable devices. (ex - DVD RAM, MO). 170 * wm_state: This is an enumeration for the different states for 171 * manipalating write range list during the read-modify-write-operation. 172 */ 173 typedef enum { 174 SD_WM_CHK_LIST, /* Check list for overlapping writes */ 175 SD_WM_WAIT_MAP, /* Wait for an overlapping I/O to complete */ 176 SD_WM_LOCK_RANGE, /* Lock the range of lba to be written */ 177 SD_WM_DONE /* I/O complete */ 178 } wm_state; 179 180 /* 181 * sd_w_map: Every write I/O will get one w_map allocated for it which will tell 182 * the range on the media which is being written for that request. 183 */ 184 struct sd_w_map { 185 uint_t wm_start; /* Write start location */ 186 uint_t wm_end; /* Write end location */ 187 ushort_t wm_flags; /* State of the wmap */ 188 ushort_t wm_wanted_count; /* # of threads waiting for region */ 189 void *wm_private; /* Used to store bp->b_private */ 190 struct buf *wm_bufp; /* to store buf pointer */ 191 struct sd_w_map *wm_next; /* Forward pointed to sd_w_map */ 192 struct sd_w_map *wm_prev; /* Back pointer to sd_w_map */ 193 kcondvar_t wm_avail; /* Sleep on this, while not available */ 194 }; 195 196 _NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_w_map::wm_flags)) 197 198 199 /* 200 * This is the struct for the layer-private data area for the 201 * mapblocksize layer. 202 */ 203 204 struct sd_mapblocksize_info { 205 void *mbs_oprivate; /* saved value of xb_private */ 206 struct buf *mbs_orig_bp; /* ptr to original bp */ 207 struct sd_w_map *mbs_wmp; /* ptr to write-map struct for RMW */ 208 ssize_t mbs_copy_offset; 209 int mbs_layer_index; /* chain index for RMW */ 210 }; 211 212 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_mapblocksize_info)) 213 214 215 /* 216 * sd_lun: The main data structure for a scsi logical unit. 217 * Stored as the softstate structure for each device. 218 */ 219 220 struct sd_lun { 221 222 /* Back ptr to the SCSA scsi_device struct for this LUN */ 223 struct scsi_device *un_sd; 224 225 /* 226 * Support for Auto-Request sense capability 227 */ 228 struct buf *un_rqs_bp; /* ptr to request sense bp */ 229 struct scsi_pkt *un_rqs_pktp; /* ptr to request sense scsi_pkt */ 230 int un_sense_isbusy; /* Busy flag for RQS buf */ 231 232 /* 233 * These specify the layering chains to use with this instance. These 234 * are initialized according to the values in the sd_chain_index_map[] 235 * array. See the description of sd_chain_index_map[] for details. 236 */ 237 int un_buf_chain_type; 238 int un_uscsi_chain_type; 239 int un_direct_chain_type; 240 int un_priority_chain_type; 241 242 /* Head & tail ptrs to the queue of bufs awaiting transport */ 243 struct buf *un_waitq_headp; 244 struct buf *un_waitq_tailp; 245 246 /* Ptr to the buf currently being retried (NULL if none) */ 247 struct buf *un_retry_bp; 248 249 /* This tracks the last kstat update for the un_retry_bp buf */ 250 void (*un_retry_statp)(kstat_io_t *); 251 252 void *un_xbuf_attr; /* xbuf attribute struct */ 253 254 255 /* System logical block size, in bytes. (defaults to DEV_BSIZE.) */ 256 uint32_t un_sys_blocksize; 257 258 /* The size of a logical block on the target, in bytes. */ 259 uint32_t un_tgt_blocksize; 260 261 /* 262 * The number of logical blocks on the target. This is adjusted 263 * to be in terms of the block size specified by un_sys_blocksize 264 * (ie, the system block size). 265 */ 266 uint64_t un_blockcount; 267 268 /* 269 * Various configuration data 270 */ 271 uchar_t un_ctype; /* Controller type */ 272 char *un_node_type; /* minor node type */ 273 uchar_t un_interconnect_type; /* Interconnect for underlying HBA */ 274 275 uint_t un_notready_retry_count; /* Per disk notready retry count */ 276 uint_t un_busy_retry_count; /* Per disk BUSY retry count */ 277 278 uint_t un_retry_count; /* Per disk retry count */ 279 uint_t un_victim_retry_count; /* Per disk victim retry count */ 280 281 /* (4356701, 4367306) */ 282 uint_t un_reset_retry_count; /* max io retries before issuing reset */ 283 ushort_t un_reserve_release_time; /* reservation release timeout */ 284 285 uchar_t un_reservation_type; /* SCSI-3 or SCSI-2 */ 286 uint_t un_max_xfer_size; /* Maximum DMA transfer size */ 287 int un_partial_dma_supported; 288 int un_buf_breakup_supported; 289 290 int un_mincdb; /* Smallest CDB to use */ 291 int un_maxcdb; /* Largest CDB to use */ 292 int un_max_hba_cdb; /* Largest CDB supported by HBA */ 293 int un_status_len; 294 int un_pkt_flags; 295 296 /* 297 * Note: un_uscsi_timeout is a "mirror" of un_cmd_timeout, adjusted 298 * for ISCD(). Any updates to un_cmd_timeout MUST be reflected 299 * in un_uscsi_timeout as well! 300 */ 301 ushort_t un_cmd_timeout; /* Timeout for completion */ 302 ushort_t un_uscsi_timeout; /* Timeout for USCSI completion */ 303 ushort_t un_busy_timeout; /* Timeout for busy retry */ 304 305 /* 306 * Info on current states, statuses, etc. (Updated frequently) 307 */ 308 uchar_t un_state; /* current state */ 309 uchar_t un_last_state; /* last state */ 310 uchar_t un_last_pkt_reason; /* used to suppress multiple msgs */ 311 int un_tagflags; /* Pkt Flags for Tagged Queueing */ 312 short un_resvd_status; /* Reservation Status */ 313 ulong_t un_detach_count; /* !0 if executing detach routine */ 314 ulong_t un_layer_count; /* Current total # of layered opens */ 315 ulong_t un_opens_in_progress; /* Current # of threads in sdopen */ 316 317 ksema_t un_semoclose; /* serialize opens/closes */ 318 319 /* 320 * Control & status info for command throttling 321 */ 322 long un_ncmds_in_driver; /* number of cmds in driver */ 323 short un_ncmds_in_transport; /* number of cmds in transport */ 324 short un_throttle; /* max #cmds allowed in transport */ 325 short un_saved_throttle; /* saved value of un_throttle */ 326 short un_busy_throttle; /* saved un_throttle for BUSY */ 327 short un_min_throttle; /* min value of un_throttle */ 328 timeout_id_t un_reset_throttle_timeid; /* timeout(9F) handle */ 329 330 /* 331 * Multi-host (clustering) support 332 */ 333 opaque_t un_mhd_token; /* scsi watch request */ 334 timeout_id_t un_resvd_timeid; /* for resvd recover */ 335 336 /* Event callback resources (photon) */ 337 ddi_eventcookie_t un_insert_event; /* insert event */ 338 ddi_callback_id_t un_insert_cb_id; /* insert callback */ 339 ddi_eventcookie_t un_remove_event; /* remove event */ 340 ddi_callback_id_t un_remove_cb_id; /* remove callback */ 341 342 uint_t un_start_stop_cycle_page; /* Saves start/stop */ 343 /* cycle page */ 344 timeout_id_t un_dcvb_timeid; /* dlyd cv broadcast */ 345 346 /* 347 * Data structures for open counts, partition info, VTOC, 348 * stats, and other such bookkeeping info. 349 */ 350 union ocmap un_ocmap; /* open partition map */ 351 struct kstat *un_pstats[NSDMAP]; /* partition statistics */ 352 struct kstat *un_stats; /* disk statistics */ 353 kstat_t *un_errstats; /* for error statistics */ 354 uint64_t un_exclopen; /* exclusive open bitmask */ 355 ddi_devid_t un_devid; /* device id */ 356 uint_t un_vpd_page_mask; /* Supported VPD pages */ 357 358 /* 359 * Bit fields for various configuration/state/status info. 360 * Comments indicate the condition if the value of the 361 * variable is TRUE (nonzero). 362 */ 363 uint32_t 364 un_f_arq_enabled :1, /* Auto request sense is */ 365 /* currently enabled */ 366 un_f_blockcount_is_valid :1, /* The un_blockcount */ 367 /* value is currently valid */ 368 un_f_tgt_blocksize_is_valid :1, /* The un_tgt_blocksize */ 369 /* value is currently valid */ 370 un_f_allow_bus_device_reset :1, /* Driver may issue a BDR as */ 371 /* a part of error recovery. */ 372 un_f_is_fibre :1, /* The device supports fibre */ 373 /* channel */ 374 un_f_sync_cache_supported :1, /* sync cache cmd supported */ 375 /* supported */ 376 un_f_format_in_progress :1, /* The device is currently */ 377 /* executing a FORMAT cmd. */ 378 un_f_opt_queueing :1, /* Enable Command Queuing to */ 379 /* Host Adapter */ 380 un_f_opt_fab_devid :1, /* Disk has no valid/unique */ 381 /* serial number. */ 382 un_f_opt_disable_cache :1, /* Read/Write disk cache is */ 383 /* disabled. */ 384 un_f_cfg_is_atapi :1, /* This is an ATAPI device. */ 385 un_f_write_cache_enabled :1, /* device return success on */ 386 /* writes before transfer to */ 387 /* physical media complete */ 388 un_f_cfg_playmsf_bcd :1, /* Play Audio, BCD params. */ 389 un_f_cfg_readsub_bcd :1, /* READ SUBCHANNEL BCD resp. */ 390 un_f_cfg_read_toc_trk_bcd :1, /* track # is BCD */ 391 un_f_cfg_read_toc_addr_bcd :1, /* address is BCD */ 392 un_f_cfg_no_read_header :1, /* READ HEADER not supported */ 393 un_f_cfg_read_cd_xd4 :1, /* READ CD opcode is 0xd4 */ 394 un_f_mmc_cap :1, /* Device is MMC compliant */ 395 un_f_mmc_writable_media :1, /* writable media in device */ 396 un_f_dvdram_writable_device :1, /* DVDRAM device is writable */ 397 un_f_cfg_cdda :1, /* READ CDDA supported */ 398 un_f_cfg_tur_check :1, /* verify un_ncmds before tur */ 399 400 un_f_use_adaptive_throttle :1, /* enable/disable adaptive */ 401 /* throttling */ 402 un_f_pm_is_enabled :1, /* PM is enabled on this */ 403 /* instance */ 404 un_f_watcht_stopped :1, /* media watch thread flag */ 405 un_f_pkstats_enabled :1, /* Flag to determine if */ 406 /* partition kstats are */ 407 /* enabled. */ 408 un_f_disksort_disabled :1, /* Flag to disable disksort */ 409 un_f_lun_reset_enabled :1, /* Set if target supports */ 410 /* SCSI Logical Unit Reset */ 411 un_f_doorlock_supported :1, /* Device supports Doorlock */ 412 un_f_start_stop_supported :1, /* device has motor */ 413 un_f_reserved1 :1; 414 415 uint32_t 416 un_f_mboot_supported :1, /* mboot supported */ 417 un_f_is_hotpluggable :1, /* hotpluggable */ 418 un_f_has_removable_media :1, /* has removable media */ 419 un_f_non_devbsize_supported :1, /* non-512 blocksize */ 420 un_f_devid_supported :1, /* device ID supported */ 421 un_f_eject_media_supported :1, /* media can be ejected */ 422 un_f_chk_wp_open :1, /* check if write-protected */ 423 /* when being opened */ 424 un_f_descr_format_supported :1, /* support descriptor format */ 425 /* for sense data */ 426 un_f_check_start_stop :1, /* needs to check if */ 427 /* START-STOP command is */ 428 /* supported by hardware */ 429 /* before issuing it */ 430 un_f_monitor_media_state :1, /* need a watch thread to */ 431 /* monitor device state */ 432 un_f_attach_spinup :1, /* spin up once the */ 433 /* device is attached */ 434 un_f_log_sense_supported :1, /* support log sense */ 435 un_f_pm_supported :1, /* support power-management */ 436 un_f_cfg_is_lsi :1, /* Is LSI device, */ 437 /* default to NO */ 438 un_f_wcc_inprog :1, /* write cache change in */ 439 /* progress */ 440 un_f_ejecting :1, /* media is ejecting */ 441 un_f_suppress_cache_flush :1, /* supress flush on */ 442 /* write cache */ 443 un_f_sync_nv_supported :1, /* SYNC_NV */ 444 /* bit is supported */ 445 un_f_sync_cache_required :1, /* flag to check if */ 446 /* SYNC CACHE needs to be */ 447 /* sent in sdclose */ 448 un_f_devid_transport_defined :1, /* devid defined by transport */ 449 un_f_rmw_type :2, /* RMW type */ 450 un_f_power_condition_disabled :1, /* power condition disabled */ 451 /* through sd configuration */ 452 un_f_power_condition_supported :1, /* support power condition */ 453 /* field by hardware */ 454 un_f_pm_log_sense_smart :1, /* log sense support SMART */ 455 /* feature attribute */ 456 un_f_is_solid_state :1, /* has solid state media */ 457 un_f_mmc_gesn_polling :1, /* use GET EVENT STATUS */ 458 /* NOTIFICATION for polling */ 459 un_f_reserved :5; 460 461 /* Ptr to table of strings for ASC/ASCQ error message printing */ 462 struct scsi_asq_key_strings *un_additional_codes; 463 464 /* 465 * Power Management support. 466 * 467 * un_pm_mutex protects, un_pm_count, un_pm_timeid, un_pm_busy, 468 * un_pm_busy_cv, and un_pm_idle_timeid. 469 * It's not required that SD_MUTEX be acquired before acquiring 470 * un_pm_mutex, however if they must both be held 471 * then acquire SD_MUTEX first. 472 * 473 * un_pm_count is used to indicate PM state as follows: 474 * less than 0 the device is powered down, 475 * transition from 0 ==> 1, mark the device as busy via DDI 476 * transition from 1 ==> 0, mark the device as idle via DDI 477 */ 478 kmutex_t un_pm_mutex; 479 int un_pm_count; /* indicates pm state */ 480 timeout_id_t un_pm_timeid; /* timeout id for pm */ 481 uint_t un_pm_busy; 482 kcondvar_t un_pm_busy_cv; 483 short un_power_level; /* Power Level */ 484 uchar_t un_save_state; 485 kcondvar_t un_suspend_cv; /* power management */ 486 kcondvar_t un_disk_busy_cv; /* wait for IO completion */ 487 488 /* Resources used for media change callback support */ 489 kcondvar_t un_state_cv; /* Cond Var on mediastate */ 490 enum dkio_state un_mediastate; /* current media state */ 491 enum dkio_state un_specified_mediastate; /* expected state */ 492 opaque_t un_swr_token; /* scsi_watch request token */ 493 494 /* Non-512 byte block support */ 495 struct kmem_cache *un_wm_cache; /* fast alloc in non-512 write case */ 496 uint_t un_rmw_count; /* count of read-modify-writes */ 497 struct sd_w_map *un_wm; /* head of sd_w_map chain */ 498 uint64_t un_rmw_incre_count; /* count I/O */ 499 timeout_id_t un_rmw_msg_timeid; /* for RMW message control */ 500 501 /* For timeout callback to issue a START STOP UNIT command */ 502 timeout_id_t un_startstop_timeid; 503 504 /* Timeout callback handle for SD_PATH_DIRECT_PRIORITY cmd restarts */ 505 timeout_id_t un_direct_priority_timeid; 506 507 /* TRAN_FATAL_ERROR count. Cleared by TRAN_ACCEPT from scsi_transport */ 508 ulong_t un_tran_fatal_count; 509 510 timeout_id_t un_retry_timeid; 511 512 time_t un_pm_idle_time; 513 timeout_id_t un_pm_idle_timeid; 514 515 /* 516 * Count to determine if a Sonoma controller is in the process of 517 * failing over, and how many I/O's are failed with the 05/94/01 518 * sense code. 519 */ 520 uint_t un_sonoma_failure_count; 521 522 /* 523 * Support for failfast operation. 524 */ 525 struct buf *un_failfast_bp; 526 struct buf *un_failfast_headp; 527 struct buf *un_failfast_tailp; 528 uint32_t un_failfast_state; 529 /* Callback routine active counter */ 530 short un_in_callback; 531 532 kcondvar_t un_wcc_cv; /* synchronize changes to */ 533 /* un_f_write_cache_enabled */ 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 550 #endif 551 552 cmlb_handle_t un_cmlbhandle; 553 554 /* 555 * Pointer to internal struct sd_fm_internal in which 556 * will pass necessary information for FMA ereport posting. 557 */ 558 void *un_fm_private; 559 }; 560 561 #define SD_IS_VALID_LABEL(un) (cmlb_is_valid(un->un_cmlbhandle)) 562 563 /* 564 * Macros for conversions between "target" and "system" block sizes, and 565 * for conversion between block counts and byte counts. As used here, 566 * "system" block size refers to the block size used by the kernel/ 567 * filesystem (this includes the disk label). The "target" block size 568 * is the block size returned by the SCSI READ CAPACITY command. 569 * 570 * Note: These macros will round up to the next largest blocksize to accomodate 571 * the number of blocks specified. 572 */ 573 574 /* Convert a byte count to a number of target blocks */ 575 #define SD_BYTES2TGTBLOCKS(un, bytecount) \ 576 ((bytecount + (un->un_tgt_blocksize - 1))/un->un_tgt_blocksize) 577 578 /* Convert a target block count to a number of bytes */ 579 #define SD_TGTBLOCKS2BYTES(un, blockcount) \ 580 (blockcount * (un)->un_tgt_blocksize) 581 582 /* Convert a byte count to a number of system blocks */ 583 #define SD_BYTES2SYSBLOCKS(bytecount) \ 584 ((bytecount + (DEV_BSIZE - 1))/DEV_BSIZE) 585 586 /* Convert a system block count to a number of bytes */ 587 #define SD_SYSBLOCKS2BYTES(blockcount) \ 588 (blockcount * DEV_BSIZE) 589 590 /* 591 * Calculate the number of bytes needed to hold the requested number of bytes 592 * based upon the native target sector/block size 593 */ 594 #define SD_REQBYTES2TGTBYTES(un, bytecount) \ 595 (SD_BYTES2TGTBLOCKS(un, bytecount) * (un)->un_tgt_blocksize) 596 597 /* 598 * Calculate the byte offset from the beginning of the target block 599 * to the system block location. 600 */ 601 #define SD_TGTBYTEOFFSET(un, sysblk, tgtblk) \ 602 (SD_SYSBLOCKS2BYTES(sysblk) - SD_TGTBLOCKS2BYTES(un, tgtblk)) 603 604 /* 605 * Calculate the target block location from the system block location 606 */ 607 #define SD_SYS2TGTBLOCK(un, blockcnt) \ 608 (blockcnt / ((un)->un_tgt_blocksize / DEV_BSIZE)) 609 610 /* 611 * Calculate the target block location from the system block location 612 */ 613 #define SD_TGT2SYSBLOCK(un, blockcnt) \ 614 (blockcnt * ((un)->un_tgt_blocksize / DEV_BSIZE)) 615 616 /* 617 * SD_DEFAULT_MAX_XFER_SIZE is the default value to bound the max xfer 618 * for physio, for devices without tagged queuing enabled. 619 * The default for devices with tagged queuing enabled is SD_MAX_XFER_SIZE 620 */ 621 #if defined(__i386) || defined(__amd64) 622 #define SD_DEFAULT_MAX_XFER_SIZE (256 * 1024) 623 #endif 624 #define SD_MAX_XFER_SIZE (1024 * 1024) 625 626 /* 627 * Warlock annotations 628 */ 629 _NOTE(MUTEX_PROTECTS_DATA(scsi_device::sd_mutex, sd_lun)) 630 _NOTE(READ_ONLY_DATA(sd_lun::un_sd)) 631 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_reservation_type)) 632 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_mincdb)) 633 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_maxcdb)) 634 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_max_hba_cdb)) 635 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_status_len)) 636 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_f_arq_enabled)) 637 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_ctype)) 638 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_cmlbhandle)) 639 _NOTE(DATA_READABLE_WITHOUT_LOCK(sd_lun::un_fm_private)) 640 641 642 _NOTE(SCHEME_PROTECTS_DATA("safe sharing", 643 sd_lun::un_mhd_token 644 sd_lun::un_state 645 sd_lun::un_tagflags 646 sd_lun::un_f_format_in_progress 647 sd_lun::un_resvd_timeid 648 sd_lun::un_reset_throttle_timeid 649 sd_lun::un_startstop_timeid 650 sd_lun::un_dcvb_timeid 651 sd_lun::un_f_allow_bus_device_reset 652 sd_lun::un_sys_blocksize 653 sd_lun::un_tgt_blocksize 654 sd_lun::un_additional_codes)) 655 656 _NOTE(SCHEME_PROTECTS_DATA("stable data", 657 sd_lun::un_reserve_release_time 658 sd_lun::un_max_xfer_size 659 sd_lun::un_partial_dma_supported 660 sd_lun::un_buf_breakup_supported 661 sd_lun::un_f_is_fibre 662 sd_lun::un_node_type 663 sd_lun::un_buf_chain_type 664 sd_lun::un_uscsi_chain_type 665 sd_lun::un_direct_chain_type 666 sd_lun::un_priority_chain_type 667 sd_lun::un_xbuf_attr 668 sd_lun::un_cmd_timeout 669 sd_lun::un_pkt_flags)) 670 671 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", 672 block_descriptor 673 buf 674 cdrom_subchnl 675 cdrom_tocentry 676 cdrom_tochdr 677 cdrom_read 678 dk_cinfo 679 dk_devid 680 dk_label 681 dk_map 682 dk_temperature 683 mhioc_inkeys 684 mhioc_inresvs 685 mode_caching 686 mode_header 687 mode_speed 688 scsi_cdb 689 scsi_arq_status 690 scsi_extended_sense 691 scsi_inquiry 692 scsi_pkt 693 uio 694 uscsi_cmd)) 695 696 697 _NOTE(SCHEME_PROTECTS_DATA("stable data", scsi_device dk_cinfo)) 698 _NOTE(SCHEME_PROTECTS_DATA("unique per pkt", scsi_status scsi_cdb)) 699 700 _NOTE(MUTEX_PROTECTS_DATA(sd_lun::un_pm_mutex, sd_lun::un_pm_count 701 sd_lun::un_pm_timeid sd_lun::un_pm_busy sd_lun::un_pm_busy_cv 702 sd_lun::un_pm_idle_timeid)) 703 704 #ifdef SD_FAULT_INJECTION 705 _NOTE(MUTEX_PROTECTS_DATA(sd_lun::un_fi_mutex, 706 sd_lun::sd_fi_buf_len sd_lun::sd_fi_log)) 707 #endif 708 709 /* _NOTE(LOCK_ORDER(sd_lun::un_sd.sd_mutex sd_lun::un_pm_mutex)) */ 710 711 712 713 /* 714 * Referenced for frequently-accessed members of the unit structure 715 */ 716 #define SD_SCSI_DEVP(un) ((un)->un_sd) 717 #define SD_DEVINFO(un) ((un)->un_sd->sd_dev) 718 #define SD_INQUIRY(un) ((un)->un_sd->sd_inq) 719 #define SD_MUTEX(un) (&((un)->un_sd->sd_mutex)) 720 #define SD_ADDRESS(un) (&((un)->un_sd->sd_address)) 721 #define SD_GET_DEV(un) (sd_make_device(SD_DEVINFO(un))) 722 #define SD_FM_LOG(un) (((struct sd_fm_internal *)\ 723 ((un)->un_fm_private))->fm_log_level) 724 725 726 /* 727 * Values for un_ctype 728 */ 729 #define CTYPE_CDROM 0 730 #define CTYPE_MD21 1 /* Obsolete! */ 731 #define CTYPE_CCS 2 732 #define CTYPE_ROD 3 733 #define CTYPE_PXRE 4 /* Obsolete! */ 734 735 #define ISCD(un) ((un)->un_ctype == CTYPE_CDROM) 736 #define ISROD(un) ((un)->un_ctype == CTYPE_ROD) 737 #define ISPXRE(un) ((un)->un_ctype == CTYPE_PXRE) 738 739 /* 740 * This macro checks the vendor of the device to see if it is LSI. Because 741 * LSI has some devices out there that return 'Symbios' or 'SYMBIOS', we 742 * need to check for those also. 743 * 744 * This is used in some vendor specific checks. 745 */ 746 #define SD_IS_LSI(un) ((un)->un_f_cfg_is_lsi == TRUE) 747 748 /* 749 * Macros to check if the lun is a Sun T3 or a T4 750 */ 751 #define SD_IS_T3(un) \ 752 ((bcmp(SD_INQUIRY(un)->inq_vid, "SUN", 3) == 0) && \ 753 (bcmp(SD_INQUIRY(un)->inq_pid, "T3", 2) == 0)) 754 755 #define SD_IS_T4(un) \ 756 ((bcmp(SD_INQUIRY(un)->inq_vid, "SUN", 3) == 0) && \ 757 (bcmp(SD_INQUIRY(un)->inq_pid, "T4", 2) == 0)) 758 759 /* 760 * Macros for non-512 byte writes to removable devices. 761 */ 762 #define NOT_DEVBSIZE(un) \ 763 ((un)->un_tgt_blocksize != (un)->un_sys_blocksize) 764 765 /* 766 * Check that a write map, used for locking lba ranges for writes, is in 767 * the linked list. 768 */ 769 #define ONLIST(un, wmp) \ 770 (((un)->un_wm == (wmp)) || ((wmp)->wm_prev != NULL)) 771 772 /* 773 * Free a write map which is on list. Basically make sure that nobody is 774 * sleeping on it before freeing it. 775 */ 776 #define FREE_ONLIST_WMAP(un, wmp) \ 777 if (!(wmp)->wm_wanted_count) { \ 778 sd_free_inlist_wmap((un), (wmp)); \ 779 (wmp) = NULL; \ 780 } 781 782 #define CHK_N_FREEWMP(un, wmp) \ 783 if (!ONLIST((un), (wmp))) { \ 784 kmem_cache_free((un)->un_wm_cache, (wmp)); \ 785 (wmp) = NULL; \ 786 } else { \ 787 FREE_ONLIST_WMAP((un), (wmp)); \ 788 } 789 790 /* 791 * Values used to in wm_flags field of sd_w_map. 792 */ 793 #define SD_WTYPE_SIMPLE 0x001 /* Write aligned at blksize boundary */ 794 #define SD_WTYPE_RMW 0x002 /* Write requires read-modify-write */ 795 #define SD_WM_BUSY 0x100 /* write-map is busy */ 796 797 /* 798 * RMW type 799 */ 800 #define SD_RMW_TYPE_DEFAULT 0 /* do rmw with warning message */ 801 #define SD_RMW_TYPE_NO_WARNING 1 /* do rmw without warning message */ 802 #define SD_RMW_TYPE_RETURN_ERROR 2 /* rmw disabled */ 803 804 /* Device error kstats */ 805 struct sd_errstats { 806 struct kstat_named sd_softerrs; 807 struct kstat_named sd_harderrs; 808 struct kstat_named sd_transerrs; 809 struct kstat_named sd_vid; 810 struct kstat_named sd_pid; 811 struct kstat_named sd_revision; 812 struct kstat_named sd_serial; 813 struct kstat_named sd_capacity; 814 struct kstat_named sd_rq_media_err; 815 struct kstat_named sd_rq_ntrdy_err; 816 struct kstat_named sd_rq_nodev_err; 817 struct kstat_named sd_rq_recov_err; 818 struct kstat_named sd_rq_illrq_err; 819 struct kstat_named sd_rq_pfa_err; 820 }; 821 822 823 /* 824 * Structs and definitions for SCSI-3 Persistent Reservation 825 */ 826 typedef struct sd_prin_readkeys { 827 uint32_t generation; 828 uint32_t len; 829 mhioc_resv_key_t *keylist; 830 } sd_prin_readkeys_t; 831 832 typedef struct sd_readresv_desc { 833 mhioc_resv_key_t resvkey; 834 uint32_t scope_specific_addr; 835 uint8_t reserved_1; 836 #if defined(_BIT_FIELDS_LTOH) 837 uint8_t type:4, 838 scope:4; 839 #elif defined(_BIT_FIELDS_HTOL) 840 uint8_t scope:4, 841 type:4; 842 #else 843 #error One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined 844 #endif /* _BIT_FIELDS_LTOH */ 845 uint8_t reserved_2; 846 uint8_t reserved_3; 847 } sd_readresv_desc_t; 848 849 typedef struct sd_prin_readresv { 850 uint32_t generation; 851 uint32_t len; 852 sd_readresv_desc_t *readresv_desc; 853 } sd_prin_readresv_t; 854 855 typedef struct sd_prout { 856 uchar_t res_key[MHIOC_RESV_KEY_SIZE]; 857 uchar_t service_key[MHIOC_RESV_KEY_SIZE]; 858 uint32_t scope_address; 859 #if defined(_BIT_FIELDS_LTOH) 860 uchar_t aptpl:1, 861 reserved:7; 862 #elif defined(_BIT_FIELDS_HTOL) 863 uchar_t reserved:7, 864 aptpl:1; 865 #else 866 #error One of _BIT_FIELDS_LTOH or _BIT_FIELDS_HTOL must be defined 867 #endif /* _BIT_FIELDS_LTOH */ 868 uchar_t reserved_1; 869 uint16_t ext_len; 870 } sd_prout_t; 871 872 #define SD_READ_KEYS 0x00 873 #define SD_READ_RESV 0x01 874 875 #define SD_SCSI3_REGISTER 0x00 876 #define SD_SCSI3_RESERVE 0x01 877 #define SD_SCSI3_RELEASE 0x02 878 #define SD_SCSI3_PREEMPTANDABORT 0x05 879 #define SD_SCSI3_REGISTERANDIGNOREKEY 0x06 880 881 /* 882 * Note: The default init of un_reservation_type is to the value of '0' 883 * (from the ddi_softs_state_zalloc) which means it is defaulting to SCSI-3 884 * reservation type. This is ok because during attach we use a SCSI-3 885 * PRIORITY RESERVE IN command to determine the reservation type, and set 886 * un_reservation_type for all cases. 887 */ 888 #define SD_SCSI3_RESERVATION 0x0 889 #define SD_SCSI2_RESERVATION 0x1 890 #define SCSI3_RESV_DESC_LEN 16 891 892 /* 893 * Reservation Status's 894 */ 895 #define SD_RELEASE 0x0000 896 #define SD_RESERVE 0x0001 897 #define SD_TKOWN 0x0002 898 #define SD_LOST_RESERVE 0x0004 899 #define SD_FAILFAST 0x0080 900 #define SD_WANT_RESERVE 0x0100 901 #define SD_RESERVATION_CONFLICT 0x0200 902 #define SD_PRIORITY_RESERVE 0x0400 903 904 #define SD_TARGET_IS_UNRESERVED 0 905 #define SD_TARGET_IS_RESERVED 1 906 907 /* 908 * Save page in mode_select 909 */ 910 #define SD_DONTSAVE_PAGE 0 911 #define SD_SAVE_PAGE 1 912 913 /* 914 * Delay before reclaiming reservation is 6 seconds, in units of micro seconds 915 */ 916 #define SD_REINSTATE_RESV_DELAY 6000000 917 918 #define SD_MODE2_BLKSIZE 2336 /* bytes */ 919 920 /* 921 * Resource type definitions for multi host control operations. Specifically, 922 * queue and request definitions for reservation request handling between the 923 * scsi facility callback function (sd_mhd_watch_cb) and the reservation 924 * reclaim thread (sd_resv_reclaim_thread) 925 */ 926 struct sd_thr_request { 927 dev_t dev; 928 struct sd_thr_request *sd_thr_req_next; 929 }; 930 931 struct sd_resv_reclaim_request { 932 kthread_t *srq_resv_reclaim_thread; 933 struct sd_thr_request *srq_thr_req_head; 934 struct sd_thr_request *srq_thr_cur_req; 935 kcondvar_t srq_inprocess_cv; 936 kmutex_t srq_resv_reclaim_mutex; 937 kcondvar_t srq_resv_reclaim_cv; 938 }; 939 940 _NOTE(MUTEX_PROTECTS_DATA(sd_resv_reclaim_request::srq_resv_reclaim_mutex, 941 sd_resv_reclaim_request)) 942 _NOTE(SCHEME_PROTECTS_DATA("unshared data", sd_thr_request)) 943 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_prout)) 944 945 946 947 /* 948 * Driver Logging Components 949 * 950 * These components cover the functional entry points and areas of the 951 * driver. A component value is used for the entry point and utility 952 * functions used by the entry point. The common component value is used 953 * in those routines that are called from many areas of the driver. 954 * 955 * This can be done by adding the following two lines to /etc/system: 956 * set sd:sd_component_mask=0x00080000 957 * set sd:sd_level_mask=0x00000008 958 */ 959 #define SD_LOG_PROBE 0x00000001 960 #define SD_LOG_ATTACH_DETACH 0x00000002 961 #define SD_LOG_OPEN_CLOSE 0x00000004 962 #define SD_LOG_READ_WRITE 0x00000008 963 #define SD_LOG_POWER 0x00000010 964 #define SD_LOG_IOCTL 0x00000020 965 #define SD_LOG_IOCTL_MHD 0x00000040 966 #define SD_LOG_IOCTL_RMMEDIA 0x00000080 967 #define SD_LOG_IOCTL_DKIO 0x00000100 968 #define SD_LOG_IO 0x00000200 969 #define SD_LOG_IO_CORE 0x00000400 970 #define SD_LOG_IO_DISKSORT 0x00000800 971 #define SD_LOG_IO_PARTITION 0x00001000 972 #define SD_LOG_IO_RMMEDIA 0x00002000 973 #define SD_LOG_IO_CHKSUM 0x00004000 974 #define SD_LOG_IO_SDIOCTL 0x00008000 975 #define SD_LOG_IO_PM 0x00010000 976 #define SD_LOG_ERROR 0x00020000 977 #define SD_LOG_DUMP 0x00040000 978 #define SD_LOG_COMMON 0x00080000 979 #define SD_LOG_SDTEST 0x00100000 980 #define SD_LOG_IOERR 0x00200000 981 #define SD_LOG_IO_FAILFAST 0x00400000 982 983 /* Driver Logging Levels */ 984 #define SD_LOGMASK_ERROR 0x00000001 985 #define SD_LOGMASK_DUMP_MEM 0x00000002 986 #define SD_LOGMASK_INFO 0x00000004 987 #define SD_LOGMASK_TRACE 0x00000008 988 #define SD_LOGMASK_DIAG 0x00000010 989 990 /* Driver Logging Formats */ 991 #define SD_LOG_HEX 0x00000001 992 #define SD_LOG_CHAR 0x00000002 993 994 /* 995 * The following macros should be used to log driver debug information 996 * only. The output is filtered according to the component and level mask 997 * values. Non-debug information, such as driver warnings intended for 998 * the user should be logged via the scsi_log facility to ensure that 999 * they are not filtered. 1000 */ 1001 #if DEBUG || lint 1002 #define SDDEBUG 1003 1004 /* SD_ERROR is called to log driver error conditions */ 1005 #define SD_ERROR sd_log_err 1006 1007 /* SD_TRACE is called to log driver trace conditions (function entry/exit) */ 1008 #define SD_TRACE sd_log_trace 1009 1010 /* SD_INFO is called to log general purpose driver info */ 1011 #define SD_INFO sd_log_info 1012 1013 /* SD_DUMP_MEMORY is called to dump a data buffer to the log */ 1014 #define SD_DUMP_MEMORY sd_dump_memory 1015 1016 /* RESET/ABORTS testing ioctls */ 1017 #define DKIOCRESET (DKIOC|14) 1018 #define DKIOCABORT (DKIOC|15) 1019 1020 #ifdef SD_FAULT_INJECTION 1021 /* 1022 * sd_fi_pkt replicates the variables that are exposed through pkt 1023 * 1024 * sd_fi_xb replicates the variables that are exposed through xb 1025 * 1026 * sd_fi_un replicates the variables that are exposed through un 1027 * 1028 * sd_fi_arq replicates the variables that are 1029 * exposed for Auto-Reqeust-Sense 1030 * 1031 */ 1032 struct sd_fi_pkt { 1033 uint_t pkt_flags; /* flags */ 1034 uchar_t pkt_scbp; /* pointer to status block */ 1035 uchar_t pkt_cdbp; /* pointer to command block */ 1036 uint_t pkt_state; /* state of command */ 1037 uint_t pkt_statistics; /* statistics */ 1038 uchar_t pkt_reason; /* reason completion called */ 1039 }; 1040 1041 struct sd_fi_xb { 1042 daddr_t xb_blkno; 1043 ssize_t xb_dma_resid; 1044 short xb_retry_count; 1045 short xb_victim_retry_count; 1046 uchar_t xb_sense_status; 1047 uint_t xb_sense_state; 1048 ssize_t xb_sense_resid; 1049 uchar_t xb_sense_data[SENSE_LENGTH]; 1050 uchar_t es_code; 1051 uchar_t es_key; 1052 uchar_t es_add_code; 1053 uchar_t es_qual_code; 1054 }; 1055 1056 struct sd_fi_un { 1057 uchar_t inq_rmb; 1058 uchar_t un_ctype; 1059 uint_t un_notready_retry_count; 1060 uint_t un_reset_retry_count; 1061 uchar_t un_reservation_type; 1062 ushort_t un_notrdy_delay; 1063 short un_resvd_status; 1064 uint32_t 1065 un_f_arq_enabled, 1066 un_f_allow_bus_device_reset, 1067 un_f_opt_queueing; 1068 timeout_id_t un_restart_timeid; 1069 }; 1070 1071 struct sd_fi_arq { 1072 struct scsi_status sts_status; 1073 struct scsi_status sts_rqpkt_status; 1074 uchar_t sts_rqpkt_reason; 1075 uchar_t sts_rqpkt_resid; 1076 uint_t sts_rqpkt_state; 1077 uint_t sts_rqpkt_statistics; 1078 struct scsi_extended_sense sts_sensedata; 1079 }; 1080 1081 /* 1082 * Conditional set def 1083 */ 1084 #define SD_CONDSET(a, b, c, d) \ 1085 { \ 1086 a->c = ((fi_ ## b)->c); \ 1087 SD_INFO(SD_LOG_IOERR, un, \ 1088 "sd_fault_injection:" \ 1089 "setting %s to %d\n", \ 1090 d, ((fi_ ## b)->c)); \ 1091 } 1092 1093 /* SD FaultInjection ioctls */ 1094 #define SDIOC ('T'<<8) 1095 #define SDIOCSTART (SDIOC|1) 1096 #define SDIOCSTOP (SDIOC|2) 1097 #define SDIOCINSERTPKT (SDIOC|3) 1098 #define SDIOCINSERTXB (SDIOC|4) 1099 #define SDIOCINSERTUN (SDIOC|5) 1100 #define SDIOCINSERTARQ (SDIOC|6) 1101 #define SDIOCPUSH (SDIOC|7) 1102 #define SDIOCRETRIEVE (SDIOC|8) 1103 #define SDIOCRUN (SDIOC|9) 1104 #endif 1105 1106 #else 1107 1108 #undef SDDEBUG 1109 #define SD_ERROR { if (0) sd_log_err; } 1110 #define SD_TRACE { if (0) sd_log_trace; } 1111 #define SD_INFO { if (0) sd_log_info; } 1112 #define SD_DUMP_MEMORY { if (0) sd_dump_memory; } 1113 #endif 1114 1115 1116 /* 1117 * Miscellaneous macros 1118 */ 1119 1120 #define SD_USECTOHZ(x) (drv_usectohz((x)*1000000)) 1121 #define SD_GET_PKT_STATUS(pktp) ((*(pktp)->pkt_scbp) & STATUS_MASK) 1122 1123 #define SD_BIOERROR(bp, errcode) \ 1124 if ((bp)->b_resid == 0) { \ 1125 (bp)->b_resid = (bp)->b_bcount; \ 1126 } \ 1127 if ((bp)->b_error == 0) { \ 1128 bioerror(bp, errcode); \ 1129 } \ 1130 (bp)->b_flags |= B_ERROR; 1131 1132 #define SD_FILL_SCSI1_LUN_CDB(lunp, cdbp) \ 1133 if (! (lunp)->un_f_is_fibre && \ 1134 SD_INQUIRY((lunp))->inq_ansi == 0x01) { \ 1135 int _lun = ddi_prop_get_int(DDI_DEV_T_ANY, \ 1136 SD_DEVINFO((lunp)), DDI_PROP_DONTPASS, \ 1137 SCSI_ADDR_PROP_LUN, 0); \ 1138 if (_lun > 0) { \ 1139 (cdbp)->scc_lun = _lun; \ 1140 } \ 1141 } 1142 1143 #define SD_FILL_SCSI1_LUN(lunp, pktp) \ 1144 SD_FILL_SCSI1_LUN_CDB((lunp), (union scsi_cdb *)(pktp)->pkt_cdbp) 1145 1146 /* 1147 * Disk driver states 1148 */ 1149 1150 #define SD_STATE_NORMAL 0 1151 #define SD_STATE_OFFLINE 1 1152 #define SD_STATE_RWAIT 2 1153 #define SD_STATE_DUMPING 3 1154 #define SD_STATE_SUSPENDED 4 1155 #define SD_STATE_PM_CHANGING 5 1156 1157 /* 1158 * The table is to be interpreted as follows: The rows lists all the states 1159 * and each column is a state that a state in each row *can* reach. The entries 1160 * in the table list the event that cause that transition to take place. 1161 * For e.g.: To go from state RWAIT to SUSPENDED, event (d)-- which is the 1162 * invocation of DDI_SUSPEND-- has to take place. Note the same event could 1163 * cause the transition from one state to two different states. e.g., from 1164 * state SUSPENDED, when we get a DDI_RESUME, we just go back to the *last 1165 * state* whatever that might be. (NORMAL or OFFLINE). 1166 * 1167 * 1168 * State Transition Table: 1169 * 1170 * NORMAL OFFLINE RWAIT DUMPING SUSPENDED PM_SUSPENDED 1171 * 1172 * NORMAL - (a) (b) (c) (d) (h) 1173 * 1174 * OFFLINE (e) - (e) (c) (d) NP 1175 * 1176 * RWAIT (f) NP - (c) (d) (h) 1177 * 1178 * DUMPING NP NP NP - NP NP 1179 * 1180 * SUSPENDED (g) (g) (b) NP* - NP 1181 * 1182 * PM_SUSPENDED (i) NP (b) (c) (d) - 1183 * 1184 * NP : Not Possible. 1185 * (a): Disk does not respond. 1186 * (b): Packet Allocation Fails 1187 * (c): Panic - Crash dump 1188 * (d): DDI_SUSPEND is called. 1189 * (e): Disk has a successful I/O completed. 1190 * (f): sdrunout() calls sdstart() which sets it NORMAL 1191 * (g): DDI_RESUME is called. 1192 * (h): Device threshold exceeded pm framework called power 1193 * entry point or pm_lower_power called in detach. 1194 * (i): When new I/O come in. 1195 * * : When suspended, we dont change state during panic dump 1196 */ 1197 1198 1199 #define SD_MAX_THROTTLE 256 1200 #define SD_MIN_THROTTLE 8 1201 /* 1202 * Lowest valid max. and min. throttle value. 1203 * This is set to 2 because if un_min_throttle were allowed to be 1 then 1204 * un_throttle would never get set to a value less than un_min_throttle 1205 * (0 is a special case) which means it would never get set back to 1206 * un_saved_throttle in routine sd_restore_throttle(). 1207 */ 1208 #define SD_LOWEST_VALID_THROTTLE 2 1209 1210 1211 1212 /* Return codes for sd_send_polled_cmd() and sd_scsi_poll() */ 1213 #define SD_CMD_SUCCESS 0 1214 #define SD_CMD_FAILURE 1 1215 #define SD_CMD_RESERVATION_CONFLICT 2 1216 #define SD_CMD_ILLEGAL_REQUEST 3 1217 #define SD_CMD_BECOMING_READY 4 1218 #define SD_CMD_CHECK_CONDITION 5 1219 1220 /* Return codes for sd_ready_and_valid */ 1221 #define SD_READY_VALID 0 1222 #define SD_NOT_READY_VALID 1 1223 #define SD_RESERVED_BY_OTHERS 2 1224 1225 #define SD_PATH_STANDARD 0 1226 #define SD_PATH_DIRECT 1 1227 #define SD_PATH_DIRECT_PRIORITY 2 1228 1229 #define SD_UNIT_ATTENTION_RETRY 40 1230 1231 /* 1232 * The following three are bit flags passed into sd_send_scsi_TEST_UNIT_READY 1233 * to control specific behavior. 1234 */ 1235 #define SD_CHECK_FOR_MEDIA 0x01 1236 #define SD_DONT_RETRY_TUR 0x02 1237 #define SD_BYPASS_PM 0x04 1238 1239 #define SD_GROUP0_MAX_ADDRESS (0x1fffff) 1240 #define SD_GROUP0_MAXCOUNT (0xff) 1241 #define SD_GROUP1_MAX_ADDRESS (0xffffffff) 1242 #define SD_GROUP1_MAXCOUNT (0xffff) 1243 1244 #define SD_BECOMING_ACTIVE 0x01 1245 #define SD_REMOVAL_ALLOW 0 1246 #define SD_REMOVAL_PREVENT 1 1247 1248 #define SD_GET_PKT_OPCODE(pktp) \ 1249 (((union scsi_cdb *)((pktp)->pkt_cdbp))->cdb_un.cmd) 1250 1251 1252 #define SD_NO_RETRY_ISSUED 0 1253 #define SD_DELAYED_RETRY_ISSUED 1 1254 #define SD_IMMEDIATE_RETRY_ISSUED 2 1255 1256 #if defined(__i386) || defined(__amd64) 1257 #define SD_UPDATE_B_RESID(bp, pktp) \ 1258 ((bp)->b_resid += (pktp)->pkt_resid + (SD_GET_XBUF(bp)->xb_dma_resid)) 1259 #else 1260 #define SD_UPDATE_B_RESID(bp, pktp) \ 1261 ((bp)->b_resid += (pktp)->pkt_resid) 1262 #endif 1263 1264 1265 #define SD_RETRIES_MASK 0x00FF 1266 #define SD_RETRIES_NOCHECK 0x0000 1267 #define SD_RETRIES_STANDARD 0x0001 1268 #define SD_RETRIES_VICTIM 0x0002 1269 #define SD_RETRIES_BUSY 0x0003 1270 #define SD_RETRIES_UA 0x0004 1271 #define SD_RETRIES_ISOLATE 0x8000 1272 #define SD_RETRIES_FAILFAST 0x4000 1273 1274 #define SD_UPDATE_RESERVATION_STATUS(un, pktp) \ 1275 if (((pktp)->pkt_reason == CMD_RESET) || \ 1276 ((pktp)->pkt_statistics & (STAT_BUS_RESET | STAT_DEV_RESET))) { \ 1277 if (((un)->un_resvd_status & SD_RESERVE) == SD_RESERVE) { \ 1278 (un)->un_resvd_status |= \ 1279 (SD_LOST_RESERVE | SD_WANT_RESERVE); \ 1280 } \ 1281 } 1282 1283 #define SD_SENSE_DATA_IS_VALID 0 1284 #define SD_SENSE_DATA_IS_INVALID 1 1285 1286 /* 1287 * Delay (in seconds) before restoring the "throttle limit" back 1288 * to its maximum value. 1289 * 60 seconds is what we will wait for to reset the 1290 * throttle back to it SD_MAX_THROTTLE for TRAN_BUSY. 1291 * 10 seconds for STATUS_QFULL because QFULL will incrementally 1292 * increase the throttle limit until it reaches max value. 1293 */ 1294 #define SD_RESET_THROTTLE_TIMEOUT 60 1295 #define SD_QFULL_THROTTLE_TIMEOUT 10 1296 1297 #define SD_THROTTLE_TRAN_BUSY 0 1298 #define SD_THROTTLE_QFULL 1 1299 1300 #define SD_THROTTLE_RESET_INTERVAL \ 1301 (sd_reset_throttle_timeout * drv_usectohz(1000000)) 1302 1303 #define SD_QFULL_THROTTLE_RESET_INTERVAL \ 1304 (sd_qfull_throttle_timeout * drv_usectohz(1000000)) 1305 1306 1307 /* 1308 * xb_pkt_flags defines 1309 * SD_XB_DMA_FREED indicates the scsi_pkt has had its DMA resources freed 1310 * by a call to scsi_dmafree(9F). The resources must be reallocated before 1311 * before a call to scsi_transport can be made again. 1312 * SD_XB_USCSICMD indicates the scsi request is a uscsi request 1313 * SD_XB_INITPKT_MASK: since this field is also used to store flags for 1314 * a scsi_init_pkt(9F) call, we need a mask to make sure that we don't 1315 * pass any unintended bits to scsi_init_pkt(9F) (ugly hack). 1316 */ 1317 #define SD_XB_DMA_FREED 0x20000000 1318 #define SD_XB_USCSICMD 0x40000000 1319 #define SD_XB_INITPKT_MASK (PKT_CONSISTENT | PKT_DMA_PARTIAL) 1320 1321 /* 1322 * Extension for the buf(9s) struct that we receive from a higher 1323 * layer. Located by b_private in the buf(9S). (The previous contents 1324 * of b_private are saved & restored before calling biodone(9F).) 1325 */ 1326 struct sd_xbuf { 1327 1328 struct sd_lun *xb_un; /* Ptr to associated sd_lun */ 1329 struct scsi_pkt *xb_pktp; /* Ptr to associated scsi_pkt */ 1330 1331 /* 1332 * xb_pktinfo points to any optional data that may be needed 1333 * by the initpkt and/or destroypkt functions. Typical 1334 * use might be to point to a struct uscsi_cmd. 1335 */ 1336 void *xb_pktinfo; 1337 1338 /* 1339 * Layer-private data area. This may be used by any layer to store 1340 * layer-specific data on a per-IO basis. Typical usage is for an 1341 * iostart routine to save some info here for later use by its 1342 * partner iodone routine. This area may be used to hold data or 1343 * a pointer to a data block that is allocated/freed by the layer's 1344 * iostart/iodone routines. Allocation & management policy for the 1345 * layer-private area is defined & implemented by each specific 1346 * layer as required. 1347 * 1348 * IMPORTANT: Since a higher layer may depend on the value in the 1349 * xb_private field, each layer must ensure that it returns the 1350 * buf/xbuf to the next higher layer (via SD_NEXT_IODONE()) with 1351 * the SAME VALUE in xb_private as when the buf/xbuf was first 1352 * received by the layer's iostart routine. Typically this is done 1353 * by the iostart routine saving the contents of xb_private into 1354 * a place in the layer-private data area, and the iodone routine 1355 * restoring the value of xb_private before deallocating the 1356 * layer-private data block and calling SD_NEXT_IODONE(). Of course, 1357 * if a layer never modifies xb_private in a buf/xbuf from a higher 1358 * layer, there will be no need to restore the value. 1359 * 1360 * Note that in the case where a layer _creates_ a buf/xbuf (such as 1361 * by calling sd_shadow_buf_alloc()) to pass to a lower layer, it is 1362 * not necessary to preserve the contents of xb_private as there is 1363 * no higher layer dependency on the value of xb_private. Such a 1364 * buf/xbuf must be deallocated by the layer that allocated it and 1365 * must *NEVER* be passed up to a higher layer. 1366 */ 1367 void *xb_private; /* Layer-private data block */ 1368 1369 /* 1370 * We do not use the b_blkno provided in the buf(9S), as we need to 1371 * make adjustments to it in the driver, but it is not a field that 1372 * the driver owns or is free to modify. 1373 */ 1374 daddr_t xb_blkno; /* Absolute block # on target */ 1375 uint64_t xb_ena; /* ena for a specific SCSI command */ 1376 1377 int xb_chain_iostart; /* iostart side index */ 1378 int xb_chain_iodone; /* iodone side index */ 1379 int xb_pkt_flags; /* Flags for scsi_init_pkt() */ 1380 ssize_t xb_dma_resid; 1381 short xb_retry_count; 1382 short xb_victim_retry_count; 1383 short xb_ua_retry_count; /* unit_attention retry counter */ 1384 short xb_nr_retry_count; /* not ready retry counter */ 1385 1386 /* 1387 * Various status and data used when a RQS command is run on 1388 * the behalf of this command. 1389 */ 1390 struct buf *xb_sense_bp; /* back ptr to buf, for RQS */ 1391 uint_t xb_sense_state; /* scsi_pkt state of RQS command */ 1392 ssize_t xb_sense_resid; /* residual of RQS command */ 1393 uchar_t xb_sense_status; /* scsi status byte of RQS command */ 1394 uchar_t xb_sense_data[SENSE_LENGTH]; /* sense data from RQS cmd */ 1395 /* 1396 * Extra sense larger than SENSE_LENGTH will be allocated 1397 * right after xb_sense_data[SENSE_LENGTH]. Please do not 1398 * add any new field after it. 1399 */ 1400 }; 1401 1402 _NOTE(SCHEME_PROTECTS_DATA("unique per pkt", sd_xbuf)) 1403 1404 #define SD_PKT_ALLOC_SUCCESS 0 1405 #define SD_PKT_ALLOC_FAILURE 1 1406 #define SD_PKT_ALLOC_FAILURE_NO_DMA 2 1407 #define SD_PKT_ALLOC_FAILURE_PKT_TOO_SMALL 3 1408 #define SD_PKT_ALLOC_FAILURE_CDB_TOO_SMALL 4 1409 1410 #define SD_GET_XBUF(bp) ((struct sd_xbuf *)((bp)->b_private)) 1411 #define SD_GET_UN(bp) ((SD_GET_XBUF(bp))->xb_un) 1412 #define SD_GET_PKTP(bp) ((SD_GET_XBUF(bp))->xb_pktp) 1413 #define SD_GET_BLKNO(bp) ((SD_GET_XBUF(bp))->xb_blkno) 1414 1415 /* 1416 * Special-purpose struct for sd_send_scsi_cmd() to pass command-specific 1417 * data through the layering chains to sd_initpkt_for_uscsi(). 1418 */ 1419 struct sd_uscsi_info { 1420 int ui_flags; 1421 struct uscsi_cmd *ui_cmdp; 1422 /* 1423 * ui_dkc is used by sd_send_scsi_SYNCHRONIZE_CACHE() to allow 1424 * for async completion notification. 1425 */ 1426 struct dk_callback ui_dkc; 1427 /* 1428 * The following fields are to be used for FMA ereport generation. 1429 */ 1430 uchar_t ui_pkt_reason; 1431 uint32_t ui_pkt_state; 1432 uint32_t ui_pkt_statistics; 1433 uint64_t ui_lba; 1434 uint64_t ui_ena; 1435 }; 1436 1437 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_uscsi_info)) 1438 1439 /* 1440 * This structure is used to issue 'internal' command sequences from the 1441 * driver's attach(9E)/open(9E)/etc entry points. It provides a common context 1442 * for issuing command sequences, with the ability to issue a command 1443 * and provide expected/unexpected assessment of results at any code 1444 * level within the sd_ssc_t scope and preserve the information needed 1445 * produce telemetry for the problem, when needed, from a single 1446 * outer-most-scope point. 1447 * 1448 * The sd_ssc_t abstraction should result in well-structured code where 1449 * the basic code structure is not jeprodized by future localized improvement. 1450 * 1451 * o Scope for a sequence of commands. 1452 * o Within a scoped sequence of commands, provides a single top-level 1453 * location for initiating telementry generation from captured data. 1454 * o Provide a common place to capture command execution data and driver 1455 * assessment information for delivery to telemetry generation point. 1456 * o Mechanism to get device-as-detector (dad) and transport telemetry 1457 * information from interrupt context (sdintr) back to the internal 1458 * command 'driver-assessment' code. 1459 * o Ability to record assessment, and return information back to 1460 * top-level telemetry generation code when an unexpected condition 1461 * occurs. 1462 * o For code paths were an command itself was successful but 1463 * the data returned looks suspect, the ability to record 1464 * 'unexpected data' conditions. 1465 * o Record assessment of issuing the command and interpreting 1466 * the returned data for consumption by top-level ereport telemetry 1467 * generation code. 1468 * o All data required to produce telemetry available off single data 1469 * structure. 1470 */ 1471 typedef struct { 1472 struct sd_lun *ssc_un; 1473 struct uscsi_cmd *ssc_uscsi_cmd; 1474 struct sd_uscsi_info *ssc_uscsi_info; 1475 int ssc_flags; /* Bits for flags */ 1476 char ssc_info[1024]; /* Buffer holding for info */ 1477 } sd_ssc_t; 1478 1479 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", sd_ssc_t)) 1480 1481 /* 1482 * This struct switch different 'type-of-assessment' 1483 * as an input argument for sd_ssc_assessment 1484 * 1485 * 1486 * in sd_send_scsi_XXX or upper-level 1487 * 1488 * - SD_FMT_IGNORE 1489 * when send uscsi command failed, and 1490 * the following code check sense data properly. 1491 * we use 'ignore' to let sd_ssc_assessment 1492 * trust current and do not do additional 1493 * checking for the uscsi command. 1494 * 1495 * - SD_FMT_IGNORE_COMPROMISE 1496 * when send uscsi command failed, and 1497 * the code does not check sense data or we don't 1498 * think the checking is 100% coverage. We mark it 1499 * as 'compromise' to indicate that we need to 1500 * enhance current code in the future. 1501 * 1502 * - SD_FMT_STATUS_CHECK 1503 * when send uscsi command failed and cause sd entries 1504 * failed finally, we need to send out real reason against 1505 * status of uscsi command no matter if there is sense back 1506 * or not. 1507 * 1508 * - SD_FMT_STANDARD 1509 * when send uscsi command succeeded, and 1510 * the code does not check sense data, we need to check 1511 * it to make sure there is no 'fault'. 1512 */ 1513 enum sd_type_assessment { 1514 SD_FMT_IGNORE = 0, 1515 SD_FMT_IGNORE_COMPROMISE, 1516 SD_FMT_STATUS_CHECK, 1517 SD_FMT_STANDARD 1518 }; 1519 1520 /* 1521 * The following declaration are used as hints of severities when posting 1522 * SCSI FMA ereport. 1523 * - SD_FM_DRV_FATAL 1524 * When posting ereport with SD_FM_DRV_FATAL, the payload 1525 * "driver-assessment" will be "fail" or "fatal" depending on the 1526 * sense-key value. If driver-assessment is "fail", it will be 1527 * propagated to an upset, otherwise, a fault will be propagated. 1528 * - SD_FM_DRV_RETRY 1529 * When posting ereport with SD_FM_DRV_RETRY, the payload 1530 * "driver-assessment" will be "retry", and it will be propagated to an 1531 * upset. 1532 * - SD_FM_DRV_RECOVERY 1533 * When posting ereport with SD_FM_DRV_RECOVERY, the payload 1534 * "driver-assessment" will be "recovered", and it will be propagated to 1535 * an upset. 1536 * - SD_FM_DRV_NOTICE 1537 * When posting ereport with SD_FM_DRV_NOTICE, the payload 1538 * "driver-assessment" will be "info", and it will be propagated to an 1539 * upset. 1540 */ 1541 enum sd_driver_assessment { 1542 SD_FM_DRV_FATAL = 0, 1543 SD_FM_DRV_RETRY, 1544 SD_FM_DRV_RECOVERY, 1545 SD_FM_DRV_NOTICE 1546 }; 1547 1548 /* 1549 * The following structure is used as a buffer when posting SCSI FMA 1550 * ereport for raw i/o. It will be allocated per sd_lun when entering 1551 * sd_unit_attach and will be deallocated when entering sd_unit_detach. 1552 */ 1553 struct sd_fm_internal { 1554 sd_ssc_t fm_ssc; 1555 struct uscsi_cmd fm_ucmd; 1556 struct sd_uscsi_info fm_uinfo; 1557 int fm_log_level; 1558 }; 1559 1560 /* 1561 * Bits in ssc_flags 1562 * sd_ssc_init will mark ssc_flags = SSC_FLAGS_UNKNOWN 1563 * sd_ssc_send will mark ssc_flags = SSC_FLAGS_CMD_ISSUED & 1564 * SSC_FLAGS_NEED_ASSESSMENT 1565 * sd_ssc_assessment will clear SSC_FLAGS_CMD_ISSUED and 1566 * SSC_FLAGS_NEED_ASSESSMENT bits of ssc_flags. 1567 * SSC_FLAGS_CMD_ISSUED is to indicate whether the SCSI command has been 1568 * sent out. 1569 * SSC_FLAGS_NEED_ASSESSMENT is to guarantee we will not miss any 1570 * assessment point. 1571 */ 1572 #define SSC_FLAGS_UNKNOWN 0x00000000 1573 #define SSC_FLAGS_CMD_ISSUED 0x00000001 1574 #define SSC_FLAGS_NEED_ASSESSMENT 0x00000002 1575 #define SSC_FLAGS_TRAN_ABORT 0x00000004 1576 1577 /* 1578 * The following bits in ssc_flags are for detecting unexpected data. 1579 */ 1580 #define SSC_FLAGS_INVALID_PKT_REASON 0x00000010 1581 #define SSC_FLAGS_INVALID_STATUS 0x00000020 1582 #define SSC_FLAGS_INVALID_SENSE 0x00000040 1583 #define SSC_FLAGS_INVALID_DATA 0x00000080 1584 1585 /* 1586 * The following are the values available for sd_fm_internal::fm_log_level. 1587 * SD_FM_LOG_NSUP The driver will log things in traditional way as if 1588 * the SCSI FMA feature is unavailable. 1589 * SD_FM_LOG_SILENT The driver will not print out syslog for FMA error 1590 * telemetry, all the error telemetries will go into 1591 * FMA error log. 1592 * SD_FM_LOG_EREPORT The driver will both print the FMA error telemetry 1593 * and post the error report, but the traditional 1594 * syslog for error telemetry will be suppressed. 1595 */ 1596 #define SD_FM_LOG_NSUP 0 1597 #define SD_FM_LOG_SILENT 1 1598 #define SD_FM_LOG_EREPORT 2 1599 1600 /* 1601 * Macros and definitions for driver kstats and errstats 1602 * 1603 * Some third-party layered drivers (they know who they are) do not maintain 1604 * their open/close counts correctly which causes our kstat reporting to get 1605 * messed up & results in panics. These macros will update the driver kstats 1606 * only if the counts are valid. 1607 */ 1608 #define SD_UPDATE_COMMON_KSTATS(kstat_function, kstatp) \ 1609 if ((kstat_function) == kstat_runq_exit || \ 1610 ((kstat_function) == kstat_runq_back_to_waitq)) { \ 1611 if (((kstat_io_t *)(kstatp))->rcnt) { \ 1612 kstat_function((kstatp)); \ 1613 } else { \ 1614 cmn_err(CE_WARN, \ 1615 "kstat rcnt == 0 when exiting runq, please check\n"); \ 1616 } \ 1617 } else if ((kstat_function) == kstat_waitq_exit || \ 1618 ((kstat_function) == kstat_waitq_to_runq)) { \ 1619 if (((kstat_io_t *)(kstatp))->wcnt) { \ 1620 kstat_function(kstatp); \ 1621 } else { \ 1622 cmn_err(CE_WARN, \ 1623 "kstat wcnt == 0 when exiting waitq, please check\n"); \ 1624 } \ 1625 } else { \ 1626 kstat_function(kstatp); \ 1627 } 1628 1629 #define SD_UPDATE_KSTATS(un, kstat_function, bp) \ 1630 ASSERT(SD_GET_XBUF(bp) != NULL); \ 1631 if (SD_IS_BUFIO(SD_GET_XBUF(bp))) { \ 1632 struct kstat *pksp = \ 1633 (un)->un_pstats[SDPART((bp)->b_edev)]; \ 1634 ASSERT(mutex_owned(SD_MUTEX(un))); \ 1635 if ((un)->un_stats != NULL) { \ 1636 kstat_io_t *kip = KSTAT_IO_PTR((un)->un_stats); \ 1637 SD_UPDATE_COMMON_KSTATS(kstat_function, kip); \ 1638 } \ 1639 if (pksp != NULL) { \ 1640 kstat_io_t *kip = KSTAT_IO_PTR(pksp); \ 1641 SD_UPDATE_COMMON_KSTATS(kstat_function, kip); \ 1642 } \ 1643 } 1644 1645 #define SD_UPDATE_ERRSTATS(un, x) \ 1646 if ((un)->un_errstats != NULL) { \ 1647 struct sd_errstats *stp; \ 1648 ASSERT(mutex_owned(SD_MUTEX(un))); \ 1649 stp = (struct sd_errstats *)(un)->un_errstats->ks_data; \ 1650 stp->x.value.ui32++; \ 1651 } 1652 1653 #define SD_UPDATE_RDWR_STATS(un, bp) \ 1654 if ((un)->un_stats != NULL) { \ 1655 kstat_io_t *kip = KSTAT_IO_PTR((un)->un_stats); \ 1656 size_t n_done = (bp)->b_bcount - (bp)->b_resid; \ 1657 if ((bp)->b_flags & B_READ) { \ 1658 kip->reads++; \ 1659 kip->nread += n_done; \ 1660 } else { \ 1661 kip->writes++; \ 1662 kip->nwritten += n_done; \ 1663 } \ 1664 } 1665 1666 #define SD_UPDATE_PARTITION_STATS(un, bp) \ 1667 { \ 1668 struct kstat *pksp = (un)->un_pstats[SDPART((bp)->b_edev)]; \ 1669 if (pksp != NULL) { \ 1670 kstat_io_t *kip = KSTAT_IO_PTR(pksp); \ 1671 size_t n_done = (bp)->b_bcount - (bp)->b_resid; \ 1672 if ((bp)->b_flags & B_READ) { \ 1673 kip->reads++; \ 1674 kip->nread += n_done; \ 1675 } else { \ 1676 kip->writes++; \ 1677 kip->nwritten += n_done; \ 1678 } \ 1679 } \ 1680 } 1681 1682 1683 #endif /* defined(_KERNEL) || defined(_KMEMUSER) */ 1684 1685 1686 /* 1687 * 60 seconds is a *very* reasonable amount of time for most slow CD 1688 * operations. 1689 */ 1690 #define SD_IO_TIME 60 1691 1692 /* 1693 * 2 hours is an excessively reasonable amount of time for format operations. 1694 */ 1695 #define SD_FMT_TIME (120 * 60) 1696 1697 /* 1698 * 5 seconds is what we'll wait if we get a Busy Status back 1699 */ 1700 #define SD_BSY_TIMEOUT (drv_usectohz(5 * 1000000)) 1701 1702 /* 1703 * 100 msec. is what we'll wait if we get Unit Attention. 1704 */ 1705 #define SD_UA_RETRY_DELAY (drv_usectohz((clock_t)100000)) 1706 1707 /* 1708 * 100 msec. is what we'll wait for restarted commands. 1709 */ 1710 #define SD_RESTART_TIMEOUT (drv_usectohz((clock_t)100000)) 1711 1712 /* 1713 * 10s misaligned I/O warning message interval 1714 */ 1715 #define SD_RMW_MSG_PRINT_TIMEOUT (drv_usectohz((clock_t)10000000)) 1716 1717 /* 1718 * 100 msec. is what we'll wait for certain retries for fibre channel 1719 * targets, 0 msec for parallel SCSI. 1720 */ 1721 #if defined(__fibre) 1722 #define SD_RETRY_DELAY (drv_usectohz(100000)) 1723 #else 1724 #define SD_RETRY_DELAY ((clock_t)0) 1725 #endif 1726 1727 /* 1728 * 60 seconds is what we will wait for to reset the 1729 * throttle back to it SD_MAX_THROTTLE. 1730 */ 1731 #define SD_RESET_THROTTLE_TIMEOUT 60 1732 1733 /* 1734 * Number of times we'll retry a normal operation. 1735 * 1736 * This includes retries due to transport failure 1737 * (need to distinguish between Target and Transport failure) 1738 * 1739 */ 1740 #if defined(__fibre) 1741 #define SD_RETRY_COUNT 3 1742 #else 1743 #define SD_RETRY_COUNT 5 1744 #endif 1745 1746 /* 1747 * Number of times we will retry for unit attention. 1748 */ 1749 #define SD_UA_RETRY_COUNT 600 1750 1751 #define SD_VICTIM_RETRY_COUNT(un) (un->un_victim_retry_count) 1752 #define CD_NOT_READY_RETRY_COUNT(un) (un->un_retry_count * 2) 1753 #define DISK_NOT_READY_RETRY_COUNT(un) (un->un_retry_count / 2) 1754 1755 1756 /* 1757 * Maximum number of units we can support 1758 * (controlled by room in minor device byte) 1759 * 1760 * Note: this value is out of date. 1761 */ 1762 #define SD_MAXUNIT 32 1763 1764 /* 1765 * 30 seconds is what we will wait for the IO to finish 1766 * before we fail the DDI_SUSPEND 1767 */ 1768 #define SD_WAIT_CMDS_COMPLETE 30 1769 1770 /* 1771 * Prevent/allow media removal flags 1772 */ 1773 #define SD_REMOVAL_ALLOW 0 1774 #define SD_REMOVAL_PREVENT 1 1775 1776 1777 /* 1778 * Drive Types (and characteristics) 1779 */ 1780 #define VIDMAX 8 1781 #define PIDMAX 16 1782 1783 1784 /* 1785 * The following #defines and type definitions for the property 1786 * processing component of the sd driver. 1787 */ 1788 1789 1790 /* Miscellaneous Definitions */ 1791 #define SD_CONF_VERSION_1 1 1792 #define SD_CONF_NOT_USED 32 1793 1794 /* 1795 * "pm-capable" property values and macros 1796 */ 1797 #define SD_PM_CAPABLE_UNDEFINED -1 1798 1799 #define SD_PM_CAPABLE_IS_UNDEFINED(pm_cap) \ 1800 (pm_cap == SD_PM_CAPABLE_UNDEFINED) 1801 1802 #define SD_PM_CAPABLE_IS_FALSE(pm_cap) \ 1803 ((pm_cap & PM_CAPABLE_PM_MASK) == 0) 1804 1805 #define SD_PM_CAPABLE_IS_TRUE(pm_cap) \ 1806 (!SD_PM_CAPABLE_IS_UNDEFINED(pm_cap) && \ 1807 ((pm_cap & PM_CAPABLE_PM_MASK) > 0)) 1808 1809 #define SD_PM_CAPABLE_IS_SPC_4(pm_cap) \ 1810 ((pm_cap & PM_CAPABLE_PM_MASK) == PM_CAPABLE_SPC4) 1811 1812 #define SD_PM_CAP_LOG_SUPPORTED(pm_cap) \ 1813 ((pm_cap & PM_CAPABLE_LOG_SUPPORTED) ? TRUE : FALSE) 1814 1815 #define SD_PM_CAP_SMART_LOG(pm_cap) \ 1816 ((pm_cap & PM_CAPABLE_SMART_LOG) ? TRUE : FALSE) 1817 1818 /* 1819 * Property data values used in static configuration table 1820 * These are all based on device characteristics. 1821 * For fibre channel devices, the throttle value is usually 1822 * derived from the devices cmd Q depth divided by the number 1823 * of supported initiators. 1824 */ 1825 #define ELITE_THROTTLE_VALUE 10 1826 #define SEAGATE_THROTTLE_VALUE 15 1827 #define IBM_THROTTLE_VALUE 15 1828 #define ST31200N_THROTTLE_VALUE 8 1829 #define FUJITSU_THROTTLE_VALUE 15 1830 #define SYMBIOS_THROTTLE_VALUE 16 1831 #define SYMBIOS_NOTREADY_RETRIES 24 1832 #define LSI_THROTTLE_VALUE 16 1833 #define LSI_NOTREADY_RETRIES 24 1834 #define LSI_OEM_NOTREADY_RETRIES 36 1835 #define PURPLE_THROTTLE_VALUE 64 1836 #define PURPLE_BUSY_RETRIES 60 1837 #define PURPLE_RESET_RETRY_COUNT 36 1838 #define PURPLE_RESERVE_RELEASE_TIME 60 1839 #define SVE_BUSY_RETRIES 60 1840 #define SVE_RESET_RETRY_COUNT 36 1841 #define SVE_RESERVE_RELEASE_TIME 60 1842 #define SVE_THROTTLE_VALUE 10 1843 #define SVE_MIN_THROTTLE_VALUE 2 1844 #define SVE_DISKSORT_DISABLED_FLAG 1 1845 #define MASERATI_DISKSORT_DISABLED_FLAG 1 1846 #define MASERATI_LUN_RESET_ENABLED_FLAG 1 1847 #define PIRUS_THROTTLE_VALUE 64 1848 #define PIRUS_NRR_COUNT 60 1849 #define PIRUS_BUSY_RETRIES 60 1850 #define PIRUS_RESET_RETRY_COUNT 36 1851 #define PIRUS_MIN_THROTTLE_VALUE 16 1852 #define PIRUS_DISKSORT_DISABLED_FLAG 0 1853 #define PIRUS_LUN_RESET_ENABLED_FLAG 1 1854 1855 /* 1856 * Driver Property Bit Flag definitions 1857 * 1858 * Unfortunately, for historical reasons, the bit-flag definitions are 1859 * different on SPARC, INTEL, & FIBRE platforms. 1860 */ 1861 1862 /* 1863 * Bit flag telling driver to set throttle from sd.conf sd-config-list 1864 * and driver table. 1865 * 1866 * The max throttle (q-depth) property implementation is for support of 1867 * fibre channel devices that can drop an i/o request when a queue fills 1868 * up. The number of commands sent to the disk from this driver is 1869 * regulated such that queue overflows are avoided. 1870 */ 1871 #define SD_CONF_SET_THROTTLE 0 1872 #define SD_CONF_BSET_THROTTLE (1 << SD_CONF_SET_THROTTLE) 1873 1874 /* 1875 * Bit flag telling driver to set the controller type from sd.conf 1876 * sd-config-list and driver table. 1877 */ 1878 #if defined(__i386) || defined(__amd64) 1879 #define SD_CONF_SET_CTYPE 1 1880 #elif defined(__fibre) 1881 #define SD_CONF_SET_CTYPE 5 1882 #else 1883 #define SD_CONF_SET_CTYPE 1 1884 #endif 1885 #define SD_CONF_BSET_CTYPE (1 << SD_CONF_SET_CTYPE) 1886 1887 /* 1888 * Bit flag telling driver to set the not ready retry count for a device from 1889 * sd.conf sd-config-list and driver table. 1890 */ 1891 #if defined(__i386) || defined(__amd64) 1892 #define SD_CONF_SET_NOTREADY_RETRIES 10 1893 #elif defined(__fibre) 1894 #define SD_CONF_SET_NOTREADY_RETRIES 1 1895 #else 1896 #define SD_CONF_SET_NOTREADY_RETRIES 2 1897 #endif 1898 #define SD_CONF_BSET_NRR_COUNT (1 << SD_CONF_SET_NOTREADY_RETRIES) 1899 1900 /* 1901 * Bit flag telling driver to set SCSI status BUSY Retries from sd.conf 1902 * sd-config-list and driver table. 1903 */ 1904 #if defined(__i386) || defined(__amd64) 1905 #define SD_CONF_SET_BUSY_RETRIES 11 1906 #elif defined(__fibre) 1907 #define SD_CONF_SET_BUSY_RETRIES 2 1908 #else 1909 #define SD_CONF_SET_BUSY_RETRIES 5 1910 #endif 1911 #define SD_CONF_BSET_BSY_RETRY_COUNT (1 << SD_CONF_SET_BUSY_RETRIES) 1912 1913 /* 1914 * Bit flag telling driver that device does not have a valid/unique serial 1915 * number. 1916 */ 1917 #if defined(__i386) || defined(__amd64) 1918 #define SD_CONF_SET_FAB_DEVID 2 1919 #else 1920 #define SD_CONF_SET_FAB_DEVID 3 1921 #endif 1922 #define SD_CONF_BSET_FAB_DEVID (1 << SD_CONF_SET_FAB_DEVID) 1923 1924 /* 1925 * Bit flag telling driver to disable all caching for disk device. 1926 */ 1927 #if defined(__i386) || defined(__amd64) 1928 #define SD_CONF_SET_NOCACHE 3 1929 #else 1930 #define SD_CONF_SET_NOCACHE 4 1931 #endif 1932 #define SD_CONF_BSET_NOCACHE (1 << SD_CONF_SET_NOCACHE) 1933 1934 /* 1935 * Bit flag telling driver that the PLAY AUDIO command requires parms in BCD 1936 * format rather than binary. 1937 */ 1938 #if defined(__i386) || defined(__amd64) 1939 #define SD_CONF_SET_PLAYMSF_BCD 4 1940 #else 1941 #define SD_CONF_SET_PLAYMSF_BCD 6 1942 #endif 1943 #define SD_CONF_BSET_PLAYMSF_BCD (1 << SD_CONF_SET_PLAYMSF_BCD) 1944 1945 /* 1946 * Bit flag telling driver that the response from the READ SUBCHANNEL command 1947 * has BCD fields rather than binary. 1948 */ 1949 #if defined(__i386) || defined(__amd64) 1950 #define SD_CONF_SET_READSUB_BCD 5 1951 #else 1952 #define SD_CONF_SET_READSUB_BCD 7 1953 #endif 1954 #define SD_CONF_BSET_READSUB_BCD (1 << SD_CONF_SET_READSUB_BCD) 1955 1956 /* 1957 * Bit in flags telling driver that the track number fields in the READ TOC 1958 * request and respone are in BCD rather than binary. 1959 */ 1960 #if defined(__i386) || defined(__amd64) 1961 #define SD_CONF_SET_READ_TOC_TRK_BCD 6 1962 #else 1963 #define SD_CONF_SET_READ_TOC_TRK_BCD 8 1964 #endif 1965 #define SD_CONF_BSET_READ_TOC_TRK_BCD (1 << SD_CONF_SET_READ_TOC_TRK_BCD) 1966 1967 /* 1968 * Bit flag telling driver that the address fields in the READ TOC request and 1969 * respone are in BCD rather than binary. 1970 */ 1971 #if defined(__i386) || defined(__amd64) 1972 #define SD_CONF_SET_READ_TOC_ADDR_BCD 7 1973 #else 1974 #define SD_CONF_SET_READ_TOC_ADDR_BCD 9 1975 #endif 1976 #define SD_CONF_BSET_READ_TOC_ADDR_BCD (1 << SD_CONF_SET_READ_TOC_ADDR_BCD) 1977 1978 /* 1979 * Bit flag telling the driver that the device doesn't support the READ HEADER 1980 * command. 1981 */ 1982 #if defined(__i386) || defined(__amd64) 1983 #define SD_CONF_SET_NO_READ_HEADER 8 1984 #else 1985 #define SD_CONF_SET_NO_READ_HEADER 10 1986 #endif 1987 #define SD_CONF_BSET_NO_READ_HEADER (1 << SD_CONF_SET_NO_READ_HEADER) 1988 1989 /* 1990 * Bit flag telling the driver that for the READ CD command the device uses 1991 * opcode 0xd4 rather than 0xbe. 1992 */ 1993 #if defined(__i386) || defined(__amd64) 1994 #define SD_CONF_SET_READ_CD_XD4 9 1995 #else 1996 #define SD_CONF_SET_READ_CD_XD4 11 1997 #endif 1998 #define SD_CONF_BSET_READ_CD_XD4 (1 << SD_CONF_SET_READ_CD_XD4) 1999 2000 /* 2001 * Bit flag telling the driver to set SCSI status Reset Retries 2002 * (un_reset_retry_count) from sd.conf sd-config-list and driver table (4356701) 2003 */ 2004 #define SD_CONF_SET_RST_RETRIES 12 2005 #define SD_CONF_BSET_RST_RETRIES (1 << SD_CONF_SET_RST_RETRIES) 2006 2007 /* 2008 * Bit flag telling the driver to set the reservation release timeout value 2009 * from sd.conf sd-config-list and driver table. (4367306) 2010 */ 2011 #define SD_CONF_SET_RSV_REL_TIME 13 2012 #define SD_CONF_BSET_RSV_REL_TIME (1 << SD_CONF_SET_RSV_REL_TIME) 2013 2014 /* 2015 * Bit flag telling the driver to verify that no commands are pending for a 2016 * device before issuing a Test Unit Ready. This is a fw workaround for Seagate 2017 * eliteI drives. (4392016) 2018 */ 2019 #define SD_CONF_SET_TUR_CHECK 14 2020 #define SD_CONF_BSET_TUR_CHECK (1 << SD_CONF_SET_TUR_CHECK) 2021 2022 /* 2023 * Bit in flags telling driver to set min. throttle from ssd.conf 2024 * ssd-config-list and driver table. 2025 */ 2026 #define SD_CONF_SET_MIN_THROTTLE 15 2027 #define SD_CONF_BSET_MIN_THROTTLE (1 << SD_CONF_SET_MIN_THROTTLE) 2028 2029 /* 2030 * Bit in flags telling driver to set disksort disable flag from ssd.conf 2031 * ssd-config-list and driver table. 2032 */ 2033 #define SD_CONF_SET_DISKSORT_DISABLED 16 2034 #define SD_CONF_BSET_DISKSORT_DISABLED (1 << SD_CONF_SET_DISKSORT_DISABLED) 2035 2036 /* 2037 * Bit in flags telling driver to set LUN Reset enable flag from [s]sd.conf 2038 * [s]sd-config-list and driver table. 2039 */ 2040 #define SD_CONF_SET_LUN_RESET_ENABLED 17 2041 #define SD_CONF_BSET_LUN_RESET_ENABLED (1 << SD_CONF_SET_LUN_RESET_ENABLED) 2042 2043 /* 2044 * Bit in flags telling driver that the write cache on the device is 2045 * non-volatile. 2046 */ 2047 #define SD_CONF_SET_CACHE_IS_NV 18 2048 #define SD_CONF_BSET_CACHE_IS_NV (1 << SD_CONF_SET_CACHE_IS_NV) 2049 2050 /* 2051 * Bit in flags telling driver that the power condition flag from [s]sd.conf 2052 * [s]sd-config-list and driver table. 2053 */ 2054 #define SD_CONF_SET_PC_DISABLED 19 2055 #define SD_CONF_BSET_PC_DISABLED (1 << SD_CONF_SET_PC_DISABLED) 2056 2057 /* 2058 * This is the number of items currently settable in the sd.conf 2059 * sd-config-list. The mask value is defined for parameter checking. The 2060 * item count and mask should be updated when new properties are added. 2061 */ 2062 #define SD_CONF_MAX_ITEMS 19 2063 #define SD_CONF_BIT_MASK 0x0007FFFF 2064 2065 typedef struct { 2066 int sdt_throttle; 2067 int sdt_ctype; 2068 int sdt_not_rdy_retries; 2069 int sdt_busy_retries; 2070 int sdt_reset_retries; 2071 int sdt_reserv_rel_time; 2072 int sdt_min_throttle; 2073 int sdt_disk_sort_dis; 2074 int sdt_lun_reset_enable; 2075 int sdt_suppress_cache_flush; 2076 int sdt_power_condition_dis; 2077 } sd_tunables; 2078 2079 /* Type definition for static configuration table entries */ 2080 typedef struct sd_disk_config { 2081 char device_id[25]; 2082 uint_t flags; 2083 sd_tunables *properties; 2084 } sd_disk_config_t; 2085 2086 /* 2087 * first 2 bits of byte 4 options for 1bh command 2088 */ 2089 #define SD_TARGET_STOP 0x00 2090 #define SD_TARGET_START 0x01 2091 #define SD_TARGET_EJECT 0x02 2092 #define SD_TARGET_CLOSE 0x03 2093 2094 /* 2095 * power condition of byte 4 for 1bh command 2096 */ 2097 #define SD_TARGET_START_VALID 0x00 2098 #define SD_TARGET_ACTIVE 0x01 2099 #define SD_TARGET_IDLE 0x02 2100 #define SD_TARGET_STANDBY 0x03 2101 2102 2103 #define SD_MODE_SENSE_PAGE3_CODE 0x03 2104 #define SD_MODE_SENSE_PAGE4_CODE 0x04 2105 2106 #define SD_MODE_SENSE_PAGE3_LENGTH \ 2107 (sizeof (struct mode_format) + MODE_PARAM_LENGTH) 2108 #define SD_MODE_SENSE_PAGE4_LENGTH \ 2109 (sizeof (struct mode_geometry) + MODE_PARAM_LENGTH) 2110 2111 /* 2112 * These command codes need to be moved to sys/scsi/generic/commands.h 2113 */ 2114 2115 /* Both versions of the Read CD command */ 2116 2117 /* the official SCMD_READ_CD now comes from cdio.h */ 2118 #define SCMD_READ_CDD4 0xd4 /* the one used by some first */ 2119 /* generation ATAPI CD drives */ 2120 2121 /* expected sector type filter values for Play and Read CD CDBs */ 2122 #define CDROM_SECTOR_TYPE_CDDA (1<<2) /* IEC 908:1987 (CDDA) */ 2123 #define CDROM_SECTOR_TYPE_MODE1 (2<<2) /* Yellow book 2048 bytes */ 2124 #define CDROM_SECTOR_TYPE_MODE2 (3<<2) /* Yellow book 2335 bytes */ 2125 #define CDROM_SECTOR_TYPE_MODE2_FORM1 (4<<2) /* 2048 bytes */ 2126 #define CDROM_SECTOR_TYPE_MODE2_FORM2 (5<<2) /* 2324 bytes */ 2127 2128 /* READ CD filter bits (cdb[9]) */ 2129 #define CDROM_READ_CD_SYNC 0x80 /* read sync field */ 2130 #define CDROM_READ_CD_HDR 0x20 /* read four byte header */ 2131 #define CDROM_READ_CD_SUBHDR 0x40 /* read sub-header */ 2132 #define CDROM_READ_CD_ALLHDRS 0x60 /* read header and sub-header */ 2133 #define CDROM_READ_CD_USERDATA 0x10 /* read user data */ 2134 #define CDROM_READ_CD_EDC_ECC 0x08 /* read EDC and ECC field */ 2135 #define CDROM_READ_CD_C2 0x02 /* read C2 error data */ 2136 #define CDROM_READ_CD_C2_BEB 0x04 /* read C2 and Block Error Bits */ 2137 2138 2139 /* 2140 * These belong in sys/scsi/generic/mode.h 2141 */ 2142 2143 /* 2144 * Mode Sense/Select Header response for Group 2 CDB. 2145 */ 2146 2147 struct mode_header_grp2 { 2148 uchar_t length_msb; /* MSB - number of bytes following */ 2149 uchar_t length_lsb; 2150 uchar_t medium_type; /* device specific */ 2151 uchar_t device_specific; /* device specfic parameters */ 2152 uchar_t resv[2]; /* reserved */ 2153 uchar_t bdesc_length_hi; /* length of block descriptor(s) */ 2154 /* (if any) */ 2155 uchar_t bdesc_length_lo; 2156 }; 2157 2158 _NOTE(SCHEME_PROTECTS_DATA("Unshared data", mode_header_grp2)) 2159 2160 /* 2161 * Length of the Mode Parameter Header for the Group 2 Mode Select command 2162 */ 2163 #define MODE_HEADER_LENGTH_GRP2 (sizeof (struct mode_header_grp2)) 2164 #define MODE_PARAM_LENGTH_GRP2 (MODE_HEADER_LENGTH_GRP2 + MODE_BLK_DESC_LENGTH) 2165 2166 /* 2167 * Mode Page 1 - Error Recovery Page 2168 */ 2169 #define MODEPAGE_ERR_RECOVER 1 2170 2171 /* 2172 * The following buffer length define is 8 bytes for the Group 2 mode page 2173 * header, 8 bytes for the block descriptor and 26 bytes for the cdrom 2174 * capabilities page (per MMC-2) 2175 */ 2176 #define MODEPAGE_CDROM_CAP 0x2A 2177 #define MODEPAGE_CDROM_CAP_LEN 26 2178 #define BUFLEN_MODE_CDROM_CAP (MODEPAGE_CDROM_CAP_LEN + \ 2179 MODE_HEADER_LENGTH_GRP2 + MODE_BLK_DESC_LENGTH) 2180 2181 2182 /* 2183 * Power management defines 2184 */ 2185 #define SD_SPINDLE_UNINIT (-1) 2186 #define SD_SPINDLE_OFF 0 2187 #define SD_SPINDLE_ON 1 2188 #define SD_SPINDLE_STOPPED 0 2189 #define SD_SPINDLE_STANDBY 1 2190 #define SD_SPINDLE_IDLE 2 2191 #define SD_SPINDLE_ACTIVE 3 2192 #define SD_PM_NOT_SUPPORTED 4 2193 2194 /* 2195 * Power method flag 2196 */ 2197 #define SD_START_STOP 0 2198 #define SD_POWER_CONDITION 1 2199 2200 2201 /* 2202 * Number of power level for start stop or power condition 2203 */ 2204 #define SD_PM_NUM_LEVEL_SSU_SS 2 2205 #define SD_PM_NUM_LEVEL_SSU_PC 4 2206 2207 /* 2208 * SD internal power state change flag 2209 */ 2210 #define SD_PM_STATE_CHANGE 0 2211 #define SD_PM_STATE_ROLLBACK 1 2212 2213 /* 2214 * Power attribute table 2215 */ 2216 typedef struct disk_power_attr_ss { 2217 char *pm_comp[SD_PM_NUM_LEVEL_SSU_SS + 2]; /* pm component */ 2218 int ran_perf[SD_PM_NUM_LEVEL_SSU_SS]; /* random performance */ 2219 int pwr_saving[SD_PM_NUM_LEVEL_SSU_SS]; /* power saving */ 2220 int latency[SD_PM_NUM_LEVEL_SSU_SS]; /* latency */ 2221 }sd_power_attr_ss; 2222 2223 typedef struct disk_power_attr_pc { 2224 char *pm_comp[SD_PM_NUM_LEVEL_SSU_PC + 2]; /* pm component */ 2225 int ran_perf[SD_PM_NUM_LEVEL_SSU_PC]; /* random performance */ 2226 int pwr_saving[SD_PM_NUM_LEVEL_SSU_PC]; /* power saving */ 2227 int latency[SD_PM_NUM_LEVEL_SSU_PC]; /* latency */ 2228 }sd_power_attr_pc; 2229 2230 2231 /* 2232 * No Need to resume if already in PM_SUSPEND state because the thread 2233 * was suspended in sdpower. It will be resumed when sdpower is invoked to make 2234 * the device active. 2235 * When the thread is suspended, the watch thread is terminated and 2236 * the token is NULLed so check for this condition. 2237 * If there's a thread that can be resumed, ie. token is not NULL, then 2238 * it can be resumed. 2239 */ 2240 #define SD_OK_TO_RESUME_SCSI_WATCHER(un) (un->un_swr_token != NULL) 2241 /* 2242 * No Need to resume if already in PM_SUSPEND state because the thread 2243 * was suspended in sdpower. It will be resumed when sdpower is invoked to make 2244 * the device active. 2245 * When the thread is suspended, the watch thread is terminated and 2246 * the token is NULLed so check for this condition. 2247 */ 2248 #define SD_OK_TO_SUSPEND_SCSI_WATCHER(un) (un->un_swr_token != NULL) 2249 #define SD_DEVICE_IS_IN_LOW_POWER(un) ((un->un_f_pm_is_enabled) && \ 2250 (un->un_pm_count < 0)) 2251 #define SD_PM_STATE_ACTIVE(un) \ 2252 (un->un_f_power_condition_supported ? \ 2253 SD_SPINDLE_ACTIVE : SD_SPINDLE_ON) 2254 #define SD_PM_STATE_STOPPED(un) \ 2255 (un->un_f_power_condition_supported ? \ 2256 SD_SPINDLE_STOPPED : SD_SPINDLE_OFF) 2257 #define SD_PM_IS_LEVEL_VALID(un, level) \ 2258 ((un->un_f_power_condition_supported && \ 2259 level >= SD_SPINDLE_STOPPED && \ 2260 level <= SD_SPINDLE_ACTIVE) || \ 2261 (!un->un_f_power_condition_supported && \ 2262 level >= SD_SPINDLE_OFF && \ 2263 level <= SD_SPINDLE_ON)) 2264 #define SD_PM_IS_IO_CAPABLE(un, level) \ 2265 ((un->un_f_power_condition_supported && \ 2266 sd_pwr_pc.ran_perf[level] > 0) || \ 2267 (!un->un_f_power_condition_supported && \ 2268 sd_pwr_ss.ran_perf[level] > 0)) 2269 #define SD_PM_STOP_MOTOR_NEEDED(un, level) \ 2270 ((un->un_f_power_condition_supported && \ 2271 level <= SD_SPINDLE_STANDBY) || \ 2272 (!un->un_f_power_condition_supported && \ 2273 level == SD_SPINDLE_OFF)) 2274 2275 /* 2276 * Could move this define to some thing like log sense.h in SCSA headers 2277 * But for now let it live here. 2278 */ 2279 #define START_STOP_CYCLE_COUNTER_PAGE_SIZE 0x28 2280 #define START_STOP_CYCLE_PAGE 0x0E 2281 #define START_STOP_CYCLE_VU_PAGE 0x31 2282 2283 /* CD-ROM Error Recovery Parameters page (0x01) */ 2284 #define MODEPAGE_ERR_RECOV 0x1 2285 #define BUFLEN_CHG_BLK_MODE MODE_HEADER_LENGTH + MODE_BLK_DESC_LENGTH 2286 2287 /* 2288 * Vendor Specific (Toshiba) CD-ROM Speed page (0x31) 2289 * 2290 * The following buffer length define is 4 bytes for the Group 0 mode page 2291 * header, 8 bytes for the block descriptor and 4 bytes for the mode speed page. 2292 */ 2293 #define MODEPAGE_CDROM_SPEED_LEN 4 2294 #define BUFLEN_MODE_CDROM_SPEED MODEPAGE_CDROM_SPEED_LEN +\ 2295 MODE_HEADER_LENGTH +\ 2296 MODE_BLK_DESC_LENGTH 2297 #define SD_SPEED_1X 176 2298 2299 /* CD-ROM Audio Control Parameters page (0x0E) */ 2300 #define MODEPAGE_AUDIO_CTRL 0x0E 2301 #define MODEPAGE_AUDIO_CTRL_LEN 16 2302 2303 /* CD-ROM Sony Read Offset Defines */ 2304 #define SONY_SESSION_OFFSET_LEN 12 2305 #define SONY_SESSION_OFFSET_KEY 0x40 2306 #define SONY_SESSION_OFFSET_VALID 0x0a 2307 2308 /* 2309 * CD-ROM Write Protect Defines 2310 * 2311 * Bit 7 of the device specific field of the mode page header is the write 2312 * protect bit. 2313 */ 2314 #define WRITE_PROTECT 0x80 2315 2316 /* 2317 * Define for the length of a profile header returned in response to the 2318 * GET CONFIGURATION command 2319 */ 2320 #define SD_PROFILE_HEADER_LEN 8 /* bytes */ 2321 2322 /* 2323 * Define the length of the data in response to the GET CONFIGURATION 2324 * command. The 3rd byte of the feature descriptor contains the 2325 * current feature field that is of interest. This field begins 2326 * after the feature header which is 8 bytes. This variable length 2327 * was increased in size from 11 to 24 because some devices became 2328 * unresponsive with the smaller size. 2329 */ 2330 #define SD_CURRENT_FEATURE_LEN 24 /* bytes */ 2331 2332 /* 2333 * Feature codes associated with GET CONFIGURATION command for supported 2334 * devices. 2335 */ 2336 #define RANDOM_WRITABLE 0x20 2337 #define HARDWARE_DEFECT_MANAGEMENT 0x24 2338 2339 /* 2340 * Could move this define to some thing like log sense.h in SCSA headers 2341 * But for now let it live here. 2342 */ 2343 #define TEMPERATURE_PAGE 0x0D 2344 #define TEMPERATURE_PAGE_SIZE 16 /* bytes */ 2345 2346 /* delay time used for sd_media_watch_cb delayed cv broadcast */ 2347 #define MEDIA_ACCESS_DELAY 2000000 2348 2349 2350 /* SCSI power on or bus device reset additional sense code */ 2351 #define SD_SCSI_RESET_SENSE_CODE 0x29 2352 2353 /* 2354 * These defines are for the Vital Product Data Pages in the inquiry command. 2355 * They are the bits in the un_vpd_page mask, telling the supported pages. 2356 */ 2357 #define SD_VPD_SUPPORTED_PG 0x01 /* 0x00 - Supported VPD pages */ 2358 #define SD_VPD_UNIT_SERIAL_PG 0x02 /* 0x80 - Unit Serial Number */ 2359 #define SD_VPD_OPERATING_PG 0x04 /* 0x81 - Implemented Op Defs */ 2360 #define SD_VPD_ASCII_OP_PG 0x08 /* 0x82 - ASCII Op Defs */ 2361 #define SD_VPD_DEVID_WWN_PG 0x10 /* 0x83 - Device Identification */ 2362 #define SD_VPD_EXTENDED_DATA_PG 0x80 /* 0x86 - Extended data about the lun */ 2363 #define SD_VPD_DEV_CHARACTER_PG 0x400 /* 0xB1 - Device Characteristics */ 2364 2365 /* 2366 * Non-volatile cache support 2367 * 2368 * Bit 1 of the byte 6 in the Extended INQUIRY data VPD page 2369 * is NV_SUP bit: An NV_SUP bit set to one indicates that 2370 * the device server supports a non-volatile cache. An 2371 * NV_SUP bit set to zero indicates that the device 2372 * server may or may not support a non-volatile cache. 2373 * 2374 * Bit 2 of the byte 1 in the SYNC CACHE command is SYNC_NV 2375 * bit: The SYNC_NV bit specifies whether the device server 2376 * is required to synchronize volatile and non-volatile 2377 * caches. 2378 */ 2379 #define SD_VPD_NV_SUP 0x02 2380 #define SD_SYNC_NV_BIT 0x04 2381 2382 /* 2383 * Addition from sddef.intel.h 2384 */ 2385 #if defined(__i386) || defined(__amd64) 2386 2387 #define P0_RAW_DISK (NDKMAP) 2388 #define FDISK_P1 (NDKMAP+1) 2389 #define FDISK_P2 (NDKMAP+2) 2390 #define FDISK_P3 (NDKMAP+3) 2391 #define FDISK_P4 (NDKMAP+4) 2392 2393 #endif /* __i386 || __amd64 */ 2394 2395 #ifdef __cplusplus 2396 } 2397 #endif 2398 2399 2400 #endif /* _SYS_SCSI_TARGETS_SDDEF_H */ 2401
Indexes created Sat Nov 07 16:53:30 UTC 2009
Terms of Use |
Privacy |
Trademarks |
Copyright Policy |
Site Guidelines |
Help
Your use of this web site or any of its content or software indicates your agreement to be bound by these Terms of Use.
Copyright © 1995-2008 Sun Microsystems, Inc.