Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Guangbin Huang <huangguangbin2@huawei.com>
To: <davem@davemloft.net>, <kuba@kernel.org>, <jiri@nvidia.com>
Cc: <netdev@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	<lipeng321@huawei.com>, <chenhao288@hisilicon.com>,
	<huangguangbin2@huawei.com>
Subject: [PATCH V2 net-next 1/9] devlink: add documentation for hns3 driver
Date: Thu, 15 Jul 2021 15:45:02 +0800	[thread overview]
Message-ID: <1626335110-50769-2-git-send-email-huangguangbin2@huawei.com> (raw)
In-Reply-To: <1626335110-50769-1-git-send-email-huangguangbin2@huawei.com>

From: Hao Chen <chenhao288@hisilicon.com>

Add a file to document devlink support for hns3 driver.

Now support devlink param and devlink info.

Signed-off-by: Hao Chen <chenhao288@hisilicon.com>
Signed-off-by: Guangbin Huang <huangguangbin2@huawei.com>
---
 Documentation/networking/devlink/hns3.rst  | 56 ++++++++++++++++++++++++++++++
 Documentation/networking/devlink/index.rst |  1 +
 2 files changed, 57 insertions(+)
 create mode 100644 Documentation/networking/devlink/hns3.rst

diff --git a/Documentation/networking/devlink/hns3.rst b/Documentation/networking/devlink/hns3.rst
new file mode 100644
index 000000000000..ed11a3d59c0c
--- /dev/null
+++ b/Documentation/networking/devlink/hns3.rst
@@ -0,0 +1,56 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+hns3 devlink support
+====================
+
+This document describes the devlink features implemented by the ``hns3``
+device driver.
+
+Parameters
+==========
+
+The ``hns3`` driver implements the following driver-specific
+parameters.
+
+.. list-table:: Driver-specific parameters implemented
+   :widths: 10 10 10 70
+
+   * - Name
+     - Type
+     - Mode
+     - Description
+   * - ``rx_buf_len``
+     - U32
+     - driverinit
+     - Set rx BD buffer size, now only support setting 2048 and 4096.
+
+       * The feature is used to change the buffer size of each BD of Rx ring
+         between 2KB and 4KB, then do devlink reload operation to take effect.
+   * - ``tx_buf_size``
+     - U32
+     - driverinit
+     - Set tx bounce buf size.
+
+       * The size is setted for tx bounce feature. Tx bounce buffer feature is
+         used for small size packet or frag. It adds a queue based tx shared
+         bounce buffer to memcpy the small packet when the len of xmitted skb is
+         below tx_copybreak(value to distinguish small size and normal size),
+         and reduce the overhead of dma map and unmap when IOMMU is on.
+
+The ``hns3`` driver supports reloading via ``DEVLINK_CMD_RELOAD``.
+
+Info versions
+=============
+
+The ``hns3`` driver reports the following versions
+
+.. list-table:: devlink info versions implemented
+   :widths: 10 10 80
+
+   * - Name
+     - Type
+     - Description
+   * - ``fw``
+     - running
+     - Used to represent the firmware version.
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index b3b9e0692088..03f56ed2961f 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -34,6 +34,7 @@ parameters, info versions, and other features it supports.
    :maxdepth: 1
 
    bnxt
+   hns3
    ionic
    ice
    mlx4
-- 
2.8.1


  reply	other threads:[~2021-07-15  7:49 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-15  7:45 [PATCH V2 net-next 0/9] net: hns3: add support devlink Guangbin Huang
2021-07-15  7:45 ` Guangbin Huang [this message]
2021-07-16  6:00   ` [PATCH V2 net-next 1/9] devlink: add documentation for hns3 driver Jakub Kicinski
2021-07-19  1:21     ` huangguangbin (A)
2021-07-15  7:45 ` [PATCH V2 net-next 2/9] net: hns3: add support for registering devlink for PF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 3/9] net: hns3: add support for registering devlink for VF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 4/9] net: hns3: add support for devlink get info for PF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 5/9] net: hns3: add support for devlink get info for VF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 6/9] net: hns3: add devlink reload support for PF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 7/9] net: hns3: add devlink reload support for VF Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 8/9] net: hns3: add support for PF setting rx/tx buffer size by devlink param Guangbin Huang
2021-07-15  7:45 ` [PATCH V2 net-next 9/9] net: hns3: add support for VF " Guangbin Huang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1626335110-50769-2-git-send-email-huangguangbin2@huawei.com \
    --to=huangguangbin2@huawei.com \
    --cc=chenhao288@hisilicon.com \
    --cc=davem@davemloft.net \
    --cc=jiri@nvidia.com \
    --cc=kuba@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lipeng321@huawei.com \
    --cc=netdev@vger.kernel.org \
    --subject='Re: [PATCH V2 net-next 1/9] devlink: add documentation for hns3 driver' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).