8305eb7b8c1557136889557921c4e8da3016b2b8
[linux-2.6.git] / Documentation / DocBook / kernel-api.tmpl
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="LinuxKernelAPI">
6  <bookinfo>
7   <title>The Linux Kernel API</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>
48 !Iinclude/asm-i386/atomic.h
49 !Iinclude/asm-i386/unaligned.h
50      </sect1>
51
52      <sect1><title>Delaying, scheduling, and timer routines</title>
53 !Iinclude/linux/sched.h
54 !Ekernel/sched.c
55 !Ekernel/timer.c
56      </sect1>
57      <sect1><title>High-resolution timers</title>
58 !Iinclude/linux/ktime.h
59 !Iinclude/linux/hrtimer.h
60 !Ekernel/hrtimer.c
61      </sect1>
62      <sect1><title>Internal Functions</title>
63 !Ikernel/exit.c
64 !Ikernel/signal.c
65 !Iinclude/linux/kthread.h
66 !Ekernel/kthread.c
67      </sect1>
68
69      <sect1><title>Kernel objects manipulation</title>
70 <!--
71 X!Iinclude/linux/kobject.h
72 -->
73 !Elib/kobject.c
74      </sect1>
75
76      <sect1><title>Kernel utility functions</title>
77 !Iinclude/linux/kernel.h
78 !Ekernel/printk.c
79 !Ekernel/panic.c
80 !Ekernel/sys.c
81 !Ekernel/rcupdate.c
82      </sect1>
83
84   </chapter>
85
86   <chapter id="adt">
87      <title>Data Types</title>
88      <sect1><title>Doubly Linked Lists</title>
89 !Iinclude/linux/list.h
90      </sect1>
91   </chapter>
92
93   <chapter id="libc">
94      <title>Basic C Library Functions</title>
95
96      <para>
97        When writing drivers, you cannot in general use routines which are
98        from the C Library.  Some of the functions have been found generally
99        useful and they are listed below.  The behaviour of these functions
100        may vary slightly from those defined by ANSI, and these deviations
101        are noted in the text.
102      </para>
103
104      <sect1><title>String Conversions</title>
105 !Ilib/vsprintf.c
106 !Elib/vsprintf.c
107      </sect1>
108      <sect1><title>String Manipulation</title>
109 <!-- All functions are exported at now
110 X!Ilib/string.c
111  -->
112 !Elib/string.c
113      </sect1>
114      <sect1><title>Bit Operations</title>
115 !Iinclude/asm-i386/bitops.h
116      </sect1>
117   </chapter>
118
119   <chapter id="kernel-lib">
120      <title>Basic Kernel Library Functions</title>
121
122      <para>
123        The Linux kernel provides more basic utility functions.
124      </para>
125
126      <sect1><title>Bitmap Operations</title>
127 !Elib/bitmap.c
128 !Ilib/bitmap.c
129      </sect1>
130
131      <sect1><title>Command-line Parsing</title>
132 !Elib/cmdline.c
133      </sect1>
134
135      <sect1><title>CRC Functions</title>
136 !Elib/crc16.c
137 !Elib/crc32.c
138 !Elib/crc-ccitt.c
139      </sect1>
140   </chapter>
141
142   <chapter id="mm">
143      <title>Memory Management in Linux</title>
144      <sect1><title>The Slab Cache</title>
145 !Iinclude/linux/slab.h
146 !Emm/slab.c
147      </sect1>
148      <sect1><title>User Space Memory Access</title>
149 !Iinclude/asm-i386/uaccess.h
150 !Earch/i386/lib/usercopy.c
151      </sect1>
152      <sect1><title>More Memory Management Functions</title>
153 !Iinclude/linux/rmap.h
154 !Emm/readahead.c
155 !Emm/filemap.c
156 !Emm/memory.c
157 !Emm/vmalloc.c
158 !Emm/mempool.c
159 !Emm/page-writeback.c
160 !Emm/truncate.c
161      </sect1>
162   </chapter>
163
164
165   <chapter id="ipc">
166      <title>Kernel IPC facilities</title>
167
168      <sect1><title>IPC utilities</title>
169 !Iipc/util.c
170      </sect1>
171   </chapter>
172
173   <chapter id="kfifo">
174      <title>FIFO Buffer</title>
175      <sect1><title>kfifo interface</title>
176 !Iinclude/linux/kfifo.h
177 !Ekernel/kfifo.c
178      </sect1>
179   </chapter>
180
181   <chapter id="proc">
182      <title>The proc filesystem</title>
183  
184      <sect1><title>sysctl interface</title>
185 !Ekernel/sysctl.c
186      </sect1>
187
188      <sect1><title>proc filesystem interface</title>
189 !Ifs/proc/base.c
190      </sect1>
191   </chapter>
192
193   <chapter id="debugfs">
194      <title>The debugfs filesystem</title>
195  
196      <sect1><title>debugfs interface</title>
197 !Efs/debugfs/inode.c
198 !Efs/debugfs/file.c
199      </sect1>
200   </chapter>
201
202   <chapter id="vfs">
203      <title>The Linux VFS</title>
204      <sect1><title>The Filesystem types</title>
205 !Iinclude/linux/fs.h
206      </sect1>
207      <sect1><title>The Directory Cache</title>
208 !Efs/dcache.c
209 !Iinclude/linux/dcache.h
210      </sect1>
211      <sect1><title>Inode Handling</title>
212 !Efs/inode.c
213 !Efs/bad_inode.c
214      </sect1>
215      <sect1><title>Registration and Superblocks</title>
216 !Efs/super.c
217      </sect1>
218      <sect1><title>File Locks</title>
219 !Efs/locks.c
220 !Ifs/locks.c
221      </sect1>
222      <sect1><title>Other Functions</title>
223 !Efs/mpage.c
224 !Efs/namei.c
225 !Efs/buffer.c
226 !Efs/bio.c
227 !Efs/seq_file.c
228 !Efs/filesystems.c
229 !Efs/fs-writeback.c
230 !Efs/block_dev.c
231      </sect1>
232   </chapter>
233
234   <chapter id="netcore">
235      <title>Linux Networking</title>
236      <sect1><title>Networking Base Types</title>
237 !Iinclude/linux/net.h
238      </sect1>
239      <sect1><title>Socket Buffer Functions</title>
240 !Iinclude/linux/skbuff.h
241 !Iinclude/net/sock.h
242 !Enet/socket.c
243 !Enet/core/skbuff.c
244 !Enet/core/sock.c
245 !Enet/core/datagram.c
246 !Enet/core/stream.c
247      </sect1>
248      <sect1><title>Socket Filter</title>
249 !Enet/core/filter.c
250      </sect1>
251      <sect1><title>Generic Network Statistics</title>
252 !Iinclude/linux/gen_stats.h
253 !Enet/core/gen_stats.c
254 !Enet/core/gen_estimator.c
255      </sect1>
256      <sect1><title>SUN RPC subsystem</title>
257 <!-- The !D functionality is not perfect, garbage has to be protected by comments
258 !Dnet/sunrpc/sunrpc_syms.c
259 -->
260 !Enet/sunrpc/xdr.c
261 !Enet/sunrpc/svcsock.c
262 !Enet/sunrpc/sched.c
263      </sect1>
264   </chapter>
265
266   <chapter id="netdev">
267      <title>Network device support</title>
268      <sect1><title>Driver Support</title>
269 !Enet/core/dev.c
270 !Enet/ethernet/eth.c
271 !Iinclude/linux/etherdevice.h
272 <!-- FIXME: Removed for now since no structured comments in source
273 X!Enet/core/wireless.c
274 -->
275      </sect1>
276      <sect1><title>Synchronous PPP</title>
277 !Edrivers/net/wan/syncppp.c
278      </sect1>
279   </chapter>
280
281   <chapter id="modload">
282      <title>Module Support</title>
283      <sect1><title>Module Loading</title>
284 !Ekernel/kmod.c
285      </sect1>
286      <sect1><title>Inter Module support</title>
287         <para>
288            Refer to the file kernel/module.c for more information.
289         </para>
290 <!-- FIXME: Removed for now since no structured comments in source
291 X!Ekernel/module.c
292 -->
293      </sect1>
294   </chapter>
295
296   <chapter id="hardware">
297      <title>Hardware Interfaces</title>
298      <sect1><title>Interrupt Handling</title>
299 !Ekernel/irq/manage.c
300      </sect1>
301
302      <sect1><title>Resources Management</title>
303 !Ekernel/resource.c
304      </sect1>
305
306      <sect1><title>MTRR Handling</title>
307 !Earch/i386/kernel/cpu/mtrr/main.c
308      </sect1>
309
310      <sect1><title>PCI Support Library</title>
311 !Edrivers/pci/pci.c
312 !Edrivers/pci/pci-driver.c
313 !Edrivers/pci/remove.c
314 !Edrivers/pci/pci-acpi.c
315 <!-- kerneldoc does not understand __devinit
316 X!Edrivers/pci/search.c
317  -->
318 !Edrivers/pci/msi.c
319 !Edrivers/pci/bus.c
320 <!-- FIXME: Removed for now since no structured comments in source
321 X!Edrivers/pci/hotplug.c
322 -->
323 !Edrivers/pci/probe.c
324 !Edrivers/pci/rom.c
325      </sect1>
326      <sect1><title>PCI Hotplug Support Library</title>
327 !Edrivers/pci/hotplug/pci_hotplug_core.c
328      </sect1>
329      <sect1><title>MCA Architecture</title>
330         <sect2><title>MCA Device Functions</title>
331            <para>
332               Refer to the file arch/i386/kernel/mca.c for more information.
333            </para>
334 <!-- FIXME: Removed for now since no structured comments in source
335 X!Earch/i386/kernel/mca.c
336 -->
337         </sect2>
338         <sect2><title>MCA Bus DMA</title>
339 !Iinclude/asm-i386/mca_dma.h
340         </sect2>
341      </sect1>
342   </chapter>
343
344   <chapter id="firmware">
345      <title>Firmware Interfaces</title>
346      <sect1><title>DMI Interfaces</title>
347 !Edrivers/firmware/dmi_scan.c
348      </sect1>
349   </chapter>
350
351   <chapter id="devfs">
352      <title>The Device File System</title>
353 !Efs/devfs/base.c
354   </chapter>
355
356   <chapter id="sysfs">
357      <title>The Filesystem for Exporting Kernel Objects</title>
358 !Efs/sysfs/file.c
359 !Efs/sysfs/symlink.c
360 !Efs/sysfs/bin.c
361   </chapter>
362
363   <chapter id="security">
364      <title>Security Framework</title>
365 !Esecurity/security.c
366   </chapter>
367
368   <chapter id="audit">
369      <title>Audit Interfaces</title>
370 !Ekernel/audit.c
371 !Ikernel/auditsc.c
372 !Ikernel/auditfilter.c
373   </chapter>
374
375   <chapter id="accounting">
376      <title>Accounting Framework</title>
377 !Ikernel/acct.c
378   </chapter>
379
380   <chapter id="pmfuncs">
381      <title>Power Management</title>
382 !Ekernel/power/pm.c
383   </chapter>
384
385   <chapter id="devdrivers">
386      <title>Device drivers infrastructure</title>
387      <sect1><title>Device Drivers Base</title>
388 <!--
389 X!Iinclude/linux/device.h
390 -->
391 !Edrivers/base/driver.c
392 !Edrivers/base/core.c
393 !Edrivers/base/firmware_class.c
394 !Edrivers/base/transport_class.c
395 !Edrivers/base/dmapool.c
396 <!-- Cannot be included, because
397      attribute_container_add_class_device_adapter
398  and attribute_container_classdev_to_container
399      exceed allowed 44 characters maximum
400 X!Edrivers/base/attribute_container.c
401 -->
402 !Edrivers/base/sys.c
403 <!--
404 X!Edrivers/base/interface.c
405 -->
406 !Edrivers/base/platform.c
407 !Edrivers/base/bus.c
408      </sect1>
409      <sect1><title>Device Drivers Power Management</title>
410 !Edrivers/base/power/main.c
411 !Edrivers/base/power/resume.c
412 !Edrivers/base/power/suspend.c
413      </sect1>
414      <sect1><title>Device Drivers ACPI Support</title>
415 <!-- Internal functions only
416 X!Edrivers/acpi/sleep/main.c
417 X!Edrivers/acpi/sleep/wakeup.c
418 X!Edrivers/acpi/motherboard.c
419 X!Edrivers/acpi/bus.c
420 -->
421 !Edrivers/acpi/scan.c
422 !Idrivers/acpi/scan.c
423 <!-- No correct structured comments
424 X!Edrivers/acpi/pci_bind.c
425 -->
426      </sect1>
427      <sect1><title>Device drivers PnP support</title>
428 !Edrivers/pnp/core.c
429 <!-- No correct structured comments
430 X!Edrivers/pnp/system.c
431  -->
432 !Edrivers/pnp/card.c
433 !Edrivers/pnp/driver.c
434 !Edrivers/pnp/manager.c
435 !Edrivers/pnp/support.c
436      </sect1>
437   </chapter>
438
439
440   <chapter id="blkdev">
441      <title>Block Devices</title>
442 !Eblock/ll_rw_blk.c
443   </chapter>
444
445   <chapter id="miscdev">
446      <title>Miscellaneous Devices</title>
447 !Edrivers/char/misc.c
448   </chapter>
449
450   <chapter id="viddev">
451      <title>Video4Linux</title>
452 !Edrivers/media/video/videodev.c
453   </chapter>
454
455   <chapter id="snddev">
456      <title>Sound Devices</title>
457 !Iinclude/sound/core.h
458 !Esound/sound_core.c
459 !Iinclude/sound/pcm.h
460 !Esound/core/pcm.c
461 !Esound/core/device.c
462 !Esound/core/info.c
463 !Esound/core/rawmidi.c
464 !Esound/core/sound.c
465 !Esound/core/memory.c
466 !Esound/core/pcm_memory.c
467 !Esound/core/init.c
468 !Esound/core/isadma.c
469 !Esound/core/control.c
470 !Esound/core/pcm_lib.c
471 !Esound/core/hwdep.c
472 !Esound/core/pcm_native.c
473 !Esound/core/memalloc.c
474 <!-- FIXME: Removed for now since no structured comments in source
475 X!Isound/sound_firmware.c
476 -->
477   </chapter>
478
479   <chapter id="uart16x50">
480      <title>16x50 UART Driver</title>
481 !Iinclude/linux/serial_core.h
482 !Edrivers/serial/serial_core.c
483 !Edrivers/serial/8250.c
484   </chapter>
485
486   <chapter id="z85230">
487      <title>Z85230 Support Library</title>
488 !Edrivers/net/wan/z85230.c
489   </chapter>
490
491   <chapter id="fbdev">
492      <title>Frame Buffer Library</title>
493
494      <para>
495        The frame buffer drivers depend heavily on four data structures.  
496        These structures are declared in include/linux/fb.h.  They are 
497        fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs. 
498        The last three can be made available to and from userland. 
499      </para>
500
501      <para>
502        fb_info defines the current state of a particular video card. 
503        Inside fb_info, there exists a fb_ops structure which is a 
504        collection of needed functions to make fbdev and fbcon work.
505        fb_info is only visible to the kernel.
506      </para>
507
508      <para>
509        fb_var_screeninfo is used to describe the features of a video card 
510        that are user defined.  With fb_var_screeninfo, things such as
511        depth and the resolution may be defined.
512      </para>
513
514      <para>
515        The next structure is fb_fix_screeninfo. This defines the 
516        properties of a card that are created when a mode is set and can't 
517        be changed otherwise.  A good example of this is the start of the 
518        frame buffer memory.  This "locks" the address of the frame buffer
519        memory, so that it cannot be changed or moved.
520      </para>
521
522      <para>
523        The last structure is fb_monospecs. In the old API, there was 
524        little importance for fb_monospecs. This allowed for forbidden things 
525        such as setting a mode of 800x600 on a fix frequency monitor. With 
526        the new API, fb_monospecs prevents such things, and if used 
527        correctly, can prevent a monitor from being cooked.  fb_monospecs
528        will not be useful until kernels 2.5.x.
529      </para>
530
531      <sect1><title>Frame Buffer Memory</title>
532 !Edrivers/video/fbmem.c
533      </sect1>
534 <!--
535      <sect1><title>Frame Buffer Console</title>
536 X!Edrivers/video/console/fbcon.c
537      </sect1>
538 -->
539      <sect1><title>Frame Buffer Colormap</title>
540 !Edrivers/video/fbcmap.c
541      </sect1>
542 <!-- FIXME:
543   drivers/video/fbgen.c has no docs, which stuffs up the sgml.  Comment
544   out until somebody adds docs.  KAO
545      <sect1><title>Frame Buffer Generic Functions</title>
546 X!Idrivers/video/fbgen.c
547      </sect1>
548 KAO -->
549      <sect1><title>Frame Buffer Video Mode Database</title>
550 !Idrivers/video/modedb.c
551 !Edrivers/video/modedb.c
552      </sect1>
553      <sect1><title>Frame Buffer Macintosh Video Mode Database</title>
554 !Edrivers/video/macmodes.c
555      </sect1>
556      <sect1><title>Frame Buffer Fonts</title>
557         <para>
558            Refer to the file drivers/video/console/fonts.c for more information.
559         </para>
560 <!-- FIXME: Removed for now since no structured comments in source
561 X!Idrivers/video/console/fonts.c
562 -->
563      </sect1>
564   </chapter>
565 </book>