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