rapidio.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  1. =======================
  2. RapidIO Subsystem Guide
  3. =======================
  4. :Author: Matt Porter
  5. Introduction
  6. ============
  7. RapidIO is a high speed switched fabric interconnect with features aimed
  8. at the embedded market. RapidIO provides support for memory-mapped I/O
  9. as well as message-based transactions over the switched fabric network.
  10. RapidIO has a standardized discovery mechanism not unlike the PCI bus
  11. standard that allows simple detection of devices in a network.
  12. This documentation is provided for developers intending to support
  13. RapidIO on new architectures, write new drivers, or to understand the
  14. subsystem internals.
  15. Known Bugs and Limitations
  16. ==========================
  17. Bugs
  18. ----
  19. None. ;)
  20. Limitations
  21. -----------
  22. 1. Access/management of RapidIO memory regions is not supported
  23. 2. Multiple host enumeration is not supported
  24. RapidIO driver interface
  25. ========================
  26. Drivers are provided a set of calls in order to interface with the
  27. subsystem to gather info on devices, request/map memory region
  28. resources, and manage mailboxes/doorbells.
  29. Functions
  30. ---------
  31. .. kernel-doc:: include/linux/rio_drv.h
  32. :internal:
  33. .. kernel-doc:: drivers/rapidio/rio-driver.c
  34. :export:
  35. .. kernel-doc:: drivers/rapidio/rio.c
  36. :export:
  37. Internals
  38. =========
  39. This chapter contains the autogenerated documentation of the RapidIO
  40. subsystem.
  41. Structures
  42. ----------
  43. .. kernel-doc:: include/linux/rio.h
  44. :internal:
  45. Enumeration and Discovery
  46. -------------------------
  47. .. kernel-doc:: drivers/rapidio/rio-scan.c
  48. :internal:
  49. Driver functionality
  50. --------------------
  51. .. kernel-doc:: drivers/rapidio/rio.c
  52. :internal:
  53. .. kernel-doc:: drivers/rapidio/rio-access.c
  54. :internal:
  55. Device model support
  56. --------------------
  57. .. kernel-doc:: drivers/rapidio/rio-driver.c
  58. :internal:
  59. PPC32 support
  60. -------------
  61. .. kernel-doc:: arch/powerpc/sysdev/fsl_rio.c
  62. :internal:
  63. Credits
  64. =======
  65. The following people have contributed to the RapidIO subsystem directly
  66. or indirectly:
  67. 1. Matt Porter\ mporter@kernel.crashing.org
  68. 2. Randy Vinson\ rvinson@mvista.com
  69. 3. Dan Malek\ dan@embeddedalley.com
  70. The following people have contributed to this document:
  71. 1. Matt Porter\ mporter@kernel.crashing.org