diff mbox series

[net-next,2/2] devlink: add documentation for octeontx2 driver

Message ID 1635330675-25592-3-git-send-email-sbhatta@marvell.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series Add a devlink param and documentation | expand

Checks

Context Check Description
netdev/cover_letter success Series has a cover letter
netdev/fixes_present success Fixes tag not required for -next series
netdev/patch_count success Link
netdev/tree_selection success Clearly marked for net-next
netdev/subject_prefix success Link
netdev/cc_maintainers warning 3 maintainers not CCed: jiri@nvidia.com corbet@lwn.net linux-doc@vger.kernel.org
netdev/source_inline success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/module_param success Was 0 now: 0
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/verify_fixes success No Fixes tag
netdev/checkpatch warning WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/header_inline success No static functions without inline keyword in header files

Commit Message

Subbaraya Sundeep Oct. 27, 2021, 10:31 a.m. UTC
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

Comments

Jakub Kicinski Oct. 27, 2021, 3:39 p.m. UTC | #1
On Wed, 27 Oct 2021 16:01:15 +0530 Subbaraya Sundeep wrote:
> 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>

Please resend just the docs for the existing params.
No point keeping those hostage to the serdes change.
sundeep subbaraya Oct. 27, 2021, 5:04 p.m. UTC | #2
Hi Jakub,

On Wed, Oct 27, 2021 at 9:53 PM Subbaraya Sundeep Bhatta
<sbhatta@marvell.com> wrote:
>
>
> From: Jakub Kicinski <kuba@kernel.org>
> Sent: Wednesday, October 27, 2021 9:09 PM
> To: Subbaraya Sundeep Bhatta
> Cc: davem@davemloft.net; netdev@vger.kernel.org; Hariprasad Kelam; Geethasowjanya Akula; Sunil Kovvuri Goutham; Rakesh Babu Saladi
> Subject: [EXT] Re: [net-next PATCH 2/2] devlink: add documentation for octeontx2 driver
>
> On Wed, 27 Oct 2021 16:01:15 +0530 Subbaraya Sundeep wrote:
> > 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>
>
> Please resend just the docs for the existing params.
> No point keeping those hostage to the serdes change.

Sure will do that.

Thanks,
Sundeep
diff mbox series

Patch

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.