Documentation/DocBook/kernel-api.tmpl

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[]>
   2 <book id="LinuxKernelAPI">
   3  <bookinfo>
   4   <title>The Linux Kernel API</title>
   5
   6   <legalnotice>
   7    <para>
   8      This documentation is free software; you can redistribute
   9      it and/or modify it under the terms of the GNU General Public
  10      License as published by the Free Software Foundation; either
  11      version 2 of the License, or (at your option) any later
  12      version.
  13    </para>
  14
  15    <para>
  16      This program is distributed in the hope that it will be
  17      useful, but WITHOUT ANY WARRANTY; without even the implied
  18      warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19      See the GNU General Public License for more details.
  20    </para>
  21
  22    <para>
  23      You should have received a copy of the GNU General Public
  24      License along with this program; if not, write to the Free
  25      Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  26      MA 02111-1307 USA
  27    </para>
  28
  29    <para>
  30      For more details see the file COPYING in the source
  31      distribution of Linux.
  32    </para>
  33   </legalnotice>
  34  </bookinfo>
  35
  36 <toc></toc>
  37   <chapter id="adt">
  38      <title>Data Types</title>
  39      <sect1><title>Doubly Linked Lists</title>
  40 !Iinclude/linux/list.h
  41      </sect1>
  42   </chapter>
  43
  44   <chapter id="mm">
  45      <title>Memory Management in Linux</title>
  46      <sect1><title>The Slab Cache</title>
  47 !Emm/slab.c
  48       </sect1>
  49   </chapter>
  50
  51   <chapter id="vfs">
  52      <title>The Linux VFS</title>
  53      <sect1><title>The Directory Cache</title>
  54 !Efs/dcache.c
  55 !Iinclude/linux/dcache.h
  56      </sect1>
  57      <sect1><title>Inode Handling</title>
  58 !Efs/inode.c
  59 !Efs/bad_inode.c
  60      </sect1>
  61      <sect1><title>Registration and Superblocks</title>
  62 !Efs/super.c
  63      </sect1>
  64      <sect1><title>File Locks</title>
  65 !Efs/locks.c
  66 !Ifs/locks.c
  67      </sect1>
  68   </chapter>
  69
  70   <chapter id="netcore">
  71      <title>Linux Networking</title>
  72      <sect1><title>Socket Buffer Functions</title>
  73 !Iinclude/linux/skbuff.h
  74 !Enet/core/skbuff.c
  75      </sect1>
  76      <sect1><title>Socket Filter</title>
  77 !Enet/core/filter.c
  78      </sect1>
  79   </chapter>
  80
  81   <chapter id="netdev">
  82      <title>Network device support</title>
  83      <sect1><title>Driver Support</title>
  84 !Edrivers/net/net_init.c
  85 !Enet/core/dev.c
  86      </sect1>
  87      <sect1><title>8390 Based Network Cards</title>
  88 !Edrivers/net/8390.c
  89      </sect1>
  90      <sect1><title>Synchronous PPP</title>
  91 !Edrivers/net/wan/syncppp.c
  92      </sect1>
  93   </chapter>
  94
  95   <chapter id="modload">
  96      <title>Module Loading</title>
  97 !Ekernel/kmod.c
  98   </chapter>
  99
 100   <chapter id="hardware">
 101      <title>Hardware Interfaces</title>
 102      <sect1><title>Interrupt Handling</title>
 103 !Iarch/i386/kernel/irq.c
 104      </sect1>
 105
 106      <sect1><title>MTRR Handling</title>
 107 !Earch/i386/kernel/mtrr.c
 108      </sect1>
 109      <sect1><title>PCI Support Library</title>
 110 !Edrivers/pci/pci.c
 111      </sect1>
 112      <sect1><title>MCA Architecture</title>
 113         <sect2><title>MCA Device Functions</title>
 114 !Earch/i386/kernel/mca.c
 115         </sect2>
 116         <sect2><title>MCA Bus DMA</title>
 117 !Iinclude/asm-i386/mca_dma.h
 118         </sect2>
 119      </sect1>
 120   </chapter>
 121
 122   <chapter id="devfs">
 123      <title>The Device File System</title>
 124 !Efs/devfs/base.c
 125   </chapter>
 126
 127   <chapter id="pmfuncs">
 128      <title>Power Management</title>
 129 !Ekernel/pm.c
 130   </chapter>
 131
 132   <chapter id="blkdev">
 133      <title>Block Devices</title>
 134 !Edrivers/block/ll_rw_blk.c
 135   </chapter>
 136
 137   <chapter id="miscdev">
 138      <title>Miscellaneous Devices</title>
 139 !Edrivers/char/misc.c
 140   </chapter>
 141
 142   <chapter id="viddev">
 143      <title>Video4Linux</title>
 144 !Edrivers/media/video/videodev.c
 145   </chapter>
 146
 147   <chapter id="snddev">
 148      <title>Sound Devices</title>
 149 !Edrivers/sound/sound_core.c
 150 !Idrivers/sound/sound_firmware.c
 151   </chapter>
 152
 153   <chapter id="usb">
 154      <title>USB Devices</title>
 155 !Edrivers/usb/usb.c
 156   </chapter>
 157
 158   <chapter id="uart16x50">
 159      <title>16x50 UART Driver</title>
 160 !Edrivers/char/serial.c
 161   </chapter>
 162
 163   <chapter id="z85230">
 164      <title>Z85230 Support Library</title>
 165 !Edrivers/net/wan/z85230.c
 166   </chapter>
 167
 168
 169 </book>