1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License, Version 1.0 only 6 * (the "License"). You may not use this file except in compliance 7 * with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or http://www.opensolaris.org/os/licensing. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYS_DKIO_H 28 #define _SYS_DKIO_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" /* SunOS-4.0 5.19 */ 31 32 #include <sys/dklabel.h> /* Needed for NDKMAP define */ 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /* 39 * Structures and definitions for disk io control commands 40 */ 41 42 /* 43 * Structures used as data by ioctl calls. 44 */ 45 46 #define DK_DEVLEN 16 /* device name max length, including */ 47 /* unit # & NULL (ie - "xyc1") */ 48 49 /* 50 * Used for controller info 51 */ 52 struct dk_cinfo { 53 char dki_cname[DK_DEVLEN]; /* controller name (no unit #) */ 54 ushort_t dki_ctype; /* controller type */ 55 ushort_t dki_flags; /* flags */ 56 ushort_t dki_cnum; /* controller number */ 57 uint_t dki_addr; /* controller address */ 58 uint_t dki_space; /* controller bus type */ 59 uint_t dki_prio; /* interrupt priority */ 60 uint_t dki_vec; /* interrupt vector */ 61 char dki_dname[DK_DEVLEN]; /* drive name (no unit #) */ 62 uint_t dki_unit; /* unit number */ 63 uint_t dki_slave; /* slave number */ 64 ushort_t dki_partition; /* partition number */ 65 ushort_t dki_maxtransfer; /* max. transfer size in DEV_BSIZE */ 66 }; 67 68 /* 69 * Controller types 70 */ 71 #define DKC_UNKNOWN 0 72 #define DKC_CDROM 1 /* CD-ROM, SCSI or otherwise */ 73 #define DKC_WDC2880 2 74 #define DKC_XXX_0 3 /* unassigned */ 75 #define DKC_XXX_1 4 /* unassigned */ 76 #define DKC_DSD5215 5 77 #define DKC_ACB4000 7 78 #define DKC_MD21 8 79 #define DKC_XXX_2 9 /* unassigned */ 80 #define DKC_NCRFLOPPY 10 81 #define DKC_SMSFLOPPY 12 82 #define DKC_SCSI_CCS 13 /* SCSI CCS compatible */ 83 #define DKC_INTEL82072 14 /* native floppy chip */ 84 #define DKC_MD 16 /* meta-disk (virtual-disk) driver */ 85 #define DKC_INTEL82077 19 /* 82077 floppy disk controller */ 86 #define DKC_DIRECT 20 /* Intel direct attached device i.e. IDE */ 87 #define DKC_PCMCIA_MEM 21 /* PCMCIA memory disk-like type */ 88 #define DKC_PCMCIA_ATA 22 /* PCMCIA AT Attached type */ 89 90 /* 91 * Sun reserves up through 1023 92 */ 93 94 #define DKC_CUSTOMER_BASE 1024 95 96 /* 97 * Flags 98 */ 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 */ 106 107 /* 108 * Used for all partitions 109 */ 110 struct dk_allmap { 111 struct dk_map dka_map[NDKMAP]; 112 }; 113 114 #if defined(_SYSCALL32) 115 struct dk_allmap32 { 116 struct dk_map32 dka_map[NDKMAP]; 117 }; 118 #endif /* _SYSCALL32 */ 119 120 /* 121 * Definition of a disk's geometry 122 */ 123 struct dk_geom { 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 */ 139 }; 140 141 /* 142 * These defines are for historic compatibility with old drivers. 143 */ 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 */ 147 148 /* 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. 156 */ 157 #define DKIOC (0x04 << 8) 158 159 /* 160 * The following ioctls are generic in nature and need to be 161 * suported as appropriate by all disk drivers 162 */ 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 */ 168 169 /* 170 * Disk Cache Controls. These ioctls should be supported by 171 * all disk drivers. 172 * 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. 176 * 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. 183 * 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. 188 */ 189 #define DKIOCFLUSHWRITECACHE (DKIOC|34) /* flush cache to phys medium */ 190 191 struct dk_callback { 192 void (*dkc_callback)(void *dkc_cookie, int error); 193 void *dkc_cookie; 194 }; 195 196 /* 197 * The following ioctls are used by Sun drivers to communicate 198 * with their associated format routines. Support of these ioctls 199 * is not required of foreign drivers 200 */ 201 #define DKIOCSGEOM (DKIOC|2) /* Set geometry */ 202 #define DKIOCSAPART (DKIOC|4) /* Set all partitions */ 203 #define DKIOCGAPART (DKIOC|5) /* Get all partitions */ 204 #define DKIOCG_PHYGEOM (DKIOC|32) /* get physical geometry */ 205 #define DKIOCG_VIRTGEOM (DKIOC|33) /* get virtual geometry */ 206 207 /* 208 * The following ioctl's are removable media support 209 */ 210 #define DKIOCLOCK (DKIOC|7) /* Generic 'lock' */ 211 #define DKIOCUNLOCK (DKIOC|8) /* Generic 'unlock' */ 212 #define DKIOCSTATE (DKIOC|13) /* Inquire insert/eject state */ 213 #define DKIOCREMOVABLE (DKIOC|16) /* is media removable */ 214 215 /* 216 * Ioctl to force driver to re-read the alternate partition and rebuild 217 * the internal defect map. 218 */ 219 #define DKIOCADDBAD (DKIOC|20) /* Re-read the alternate map (IDE) */ 220 #define DKIOCGETDEF (DKIOC|21) /* read defect list (IDE) */ 221 222 /* 223 * Used by applications to get disk defect information from IDE 224 * drives. 225 */ 226 #ifdef _SYSCALL32 227 struct defect_header32 { 228 int head; 229 caddr32_t buffer; 230 }; 231 #endif /* _SYSCALL32 */ 232 233 struct defect_header { 234 int head; 235 caddr_t buffer; 236 }; 237 238 #define DKIOCPARTINFO (DKIOC|22) /* Get partition or slice parameters */ 239 240 /* 241 * Used by applications to get partition or slice information 242 */ 243 #ifdef _SYSCALL32 244 struct part_info32 { 245 daddr32_t p_start; 246 int p_length; 247 }; 248 #endif /* _SYSCALL32 */ 249 250 struct part_info { 251 daddr_t p_start; 252 int p_length; 253 }; 254 255 /* The following ioctls are for Optical Memory Device */ 256 #define DKIOC_EBP_ENABLE (DKIOC|40) /* enable by pass erase on write */ 257 #define DKIOC_EBP_DISABLE (DKIOC|41) /* disable by pass erase on write */ 258 259 /* 260 * This state enum is the argument passed to the DKIOCSTATE ioctl. 261 */ 262 enum dkio_state { DKIO_NONE, DKIO_EJECTED, DKIO_INSERTED, DKIO_DEV_GONE }; 263 264 #define DKIOCGMEDIAINFO (DKIOC|42) /* get information about the media */ 265 266 /* 267 * ioctls to read/write mboot info. 268 */ 269 #define DKIOCGMBOOT (DKIOC|43) /* get mboot info */ 270 #define DKIOCSMBOOT (DKIOC|44) /* set mboot info */ 271 272 /* 273 * ioctl to get the device temperature. 274 */ 275 #define DKIOCGTEMPERATURE (DKIOC|45) /* get temperature */ 276 277 /* 278 * Used for providing the temperature. 279 */ 280 281 struct dk_temperature { 282 uint_t dkt_flags; /* Flags */ 283 short dkt_cur_temp; /* Current disk temperature */ 284 short dkt_ref_temp; /* reference disk temperature */ 285 }; 286 287 #define DKT_BYPASS_PM 0x1 288 #define DKT_INVALID_TEMP 0xFFFF 289 290 291 /* 292 * Used for Media info or the current profile info 293 */ 294 struct dk_minfo { 295 uint_t dki_media_type; /* Media type or profile info */ 296 uint_t dki_lbsize; /* Logical blocksize of media */ 297 diskaddr_t dki_capacity; /* Capacity as # of dki_lbsize blks */ 298 }; 299 300 /* 301 * Media types or profiles known 302 */ 303 #define DK_UNKNOWN 0x00 /* Media inserted - type unknown */ 304 305 306 /* 307 * SFF 8090 Specification Version 3, media types 0x01 - 0xfffe are retained to 308 * maintain compatibility with SFF8090. The following define the 309 * optical media type. 310 */ 311 #define DK_REMOVABLE_DISK 0x02 /* Removable Disk */ 312 #define DK_MO_ERASABLE 0x03 /* MO Erasable */ 313 #define DK_MO_WRITEONCE 0x04 /* MO Write once */ 314 #define DK_AS_MO 0x05 /* AS MO */ 315 #define DK_CDROM 0x08 /* CDROM */ 316 #define DK_CDR 0x09 /* CD-R */ 317 #define DK_CDRW 0x0A /* CD-RW */ 318 #define DK_DVDROM 0x10 /* DVD-ROM */ 319 #define DK_DVDR 0x11 /* DVD-R */ 320 #define DK_DVDRAM 0x12 /* DVD_RAM or DVD-RW */ 321 322 /* 323 * Media types for other rewritable magnetic media 324 */ 325 #define DK_FIXED_DISK 0x10001 /* Fixed disk SCSI or otherwise */ 326 #define DK_FLOPPY 0x10002 /* Floppy media */ 327 #define DK_ZIP 0x10003 /* IOMEGA ZIP media */ 328 #define DK_JAZ 0x10004 /* IOMEGA JAZ media */ 329 330 #define DKIOCSETEFI (DKIOC|17) /* Set EFI info */ 331 #define DKIOCGETEFI (DKIOC|18) /* Get EFI info */ 332 333 #define DKIOCPARTITION (DKIOC|9) /* Get partition info */ 334 335 /* 336 * Ioctls to get/set volume capabilities related to Logical Volume Managers. 337 * They include the ability to get/set capabilities and to issue a read to a 338 * specific underlying device of a replicated device. 339 */ 340 341 #define DKIOCGETVOLCAP (DKIOC | 25) /* Get volume capabilities */ 342 #define DKIOCSETVOLCAP (DKIOC | 26) /* Set volume capabilities */ 343 #define DKIOCDMR (DKIOC | 27) /* Issue a directed read */ 344 345 typedef uint_t volcapinfo_t; 346 347 typedef uint_t volcapset_t; 348 349 #define DKV_ABR_CAP 0x00000001 /* Support Appl.Based Recovery */ 350 #define DKV_DMR_CAP 0x00000002 /* Support Directed Mirror Read */ 351 352 typedef struct volcap { 353 volcapinfo_t vc_info; /* Capabilities available */ 354 volcapset_t vc_set; /* Capabilities set */ 355 } volcap_t; 356 357 #define VOL_SIDENAME 256 358 359 typedef struct vol_directed_rd { 360 int vdr_flags; 361 offset_t vdr_offset; 362 size_t vdr_nbytes; 363 size_t vdr_bytesread; 364 void *vdr_data; 365 int vdr_side; 366 char vdr_side_name[VOL_SIDENAME]; 367 } vol_directed_rd_t; 368 369 #define DKV_SIDE_INIT (-1) 370 #define DKV_DMR_NEXT_SIDE 0x00000001 371 #define DKV_DMR_DONE 0x00000002 372 #define DKV_DMR_ERROR 0x00000004 373 #define DKV_DMR_SUCCESS 0x00000008 374 #define DKV_DMR_SHORT 0x00000010 375 376 #ifdef _MULTI_DATAMODEL 377 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 378 #pragma pack(4) 379 #endif 380 typedef struct vol_directed_rd32 { 381 int32_t vdr_flags; 382 offset_t vdr_offset; /* 64-bit element on 32-bit alignment */ 383 size32_t vdr_nbytes; 384 size32_t vdr_bytesread; 385 caddr32_t vdr_data; 386 int32_t vdr_side; 387 char vdr_side_name[VOL_SIDENAME]; 388 } vol_directed_rd32_t; 389 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4 390 #pragma pack() 391 #endif 392 #endif /* _MULTI_DATAMODEL */ 393 394 #ifdef __cplusplus 395 } 396 #endif 397 398 #endif /* _SYS_DKIO_H */ 399