0001 =======================
0002 RapidIO Subsystem Guide
0003 =======================
0004
0005 :Author: Matt Porter
0006
0007 Introduction
0008 ============
0009
0010 RapidIO is a high speed switched fabric interconnect with features aimed
0011 at the embedded market. RapidIO provides support for memory-mapped I/O
0012 as well as message-based transactions over the switched fabric network.
0013 RapidIO has a standardized discovery mechanism not unlike the PCI bus
0014 standard that allows simple detection of devices in a network.
0015
0016 This documentation is provided for developers intending to support
0017 RapidIO on new architectures, write new drivers, or to understand the
0018 subsystem internals.
0019
0020 Known Bugs and Limitations
0021 ==========================
0022
0023 Bugs
0024 ----
0025
0026 None. ;)
0027
0028 Limitations
0029 -----------
0030
0031 1. Access/management of RapidIO memory regions is not supported
0032
0033 2. Multiple host enumeration is not supported
0034
0035 RapidIO driver interface
0036 ========================
0037
0038 Drivers are provided a set of calls in order to interface with the
0039 subsystem to gather info on devices, request/map memory region
0040 resources, and manage mailboxes/doorbells.
0041
0042 Functions
0043 ---------
0044
0045 .. kernel-doc:: include/linux/rio_drv.h
0046 :internal:
0047
0048 .. kernel-doc:: drivers/rapidio/rio-driver.c
0049 :export:
0050
0051 .. kernel-doc:: drivers/rapidio/rio.c
0052 :export:
0053
0054 Internals
0055 =========
0056
0057 This chapter contains the autogenerated documentation of the RapidIO
0058 subsystem.
0059
0060 Structures
0061 ----------
0062
0063 .. kernel-doc:: include/linux/rio.h
0064 :internal:
0065
0066 Enumeration and Discovery
0067 -------------------------
0068
0069 .. kernel-doc:: drivers/rapidio/rio-scan.c
0070 :internal:
0071
0072 Driver functionality
0073 --------------------
0074
0075 .. kernel-doc:: drivers/rapidio/rio.c
0076 :internal:
0077
0078 .. kernel-doc:: drivers/rapidio/rio-access.c
0079 :internal:
0080
0081 Device model support
0082 --------------------
0083
0084 .. kernel-doc:: drivers/rapidio/rio-driver.c
0085 :internal:
0086
0087 PPC32 support
0088 -------------
0089
0090 .. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
0091 :internal:
0092
0093 Credits
0094 =======
0095
0096 The following people have contributed to the RapidIO subsystem directly
0097 or indirectly:
0098
0099 1. Matt Porter\ mporter@kernel.crashing.org
0100
0101 2. Randy Vinson\ rvinson@mvista.com
0102
0103 3. Dan Malek\ dan@embeddedalley.com
0104
0105 The following people have contributed to this document:
0106
0107 1. Matt Porter\ mporter@kernel.crashing.org
