xref: /OK3568_Linux_fs/kernel/Documentation/admin-guide/rapidio.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun=======================
2*4882a593SmuzhiyunRapidIO Subsystem Guide
3*4882a593Smuzhiyun=======================
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun:Author: Matt Porter
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunIntroduction
8*4882a593Smuzhiyun============
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunRapidIO is a high speed switched fabric interconnect with features aimed
11*4882a593Smuzhiyunat the embedded market. RapidIO provides support for memory-mapped I/O
12*4882a593Smuzhiyunas well as message-based transactions over the switched fabric network.
13*4882a593SmuzhiyunRapidIO has a standardized discovery mechanism not unlike the PCI bus
14*4882a593Smuzhiyunstandard that allows simple detection of devices in a network.
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunThis documentation is provided for developers intending to support
17*4882a593SmuzhiyunRapidIO on new architectures, write new drivers, or to understand the
18*4882a593Smuzhiyunsubsystem internals.
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunKnown Bugs and Limitations
21*4882a593Smuzhiyun==========================
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunBugs
24*4882a593Smuzhiyun----
25*4882a593Smuzhiyun
26*4882a593SmuzhiyunNone. ;)
27*4882a593Smuzhiyun
28*4882a593SmuzhiyunLimitations
29*4882a593Smuzhiyun-----------
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun1. Access/management of RapidIO memory regions is not supported
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun2. Multiple host enumeration is not supported
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunRapidIO driver interface
36*4882a593Smuzhiyun========================
37*4882a593Smuzhiyun
38*4882a593SmuzhiyunDrivers are provided a set of calls in order to interface with the
39*4882a593Smuzhiyunsubsystem to gather info on devices, request/map memory region
40*4882a593Smuzhiyunresources, and manage mailboxes/doorbells.
41*4882a593Smuzhiyun
42*4882a593SmuzhiyunFunctions
43*4882a593Smuzhiyun---------
44*4882a593Smuzhiyun
45*4882a593Smuzhiyun.. kernel-doc:: include/linux/rio_drv.h
46*4882a593Smuzhiyun   :internal:
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio-driver.c
49*4882a593Smuzhiyun   :export:
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio.c
52*4882a593Smuzhiyun   :export:
53*4882a593Smuzhiyun
54*4882a593SmuzhiyunInternals
55*4882a593Smuzhiyun=========
56*4882a593Smuzhiyun
57*4882a593SmuzhiyunThis chapter contains the autogenerated documentation of the RapidIO
58*4882a593Smuzhiyunsubsystem.
59*4882a593Smuzhiyun
60*4882a593SmuzhiyunStructures
61*4882a593Smuzhiyun----------
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun.. kernel-doc:: include/linux/rio.h
64*4882a593Smuzhiyun   :internal:
65*4882a593Smuzhiyun
66*4882a593SmuzhiyunEnumeration and Discovery
67*4882a593Smuzhiyun-------------------------
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio-scan.c
70*4882a593Smuzhiyun   :internal:
71*4882a593Smuzhiyun
72*4882a593SmuzhiyunDriver functionality
73*4882a593Smuzhiyun--------------------
74*4882a593Smuzhiyun
75*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio.c
76*4882a593Smuzhiyun   :internal:
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio-access.c
79*4882a593Smuzhiyun   :internal:
80*4882a593Smuzhiyun
81*4882a593SmuzhiyunDevice model support
82*4882a593Smuzhiyun--------------------
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun.. kernel-doc:: drivers/rapidio/rio-driver.c
85*4882a593Smuzhiyun   :internal:
86*4882a593Smuzhiyun
87*4882a593SmuzhiyunPPC32 support
88*4882a593Smuzhiyun-------------
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
91*4882a593Smuzhiyun   :internal:
92*4882a593Smuzhiyun
93*4882a593SmuzhiyunCredits
94*4882a593Smuzhiyun=======
95*4882a593Smuzhiyun
96*4882a593SmuzhiyunThe following people have contributed to the RapidIO subsystem directly
97*4882a593Smuzhiyunor indirectly:
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun1. Matt Porter\ mporter@kernel.crashing.org
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun2. Randy Vinson\ rvinson@mvista.com
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun3. Dan Malek\ dan@embeddedalley.com
104*4882a593Smuzhiyun
105*4882a593SmuzhiyunThe following people have contributed to this document:
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun1. Matt Porter\ mporter@kernel.crashing.org
108