Skip to content

Commit 2b86127

Browse files
author
Pavel Siska
committed
Nfb: Add README
1 parent c1b1a88 commit 2b86127

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

src/plugins/input/nfb/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# NFB (input plugin)
2+
3+
Receive packets over nfb (Netcope FPGA Board). Requires a special network card with compatible
4+
firmware for high-speed packet processing. Suitable for speeds of 100 Gbps and above.
5+
6+
## Example configuration
7+
8+
```yaml
9+
input_plugin:
10+
ndp:
11+
device: "/dev/nfb0"
12+
queues: "0,1,2,3-15"
13+
```
14+
15+
## Parameters
16+
17+
**Mandatory parameters:**
18+
19+
|Parameter | Description |
20+
|---|---|
21+
|__device__| Path to the NFB device to be used. Typically /dev/nfb0 or /dev/nfb/by-serial-no/{card-serial} |
22+
|__queues__| List of queues to be used for packet reception. The queues can be specified as a comma-separated list (e.g., 0,1,2) or a range (e.g., 3-15). This is required to determine which specific receive queues to use on the NFB device. |

0 commit comments

Comments
 (0)