Blame man/man8/devlink-dev.8

Packit d3f73b
.TH DEVLINK\-DEV 8 "14 Mar 2016" "iproute2" "Linux"
Packit d3f73b
.SH NAME
Packit d3f73b
devlink-dev \- devlink device configuration
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 dev
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
.B devlink dev show
Packit d3f73b
.RI "[ " DEV " ]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.B devlink dev help
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev eswitch set"
Packit d3f73b
.IR DEV
Packit d3f73b
.RI "[ "
Packit d3f73b
.BR mode " { " legacy " | " switchdev " } "
Packit d3f73b
.RI "]"
Packit d3f73b
.RI "[ "
Packit d3f73b
.BR inline-mode " { " none " | " link " | " network " | " transport " } "
Packit d3f73b
.RI "]"
Packit d3f73b
.RI "[ "
Packit d3f73b
.BR encap " { " disable " | " enable " } "
Packit d3f73b
.RI "]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev eswitch show"
Packit d3f73b
.IR DEV
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev param set"
Packit d3f73b
.IR DEV
Packit d3f73b
.BR name
Packit d3f73b
.IR PARAMETER
Packit d3f73b
.BR value
Packit d3f73b
.IR VALUE
Packit d3f73b
.BR cmode " { " runtime " | " driverinit " | " permanent " } "
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev param show"
Packit d3f73b
.RI "[ "
Packit d3f73b
.IR DEV
Packit d3f73b
.BR name
Packit d3f73b
.IR PARAMETER
Packit d3f73b
.RI "]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev reload"
Packit d3f73b
.IR DEV
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev info"
Packit d3f73b
.RI "[ "
Packit d3f73b
.IR DEV
Packit d3f73b
.RI "]"
Packit d3f73b
Packit d3f73b
.ti -8
Packit d3f73b
.BR "devlink dev flash"
Packit d3f73b
.IR DEV
Packit d3f73b
.BR file
Packit d3f73b
.IR PATH
Packit d3f73b
.RI "["
Packit d3f73b
.BR target
Packit d3f73b
.IR ID
Packit d3f73b
.RI "]"
Packit d3f73b
Packit d3f73b
.SH "DESCRIPTION"
Packit d3f73b
.SS devlink dev show - display devlink device attributes
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV"
Packit d3f73b
- specifies the devlink device to show.
Packit d3f73b
If this argument is omitted all devices are listed.
Packit d3f73b
Packit d3f73b
.in +4
Packit d3f73b
Format is:
Packit d3f73b
.in +2
Packit d3f73b
BUS_NAME/BUS_ADDRESS
Packit d3f73b
Packit d3f73b
.SS devlink dev eswitch show - display devlink device eswitch attributes
Packit d3f73b
.SS devlink dev eswitch set  - sets devlink device eswitch attributes
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BR mode " { " legacy " | " switchdev " } "
Packit d3f73b
Set eswitch mode
Packit d3f73b
Packit d3f73b
.I legacy
Packit d3f73b
- Legacy SRIOV
Packit d3f73b
Packit d3f73b
.I switchdev
Packit d3f73b
- SRIOV switchdev offloads
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BR inline-mode " { " none " | " link " | " network " | " transport " } "
Packit d3f73b
Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.
Packit d3f73b
Packit d3f73b
.I none
Packit d3f73b
- None
Packit d3f73b
Packit d3f73b
.I link
Packit d3f73b
- L2 mode
Packit d3f73b
Packit d3f73b
.I network
Packit d3f73b
- L3 mode
Packit d3f73b
Packit d3f73b
.I transport
Packit d3f73b
- L4 mode
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BR encap " { " disable " | " enable " } "
Packit d3f73b
Set eswitch encapsulation support
Packit d3f73b
Packit d3f73b
.I disable
Packit d3f73b
- Disable encapsulation support
Packit d3f73b
Packit d3f73b
.I enable
Packit d3f73b
- Enable encapsulation support
Packit d3f73b
Packit d3f73b
.SS devlink dev param set  - set new value to devlink device configuration parameter
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BI name " PARAMETER"
Packit d3f73b
Specify parameter name to set.
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BI value " VALUE"
Packit d3f73b
New value to set.
Packit d3f73b
Packit d3f73b
.TP
Packit d3f73b
.BR cmode " { " runtime " | " driverinit " | " permanent " } "
Packit d3f73b
Configuration mode in which the new value is set.
Packit d3f73b
Packit d3f73b
.I runtime
Packit d3f73b
- Set new value while driver is running. This configuration mode doesn't require any reset to apply the new value.
Packit d3f73b
Packit d3f73b
.I driverinit
Packit d3f73b
- Set new value which will be applied during driver initialization. This configuration mode requires restart driver by devlink reload command to apply the new value.
Packit d3f73b
Packit d3f73b
.I permanent
Packit d3f73b
- New value is written to device's non-volatile memory. This configuration mode requires hard reset to apply the new value.
Packit d3f73b
Packit d3f73b
.SS devlink dev param show - display devlink device supported configuration parameters attributes
Packit d3f73b
Packit d3f73b
.BR name
Packit d3f73b
.IR PARAMETER
Packit d3f73b
Specify parameter name to show.
Packit d3f73b
If this argument is omitted all parameters supported by devlink devices are listed.
Packit d3f73b
Packit d3f73b
.SS devlink dev reload - perform hot reload of the driver.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV"
Packit d3f73b
- Specifies the devlink device to reload.
Packit d3f73b
Packit d3f73b
.SS devlink dev info - display device information.
Packit d3f73b
Display device information provided by the driver. This command can be used
Packit d3f73b
to query versions of the hardware components or device components which
Packit d3f73b
can't be updated (
Packit d3f73b
.I fixed
Packit d3f73b
) as well as device firmware which can be updated. For firmware components
Packit d3f73b
.I running
Packit d3f73b
displays the versions of firmware currently loaded into the device, while
Packit d3f73b
.I stored
Packit d3f73b
reports the versions in device's flash.
Packit d3f73b
.I Running
Packit d3f73b
and
Packit d3f73b
.I stored
Packit d3f73b
versions may differ after flash has been updated, but before reboot.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV"
Packit d3f73b
- specifies the devlink device to show.
Packit d3f73b
If this argument is omitted all devices are listed.
Packit d3f73b
Packit d3f73b
.SS devlink dev flash - write device's non-volatile memory.
Packit d3f73b
Packit d3f73b
.PP
Packit d3f73b
.I "DEV"
Packit d3f73b
- specifies the devlink device to write to.
Packit d3f73b
Packit d3f73b
.BR file
Packit d3f73b
.I PATH
Packit d3f73b
- Path to the file which will be written into device's flash. The path needs
Packit d3f73b
to be relative to one of the directories searched by the kernel firmware loaded,
Packit d3f73b
such as /lib/firmware.
Packit d3f73b
Packit d3f73b
.BR component
Packit d3f73b
.I NAME
Packit d3f73b
- If device stores multiple firmware images in non-volatile memory, this
Packit d3f73b
parameter may be used to indicate which firmware image should be written.
Packit d3f73b
The value of
Packit d3f73b
.I NAME
Packit d3f73b
should match the component names from
Packit d3f73b
.B "devlink dev info"
Packit d3f73b
and may be driver-dependent.
Packit d3f73b
Packit d3f73b
.SH "EXAMPLES"
Packit d3f73b
.PP
Packit d3f73b
devlink dev show
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of all devlink devices on the system.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev show pci/0000:01:00.0
Packit d3f73b
.RS 4
Packit d3f73b
Shows the state of specified devlink device.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev eswitch show pci/0000:01:00.0
Packit d3f73b
.RS 4
Packit d3f73b
Shows the eswitch mode of specified devlink device.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev eswitch set pci/0000:01:00.0 mode switchdev
Packit d3f73b
.RS 4
Packit d3f73b
Sets the eswitch mode of specified devlink device to switchdev.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev param show pci/0000:01:00.0 name max_macs
Packit d3f73b
.RS 4
Packit d3f73b
Shows the parameter max_macs attributes.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev param set pci/0000:01:00.0 name internal_error_reset value true cmode runtime
Packit d3f73b
.RS 4
Packit d3f73b
Sets the parameter internal_error_reset of specified devlink device to true.
Packit d3f73b
.RE
Packit d3f73b
.PP
Packit d3f73b
devlink dev reload pci/0000:01:00.0
Packit d3f73b
.RS 4
Packit d3f73b
Performs hot reload of specified devlink device.
Packit d3f73b
Packit d3f73b
.SH SEE ALSO
Packit d3f73b
.BR devlink (8),
Packit d3f73b
.BR devlink-port (8),
Packit d3f73b
.BR devlink-sb (8),
Packit d3f73b
.BR devlink-monitor (8),
Packit d3f73b
.br
Packit d3f73b
Packit d3f73b
.SH AUTHOR
Packit d3f73b
Jiri Pirko <jiri@mellanox.com>