
DOCA Ethernet
OfficialFreeHands-on packet-queue management for DOCA Ethernet.
Free · Opens the source repo
What DOCA Ethernet does
DOCA Ethernet is a skill designed for developers working with the DOCA Ethernet library on BlueField DPUs or ConnectX NICs. It facilitates hands-on management of Ethernet packet queues, specifically focusing on the initialization and configuration of RX and TX queues through the doca_eth_rxq and doca_eth_txq interfaces. This skill is particularly useful for those who need to set up packet processing capabilities, troubleshoot issues, and optimize performance in their applications that leverage DOCA Ethernet.
The skill provides guidance on selecting the appropriate RX queue type from the available options, which include regular, cyclic, managed memory pool, and shared memory pool. Users can also determine the optimal burst and scatter-gather lengths by querying device capabilities. Additionally, the skill assists in debugging common errors encountered during Ethernet operations, such as understanding the implications of DOCA_ERROR_* codes and ensuring that the necessary conditions for packet reception are met.
This skill is tailored for external developers who are integrating DOCA Ethernet into their applications, whether they are using C/C++ directly or accessing the library through language bindings. It streamlines the process of setting up and managing Ethernet queues, making it easier to achieve line-rate packet I/O on physical ports or representors. The skill also emphasizes the importance of routing to other relevant skills, such as DOCA Flow for steering configurations, ensuring that users have a comprehensive toolkit for their networking tasks.
When to use it
Use this skill when you are working on initializing and configuring Ethernet packet queues in DOCA, particularly when you need to troubleshoot or optimize packet processing.
When not to use it
This skill is not suitable for users who have not yet installed DOCA or those seeking to manage flow rules, steering programming, or RDMA data movement.
What you can build with it
Setting Up RX and TX Queues
Initialize a `doca_eth_rxq` and a `doca_eth_txq` on a BlueField representor for packet processing.
Choosing the Right RX Queue Type
Determine the best RX queue type for your application, such as regular or cyclic, based on your data characteristics.
Debugging Packet Reception Issues
Resolve issues where packets are not arriving at the RX queue despite correct initialization.
How to install DOCA Ethernet
View source1. Install with the skills CLI
npx skills add nvidia/skills/doca-eth --agent claude-code2. Or install it manually
Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.
Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs
Inside SKILL.md
Written by nvidiaDOCA Ethernet
Where to start: This skill assumes DOCA is already installed and
the user is doing hands-on packet-queue work on a host or
BlueField with DOCA. Open TASKS.md if the user wants
to do something (configure / build / modify / run / test /
debug); open CAPABILITIES.md when the question
is what can a DOCA Ethernet queue express on this version. If
the user has not installed DOCA yet, route to
doca-setup first. If the user is
asking "how do I get packets to land on my RX queue at all", the
answer lives in doca-flow — DOCA
Ethernet is the queue surface; DOCA Flow is the steering
surface, and they are independent libraries.
Example questions this skill answers well
The CLASSES of DOCA Ethernet 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.
- "How do I bring up an RX and TX queue on a representor or
physical port?" — worked example: "set up a
doca_eth_rxqplus adoca_eth_txqon a single BlueField representor for first-run testing". Answered by the queue-pair lifecycle inTASKS.md ## configure+CAPABILITIES.md ## Capabilities and modesRX / TX object table. - "Which RX type fits my data shape — regular, cyclic, or
managed-recv?" — worked example: "line-rate ingress with
fixed-size frames into a pre-allocated buffer ring". Answered
by the RX-type taxonomy in
CAPABILITIES.md ## Capabilities and modes- the capability-query rule (
doca_eth_rxq_cap_is_type_supportedagainst adoca_devinfo) inTASKS.md ## configure.
- the capability-query rule (
- "How do I send a packet from user code through
doca_eth_txq?" — worked example: "allocate a packetdoca_buf, attach the payload, submit one send-task, wait for the completion event". Answered by the TX submission shape inCAPABILITIES.md ## Capabilities and modes- the property-set workflow in
TASKS.md ## modify.
- the property-set workflow in
- "My queue is up but no packets arrive — why?" — worked
example: "
doca_eth_rxqstarted cleanly but the recv callback never fires". Answered by the steering-dependency rule inCAPABILITIES.md ## Safety policy- the env-prep checklist in
TASKS.md ## configurestep 1, which routes the steering side todoca-flowand the promiscuous-mode side todoca-setup.
- the env-prep checklist in
- "Is this Ethernet capability available on my device + my
installed DOCA?" — worked example: "does this device
advertise L3 checksum offload". Answered by the
capability-query rule (
doca_eth_txq_cap_is_l3_chksum_offload_supportedagainst adoca_devinfo) inCAPABILITIES.md ## Capabilities and modes- the version-and-device overlay in
CAPABILITIES.md ## Version compatibility.
- the version-and-device overlay in
- "What does this
DOCA_ERROR_*from an Ethernet call mean and which layer caused it?" — worked example: "DOCA_ERROR_AGAINondoca_task_submitfor aneth_txqsend-task at high rate". Answered by the Ethernet overlay on the cross-library taxonomy inCAPABILITIES.md ## Error taxonomy- the layered ladder in
TASKS.md ## debugthat escalates todoca-debug.
- the layered ladder in
Audience
This skill serves external developers building applications that
consume the DOCA Ethernet library — i.e., users whose code calls
doca_eth_rxq_* / doca_eth_txq_* (directly in C/C++, or through
FFI/bindings from another language) to do line-rate packet I/O on
physical ports, representors, or SFs of a BlueField or ConnectX
device. It is not for NVIDIA developers contributing to DOCA
Ethernet itself.
Language scope. DOCA Ethernet ships as a C library with
pkg-config module name doca-eth. The shipped samples are
written in C. C and C++ consumers are the canonical case; the
worked examples in TASKS.md 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 queue-object split, lifecycle,
capability-discovery, permission, RX-type taxonomy, 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 Ethernet work, in any language. Concretely:
- Initializing a
doca_eth_rxqon adoca_devopened against a physical port, a representor, or an SF — choosing among the regular / cyclic / managed-recv RX types based on data shape beforedoca_ctx_start(). - Initializing a
doca_eth_txqon the same or a differentdoca_devand posting send-tasks against packetdoca_bufs payload buffers. - Reading or setting Ethernet queue properties via
doca_eth_rxq_set_*/doca_eth_txq_set_*and querying device capability viadoca_eth_rxq_cap_*/doca_eth_txq_cap_*(max burst size, RX-type support, max scatter-gather length, checksum-offload presence). - Confirming the port is up and that traffic is actually steered to the chosen RX queue — either via DOCA Flow rules (the canonical path) or via kernel-side promiscuous mode (the expedient first-run path).
- Wiring an Ethernet queue to a higher-level data plane: GPU packet processing via DOCA GPUNetIO, custom user-space forwarding agents, or telemetry mirrors that snap a copy of every packet.
- Debugging a
DOCA_ERROR_*returned from an Ethernet call (lifecycle vs. permission vs. capability vs. send-queue-full vs. driver-below) and the per-queue progress engine events. - Designing or extending non-C bindings (Rust, Go, Python, …) that wrap the DOCA Ethernet C ABI — for the lifecycle, queue split, RX-type, capability, and permission rules the wrapper must honor.
Do not load this skill for general DOCA orientation, install
of DOCA itself, flow-rule programming (use
doca-flow), host ↔ DPU control
messaging (use doca-comch), or
RDMA data movement (use doca-rdma).
For DOCA documentation orientation, use
doca-public-knowledge-map.
What this skill provides
This is a thin loader. The body keeps only the orientation needed to pick the right next file. The substantive Ethernet- specific material lives in two companion files:
CAPABILITIES.md— what a DOCA Ethernet queue can express on this version: the RX / TX object split, the RX-type taxonomy (regular / cyclic / managed-recv), the send-task / frame submission surface, the capability-query surface (doca_eth_rxq_cap_*/doca_eth_txq_cap_*), the Ethernet error taxonomy (mapped onto the cross-libraryDOCA_ERROR_*set), the observability surface (per-queue progress engine events, capability snapshots), and the safety policy that gates the steering / permission / port-state preconditions.TASKS.md— step-by-step workflows for the six in-scope Ethernet verbs:configure,build,modify,run,test,debug. Plus aDeferred task verbsblock that points out-of-scope questions at the right next skill, and aCommand appendixof the recurring commands the agent reaches for.
The skill assumes a host or BlueField where DOCA is already
installed at the standard location 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.
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 Ethernet application source code, in any
language. The verified Ethernet source code is the shipped C
samples at
/opt/mellanox/doca/samples/doca_eth/<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 indoca-programming-guide, layered with the Ethernet-specific overrides inTASKS.md ## modify. - 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, wherepkg-config --modversion doca-ethis the source of truth. - A
samples/,bindings/, orreference/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.mdfirst to confirm the user's question is in scope. - For the Ethernet capability matrix, RX-type taxonomy, send surface, capability-query rules, error taxonomy, observability, and safety policy, see CAPABILITIES.md.
- For step-by-step workflows — configure, build, modify, run, test, debug — see TASKS.md.
Both companion files cross-link to each other,
doca-version for the canonical
version-handling rules,
doca-flow for the steering side
that the RX queue depends on, and
doca-public-knowledge-map
whenever the right answer is "look it up in the public docs or
the installed package layout" rather than "Ethernet-specific
guidance".
Related skills
doca-public-knowledge-map— the routing table for every public DOCA documentation source and the on-disk layout of an installed DOCA package. The Ethernet URL slug isDOCA-Ethernet.doca-setup— env preparation, install verification, port-state checks (devlink dev show,ip link), permission and group-membership requirements for opening adoca_dev. This skill assumes its preconditions are satisfied.doca-version— canonical DOCA version-handling rules. This skill's## Version compatibilitycross-links the four-way match rule and adds only the Ethernet-specific overlay (RX-type availability windows, checksum-offload device-conditional support).doca-structured-tools-contract— the bundle's structured-tools precedence rule (detect / prefer / fall back / report). The Command appendix in TASKS.md honors this contract.doca-programming-guide— general DOCA programming patterns shared by every library: the canonicalpkg-config+ meson build pattern, the universal modify-a-shipped-sample first-app workflow, the universal lifecycle, the cross-libraryDOCA_ERROR_*taxonomy, and the program-side debug order. This skill layers Ethernet specifics on top.doca-flow— the steering surface that decides which packets land on whichdoca_eth_rxq. DOCA Ethernet does not program steering itself; an empty RX queue almost always means a missing or wrong Flow rule, not an Ethernet bug.doca-debug— the cross-cutting debug ladder (install / version / build / link / runtime / program / driver). Ethernet-specific debug (RX-type mismatches, send-queue-full retries, steering-empty-queue symptoms) overlays on top of that ladder.
Frequently asked questions about DOCA Ethernet
Similar skills
Python PyPI Package Builder
Streamline the process of creating and publishing Python packages.
Minecraft Plugin Development
Streamline your Minecraft server plugin creation.
MCP Server Builder
Easily build .NET MCP servers with the latest standards.
CommunityToolkit.Mvvm Messenger
Decoupled communication for ViewModels in .NET applications.
MVVM Toolkit DI
Streamline ViewModel integration with Dependency Injection in .NET.
MCP Apps Builder
Essential guidelines for MCP server development.
