bsd/sys/disklabel.h

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