From patchwork Thu Jul 15 07:45:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "huangguangbin \(A\)" X-Patchwork-Id: 477871 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DB4EDC07E96 for ; Thu, 15 Jul 2021 07:49:04 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id BE9A361279 for ; Thu, 15 Jul 2021 07:49:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S240715AbhGOHv4 (ORCPT ); Thu, 15 Jul 2021 03:51:56 -0400 Received: from szxga02-in.huawei.com ([45.249.212.188]:11418 "EHLO szxga02-in.huawei.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S240505AbhGOHvh (ORCPT ); Thu, 15 Jul 2021 03:51:37 -0400 Received: from dggemv703-chm.china.huawei.com (unknown [172.30.72.53]) by szxga02-in.huawei.com (SkyGuard) with ESMTP id 4GQRHS3VB8zcddF; Thu, 15 Jul 2021 15:45:24 +0800 (CST) Received: from dggemi759-chm.china.huawei.com (10.1.198.145) by dggemv703-chm.china.huawei.com (10.3.19.46) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256) id 15.1.2176.2; Thu, 15 Jul 2021 15:48:38 +0800 Received: from localhost.localdomain (10.67.165.24) by dggemi759-chm.china.huawei.com (10.1.198.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2176.2; Thu, 15 Jul 2021 15:48:38 +0800 From: Guangbin Huang To: , , CC: , , , , Subject: [PATCH V2 net-next 1/9] devlink: add documentation for hns3 driver Date: Thu, 15 Jul 2021 15:45:02 +0800 Message-ID: <1626335110-50769-2-git-send-email-huangguangbin2@huawei.com> X-Mailer: git-send-email 2.8.1 In-Reply-To: <1626335110-50769-1-git-send-email-huangguangbin2@huawei.com> References: <1626335110-50769-1-git-send-email-huangguangbin2@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.67.165.24] X-ClientProxiedBy: dggems701-chm.china.huawei.com (10.3.19.178) To dggemi759-chm.china.huawei.com (10.1.198.145) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org From: Hao Chen Add a file to document devlink support for hns3 driver. Now support devlink param and devlink info. Signed-off-by: Hao Chen Signed-off-by: Guangbin Huang --- 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