summaryrefslogtreecommitdiffstats
path: root/man/man8/devlink-region.8
blob: b70679613341a94c7e2a1726581b7701c5286cc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
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>