networking/devlink/devlink-port.rst

1 .. SPDX-License-Identifier: GPL-2.0
9 ``devlink-port`` is a port that exists on the device. It has a logically
19 .. list-table:: List of devlink port flavours
22    * - Flavour
23      - Description
24    * - ``DEVLINK_PORT_FLAVOUR_PHYSICAL``
25      - Any kind of physical port. This can be an eswitch physical port or any
27    * - ``DEVLINK_PORT_FLAVOUR_DSA``
28      - This indicates a DSA interconnect port.
29    * - ``DEVLINK_PORT_FLAVOUR_CPU``
30      - This indicates a CPU port applicable only to DSA.
31    * - ``DEVLINK_PORT_FLAVOUR_PCI_PF``
32      - This indicates an eswitch port representing a port of PCI
34    * - ``DEVLINK_PORT_FLAVOUR_PCI_VF``
35      - This indicates an eswitch port representing a port of PCI
37    * - ``DEVLINK_PORT_FLAVOUR_PCI_SF``
38      - This indicates an eswitch port representing a port of PCI
40    * - ``DEVLINK_PORT_FLAVOUR_VIRTUAL``
41      - This indicates a virtual port for the PCI virtual function.
45 .. list-table:: List of devlink port types
48    * - Type
49      - Description
50    * - ``DEVLINK_PORT_TYPE_ETH``
51      - Driver should set this port type when a link layer of the port is
53    * - ``DEVLINK_PORT_TYPE_IB``
54      - Driver should set this port type when a link layer of the port is
56    * - ``DEVLINK_PORT_TYPE_AUTO``
57      - This type is indicated by the user when driver should detect the port
61 ---------------
74                  ---------------------------------------------------------
76                  |           --------- ---------         ------- ------- |
77     -----------  |           | vf(s) | | sf(s) |         |vf(s)| |sf(s)| |
78     | server  |  | -------   ----/---- ---/----- ------- ---/--- ---/--- |
80     | connect |  | -------                       -------                 |
81     -----------  |     | controller_num=1 (no eswitch)                   |
82                  ------|--------------------------------------------------
85                  ---------------------------------------------------------
87                  | ----------------------------------------------------- |
88                  | |ctrl-0 | ctrl-0 | ctrl-0 | ctrl-0 | ctrl-0 |ctrl-0 | |
90                  | ----------------------------------------------------- |
91                  | |ctrl-1 | ctrl-1 | ctrl-1 | ctrl-1 | ctrl-1 |ctrl-1 | |
93                  | ----------------------------------------------------- |
96     -----------  |           --------- ---------         ------- ------- |
98     | pci rc  |==| -------   ----/---- ---/----- ------- ---/--- ---/--- |
100     -----------  | -------                       -------                 |
103                  ---------------------------------------------------------
144 -----------------
148 - Get the MAC address of the VF identified by its unique devlink port index::
155 - Set the MAC address of the VF identified by its unique devlink port index::
164 - Get the MAC address of the SF identified by its unique devlink port index::
171 - Set the MAC address of the SF identified by its unique devlink port index::
181 ---------------------
186 When user disables RoCE capability for a VF/SF, user application cannot send or
193 - Get RoCE capability of the VF device::
200 - Set RoCE capability of the VF device::
210 ---------------------------
211 Live migration is the process of transferring a live virtual machine
215 User who want PCI VFs to be able to perform live migration need to
219 with migration support, the user can migrate the VM with this VF from one HV to a
226 - Get migratable capability of the VF device::
233 - Set migratable capability of the VF device::
242 - Bind VF to VFIO driver with migration support::
250 Perform live migration.
253 -----------------------------
260 - Get IPsec crypto capability of the VF device::
267 - Set IPsec crypto capability of the VF device::
277 -----------------------------
285 - Get IPsec packet capability of the VF device::
292 - Set IPsec packet capability of the VF device::
302 ------------------------------
315 - Get maximum IO event queues of the VF device::
322 - Set maximum IO event queues of the VF device::
341 1) create - create a subfunction;
342 2) configure - configure subfunction attributes;
343 3) deploy - deploy the subfunction;
349 ----------
358 -------------
360 entities are created on devlink side, the e-switch port representor is created,
361 but the subfunction device itself is not created. A user might use e-switch port
367 ----------
371 A subfunction device is created on the :ref:`Documentation/driver-api/auxiliary_bus.rst <auxiliary_…
437 #. If all the nodes from the highest priority sub-group are satisfied, or
442 may export nodes/leafs and their child-parent relationships.
447 .. list-table:: Terms and Definitions
450    * - Term
451      - Definitions
452    * - ``PCI device``
453      - A physical PCI device having one or more PCI buses consists of one or
455    * - ``PCI controller``
456      -  A controller consists of potentially multiple physical functions,
458    * - ``Port function``
459      -  An object to manage the function of a port.
460    * - ``Subfunction``
461      -  A lightweight function that has parent PCI function on which it is
463    * - ``Subfunction device``
464      -  A bus device of the subfunction, usually on a auxiliary bus.
465    * - ``Subfunction driver``
466      -  A device driver for the subfunction auxiliary device.
467    * - ``Subfunction management device``
468      -  A PCI physical function that supports subfunction management.
469    * - ``Subfunction management driver``
470      -  A device driver for PCI physical function that supports
472    * - ``Subfunction host driver``
473      -  A device driver for PCI physical function that hosts subfunction