skills.rest
NVIDIA
NVIDIAOFFICIAL
Explore all skills by this author →
WebsiteGitHub

doca-rmax

Configure and debug DOCA Rivermax receive streams for timing-precise media-over-IP workloads.

3.2k|370|Updated Feb 25, 2026
Search Tags:#Debugging#Networking#doca#bluefield#media streaming#rivermax#smpte st 2110
One-click install
npx skills add https://github.com/NVIDIA/skills --skill doca-rmax
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doca-rmax
Source: https://github.com/NVIDIA/skills/tree/main/skills/doca-rmax
Command: npx skills add https://github.com/NVIDIA/skills --skill doca-rmax

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Building applications on NVIDIA DOCA Rivermax is error-prone: the library is only a wrapper around the separately installed Rivermax SDK, requires a valid license, and depends on correctly paired doca-eth queues and doca-flow steering rules. This Skill guides an AI agent through those preconditions, capability queries, and layered debugging so Rivermax receive streams come up correctly the first time.

Core Features & Use Cases

  • Precondition and capability gating: Verifies the Rivermax SDK install, license readability, device access, and port state before any code, and runs doca_rmax_get_*_supported queries before promising PTP clocks or hardware packet-placement ordering.
  • Receive-stream lifecycle workflows: Step-by-step configure, build, modify, run, test, and debug verbs for the receive-only doca_rmax_in_stream object on BlueField DPUs or ConnectX hosts.
  • Layered error diagnosis: Maps DOCA_ERROR_* returns to the correct layer (license, capability, lifecycle, driver) and routes queue, steering, and install issues to the right companion skill.
  • Use Case: A developer reports "ST 2110 receive isn't getting frames" on a BlueField. The agent loads this Skill, walks the precondition matrix, checks the Flow steering rule and underlying doca_eth_rxq queue, and isolates the cause without inventing Rivermax commands.

Quick Start

Ask your agent to help set up a SMPTE ST 2110 video receive stream with DOCA Rivermax on your BlueField DPU, including the license and capability checks.

Frequently Asked Questions about doca-rmax

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a DOCA Rivermax receive stream for SMPTE ST 2110?▼

Confirm the Rivermax SDK and license are installed, bring up a doca_eth_rxq queue, then call doca_rmax_init() and doca_rmax_in_stream_create() on a doca_dev with a valid IPv4 address. Configure scatter type, timestamp format, and memory layout, register the Rx-data event, and start the context with doca_ctx_start().

Why does doca_rmax_init return DOCA_ERROR_NOT_SUPPORTED?▼

Per the installed header, DOCA_ERROR_NOT_SUPPORTED from doca_rmax_init() signals an invalid or missing Rivermax license or SDK. Verify the Rivermax SDK is installed and the license file is readable by the streaming user before investigating any DOCA-side code.

Does DOCA Rivermax support transmit streams?▼

No. The public DOCA Rivermax API is receive-only; the only stream object is doca_rmax_in_stream. There is no transmit or output stream object in the library.

Why is my Rivermax stream started but receiving no packets?▼

A silent Rivermax input stream is almost always a missing Rivermax license, a missing or wrong doca-flow steering rule, or an unstarted underlying doca_eth_rxq queue. Check those three preconditions in order before suspecting a code bug.

Can I use doca-rmax without installing the Rivermax SDK?▼

No. DOCA does not bundle Rivermax; doca-rmax is only a wrapper around the separately installed NVIDIA Rivermax SDK, and a valid license is mandatory. Without both, use doca-eth for best-effort packet I/O, accepting the loss of sub-microsecond jitter guarantees.

How do I check PTP clock or packet-placement support on my device?▼

Call the matching doca_rmax_get_*_supported query against the active doca_devinfo before configuring the feature. The capability query is the runtime authority; support depends on the device, DOCA version, and Rivermax SDK version together.

Related Skills

Explore More Software Engineering Skills→
NVIDIANVIDIA
14

k8s-network-engineer

Configure and troubleshoot NVIDIA networking deployments on Kubernetes.

Official
Advanced
EasyRemoteEasyRemote
4

camera-runtime-pack

Capture photos, record videos, and stream media from device hardware.

Official
Intermediate
stolyarchukstolyarchuk

doca-expert

Guide C++ engineers in designing and optimizing DOCA Flow pipelines on NVIDIA SmartNICs.

Community
Advanced
box755box755

deepspeed

Configure and troubleshoot DeepSpeed distributed training with ZeRO, mixed precision, and DeepNVMe I/O.

Community
Advanced