sys/cddl/contrib/opensolaris/uts/common/sys/dkio.h

   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 2008 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 #include <sys/dklabel.h>        /* Needed for NDKMAP define */
  31
  32 #ifdef  __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /*
  37  * Structures and definitions for disk io control commands
  38  */
  39
  40 /*
  41  * Structures used as data by ioctl calls.
  42  */
  43
  44 #define DK_DEVLEN       16              /* device name max length, including */
  45                                         /* unit # & NULL (ie - "xyc1") */
  46
  47 /*
  48  * Used for controller info
  49  */
  50 struct dk_cinfo {
  51         char    dki_cname[DK_DEVLEN];   /* controller name (no unit #) */
  52         ushort_t dki_ctype;             /* controller type */
  53         ushort_t dki_flags;             /* flags */
  54         ushort_t dki_cnum;              /* controller number */
  55         uint_t  dki_addr;               /* controller address */
  56         uint_t  dki_space;              /* controller bus type */
  57         uint_t  dki_prio;               /* interrupt priority */
  58         uint_t  dki_vec;                /* interrupt vector */
  59         char    dki_dname[DK_DEVLEN];   /* drive name (no unit #) */
  60         uint_t  dki_unit;               /* unit number */
  61         uint_t  dki_slave;              /* slave number */
  62         ushort_t dki_partition;         /* partition number */
  63         ushort_t dki_maxtransfer;       /* max. transfer size in DEV_BSIZE */
  64 };
  65
  66 /*
  67  * Controller types
  68  */
  69 #define DKC_UNKNOWN     0
  70 #define DKC_CDROM       1       /* CD-ROM, SCSI or otherwise */
  71 #define DKC_WDC2880     2
  72 #define DKC_XXX_0       3       /* unassigned */
  73 #define DKC_XXX_1       4       /* unassigned */
  74 #define DKC_DSD5215     5
  75 #define DKC_ACB4000     7
  76 #define DKC_MD21        8
  77 #define DKC_XXX_2       9       /* unassigned */
  78 #define DKC_NCRFLOPPY   10
  79 #define DKC_SMSFLOPPY   12
  80 #define DKC_SCSI_CCS    13      /* SCSI CCS compatible */
  81 #define DKC_INTEL82072  14      /* native floppy chip */
  82 #define DKC_MD          16      /* meta-disk (virtual-disk) driver */
  83 #define DKC_INTEL82077  19      /* 82077 floppy disk controller */
  84 #define DKC_DIRECT      20      /* Intel direct attached device i.e. IDE */
  85 #define DKC_PCMCIA_MEM  21      /* PCMCIA memory disk-like type */
  86 #define DKC_PCMCIA_ATA  22      /* PCMCIA AT Attached type */
  87 #define DKC_VBD         23      /* virtual block device */
  88
  89 /*
  90  * Sun reserves up through 1023
  91  */
  92
  93 #define DKC_CUSTOMER_BASE       1024
  94
  95 /*
  96  * Flags
  97  */
  98 #define DKI_BAD144      0x01    /* use DEC std 144 bad sector fwding */
  99 #define DKI_MAPTRK      0x02    /* controller does track mapping */
 100 #define DKI_FMTTRK      0x04    /* formats only full track at a time */
 101 #define DKI_FMTVOL      0x08    /* formats only full volume at a time */
 102 #define DKI_FMTCYL      0x10    /* formats only full cylinders at a time */
 103 #define DKI_HEXUNIT     0x20    /* unit number is printed as 3 hex digits */
 104 #define DKI_PCMCIA_PFD  0x40    /* PCMCIA pseudo-floppy memory card */
 105
 106 /*
 107  * Used for all partitions
 108  */
 109 struct dk_allmap {
 110         struct dk_map   dka_map[NDKMAP];
 111 };
 112
 113 #if defined(_SYSCALL32)
 114 struct dk_allmap32 {
 115         struct dk_map32 dka_map[NDKMAP];
 116 };
 117 #endif /* _SYSCALL32 */
 118
 119 /*
 120  * Definition of a disk's geometry
 121  */
 122 struct dk_geom {
 123         unsigned short  dkg_ncyl;       /* # of data cylinders */
 124         unsigned short  dkg_acyl;       /* # of alternate cylinders */
 125         unsigned short  dkg_bcyl;       /* cyl offset (for fixed head area) */
 126         unsigned short  dkg_nhead;      /* # of heads */
 127         unsigned short  dkg_obs1;       /* obsolete */
 128         unsigned short  dkg_nsect;      /* # of data sectors per track */
 129         unsigned short  dkg_intrlv;     /* interleave factor */
 130         unsigned short  dkg_obs2;       /* obsolete */
 131         unsigned short  dkg_obs3;       /* obsolete */
 132         unsigned short  dkg_apc;        /* alternates per cyl (SCSI only) */
 133         unsigned short  dkg_rpm;        /* revolutions per minute */
 134         unsigned short  dkg_pcyl;       /* # of physical cylinders */
 135         unsigned short  dkg_write_reinstruct;   /* # sectors to skip, writes */
 136         unsigned short  dkg_read_reinstruct;    /* # sectors to skip, reads */
 137         unsigned short  dkg_extra[7];   /* for compatible expansion */
 138 };
 139
 140 /*
 141  * These defines are for historic compatibility with old drivers.
 142  */
 143 #define dkg_bhead       dkg_obs1        /* used to be head offset */
 144 #define dkg_gap1        dkg_obs2        /* used to be gap1 */
 145 #define dkg_gap2        dkg_obs3        /* used to be gap2 */
 146
 147 /*
 148  * Disk io control commands
 149  * Warning: some other ioctls with the DIOC prefix exist elsewhere.
 150  * The Generic DKIOC numbers are from   0   -  50.
 151  *      The Floppy Driver uses          51  - 100.
 152  *      The Hard Disk (except SCSI)     101 - 106.      (these are obsolete)
 153  *      The CDROM Driver                151 - 200.
 154  *      The USCSI ioctl                 201 - 250.
 155  */
 156 #define DKIOC           (0x04 << 8)
 157
 158 /*
 159  * The following ioctls are generic in nature and need to be
 160  * suported as appropriate by all disk drivers
 161  */
 162 #define DKIOCGGEOM      (DKIOC|1)               /* Get geometry */
 163 #define DKIOCINFO       (DKIOC|3)               /* Get info */
 164 #define DKIOCEJECT      (DKIOC|6)               /* Generic 'eject' */
 165 #define DKIOCGVTOC      (DKIOC|11)              /* Get VTOC */
 166 #define DKIOCSVTOC      (DKIOC|12)              /* Set VTOC & Write to Disk */
 167
 168 #define DKIOCGEXTVTOC   (DKIOC|23)      /* Get extended VTOC */
 169 #define DKIOCSEXTVTOC   (DKIOC|24)      /* Set extended VTOC, Write to Disk */
 170
 171 /*
 172  * Disk Cache Controls.  These ioctls should be supported by
 173  * all disk drivers.
 174  *
 175  * DKIOCFLUSHWRITECACHE when used from user-mode ignores the ioctl
 176  * argument, but it should be passed as NULL to allow for future
 177  * reinterpretation.  From user-mode, this ioctl request is synchronous.
 178  *
 179  * When invoked from within the kernel, the arg can be NULL to indicate
 180  * a synchronous request or can be the address of a struct dk_callback
 181  * to request an asynchronous callback when the flush request is complete.
 182  * In this case, the flag to the ioctl must include FKIOCTL and the
 183  * dkc_callback field of the pointed to struct must be non-null or the
 184  * request is made synchronously.
 185  *
 186  * In the callback case: if the ioctl returns 0, a callback WILL be performed.
 187  * If the ioctl returns non-zero, a callback will NOT be performed.
 188  * NOTE: In some cases, the callback may be done BEFORE the ioctl call
 189  * returns.  The caller's locking strategy should be prepared for this case.
 190  */
 191 #define DKIOCFLUSHWRITECACHE    (DKIOC|34)      /* flush cache to phys medium */
 192
 193 struct dk_callback {
 194         void (*dkc_callback)(void *dkc_cookie, int error);
 195         void *dkc_cookie;
 196         int dkc_flag;
 197 };
 198
 199 /* bit flag definitions for dkc_flag */
 200 #define FLUSH_VOLATILE          0x1     /* Bit 0: if set, only flush */
 201                                         /* volatile cache; otherwise, flush */
 202                                         /* volatile and non-volatile cache */
 203
 204 #define DKIOCGETWCE             (DKIOC|36)      /* Get current write cache */
 205                                                 /* enablement status */
 206 #define DKIOCSETWCE             (DKIOC|37)      /* Enable/Disable write cache */
 207
 208 /*
 209  * The following ioctls are used by Sun drivers to communicate
 210  * with their associated format routines. Support of these ioctls
 211  * is not required of foreign drivers
 212  */
 213 #define DKIOCSGEOM      (DKIOC|2)               /* Set geometry */
 214 #define DKIOCSAPART     (DKIOC|4)               /* Set all partitions */
 215 #define DKIOCGAPART     (DKIOC|5)               /* Get all partitions */
 216 #define DKIOCG_PHYGEOM  (DKIOC|32)              /* get physical geometry */
 217 #define DKIOCG_VIRTGEOM (DKIOC|33)              /* get virtual geometry */
 218
 219 /*
 220  * The following ioctl's are removable media support
 221  */
 222 #define DKIOCLOCK       (DKIOC|7)       /* Generic 'lock' */
 223 #define DKIOCUNLOCK     (DKIOC|8)       /* Generic 'unlock' */
 224 #define DKIOCSTATE      (DKIOC|13)      /* Inquire insert/eject state */
 225 #define DKIOCREMOVABLE  (DKIOC|16)      /* is media removable */
 226
 227
 228 /*
 229  * ioctl for hotpluggable devices
 230  */
 231 #define DKIOCHOTPLUGGABLE       (DKIOC|35)      /* is hotpluggable */
 232
 233 /*
 234  * Ioctl to force driver to re-read the alternate partition and rebuild
 235  * the internal defect map.
 236  */
 237 #define DKIOCADDBAD     (DKIOC|20)      /* Re-read the alternate map (IDE) */
 238 #define DKIOCGETDEF     (DKIOC|21)      /* read defect list (IDE)          */
 239
 240 /*
 241  * Used by applications to get disk defect information from IDE
 242  * drives.
 243  */
 244 #ifdef _SYSCALL32
 245 struct defect_header32 {
 246         int             head;
 247         caddr32_t       buffer;
 248 };
 249 #endif /* _SYSCALL32 */
 250
 251 struct defect_header {
 252         int             head;
 253         caddr_t         buffer;
 254 };
 255
 256 #define DKIOCPARTINFO   (DKIOC|22)      /* Get partition or slice parameters */
 257 #define DKIOCEXTPARTINFO (DKIOC|19)     /* Get extended partition or slice */
 258                                         /* parameters */
 259
 260
 261 /*
 262  * Used by applications to get partition or slice information
 263  */
 264 #ifdef _SYSCALL32
 265 struct part_info32 {
 266         daddr32_t       p_start;
 267         int             p_length;
 268 };
 269 #endif /* _SYSCALL32 */
 270
 271 struct part_info {
 272         daddr_t         p_start;
 273         int             p_length;
 274 };
 275
 276 struct extpart_info {
 277         diskaddr_t      p_start;
 278         diskaddr_t      p_length;
 279 };
 280
 281 /* The following ioctls are for Optical Memory Device */
 282 #define DKIOC_EBP_ENABLE  (DKIOC|40)    /* enable by pass erase on write */
 283 #define DKIOC_EBP_DISABLE (DKIOC|41)    /* disable by pass erase on write */
 284
 285 /*
 286  * This state enum is the argument passed to the DKIOCSTATE ioctl.
 287  */
 288 enum dkio_state { DKIO_NONE, DKIO_EJECTED, DKIO_INSERTED, DKIO_DEV_GONE };
 289
 290 #define DKIOCGMEDIAINFO (DKIOC|42)      /* get information about the media */
 291
 292 /*
 293  * ioctls to read/write mboot info.
 294  */
 295 #define DKIOCGMBOOT     (DKIOC|43)      /* get mboot info */
 296 #define DKIOCSMBOOT     (DKIOC|44)      /* set mboot info */
 297
 298 /*
 299  * ioctl to get the device temperature.
 300  */
 301 #define DKIOCGTEMPERATURE       (DKIOC|45)      /* get temperature */
 302
 303 /*
 304  * Used for providing the temperature.
 305  */
 306
 307 struct  dk_temperature  {
 308         uint_t          dkt_flags;      /* Flags */
 309         short           dkt_cur_temp;   /* Current disk temperature */
 310         short           dkt_ref_temp;   /* reference disk temperature */
 311 };
 312
 313 #define DKT_BYPASS_PM           0x1
 314 #define DKT_INVALID_TEMP        0xFFFF
 315
 316
 317 /*
 318  * Used for Media info or the current profile info
 319  */
 320 struct dk_minfo {
 321         uint_t          dki_media_type; /* Media type or profile info */
 322         uint_t          dki_lbsize;     /* Logical blocksize of media */
 323         diskaddr_t      dki_capacity;   /* Capacity as # of dki_lbsize blks */
 324 };
 325
 326 /*
 327  * Media types or profiles known
 328  */
 329 #define DK_UNKNOWN              0x00    /* Media inserted - type unknown */
 330
 331
 332 /*
 333  * SFF 8090 Specification Version 3, media types 0x01 - 0xfffe are retained to
 334  * maintain compatibility with SFF8090.  The following define the
 335  * optical media type.
 336  */
 337 #define DK_REMOVABLE_DISK       0x02 /* Removable Disk */
 338 #define DK_MO_ERASABLE          0x03 /* MO Erasable */
 339 #define DK_MO_WRITEONCE         0x04 /* MO Write once */
 340 #define DK_AS_MO                0x05 /* AS MO */
 341 #define DK_CDROM                0x08 /* CDROM */
 342 #define DK_CDR                  0x09 /* CD-R */
 343 #define DK_CDRW                 0x0A /* CD-RW */
 344 #define DK_DVDROM               0x10 /* DVD-ROM */
 345 #define DK_DVDR                 0x11 /* DVD-R */
 346 #define DK_DVDRAM               0x12 /* DVD_RAM or DVD-RW */
 347
 348 /*
 349  * Media types for other rewritable magnetic media
 350  */
 351 #define DK_FIXED_DISK           0x10001 /* Fixed disk SCSI or otherwise */
 352 #define DK_FLOPPY               0x10002 /* Floppy media */
 353 #define DK_ZIP                  0x10003 /* IOMEGA ZIP media */
 354 #define DK_JAZ                  0x10004 /* IOMEGA JAZ media */
 355
 356 #define DKIOCSETEFI     (DKIOC|17)              /* Set EFI info */
 357 #define DKIOCGETEFI     (DKIOC|18)              /* Get EFI info */
 358
 359 #define DKIOCPARTITION  (DKIOC|9)               /* Get partition info */
 360
 361 /*
 362  * Ioctls to get/set volume capabilities related to Logical Volume Managers.
 363  * They include the ability to get/set capabilities and to issue a read to a
 364  * specific underlying device of a replicated device.
 365  */
 366
 367 #define DKIOCGETVOLCAP  (DKIOC | 25)    /* Get volume capabilities */
 368 #define DKIOCSETVOLCAP  (DKIOC | 26)    /* Set volume capabilities */
 369 #define DKIOCDMR        (DKIOC | 27)    /* Issue a directed read */
 370
 371 #define DKIOCDUMPINIT   (DKIOC | 28)    /* Dumpify a zvol */
 372 #define DKIOCDUMPFINI   (DKIOC | 29)    /* Un-Dumpify a zvol */
 373
 374 typedef uint_t volcapinfo_t;
 375
 376 typedef uint_t volcapset_t;
 377
 378 #define DKV_ABR_CAP 0x00000001          /* Support Appl.Based Recovery */
 379 #define DKV_DMR_CAP 0x00000002          /* Support Directed  Mirror Read */
 380
 381 typedef struct volcap {
 382         volcapinfo_t vc_info;   /* Capabilities available */
 383         volcapset_t vc_set;     /* Capabilities set */
 384 } volcap_t;
 385
 386 #define VOL_SIDENAME 256
 387
 388 typedef struct vol_directed_rd {
 389         int             vdr_flags;
 390         offset_t        vdr_offset;
 391         size_t          vdr_nbytes;
 392         size_t          vdr_bytesread;
 393         void            *vdr_data;
 394         int             vdr_side;
 395         char            vdr_side_name[VOL_SIDENAME];
 396 } vol_directed_rd_t;
 397
 398 #define DKV_SIDE_INIT           (-1)
 399 #define DKV_DMR_NEXT_SIDE       0x00000001
 400 #define DKV_DMR_DONE            0x00000002
 401 #define DKV_DMR_ERROR           0x00000004
 402 #define DKV_DMR_SUCCESS         0x00000008
 403 #define DKV_DMR_SHORT           0x00000010
 404
 405 #ifdef _MULTI_DATAMODEL
 406 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
 407 #pragma pack(4)
 408 #endif
 409 typedef struct vol_directed_rd32 {
 410         int32_t         vdr_flags;
 411         offset_t        vdr_offset;     /* 64-bit element on 32-bit alignment */
 412         size32_t        vdr_nbytes;
 413         size32_t        vdr_bytesread;
 414         caddr32_t       vdr_data;
 415         int32_t         vdr_side;
 416         char            vdr_side_name[VOL_SIDENAME];
 417 } vol_directed_rd32_t;
 418 #if _LONG_LONG_ALIGNMENT == 8 && _LONG_LONG_ALIGNMENT_32 == 4
 419 #pragma pack()
 420 #endif
 421 #endif  /* _MULTI_DATAMODEL */
 422
 423 /*
 424  * The ioctl is used to fetch disk's device type, vendor ID,
 425  * model number/product ID, firmware revision and serial number together.
 426  *
 427  * Currently there are two device types - DKD_ATA_TYPE which means the
 428  * disk is driven by cmdk/ata or dad/uata driver, and DKD_SCSI_TYPE
 429  * which means the disk is driven by sd/scsi hba driver.
 430  */
 431 #define DKIOC_GETDISKID (DKIOC|46)
 432
 433 /* These two labels are for dkd_dtype of dk_disk_id_t */
 434 #define DKD_ATA_TYPE    0x01 /* ATA disk or legacy mode SATA disk */
 435 #define DKD_SCSI_TYPE   0x02 /* SCSI disk or native mode SATA disk */
 436
 437 #define DKD_ATA_MODEL   40      /* model number length */
 438 #define DKD_ATA_FWVER   8       /* firmware revision length */
 439 #define DKD_ATA_SERIAL  20      /* serial number length */
 440
 441 #define DKD_SCSI_VENDOR 8       /* vendor ID length */
 442 #define DKD_SCSI_PRODUCT 16     /* product ID length */
 443 #define DKD_SCSI_REVLEVEL 4     /* revision level length */
 444 #define DKD_SCSI_SERIAL 12      /* serial number length */
 445
 446 /*
 447  * The argument type for DKIOC_GETDISKID ioctl.
 448  */
 449 typedef struct dk_disk_id {
 450         uint_t  dkd_dtype;
 451         union {
 452                 struct {
 453                         char dkd_amodel[DKD_ATA_MODEL];         /* 40 bytes */
 454                         char dkd_afwver[DKD_ATA_FWVER];         /* 8 bytes */
 455                         char dkd_aserial[DKD_ATA_SERIAL];       /* 20 bytes */
 456                 } ata_disk_id;
 457                 struct {
 458                         char dkd_svendor[DKD_SCSI_VENDOR];      /* 8 bytes */
 459                         char dkd_sproduct[DKD_SCSI_PRODUCT];    /* 16 bytes */
 460                         char dkd_sfwver[DKD_SCSI_REVLEVEL];     /* 4 bytes */
 461                         char dkd_sserial[DKD_SCSI_SERIAL];      /* 12 bytes */
 462                 } scsi_disk_id;
 463         } disk_id;
 464 } dk_disk_id_t;
 465
 466 /*
 467  * The ioctl is used to update the firmware of device.
 468  */
 469 #define DKIOC_UPDATEFW          (DKIOC|47)
 470
 471 /* The argument type for DKIOC_UPDATEFW ioctl */
 472 typedef struct dk_updatefw {
 473         caddr_t         dku_ptrbuf;     /* pointer to firmware buf */
 474         uint_t          dku_size;       /* firmware buf length */
 475         uint8_t         dku_type;       /* firmware update type */
 476 } dk_updatefw_t;
 477
 478 #ifdef _SYSCALL32
 479 typedef struct dk_updatefw_32 {
 480         caddr32_t       dku_ptrbuf;     /* pointer to firmware buf */
 481         uint_t          dku_size;       /* firmware buf length */
 482         uint8_t         dku_type;       /* firmware update type */
 483 } dk_updatefw_32_t;
 484 #endif /* _SYSCALL32 */
 485
 486 /*
 487  * firmware update type - temporary or permanent use
 488  */
 489 #define FW_TYPE_TEMP    0x0             /* temporary use */
 490 #define FW_TYPE_PERM    0x1             /* permanent use */
 491
 492
 493 #ifdef  __cplusplus
 494 }
 495 #endif
 496
 497 #endif /* _SYS_DKIO_H */