X-Git-Url: http://ftp.safe.ca/?a=blobdiff_plain;f=Documentation%2FDocBook%2Fkernel-api.tmpl;h=44b3def961a24c85ead76a4ed713a1675dd28e58;hb=d8008562379b927758ca08eded1508c68d9beb4e;hp=31b727ceb127b109838464b9137474c90a4355f6;hpb=862f5f0133f1c8a179dd93adc03d43f8f7e8bac5;p=safe%2Fjmp%2Flinux-2.6
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 31b727c..44b3def 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -38,49 +38,6 @@
-
- Driver Basics
- Driver Entry and Exit points
-!Iinclude/linux/init.h
-
-
- Atomic and pointer manipulation
-!Iinclude/asm-i386/atomic.h
-!Iinclude/asm-i386/unaligned.h
-
-
- Delaying, scheduling, and timer routines
-!Iinclude/linux/sched.h
-!Ekernel/sched.c
-!Ekernel/timer.c
-
- High-resolution timers
-!Iinclude/linux/ktime.h
-!Iinclude/linux/hrtimer.h
-!Ekernel/hrtimer.c
-
- Internal Functions
-!Ikernel/exit.c
-!Ikernel/signal.c
-
-
- Kernel objects manipulation
-
-!Elib/kobject.c
-
-
- Kernel utility functions
-!Iinclude/linux/kernel.h
-!Ekernel/printk.c
-!Ekernel/panic.c
-!Ekernel/sys.c
-!Ekernel/rcupdate.c
-
-
-
-
Data Types
Doubly Linked Lists
@@ -110,7 +67,32 @@ X!Ilib/string.c
!Elib/string.c
Bit Operations
-!Iinclude/asm-i386/bitops.h
+!Iarch/x86/include/asm/bitops.h
+
+
+
+
+ Basic Kernel Library Functions
+
+
+ The Linux kernel provides more basic utility functions.
+
+
+ Bitmap Operations
+!Elib/bitmap.c
+!Ilib/bitmap.c
+
+
+ Command-line Parsing
+!Elib/cmdline.c
+
+
+ CRC Functions
+!Elib/crc7.c
+!Elib/crc16.c
+!Elib/crc-itu-t.c
+!Elib/crc32.c
+!Elib/crc-ccitt.c
@@ -121,16 +103,17 @@ X!Ilib/string.c
!Emm/slab.c
User Space Memory Access
-!Iinclude/asm-i386/uaccess.h
-!Earch/i386/lib/usercopy.c
+!Iarch/x86/include/asm/uaccess_32.h
+!Earch/x86/lib/usercopy_32.c
More Memory Management Functions
-!Iinclude/linux/rmap.h
!Emm/readahead.c
!Emm/filemap.c
!Emm/memory.c
!Emm/vmalloc.c
+!Imm/page_alloc.c
!Emm/mempool.c
+!Emm/dmapool.c
!Emm/page-writeback.c
!Emm/truncate.c
@@ -153,103 +136,19 @@ X!Ilib/string.c
-
- The proc filesystem
-
- sysctl interface
-!Ekernel/sysctl.c
-
-
- proc filesystem interface
-!Ifs/proc/base.c
-
-
-
-
- The debugfs filesystem
-
- debugfs interface
-!Efs/debugfs/inode.c
-!Efs/debugfs/file.c
-
-
-
-
- The Linux VFS
- The Filesystem types
-!Iinclude/linux/fs.h
-
- The Directory Cache
-!Efs/dcache.c
-!Iinclude/linux/dcache.h
-
- Inode Handling
-!Efs/inode.c
-!Efs/bad_inode.c
-
- Registration and Superblocks
-!Efs/super.c
-
- File Locks
-!Efs/locks.c
-!Ifs/locks.c
-
- Other Functions
-!Efs/mpage.c
-!Efs/namei.c
-!Efs/buffer.c
-!Efs/bio.c
-!Efs/seq_file.c
-!Efs/filesystems.c
-!Efs/fs-writeback.c
-!Efs/block_dev.c
-
-
+
+ relay interface support
-
- Linux Networking
- Networking Base Types
-!Iinclude/linux/net.h
-
- Socket Buffer Functions
-!Iinclude/linux/skbuff.h
-!Iinclude/net/sock.h
-!Enet/socket.c
-!Enet/core/skbuff.c
-!Enet/core/sock.c
-!Enet/core/datagram.c
-!Enet/core/stream.c
-
- Socket Filter
-!Enet/core/filter.c
-
- Generic Network Statistics
-!Iinclude/linux/gen_stats.h
-!Enet/core/gen_stats.c
-!Enet/core/gen_estimator.c
-
- SUN RPC subsystem
-
-!Enet/sunrpc/xdr.c
-!Enet/sunrpc/svcsock.c
-!Enet/sunrpc/sched.c
-
-
+
+ Relay interface support
+ is designed to provide an efficient mechanism for tools and
+ facilities to relay large amounts of data from kernel space to
+ user space.
+
-
- Network device support
- Driver Support
-!Enet/core/dev.c
-!Enet/ethernet/eth.c
-!Iinclude/linux/etherdevice.h
-
-
- Synchronous PPP
-!Edrivers/net/wan/syncppp.c
+ relay interface
+!Ekernel/relay.c
+!Ikernel/relay.c
@@ -274,28 +173,37 @@ X!Ekernel/module.c
!Ekernel/irq/manage.c
+ DMA Channels
+!Ekernel/dma.c
+
+
Resources Management
+!Ikernel/resource.c
!Ekernel/resource.c
MTRR Handling
-!Earch/i386/kernel/cpu/mtrr/main.c
+!Earch/x86/kernel/cpu/mtrr/main.c
+
PCI Support Library
!Edrivers/pci/pci.c
!Edrivers/pci/pci-driver.c
!Edrivers/pci/remove.c
-!Edrivers/pci/pci-acpi.c
-
+!Edrivers/pci/search.c
!Edrivers/pci/msi.c
!Edrivers/pci/bus.c
+!Edrivers/pci/access.c
+!Edrivers/pci/irq.c
+!Edrivers/pci/htirq.c
!Edrivers/pci/probe.c
+!Edrivers/pci/slot.c
!Edrivers/pci/rom.c
+!Edrivers/pci/iov.c
+!Idrivers/pci/pci-sysfs.c
PCI Hotplug Support Library
!Edrivers/pci/hotplug/pci_hotplug_core.c
@@ -303,33 +211,32 @@ X!Edrivers/pci/hotplug.c
MCA Architecture
MCA Device Functions
- Refer to the file arch/i386/kernel/mca.c for more information.
+ Refer to the file arch/x86/kernel/mca_32.c for more information.
MCA Bus DMA
-!Iinclude/asm-i386/mca_dma.h
+!Iarch/x86/include/asm/mca_dma.h
-
- The Device File System
-!Efs/devfs/base.c
-
-
-
- The Filesystem for Exporting Kernel Objects
-!Efs/sysfs/file.c
-!Efs/sysfs/symlink.c
-!Efs/sysfs/bin.c
+
+ Firmware Interfaces
+ DMI Interfaces
+!Edrivers/firmware/dmi_scan.c
+
+ EDD Interfaces
+!Idrivers/firmware/edd.c
+
Security Framework
-!Esecurity/security.c
+!Isecurity/security.c
+!Esecurity/inode.c
@@ -344,69 +251,26 @@ X!Earch/i386/kernel/mca.c
!Ikernel/acct.c
-
- Power Management
-!Ekernel/power/pm.c
-
-
-
- Device drivers infrastructure
- Device Drivers Base
-
-!Edrivers/base/driver.c
-!Edrivers/base/core.c
-!Edrivers/base/firmware_class.c
-!Edrivers/base/transport_class.c
-!Edrivers/base/dmapool.c
-
-!Edrivers/base/sys.c
-
-!Edrivers/base/platform.c
-!Edrivers/base/bus.c
-
- Device Drivers Power Management
-!Edrivers/base/power/main.c
-!Edrivers/base/power/resume.c
-!Edrivers/base/power/suspend.c
-
- Device Drivers ACPI Support
-
-!Edrivers/acpi/scan.c
-!Idrivers/acpi/scan.c
-
-
- Device drivers PnP support
-!Edrivers/pnp/core.c
-
-!Edrivers/pnp/card.c
-!Edrivers/pnp/driver.c
-!Edrivers/pnp/manager.c
-!Edrivers/pnp/support.c
-
-
-
-
Block Devices
-!Eblock/ll_rw_blk.c
+!Eblock/blk-core.c
+!Iblock/blk-core.c
+!Eblock/blk-map.c
+!Iblock/blk-sysfs.c
+!Eblock/blk-settings.c
+!Eblock/blk-exec.c
+!Eblock/blk-barrier.c
+!Eblock/blk-tag.c
+!Iblock/blk-tag.c
+!Eblock/blk-integrity.c
+!Ikernel/trace/blktrace.c
+!Iblock/genhd.c
+!Eblock/genhd.c
+
+
+
+ Char devices
+!Efs/char_dev.c
@@ -414,119 +278,58 @@ X!Edrivers/pnp/system.c
!Edrivers/char/misc.c
-
- Video4Linux
-!Edrivers/media/video/videodev.c
-
-
-
- Sound Devices
-!Iinclude/sound/core.h
-!Esound/sound_core.c
-!Iinclude/sound/pcm.h
-!Esound/core/pcm.c
-!Esound/core/device.c
-!Esound/core/info.c
-!Esound/core/rawmidi.c
-!Esound/core/sound.c
-!Esound/core/memory.c
-!Esound/core/pcm_memory.c
-!Esound/core/init.c
-!Esound/core/isadma.c
-!Esound/core/control.c
-!Esound/core/pcm_lib.c
-!Esound/core/hwdep.c
-!Esound/core/pcm_native.c
-!Esound/core/memalloc.c
-
-
-
-
- 16x50 UART Driver
-!Iinclude/linux/serial_core.h
-!Edrivers/serial/serial_core.c
-!Edrivers/serial/8250.c
-
-
-
- Z85230 Support Library
-!Edrivers/net/wan/z85230.c
-
-
-
- Frame Buffer Library
-
-
- The frame buffer drivers depend heavily on four data structures.
- These structures are declared in include/linux/fb.h. They are
- fb_info, fb_var_screeninfo, fb_fix_screeninfo and fb_monospecs.
- The last three can be made available to and from userland.
-
+
+ Clock Framework
- fb_info defines the current state of a particular video card.
- Inside fb_info, there exists a fb_ops structure which is a
- collection of needed functions to make fbdev and fbcon work.
- fb_info is only visible to the kernel.
+ The clock framework defines programming interfaces to support
+ software management of the system clock tree.
+ This framework is widely used with System-On-Chip (SOC) platforms
+ to support power management and various devices which may need
+ custom clock rates.
+ Note that these "clocks" don't relate to timekeeping or real
+ time clocks (RTCs), each of which have separate frameworks.
+ These struct clk instances may be used
+ to manage for example a 96 MHz signal that is used to shift bits
+ into and out of peripherals or busses, or otherwise trigger
+ synchronous state machine transitions in system hardware.
- fb_var_screeninfo is used to describe the features of a video card
- that are user defined. With fb_var_screeninfo, things such as
- depth and the resolution may be defined.
+ Power management is supported by explicit software clock gating:
+ unused clocks are disabled, so the system doesn't waste power
+ changing the state of transistors that aren't in active use.
+ On some systems this may be backed by hardware clock gating,
+ where clocks are gated without being disabled in software.
+ Sections of chips that are powered but not clocked may be able
+ to retain their last state.
+ This low power state is often called a retention
+ mode.
+ This mode still incurs leakage currents, especially with finer
+ circuit geometries, but for CMOS circuits power is mostly used
+ by clocked state changes.
- The next structure is fb_fix_screeninfo. This defines the
- properties of a card that are created when a mode is set and can't
- be changed otherwise. A good example of this is the start of the
- frame buffer memory. This "locks" the address of the frame buffer
- memory, so that it cannot be changed or moved.
+ Power-aware drivers only enable their clocks when the device
+ they manage is in active use. Also, system sleep states often
+ differ according to which clock domains are active: while a
+ "standby" state may allow wakeup from several active domains, a
+ "mem" (suspend-to-RAM) state may require a more wholesale shutdown
+ of clocks derived from higher speed PLLs and oscillators, limiting
+ the number of possible wakeup event sources. A driver's suspend
+ method may need to be aware of system-specific clock constraints
+ on the target sleep state.
- The last structure is fb_monospecs. In the old API, there was
- little importance for fb_monospecs. This allowed for forbidden things
- such as setting a mode of 800x600 on a fix frequency monitor. With
- the new API, fb_monospecs prevents such things, and if used
- correctly, can prevent a monitor from being cooked. fb_monospecs
- will not be useful until kernels 2.5.x.
+ Some platforms support programmable clock generators. These
+ can be used by external chips of various kinds, such as other
+ CPUs, multimedia codecs, and devices with strict requirements
+ for interface clocking.
- Frame Buffer Memory
-!Edrivers/video/fbmem.c
-
-
- Frame Buffer Colormap
-!Edrivers/video/fbcmap.c
-
-
- Frame Buffer Video Mode Database
-!Idrivers/video/modedb.c
-!Edrivers/video/modedb.c
-
- Frame Buffer Macintosh Video Mode Database
-!Edrivers/video/macmodes.c
-
- Frame Buffer Fonts
-
- Refer to the file drivers/video/console/fonts.c for more information.
-
-
-
+!Iinclude/linux/clk.h
+