linux/Documentation/admin-guide/rapidio.rst
<<
>>
Prefs
   1=======================
   2RapidIO Subsystem Guide
   3=======================
   4
   5:Author: Matt Porter
   6
   7Introduction
   8============
   9
  10RapidIO is a high speed switched fabric interconnect with features aimed
  11at the embedded market. RapidIO provides support for memory-mapped I/O
  12as well as message-based transactions over the switched fabric network.
  13RapidIO has a standardized discovery mechanism not unlike the PCI bus
  14standard that allows simple detection of devices in a network.
  15
  16This documentation is provided for developers intending to support
  17RapidIO on new architectures, write new drivers, or to understand the
  18subsystem internals.
  19
  20Known Bugs and Limitations
  21==========================
  22
  23Bugs
  24----
  25
  26None. ;)
  27
  28Limitations
  29-----------
  30
  311. Access/management of RapidIO memory regions is not supported
  32
  332. Multiple host enumeration is not supported
  34
  35RapidIO driver interface
  36========================
  37
  38Drivers are provided a set of calls in order to interface with the
  39subsystem to gather info on devices, request/map memory region
  40resources, and manage mailboxes/doorbells.
  41
  42Functions
  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
  54Internals
  55=========
  56
  57This chapter contains the autogenerated documentation of the RapidIO
  58subsystem.
  59
  60Structures
  61----------
  62
  63.. kernel-doc:: include/linux/rio.h
  64   :internal:
  65
  66Enumeration and Discovery
  67-------------------------
  68
  69.. kernel-doc:: drivers/rapidio/rio-scan.c
  70   :internal:
  71
  72Driver functionality
  73--------------------
  74
  75.. kernel-doc:: drivers/rapidio/rio.c
  76   :internal:
  77
  78.. kernel-doc:: drivers/rapidio/rio-access.c
  79   :internal:
  80
  81Device model support
  82--------------------
  83
  84.. kernel-doc:: drivers/rapidio/rio-driver.c
  85   :internal:
  86
  87PPC32 support
  88-------------
  89
  90.. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
  91   :internal:
  92
  93Credits
  94=======
  95
  96The following people have contributed to the RapidIO subsystem directly
  97or indirectly:
  98
  991. Matt Porter\ mporter@kernel.crashing.org
 100
 1012. Randy Vinson\ rvinson@mvista.com
 102
 1033. Dan Malek\ dan@embeddedalley.com
 104
 105The following people have contributed to this document:
 106
 1071. Matt Porter\ mporter@kernel.crashing.org
 108