bsd/sys/disklabel.h

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