driver-api/rapidio/mport_cdev.rst

2 RapidIO subsystem mport character device driver (rio_mport_cdev.c)
8 This device driver is the result of collaboration within the RapidIO.org
17 for user-space applications. Most of RapidIO operations are supported through
20 When loaded this device driver creates filesystem nodes named rio_mportX in /dev
21 directory for each registered RapidIO mport device. 'X' in the node name matches
22 to unique port ID assigned to each local mport device.
24 Using available set of ioctl commands user-space applications can perform
27 - Reads and writes from/to configuration registers of mport devices
29 - Reads and writes from/to configuration registers of remote RapidIO devices.
32 - Set RapidIO Destination ID for mport devices (RIO_MPORT_MAINT_HDID_SET)
33 - Set RapidIO Component Tag for mport devices (RIO_MPORT_MAINT_COMPTAG_SET)
34 - Query logical index of mport devices (RIO_MPORT_MAINT_PORT_IDX_GET)
35 - Query capabilities and RapidIO link configuration of mport devices
37 - Enable/Disable reporting of RapidIO doorbell events to user-space applications
39 - Enable/Disable reporting of RIO port-write events to user-space applications
41 - Query/Control type of events reported through this driver: doorbells,
42   port-writes or both (RIO_SET_EVENT_MASK/RIO_GET_EVENT_MASK)
43 - Configure/Map mport's outbound requests window(s) for specific size,
46 - Configure/Map mport's inbound requests window(s) for specific size,
49 - Allocate/Free contiguous DMA coherent memory buffer for DMA data transfers
51 - Initiate DMA data transfers to/from remote RapidIO devices (RIO_TRANSFER).
52   Supports blocking, asynchronous and posted (a.k.a 'fire-and-forget') data
54 - Check/Wait for completion of asynchronous DMA data transfer
56 - Manage device objects supported by RapidIO subsystem (RIO_DEV_ADD/RIO_DEV_DEL).
58   as user-space applications while using remaining functionality provided by
64 This device driver uses standard interfaces defined by kernel RapidIO subsystem
65 and therefore it can be used with any mport device driver registered by RapidIO
68 At this moment the most common limitation is availability of RapidIO-specific
69 DMA engine framework for specific mport device. Users should verify available
72 - IDT Tsi721 PCIe-to-RapidIO bridge device and its mport device driver are fully
74 - Freescale SoCs 'fsl_rio' mport driver does not have implementation for RapidIO
75   specific DMA engine support and therefore DMA data transfers mport_cdev driver
81 - 'dma_timeout'
82       - DMA transfer completion timeout (in msec, default value 3000).
86 - 'dbg_level'
87       - This parameter allows to control amount of debug information
88         generated by this device driver. This parameter is formed by set of
89         bit masks that correspond to the specific functional blocks.
99 5. User-space Applications and API
102 API library and applications that use this device driver are available from
108 - Add support for sending/receiving "raw" RapidIO messaging packets.
109 - Add memory mapped DMA data transfers as an option when RapidIO-specific DMA