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