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