tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs-rst: convert rapidio book to ReST
Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
+110
-157
+2
-2
Documentation/DocBook/Makefile
+2
-2
Documentation/DocBook/Makefile
-155
Documentation/DocBook/rapidio.tmpl
-155
Documentation/DocBook/rapidio.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
-
<!ENTITY rapidio SYSTEM "rapidio.xml">
5
-
]>
6
-
7
-
<book id="RapidIO-Guide">
8
-
<bookinfo>
9
-
<title>RapidIO Subsystem Guide</title>
10
-
11
-
<authorgroup>
12
-
<author>
13
-
<firstname>Matt</firstname>
14
-
<surname>Porter</surname>
15
-
<affiliation>
16
-
<address>
17
-
<email>mporter@kernel.crashing.org</email>
18
-
<email>mporter@mvista.com</email>
19
-
</address>
20
-
</affiliation>
21
-
</author>
22
-
</authorgroup>
23
-
24
-
<copyright>
25
-
<year>2005</year>
26
-
<holder>MontaVista Software, Inc.</holder>
27
-
</copyright>
28
-
29
-
<legalnotice>
30
-
<para>
31
-
This documentation is free software; you can redistribute
32
-
it and/or modify it under the terms of the GNU General Public
33
-
License version 2 as published by the Free Software Foundation.
34
-
</para>
35
-
36
-
<para>
37
-
This program is distributed in the hope that it will be
38
-
useful, but WITHOUT ANY WARRANTY; without even the implied
39
-
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
40
-
See the GNU General Public License for more details.
41
-
</para>
42
-
43
-
<para>
44
-
You should have received a copy of the GNU General Public
45
-
License along with this program; if not, write to the Free
46
-
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
47
-
MA 02111-1307 USA
48
-
</para>
49
-
50
-
<para>
51
-
For more details see the file COPYING in the source
52
-
distribution of Linux.
53
-
</para>
54
-
</legalnotice>
55
-
</bookinfo>
56
-
57
-
<toc></toc>
58
-
59
-
<chapter id="intro">
60
-
<title>Introduction</title>
61
-
<para>
62
-
RapidIO is a high speed switched fabric interconnect with
63
-
features aimed at the embedded market. RapidIO provides
64
-
support for memory-mapped I/O as well as message-based
65
-
transactions over the switched fabric network. RapidIO has
66
-
a standardized discovery mechanism not unlike the PCI bus
67
-
standard that allows simple detection of devices in a
68
-
network.
69
-
</para>
70
-
<para>
71
-
This documentation is provided for developers intending
72
-
to support RapidIO on new architectures, write new drivers,
73
-
or to understand the subsystem internals.
74
-
</para>
75
-
</chapter>
76
-
77
-
<chapter id="bugs">
78
-
<title>Known Bugs and Limitations</title>
79
-
80
-
<sect1 id="known_bugs">
81
-
<title>Bugs</title>
82
-
<para>None. ;)</para>
83
-
</sect1>
84
-
<sect1 id="Limitations">
85
-
<title>Limitations</title>
86
-
<para>
87
-
<orderedlist>
88
-
<listitem><para>Access/management of RapidIO memory regions is not supported</para></listitem>
89
-
<listitem><para>Multiple host enumeration is not supported</para></listitem>
90
-
</orderedlist>
91
-
</para>
92
-
</sect1>
93
-
</chapter>
94
-
95
-
<chapter id="drivers">
96
-
<title>RapidIO driver interface</title>
97
-
<para>
98
-
Drivers are provided a set of calls in order
99
-
to interface with the subsystem to gather info
100
-
on devices, request/map memory region resources,
101
-
and manage mailboxes/doorbells.
102
-
</para>
103
-
<sect1 id="Functions">
104
-
<title>Functions</title>
105
-
!Iinclude/linux/rio_drv.h
106
-
!Edrivers/rapidio/rio-driver.c
107
-
!Edrivers/rapidio/rio.c
108
-
</sect1>
109
-
</chapter>
110
-
111
-
<chapter id="internals">
112
-
<title>Internals</title>
113
-
114
-
<para>
115
-
This chapter contains the autogenerated documentation of the RapidIO
116
-
subsystem.
117
-
</para>
118
-
119
-
<sect1 id="Structures"><title>Structures</title>
120
-
!Iinclude/linux/rio.h
121
-
</sect1>
122
-
<sect1 id="Enumeration_and_Discovery"><title>Enumeration and Discovery</title>
123
-
!Idrivers/rapidio/rio-scan.c
124
-
</sect1>
125
-
<sect1 id="Driver_functionality"><title>Driver functionality</title>
126
-
!Idrivers/rapidio/rio.c
127
-
!Idrivers/rapidio/rio-access.c
128
-
</sect1>
129
-
<sect1 id="Device_model_support"><title>Device model support</title>
130
-
!Idrivers/rapidio/rio-driver.c
131
-
</sect1>
132
-
<sect1 id="PPC32_support"><title>PPC32 support</title>
133
-
!Iarch/powerpc/sysdev/fsl_rio.c
134
-
</sect1>
135
-
</chapter>
136
-
137
-
<chapter id="credits">
138
-
<title>Credits</title>
139
-
<para>
140
-
The following people have contributed to the RapidIO
141
-
subsystem directly or indirectly:
142
-
<orderedlist>
143
-
<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
144
-
<listitem><para>Randy Vinson<email>rvinson@mvista.com</email></para></listitem>
145
-
<listitem><para>Dan Malek<email>dan@embeddedalley.com</email></para></listitem>
146
-
</orderedlist>
147
-
</para>
148
-
<para>
149
-
The following people have contributed to this document:
150
-
<orderedlist>
151
-
<listitem><para>Matt Porter<email>mporter@kernel.crashing.org</email></para></listitem>
152
-
</orderedlist>
153
-
</para>
154
-
</chapter>
155
-
</book>
+1
Documentation/driver-api/index.rst
+1
Documentation/driver-api/index.rst
+107
Documentation/driver-api/rapidio.rst
+107
Documentation/driver-api/rapidio.rst
···
1
+
=======================
2
+
RapidIO Subsystem Guide
3
+
=======================
4
+
5
+
:Author: Matt Porter
6
+
7
+
Introduction
8
+
============
9
+
10
+
RapidIO is a high speed switched fabric interconnect with features aimed
11
+
at the embedded market. RapidIO provides support for memory-mapped I/O
12
+
as well as message-based transactions over the switched fabric network.
13
+
RapidIO has a standardized discovery mechanism not unlike the PCI bus
14
+
standard that allows simple detection of devices in a network.
15
+
16
+
This documentation is provided for developers intending to support
17
+
RapidIO on new architectures, write new drivers, or to understand the
18
+
subsystem internals.
19
+
20
+
Known Bugs and Limitations
21
+
==========================
22
+
23
+
Bugs
24
+
----
25
+
26
+
None. ;)
27
+
28
+
Limitations
29
+
-----------
30
+
31
+
1. Access/management of RapidIO memory regions is not supported
32
+
33
+
2. Multiple host enumeration is not supported
34
+
35
+
RapidIO driver interface
36
+
========================
37
+
38
+
Drivers are provided a set of calls in order to interface with the
39
+
subsystem to gather info on devices, request/map memory region
40
+
resources, and manage mailboxes/doorbells.
41
+
42
+
Functions
43
+
---------
44
+
45
+
.. kernel-doc:: include/linux/rio_drv.h
46
+
:internal:
47
+
48
+
.. kernel-doc:: drivers/rapidio/rio-driver.c
49
+
:export:
50
+
51
+
.. kernel-doc:: drivers/rapidio/rio.c
52
+
:export:
53
+
54
+
Internals
55
+
=========
56
+
57
+
This chapter contains the autogenerated documentation of the RapidIO
58
+
subsystem.
59
+
60
+
Structures
61
+
----------
62
+
63
+
.. kernel-doc:: include/linux/rio.h
64
+
:internal:
65
+
66
+
Enumeration and Discovery
67
+
-------------------------
68
+
69
+
.. kernel-doc:: drivers/rapidio/rio-scan.c
70
+
:internal:
71
+
72
+
Driver functionality
73
+
--------------------
74
+
75
+
.. kernel-doc:: drivers/rapidio/rio.c
76
+
:internal:
77
+
78
+
.. kernel-doc:: drivers/rapidio/rio-access.c
79
+
:internal:
80
+
81
+
Device model support
82
+
--------------------
83
+
84
+
.. kernel-doc:: drivers/rapidio/rio-driver.c
85
+
:internal:
86
+
87
+
PPC32 support
88
+
-------------
89
+
90
+
.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
91
+
:internal:
92
+
93
+
Credits
94
+
=======
95
+
96
+
The following people have contributed to the RapidIO subsystem directly
97
+
or indirectly:
98
+
99
+
1. Matt Porter\ mporter@kernel.crashing.org
100
+
101
+
2. Randy Vinson\ rvinson@mvista.com
102
+
103
+
3. Dan Malek\ dan@embeddedalley.com
104
+
105
+
The following people have contributed to this document:
106
+
107
+
1. Matt Porter\ mporter@kernel.crashing.org