| From a258c804aa8742763dce694b5e992d7ccf4294f2 Mon Sep 17 00:00:00 2001 |
| From: Mateusz Polchlopek <mateusz.polchlopek@intel.com> |
| Date: Thu, 12 Oct 2023 08:31:44 -0400 |
| Subject: docs: fix info about representor identification |
| |
| From: Mateusz Polchlopek <mateusz.polchlopek@intel.com> |
| |
| commit a258c804aa8742763dce694b5e992d7ccf4294f2 upstream. |
| |
| Update the "How are representors identified?" documentation |
| subchapter. For newer kernels driver should use |
| SET_NETDEV_DEVLINK_PORT instead of ndo_get_devlink_port() |
| callback. |
| |
| Fixes: 7712b3e966ea ("Merge branch 'net-fix-netdev-to-devlink_port-linkage-and-expose-to-user'") |
| Signed-off-by: Mateusz Polchlopek <mateusz.polchlopek@intel.com> |
| Reviewed-by: Wojciech Drewek <wojciech.drewek@intel.com> |
| Reviewed-by: Przemek Kitszel <przemyslaw.kitszel@intel.com> |
| Reviewed-by: Edward Cree <ecree.xilinx@gmail.com> |
| Link: https://lore.kernel.org/r/20231012123144.15768-1-mateusz.polchlopek@intel.com |
| Signed-off-by: Jakub Kicinski <kuba@kernel.org> |
| Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> |
| --- |
| Documentation/networking/representors.rst | 8 +++++--- |
| 1 file changed, 5 insertions(+), 3 deletions(-) |
| |
| diff --git a/Documentation/networking/representors.rst b/Documentation/networking/representors.rst |
| index ee1f5cd54496..decb39c19b9e 100644 |
| --- a/Documentation/networking/representors.rst |
| +++ b/Documentation/networking/representors.rst |
| @@ -162,9 +162,11 @@ How are representors identified? |
| The representor netdevice should *not* directly refer to a PCIe device (e.g. |
| through ``net_dev->dev.parent`` / ``SET_NETDEV_DEV()``), either of the |
| representee or of the switchdev function. |
| -Instead, it should implement the ``ndo_get_devlink_port()`` netdevice op, which |
| -the kernel uses to provide the ``phys_switch_id`` and ``phys_port_name`` sysfs |
| -nodes. (Some legacy drivers implement ``ndo_get_port_parent_id()`` and |
| +Instead, the driver should use the ``SET_NETDEV_DEVLINK_PORT`` macro to |
| +assign a devlink port instance to the netdevice before registering the |
| +netdevice; the kernel uses the devlink port to provide the ``phys_switch_id`` |
| +and ``phys_port_name`` sysfs nodes. |
| +(Some legacy drivers implement ``ndo_get_port_parent_id()`` and |
| ``ndo_get_phys_port_name()`` directly, but this is deprecated.) See |
| :ref:`Documentation/networking/devlink/devlink-port.rst <devlink_port>` for the |
| details of this API. |
| -- |
| 2.42.0 |
| |