diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 14:18:53 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 14:18:53 +0000 |
commit | a0e0018c9a7ef5ce7f6d2c3ae16aecbbd16a8f67 (patch) | |
tree | 8feaf1a1932871b139b3b30be4c09c66489918be /man/man8/devlink-region.8 | |
parent | Initial commit. (diff) | |
download | iproute2-upstream/6.1.0.tar.xz iproute2-upstream/6.1.0.zip |
Adding upstream version 6.1.0.upstream/6.1.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | man/man8/devlink-region.8 | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/man/man8/devlink-region.8 b/man/man8/devlink-region.8 new file mode 100644 index 0000000..b706796 --- /dev/null +++ b/man/man8/devlink-region.8 @@ -0,0 +1,156 @@ +.TH DEVLINK\-REGION 8 "10 Jan 2018" "iproute2" "Linux" +.SH NAME +devlink-region \- devlink address region access +.SH SYNOPSIS +.sp +.ad l +.in +8 +.ti -8 +.B devlink +.RI "[ " OPTIONS " ]" +.B region +.RI " { " COMMAND " | " +.BR help " }" +.sp + +.ti -8 +.IR OPTIONS " := { " +\fB\-V\fR[\fIersion\fR] | +\fB\-n\fR[\fIno-nice-names\fR] } + +.ti -8 +.BR "devlink region show" +.RI "[ " DEV/REGION " ]" + +.ti -8 +.BR "devlink region new" +.RI "" DEV/REGION "" +.BR "[ " +.BR "snapshot" +.RI "" SNAPSHOT_ID "" +.BR "]" + +.ti -8 +.BR "devlink region del" +.RI "" DEV/REGION "" +.BR "snapshot" +.RI "" SNAPSHOT_ID "" + +.ti -8 +.BR "devlink region dump" +.RI "" DEV/REGION "" +.BR "snapshot" +.RI "" SNAPSHOT_ID "" + +.ti -8 +.BR "devlink region read" +.RI "" DEV/REGION "" +.BR "[ " +.BR "snapshot" +.RI "" SNAPSHOT_ID "" +.BR "]" +.BR "address" +.RI "" ADDRESS " +.BR "length" +.RI "" LENGTH "" + +.ti -8 +.B devlink region help + +.SH "DESCRIPTION" +.SS devlink region show - Show all supported address regions names, snapshots and sizes + +.PP +.I "DEV/REGION" +- specifies the devlink device and address-region to query. + +.SS devlink region new - Create a snapshot specified by address-region name and snapshot ID + +.PP +.I "DEV/REGION" +- specifies the devlink device and address-region to snapshot + +.PP +snapshot +.I "SNAPSHOT_ID" +- optionally specifies the snapshot ID to assign. If not specified, devlink will assign a unique ID to the snapshot. + +.SS devlink region del - Delete a snapshot specified by address-region name and snapshot ID + +.PP +.I "DEV/REGION" +- specifies the devlink device and address-region to delete the snapshot from + +.PP +snapshot +.I "SNAPSHOT_ID" +- specifies the snapshot ID to delete + +.SS devlink region dump - Dump all the available data from a region or from snapshot of a region + +.PP +.I "DEV/REGION" +- specifies the device and address-region to dump from. + +.PP +snapshot +.I "SNAPSHOT_ID" +- specifies the snapshot-id of the region to dump. + +.SS devlink region read - Read from a specific region address for a given length + +.PP +.I "DEV/REGION" +- specifies the device and address-region to read from. + +.PP +snapshot +.I "SNAPSHOT_ID" +- specifies the snapshot-id of the region to read. + +.PP +address +.I "ADDRESS" +- specifies the address to read from. + +.PP +length +.I "LENGTH" +- specifies the length of data to read. + +.SH "EXAMPLES" +.PP +devlink region show +.RS 4 +List available address regions and snapshot. +.RE +.PP +devlink region new pci/0000:00:05.0/cr-space +.RS 4 +Create a new snapshot from cr-space address region from device pci/0000:00:05.0. +.RE +.PP +devlink region del pci/0000:00:05.0/cr-space snapshot 1 +.RS 4 +Delete snapshot id 1 from cr-space address region from device pci/0000:00:05.0. +.RE +.PP +devlink region dump pci/0000:00:05.0/cr-space snapshot 1 +.RS 4 +Dump the snapshot taken from cr-space address region with ID 1 +.RE +.PP +devlink region read pci/0000:00:05.0/cr-space snapshot 1 address 0x10 length 16 +.RS 4 +Read from address 0x10, 16 Bytes of snapshot ID 1 taken from cr-space address region +.RE + +.SH SEE ALSO +.BR devlink (8), +.BR devlink-dev (8), +.BR devlink-port (8), +.BR devlink-monitor (8), +.br + +.SH AUTHOR +Alex Vesker <valex@mellanox.com> |