Skip to content

Commit

Permalink
xdp-loader/README: Mention lack of support for HW mode in most cards
Browse files Browse the repository at this point in the history
We don't document that the 'hw' mode is unsupported on most hardware. Add a
note to the man page explaining this.

Signed-off-by: Toke Høiland-Jørgensen <[email protected]>
  • Loading branch information
tohojo committed Dec 9, 2022
1 parent 2682c1c commit 8afda7a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 3 additions & 1 deletion xdp-loader/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ the program to be offloaded to the hardware, or 'unspecified' which leaves it up
to the kernel to pick a mode (which it will do by picking native mode if the
driver supports it, or generic mode otherwise). Note that using 'unspecified'
can make it difficult to predict what mode a program will end up being loaded
in. For this reason, the default is 'native'.
in. For this reason, the default is 'native'. Note that hardware with support
for the 'hw' mode is rare: Solarflare cards (using the 'sfc' driver) are the
only devices with support for this in the mainline Linux kernel.

** -p, --pin-path <path>
This specifies a root path under which to pin any maps that define the 'pinning'
Expand Down
6 changes: 4 additions & 2 deletions xdp-loader/xdp-loader.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "xdp-loader" "8" "AUGUST 16, 2022" "V1.2.8" "XDP program loader"
.TH "xdp-loader" "8" "DECEMBER 10, 2022" "V1.2.8" "XDP program loader"

.SH "NAME"
xdp-loader \- an XDP program loader
Expand Down Expand Up @@ -59,7 +59,9 @@ the program to be offloaded to the hardware, or 'unspecified' which leaves it up
to the kernel to pick a mode (which it will do by picking native mode if the
driver supports it, or generic mode otherwise). Note that using 'unspecified'
can make it difficult to predict what mode a program will end up being loaded
in. For this reason, the default is 'native'.
in. For this reason, the default is 'native'. Note that hardware with support
for the 'hw' mode is rare: Solarflare cards (using the 'sfc' driver) are the
only devices with support for this in the mainline Linux kernel.

.SS "-p, --pin-path <path>"
.PP
Expand Down

0 comments on commit 8afda7a

Please sign in to comment.