docbook: dmapool: fix fatal changed filename
[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-x86/atomic_32.h
49 !Iinclude/asm-x86/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>Workqueues and Kevents</title>
63 !Ekernel/workqueue.c
64      </sect1>
65      <sect1><title>Internal Functions</title>
66 !Ikernel/exit.c
67 !Ikernel/signal.c
68 !Iinclude/linux/kthread.h
69 !Ekernel/kthread.c
70      </sect1>
71
72      <sect1><title>Kernel objects manipulation</title>
73 <!--
74 X!Iinclude/linux/kobject.h
75 -->
76 !Elib/kobject.c
77      </sect1>
78
79      <sect1><title>Kernel utility functions</title>
80 !Iinclude/linux/kernel.h
81 !Ekernel/printk.c
82 !Ekernel/panic.c
83 !Ekernel/sys.c
84 !Ekernel/rcupdate.c
85      </sect1>
86
87      <sect1><title>Device Resource Management</title>
88 !Edrivers/base/devres.c
89      </sect1>
90
91   </chapter>
92
93   <chapter id="adt">
94      <title>Data Types</title>
95      <sect1><title>Doubly Linked Lists</title>
96 !Iinclude/linux/list.h
97      </sect1>
98   </chapter>
99
100   <chapter id="libc">
101      <title>Basic C Library Functions</title>
102
103      <para>
104        When writing drivers, you cannot in general use routines which are
105        from the C Library.  Some of the functions have been found generally
106        useful and they are listed below.  The behaviour of these functions
107        may vary slightly from those defined by ANSI, and these deviations
108        are noted in the text.
109      </para>
110
111      <sect1><title>String Conversions</title>
112 !Ilib/vsprintf.c
113 !Elib/vsprintf.c
114      </sect1>
115      <sect1><title>String Manipulation</title>
116 <!-- All functions are exported at now
117 X!Ilib/string.c
118  -->
119 !Elib/string.c
120      </sect1>
121      <sect1><title>Bit Operations</title>
122 !Iinclude/asm-x86/bitops_32.h
123      </sect1>
124   </chapter>
125
126   <chapter id="kernel-lib">
127      <title>Basic Kernel Library Functions</title>
128
129      <para>
130        The Linux kernel provides more basic utility functions.
131      </para>
132
133      <sect1><title>Bitmap Operations</title>
134 !Elib/bitmap.c
135 !Ilib/bitmap.c
136      </sect1>
137
138      <sect1><title>Command-line Parsing</title>
139 !Elib/cmdline.c
140      </sect1>
141
142      <sect1 id="crc"><title>CRC Functions</title>
143 !Elib/crc7.c
144 !Elib/crc16.c
145 !Elib/crc-itu-t.c
146 !Elib/crc32.c
147 !Elib/crc-ccitt.c
148      </sect1>
149   </chapter>
150
151   <chapter id="mm">
152      <title>Memory Management in Linux</title>
153      <sect1><title>The Slab Cache</title>
154 !Iinclude/linux/slab.h
155 !Emm/slab.c
156      </sect1>
157      <sect1><title>User Space Memory Access</title>
158 !Iinclude/asm-x86/uaccess_32.h
159 !Earch/x86/lib/usercopy_32.c
160      </sect1>
161      <sect1><title>More Memory Management Functions</title>
162 !Emm/readahead.c
163 !Emm/filemap.c
164 !Emm/memory.c
165 !Emm/vmalloc.c
166 !Imm/page_alloc.c
167 !Emm/mempool.c
168 !Emm/dmapool.c
169 !Emm/page-writeback.c
170 !Emm/truncate.c
171      </sect1>
172   </chapter>
173
174
175   <chapter id="ipc">
176      <title>Kernel IPC facilities</title>
177
178      <sect1><title>IPC utilities</title>
179 !Iipc/util.c
180      </sect1>
181   </chapter>
182
183   <chapter id="kfifo">
184      <title>FIFO Buffer</title>
185      <sect1><title>kfifo interface</title>
186 !Iinclude/linux/kfifo.h
187 !Ekernel/kfifo.c
188      </sect1>
189   </chapter>
190
191   <chapter id="relayfs">
192      <title>relay interface support</title>
193
194      <para>
195         Relay interface support
196         is designed to provide an efficient mechanism for tools and
197         facilities to relay large amounts of data from kernel space to
198         user space.
199      </para>
200
201      <sect1><title>relay interface</title>
202 !Ekernel/relay.c
203 !Ikernel/relay.c
204      </sect1>
205   </chapter>
206
207   <chapter id="netcore">
208      <title>Linux Networking</title>
209      <sect1><title>Networking Base Types</title>
210 !Iinclude/linux/net.h
211      </sect1>
212      <sect1><title>Socket Buffer Functions</title>
213 !Iinclude/linux/skbuff.h
214 !Iinclude/net/sock.h
215 !Enet/socket.c
216 !Enet/core/skbuff.c
217 !Enet/core/sock.c
218 !Enet/core/datagram.c
219 !Enet/core/stream.c
220      </sect1>
221      <sect1><title>Socket Filter</title>
222 !Enet/core/filter.c
223      </sect1>
224      <sect1><title>Generic Network Statistics</title>
225 !Iinclude/linux/gen_stats.h
226 !Enet/core/gen_stats.c
227 !Enet/core/gen_estimator.c
228      </sect1>
229      <sect1><title>SUN RPC subsystem</title>
230 <!-- The !D functionality is not perfect, garbage has to be protected by comments
231 !Dnet/sunrpc/sunrpc_syms.c
232 -->
233 !Enet/sunrpc/xdr.c
234 !Enet/sunrpc/svcsock.c
235 !Enet/sunrpc/sched.c
236      </sect1>
237   </chapter>
238
239   <chapter id="netdev">
240      <title>Network device support</title>
241      <sect1><title>Driver Support</title>
242 !Enet/core/dev.c
243 !Enet/ethernet/eth.c
244 !Enet/sched/sch_generic.c
245 !Iinclude/linux/etherdevice.h
246 !Iinclude/linux/netdevice.h
247      </sect1>
248      <sect1><title>PHY Support</title>
249 !Edrivers/net/phy/phy.c
250 !Idrivers/net/phy/phy.c
251 !Edrivers/net/phy/phy_device.c
252 !Idrivers/net/phy/phy_device.c
253 !Edrivers/net/phy/mdio_bus.c
254 !Idrivers/net/phy/mdio_bus.c
255      </sect1>
256 <!-- FIXME: Removed for now since no structured comments in source
257      <sect1><title>Wireless</title>
258 X!Enet/core/wireless.c
259      </sect1>
260 -->
261      <sect1><title>Synchronous PPP</title>
262 !Edrivers/net/wan/syncppp.c
263      </sect1>
264   </chapter>
265
266   <chapter id="modload">
267      <title>Module Support</title>
268      <sect1><title>Module Loading</title>
269 !Ekernel/kmod.c
270      </sect1>
271      <sect1><title>Inter Module support</title>
272         <para>
273            Refer to the file kernel/module.c for more information.
274         </para>
275 <!-- FIXME: Removed for now since no structured comments in source
276 X!Ekernel/module.c
277 -->
278      </sect1>
279   </chapter>
280
281   <chapter id="hardware">
282      <title>Hardware Interfaces</title>
283      <sect1><title>Interrupt Handling</title>
284 !Ekernel/irq/manage.c
285      </sect1>
286
287      <sect1><title>DMA Channels</title>
288 !Ekernel/dma.c
289      </sect1>
290
291      <sect1><title>Resources Management</title>
292 !Ikernel/resource.c
293 !Ekernel/resource.c
294      </sect1>
295
296      <sect1><title>MTRR Handling</title>
297 !Earch/x86/kernel/cpu/mtrr/main.c
298      </sect1>
299
300      <sect1><title>PCI Support Library</title>
301 !Edrivers/pci/pci.c
302 !Edrivers/pci/pci-driver.c
303 !Edrivers/pci/remove.c
304 !Edrivers/pci/pci-acpi.c
305 !Edrivers/pci/search.c
306 !Edrivers/pci/msi.c
307 !Edrivers/pci/bus.c
308 <!-- FIXME: Removed for now since no structured comments in source
309 X!Edrivers/pci/hotplug.c
310 -->
311 !Edrivers/pci/probe.c
312 !Edrivers/pci/rom.c
313      </sect1>
314      <sect1><title>PCI Hotplug Support Library</title>
315 !Edrivers/pci/hotplug/pci_hotplug_core.c
316      </sect1>
317      <sect1><title>MCA Architecture</title>
318         <sect2><title>MCA Device Functions</title>
319            <para>
320               Refer to the file arch/x86/kernel/mca_32.c for more information.
321            </para>
322 <!-- FIXME: Removed for now since no structured comments in source
323 X!Earch/x86/kernel/mca_32.c
324 -->
325         </sect2>
326         <sect2><title>MCA Bus DMA</title>
327 !Iinclude/asm-x86/mca_dma.h
328         </sect2>
329      </sect1>
330   </chapter>
331
332   <chapter id="firmware">
333      <title>Firmware Interfaces</title>
334      <sect1><title>DMI Interfaces</title>
335 !Edrivers/firmware/dmi_scan.c
336      </sect1>
337      <sect1><title>EDD Interfaces</title>
338 !Idrivers/firmware/edd.c
339      </sect1>
340   </chapter>
341
342   <chapter id="security">
343      <title>Security Framework</title>
344 !Isecurity/security.c
345   </chapter>
346
347   <chapter id="audit">
348      <title>Audit Interfaces</title>
349 !Ekernel/audit.c
350 !Ikernel/auditsc.c
351 !Ikernel/auditfilter.c
352   </chapter>
353
354   <chapter id="accounting">
355      <title>Accounting Framework</title>
356 !Ikernel/acct.c
357   </chapter>
358
359   <chapter id="pmfuncs">
360      <title>Power Management</title>
361 !Ekernel/power/pm.c
362   </chapter>
363
364   <chapter id="devdrivers">
365      <title>Device drivers infrastructure</title>
366      <sect1><title>Device Drivers Base</title>
367 <!--
368 X!Iinclude/linux/device.h
369 -->
370 !Edrivers/base/driver.c
371 !Edrivers/base/core.c
372 !Edrivers/base/class.c
373 !Edrivers/base/firmware_class.c
374 !Edrivers/base/transport_class.c
375 <!-- Cannot be included, because
376      attribute_container_add_class_device_adapter
377  and attribute_container_classdev_to_container
378      exceed allowed 44 characters maximum
379 X!Edrivers/base/attribute_container.c
380 -->
381 !Edrivers/base/sys.c
382 <!--
383 X!Edrivers/base/interface.c
384 -->
385 !Edrivers/base/platform.c
386 !Edrivers/base/bus.c
387      </sect1>
388      <sect1><title>Device Drivers Power Management</title>
389 !Edrivers/base/power/main.c
390      </sect1>
391      <sect1><title>Device Drivers ACPI Support</title>
392 <!-- Internal functions only
393 X!Edrivers/acpi/sleep/main.c
394 X!Edrivers/acpi/sleep/wakeup.c
395 X!Edrivers/acpi/motherboard.c
396 X!Edrivers/acpi/bus.c
397 -->
398 !Edrivers/acpi/scan.c
399 !Idrivers/acpi/scan.c
400 <!-- No correct structured comments
401 X!Edrivers/acpi/pci_bind.c
402 -->
403      </sect1>
404      <sect1><title>Device drivers PnP support</title>
405 !Idrivers/pnp/core.c
406 <!-- No correct structured comments
407 X!Edrivers/pnp/system.c
408  -->
409 !Edrivers/pnp/card.c
410 !Idrivers/pnp/driver.c
411 !Edrivers/pnp/manager.c
412 !Edrivers/pnp/support.c
413      </sect1>
414      <sect1><title>Userspace IO devices</title>
415 !Edrivers/uio/uio.c
416 !Iinclude/linux/uio_driver.h
417      </sect1>
418   </chapter>
419
420   <chapter id="blkdev">
421      <title>Block Devices</title>
422 !Eblock/blk-core.c
423 !Eblock/blk-map.c
424 !Iblock/blk-sysfs.c
425 !Eblock/blk-settings.c
426 !Eblock/blk-exec.c
427 !Eblock/blk-barrier.c
428 !Eblock/blk-tag.c
429   </chapter>
430
431   <chapter id="chrdev">
432         <title>Char devices</title>
433 !Efs/char_dev.c
434   </chapter>
435
436   <chapter id="miscdev">
437      <title>Miscellaneous Devices</title>
438 !Edrivers/char/misc.c
439   </chapter>
440
441   <chapter id="parportdev">
442      <title>Parallel Port Devices</title>
443 !Iinclude/linux/parport.h
444 !Edrivers/parport/ieee1284.c
445 !Edrivers/parport/share.c
446 !Idrivers/parport/daisy.c
447   </chapter>
448
449   <chapter id="message_devices">
450         <title>Message-based devices</title>
451      <sect1><title>Fusion message devices</title>
452 !Edrivers/message/fusion/mptbase.c
453 !Idrivers/message/fusion/mptbase.c
454 !Edrivers/message/fusion/mptscsih.c
455 !Idrivers/message/fusion/mptscsih.c
456 !Idrivers/message/fusion/mptctl.c
457 !Idrivers/message/fusion/mptspi.c
458 !Idrivers/message/fusion/mptfc.c
459 !Idrivers/message/fusion/mptlan.c
460      </sect1>
461      <sect1><title>I2O message devices</title>
462 !Iinclude/linux/i2o.h
463 !Idrivers/message/i2o/core.h
464 !Edrivers/message/i2o/iop.c
465 !Idrivers/message/i2o/iop.c
466 !Idrivers/message/i2o/config-osm.c
467 !Edrivers/message/i2o/exec-osm.c
468 !Idrivers/message/i2o/exec-osm.c
469 !Idrivers/message/i2o/bus-osm.c
470 !Edrivers/message/i2o/device.c
471 !Idrivers/message/i2o/device.c
472 !Idrivers/message/i2o/driver.c
473 !Idrivers/message/i2o/pci.c
474 !Idrivers/message/i2o/i2o_block.c
475 !Idrivers/message/i2o/i2o_scsi.c
476 !Idrivers/message/i2o/i2o_proc.c
477      </sect1>
478   </chapter>
479
480   <chapter id="snddev">
481      <title>Sound Devices</title>
482 !Iinclude/sound/core.h
483 !Esound/sound_core.c
484 !Iinclude/sound/pcm.h
485 !Esound/core/pcm.c
486 !Esound/core/device.c
487 !Esound/core/info.c
488 !Esound/core/rawmidi.c
489 !Esound/core/sound.c
490 !Esound/core/memory.c
491 !Esound/core/pcm_memory.c
492 !Esound/core/init.c
493 !Esound/core/isadma.c
494 !Esound/core/control.c
495 !Esound/core/pcm_lib.c
496 !Esound/core/hwdep.c
497 !Esound/core/pcm_native.c
498 !Esound/core/memalloc.c
499 <!-- FIXME: Removed for now since no structured comments in source
500 X!Isound/sound_firmware.c
501 -->
502   </chapter>
503
504   <chapter id="uart16x50">
505      <title>16x50 UART Driver</title>
506 !Iinclude/linux/serial_core.h
507 !Edrivers/serial/serial_core.c
508 !Edrivers/serial/8250.c
509   </chapter>
510
511   <chapter id="z85230">
512      <title>Z85230 Support Library</title>
513 !Edrivers/net/wan/z85230.c
514   </chapter>
515
516   <chapter id="fbdev">
517      <title>Frame Buffer Library</title>
518
519      <para>
520        The frame buffer drivers depend heavily on four data structures.  
521        These structures are declared in include/linux/fb.h.  They are 
522        fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs. 
523        The last three can be made available to and from userland. 
524      </para>
525
526      <para>
527        fb_info defines the current state of a particular video card. 
528        Inside fb_info, there exists a fb_ops structure which is a 
529        collection of needed functions to make fbdev and fbcon work.
530        fb_info is only visible to the kernel.
531      </para>
532
533      <para>
534        fb_var_screeninfo is used to describe the features of a video card 
535        that are user defined.  With fb_var_screeninfo, things such as
536        depth and the resolution may be defined.
537      </para>
538
539      <para>
540        The next structure is fb_fix_screeninfo. This defines the 
541        properties of a card that are created when a mode is set and can't 
542        be changed otherwise.  A good example of this is the start of the 
543        frame buffer memory.  This "locks" the address of the frame buffer
544        memory, so that it cannot be changed or moved.
545      </para>
546
547      <para>
548        The last structure is fb_monospecs. In the old API, there was 
549        little importance for fb_monospecs. This allowed for forbidden things 
550        such as setting a mode of 800x600 on a fix frequency monitor. With 
551        the new API, fb_monospecs prevents such things, and if used 
552        correctly, can prevent a monitor from being cooked.  fb_monospecs
553        will not be useful until kernels 2.5.x.
554      </para>
555
556      <sect1><title>Frame Buffer Memory</title>
557 !Edrivers/video/fbmem.c
558      </sect1>
559 <!--
560      <sect1><title>Frame Buffer Console</title>
561 X!Edrivers/video/console/fbcon.c
562      </sect1>
563 -->
564      <sect1><title>Frame Buffer Colormap</title>
565 !Edrivers/video/fbcmap.c
566      </sect1>
567 <!-- FIXME:
568   drivers/video/fbgen.c has no docs, which stuffs up the sgml.  Comment
569   out until somebody adds docs.  KAO
570      <sect1><title>Frame Buffer Generic Functions</title>
571 X!Idrivers/video/fbgen.c
572      </sect1>
573 KAO -->
574      <sect1><title>Frame Buffer Video Mode Database</title>
575 !Idrivers/video/modedb.c
576 !Edrivers/video/modedb.c
577      </sect1>
578      <sect1><title>Frame Buffer Macintosh Video Mode Database</title>
579 !Edrivers/video/macmodes.c
580      </sect1>
581      <sect1><title>Frame Buffer Fonts</title>
582         <para>
583            Refer to the file drivers/video/console/fonts.c for more information.
584         </para>
585 <!-- FIXME: Removed for now since no structured comments in source
586 X!Idrivers/video/console/fonts.c
587 -->
588      </sect1>
589   </chapter>
590
591   <chapter id="input_subsystem">
592      <title>Input Subsystem</title>
593 !Iinclude/linux/input.h
594 !Edrivers/input/input.c
595 !Edrivers/input/ff-core.c
596 !Edrivers/input/ff-memless.c
597   </chapter>
598
599   <chapter id="spi">
600       <title>Serial Peripheral Interface (SPI)</title>
601   <para>
602         SPI is the "Serial Peripheral Interface", widely used with
603         embedded systems because it is a simple and efficient
604         interface:  basically a multiplexed shift register.
605         Its three signal wires hold a clock (SCK, often in the range
606         of 1-20 MHz), a "Master Out, Slave In" (MOSI) data line, and
607         a "Master In, Slave Out" (MISO) data line.
608         SPI is a full duplex protocol; for each bit shifted out the
609         MOSI line (one per clock) another is shifted in on the MISO line.
610         Those bits are assembled into words of various sizes on the
611         way to and from system memory.
612         An additional chipselect line is usually active-low (nCS);
613         four signals are normally used for each peripheral, plus
614         sometimes an interrupt.
615   </para>
616   <para>
617         The SPI bus facilities listed here provide a generalized
618         interface to declare SPI busses and devices, manage them
619         according to the standard Linux driver model, and perform
620         input/output operations.
621         At this time, only "master" side interfaces are supported,
622         where Linux talks to SPI peripherals and does not implement
623         such a peripheral itself.
624         (Interfaces to support implementing SPI slaves would
625         necessarily look different.)
626   </para>
627   <para>
628         The programming interface is structured around two kinds of driver,
629         and two kinds of device.
630         A "Controller Driver" abstracts the controller hardware, which may
631         be as simple as a set of GPIO pins or as complex as a pair of FIFOs
632         connected to dual DMA engines on the other side of the SPI shift
633         register (maximizing throughput).  Such drivers bridge between
634         whatever bus they sit on (often the platform bus) and SPI, and
635         expose the SPI side of their device as a
636         <structname>struct spi_master</structname>.
637         SPI devices are children of that master, represented as a
638         <structname>struct spi_device</structname> and manufactured from
639         <structname>struct spi_board_info</structname> descriptors which
640         are usually provided by board-specific initialization code.
641         A <structname>struct spi_driver</structname> is called a
642         "Protocol Driver", and is bound to a spi_device using normal
643         driver model calls.
644   </para>
645   <para>
646         The I/O model is a set of queued messages.  Protocol drivers
647         submit one or more <structname>struct spi_message</structname>
648         objects, which are processed and completed asynchronously.
649         (There are synchronous wrappers, however.)  Messages are
650         built from one or more <structname>struct spi_transfer</structname>
651         objects, each of which wraps a full duplex SPI transfer.
652         A variety of protocol tweaking options are needed, because
653         different chips adopt very different policies for how they
654         use the bits transferred with SPI.
655   </para>
656 !Iinclude/linux/spi/spi.h
657 !Fdrivers/spi/spi.c spi_register_board_info
658 !Edrivers/spi/spi.c
659   </chapter>
660
661   <chapter id="i2c">
662      <title>I<superscript>2</superscript>C and SMBus Subsystem</title>
663
664      <para>
665         I<superscript>2</superscript>C (or without fancy typography, "I2C")
666         is an acronym for the "Inter-IC" bus, a simple bus protocol which is
667         widely used where low data rate communications suffice.
668         Since it's also a licensed trademark, some vendors use another
669         name (such as "Two-Wire Interface", TWI) for the same bus.
670         I2C only needs two signals (SCL for clock, SDA for data), conserving
671         board real estate and minimizing signal quality issues.
672         Most I2C devices use seven bit addresses, and bus speeds of up
673         to 400 kHz; there's a high speed extension (3.4 MHz) that's not yet
674         found wide use.
675         I2C is a multi-master bus; open drain signaling is used to
676         arbitrate between masters, as well as to handshake and to
677         synchronize clocks from slower clients.
678      </para>
679
680      <para>
681         The Linux I2C programming interfaces support only the master
682         side of bus interactions, not the slave side.
683         The programming interface is structured around two kinds of driver,
684         and two kinds of device.
685         An I2C "Adapter Driver" abstracts the controller hardware; it binds
686         to a physical device (perhaps a PCI device or platform_device) and
687         exposes a <structname>struct i2c_adapter</structname> representing
688         each I2C bus segment it manages.
689         On each I2C bus segment will be I2C devices represented by a
690         <structname>struct i2c_client</structname>.  Those devices will
691         be bound to a <structname>struct i2c_driver</structname>,
692         which should follow the standard Linux driver model.
693         (At this writing, a legacy model is more widely used.)
694         There are functions to perform various I2C protocol operations; at
695         this writing all such functions are usable only from task context.
696      </para>
697
698      <para>
699         The System Management Bus (SMBus) is a sibling protocol.  Most SMBus
700         systems are also I2C conformant.  The electrical constraints are
701         tighter for SMBus, and it standardizes particular protocol messages
702         and idioms.  Controllers that support I2C can also support most
703         SMBus operations, but SMBus controllers don't support all the protocol
704         options that an I2C controller will.
705         There are functions to perform various SMBus protocol operations,
706         either using I2C primitives or by issuing SMBus commands to
707         i2c_adapter devices which don't support those I2C operations.
708      </para>
709
710 !Iinclude/linux/i2c.h
711 !Fdrivers/i2c/i2c-boardinfo.c i2c_register_board_info
712 !Edrivers/i2c/i2c-core.c
713   </chapter>
714
715   <chapter id="splice">
716       <title>splice API</title>
717   <para>
718         splice is a method for moving blocks of data around inside the
719         kernel, without continually transferring them between the kernel
720         and user space.
721   </para>
722 !Ffs/splice.c
723   </chapter>
724
725   <chapter id="pipes">
726       <title>pipes API</title>
727   <para>
728         Pipe interfaces are all for in-kernel (builtin image) use.
729         They are not exported for use by modules.
730   </para>
731 !Iinclude/linux/pipe_fs_i.h
732 !Ffs/pipe.c
733   </chapter>
734
735 </book>