Debian Codegraph @

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

raw
1 .TH DEVLINK\-PORT 8 "14 Mar 2016" "iproute2" "Linux"
2 .SH NAME
3 devlink-port \- devlink port configuration
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B devlink
10 .RI "[ " OPTIONS " ]"
11 .B port
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 port set "
23 .IR DEV/PORT_INDEX
24 .RI "[ "
25 .BR type " { " eth " | " ib " | " auto " }"
26 .RI "]"
27
28 .ti -8
29 .BR "devlink port split "
30 .IR DEV/PORT_INDEX
31 .BR count
32 .IR COUNT
33
34 .ti -8
35 .BR "devlink port unsplit "
36 .IR DEV/PORT_INDEX
37
38 .ti -8
39 .B devlink port show
40 .RI "[ " DEV/PORT_INDEX " ]"
41
42 .ti -8
43 .B devlink port health
44 .RI "{ " show " | " recover " | " diagnose " | " dump " | " set " }"
45
46 .ti -8
47 .BI "devlink port add"
48 .RB "{"
49 .IR "DEV | DEV/PORT_INDEX"
50 .RB "} "
51 .RB "[ " flavour
52 .IR FLAVOUR " ]"
53 .RB "[ " pfnum
54 .IR PFNUMBER " ]"
55 .RB "[ " sfnum
56 .IR SFNUMBER " ]"
57 .RB "[ " controller
58 .IR CNUM " ]"
59 .br
60
61 .ti -8
62 .B devlink port del
63 .IR DEV/PORT_INDEX
64
65 .ti -8
66 .BR "devlink port function set "
67 .IR DEV/PORT_INDEX
68 .RI "[ "
69 .BR "hw_addr "
70 .RI "ADDR ]"
71 .RI "[ "
72 .BR state " { " active " | " inactive " }"
73 .RI "]"
74 .RI "[ "
75 .BR roce " { " enable " | " disable " }"
76 .RI "]"
77 .RI "[ "
78 .BR migratable " { " enable " | " disable " }"
79 .RI "]"
80 .RI "[ "
81 .BR ipsec_crypto " { " enable " | " disable " }"
82 .RI "]"
83 .RI "[ "
84 .BR ipsec_packet " { " enable " | " disable " }"
85 .RI "]"
86 .RI "[ "
87 .BR max_io_eqs " EQS"
88 .RI "]"
89
90 .ti -8
91 .BR "devlink port function rate "
92 .RI "{ " show " | " set " | " add " | " del " | " help " }"
93
94 .ti -8
95 .B devlink dev param set
96 .I DEV/PORT_INDEX
97 .B name
98 .I PARAMETER
99 .B value
100 .I VALUE
101 .BR cmode " { " runtime " | " driverinit " | " permanent " } "
102
103 .ti -8
104 .B devlink dev param show
105 [
106 .I DEV/PORT_INDEX
107 .B name
108 .I PARAMETER
109 ]
110
111 .ti -8
112 .B devlink port help
113
114 .SH "DESCRIPTION"
115 .SS devlink port set - change devlink port attributes
116
117 .PP
118 .I "DEV/PORT_INDEX"
119 - specifies the devlink port to operate on.
120
121 .in +4
122 Format is:
123 .in +2
124 BUS_NAME/BUS_ADDRESS/PORT_INDEX
125
126 .TP
127 .BR type " { " eth " | " ib " | " auto " } "
128 Set port type.
129
130 .I eth
131 - Ethernet
132
133 .I ib
134 - Infiniband
135
136 .I auto
137 - autoselect
138
139 .SS devlink port split - split devlink port into more
140
141 .PP
142 .I "DEV/PORT_INDEX"
143 - specifies the devlink port to operate on.
144
145 .TP
146 .BI count " COUNT"
147 Number of ports to split into.
148
149 .SS devlink port unsplit - unsplit previously split devlink port
150 Could be performed on any split port of the same split group.
151
152 .PP
153 .I "DEV/PORT_INDEX"
154 - specifies the devlink port to operate on.
155
156 .SS devlink port show - display devlink port attributes
157
158 .PP
159 .I "DEV/PORT_INDEX"
160 - specifies the devlink port to show.
161 If this argument is omitted all ports are listed.
162
163 .SS devlink port health - devlink health reporting and recovery
164 Is an alias for
165 .BR devlink-health (8).
166
167 .ti -8
168 .SS devlink port add - add a devlink port
169 .PP
170 .I "DEV"
171 - specifies the devlink device to operate on, or
172
173 .PP
174 .I "DEV/PORT_INDEX"
175 - specifies the devlink port index to use for the requested new port.
176 This is optional. When omitted, driver allocates unique port index.
177
178 .TP
179 .BR flavour " { " pcipf " | " pcisf " } "
180 set port flavour
181
182 .I pcipf
183 - PCI PF port
184
185 .I pcisf
186 - PCI SF port
187
188 .TP
189 .BI pfnum " PFNUMBER "
190 Specifies the PCI PF number on which to create an SF device.
191
192 .TP
193 .BI sfnum " SFNUMBER "
194 Specifies sfnumber to assign to the device of the SF.
195 This field is optional for those devices which support auto assignment of the
196 SF number.
197
198 .TP
199 .BI controller " CNUM "
200 Specifies controller number for which the SF port is created.
201 This field is optional. It is used only when SF port is created for the
202 external controller.
203
204 .ti -8
205 .SS devlink port function set - Set the port function attribute(s).
206
207 .PP
208 .I "DEV/PORT_INDEX"
209 - specifies the devlink port to operate on.
210
211 .TP
212 .BI hw_addr " ADDR"
213 Hardware address of the function to set. This is an Ethernet MAC address when
214 port type is Ethernet.
215
216 .TP
217 .BR state " { " active " | " inactive " } "
218 New state of the function to change to.
219
220 .I active
221 - Once configuration of the function is done, activate the function.
222
223 .I inactive
224 - To inactivate the function and its device(s), set to inactive.
225
226 .TP
227 .BR roce " { " enable " | " disable " } "
228 Set the RoCE capability of the function.
229
230 .TP
231 .BR migratable " { " enable " | " disable " } "
232 Set the migratable capability of the function.
233
234 .TP
235 .BR ipsec_crypto " { " enable " | " disable " } "
236 Set the IPsec crypto offload capability of the function. Controls XFRM state
237 crypto operation (Encrypt/Decrypt) offload.
238
239 .TP
240 .BR ipsec_packet " { " enable " | " disable " } "
241 Set the IPsec packet offload capability of the function. Controls XFRM state
242 and policy offload (Encrypt/Decrypt operation and IPsec encapsulation).
243
244 .TP
245 .BR max_io_eqs " EQS"
246 Set the maximum number of IO event queues of the function.
247
248 .ti -8
249 .SS devlink port del - delete a devlink port
250 .PP
251 .I "DEV/PORT_INDEX"
252 - specifies the devlink port to delete.
253
254 .ti -8
255 .SS devlink port param set - set new value to devlink port configuration parameter
256 .PP
257 .I "DEV/PORT_INDEX"
258 - specifies the devlink port to operate on.
259
260 .TP
261 .BI name " PARAMETER"
262 Specify parameter name to set.
263
264 .TP
265 .BI value " VALUE"
266 New value to set.
267
268 .TP
269 .BR cmode " { " runtime " | " driverinit " | " permanent " } "
270 Configuration mode in which the new value is set.
271
272 .I runtime
273 - Set new value while driver is running. This configuration mode doesn't require any reset to apply the new value.
274
275 .I driverinit
276 - Set new value which will be applied during driver initialization. This configuration mode requires restarting the driver by devlink reload command to apply the new value.
277
278 .I permanent
279 - New value is written to device's non-volatile memory. This configuration mode requires hard reset to apply the new value.
280
281 .SS devlink port param show - display devlink port supported configuration parameters attributes
282
283 .PP
284 .I "DEV/PORT_INDEX"
285 - specifies the devlink port to operate on.
286
287 .B name
288 .I PARAMETER
289 Specify parameter name to show.
290 If this argument, as well as port index, are omitted - all parameters supported by devlink device ports are listed.
291
292 .SS devlink port function rate - manage devlink rate objects
293 Is an alias for
294 .BR devlink-rate (8).
295
296 .SH "EXAMPLES"
297 .PP
298 devlink port show
299 .RS 4
300 Shows the state of all devlink ports on the system.
301 .RE
302 .PP
303 devlink port show pci/0000:01:00.0/1
304 .RS 4
305 Shows the state of specified devlink port.
306 .RE
307 .PP
308 devlink port set pci/0000:01:00.0/1 type eth
309 .RS 4
310 Set type of specified devlink port to Ethernet.
311 .RE
312 .PP
313 devlink port split pci/0000:01:00.0/1 count 4
314 .RS 4
315 Split the specified devlink port into four ports.
316 .RE
317 .PP
318 devlink port unsplit pci/0000:01:00.0/1
319 .RS 4
320 Unsplit the specified previously split devlink port.
321 .RE
322 .PP
323 devlink port health show
324 .RS 4
325 Shows status and configuration of all supported reporters registered on all devlink ports.
326 .RE
327 .PP
328 devlink port health show pci/0000:01:00.0/1 reporter tx
329 .RS 4
330 Shows status and configuration of tx reporter registered on pci/0000:01:00.0/1 devlink port.
331 .RE
332 .PP
333 devlink port add pci/0000:06:00.0 flavour pcisf pfnum 0 sfnum 88
334 .RS 4
335 Add a devlink port of flavour PCI SF on PCI PF having number 0 with SF number 88.
336 To make use of the function an example sequence is to add a port, configure the
337 function attribute and activate the function. Once function usage is completed,
338 inactivate the function and finally delete the port. When there is desire to
339 reuse the port without deletion, it can be reconfigured and activated again when
340 function is in inactive state and function's operational state is detached.
341 .RE
342 .PP
343 devlink port del pci/0000:06:00.0/1
344 .RS 4
345 Delete previously created devlink port. It is recommended to first deactivate
346 the function if the function supports state management.
347 .RE
348 .PP
349 devlink port function set pci/0000:01:00.0/1 hw_addr 00:00:00:11:22:33
350 .RS 4
351 Configure hardware address of the PCI function represented by devlink port.
352 If the port supports change in function state, hardware address must be configured
353 before activating the function.
354 .RE
355 .PP
356 devlink port function set pci/0000:01:00.0/1 state active
357 .RS 4
358 Activate the function. This will initiate the function enumeration and driver loading.
359 .RE
360 .PP
361 devlink port function set pci/0000:01:00.0/1 state inactive
362 .RS 4
363 Deactivate the function. This will initiate the function teardown which results
364 in driver unload and device removal.
365 .RE
366 .PP
367 devlink port function set pci/0000:01:00.0/1 roce enable
368 .RS 4
369 This will enable the RoCE functionality of the function.
370 .RE
371 .PP
372 devlink port function set pci/0000:01:00.0/1 migratable enable
373 .RS 4
374 This will enable the migratable functionality of the function.
375 .RE
376 .PP
377 devlink port function set pci/0000:01:00.0/1 ipsec_crypto enable
378 .RS 4
379 This will enable the IPsec crypto offload functionality of the function.
380 .RE
381 .PP
382 devlink port function set pci/0000:01:00.0/1 ipsec_packet enable
383 .RS 4
384 This will enable the IPsec packet offload functionality of the function.
385 .RE
386 .PP
387 devlink port function set pci/0000:01:00.0/1 max_io_eqs 4
388 .RS 4
389 This will set the maximum number of IO event queues of the function to 4.
390 .RE
391 .PP
392 devlink port function set pci/0000:01:00.0/1 hw_addr 00:00:00:11:22:33 state active
393 .RS 4
394 Configure hardware address and also activate the function. When a function is
395 activated together with other configuration in a single command, all the
396 configuration is applied first before changing the state to active.
397 .RE
398 .PP
399 devlink dev param show
400 .RS 4
401 Shows (dumps) all the port parameters across all the devices registered in the devlink.
402 .RE
403 .PP
404 devlink dev param set pci/0000:01:00.0/1 name internal_error_reset value true cmode runtime
405 .RS 4
406 Sets the parameter internal_error_reset of specified devlink port (#1) to true.
407 .RE
408 .PP
409 devlink port add pci/0000:06:00.0 flavour pcisf pfnum 0 sfnum 88 controller 1
410 .RS 4
411 Add a devlink port of flavour PCI SF on controller 1 which has PCI PF of number
412 0 with SF number 88. To make use of the function an example sequence is to add
413 a port, configure the function attribute and activate the function. Once
414 the function usage is completed, deactivate the function and finally delete
415 the port. When there is desire to reuse the port without deletion, it can be
416 reconfigured and activated again when function is in inactive state and
417 function's operational state is detached.
418 .RE
419
420 .SH SEE ALSO
421 .BR devlink (8),
422 .BR devlink-dev (8),
423 .BR devlink-sb (8),
424 .BR devlink-monitor (8),
425 .BR devlink-health (8),
426 .br
427
428 .SH AUTHOR
429 Jiri Pirko <[email protected]>