rapidio.tmpl 4.4 KB

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