share/man/man4/intro.4

   1 .\"
   2 .\" Copyright (c) 1996 David E. O'Brien, Joerg Wunsch
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd January 20, 1996
  29 .Dt INTRO 4
  30 .Os
  31 .Sh NAME
  32 .Nm intro
  33 .Nd introduction to devices and device drivers
  34 .Sh DESCRIPTION
  35 This section contains information related to devices, device drivers
  36 and miscellaneous hardware.
  37 .Ss The device abstraction
  38 Device is a term used mostly for hardware-related stuff that belongs
  39 to the system, like disks, printers, or a graphics display with its
  40 keyboard.
  41 There are also so-called
  42 .Em pseudo-devices
  43 where a device driver emulates the behaviour of a device in software
  44 without any particular underlying hardware.
  45 A typical example for
  46 the latter class is
  47 .Pa /dev/mem ,
  48 a loophole where the physical memory can be accessed using the regular
  49 file access semantics.
  50 .Pp
  51 The device abstraction generally provides a common set of system calls
  52 layered on top of them, which are dispatched to the corresponding
  53 device driver by the upper layers of the kernel.
  54 The set of system
  55 calls available for devices is chosen from
  56 .Xr open 2 ,
  57 .Xr close 2 ,
  58 .Xr read 2 ,
  59 .Xr write 2 ,
  60 .Xr ioctl 2 ,
  61 .Xr select 2 ,
  62 and
  63 .Xr mmap 2 .
  64 Not all drivers implement all system calls, for example, calling
  65 .Xr mmap 2
  66 on terminal devices is likely to be not useful at all.
  67 .Ss Accessing Devices
  68 Most of the devices in a
  69 .Ux Ns
  70 -like operating system are accessed
  71 through so-called
  72 .Em device nodes ,
  73 sometimes also called
  74 .Em special files .
  75 They are usually located under the directory
  76 .Pa /dev
  77 in the file system hierarchy
  78 (see also
  79 .Xr hier 7 ) .
  80 .Pp
  81 Note that this could lead to an inconsistent state, where either there
  82 are device nodes that do not have a configured driver associated with
  83 them, or there may be drivers that have successfully probed for their
  84 devices, but cannot be accessed since the corresponding device node is
  85 still missing.
  86 In the first case, any attempt to reference the device
  87 through the device node will result in an error, returned by the upper
  88 layers of the kernel, usually
  89 .Er ENXIO .
  90 In the second case, the device node needs to be created before the
  91 driver and its device will be usable.
  92 .Pp
  93 Some devices come in two flavors:
  94 .Em block
  95 and
  96 .Em character
  97 devices, or to use better terms, buffered and unbuffered
  98 (raw)
  99 devices.
 100 The traditional names are reflected by the letters
 101 .Ql b
 102 and
 103 .Ql c
 104 as the file type identification in the output of
 105 .Ql ls -l .
 106 Buffered devices are being accessed through the buffer cache of the
 107 operating system, and they are solely intended to layer a file system
 108 on top of them.
 109 They are normally implemented for disks and disk-like
 110 devices only and, for historical reasons, for tape devices.
 111 .Pp
 112 Raw devices are available for all drivers, including those that also
 113 implement a buffered device.
 114 For the latter group of devices, the
 115 differentiation is conventionally done by prepending the letter
 116 .Ql r
 117 to the path name of the device node, for example
 118 .Pa /dev/rda0
 119 denotes the raw device for the first SCSI disk, while
 120 .Pa /dev/da0
 121 is the corresponding device node for the buffered device.
 122 .Pp
 123 Unbuffered devices should be used for all actions that are not related
 124 to file system operations, even if the device in question is a disk
 125 device.
 126 This includes making backups of entire disk partitions, or
 127 to
 128 .Em raw
 129 floppy disks
 130 (i.e., those used like tapes).
 131 .Pp
 132 Access restrictions to device nodes are usually subject to the regular
 133 file permissions of the device node entry, instead of being enforced
 134 directly by the drivers in the kernel.
 135 .Ss Drivers without device nodes
 136 Drivers for network devices do not use device nodes in order to be
 137 accessed.
 138 Their selection is based on other decisions inside the
 139 kernel, and instead of calling
 140 .Xr open 2 ,
 141 use of a network device is generally introduced by using the system
 142 call
 143 .Xr socket 2 .
 144 .Ss Configuring a driver into the kernel
 145 For each kernel, there is a configuration file that is used as a base
 146 to select the facilities and drivers for that kernel, and to tune
 147 several options.
 148 See
 149 .Xr config 8
 150 for a detailed description of the files involved.
 151 The individual manual pages in this section provide a sample line for the
 152 configuration file in their synopsis portion.
 153 See also the sample config file
 154 .Pa /sys/i386/conf/LINT
 155 (for the
 156 .Em i386
 157 architecture).
 158 .Sh SEE ALSO
 159 .Xr close 2 ,
 160 .Xr ioctl 2 ,
 161 .Xr mmap 2 ,
 162 .Xr open 2 ,
 163 .Xr read 2 ,
 164 .Xr select 2 ,
 165 .Xr socket 2 ,
 166 .Xr write 2 ,
 167 .Xr devfs 5 ,
 168 .Xr hier 7 ,
 169 .Xr config 8
 170 .Sh HISTORY
 171 This manual page first appeared in
 172 .Fx 2.1 .
 173 .Sh AUTHORS
 174 .An -nosplit
 175 This man page has been written by
 176 .An J\(:org Wunsch
 177 with initial input by
 178 .An David E. O'Brien .