Skip to content

Commit 93971b2

Browse files
committed
Add: document dma-dev parameter for DMA offload in README
1 parent 161980b commit 93971b2

File tree

1 file changed

+1
-6
lines changed

1 file changed

+1
-6
lines changed

ecosystem/gstreamer_plugin/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ In MTL GStreamer plugins there are general arguments that apply to every plugin.
106106
| tx-queues | uint | Number of TX queues to initialize in DPDK backend. | 0 to G_MAXUINT |
107107
| rx-queues | uint | Number of RX queues to initialize in DPDK backend. | 0 to G_MAXUINT |
108108
| enable-dma-offload | boolean | Request DMA offload for sessions that support it. | TRUE/FALSE |
109+
| dma-dev | string | DPDK port bound for DMA engines, exported as described in `doc/dma.md`. Required when `enable-dma-offload=true`. | N/A |
109110
| payload-type | uint | SMPTE ST 2110 payload type. | 0 to G_MAXUINT |
110111
| port | string | Session DPDK device port. If not specified it will be taken from the dev-port argument. | N/A |
111112
| port-red | string | Redundant session DPDK device port if left open taken from dev-port-red argument if specified. | N/A |
@@ -115,12 +116,6 @@ When `enable-dma-offload` is set to `true`, every plugin that supports DMA will
115116
the `dma-dev` port is bound and exported as described in `doc/dma.md` before enabling the
116117
flag.
117118

118-
These are also general parameters accepted by plugins, but the functionality they provide to the user is not yet supported in plugins.
119-
120-
| Property Name | Type | Description | Range |
121-
|---------------|--------|---------------------------------------------------------------------------------------------------|--------------------------|
122-
| dma-dev | string | **RESERVED FOR FUTURE USE** port for the MTL direct memory functionality. | N/A |
123-
124119

125120
> **Warning:**
126121
> Generally, the `log-level`, `dev-port`, `dev-ip`, `tx-queues`, and `rx-queues` are used to initialize the MTLlibrary. As the MTL library handle is shared between MTL

0 commit comments

Comments
 (0)