Commit | Line | Data |
---|---|---|
f7f84f38 RD |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> | |
4 | ||
5 | <book id="LinuxDriversAPI"> | |
6 | <bookinfo> | |
7 | <title>Linux Device Drivers</title> | |
8 | ||
9 | <legalnotice> | |
10 | <para> | |
11 | This documentation is free software; you can redistribute | |
12 | it and/or modify it under the terms of the GNU General Public | |
13 | License as published by the Free Software Foundation; either | |
14 | version 2 of the License, or (at your option) any later | |
15 | version. | |
16 | </para> | |
17 | ||
18 | <para> | |
19 | This program is distributed in the hope that it will be | |
20 | useful, but WITHOUT ANY WARRANTY; without even the implied | |
21 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
22 | See the GNU General Public License for more details. | |
23 | </para> | |
24 | ||
25 | <para> | |
26 | You should have received a copy of the GNU General Public | |
27 | License along with this program; if not, write to the Free | |
28 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | |
29 | MA 02111-1307 USA | |
30 | </para> | |
31 | ||
32 | <para> | |
33 | For more details see the file COPYING in the source | |
34 | distribution of Linux. | |
35 | </para> | |
36 | </legalnotice> | |
37 | </bookinfo> | |
38 | ||
39 | <toc></toc> | |
40 | ||
41 | <chapter id="Basics"> | |
42 | <title>Driver Basics</title> | |
43 | <sect1><title>Driver Entry and Exit points</title> | |
44 | !Iinclude/linux/init.h | |
45 | </sect1> | |
46 | ||
47 | <sect1><title>Atomic and pointer manipulation</title> | |
88b68033 | 48 | !Iarch/x86/include/asm/atomic.h |
f7f84f38 RD |
49 | </sect1> |
50 | ||
51 | <sect1><title>Delaying, scheduling, and timer routines</title> | |
52 | !Iinclude/linux/sched.h | |
b4d20859 RD |
53 | !Ekernel/sched/core.c |
54 | !Ikernel/sched/cpupri.c | |
55 | !Ikernel/sched/fair.c | |
ee2f154a | 56 | !Iinclude/linux/completion.h |
be11e6d8 | 57 | !Ekernel/time/timer.c |
ee2f154a RD |
58 | </sect1> |
59 | <sect1><title>Wait queues and Wake events</title> | |
60 | !Iinclude/linux/wait.h | |
96d5d9d9 | 61 | !Ekernel/sched/wait.c |
f7f84f38 RD |
62 | </sect1> |
63 | <sect1><title>High-resolution timers</title> | |
64 | !Iinclude/linux/ktime.h | |
65 | !Iinclude/linux/hrtimer.h | |
be11e6d8 | 66 | !Ekernel/time/hrtimer.c |
f7f84f38 RD |
67 | </sect1> |
68 | <sect1><title>Workqueues and Kevents</title> | |
69 | !Ekernel/workqueue.c | |
70 | </sect1> | |
71 | <sect1><title>Internal Functions</title> | |
72 | !Ikernel/exit.c | |
73 | !Ikernel/signal.c | |
74 | !Iinclude/linux/kthread.h | |
75 | !Ekernel/kthread.c | |
76 | </sect1> | |
77 | ||
78 | <sect1><title>Kernel objects manipulation</title> | |
79 | <!-- | |
80 | X!Iinclude/linux/kobject.h | |
81 | --> | |
82 | !Elib/kobject.c | |
83 | </sect1> | |
84 | ||
85 | <sect1><title>Kernel utility functions</title> | |
86 | !Iinclude/linux/kernel.h | |
b9ee979e | 87 | !Ekernel/printk/printk.c |
f7f84f38 RD |
88 | !Ekernel/panic.c |
89 | !Ekernel/sys.c | |
4102adab PM |
90 | !Ekernel/rcu/srcu.c |
91 | !Ekernel/rcu/tree.c | |
92 | !Ekernel/rcu/tree_plugin.h | |
93 | !Ekernel/rcu/update.c | |
f7f84f38 RD |
94 | </sect1> |
95 | ||
96 | <sect1><title>Device Resource Management</title> | |
97 | !Edrivers/base/devres.c | |
98 | </sect1> | |
99 | ||
100 | </chapter> | |
101 | ||
102 | <chapter id="devdrivers"> | |
103 | <title>Device drivers infrastructure</title> | |
880ffb5c WG |
104 | <sect1><title>The Basic Device Driver-Model Structures </title> |
105 | !Iinclude/linux/device.h | |
106 | </sect1> | |
f7f84f38 | 107 | <sect1><title>Device Drivers Base</title> |
13405059 | 108 | !Idrivers/base/init.c |
f7f84f38 RD |
109 | !Edrivers/base/driver.c |
110 | !Edrivers/base/core.c | |
13405059 | 111 | !Edrivers/base/syscore.c |
f7f84f38 | 112 | !Edrivers/base/class.c |
13405059 | 113 | !Idrivers/base/node.c |
f7f84f38 RD |
114 | !Edrivers/base/firmware_class.c |
115 | !Edrivers/base/transport_class.c | |
116 | <!-- Cannot be included, because | |
117 | attribute_container_add_class_device_adapter | |
118 | and attribute_container_classdev_to_container | |
119 | exceed allowed 44 characters maximum | |
120 | X!Edrivers/base/attribute_container.c | |
121 | --> | |
13405059 | 122 | !Edrivers/base/dd.c |
f7f84f38 RD |
123 | <!-- |
124 | X!Edrivers/base/interface.c | |
125 | --> | |
44f28bde | 126 | !Iinclude/linux/platform_device.h |
f7f84f38 RD |
127 | !Edrivers/base/platform.c |
128 | !Edrivers/base/bus.c | |
13405059 RD |
129 | </sect1> |
130 | <sect1><title>Device Drivers DMA Management</title> | |
35fac7e3 | 131 | !Edrivers/dma-buf/dma-buf.c |
e941759c | 132 | !Edrivers/dma-buf/fence.c |
606b23ad | 133 | !Edrivers/dma-buf/seqno-fence.c |
e941759c | 134 | !Iinclude/linux/fence.h |
606b23ad | 135 | !Iinclude/linux/seqno-fence.h |
04a5faa8 | 136 | !Edrivers/dma-buf/reservation.c |
786d7257 | 137 | !Iinclude/linux/reservation.h |
13405059 RD |
138 | !Edrivers/base/dma-coherent.c |
139 | !Edrivers/base/dma-mapping.c | |
f7f84f38 RD |
140 | </sect1> |
141 | <sect1><title>Device Drivers Power Management</title> | |
142 | !Edrivers/base/power/main.c | |
143 | </sect1> | |
144 | <sect1><title>Device Drivers ACPI Support</title> | |
145 | <!-- Internal functions only | |
146 | X!Edrivers/acpi/sleep/main.c | |
147 | X!Edrivers/acpi/sleep/wakeup.c | |
148 | X!Edrivers/acpi/motherboard.c | |
149 | X!Edrivers/acpi/bus.c | |
150 | --> | |
151 | !Edrivers/acpi/scan.c | |
152 | !Idrivers/acpi/scan.c | |
153 | <!-- No correct structured comments | |
154 | X!Edrivers/acpi/pci_bind.c | |
155 | --> | |
156 | </sect1> | |
157 | <sect1><title>Device drivers PnP support</title> | |
158 | !Idrivers/pnp/core.c | |
159 | <!-- No correct structured comments | |
160 | X!Edrivers/pnp/system.c | |
161 | --> | |
162 | !Edrivers/pnp/card.c | |
163 | !Idrivers/pnp/driver.c | |
164 | !Edrivers/pnp/manager.c | |
165 | !Edrivers/pnp/support.c | |
166 | </sect1> | |
167 | <sect1><title>Userspace IO devices</title> | |
168 | !Edrivers/uio/uio.c | |
169 | !Iinclude/linux/uio_driver.h | |
170 | </sect1> | |
171 | </chapter> | |
172 | ||
173 | <chapter id="parportdev"> | |
174 | <title>Parallel Port Devices</title> | |
175 | !Iinclude/linux/parport.h | |
176 | !Edrivers/parport/ieee1284.c | |
177 | !Edrivers/parport/share.c | |
178 | !Idrivers/parport/daisy.c | |
179 | </chapter> | |
180 | ||
181 | <chapter id="message_devices"> | |
182 | <title>Message-based devices</title> | |
183 | <sect1><title>Fusion message devices</title> | |
184 | !Edrivers/message/fusion/mptbase.c | |
185 | !Idrivers/message/fusion/mptbase.c | |
186 | !Edrivers/message/fusion/mptscsih.c | |
187 | !Idrivers/message/fusion/mptscsih.c | |
188 | !Idrivers/message/fusion/mptctl.c | |
189 | !Idrivers/message/fusion/mptspi.c | |
190 | !Idrivers/message/fusion/mptfc.c | |
191 | !Idrivers/message/fusion/mptlan.c | |
192 | </sect1> | |
f7f84f38 RD |
193 | </chapter> |
194 | ||
195 | <chapter id="snddev"> | |
196 | <title>Sound Devices</title> | |
197 | !Iinclude/sound/core.h | |
198 | !Esound/sound_core.c | |
199 | !Iinclude/sound/pcm.h | |
200 | !Esound/core/pcm.c | |
201 | !Esound/core/device.c | |
202 | !Esound/core/info.c | |
203 | !Esound/core/rawmidi.c | |
204 | !Esound/core/sound.c | |
205 | !Esound/core/memory.c | |
206 | !Esound/core/pcm_memory.c | |
207 | !Esound/core/init.c | |
208 | !Esound/core/isadma.c | |
209 | !Esound/core/control.c | |
210 | !Esound/core/pcm_lib.c | |
211 | !Esound/core/hwdep.c | |
212 | !Esound/core/pcm_native.c | |
213 | !Esound/core/memalloc.c | |
214 | <!-- FIXME: Removed for now since no structured comments in source | |
215 | X!Isound/sound_firmware.c | |
216 | --> | |
217 | </chapter> | |
218 | ||
dc2c8bd3 MCC |
219 | <chapter id="mediadev"> |
220 | <title>Media Devices</title> | |
04ffb9c1 MCC |
221 | |
222 | <sect1><title>Video2Linux devices</title> | |
dc2c8bd3 | 223 | !Iinclude/media/v4l2-async.h |
04ffb9c1 MCC |
224 | !Iinclude/media/v4l2-ctrls.h |
225 | !Iinclude/media/v4l2-dv-timings.h | |
226 | !Iinclude/media/v4l2-event.h | |
dc2c8bd3 | 227 | !Iinclude/media/v4l2-flash-led-class.h |
04ffb9c1 | 228 | !Iinclude/media/v4l2-mediabus.h |
dc2c8bd3 MCC |
229 | !Iinclude/media/v4l2-mem2mem.h |
230 | !Iinclude/media/v4l2-of.h | |
231 | !Iinclude/media/v4l2-subdev.h | |
04ffb9c1 MCC |
232 | !Iinclude/media/videobuf2-core.h |
233 | !Iinclude/media/videobuf2-memops.h | |
234 | </sect1> | |
235 | <sect1><title>Digital TV (DVB) devices</title> | |
fbefb1a8 | 236 | !Idrivers/media/dvb-core/dvb_ca_en50221.h |
4f1c1868 | 237 | !Idrivers/media/dvb-core/dvb_frontend.h |
e08bb6f7 | 238 | !Idrivers/media/dvb-core/dvb_math.h |
2a86e373 | 239 | !Idrivers/media/dvb-core/dvb_ringbuffer.h |
04ffb9c1 MCC |
240 | </sect1> |
241 | <sect1><title>Remote Controller devices</title> | |
242 | !Iinclude/media/rc-core.h | |
243 | </sect1> | |
244 | <sect1><title>Media Controller devices</title> | |
245 | !Iinclude/media/media-device.h | |
246 | !Iinclude/media/media-devnode.h | |
247 | !Iinclude/media/media-entity.h | |
248 | </sect1> | |
dc2c8bd3 MCC |
249 | |
250 | </chapter> | |
251 | ||
f7f84f38 RD |
252 | <chapter id="uart16x50"> |
253 | <title>16x50 UART Driver</title> | |
fcf28564 | 254 | !Edrivers/tty/serial/serial_core.c |
5448bd8c | 255 | !Edrivers/tty/serial/8250/8250_core.c |
f7f84f38 RD |
256 | </chapter> |
257 | ||
258 | <chapter id="fbdev"> | |
259 | <title>Frame Buffer Library</title> | |
260 | ||
261 | <para> | |
262 | The frame buffer drivers depend heavily on four data structures. | |
263 | These structures are declared in include/linux/fb.h. They are | |
264 | fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs. | |
265 | The last three can be made available to and from userland. | |
266 | </para> | |
267 | ||
268 | <para> | |
269 | fb_info defines the current state of a particular video card. | |
270 | Inside fb_info, there exists a fb_ops structure which is a | |
271 | collection of needed functions to make fbdev and fbcon work. | |
272 | fb_info is only visible to the kernel. | |
273 | </para> | |
274 | ||
275 | <para> | |
276 | fb_var_screeninfo is used to describe the features of a video card | |
277 | that are user defined. With fb_var_screeninfo, things such as | |
278 | depth and the resolution may be defined. | |
279 | </para> | |
280 | ||
281 | <para> | |
282 | The next structure is fb_fix_screeninfo. This defines the | |
283 | properties of a card that are created when a mode is set and can't | |
284 | be changed otherwise. A good example of this is the start of the | |
285 | frame buffer memory. This "locks" the address of the frame buffer | |
286 | memory, so that it cannot be changed or moved. | |
287 | </para> | |
288 | ||
289 | <para> | |
290 | The last structure is fb_monospecs. In the old API, there was | |
291 | little importance for fb_monospecs. This allowed for forbidden things | |
292 | such as setting a mode of 800x600 on a fix frequency monitor. With | |
293 | the new API, fb_monospecs prevents such things, and if used | |
294 | correctly, can prevent a monitor from being cooked. fb_monospecs | |
295 | will not be useful until kernels 2.5.x. | |
296 | </para> | |
297 | ||
298 | <sect1><title>Frame Buffer Memory</title> | |
19757fc8 | 299 | !Edrivers/video/fbdev/core/fbmem.c |
f7f84f38 RD |
300 | </sect1> |
301 | <!-- | |
302 | <sect1><title>Frame Buffer Console</title> | |
303 | X!Edrivers/video/console/fbcon.c | |
304 | </sect1> | |
305 | --> | |
306 | <sect1><title>Frame Buffer Colormap</title> | |
19757fc8 | 307 | !Edrivers/video/fbdev/core/fbcmap.c |
f7f84f38 RD |
308 | </sect1> |
309 | <!-- FIXME: | |
310 | drivers/video/fbgen.c has no docs, which stuffs up the sgml. Comment | |
311 | out until somebody adds docs. KAO | |
312 | <sect1><title>Frame Buffer Generic Functions</title> | |
313 | X!Idrivers/video/fbgen.c | |
314 | </sect1> | |
315 | KAO --> | |
316 | <sect1><title>Frame Buffer Video Mode Database</title> | |
19757fc8 TV |
317 | !Idrivers/video/fbdev/core/modedb.c |
318 | !Edrivers/video/fbdev/core/modedb.c | |
f7f84f38 RD |
319 | </sect1> |
320 | <sect1><title>Frame Buffer Macintosh Video Mode Database</title> | |
f7018c21 | 321 | !Edrivers/video/fbdev/macmodes.c |
f7f84f38 RD |
322 | </sect1> |
323 | <sect1><title>Frame Buffer Fonts</title> | |
324 | <para> | |
ee89bd6b | 325 | Refer to the file lib/fonts/fonts.c for more information. |
f7f84f38 RD |
326 | </para> |
327 | <!-- FIXME: Removed for now since no structured comments in source | |
ee89bd6b | 328 | X!Ilib/fonts/fonts.c |
f7f84f38 RD |
329 | --> |
330 | </sect1> | |
331 | </chapter> | |
332 | ||
333 | <chapter id="input_subsystem"> | |
334 | <title>Input Subsystem</title> | |
d69249f4 | 335 | <sect1><title>Input core</title> |
f7f84f38 RD |
336 | !Iinclude/linux/input.h |
337 | !Edrivers/input/input.c | |
338 | !Edrivers/input/ff-core.c | |
339 | !Edrivers/input/ff-memless.c | |
69479f8d DT |
340 | </sect1> |
341 | <sect1><title>Multitouch Library</title> | |
342 | !Iinclude/linux/input/mt.h | |
343 | !Edrivers/input/input-mt.c | |
d69249f4 DT |
344 | </sect1> |
345 | <sect1><title>Polled input devices</title> | |
346 | !Iinclude/linux/input-polldev.h | |
347 | !Edrivers/input/input-polldev.c | |
348 | </sect1> | |
349 | <sect1><title>Matrix keyboars/keypads</title> | |
350 | !Iinclude/linux/input/matrix_keypad.h | |
351 | </sect1> | |
36203c4f DT |
352 | <sect1><title>Sparse keymap support</title> |
353 | !Iinclude/linux/input/sparse-keymap.h | |
354 | !Edrivers/input/sparse-keymap.c | |
355 | </sect1> | |
f7f84f38 RD |
356 | </chapter> |
357 | ||
358 | <chapter id="spi"> | |
359 | <title>Serial Peripheral Interface (SPI)</title> | |
360 | <para> | |
361 | SPI is the "Serial Peripheral Interface", widely used with | |
362 | embedded systems because it is a simple and efficient | |
363 | interface: basically a multiplexed shift register. | |
364 | Its three signal wires hold a clock (SCK, often in the range | |
365 | of 1-20 MHz), a "Master Out, Slave In" (MOSI) data line, and | |
366 | a "Master In, Slave Out" (MISO) data line. | |
367 | SPI is a full duplex protocol; for each bit shifted out the | |
368 | MOSI line (one per clock) another is shifted in on the MISO line. | |
369 | Those bits are assembled into words of various sizes on the | |
370 | way to and from system memory. | |
371 | An additional chipselect line is usually active-low (nCS); | |
372 | four signals are normally used for each peripheral, plus | |
373 | sometimes an interrupt. | |
374 | </para> | |
375 | <para> | |
376 | The SPI bus facilities listed here provide a generalized | |
377 | interface to declare SPI busses and devices, manage them | |
378 | according to the standard Linux driver model, and perform | |
379 | input/output operations. | |
380 | At this time, only "master" side interfaces are supported, | |
381 | where Linux talks to SPI peripherals and does not implement | |
382 | such a peripheral itself. | |
383 | (Interfaces to support implementing SPI slaves would | |
384 | necessarily look different.) | |
385 | </para> | |
386 | <para> | |
387 | The programming interface is structured around two kinds of driver, | |
388 | and two kinds of device. | |
389 | A "Controller Driver" abstracts the controller hardware, which may | |
390 | be as simple as a set of GPIO pins or as complex as a pair of FIFOs | |
391 | connected to dual DMA engines on the other side of the SPI shift | |
392 | register (maximizing throughput). Such drivers bridge between | |
393 | whatever bus they sit on (often the platform bus) and SPI, and | |
394 | expose the SPI side of their device as a | |
395 | <structname>struct spi_master</structname>. | |
396 | SPI devices are children of that master, represented as a | |
397 | <structname>struct spi_device</structname> and manufactured from | |
398 | <structname>struct spi_board_info</structname> descriptors which | |
399 | are usually provided by board-specific initialization code. | |
400 | A <structname>struct spi_driver</structname> is called a | |
401 | "Protocol Driver", and is bound to a spi_device using normal | |
402 | driver model calls. | |
403 | </para> | |
404 | <para> | |
405 | The I/O model is a set of queued messages. Protocol drivers | |
406 | submit one or more <structname>struct spi_message</structname> | |
407 | objects, which are processed and completed asynchronously. | |
408 | (There are synchronous wrappers, however.) Messages are | |
409 | built from one or more <structname>struct spi_transfer</structname> | |
410 | objects, each of which wraps a full duplex SPI transfer. | |
411 | A variety of protocol tweaking options are needed, because | |
412 | different chips adopt very different policies for how they | |
413 | use the bits transferred with SPI. | |
414 | </para> | |
415 | !Iinclude/linux/spi/spi.h | |
416 | !Fdrivers/spi/spi.c spi_register_board_info | |
417 | !Edrivers/spi/spi.c | |
418 | </chapter> | |
419 | ||
420 | <chapter id="i2c"> | |
421 | <title>I<superscript>2</superscript>C and SMBus Subsystem</title> | |
422 | ||
423 | <para> | |
424 | I<superscript>2</superscript>C (or without fancy typography, "I2C") | |
425 | is an acronym for the "Inter-IC" bus, a simple bus protocol which is | |
426 | widely used where low data rate communications suffice. | |
427 | Since it's also a licensed trademark, some vendors use another | |
428 | name (such as "Two-Wire Interface", TWI) for the same bus. | |
429 | I2C only needs two signals (SCL for clock, SDA for data), conserving | |
430 | board real estate and minimizing signal quality issues. | |
431 | Most I2C devices use seven bit addresses, and bus speeds of up | |
432 | to 400 kHz; there's a high speed extension (3.4 MHz) that's not yet | |
433 | found wide use. | |
434 | I2C is a multi-master bus; open drain signaling is used to | |
435 | arbitrate between masters, as well as to handshake and to | |
436 | synchronize clocks from slower clients. | |
437 | </para> | |
438 | ||
439 | <para> | |
440 | The Linux I2C programming interfaces support only the master | |
441 | side of bus interactions, not the slave side. | |
442 | The programming interface is structured around two kinds of driver, | |
443 | and two kinds of device. | |
444 | An I2C "Adapter Driver" abstracts the controller hardware; it binds | |
445 | to a physical device (perhaps a PCI device or platform_device) and | |
446 | exposes a <structname>struct i2c_adapter</structname> representing | |
447 | each I2C bus segment it manages. | |
448 | On each I2C bus segment will be I2C devices represented by a | |
449 | <structname>struct i2c_client</structname>. Those devices will | |
450 | be bound to a <structname>struct i2c_driver</structname>, | |
451 | which should follow the standard Linux driver model. | |
452 | (At this writing, a legacy model is more widely used.) | |
453 | There are functions to perform various I2C protocol operations; at | |
454 | this writing all such functions are usable only from task context. | |
455 | </para> | |
456 | ||
457 | <para> | |
458 | The System Management Bus (SMBus) is a sibling protocol. Most SMBus | |
459 | systems are also I2C conformant. The electrical constraints are | |
460 | tighter for SMBus, and it standardizes particular protocol messages | |
461 | and idioms. Controllers that support I2C can also support most | |
462 | SMBus operations, but SMBus controllers don't support all the protocol | |
463 | options that an I2C controller will. | |
464 | There are functions to perform various SMBus protocol operations, | |
465 | either using I2C primitives or by issuing SMBus commands to | |
466 | i2c_adapter devices which don't support those I2C operations. | |
467 | </para> | |
468 | ||
469 | !Iinclude/linux/i2c.h | |
470 | !Fdrivers/i2c/i2c-boardinfo.c i2c_register_board_info | |
471 | !Edrivers/i2c/i2c-core.c | |
472 | </chapter> | |
473 | ||
a4ac73a7 CC |
474 | <chapter id="hsi"> |
475 | <title>High Speed Synchronous Serial Interface (HSI)</title> | |
476 | ||
477 | <para> | |
478 | High Speed Synchronous Serial Interface (HSI) is a | |
479 | serial interface mainly used for connecting application | |
480 | engines (APE) with cellular modem engines (CMT) in cellular | |
481 | handsets. | |
482 | ||
483 | HSI provides multiplexing for up to 16 logical channels, | |
484 | low-latency and full duplex communication. | |
485 | </para> | |
486 | ||
487 | !Iinclude/linux/hsi/hsi.h | |
488 | !Edrivers/hsi/hsi.c | |
489 | </chapter> | |
490 | ||
f7f84f38 | 491 | </book> |