bsd/sys/disklabel.h

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