RE: [PATCH net-next] devlink: Add devlink port documentation

From: Jacob Keller <jacob.e.keller@intel.com>
Sent: Tuesday, December 1, 2020 12:59 AM



On 11/30/2020 8:41 AM, Parav Pandit wrote:

quoted

Added documentation for devlink port and port function related commands.

Signed-off-by: Parav Pandit <redacted>
Reviewed-by: Jiri Pirko <redacted>

Good to see this! I saw a couple of minor nits.

Thanks, fixing them.
 

- Jake

quoted

---
 .../networking/devlink/devlink-port.rst       | 102 ++++++++++++++++++
 Documentation/networking/devlink/index.rst    |   1 +
 2 files changed, 103 insertions(+)
 create mode 100644 Documentation/networking/devlink/devlink-port.rst

diff --git a/Documentation/networking/devlink/devlink-port.rst

b/Documentation/networking/devlink/devlink-port.rst
new file mode 100644
index 000000000000..966d2ee328a6

--- /dev/null
+++ b/Documentation/networking/devlink/devlink-port.rst

@@ -0,0 +1,102 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============
+Devlink Port
+============
+
+``devlink-port`` provides capability for a driver to expose various
+flavours of ports which exist on device. A devlink port can of an
+embedded switch (eswitch) present on the device.
+

Seems like a word is missing here in the "A devlink port can of an embedded
switch". Perhaps "Can be of"?

Yes. 

quoted

+A devlink port can be of 3 diffferent types.
+
+.. list-table:: List of devlink port types
+   :widths: 23 90
+
+   * - Type
+     - Description
+   * - ``DEVLINK_PORT_TYPE_ETH``
+     - This type is set for a devlink port when a physical link layer of the port
+       is Ethernet.
+   * - ``DEVLINK_PORT_TYPE_IB``
+     - This type is set for a devlink port when a physical link layer of the port
+       is InfiniBand.
+   * - ``DEVLINK_PORT_TYPE_AUTO``
+     - This type is indicated by the user when user prefers to set the port type
+       to be automatically detected by the device driver.
+
+Devlink port can be of few different flavours described below.
+
+.. list-table:: List of devlink port flavours
+   :widths: 33 90
+
+   * - Flavour
+     - Description
+   * - ``DEVLINK_PORT_FLAVOUR_PHYSICAL``
+     - Any kind of port which is physically facing the user. This can be
+       a eswitch physical port or any other physical port on the device.
+   * - ``DEVLINK_PORT_FLAVOUR_CPU``
+     - This indicates a CPU port.
+   * - ``DEVLINK_PORT_FLAVOUR_DSA``
+     - This indicates a interconnect port in a distributed switch architecture.
+   * - ``DEVLINK_PORT_FLAVOUR_PCI_PF``
+     - This indicates an eswitch port representing PCI physical function(PF).
+   * - ``DEVLINK_PORT_FLAVOUR_PCI_VF``
+     - This indicates an eswitch port representing PCI virtual function(VF).
+   * - ``DEVLINK_PORT_FLAVOUR_VIRTUAL``
+     - This indicates a virtual port facing the user.
+   * - ``DEVLINK_PORT_FLAVOUR_VIRTUAL``
+     - This indicates an virtual port facing the user.

DEVLINK_PORT_FLAVOUR_VIRTUAL is repeated.

Removing it.

quoted

+
+A devlink port may be for a controller consist of one or more PCI device(s).
+A devlink instance holds ports of two types of controllers.
+

s/consist/consisting/ ?

Yes.