]>
git.proxmox.com Git - mirror_zfs.git/blob - lib/libspl/include/sys/dkio.h
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.
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.
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]
22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
23 * Use is subject to license terms.
31 #include <sys/dklabel.h> /* Needed for NDKMAP define */
38 * Structures and definitions for disk io control commands
42 * Structures used as data by ioctl calls.
45 #define DK_DEVLEN 16 /* device name max length, including */
46 /* unit # & NULL (ie - "xyc1") */
49 * Used for controller info
52 char dki_cname
[DK_DEVLEN
]; /* controller name (no unit #) */
53 ushort_t dki_ctype
; /* controller type */
54 ushort_t dki_flags
; /* flags */
55 ushort_t dki_cnum
; /* controller number */
56 uint_t dki_addr
; /* controller address */
57 uint_t dki_space
; /* controller bus type */
58 uint_t dki_prio
; /* interrupt priority */
59 uint_t dki_vec
; /* interrupt vector */
60 char dki_dname
[DK_DEVLEN
]; /* drive name (no unit #) */
61 uint_t dki_unit
; /* unit number */
62 uint_t dki_slave
; /* slave number */
63 ushort_t dki_partition
; /* partition number */
64 ushort_t dki_maxtransfer
; /* max. transfer size in DEV_BSIZE */
71 #define DKC_CDROM 1 /* CD-ROM, SCSI or otherwise */
73 #define DKC_XXX_0 3 /* unassigned */
74 #define DKC_XXX_1 4 /* unassigned */
78 #define DKC_XXX_2 9 /* unassigned */
79 #define DKC_NCRFLOPPY 10
80 #define DKC_SMSFLOPPY 12
81 #define DKC_SCSI_CCS 13 /* SCSI CCS compatible */
82 #define DKC_INTEL82072 14 /* native floppy chip */
83 #define DKC_MD 16 /* meta-disk (virtual-disk) driver */
84 #define DKC_INTEL82077 19 /* 82077 floppy disk controller */
85 #define DKC_DIRECT 20 /* Intel direct attached device i.e. IDE */
86 #define DKC_PCMCIA_MEM 21 /* PCMCIA memory disk-like type */
87 #define DKC_PCMCIA_ATA 22 /* PCMCIA AT Attached type */
88 #define DKC_VBD 23 /* virtual block device */
91 * Sun reserves up through 1023
94 #define DKC_CUSTOMER_BASE 1024
99 #define DKI_BAD144 0x01 /* use DEC std 144 bad sector fwding */
100 #define DKI_MAPTRK 0x02 /* controller does track mapping */
101 #define DKI_FMTTRK 0x04 /* formats only full track at a time */
102 #define DKI_FMTVOL 0x08 /* formats only full volume at a time */
103 #define DKI_FMTCYL 0x10 /* formats only full cylinders at a time */
104 #define DKI_HEXUNIT 0x20 /* unit number is printed as 3 hex digits */
105 #define DKI_PCMCIA_PFD 0x40 /* PCMCIA pseudo-floppy memory card */
108 * Used for all partitions
111 struct dk_map dka_map
[NDKMAP
];
114 #if defined(_SYSCALL32)
116 struct dk_map32 dka_map
[NDKMAP
];
118 #endif /* _SYSCALL32 */
121 * Definition of a disk's geometry
124 unsigned short dkg_ncyl
; /* # of data cylinders */
125 unsigned short dkg_acyl
; /* # of alternate cylinders */
126 unsigned short dkg_bcyl
; /* cyl offset (for fixed head area) */
127 unsigned short dkg_nhead
; /* # of heads */
128 unsigned short dkg_obs1
; /* obsolete */
129 unsigned short dkg_nsect
; /* # of data sectors per track */
130 unsigned short dkg_intrlv
; /* interleave factor */
131 unsigned short dkg_obs2
; /* obsolete */
132 unsigned short dkg_obs3
; /* obsolete */
133 unsigned short dkg_apc
; /* alternates per cyl (SCSI only) */
134 unsigned short dkg_rpm
; /* revolutions per minute */
135 unsigned short dkg_pcyl
; /* # of physical cylinders */
136 unsigned short dkg_write_reinstruct
; /* # sectors to skip, writes */
137 unsigned short dkg_read_reinstruct
; /* # sectors to skip, reads */
138 unsigned short dkg_extra
[7]; /* for compatible expansion */
142 * These defines are for historic compatibility with old drivers.
144 #define dkg_bhead dkg_obs1 /* used to be head offset */
145 #define dkg_gap1 dkg_obs2 /* used to be gap1 */
146 #define dkg_gap2 dkg_obs3 /* used to be gap2 */
149 * Disk io control commands
150 * Warning: some other ioctls with the DIOC prefix exist elsewhere.
151 * The Generic DKIOC numbers are from 0 - 50.
152 * The Floppy Driver uses 51 - 100.
153 * The Hard Disk (except SCSI) 101 - 106. (these are obsolete)
154 * The CDROM Driver 151 - 200.
155 * The USCSI ioctl 201 - 250.
157 #define DKIOC (0x04 << 8)
160 * The following ioctls are generic in nature and need to be
161 * suported as appropriate by all disk drivers
163 #define DKIOCGGEOM (DKIOC|1) /* Get geometry */
164 #define DKIOCINFO (DKIOC|3) /* Get info */
165 #define DKIOCEJECT (DKIOC|6) /* Generic 'eject' */
166 #define DKIOCGVTOC (DKIOC|11) /* Get VTOC */
167 #define DKIOCSVTOC (DKIOC|12) /* Set VTOC & Write to Disk */
170 * Disk Cache Controls. These ioctls should be supported by
173 * DKIOCFLUSHWRITECACHE when used from user-mode ignores the ioctl
174 * argument, but it should be passed as NULL to allow for future
175 * reinterpretation. From user-mode, this ioctl request is synchronous.
177 * When invoked from within the kernel, the arg can be NULL to indicate
178 * a synchronous request or can be the address of a struct dk_callback
179 * to request an asynchronous callback when the flush request is complete.
180 * In this case, the flag to the ioctl must include FKIOCTL and the
181 * dkc_callback field of the pointed to struct must be non-null or the
182 * request is made synchronously.
184 * In the callback case: if the ioctl returns 0, a callback WILL be performed.
185 * If the ioctl returns non-zero, a callback will NOT be performed.
186 * NOTE: In some cases, the callback may be done BEFORE the ioctl call
187 * returns. The caller's locking strategy should be prepared for this case.
189 #define DKIOCFLUSHWRITECACHE (DKIOC|34) /* flush cache to phys medium */
192 void (*dkc_callback
)(void *dkc_cookie
, int error
);
197 /* bit flag definitions for dkc_flag */
198 #define FLUSH_VOLATILE 0x1 /* Bit 0: if set, only flush */
199 /* volatile cache; otherwise, flush */
200 /* volatile and non-volatile cache */
202 #define DKIOCGETWCE (DKIOC|36) /* Get current write cache */
203 /* enablement status */
204 #define DKIOCSETWCE (DKIOC|37) /* Enable/Disable write cache */
207 * The following ioctls are used by Sun drivers to communicate
208 * with their associated format routines. Support of these ioctls
209 * is not required of foreign drivers
211 #define DKIOCSGEOM (DKIOC|2) /* Set geometry */
212 #define DKIOCSAPART (DKIOC|4) /* Set all partitions */
213 #define DKIOCGAPART (DKIOC|5) /* Get all partitions */
214 #define DKIOCG_PHYGEOM (DKIOC|32) /* get physical geometry */
215 #define DKIOCG_VIRTGEOM (DKIOC|33) /* get virtual geometry */
218 * The following ioctl's are removable media support
220 #define DKIOCLOCK (DKIOC|7) /* Generic 'lock' */
221 #define DKIOCUNLOCK (DKIOC|8) /* Generic 'unlock' */
222 #define DKIOCSTATE (DKIOC|13) /* Inquire insert/eject state */
223 #define DKIOCREMOVABLE (DKIOC|16) /* is media removable */
227 * ioctl for hotpluggable devices
229 #define DKIOCHOTPLUGGABLE (DKIOC|35) /* is hotpluggable */
232 * Ioctl to force driver to re-read the alternate partition and rebuild
233 * the internal defect map.
235 #define DKIOCADDBAD (DKIOC|20) /* Re-read the alternate map (IDE) */
236 #define DKIOCGETDEF (DKIOC|21) /* read defect list (IDE) */
239 * Used by applications to get disk defect information from IDE
243 struct defect_header32
{
247 #endif /* _SYSCALL32 */
249 struct defect_header
{
254 #define DKIOCPARTINFO (DKIOC|22) /* Get partition or slice parameters */
257 * Used by applications to get partition or slice information
264 #endif /* _SYSCALL32 */
271 /* The following ioctls are for Optical Memory Device */
272 #define DKIOC_EBP_ENABLE (DKIOC|40) /* enable by pass erase on write */
273 #define DKIOC_EBP_DISABLE (DKIOC|41) /* disable by pass erase on write */
276 * This state enum is the argument passed to the DKIOCSTATE ioctl.
278 enum dkio_state
{ DKIO_NONE
, DKIO_EJECTED
, DKIO_INSERTED
, DKIO_DEV_GONE
};
280 #define DKIOCGMEDIAINFO (DKIOC|42) /* get information about the media */
283 * ioctls to read/write mboot info.
285 #define DKIOCGMBOOT (DKIOC|43) /* get mboot info */
286 #define DKIOCSMBOOT (DKIOC|44) /* set mboot info */
289 * ioctl to get the device temperature.
291 #define DKIOCGTEMPERATURE (DKIOC|45) /* get temperature */
294 * Used for providing the temperature.
297 struct dk_temperature
{
298 uint_t dkt_flags
; /* Flags */
299 short dkt_cur_temp
; /* Current disk temperature */
300 short dkt_ref_temp
; /* reference disk temperature */
303 #define DKT_BYPASS_PM 0x1
304 #define DKT_INVALID_TEMP 0xFFFF
308 * Used for Media info or the current profile info
311 uint_t dki_media_type
; /* Media type or profile info */
312 uint_t dki_lbsize
; /* Logical blocksize of media */
313 diskaddr_t dki_capacity
; /* Capacity as # of dki_lbsize blks */
317 * Media types or profiles known
319 #define DK_UNKNOWN 0x00 /* Media inserted - type unknown */
323 * SFF 8090 Specification Version 3, media types 0x01 - 0xfffe are retained to
324 * maintain compatibility with SFF8090. The following define the
325 * optical media type.
327 #define DK_REMOVABLE_DISK 0x02 /* Removable Disk */
328 #define DK_MO_ERASABLE 0x03 /* MO Erasable */
329 #define DK_MO_WRITEONCE 0x04 /* MO Write once */
330 #define DK_AS_MO 0x05 /* AS MO */
331 #define DK_CDROM 0x08 /* CDROM */
332 #define DK_CDR 0x09 /* CD-R */
333 #define DK_CDRW 0x0A /* CD-RW */
334 #define DK_DVDROM 0x10 /* DVD-ROM */
335 #define DK_DVDR 0x11 /* DVD-R */
336 #define DK_DVDRAM 0x12 /* DVD_RAM or DVD-RW */
339 * Media types for other rewritable magnetic media
341 #define DK_FIXED_DISK 0x10001 /* Fixed disk SCSI or otherwise */
342 #define DK_FLOPPY 0x10002 /* Floppy media */
343 #define DK_ZIP 0x10003 /* IOMEGA ZIP media */
344 #define DK_JAZ 0x10004 /* IOMEGA JAZ media */
346 #define DKIOCSETEFI (DKIOC|17) /* Set EFI info */
347 #define DKIOCGETEFI (DKIOC|18) /* Get EFI info */
349 #define DKIOCPARTITION (DKIOC|9) /* Get partition info */
352 * Ioctls to get/set volume capabilities related to Logical Volume Managers.
353 * They include the ability to get/set capabilities and to issue a read to a
354 * specific underlying device of a replicated device.
357 #define DKIOCGETVOLCAP (DKIOC | 25) /* Get volume capabilities */
358 #define DKIOCSETVOLCAP (DKIOC | 26) /* Set volume capabilities */
359 #define DKIOCDMR (DKIOC | 27) /* Issue a directed read */
361 typedef uint_t volcapinfo_t
;
363 typedef uint_t volcapset_t
;
365 #define DKV_ABR_CAP 0x00000001 /* Support Appl.Based Recovery */
366 #define DKV_DMR_CAP 0x00000002 /* Support Directed Mirror Read */
368 typedef struct volcap
{
369 volcapinfo_t vc_info
; /* Capabilities available */
370 volcapset_t vc_set
; /* Capabilities set */
373 #define VOL_SIDENAME 256
375 typedef struct vol_directed_rd
{
379 size_t vdr_bytesread
;
382 char vdr_side_name
[VOL_SIDENAME
];
385 #define DKV_SIDE_INIT (-1)
386 #define DKV_DMR_NEXT_SIDE 0x00000001
387 #define DKV_DMR_DONE 0x00000002
388 #define DKV_DMR_ERROR 0x00000004
389 #define DKV_DMR_SUCCESS 0x00000008
390 #define DKV_DMR_SHORT 0x00000010
392 #ifdef _MULTI_DATAMODEL
393 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
396 typedef struct vol_directed_rd32
{
398 offset_t vdr_offset
; /* 64-bit element on 32-bit alignment */
400 size32_t vdr_bytesread
;
403 char vdr_side_name
[VOL_SIDENAME
];
404 } vol_directed_rd32_t
;
405 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
408 #endif /* _MULTI_DATAMODEL */
411 * The ioctl is used to fetch disk's device type, vendor ID,
412 * model number/product ID, firmware revision and serial number together.
414 * Currently there are two device types - DKD_ATA_TYPE which means the
415 * disk is driven by cmdk/ata or dad/uata driver, and DKD_SCSI_TYPE
416 * which means the disk is driven by sd/scsi hba driver.
418 #define DKIOC_GETDISKID (DKIOC|46)
420 /* These two labels are for dkd_dtype of dk_disk_id_t */
421 #define DKD_ATA_TYPE 0x01 /* ATA disk or legacy mode SATA disk */
422 #define DKD_SCSI_TYPE 0x02 /* SCSI disk or native mode SATA disk */
424 #define DKD_ATA_MODEL 40 /* model number length */
425 #define DKD_ATA_FWVER 8 /* firmware revision length */
426 #define DKD_ATA_SERIAL 20 /* serial number length */
428 #define DKD_SCSI_VENDOR 8 /* vendor ID length */
429 #define DKD_SCSI_PRODUCT 16 /* product ID length */
430 #define DKD_SCSI_REVLEVEL 4 /* revision level length */
431 #define DKD_SCSI_SERIAL 12 /* serial number length */
434 * The argument type for DKIOC_GETDISKID ioctl.
436 typedef struct dk_disk_id
{
440 char dkd_amodel
[DKD_ATA_MODEL
]; /* 40 bytes */
441 char dkd_afwver
[DKD_ATA_FWVER
]; /* 8 bytes */
442 char dkd_aserial
[DKD_ATA_SERIAL
]; /* 20 bytes */
445 char dkd_svendor
[DKD_SCSI_VENDOR
]; /* 8 bytes */
446 char dkd_sproduct
[DKD_SCSI_PRODUCT
]; /* 16 bytes */
447 char dkd_sfwver
[DKD_SCSI_REVLEVEL
]; /* 4 bytes */
448 char dkd_sserial
[DKD_SCSI_SERIAL
]; /* 12 bytes */
454 * The ioctl is used to update the firmware of device.
456 #define DKIOC_UPDATEFW (DKIOC|47)
458 /* The argument type for DKIOC_UPDATEFW ioctl */
459 typedef struct dk_updatefw
{
460 caddr_t dku_ptrbuf
; /* pointer to firmware buf */
461 uint_t dku_size
; /* firmware buf length */
462 uint8_t dku_type
; /* firmware update type */
466 typedef struct dk_updatefw_32
{
467 caddr32_t dku_ptrbuf
; /* pointer to firmware buf */
468 uint_t dku_size
; /* firmware buf length */
469 uint8_t dku_type
; /* firmware update type */
471 #endif /* _SYSCALL32 */
474 * firmware update type - temporary or permanent use
476 #define FW_TYPE_TEMP 0x0 /* temporary use */
477 #define FW_TYPE_PERM 0x1 /* permanent use */
484 #endif /* _SYS_DKIO_H */