Move primary cache code to libminixfs.

[minix.git] / man / man4 / controller.4

.TH CONTROLLER 4
.SH NAME
controller, disk, tape, at, bios, esdi, aha1540, ncr810, dosfile, fatfile \- controllers, disks and tapes
.SH DESCRIPTION
.de SP
.if t .sp 0.4
.if n .sp
..
The
.BI c n *
family of devices refer to drivers that control disks, disk like devices,
and tapes.  MINIX 3 contains a number of drivers for several different
controllers.  These controllers can have disks, cdroms and tapes attached to
them.  Boot Monitor variables specify which drivers are activated using
the variables
.BR c0 ,
.BR c1 ,
etc.  The names of the devices in
.BR /dev
that correspond with the driver for controller 0 are all named beginning
with
.BR c0 .
.PP
For each controller, the minor device numbers are organized as follows:
.PP
.RS
.nf
.ta +\w'122-127nnmm'u +\w'd0p0s0nnmm'u +\w'disk 0, part 0, subpart 0nnmm'u
.ft B
minor   device  what?   obsolete
.ft P
0       d0      disk 0  hd0
1       d0p0    disk 0, partition 0     hd1
2       d0p1    disk 0, partition 1     hd2
3       d0p2    disk 0, partition 2     hd3
4       d0p3    disk 0, partition 3     hd4
5       d1      disk 1  hd5
6       d1p0    disk 1, partition 0     hd6
7       d1p1    disk 1, partition 1     hd7
8       d1p2    disk 1, partition 2     hd8
9       d1p3    disk 1, partition 3     hd9
\&...   ...
39      d7p3    disk 7, partition 3     hd39
.SP
64      t0n     tape 0, non-rewinding
65      t0      tape 0, rewind on close
66      t1n     tape 1, non-rewinding
67      t1      tape 1, rewind on close
\&...   ...
78      t7n     tape 7, non-rewinding
79      t7      tape 7, rewind on close
.SP
120     r0      raw access device 0
121     r1      raw access device 1
\&...   ...
127     r7      raw access device 7
.SP
128     d0p0s0  disk 0, part 0, subpart 0       hd1a
129     d0p0s1  disk 0, part 0, subpart 1       hd1b
130     d0p0s2  disk 0, part 0, subpart 2       hd1c
131     d0p0s3  disk 0, part 0, subpart 3       hd1d
132     d0p1s0  disk 0, part 1, subpart 0       hd2a
\&...   ...
144     d1p0s0  disk 1, part 0, subpart 0       hd6a
\&...   ...
255     d7p3s3  disk 7, part 3, subpart 3       hd39d
.fi
.RE
.PP
The device names in
.B /dev
also name the controller, of course, so the usual place for the MINIX 3
root device, the first subpartition of the second partition of disk 0 on
controller 0 is
.BR /dev/c0d0p1s0 .
Note that everything is numbered from 0!  The first controller is controller
0, the first disk is disk 0, etc.  So the second partition is
.BR p1 .
.PP
The fourth column in the table above shows the disk devices names that were
used by previous versions of MINIX 3 for what is now controller 0.  These
devices are no longer present in
.BR /dev .
.SS Disks
Most disks are arrays of 512 byte sectors.  The disk devices are normally
block devices, which means they are block buffered by the MINIX 3 file system
cache using 1024 byte blocks.  The FS cache allows I/O at any byte offset,
and takes care of cutting and pasting incomplete blocks together.  If one
creates a character device for a disk device, then I/O must be in multiples
of the disk block size.
.PP
For each disk there is a device that covers the entire disk, these are named
.BR c0d0 ,
.BR c0d1 ,
etc, up to
.B c0d7
for controller 0.  If a partition table is placed in the first sector of the
disk, then the disk is subdivided into regions named partitions.  Up to four
partitions may be defined, named
.BR c0d0p0
to
.BR c0d0p3
for disk 0 on controller 0.  To make things interesting you can also place a
partition table in the first sector of a MINIX 3 partition, which divides the
partition into up to four subpartitions.  Normally MINIX 3 is installed into a
single partition, with the root, /home, and /usr file systems in subpartitions.
.PP
If a partition is an extended partition then it contains a linked list of
partition tables each of which may specify a logical partition.  Up to four
of these logical partitions are presented by the driver as subpartitions of
the extended partition.
.PP
A sector containing a partition table starts with 446 bytes of boot code,
followed by four partition table entries of 16 bytes each, and ends with
the magic number 0xAA55 (little endian, so first 0x55 then 0xAA.)  Partition
table information is defined in <ibm/partition.h>:
.PP
.nf
.ta +2n +29n +37n
/* Description of entry in the partition table.  */

struct part_entry {
        unsigned char bootind;  /* boot indicator 0/ACTIVE_FLAG */
        unsigned char start_head;       /* head value for first sector  */
        unsigned char start_sec;        /* sector value + high 2 cyl bits       */
        unsigned char start_cyl;        /* low 8 cylinder bits  */
        unsigned char sysind;   /* system indicator     */
        unsigned char last_head;        /* h/s/c for the last sector    */
        unsigned char last_sec;
        unsigned char last_cyl;
        unsigned long lowsec;   /* logical first sector */
        unsigned long size;     /* size of partition in sectors */
};

.ta +24n +7n +37n
#define ACTIVE_FLAG     0x80    /* value for active in bootind field    */
#define NR_PARTITIONS   4       /* number of entries in table   */
#define PART_TABLE_OFF  0x1BE   /* offset of table in boot sector       */

/* Partition types (sysind). */
#define NO_PART 0x00    /* unused entry */
#define MINIX_PART      0x81    /* MINIX 3 partition type */
.fi
.PP
The cylinder numbers are encoded in a very strange way, bits 8 and 9 are
in the high two bits of the sector number.  The sector numbers count from 1,
not 0!  More useful are the lowsec and size fields however, they simply give
the location of the partition as an absolute sector offset and length within
the drive.
.PP
The partition table entry defined above is specific to IBM type disks.  The
device drivers use another partition entry structure to pass information on
a partition.  This is what <minix/partition.h> looks like:
.sp
.nf
.ta +2n +25n
struct partition {
        u64_t base;     /* byte offset to the partition start */
        u64_t size;     /* number of bytes in the partition */
        unsigned cylinders;     /* disk geometry for partitioning */
        unsigned heads;
        unsigned sectors;
};
.fi
.PP
The base and size fields are the byte offset and length of a partition.
The geometry of the disk is also given for the benefit of
partition table editors.  This information can be obtained from an open disk
device with the call:
.sp
.RS
.ft B
ioctl(\fIfd\fP, DIOCGETP, &\fIentry\fP);
.ft R
.RE
.sp
One can change the placement of the device to the lowsec and size fields of
.I entry
by using the
.B DIOCSETP
call instead.  Only the base and size fields are used for
.BR DIOCSETP .
.PP
The partition tables when read from disk by the driver are checked and
truncated to fit within the primary partition or drive.  The first sector
is normally left free for the partition table.
.PP
The partition tables are read when the in-use count (opens and mounts)
changes from 0 to 1.  So an idle disk is automatically repartitioned on the
next access.  This means that DIOCSETP only has effect if the disk is in
use.
.SS "Disk-like devices"
Devices like a CD-ROM are treated as read-only disks, and can be accessed
using disk devices.  A CD-ROM usually has a block size of 2048 bytes, but
the driver knows this, and allows one to read at any byte offset by reading
what isn't needed into a scratch buffer.
.SS Tapes
There are two kinds of tape devices:  Non-rewinding, and rewind-on-close.
The non-rewinding devices treat the tape as a series of files.  The
rewind-on-close devices look at the tape as a single file, and when you close
such a device the tape is told to rewind.
See
.BR mt (1),
and
.BR mtio (4)
for a description of the commands that may be sent to the tape, either from
the command prompt or from a program.
.PP
There are two kinds of tape drives:  Fixed and variable block size tape
drives.  Examples of the first kind are cartridge
tapes, with a fixed 512 bytes block size.  An Exabyte tape drive has a
variable block size, with a minimum of 1 byte and a maximum of 245760 bytes
(see the documentation of such devices.)
The maximum is truncated to 32767 bytes for Minix-86 and 61440 bytes for
Minix-vmd, because the driver can't move more bytes in a single request.
.PP
A read or write to a fixed block size tape must be a precise multiple of the
block size, any other count gives results in an I/O error.  A read from a
variable block sized tape must be large enough to accept the block that is
read, otherwise an I/O error will be returned.  A write can be any size
above the minimum, creating a block of that size.  If the write count is
larger than the maximum block size then more blocks are written until the
count becomes zero.  The last block must be larger than the minimum of
course.  (This minimum is often as small as 1 byte, as for the Exabyte.)
.PP
The
.B mt blksize
command may be used to select a fixed block size for a variable block sized
tape.  This will speed up I/O considerably for small block sizes.  (Some
systems can only use fixed mode and will write an Exabyte tape with 1024
byte blocks, which read very slow in variable mode.)
.PP
A tape is a sequence of blocks and filemarks.  A tape may be opened and
blocks may be read from it upto a filemark, after that all further reads
return 0.  After the tape is closed and reopened one can read the blocks
following the filemark if using a non-rewinding device.  This makes the tape
look like a sequence of files.
.PP
If a tape has been written to or opened in write-only mode, then a filemark
is written if the tape is closed or if a space command is issued.  No extra
filemark is written if the drive is instructed to write filemarks.
.SH DRIVERS
By setting the Boot variables
.BR c0
to
.BR c3
under MINIX 3, or
.BR c0
to
.BR c4
under Minix-vmd one attaches a set of disk and tape devices to a driver.
See
.BR boot (8)
for a list of boot variables that configure each of these drivers.
The following drivers are available:
.SS at
The standard IBM/AT disk driver that also supports IDE disks.  This is the
default driver for controller 0 on AT class machines.  (Most PCs are in that
class.)
.SS bios
A disk driver that uses BIOS calls to do disk I/O.  This is the default
driver on anything but an AT.  (Old XTs and PS/2s.)  On an XT this is the
best driver you can use, but on any other machine this driver may be
somewhat slow, because the system has to switch out of protected mode to
make a BIOS call.  On a fast enough machine with a high enough setting of
DMA_SECTORS (see
.BR config (8))
it works well enough.
.SS esdi
A hard disk driver for use on some PS/2 models.
.SS "xt \fR(MINIX 3 only)"
A hard disk driver for IBM/XT type hard disks.  Useful for old 286 based
machines that have such a disk.  On XTs you are better off with the
.B bios
driver.
.SS aha1540
A SCSI driver for the Adaptec 1540 host adapter family, which includes the
1540, 1540A, 1540B, 1540C, 1540CF, 1640, and 1740.  Also supported is the
compatible BusLogic 545.
.SS ncr810
This will eventually become a Symbios 810 SCSI driver.  (Formerly owned by
NCR.)  KJB has read the docs on this card three times, but has still done
nothing, the lazy bum.
.SS dosfile
The "DOS file as disk" driver that is used when MINIX 3 is running
under DOS.  It treats a large DOS file as a MINIX 3 disk.  Only primary
partitions are supported, there are no subpartitions.  This is the default
driver when MINIX 3 is started under DOS.
.SS fatfile
Uses a large file on a FAT file system as a disk.  It needs one of the other
disk drivers to do the actual I/O.  This driver only knows how to interpret
a FAT file system to find the file to use.  With a fast native disk driver
this driver is much faster than the
.B dosfile
driver.
.SH FILES
.TP 25
/dev/c*d*
Disks devices.
.TP
/dev/c*d*p*
Partitions.
.TP
/dev/c*d*p*s*
Subpartitions.
.TP
/dev/c*t*n, /dev/c*t*
Tapes.
.TP
/dev/c*r*
Raw access devices.
.SH "SEE ALSO"
.BR dd (1),
.BR mt (1),
.BR eject (1),
.BR ioctl (2),
.BR int64 (3),
.BR mtio (4),
.BR boot (8),
.BR config (8),
.BR monitor (8),
.BR part (8),
.BR repartition (8).
.SH BUGS
The subpartitioning is incompatible with the MS-DOS method of extended
partitions.  The latter does not map well to the sparse minor device number
space.
.PP
The primary partition table is sorted by lowsec like MS-DOS does, subpartition
tables are not.  Just think about what happens when you delete a partition in
the MS-DOS scheme.
.PP
Don't move a partition that is mounted or kept open by some process.  The
file system may write cached blocks to the new location.
.PP
The BIOS driver is not slow at all on a buffered disk.
.PP
Some IDE disks send an interrupt when they spin down under hardware power
management.  The driver acknowledges the interrupt as it is supposed to do by
reading the status register.  The disk then spins up again...  You have to
disable the spin down in the computer setup to fix the problem.
.SH AUTHOR
Kees J. Bot (kjb@cs.vu.nl)