dma: rework config parsing
[dragonfly.git] / share / man / man4 / intro.4
blob2759263a1eb756ab69c0cbe8bcc2532eb2ac0170
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: src/share/man/man4/intro.4,v 1.13.2.6 2002/01/09 15:36:51 ru Exp $
27 .\" $DragonFly: src/share/man/man4/intro.4,v 1.4 2006/10/24 17:09:45 swildner Exp $
28 .\"
29 .Dd August 6, 2009
30 .Dt INTRO 4
31 .Os
32 .Sh NAME
33 .Nm intro
34 .Nd introduction to devices and device drivers
35 .Sh DESCRIPTION
36 This section contains information related to devices, device drivers
37 and miscellaneous hardware.
38 .Ss The device abstraction
39 Device is a term used mostly for hardware-related stuff that belongs
40 to the system, like disks, printers, or a graphics display with its
41 keyboard.
42 There are also so-called
43 .Em pseudo-devices
44 where a device driver emulates the behaviour of a device in software
45 without any particular underlying hardware.
46 A typical example for
47 the latter class is
48 .Pa /dev/mem ,
49 a loophole where the physical memory can be accessed using the regular
50 file access semantics.
51 .Pp
52 The device abstraction generally provides a common set of system calls
53 layered on top of them, which are dispatched to the corresponding
54 device driver by the upper layers of the kernel.
55 The set of system
56 calls available for devices is chosen from
57 .Xr open 2 ,
58 .Xr close 2 ,
59 .Xr read 2 ,
60 .Xr write 2 ,
61 .Xr ioctl 2 ,
62 .Xr select 2 ,
63 and
64 .Xr mmap 2 .
65 Not all drivers implement all system calls, for example, calling
66 .Xr mmap 2
67 on terminal devices is likely to be not useful at all.
68 .Ss Accessing Devices
69 Most of the devices in a unix-like operating system are accessed
70 through so-called
71 .Em device nodes ,
72 sometimes also called
73 .Em special files .
74 They are usually located under the directory
75 .Pa /dev
76 in the file system hierarchy
77 (see also
78 .Xr hier 7 ) .
79 .Pp
80 Some devices come in two flavors:
81 .Em block
82 and
83 .Em character
84 devices, or to use better terms, buffered and unbuffered
85 (raw)
86 devices.
87 The traditional names are reflected by the letters
88 .Ql b
89 and
90 .Ql c
91 as the file type identification in the output of
92 .Ql ls -l .
93 Buffered devices are being accessed through the buffer cache of the
94 operating system, and they are solely intended to layer a file system
95 on top of them.
96 They are normally implemented for disks and disk-like
97 devices only and, for historical reasons, for tape devices.
98 .Pp
99 Raw devices are available for all drivers, including those that also
100 implement a buffered device.
101 For the latter group of devices, the
102 differentiation is conventionally done by prepending the letter
103 .Ql r
104 to the path name of the device node, for example
105 .Pa /dev/rda0
106 denotes the raw device for the first SCSI disk, while
107 .Pa /dev/da0
108 is the corresponding device node for the buffered device.
110 Unbuffered devices should be used for all actions that are not related
111 to file system operations, even if the device in question is a disk
112 device.
113 This includes making backups of entire disk partitions, or
115 .Em raw
116 floppy disks
117 (i.e. those used like tapes).
119 Access restrictions to device nodes are usually subject to the regular
120 file permissions of the device node entry, instead of being enforced
121 directly by the drivers in the kernel.
122 .Ss Drivers without device nodes
123 Drivers for network devices do not use device nodes in order to be
124 accessed.
125 Their selection is based on other decisions inside the
126 kernel, and instead of calling
127 .Xr open 2 ,
128 use of a network device is generally introduced by using the system
129 call
130 .Xr socket 2 .
131 .Ss Configuring a driver into the kernel
132 For each kernel, there is a configuration file that is used as a base
133 to select the facilities and drivers for that kernel, and to tune
134 several options.
136 .Xr config 8
137 for a detailed description of the files involved.
138 The individual manual pages in this section provide a sample line for the
139 configuration file in their synopsis portion.  See also the sample
140 config file
141 .Pa /sys/config/LINT
142 (for the
143 .Em i386
144 architecture).
145 .Sh SEE ALSO
146 .Xr close 2 ,
147 .Xr ioctl 2 ,
148 .Xr mmap 2 ,
149 .Xr open 2 ,
150 .Xr read 2 ,
151 .Xr select 2 ,
152 .Xr socket 2 ,
153 .Xr write 2 ,
154 .Xr hier 7 ,
155 .Xr config 8
156 .Sh HISTORY
159 manual page first appeared in
160 .Fx 2.1 .
161 .Sh AUTHORS
162 .An -nosplit
163 This man page was written by
164 .An J\(:org Wunsch
165 with initial input by
166 .An David E. O'Brien .