From patchwork Wed Feb 23 13:48:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Baum X-Patchwork-Id: 108174 Return-Path: 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 603D9A034C; Wed, 23 Feb 2022 14:48:47 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C5C7441226; Wed, 23 Feb 2022 14:48:46 +0100 (CET) Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2042.outbound.protection.outlook.com [40.107.223.42]) by mails.dpdk.org (Postfix) with ESMTP id E2E0E411B2 for ; Wed, 23 Feb 2022 14:48:45 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=UGUMR3CmTx2hz7em/dRaUozdKCjHixrrWPqAvLo2lX34bWfiA57XjlWwa4PIYty9UXLzf1/YObCN3cd8PMyz34Y6kwnODbLssY/JlcBNdPk6M6ecuNXNT0a7w7YfhBUQZb5I4ufAs1x23xbTBIvEUdOCWB2VmVwnI5m/pwxwZKcas+/9Vo8M6e60/e4fLbRpPVGhYHr4IrMvcMgpXoVyvyRtsmZ85iwQFZ0gvycjdrR5ICdD8GE1nSF0T7eoDnkbnWSgX/i1//W5kZUYfU/k2ItP6JJ8n7s/Bi4+aPIeXugGYA00VNr2sqpY4wT0TxI41d5l/pHdElnW9ygFn5uPoQ== 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=XE2qp9fcVylcHSZD5V/cmTvhzEnrHrXvIBnAsf6AAcI=; b=CkN9u3/SRr8qng4nL8XZK2zK800AMCtk3o7C+o6qdpb/KKET267Cg8ZCr9k1NtnI12j9y4xRsYBCHvLhqItsGWsAihKniJej0prmqlqSgCR6LQuJW1ez45efiNl786ekVWeUoYi92zsu2EdScRvu0AzT6Kq5GgQ/97QjN3ymwn8xQUwetwM/5oueCk/ycXOw0cEZ5c0sHDgqr8v9yWFZuK7ftW7yJ/L32fbN/yw63uPk1c4hHM6bqac8Wdd78Ty4nbwAaO60M6rUoI7NADDm8z14/Fj0rQGOML62Q8+iE+heL+wpI8OK7Bkkel2K5IkLu1As8vEg0epJekPUe0iArg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 12.22.5.234) 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=XE2qp9fcVylcHSZD5V/cmTvhzEnrHrXvIBnAsf6AAcI=; b=MBKHzbbi0wnRbbR6T6oXPGOLjMG+RZmxy5qxzkQODZY3H6cxGwNLD4PPpHV/+IgdguFROE0sLi15POaX++HLVOc0ggZnFqI8cGhU8hSPjBMR3RQU/aZHbGM0XxjiXOta7cQrERlh3sVf4YWEBTxZMfGjXHFH3fwt7aNtcFDLJe5Vqv5HDJeqxEhwjYXmLYmS4OAdZFPXg8D4i8kxHkvM8sakyGCfrz8JZUMN1Zq6HU+H1UY1sadUzCbAuk8kxwvHq/BFUd664Lk9BX51qo6hIoh0s7qccbf5LImetSBUesMq8gLB5AN1NElfSZt958BOehR+Os37TLjNMRbC+gKi7Q== Received: from CO2PR04CA0189.namprd04.prod.outlook.com (2603:10b6:104:5::19) by SN1PR12MB2575.namprd12.prod.outlook.com (2603:10b6:802:25::14) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4995.16; Wed, 23 Feb 2022 13:48:43 +0000 Received: from CO1NAM11FT068.eop-nam11.prod.protection.outlook.com (2603:10b6:104:5:cafe::8) by CO2PR04CA0189.outlook.office365.com (2603:10b6:104:5::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5017.23 via Frontend Transport; Wed, 23 Feb 2022 13:48:43 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 12.22.5.234) 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.234 as permitted sender) receiver=protection.outlook.com; client-ip=12.22.5.234; helo=mail.nvidia.com; Received: from mail.nvidia.com (12.22.5.234) by CO1NAM11FT068.mail.protection.outlook.com (10.13.175.142) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384) id 15.20.5017.22 via Frontend Transport; Wed, 23 Feb 2022 13:48:42 +0000 Received: from rnnvmail204.nvidia.com (10.129.68.6) by DRHQMAIL101.nvidia.com (10.27.9.10) with Microsoft SMTP Server (TLS) id 15.0.1497.18; Wed, 23 Feb 2022 13:48:42 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by rnnvmail204.nvidia.com (10.129.68.6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.9; Wed, 23 Feb 2022 05:48:40 -0800 Received: from nvidia.com (10.127.8.13) by mail.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.9 via Frontend Transport; Wed, 23 Feb 2022 05:48:39 -0800 From: Michael Baum To: CC: Matan Azrad , Raslan Darawsheh , Viacheslav Ovsiienko Subject: [PATCH v2 0/5] Refactor mlx5 guides Date: Wed, 23 Feb 2022 15:48:29 +0200 Message-ID: <20220223134834.2840916-1-michaelba@nvidia.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220222124815.2587851-1-michaelba@nvidia.com> References: <20220222124815.2587851-1-michaelba@nvidia.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: b27de54a-fce6-42c0-ebae-08d9f6d3349d X-MS-TrafficTypeDiagnostic: SN1PR12MB2575:EE_ X-Microsoft-Antispam-PRVS: X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Kh3agOUnJqNYPSkZsht3OQHJ02MDwmiIKs7YCkm0+Ckx7TnCrgZkwAYBN5E9hbAFWQHVu160F2cMPa2pU5L4GUDtM+wHPqYP7cm36d2ab6SQoUBCXZA26ktDudDKiKyl5phPptjwuTr6yQmAy5L2GsM/yhq8l7F2hiLrM79EIstsxTycMPi6Bfro5WwrN9FiDCSG2dklx2gf+PIY8dZHY92RQR/8VvEMC90C6kfYl/0Qo/X0VU9yHucnfZGgxulsyewPnj6D/T8Kmj5AWhjbqPJci8pYV3iTBcigjlwIEvr4lIItx0LfbhbxDCa3fH58LGo/wUdfaYSoPrrMmALRqZkh8By2i2VBNuwhSxj5BZhC6CSxw5XzBP77KmV76eIaeABzaRpluEKSNfEVp7WCSrWMQgFMQFvIEYY0bjbB30pP6gzl3PNX683BC8+uuPhaRoBSuiCUB1IYA+MPHHKfBeM+TWweE1KmQkxRw9ZyYvwhVYhiSNkwSkHRa8v8cP82ugwlUQoNUz4WyIE6MXBfQv0gB5Qd7qX9OyWm/kGdJUwl2g/o41RE8wYjTP0r7sMva5CmeQZRA19QbWlytiDaxWMC6gg7cYEk8Sa39/TNjzPmm9Ttq1OWeqLEmRwV7vY7Pbv7X8ycjLgrQ+2WGB3ol25IxRdrV/RGsfQw5TkeqSjwjK4PbZVwY8hCk1OSbWHU0LRO8CNtiBnia/uQbtsWBZ/i/bsyE3qF7vRm5XXp52makcasVaC3ZEWm3Lg+Kg7sJwJXHYOus+6Q8qjeIpkbRgcxw8E1x+eU3XG9zzxMK+w= X-Forefront-Antispam-Report: CIP:12.22.5.234; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:mail.nvidia.com; PTR:InfoNoRecords; CAT:NONE; SFS:(13230001)(4636009)(40470700004)(36840700001)(46966006)(36756003)(36860700001)(2616005)(6666004)(47076005)(7696005)(966005)(40460700003)(55016003)(508600001)(107886003)(2906002)(4326008)(6286002)(5660300002)(54906003)(6916009)(8936002)(8676002)(26005)(316002)(356005)(82310400004)(86362001)(426003)(81166007)(186003)(70206006)(70586007)(1076003)(336012)(83380400001)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Feb 2022 13:48:42.9683 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: b27de54a-fce6-42c0-ebae-08d9f6d3349d 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.234]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT068.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN1PR12MB2575 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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/ v2: Rebase 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