About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / driver-api / rapidio.rst


Based on kernel version 4.16.1. Page generated on 2018-04-09 11:53 EST.

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
Hide Line Numbers


About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog