Debian Codegraph @

upstream/debian-unstable/man8/devlink-region.8

raw
1 .TH DEVLINK\-REGION 8 "10 Jan 2018" "iproute2" "Linux"
2 .SH NAME
3 devlink-region \- devlink address region access
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B devlink
10 .RI "[ " OPTIONS " ]"
11 .B region
12 .RI " { " COMMAND " | "
13 .BR help " }"
14 .sp
15
16 .ti -8
17 .IR OPTIONS " := { "
18 \fB\-V\fR[\fIersion\fR] |
19 \fB\-n\fR[\fIno-nice-names\fR] }
20
21 .ti -8
22 .BR "devlink region show"
23 .RI "[ " DEV/REGION " ]"
24
25 .ti -8
26 .BR "devlink region new"
27 .RI "" DEV/REGION ""
28 .BR "[ "
29 .BR "snapshot"
30 .RI "" SNAPSHOT_ID ""
31 .BR "]"
32
33 .ti -8
34 .BR "devlink region del"
35 .RI "" DEV/REGION ""
36 .BR "snapshot"
37 .RI "" SNAPSHOT_ID ""
38
39 .ti -8
40 .BR "devlink region dump"
41 .RI "" DEV/REGION ""
42 .BR "snapshot"
43 .RI "" SNAPSHOT_ID ""
44
45 .ti -8
46 .BR "devlink region read"
47 .RI "" DEV/REGION ""
48 .BR "[ "
49 .BR "snapshot"
50 .RI "" SNAPSHOT_ID ""
51 .BR "]"
52 .BR "address"
53 .RI "" ADDRESS "
54 .BR "length"
55 .RI "" LENGTH ""
56
57 .ti -8
58 .B devlink region help
59
60 .SH "DESCRIPTION"
61 .SS devlink region show - Show all supported address regions names, snapshots and sizes
62
63 .PP
64 .I "DEV/REGION"
65 - specifies the devlink device and address-region to query.
66
67 .SS devlink region new - Create a snapshot specified by address-region name and snapshot ID
68
69 .PP
70 .I "DEV/REGION"
71 - specifies the devlink device and address-region to snapshot
72
73 .PP
74 snapshot
75 .I "SNAPSHOT_ID"
76 - optionally specifies the snapshot ID to assign. If not specified, devlink will assign a unique ID to the snapshot.
77
78 .SS devlink region del - Delete a snapshot specified by address-region name and snapshot ID
79
80 .PP
81 .I "DEV/REGION"
82 - specifies the devlink device and address-region to delete the snapshot from
83
84 .PP
85 snapshot
86 .I "SNAPSHOT_ID"
87 - specifies the snapshot ID to delete
88
89 .SS devlink region dump - Dump all the available data from a region or from snapshot of a region
90
91 .PP
92 .I "DEV/REGION"
93 - specifies the device and address-region to dump from.
94
95 .PP
96 snapshot
97 .I "SNAPSHOT_ID"
98 - specifies the snapshot-id of the region to dump.
99
100 .SS devlink region read - Read from a specific region address for a given length
101
102 .PP
103 .I "DEV/REGION"
104 - specifies the device and address-region to read from.
105
106 .PP
107 snapshot
108 .I "SNAPSHOT_ID"
109 - specifies the snapshot-id of the region to read.
110
111 .PP
112 address
113 .I "ADDRESS"
114 - specifies the address to read from.
115
116 .PP
117 length
118 .I "LENGTH"
119 - specifies the length of data to read.
120
121 .SH "EXAMPLES"
122 .PP
123 devlink region show
124 .RS 4
125 List available address regions and snapshot.
126 .RE
127 .PP
128 devlink region new pci/0000:00:05.0/cr-space
129 .RS 4
130 Create a new snapshot from cr-space address region from device pci/0000:00:05.0.
131 .RE
132 .PP
133 devlink region del pci/0000:00:05.0/cr-space snapshot 1
134 .RS 4
135 Delete snapshot id 1 from cr-space address region from device pci/0000:00:05.0.
136 .RE
137 .PP
138 devlink region dump pci/0000:00:05.0/cr-space snapshot 1
139 .RS 4
140 Dump the snapshot taken from cr-space address region with ID 1
141 .RE
142 .PP
143 devlink region read pci/0000:00:05.0/cr-space snapshot 1 address 0x10 length 16
144 .RS 4
145 Read from address 0x10, 16 Bytes of snapshot ID 1 taken from cr-space address region
146 .RE
147
148 .SH SEE ALSO
149 .BR devlink (8),
150 .BR devlink-dev (8),
151 .BR devlink-port (8),
152 .BR devlink-monitor (8),
153 .br
154
155 .SH AUTHOR
156 Alex Vesker <[email protected]>