bsd/sys/disklabel.h

   1 /*
   2  * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1987, 1988, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms, with or without
  34  * modification, are permitted provided that the following conditions
  35  * are met:
  36  * 1. Redistributions of source code must retain the above copyright
  37  *    notice, this list of conditions and the following disclaimer.
  38  * 2. Redistributions in binary form must reproduce the above copyright
  39  *    notice, this list of conditions and the following disclaimer in the
  40  *    documentation and/or other materials provided with the distribution.
  41  * 3. All advertising materials mentioning features or use of this software
  42  *    must display the following acknowledgement:
  43  *      This product includes software developed by the University of
  44  *      California, Berkeley and its contributors.
  45  * 4. Neither the name of the University nor the names of its contributors
  46  *    may be used to endorse or promote products derived from this software
  47  *    without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  50  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  53  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  54  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  55  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  56  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  57  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  58  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  59  * SUCH DAMAGE.
  60  *
  61  *      @(#)disklabel.h 8.2 (Berkeley) 7/10/94
  62  */
  63 #ifndef _SYS_DISKLABEL_H_
  64 #define _SYS_DISKLABEL_H_
  65
  66 #include <sys/appleapiopts.h>
  67 #include <sys/types.h>          /* for daddr_t */
  68
  69 #ifdef __APPLE_API_OBSOLETE
  70
  71 /*
  72  * Disk description table, see disktab(5)
  73  */
  74 #define _PATH_DISKTAB   "/etc/disktab"
  75 #define DISKTAB         "/etc/disktab"          /* deprecated */
  76
  77 /*
  78  * Each disk has a label which includes information about the hardware
  79  * disk geometry, filesystem partitions, and drive specific information.
  80  * The location of the label, as well as the number of partitions the
  81  * label can describe and the number of the "whole disk" (raw)
  82  * paritition are machine dependent.
  83  */
  84 #include <machine/disklabel.h>
  85
  86 /*
  87  * The absolute maximum number of disk partitions allowed.
  88  * This is the maximum value of MAXPARTITIONS for which 'struct disklabel'
  89  * is <= DEV_BSIZE bytes long.  If MAXPARTITIONS is greater than this, beware.
  90  */
  91 #define MAXMAXPARTITIONS        22
  92 #if MAXPARTITIONS > MAXMAXPARTITIONS
  93 #warning beware: MAXPARTITIONS bigger than MAXMAXPARTITIONS
  94 #endif
  95
  96 /*
  97  * Translate between device numbers and major/disk unit/disk partition.
  98  */
  99 #define DISKUNIT(dev)   (minor(dev) / MAXPARTITIONS)
 100 #define DISKPART(dev)   (minor(dev) % MAXPARTITIONS)
 101 #define MAKEDISKDEV(maj, unit, part) \
 102     (makedev((maj), ((unit) * MAXPARTITIONS) + (part)))
 103
 104 #define DISKMAGIC       ((u_int32_t)0x82564557) /* The disk magic number */
 105
 106 #ifndef LOCORE
 107 struct disklabel {
 108         u_int32_t d_magic;              /* the magic number */
 109         u_int16_t d_type;               /* drive type */
 110         u_int16_t d_subtype;            /* controller/d_type specific */
 111         char      d_typename[16];       /* type name, e.g. "eagle" */
 112
 113         /*
 114          * d_packname contains the pack identifier and is returned when
 115          * the disklabel is read off the disk or in-core copy.
 116          * d_boot0 and d_boot1 are the (optional) names of the
 117          * primary (block 0) and secondary (block 1-15) bootstraps
 118          * as found in /usr/mdec.  These are returned when using
 119          * getdiskbyname(3) to retrieve the values from /etc/disktab.
 120          */
 121         union {
 122                 char    un_d_packname[16];      /* pack identifier */
 123                 struct {
 124                         char *un_d_boot0;       /* primary bootstrap name */
 125                         char *un_d_boot1;       /* secondary bootstrap name */
 126                 } un_b;
 127         } d_un;
 128 #define d_packname      d_un.un_d_packname
 129 #define d_boot0         d_un.un_b.un_d_boot0
 130 #define d_boot1         d_un.un_b.un_d_boot1
 131
 132                         /* disk geometry: */
 133         u_int32_t d_secsize;            /* # of bytes per sector */
 134         u_int32_t d_nsectors;           /* # of data sectors per track */
 135         u_int32_t d_ntracks;            /* # of tracks per cylinder */
 136         u_int32_t d_ncylinders;         /* # of data cylinders per unit */
 137         u_int32_t d_secpercyl;          /* # of data sectors per cylinder */
 138         u_int32_t d_secperunit;         /* # of data sectors per unit */
 139
 140         /*
 141          * Spares (bad sector replacements) below are not counted in
 142          * d_nsectors or d_secpercyl.  Spare sectors are assumed to
 143          * be physical sectors which occupy space at the end of each
 144          * track and/or cylinder.
 145          */
 146         u_int16_t d_sparespertrack;     /* # of spare sectors per track */
 147         u_int16_t d_sparespercyl;       /* # of spare sectors per cylinder */
 148         /*
 149          * Alternate cylinders include maintenance, replacement, configuration
 150          * description areas, etc.
 151          */
 152         u_int32_t d_acylinders;         /* # of alt. cylinders per unit */
 153
 154                         /* hardware characteristics: */
 155         /*
 156          * d_interleave, d_trackskew and d_cylskew describe perturbations
 157          * in the media format used to compensate for a slow controller.
 158          * Interleave is physical sector interleave, set up by the
 159          * formatter or controller when formatting.  When interleaving is
 160          * in use, logically adjacent sectors are not physically
 161          * contiguous, but instead are separated by some number of
 162          * sectors.  It is specified as the ratio of physical sectors
 163          * traversed per logical sector.  Thus an interleave of 1:1
 164          * implies contiguous layout, while 2:1 implies that logical
 165          * sector 0 is separated by one sector from logical sector 1.
 166          * d_trackskew is the offset of sector 0 on track N relative to
 167          * sector 0 on track N-1 on the same cylinder.  Finally, d_cylskew
 168          * is the offset of sector 0 on cylinder N relative to sector 0
 169          * on cylinder N-1.
 170          */
 171         u_int16_t d_rpm;                /* rotational speed */
 172         u_int16_t d_interleave;         /* hardware sector interleave */
 173         u_int16_t d_trackskew;          /* sector 0 skew, per track */
 174         u_int16_t d_cylskew;            /* sector 0 skew, per cylinder */
 175         u_int32_t d_headswitch;         /* head switch time, usec */
 176         u_int32_t d_trkseek;            /* track-to-track seek, usec */
 177         u_int32_t d_flags;              /* generic flags */
 178 #define NDDATA 5
 179         u_int32_t d_drivedata[NDDATA];  /* drive-type specific information */
 180 #define NSPARE 5
 181         u_int32_t d_spare[NSPARE];      /* reserved for future use */
 182         u_int32_t d_magic2;             /* the magic number (again) */
 183         u_int16_t d_checksum;           /* xor of data incl. partitions */
 184
 185                         /* filesystem and partition information: */
 186         u_int16_t d_npartitions;        /* number of partitions in following */
 187         u_int32_t d_bbsize;             /* size of boot area at sn0, bytes */
 188         u_int32_t d_sbsize;             /* max size of fs superblock, bytes */
 189         struct  partition {             /* the partition table */
 190                 u_int32_t p_size;       /* number of sectors in partition */
 191                 u_int32_t p_offset;     /* starting sector */
 192                 u_int32_t p_fsize;      /* filesystem basic fragment size */
 193                 u_int8_t p_fstype;      /* filesystem type, see below */
 194                 u_int8_t p_frag;        /* filesystem fragments per block */
 195                 union {
 196                         u_int16_t cpg;  /* UFS: FS cylinders per group */
 197                         u_int16_t sgs;  /* LFS: FS segment shift */
 198                 } __partition_u1;
 199 #define p_cpg   __partition_u1.cpg
 200 #define p_sgs   __partition_u1.sgs
 201         } d_partitions[MAXPARTITIONS];  /* actually may be more */
 202 };
 203 #else /* LOCORE */
 204         /*
 205          * offsets for asm boot files.
 206          */
 207         .set    d_secsize,40
 208         .set    d_nsectors,44
 209         .set    d_ntracks,48
 210         .set    d_ncylinders,52
 211         .set    d_secpercyl,56
 212         .set    d_secperunit,60
 213         .set    d_end_,276              /* size of disk label */
 214 #endif /* LOCORE */
 215
 216 /* d_type values: */
 217 #define DTYPE_SMD               1               /* SMD, XSMD; VAX hp/up */
 218 #define DTYPE_MSCP              2               /* MSCP */
 219 #define DTYPE_DEC               3               /* other DEC (rk, rl) */
 220 #define DTYPE_SCSI              4               /* SCSI */
 221 #define DTYPE_ESDI              5               /* ESDI interface */
 222 #define DTYPE_ST506             6               /* ST506 etc. */
 223 #define DTYPE_HPIB              7               /* CS/80 on HP-IB */
 224 #define DTYPE_HPFL              8               /* HP Fiber-link */
 225 #define DTYPE_FLOPPY            10              /* floppy */
 226
 227 #ifdef DKTYPENAMES
 228 static const char *dktypenames[] = {
 229         "unknown",
 230         "SMD",
 231         "MSCP",
 232         "old DEC",
 233         "SCSI",
 234         "ESDI",
 235         "ST506",
 236         "HP-IB",
 237         "HP-FL",
 238         "type 9",
 239         "floppy",
 240         NULL
 241 };
 242 #define DKMAXTYPES      (sizeof(dktypenames) / sizeof(dktypenames[0]) - 1)
 243 #endif
 244
 245 /*
 246  * Filesystem type and version.
 247  * Used to interpret other filesystem-specific
 248  * per-partition information.
 249  */
 250 #define FS_UNUSED       0               /* unused */
 251 #define FS_SWAP         1               /* swap */
 252 #define FS_V6           2               /* Sixth Edition */
 253 #define FS_V7           3               /* Seventh Edition */
 254 #define FS_SYSV         4               /* System V */
 255 #define FS_V71K         5               /* V7 with 1K blocks (4.1, 2.9) */
 256 #define FS_V8           6               /* Eighth Edition, 4K blocks */
 257 #define FS_BSDFFS       7               /* 4.2BSD fast file system */
 258 #define FS_MSDOS        8               /* MSDOS file system */
 259 #define FS_BSDLFS       9               /* 4.4BSD log-structured file system */
 260 #define FS_OTHER        10              /* in use, but unknown/unsupported */
 261 #define FS_HPFS         11              /* OS/2 high-performance file system */
 262 #define FS_ISO9660      12              /* ISO 9660, normally CD-ROM */
 263 #define FS_BOOT         13              /* partition contains bootstrap */
 264 #define FS_ADOS         14              /* AmigaDOS fast file system */
 265 #define FS_HFS          15              /* Macintosh HFS */
 266
 267 #ifdef  DKTYPENAMES
 268 static const char *fstypenames[] = {
 269         "unused",
 270         "swap",
 271         "Version 6",
 272         "Version 7",
 273         "System V",
 274         "4.1BSD",
 275         "Eighth Edition",
 276         "4.2BSD",
 277         "MSDOS",
 278         "4.4LFS",
 279         "unknown",
 280         "HPFS",
 281         "ISO9660",
 282         "boot",
 283         "ADOS",
 284         "HFS",
 285         NULL
 286 };
 287 #define FSMAXTYPES      (sizeof(fstypenames) / sizeof(fstypenames[0]) - 1)
 288 #endif
 289
 290 /*
 291  * flags shared by various drives:
 292  */
 293 #define         D_REMOVABLE     0x01            /* removable media */
 294 #define         D_ECC           0x02            /* supports ECC */
 295 #define         D_BADSECT       0x04            /* supports bad sector forw. */
 296 #define         D_RAMDISK       0x08            /* disk emulator */
 297 #define         D_CHAIN         0x10            /* can do back-back transfers */
 298
 299 /*
 300  * Drive data for SMD.
 301  */
 302 #define d_smdflags      d_drivedata[0]
 303 #define         D_SSE           0x1             /* supports skip sectoring */
 304 #define d_mindist       d_drivedata[1]
 305 #define d_maxdist       d_drivedata[2]
 306 #define d_sdist         d_drivedata[3]
 307
 308 /*
 309  * Drive data for ST506.
 310  */
 311 #define d_precompcyl    d_drivedata[0]
 312 #define d_gap3          d_drivedata[1]          /* used only when formatting */
 313
 314 /*
 315  * Drive data for SCSI.
 316  */
 317 #define d_blind         d_drivedata[0]
 318
 319 #ifndef LOCORE
 320 /*
 321  * Structure used to perform a format or other raw operation, returning
 322  * data and/or register values.  Register identification and format
 323  * are device- and driver-dependent.
 324  */
 325 struct format_op {
 326         char    *df_buf;
 327         int      df_count;              /* value-result */
 328         daddr_t  df_startblk;
 329         int      df_reg[8];             /* result */
 330 };
 331
 332 /*
 333  * Structure used internally to retrieve information about a partition
 334  * on a disk.
 335  */
 336 struct partinfo {
 337         struct disklabel *disklab;
 338         struct partition *part;
 339 };
 340
 341 /*
 342  * Disk-specific ioctls.
 343  */
 344                 /* get and set disklabel; DIOCGPART used internally */
 345 #define DIOCGDINFO      _IOR('d', 101, struct disklabel)/* get */
 346 #define DIOCSDINFO      _IOW('d', 102, struct disklabel)/* set */
 347 #define DIOCWDINFO      _IOW('d', 103, struct disklabel)/* set, update disk */
 348 #define DIOCGPART       _IOW('d', 104, struct partinfo) /* get partition */
 349
 350 /* do format operation, read or write */
 351 #define DIOCRFORMAT     _IOWR('d', 105, struct format_op)
 352 #define DIOCWFORMAT     _IOWR('d', 106, struct format_op)
 353
 354 #define DIOCSSTEP       _IOW('d', 107, int)     /* set step rate */
 355 #define DIOCSRETRIES    _IOW('d', 108, int)     /* set # of retries */
 356 #define DIOCWLABEL      _IOW('d', 109, int)     /* write en/disable label */
 357
 358 #define DIOCSBAD        _IOW('d', 110, struct dkbad)    /* set kernel dkbad */
 359
 360 #endif /* LOCORE */
 361
 362 #if !defined(KERNEL) && !defined(LOCORE)
 363
 364 #include <sys/cdefs.h>
 365
 366 __BEGIN_DECLS
 367 struct disklabel *getdiskbyname(const char *);
 368 __END_DECLS
 369
 370 #endif
 371
 372 #endif /* __APPLE_API_OBSOLETE */
 373
 374 #endif /* ! _SYS_DISKLABEL_H_ */
 375