DOCA Rivermax
Examples
- "ST 2110 receive isn't getting frames." — this is in
scope after Rivermax SDK + license are already present.
- "How do I obtain / install the Rivermax SDK and its license?" —
out of scope for this skill. Say so, give no install or licensing
steps, and route: DOCA packages to
doca-setup/SKILL.md, the
Rivermax SDK + license to the public DOCA Rivermax guide via
doca-public-knowledge-map/SKILL.md. Come back here once both
are present.
- "NOT_SUPPORTED from doca_rmax_init." — run the
doca_rmax_get_*_supported queries before changing stream
setup.
Instructions
Follow Loading order below. Open the tasks companion for configure /
stream / debug. Open the capabilities companion for Rivermax
preconditions. Do not open every companion file.
Where to start: This skill assumes DOCA is already installed on
the target BlueField DPU (DOCA Rivermax apps run only on the target
DPU), AND that the Rivermax libraries (doca-sdk-rmax /
libdoca-sdk-rmax-dev from the DOCA repo) are installed with a valid
Rivermax license present on the DPU. The agent's FIRST
action on any Rivermax question is to confirm both — without
the Rivermax libraries + license, doca-rmax cannot function regardless
of how clean the DOCA-side code is, and this is the #1 first-app
confusion (the Rivermax license, and the driver per the Rivermax SDK
page, are obtained separately from DOCA). Open
the tasks companion if the user wants to do something
(configure / build / modify / run / test / debug); open
the capabilities companion when the question is what
can DOCA Rivermax express on this version + this Rivermax
install. If the user has not installed DOCA yet, route to
doca-setup/SKILL.md first; for the Rivermax
SDK + license install itself, route to the public DOCA Rivermax
guide (slug DOCA-Rivermax) via
doca-public-knowledge-map/SKILL.md.
If the user is asking "how do I get packets to land on my
Rivermax input stream at all", the answer is layered:
doca-rmax is the Rivermax integration surface,
doca-eth/SKILL.md is the queue surface that
carries the packets, and doca-flow/SKILL.md
is the steering surface that directs them.
Example questions this skill answers well
The CLASSES of DOCA Rivermax questions this skill is built to
answer, each with one worked example. The agent should treat the
class as the load-bearing piece — the worked example is a
single instance.
- "Can I even use
doca-rmax on this host?" — worked
example: "the public docs mention doca-rmax; is it
usable without doing anything else?". Answered by the
Rivermax-SDK + license precondition rule inSafety policy
- the env-prep checklist in
configure step 1, which
routes the install-side question to the public Rivermax guide
via
doca-public-knowledge-map/SKILL.md
and refuses to recommend a fallback to doca-eth alone that
would silently lose the timing properties.
- "How do I set up a SMPTE ST 2110 video receive stream?" —
worked example: "line up an inbound Rivermax stream on a
representor of a BlueField port for first-run testing".
Answered by the per-stream object lifecycle in
configure +
Capabilities and modes
input stream capability table.
- "Which
doca_rmax_get_*_supported query do I have to call before
picking a PTP clock or hardware packet-placement order?" — worked
example: "can this device + this Rivermax install use
ST 2110-20 sequence-number placement?". Answered by the
capability-query rule inCapabilities and modes
configure.
- "My stream is set up but no packets arrive — why?" —
worked example: "the Rivermax stream object started cleanly
but no recv events fire". Answered by the precondition matrix
in
Safety policy
- the env-prep checklist in
configure step 1, which
routes the steering side to
doca-flow/SKILL.md, the queue side to
doca-eth/SKILL.md, and the license side
back to the Rivermax-side precondition.
- "Is this Rivermax integration capability available on my
device + my installed DOCA + my Rivermax SDK?" — worked
example: "does this device + this Rivermax version advertise
the PTP clock or placement mode I need". Answered by the capability-query
rule in
Capabilities and modes
- the version-and-device overlay in
Version compatibility,
which adds the Rivermax-side version is a second axis rule
on top of the canonical DOCA version-handling chain in
doca-version/SKILL.md.
- "What does this
DOCA_ERROR_* from a Rivermax call mean and
which layer caused it?" — worked example:
"DOCA_ERROR_NOT_SUPPORTED from doca_rmax_init()".
Answered by the Rivermax overlay on the
cross-library taxonomy inError taxonomy
debug that escalates to
doca-debug/SKILL.md, and which preserves
the installed header's call-specific mapping: init-time
_NOT_SUPPORTED routes first to Rivermax SDK / license checks;
later errors are interpreted from the exact failing call rather
than generalized into a license diagnosis.
Audience
This skill serves external developers building applications
that consume the DOCA Rivermax integration — i.e., users whose
code calls doca_rmax_* (directly in C/C++, or through
FFI/bindings from another language) to drive timing-precise
media-over-IP streams (SMPTE ST 2110, real-time market data,
high-throughput scientific instrument streams) on top of a
separately-installed NVIDIA Rivermax SDK on a BlueField or
ConnectX host. It is not for NVIDIA developers contributing to
DOCA Rivermax itself, and it is not for users who want
best-effort packet I/O — for that, route to
doca-eth/SKILL.md directly.
Language scope. DOCA Rivermax ships as a C library with
pkg-config module name doca-rmax. The shipped samples
live under /opt/mellanox/doca/samples/doca_rmax/ and are
written in C. C and C++ consumers are the canonical case; the
worked examples in the tasks companion assume that path. Other-language
consumers (Rust, Go, Python, …) consume the same *.so through
FFI or language-specific bindings; the skill's contribution in
that case is to keep the precondition rule (Rivermax SDK +
license), per-stream lifecycle, capability-discovery,
permission, scheduling-discipline, and error-taxonomy guidance
language-neutral, and to route the agent to the public C ABI as
the authoritative surface that any wrapper will eventually call.
When to load this skill
Load this skill when the user is doing hands-on DOCA Rivermax
work, in any language. Concretely:
- Confirming that the NVIDIA Rivermax SDK and a valid Rivermax
license are present on the host before any DOCA-side code is
written — this is a mandatory precondition, not an error
path; without it the answer is "
doca-rmax cannot be
used; pick a different library", not "let's try and see what
fails".
- Initializing the global DOCA Rivermax engine with
doca_rmax_init() / doca_rmax_release(), then creating a
doca_rmax_in_stream (receive) context with
doca_rmax_in_stream_create() on a doca_dev opened against a
physical port, a representor, or an SF, and converting it via
doca_rmax_in_stream_as_ctx() before doca_ctx_start(). The
public DOCA Rivermax API is receive-only — there is no
transmit/output stream object.
- Configuring a Rivermax input stream for SMPTE ST 2110 audio +
video over IP, real-time market data feeds, or a scientific
instrument stream — with awareness that PTP-clock and
hardware packet-placement-order support are device- and
Rivermax-conditional and gate on the matching
doca_rmax_get_*_supported query.
- Reading or setting Rivermax stream properties via
doca_rmax_in_stream_set_* and querying device + Rivermax
capability via the doca_rmax_get_*_supported family before
assuming PTP-clock or hardware packet-placement-order support.
- Pairing the Rivermax stream with the
doca-eth queue surface
that carries the packets and the doca-flow rules that
steer them — Rivermax does not program steering itself.
- Designing the real-time scheduling discipline for the
streaming threads (the underlying Rivermax stack expects
real-time priority for sub-microsecond jitter; the canonical
scheduling guidance lives in the Rivermax SDK docs reachable
through
doca-public-knowledge-map/SKILL.md).
- Debugging a
DOCA_ERROR_* returned from a Rivermax call
(lifecycle vs. license / permission vs. capability vs.
driver-below) where the cause may live in the DOCA-side
wrapper, the underlying Rivermax stack, or the licensing
layer.
- Designing or extending non-C bindings (Rust, Go, Python, …)
that wrap the DOCA Rivermax C ABI — for the precondition
rule, lifecycle, capability, permission, and scheduling rules
the wrapper must honor.
Do not load this skill for general DOCA orientation, for
installing DOCA itself, for installing the Rivermax SDK or
managing the Rivermax license file (those live in the public
Rivermax SDK guide reachable through
doca-public-knowledge-map/SKILL.md),
for best-effort packet I/O without timing requirements (use
doca-eth/SKILL.md directly), or for pure
host-side data processing without networking. For DOCA
documentation orientation, use
doca-public-knowledge-map/SKILL.md.
What this skill provides
This is a thin loader. The body keeps only the orientation
needed to pick the right next file. The substantive
Rivermax-specific material lives in two companion files:
- the capabilities companion — what DOCA Rivermax can express on this
version and this Rivermax SDK install: the
Rivermax-as-hard-dependency rule, the receive-only
doca_rmax_in_stream object model, the capability-query surface
(doca_rmax_get_*_supported), the Rivermax error taxonomy
(mapped onto the cross-library DOCA_ERROR_* set, with
Rivermax-specific causes called out per row), the
observability surface (per-stream progress engine events,
capability snapshots, Rivermax-side license + driver state),
and the safety policy that gates the Rivermax-SDK-present /
license-present / device-access / scheduling-discipline
preconditions.
- the tasks companion — step-by-step workflows for the six in-scope
Rivermax verbs:
configure, build, modify, run,
test, debug. Plus a Deferred task verbs block that
points out-of-scope questions (installing Rivermax,
managing the license, programming steering, programming the
underlying queue) at the right next skill, and a Command appendix of the recurring commands the agent reaches for.
The skill assumes a host or BlueField where DOCA is already
installed at the standard location, the NVIDIA Rivermax SDK is
installed at its expected location with a valid license, and
the user has the privileges their public install profile
expects (typically sudo or mlnx-group membership to open a
doca_dev against a port). It does not cover installing DOCA —
that path goes through
doca-setup/SKILL.md. It does not cover
installing Rivermax or its license — that path goes through the
public Rivermax SDK guide reachable through
doca-public-knowledge-map/SKILL.md.
What this skill deliberately does not ship
This skill is agent guidance, not a samples or templates
bundle. To keep the boundary clean, it deliberately does not
contain — and pull requests should not add:
- Pre-written DOCA Rivermax application source code, in any
language. The verified Rivermax source code is the shipped
C samples at
/opt/mellanox/doca/samples/doca_rmax/<name>/.
The agent's job is to route the user to those files and
prescribe a minimum-diff modification on them via the
universal modify-a-sample workflow in
doca-programming-guide/SKILL.md,
layered with the Rivermax-specific overrides inmodify.
- Standalone build manifests (
meson.build,
CMakeLists.txt, Cargo.toml, …) parked inside the skill.
The agent constructs the build manifest in the user's
project directory against the user's installed DOCA, where
pkg-config --modversion doca-rmax is the source of
truth.
- Quoted Rivermax symbol names beyond the public family
pattern (
doca_rmax_get_*_supported for capability discovery,
receive-only doca_rmax_in_stream session objects driven by the
standard DOCA Core context lifecycle). Exact Rivermax
symbol names are install-bound and Rivermax-SDK-version-
bound; the agent should read them from the installed headers
at $(pkg-config --variable=includedir doca-common) and from the
public DOCA Rivermax guide rather than rely on agent memory.
- A
samples/, bindings/, or reference/ subtree of
any kind. A mock or incomplete artifact in this skill's
tree, even one labeled "reference", is misleading: users
will read it as buildable.
Loading order
- Read this skill first to confirm the user's question is
in scope and that the Rivermax-SDK + license
precondition has been considered.
- For the Rivermax capability matrix, the receive-only input
stream model, capability-query rules, error taxonomy,
observability, and safety policy, see
the capabilities companion.
- For step-by-step workflows — configure, build, modify,
run, test, debug — see the tasks companion.
Both companion files cross-link to each other,
doca-version/SKILL.md for the canonical
DOCA version-handling rules (Rivermax adds a Rivermax-SDK-
version axis on top),
doca-eth/SKILL.md for the queue surface
that carries the packets,
doca-flow/SKILL.md for the steering side
that decides which packets land on which queue, and
doca-public-knowledge-map/SKILL.md
whenever the right answer is "look it up in the public
Rivermax SDK guide or the installed package layout" rather
than "Rivermax-integration-specific guidance".
Related skills
doca-public-knowledge-map/SKILL.md —
the routing table for every public DOCA documentation source
and the on-disk layout of an installed DOCA package. The
Rivermax URL slug is DOCA-Rivermax; the public Rivermax SDK
guide (separate product) is reachable from the same routing
table when the user asks how to install Rivermax or its
license.
doca-setup/SKILL.md — env preparation,
install verification, port-state checks (devlink dev show,
ip link), permission and group-membership requirements for
opening a doca_dev. This skill assumes its preconditions
are satisfied; the Rivermax-SDK + license preconditions are
layered on top.
doca-version/SKILL.md — canonical
DOCA version-handling rules. This skill's ## Version compatibility cross-links the four-way match rule and adds
the Rivermax-specific overlay (Rivermax SDK version is a
second axis; the capability set on this host is the
intersection of DOCA-side cap-query results and
Rivermax-side capabilities).
doca-structured-tools-contract/SKILL.md —
the bundle's structured-tools precedence rule (detect /
prefer / fall back / report). The Command appendix in
the tasks companion honors this contract.
doca-programming-guide/SKILL.md —
general DOCA programming patterns shared by every library:
the canonical pkg-config + meson build pattern, the
universal modify-a-shipped-sample first-app workflow, the
universal lifecycle, the cross-library DOCA_ERROR_*
taxonomy, and the program-side debug order. This skill
layers Rivermax specifics on top.
doca-eth/SKILL.md — the queue surface
that carries the packets a Rivermax stream produces or
consumes. DOCA Rivermax does not program the underlying
queue itself; it integrates with the queue programmed via
doca-eth. The two skills' lifecycles are independent.
doca-flow/SKILL.md — the steering
surface that decides which packets land on which queue.
DOCA Rivermax does not program steering itself; an empty
Rivermax input stream almost always means a missing or wrong
Flow rule (or a missing Rivermax license), not a Rivermax
bug.
doca-debug/SKILL.md — the
cross-cutting debug ladder (install / version / build /
link / runtime / program / driver). Rivermax-specific debug
(license precondition gaps, stream-type / packet-rate
capability mismatches, scheduling-discipline jitter
symptoms) overlays on top of that ladder.
1---2license: Apache-2.03name: doca-rmax4description: >5 DOCA Rivermax (doca_rmax) receive streams for timing-precise media over6 IP (SMPTE ST 2110 video / audio, market data, scientific feeds) on a7 target BlueField DPU (DOCA Rivermax apps run only there), once the8 Rivermax libraries and license are installed; getting them is doca-setup /9 doca-public-knowledge-map territory. Trigger on "ST 2110 receive isn't10 getting frames", "sub-microsecond jitter on my media receiver",11 "NOT_SUPPORTED from doca_rmax_init", "no recv events after stream12 start", or "license check failing on a media receiver", even without13 naming Rivermax. Covers doca_rmax_in_stream sessions, the SDK + license14 precondition check, doca_rmax_get_*_supported capability queries,15 pairing with doca-eth queues and doca-flow steering, and DOCA_ERROR_*16 from Rivermax calls. Refuse and route elsewhere for programming the17 underlying queue (doca-eth), steering rules (doca-flow), PTP / clock18 sync (doca-firefly), or best-effort packet I/O.19metadata:20 source: https://skillmd.com/skills/nvidia/doca-rmax21 author: NVIDIA <doca-feedback@nvidia.com>22 kind: library23 doca_version: "3.5"24 tags:25 - doca26 - rmax27 - rivermax28compatibility: >29 Requires DOCA SDK at /opt/mellanox/doca on Linux (Ubuntu 22.04/24.0430 or RHEL/SLES) on the target BlueField DPU (DOCA Rivermax apps run only31 there), with `doca-sdk-rmax` from the DOCA repo AND a separately32 obtained Rivermax license readable by the user. Reads33 the local install via `pkg-config doca-rmax`; route Rivermax SDK34 install/license questions to the public Rivermax guide. The validation35 steps require a live DOCA install.36---3738# DOCA Rivermax3940## Examples4142- **"ST 2110 receive isn't getting frames."** — this is in43 scope after Rivermax SDK + license are already present.44- **"How do I obtain / install the Rivermax SDK and its license?"** —45 out of scope for this skill. Say so, give no install or licensing46 steps, and route: DOCA packages to `doca-setup/SKILL.md`, the47 Rivermax SDK + license to the public DOCA Rivermax guide via48 `doca-public-knowledge-map/SKILL.md`. Come back here once both49 are present.50- **"NOT_SUPPORTED from doca_rmax_init."** — run the51 `doca_rmax_get_*_supported` queries before changing stream52 setup.5354## Instructions5556Follow Loading order below. Open the tasks companion for configure /57stream / debug. Open the capabilities companion for Rivermax58preconditions. Do not open every companion file.5960**Where to start:** This skill assumes DOCA is already installed on61the target BlueField DPU (DOCA Rivermax apps run only on the target62DPU), **AND** that the Rivermax libraries (`doca-sdk-rmax` /63`libdoca-sdk-rmax-dev` from the DOCA repo) are installed with a valid64Rivermax license present on the DPU. The agent's FIRST65action on any Rivermax question is to confirm both — without66the Rivermax libraries + license, `doca-rmax` cannot function regardless67of how clean the DOCA-side code is, and this is the #1 first-app68confusion (the Rivermax license, and the driver per the Rivermax SDK69page, are obtained separately from DOCA). Open70the tasks companion if the user wants to *do* something71(configure / build / modify / run / test / debug); open72the capabilities companion when the question is *what73can DOCA Rivermax express* on this version + this Rivermax74install. If the user has not installed DOCA yet, route to75`doca-setup/SKILL.md` first; for the Rivermax76SDK + license install itself, route to the public DOCA Rivermax77guide (slug `DOCA-Rivermax`) via78`doca-public-knowledge-map/SKILL.md`.79If the user is asking *"how do I get packets to land on my80Rivermax input stream at all"*, the answer is layered:81`doca-rmax` is the *Rivermax integration* surface,82`doca-eth/SKILL.md` is the *queue* surface that83carries the packets, and `doca-flow/SKILL.md`84is the *steering* surface that directs them.8586## Example questions this skill answers well8788The CLASSES of DOCA Rivermax questions this skill is built to89answer, each with one worked example. The agent should treat the90*class* as the load-bearing piece — the worked example is a91single instance.9293- **"Can I even use `doca-rmax` on this host?"** — worked94 example: *"the public docs mention `doca-rmax`; is it95 usable without doing anything else?"*. Answered by the96 Rivermax-SDK + license precondition rule in97 ## Safety policy98 + the env-prep checklist in99 ## configure step 1, which100 routes the install-side question to the public Rivermax guide101 via102 `doca-public-knowledge-map/SKILL.md`103 and refuses to recommend a fallback to `doca-eth` alone that104 would silently lose the timing properties.105- **"How do I set up a SMPTE ST 2110 video receive stream?"** —106 worked example: *"line up an inbound Rivermax stream on a107 representor of a BlueField port for first-run testing"*.108 Answered by the per-stream object lifecycle in109 ## configure +110 ## Capabilities and modes111 input stream capability table.112- **"Which `doca_rmax_get_*_supported` query do I have to call before113 picking a PTP clock or hardware packet-placement order?"** — worked114 example: *"can this device + this Rivermax install use115 ST 2110-20 sequence-number placement?"*. Answered by the116 capability-query rule in117 ## Capabilities and modes118 + step 3 in119 ## configure.120- **"My stream is set up but no packets arrive — why?"** —121 worked example: *"the Rivermax stream object started cleanly122 but no recv events fire"*. Answered by the precondition matrix123 in124 ## Safety policy125 + the env-prep checklist in126 ## configure step 1, which127 routes the steering side to128 `doca-flow/SKILL.md`, the queue side to129 `doca-eth/SKILL.md`, and the license side130 back to the Rivermax-side precondition.131- **"Is this Rivermax integration capability available on my132 device + my installed DOCA + my Rivermax SDK?"** — worked133 example: *"does this device + this Rivermax version advertise134 the PTP clock or placement mode I need"*. Answered by the capability-query135 rule in136 ## Capabilities and modes137 + the version-and-device overlay in138 ## Version compatibility,139 which adds the *Rivermax-side version is a second axis* rule140 on top of the canonical DOCA version-handling chain in141 `doca-version/SKILL.md`.142- **"What does this `DOCA_ERROR_*` from a Rivermax call mean and143 which layer caused it?"** — worked example:144 *"`DOCA_ERROR_NOT_SUPPORTED` from `doca_rmax_init()`"*.145 Answered by the Rivermax overlay on the146 cross-library taxonomy in147 ## Error taxonomy148 + the layered ladder in149 ## debug that escalates to150 `doca-debug/SKILL.md`, and which preserves151 the installed header's call-specific mapping: init-time152 `_NOT_SUPPORTED` routes first to Rivermax SDK / license checks;153 later errors are interpreted from the exact failing call rather154 than generalized into a license diagnosis.155156## Audience157158This skill serves **external developers building applications159that consume the DOCA Rivermax integration** — i.e., users whose160code calls `doca_rmax_*` (directly in C/C++, or through161FFI/bindings from another language) to drive timing-precise162media-over-IP streams (SMPTE ST 2110, real-time market data,163high-throughput scientific instrument streams) on top of a164separately-installed NVIDIA Rivermax SDK on a BlueField or165ConnectX host. It is *not* for NVIDIA developers contributing to166DOCA Rivermax itself, and it is *not* for users who want167best-effort packet I/O — for that, route to168`doca-eth/SKILL.md` directly.169170**Language scope.** DOCA Rivermax ships as a C library with171`pkg-config` module name `doca-rmax`. The shipped samples172live under `/opt/mellanox/doca/samples/doca_rmax/` and are173written in C. C and C++ consumers are the canonical case; the174worked examples in the tasks companion assume that path. Other-language175consumers (Rust, Go, Python, …) consume the same `*.so` through176FFI or language-specific bindings; the skill's contribution in177that case is to keep the precondition rule (Rivermax SDK +178license), per-stream lifecycle, capability-discovery,179permission, scheduling-discipline, and error-taxonomy guidance180language-neutral, and to route the agent to the public C ABI as181the authoritative surface that any wrapper will eventually call.182183## When to load this skill184185Load this skill when the user is doing hands-on DOCA Rivermax186work, in any language. Concretely:187188- Confirming that the NVIDIA Rivermax SDK and a valid Rivermax189 license are present on the host before any DOCA-side code is190 written — this is a **mandatory precondition**, not an error191 path; without it the answer is *"`doca-rmax` cannot be192 used; pick a different library"*, not *"let's try and see what193 fails"*.194- Initializing the global DOCA Rivermax engine with195 `doca_rmax_init()` / `doca_rmax_release()`, then creating a196 `doca_rmax_in_stream` (receive) context with197 `doca_rmax_in_stream_create()` on a `doca_dev` opened against a198 physical port, a representor, or an SF, and converting it via199 `doca_rmax_in_stream_as_ctx()` before `doca_ctx_start()`. The200 public DOCA Rivermax API is receive-only — there is no201 transmit/output stream object.202- Configuring a Rivermax input stream for SMPTE ST 2110 audio +203 video over IP, real-time market data feeds, or a scientific204 instrument stream — with awareness that PTP-clock and205 hardware packet-placement-order support are device- and206 Rivermax-conditional and gate on the matching207 `doca_rmax_get_*_supported` query.208- Reading or setting Rivermax stream properties via209 `doca_rmax_in_stream_set_*` and querying device + Rivermax210 capability via the `doca_rmax_get_*_supported` family before211 assuming PTP-clock or hardware packet-placement-order support.212- Pairing the Rivermax stream with the `doca-eth` queue surface213 that carries the packets and the `doca-flow` rules that214 steer them — Rivermax does not program steering itself.215- Designing the real-time scheduling discipline for the216 streaming threads (the underlying Rivermax stack expects217 real-time priority for sub-microsecond jitter; the canonical218 scheduling guidance lives in the Rivermax SDK docs reachable219 through220 `doca-public-knowledge-map/SKILL.md`).221- Debugging a `DOCA_ERROR_*` returned from a Rivermax call222 (lifecycle vs. license / permission vs. capability vs.223 driver-below) where the cause may live in the DOCA-side224 wrapper, the underlying Rivermax stack, or the licensing225 layer.226- Designing or extending non-C bindings (Rust, Go, Python, …)227 that wrap the DOCA Rivermax C ABI — for the precondition228 rule, lifecycle, capability, permission, and scheduling rules229 the wrapper must honor.230231Do **not** load this skill for general DOCA orientation, for232installing DOCA itself, for installing the Rivermax SDK or233managing the Rivermax license file (those live in the public234Rivermax SDK guide reachable through235`doca-public-knowledge-map/SKILL.md`),236for best-effort packet I/O without timing requirements (use237`doca-eth/SKILL.md` directly), or for pure238host-side data processing without networking. For DOCA239documentation orientation, use240`doca-public-knowledge-map/SKILL.md`.241242## What this skill provides243244This is a **thin loader**. The body keeps only the orientation245needed to pick the right next file. The substantive246Rivermax-specific material lives in two companion files:247248- the capabilities companion — what DOCA Rivermax can express on this249 version *and this Rivermax SDK install*: the250 Rivermax-as-hard-dependency rule, the receive-only251 `doca_rmax_in_stream` object model, the capability-query surface252 (`doca_rmax_get_*_supported`), the Rivermax error taxonomy253 (mapped onto the cross-library `DOCA_ERROR_*` set, with254 Rivermax-specific causes called out per row), the255 observability surface (per-stream progress engine events,256 capability snapshots, Rivermax-side license + driver state),257 and the safety policy that gates the Rivermax-SDK-present /258 license-present / device-access / scheduling-discipline259 preconditions.260- the tasks companion — step-by-step workflows for the six in-scope261 Rivermax verbs: `configure`, `build`, `modify`, `run`,262 `test`, `debug`. Plus a `Deferred task verbs` block that263 points out-of-scope questions (installing Rivermax,264 managing the license, programming steering, programming the265 underlying queue) at the right next skill, and a `Command266 appendix` of the recurring commands the agent reaches for.267268The skill assumes a host or BlueField where DOCA is already269installed at the standard location, the NVIDIA Rivermax SDK is270installed at its expected location with a valid license, and271the user has the privileges their public install profile272expects (typically sudo or `mlnx`-group membership to open a273`doca_dev` against a port). It does not cover installing DOCA —274that path goes through275`doca-setup/SKILL.md`. It does not cover276installing Rivermax or its license — that path goes through the277public Rivermax SDK guide reachable through278`doca-public-knowledge-map/SKILL.md`.279280## What this skill deliberately does not ship281282This skill is **agent guidance**, not a samples or templates283bundle. To keep the boundary clean, it deliberately does not284contain — and pull requests should not add:285286- **Pre-written DOCA Rivermax application source code, in any287 language.** The verified Rivermax source code is the shipped288 C samples at `/opt/mellanox/doca/samples/doca_rmax/<name>/`.289 The agent's job is to route the user to those files and290 prescribe a minimum-diff modification on them via the291 universal modify-a-sample workflow in292 `doca-programming-guide/SKILL.md`,293 layered with the Rivermax-specific overrides in294 ## modify.295- **Standalone build manifests** (`meson.build`,296 `CMakeLists.txt`, `Cargo.toml`, …) parked inside the skill.297 The agent constructs the build manifest *in the user's298 project directory* against the user's installed DOCA, where299 `pkg-config --modversion doca-rmax` is the source of300 truth.301- **Quoted Rivermax symbol names beyond the public family302 pattern (`doca_rmax_get_*_supported` for capability discovery,303 receive-only `doca_rmax_in_stream` session objects driven by the304 standard DOCA Core context lifecycle).** Exact Rivermax305 symbol names are install-bound and Rivermax-SDK-version-306 bound; the agent should read them from the installed headers307 at $(pkg-config --variable=includedir doca-common) and from the308 public DOCA Rivermax guide rather than rely on agent memory.309- **A `samples/`, `bindings/`, or `reference/` subtree** of310 any kind. A mock or incomplete artifact in this skill's311 tree, even one labeled *"reference"*, is misleading: users312 will read it as buildable.313314## Loading order3153161. Read this skill first to confirm the user's question is317 in scope **and** that the Rivermax-SDK + license318 precondition has been considered.3192. **For the Rivermax capability matrix, the receive-only input320 stream model, capability-query rules, error taxonomy,321 observability, and safety policy, see322 the capabilities companion.**3233. **For step-by-step workflows — configure, build, modify,324 run, test, debug — see the tasks companion.**325326Both companion files cross-link to each other,327`doca-version/SKILL.md` for the canonical328DOCA version-handling rules (Rivermax adds a Rivermax-SDK-329version axis on top),330`doca-eth/SKILL.md` for the queue surface331that carries the packets,332`doca-flow/SKILL.md` for the steering side333that decides which packets land on which queue, and334`doca-public-knowledge-map/SKILL.md`335whenever the right answer is *"look it up in the public336Rivermax SDK guide or the installed package layout"* rather337than *"Rivermax-integration-specific guidance"*.338339## Related skills340341- `doca-public-knowledge-map/SKILL.md` —342 the routing table for every public DOCA documentation source343 and the on-disk layout of an installed DOCA package. The344 Rivermax URL slug is `DOCA-Rivermax`; the public Rivermax SDK345 guide (separate product) is reachable from the same routing346 table when the user asks how to install Rivermax or its347 license.348- `doca-setup/SKILL.md` — env preparation,349 install verification, port-state checks (`devlink dev show`,350 `ip link`), permission and group-membership requirements for351 opening a `doca_dev`. This skill assumes its preconditions352 are satisfied; the Rivermax-SDK + license preconditions are353 layered on top.354- `doca-version/SKILL.md` — canonical355 DOCA version-handling rules. This skill's `## Version356 compatibility` cross-links the four-way match rule and adds357 the Rivermax-specific overlay (Rivermax SDK version is a358 second axis; the capability set on this host is the359 intersection of DOCA-side cap-query results and360 Rivermax-side capabilities).361- `doca-structured-tools-contract/SKILL.md` —362 the bundle's structured-tools precedence rule (detect /363 prefer / fall back / report). The Command appendix in364 the tasks companion honors this contract.365- `doca-programming-guide/SKILL.md` —366 general DOCA programming patterns shared by every library:367 the canonical `pkg-config` + meson build pattern, the368 universal modify-a-shipped-sample first-app workflow, the369 universal lifecycle, the cross-library `DOCA_ERROR_*`370 taxonomy, and the program-side debug order. This skill371 layers Rivermax specifics on top.372- `doca-eth/SKILL.md` — the queue surface373 that carries the packets a Rivermax stream produces or374 consumes. DOCA Rivermax does *not* program the underlying375 queue itself; it integrates with the queue programmed via376 `doca-eth`. The two skills' lifecycles are independent.377- `doca-flow/SKILL.md` — the steering378 surface that decides which packets land on which queue.379 DOCA Rivermax does *not* program steering itself; an empty380 Rivermax input stream almost always means a missing or wrong381 Flow rule (or a missing Rivermax license), not a Rivermax382 bug.383- `doca-debug/SKILL.md` — the384 cross-cutting debug ladder (install / version / build /385 link / runtime / program / driver). Rivermax-specific debug386 (license precondition gaps, stream-type / packet-rate387 capability mismatches, scheduling-discipline jitter388 symptoms) overlays on top of that ladder.389