[net-next PATCH 2/2] devlink: add documentation for octeontx2 driver
From: Subbaraya Sundeep <sbhatta@marvell.com>
Date: 2021-10-27 10:31:38
Subsystem:
documentation, networking [general], the rest · Maintainers:
Jonathan Corbet, "David S. Miller", Eric Dumazet, Jakub Kicinski, Paolo Abeni, Linus Torvalds
Add a file to document devlink support for octeontx2 driver. Driver-specific parameters implemented by AF, PF and VF drivers are documented. Signed-off-by: Subbaraya Sundeep <sbhatta@marvell.com> Signed-off-by: Sunil Goutham <sgoutham@marvell.com> --- Documentation/networking/devlink/index.rst | 1 + Documentation/networking/devlink/octeontx2.rst | 47 ++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 Documentation/networking/devlink/octeontx2.rst
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 19ffd56..4431237 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst@@ -48,3 +48,4 @@ parameters, info versions, and other features it supports. am65-nuss-cpsw-switch prestera iosm + octeontx2
diff --git a/Documentation/networking/devlink/octeontx2.rst b/Documentation/networking/devlink/octeontx2.rst
new file mode 100644
index 0000000..988fa21
--- /dev/null
+++ b/Documentation/networking/devlink/octeontx2.rst@@ -0,0 +1,47 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================= +octeontx2 devlink support +========================= + +This document describes the devlink features implemented by the ``octeontx2 AF, PF and VF`` +device drivers. + +Parameters +========== + +The ``octeontx2 PF and VF`` drivers implement the following driver-specific parameters. + +.. list-table:: Driver-specific parameters implemented + :widths: 5 5 5 85 + + * - Name + - Type + - Mode + - Description + * - ``mcam_count`` + - u16 + - runtime + - Select number of match CAM entries to be allocated for an interface. + The same is used for ntuple filters of the interface. Supported by + PF and VF drivers. + * - ``serdes_link`` + - bool + - runtime + - Use to initialize and de-initialize SerDes configuration. Command is + sent to firmware for SerDes configuration. Supported by PF driver + +The ``octeontx2 AF`` driver implements the following driver-specific parameters. + +.. list-table:: Driver-specific parameters implemented + :widths: 5 5 5 85 + + * - Name + - Type + - Mode + - Description + * - ``dwrr_mtu`` + - u32 + - runtime + - Use to set the quantum which hardware uses for scheduling among transmit queues. + Hardware uses weighted DWRR algorithm to schedule among all transmit queues.
--
2.7.4