Blame man/man8/devlink-region.8

Packit d3f73b
.TH DEVLINK\-REGION 8 "10 Jan 2018" "iproute2" "Linux"
Packit d3f73b
.SH NAME
Packit d3f73b
devlink-region \- devlink address region access
Packit d3f73b
.SH SYNOPSIS
Packit d3f73b
.sp
Packit d3f73b
.ad l
Packit d3f73b
.in +8
Packit d3f73b
.ti -8
Packit d3f73b
.B devlink
Packit d3f73b
.RI "[ " OPTIONS " ]"
Packit d3f73b
.B region
Packit d3f73b
.RI  " { " COMMAND " | "
Packit d3f73b
.BR help " }"
Packit d3f73b
.sp
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.IR OPTIONS " := { "
Packit d3f73b
\fB\-V\fR[\fIersion\fR] |
Packit d3f73b
\fB\-n\fR[\fIno-nice-names\fR] }
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink region show"
Packit d3f73b
.RI "[ " DEV/REGION " ]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink region del"
Packit d3f73b
.RI "" DEV/REGION ""
Packit d3f73b
.BR "snapshot"
Packit d3f73b
.RI "" SNAPSHOT_ID ""
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink region dump"
Packit d3f73b
.RI "" DEV/REGION ""
Packit d3f73b
.BR "snapshot"
Packit d3f73b
.RI "" SNAPSHOT_ID ""
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink region read"
Packit d3f73b
.RI "" DEV/REGION ""
Packit d3f73b
.BR "[ "
Packit d3f73b
.BR "snapshot"
Packit d3f73b
.RI "" SNAPSHOT_ID ""
Packit d3f73b
.BR "]"
Packit d3f73b
.BR "address"
Packit d3f73b
.RI "" ADDRESS "
Packit d3f73b
.BR "length"
Packit d3f73b
.RI "" LENGTH ""
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B devlink region help
Packit d3f73b
Packit d3f73b
.SH "DESCRIPTION"
Packit d3f73b
.SS devlink region show - Show all supported address regions names, snapshots and sizes
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV/REGION"
Packit d3f73b
- specifies the devlink device and address-region to query.
Packit d3f73b
Packit d3f73b
.SS devlink region del - Delete a snapshot specified by address-region name and snapshot ID
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV/REGION"
Packit d3f73b
- specifies the devlink device and address-region to delete the snapshot from
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
snapshot
Packit d3f73b
.I "SNAPSHOT_ID"
Packit d3f73b
- specifies the snapshot ID to delete
Packit d3f73b
Packit d3f73b
.SS devlink region dump - Dump all the available data from a region or from snapshot of a region
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV/REGION"
Packit d3f73b
- specifies the device and address-region to dump from.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
snapshot
Packit d3f73b
.I "SNAPSHOT_ID"
Packit d3f73b
- specifies the snapshot-id of the region to dump.
Packit d3f73b
Packit d3f73b
.SS devlink region read - Read from a specific region address for a given length
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV/REGION"
Packit d3f73b
- specifies the device and address-region to read from.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
snapshot
Packit d3f73b
.I "SNAPSHOT_ID"
Packit d3f73b
- specifies the snapshot-id of the region to read.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
address
Packit d3f73b
.I "ADDRESS"
Packit d3f73b
- specifies the address to read from.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
length
Packit d3f73b
.I "LENGTH"
Packit d3f73b
- specifies the length of data to read.
Packit d3f73b
Packit d3f73b
.SH "EXAMPLES"
Packit d3f73b
.PP
Packit d3f73b
devlink region show
Packit d3f73b
.RS 4
Packit d3f73b
List available address regions and snapshot.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink region del pci/0000:00:05.0/cr-space snapshot 1
Packit d3f73b
.RS 4
Packit d3f73b
Delete snapshot id 1 from cr-space address region from device pci/0000:00:05.0.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink region dump pci/0000:00:05.0/cr-space snapshot 1
Packit d3f73b
.RS 4
Packit d3f73b
Dump the snapshot taken from cr-space address region with ID 1
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink region read pci/0000:00:05.0/cr-space snapshot 1 address 0x10 legth 16
Packit d3f73b
.RS 4
Packit d3f73b
Read from address 0x10, 16 Bytes of snapshot ID 1 taken from cr-space address region
Packit d3f73b
Packit d3f73b
.SH SEE ALSO
Packit d3f73b
.BR devlink (8),
Packit d3f73b
.BR devlink-dev (8),
Packit d3f73b
.BR devlink-port (8),
Packit d3f73b
.BR devlink-monitor (8),
Packit d3f73b
.br
Packit d3f73b
Packit d3f73b
.SH AUTHOR
Packit d3f73b
Alex Vesker <valex@mellanox.com>