[0/5] refactore mlx5 guides
| Message ID | 20220222124815.2587851-1-michaelba@nvidia.com (mailing list archive) |
|---|---|
| Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 201F9A0350; Tue, 22 Feb 2022 13:48:28 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EAA0F40DF6; Tue, 22 Feb 2022 13:48:27 +0100 (CET) Received: from NAM12-BN8-obe.outbound.protection.outlook.com (mail-bn8nam12on2079.outbound.protection.outlook.com [40.107.237.79]) by mails.dpdk.org (Postfix) with ESMTP id 248BE40DF4 for <dev@dpdk.org>; Tue, 22 Feb 2022 13:48:26 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=DLmR2QZFSlKzHfnmx/YXQrg62mtp9KStNcYpxOKhUm1x7U4QlbTp+0CRnKzQ7v+T8GV/0JeJs0twLIWq02yTAxXZj1d5NixYuigFqsAto4b/Ey2SQfPS+Y5S7bK+BP4uWcARN2InWYcViJ/shhqD670s2J8Fd8QO1MAeEkxotCAakQ+VFq033EMrsvncidKfF6PHnkM12zqY2fLP4QPq4UiguHaqh+XB6LjAO4ifOu3/jiTXgBgHQz9421KzunifR+43DpIaKbDDu9sEYa6JvczuEKI05TCp/5yFoexe2vVOKlCYRja22lmJOCiIqoe8hyO0C/brUZJ6IbH4Plx9pw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=WWXD2v+o/CX5D5DmIR2EKvD+D6ajDKcZFnFeFTlnBPo=; b=MhnsoxTfQCAYdtSmCk+cApTsPjzb76HmgWgXd3E2ZszJN31GdVs7fN4TXWNyxZArKM8Kw44Yce9WTj7XH1q7UDNyAsFo0KNzYVpzSFmycdABxo6nx7JJR8nO8ne1r3eFgP8HH/hgK1mS7sSjIY+PLjvRfL6uhY/zJmAUjOk7BGFnhpd6789WceY03Gi84LV38zgQcuRgOHT+wxOLP8fLqGdruRwlidAcLgrYqvnua8VZulwvjsxQsGb56YIuOE2H/mpp686qBQ2oSt0Ji6JaIDWHVxcFPLd91kuS7BzE6u15hj90eQwI6IDF8c0MQgS5CHnvrZ7x1+talhY35kl3ng== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 12.22.5.235) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=WWXD2v+o/CX5D5DmIR2EKvD+D6ajDKcZFnFeFTlnBPo=; b=V+6U1wvFdWwQdCBNktgoFTD6r3F52c4kBjEkgFH36nulbbFz7Pcz4sJjWcWk64uUyJfmwMYllb+qAubC1TC2uE4NMSlPCa9iVZ19Mx9CJ35rcusRnncxzyiWP8PR2SU4euDtItPwu8StPPuaYWLa1ajG3NGYAn1wOVzgFOdBV4rijYwtEEA853KiZcVTR9DpzDtEfSur6Y6p5cjAqAqbG3ufRFgdPJRYxJLQV/a5hDNch7iaYW2SnLEG1I8PY+T8ZB4SMGOXQbKBH5scZ3CTdOJ8D0Cq8o6x0fxKH1TbNNPLRxaf01ImeiJ7waTWrCj4eLyWU1TBeeZqO0Iz4Z0+sg== Received: from MW4PR03CA0269.namprd03.prod.outlook.com (2603:10b6:303:b4::34) by CO6PR12MB5475.namprd12.prod.outlook.com (2603:10b6:5:354::7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5017.21; Tue, 22 Feb 2022 12:48:24 +0000 Received: from CO1NAM11FT032.eop-nam11.prod.protection.outlook.com (2603:10b6:303:b4:cafe::d4) by MW4PR03CA0269.outlook.office365.com (2603:10b6:303:b4::34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4995.16 via Frontend Transport; Tue, 22 Feb 2022 12:48:24 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 12.22.5.235) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 12.22.5.235 as permitted sender) receiver=protection.outlook.com; client-ip=12.22.5.235; helo=mail.nvidia.com; Received: from mail.nvidia.com (12.22.5.235) by CO1NAM11FT032.mail.protection.outlook.com (10.13.174.218) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.4995.15 via Frontend Transport; Tue, 22 Feb 2022 12:48:24 +0000 Received: from rnnvmail205.nvidia.com (10.129.68.10) by DRHQMAIL107.nvidia.com (10.27.9.16) with Microsoft SMTP Server (TLS) id 15.0.1497.18; Tue, 22 Feb 2022 12:48:23 +0000 Received: from rnnvmail203.nvidia.com (10.129.68.9) by rnnvmail205.nvidia.com (10.129.68.10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.9; Tue, 22 Feb 2022 04:48:21 -0800 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.129.68.9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.9 via Frontend Transport; Tue, 22 Feb 2022 04:48:20 -0800 From: Michael Baum <michaelba@nvidia.com> To: <dev@dpdk.org> CC: Matan Azrad <matan@nvidia.com>, Raslan Darawsheh <rasland@nvidia.com>, Viacheslav Ovsiienko <viacheslavo@nvidia.com> Subject: [PATCH 0/5] refactore mlx5 guides Date: Tue, 22 Feb 2022 14:48:10 +0200 Message-ID: <20220222124815.2587851-1-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 84412d44-27de-44dd-910c-08d9f6019d39 X-MS-TrafficTypeDiagnostic: CO6PR12MB5475:EE_ X-Microsoft-Antispam-PRVS: <CO6PR12MB5475EDC6DA7CE62467E61CBACC3B9@CO6PR12MB5475.namprd12.prod.outlook.com> X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 00qP+oCfuxGju9NZUWThJOcrDLhfYn+9znBxKFCpiu+Er/l6rijBwV+VYsvAVoal5xG0aiLRDcejXIXJq8ibR6XaE4h6wlggmwxlv1fWM4WqQwocKwgsavCo9wUkjtB5rBxkjqw0yLYViE6p2JnWjK0q3AJIl4r1HLvg7iUewQi1xwZ3kS+0/NzYB0V33Qcgq7V9Hv1ApsA9Se6JgjGy3Q4d6YJMwam/0hx9Qc5ujF6P37kZcpWrcXJ8sXoP/YZAK9AXP+6qcnPLjOcsdBcVihFdK8utSibeSF7z/WMxBeSwUMXGrfhsb2ZeFD1DSHquUTAhiJnSSh1zLVQGYc5gLCpw/4APmnls5QLGbhr0xCNcSWubt5PAj5PKbMxt/oJfrpI4YlMxqy+X4fgDHWQNf/HseR2dX5mEH37e3VZN8JcMeQsVAlmq1MH9PSlSZahZcBg8gh4WU83ahn3RbGpy03Yfm6qLs7aN0QVqJVwi6Ia70BK9G6s+nFW2AMXIpGBh/blDzIa/kFcnZtEZZOB1dfwYB0Hw3dyUnGqLuLfVX+Y48c1ZdpTxCfSYRJcnsUUUprmVL9ojxqdfLzuublXE+bUplaRcX1AJKPkzruSk2erUqjd6lNmt3lFOsaSdbYkJopZDEevZ2ATw8qVxS5Z+hxS39xbQpAVF+CdO0ny5pjHoOtJ/oB/tmBJL5L5LtB/87dxU41GLmL+xGq6eNvUTnk5+KVrC5GEBfS3QUrv57r9z19kOqy36HyIYOoiiqAYk/+sqiPgjKNWAmY49jtJZX/6ek+uQ1BWBApAkjffO1e4= X-Forefront-Antispam-Report: CIP:12.22.5.235; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:mail.nvidia.com; PTR:InfoNoRecords; CAT:NONE; SFS:(13230001)(4636009)(36840700001)(40470700004)(46966006)(356005)(2906002)(83380400001)(81166007)(2616005)(107886003)(55016003)(186003)(8936002)(36756003)(7696005)(1076003)(26005)(5660300002)(6286002)(47076005)(82310400004)(6916009)(54906003)(316002)(70586007)(70206006)(426003)(36860700001)(86362001)(6666004)(40460700003)(508600001)(8676002)(4326008)(336012)(966005)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Feb 2022 12:48:24.1894 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 84412d44-27de-44dd-910c-08d9f6019d39 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[12.22.5.235]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT032.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR12MB5475 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org |
Message
Michael Baum
Feb. 22, 2022, 12:48 p.m. UTC
Recently [1] all the drivers running over the mlx5 device started sharing some objects. This raised the need to create documentation for the common driver that would contain information relevant to all drivers and in particular: - Tutorial for configuration of the device. - Instruction for using Mellanox ofed. - devargs of the common driver. This series adds such documentation and reference to it as parts of the documentation of the other drivers. [1] https://patchwork.dpdk.org/project/dpdk/cover/20211019205602.3188203-1-michaelba@nvidia.com/ Michael Baum (5): doc: remove obsolete explanations from mlx5 guide doc: replace broken links in mlx5 guide doc: correct name of BlueField-2 in mlx5 guide doc: add shared guide for mlx5 PMDs doc: update doorbell mapping parameter name in mlx5 guide doc/guides/compressdevs/mlx5.rst | 40 +- doc/guides/cryptodevs/mlx5.rst | 38 +- doc/guides/nics/mlx4.rst | 4 +- doc/guides/nics/mlx5.rst | 567 +----------------- doc/guides/platform/index.rst | 1 + doc/guides/platform/mlx5.rst | 641 +++++++++++++++++++++ doc/guides/regexdevs/mlx5.rst | 44 +- doc/guides/vdpadevs/mlx5.rst | 87 +-- drivers/common/mlx5/linux/mlx5_common_os.c | 2 +- drivers/common/mlx5/mlx5_common.c | 31 +- drivers/common/mlx5/mlx5_common_defs.h | 8 +- drivers/net/mlx5/linux/mlx5_verbs.c | 2 +- drivers/net/mlx5/mlx5_devx.c | 2 +- 13 files changed, 747 insertions(+), 720 deletions(-) create mode 100644 doc/guides/platform/mlx5.rst