diff options
Diffstat (limited to 'Documentation/DocBook')
| -rw-r--r-- | Documentation/DocBook/Makefile | 2 | ||||
| -rw-r--r-- | Documentation/DocBook/journal-api.tmpl | 2 | ||||
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 7 | ||||
| -rw-r--r-- | Documentation/DocBook/rapidio.tmpl | 160 |
4 files changed, 165 insertions, 6 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index fa3e29ad8a4..7018f5c6a44 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -10,7 +10,7 @@ DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ procfs-guide.xml writing_usb_driver.xml \ sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \ - gadget.xml libata.xml mtdnand.xml librs.xml + gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml ### # The build process is as follows (targets): diff --git a/Documentation/DocBook/journal-api.tmpl b/Documentation/DocBook/journal-api.tmpl index 341aaa4ce48..2077f9a28c1 100644 --- a/Documentation/DocBook/journal-api.tmpl +++ b/Documentation/DocBook/journal-api.tmpl @@ -306,7 +306,7 @@ an example. </para> <sect1><title>Journal Level</title> !Efs/jbd/journal.c -!Efs/jbd/recovery.c +!Ifs/jbd/recovery.c </sect1> <sect1><title>Transasction Level</title> !Efs/jbd/transaction.c diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index ec474e5a25e..a8316b1a3e3 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl @@ -118,7 +118,7 @@ X!Ilib/string.c </sect1> <sect1><title>User Space Memory Access</title> !Iinclude/asm-i386/uaccess.h -!Iarch/i386/lib/usercopy.c +!Earch/i386/lib/usercopy.c </sect1> <sect1><title>More Memory Management Functions</title> !Iinclude/linux/rmap.h @@ -174,7 +174,6 @@ X!Ilib/string.c <title>The Linux VFS</title> <sect1><title>The Filesystem types</title> !Iinclude/linux/fs.h -!Einclude/linux/fs.h </sect1> <sect1><title>The Directory Cache</title> !Efs/dcache.c @@ -266,7 +265,7 @@ X!Ekernel/module.c <chapter id="hardware"> <title>Hardware Interfaces</title> <sect1><title>Interrupt Handling</title> -!Ikernel/irq/manage.c +!Ekernel/irq/manage.c </sect1> <sect1><title>Resources Management</title> @@ -501,7 +500,7 @@ KAO --> !Edrivers/video/modedb.c </sect1> <sect1><title>Frame Buffer Macintosh Video Mode Database</title> -!Idrivers/video/macmodes.c +!Edrivers/video/macmodes.c </sect1> <sect1><title>Frame Buffer Fonts</title> <para> diff --git a/Documentation/DocBook/rapidio.tmpl b/Documentation/DocBook/rapidio.tmpl new file mode 100644 index 00000000000..1becf27ba27 --- /dev/null +++ b/Documentation/DocBook/rapidio.tmpl @@ -0,0 +1,160 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ + <!ENTITY rapidio SYSTEM "rapidio.xml"> + ]> + +<book id="RapidIO-Guide"> + <bookinfo> + <title>RapidIO Subsystem Guide</title> + + <authorgroup> + <author> + <firstname>Matt</firstname> + <surname>Porter</surname> + <affiliation> + <address> + <email>mporter@kernel.crashing.org</email> + <email>mporter@mvista.com</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2005</year> + <holder>MontaVista Software, Inc.</holder> + </copyright> + + <legalnotice> + <para> + This documentation is free software; you can redistribute + it and/or modify it under the terms of the GNU General Public + License version 2 as published by the Free Software Foundation. + </para> + + <para> + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU General Public License for more details. + </para> + + <para> + You should have received a copy of the GNU General Public + License along with this program; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, + MA 02111-1307 USA + </para> + + <para> + For more details see the file COPYING in the source + distribution of Linux. + </para> + </legalnotice> + </bookinfo> + +<toc></toc> + + <chapter id="intro"> + <title>Introduction</title> + <para> + RapidIO is a high speed switched fabric interconnect with + features aimed at the embedded market. RapidIO provides + support for memory-mapped I/O as well as message-based + transactions over the switched fabric network. RapidIO has + a standardized discovery mechanism not unlike the PCI bus + standard that allows simple detection of devices in a + network. + </para> + <para> + This documentation is provided for developers intending + to support RapidIO on new architectures, write new drivers, + or to understand the subsystem internals. + </para> + </chapter> + + <chapter id="bugs"> + <title>Known Bugs and Limitations</title> + + <sect1> + <title>Bugs</title> + <para>None. ;)</para> + </sect1> + <sect1> + <title>Limitations</title> + <para> + <orderedlist> + <listitem><para>Access/management of RapidIO memory regions is not supported</para></listitem> + <listitem><para>Multiple host enumeration is not supported</para></listitem> + </orderedlist> + </para> + </sect1> + </chapter> + + <chapter id="drivers"> + <title>RapidIO driver interface</title> + <para> + Drivers are provided a set of calls in order + to interface with the subsystem to gather info + on devices, request/map memory region resources, + and manage mailboxes/doorbells. + </para> + <sect1> + <title>Functions</title> +!Iinclude/linux/rio_drv.h +!Edrivers/rapidio/rio-driver.c +!Edrivers/rapidio/rio.c + </sect1> + </chapter> + + <chapter id="internals"> + <title>Internals</title> + + <para> + This chapter contains the autogenerated documentation of the RapidIO + subsystem. + </para> + + <sect1><title>Structures</title> +!Iinclude/linux/rio.h + </sect1> + <sect1><title>Enumeration and Discovery</title> +!Idrivers/rapidio/rio-scan.c + </sect1> + <sect1><title>Driver functionality</title> +!Idrivers/rapidio/rio.c +!Idrivers/rapidio/rio-access.c + </sect1> + <sect1><title>Device model support</title> +!Idrivers/rapidio/rio-driver.c + </sect1> + <sect1><title>Sysfs support</title> +!Idrivers/rapidio/rio-sysfs.c + </sect1> + <sect1><title>PPC32 support</title> +!Iarch/ppc/kernel/rio.c +!Earch/ppc/syslib/ppc85xx_rio.c +!Iarch/ppc/syslib/ppc85xx_rio.c + </sect1> + </chapter> + + <chapter id="credits"> + <title>Credits</title> + <para> + The following people have contributed to the RapidIO + subsystem directly or indirectly: + <orderedlist> + <listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem> + <listitem><para>Randy Vinson<email>rvinson@mvista.com</email></para></listitem> + <listitem><para>Dan Malek<email>dan@embeddedalley.com</email></para></listitem> + </orderedlist> + </para> + <para> + The following people have contributed to this document: + <orderedlist> + <listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem> + </orderedlist> + </para> + </chapter> +</book> |