From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9F7F6A0547; Thu, 9 Sep 2021 13:16:06 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7262941166; Thu, 9 Sep 2021 13:15:39 +0200 (CEST) Received: from EUR05-VI1-obe.outbound.protection.outlook.com (mail-vi1eur05on2076.outbound.protection.outlook.com [40.107.21.76]) by mails.dpdk.org (Postfix) with ESMTP id 3FB234115E for ; Thu, 9 Sep 2021 13:15:37 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=fXIXA3tJJtjY6lO0ADwk88jkJkkZSRCESci+LSjJFDupkDaV0u3yc5x6xTh4WDLhK07721QLY/Cu/aRcjMb/HBYlsCxUXnCE3ImgiQnvK95/EeJ2EKn2q+zqykB3/wI9XiluNyPNC9o0kD4HXkKvVEEEZpg4GsExZgpVJx7CT/1vMuUoUsf2+Bj2WcOWXB0D8R3rUlJxtZLHkrohMNqbjGg1RwRBgkCE/EYOqPzb/qWpFNHSqoThvwg3J8QkyahyvRybJOz70bg9fo368RMP71/agbmWfzsY9ji1/uyNf3IaGmtAqKAYLezHryMOxjl58ORmT32SpjapFH7O53gUJQ== 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; bh=U9R3q1gF8akbXd2ofNqGD8JMypFncEuqbd57vWX3kNE=; b=dljOm0UAMdVDaYHHBxOo/UNuI2fq7zHpd6Axr6f9EJ3UjGjPakN963D2EFY+6wHkfOGDOwzQtJCggV8eyCum4n2vp92B7eMSHyFK0pQxZIjVdxPHbVuErWvTXGT3JVNcuZOKiaW2UzmMcWns7W7ImZL0x/pCbyRgG+tOdzGEIO446fFzIpmKqqs1fDYY5GAYsyAyIWCYdFTmsPOgtqve7EeCYUt4XuI0G2Id5MSDfO/QsQwb/NKcTqpFY003/eMEgJGZfyjfUmDAY5wKHAEvm8zTVtWUiSbXefnMMwYmcsENQ6MG8XfP+GFUDs2EmZm5KcAgaXb0egNE7shJ8zv4Fg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nxp.com; dmarc=pass action=none header.from=nxp.com; dkim=pass header.d=nxp.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=U9R3q1gF8akbXd2ofNqGD8JMypFncEuqbd57vWX3kNE=; b=k/zIAXIJxnUNGS9JSybR2UznQuqf47yGgQ/bPFC8cDN6IXohYOJxQvkVhyICl1UsDyZ3r5IZFMmXvxFwdL+9Q1LnB4LSB24FXwuDFhC7KbWoHKXttUSX7dGBBven/toYu0j2koHnAlv5q8E8r4nLfshC7zrZRJpZNcuvspVY7IE= Authentication-Results: dpdk.org; dkim=none (message not signed) header.d=none;dpdk.org; dmarc=none action=none header.from=nxp.com; Received: from VI1PR04MB6960.eurprd04.prod.outlook.com (2603:10a6:803:12d::10) by VI1PR04MB5935.eurprd04.prod.outlook.com (2603:10a6:803:e9::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.16; Thu, 9 Sep 2021 11:15:36 +0000 Received: from VI1PR04MB6960.eurprd04.prod.outlook.com ([fe80::d496:fcce:f667:7aa7]) by VI1PR04MB6960.eurprd04.prod.outlook.com ([fe80::d496:fcce:f667:7aa7%8]) with mapi id 15.20.4500.015; Thu, 9 Sep 2021 11:15:36 +0000 From: Gagandeep Singh To: dev@dpdk.org Cc: nipun.gupta@nxp.com, thomas@monjalon.net, Gagandeep Singh Date: Thu, 9 Sep 2021 16:45:00 +0530 Message-Id: <20210909111500.3901706-7-g.singh@nxp.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210909111500.3901706-1-g.singh@nxp.com> References: <20210909111500.3901706-1-g.singh@nxp.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: SG2PR06CA0149.apcprd06.prod.outlook.com (2603:1096:1:1f::27) To VI1PR04MB6960.eurprd04.prod.outlook.com (2603:10a6:803:12d::10) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from lsv03457.swis.in-blr01.nxp.com (14.142.151.118) by SG2PR06CA0149.apcprd06.prod.outlook.com (2603:1096:1:1f::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.14 via Frontend Transport; Thu, 9 Sep 2021 11:15:34 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 0f24a561-1be2-462d-b7ae-08d973832592 X-MS-TrafficTypeDiagnostic: VI1PR04MB5935: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:9508; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: ZE2JR8YizF/Vu0ugFk+ble4BKn+wSeWubF5Zx6b/GyRz0avhzOC5E+xL1ObfD6JfBppdg44dx2HenBsvdSa+ZUHmCQ5xXyeO45SHxhti51dHTnZA7sGTMuwaLg4a9p/OUNgx+0bhv8yYakoeCeLNQ0TLSm+RjsSpWSSz4C0iWk4vJQxP72SWWsVx509fPve88ccbOM/TaBQHa3VcOgoRww2hXy3FwsKub9UmXqFD1RuzsS8QTVcGcVkNv4NeU9dU76aHNsnAmt9liZvaXsab1GM1QAZh564+Br1zWL5UEd58Qkg4fNFmbMqeEB4F4SN9OM5kY6tsI2I6iOWe26vfE8w3GtDoro/VxFUacb7eJT2Q+kpHGlvm+6t4l5bRqurb0VaY0RVR47wEUyIxA2r/ptzBaq2SC586QFC5AKIBVPf/JxEEKVH2C2pVZnFkmAEnfqlZeFd4V9ttt3mVvgiY8J0VHPO2ZgCizClC2nduHrqr0ptaAyhkyoi/+sGmEcix2JJ4BKZozHDNLgvSavfnVot/r1NuZNFJ/eT5TRvnipRuzTnxcMDOO9SydaWgyr1wSzZ2XGYnTkWyRX3B62ueSrEjNzsbnsKqavPsklx/EKBIkOCR9XbbtBl7nhC0uNY/nhlfE+gxz2hJnEBkYKY0bIFjUthFQOy02q69MqvJtmzGh2AwuF1xY8F0oVi33vlqcI35QyrUQNKHVKy6XIM+VEkYViqFqUSZAoUTA6dFR0jqhCbc9XIT9C6WoS5gOcSJgYvcshEbPRvYJCRrZwwStR4KiT79BbyiLZZII6HHB7d8Wqa17i5BehPlV2hqeZxp X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:VI1PR04MB6960.eurprd04.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(39860400002)(136003)(346002)(366004)(376002)(396003)(6916009)(8936002)(38350700002)(1006002)(6666004)(38100700002)(86362001)(5660300002)(26005)(83380400001)(36756003)(55236004)(1076003)(2906002)(66946007)(186003)(7696005)(4326008)(52116002)(66556008)(316002)(6486002)(8676002)(478600001)(66476007)(956004)(2616005)(110426009); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?8Pnwuf+BuFcVG/xr8wVepqN9OPFS178ESPczqhIBbm4/VxPb8nLyLXUKgHVD?= =?us-ascii?Q?CQQJZxHXxbDOqMpoCSyMtXGWwTvWLGgHuz7Pf6kq3+GDe6MdxKHVClaFjuJC?= =?us-ascii?Q?rCKzKLIGNP46Qa7rgpD6AI89iy7gYO92mPlInm8qtHRpERgHzaLbMviSiaHY?= =?us-ascii?Q?XeABsNd9YZXhovA7LTk8pcetutdB2JjOvv3T4ztZJaiIFBCQWcANo8BX1d+y?= =?us-ascii?Q?DnCv/B4x06uKMtHipumWIzoOhMv06vfbF8jlWbSKdH9+XWthM0DTV3x3KaLG?= =?us-ascii?Q?pZxcgrECk+RtufF5pzNZquJXVVcmp4Rz4IWFO3Yw8uKgpHRVNx6V8gInHxHA?= =?us-ascii?Q?h3WbFF0YlrDO/rq22x1JhyKn7mQuz1PA1kt42XRW0jru1y3DPDgC36bA/4zI?= =?us-ascii?Q?TvB61srdS86UPxqbLsLU2m6283PG6Rfpmn0MB9cuqzG1dzFph9DVb+DhZ99D?= =?us-ascii?Q?ZPqR88ptmDvtZEp04rLYcDTuJefd8kd9UNQaSdh9vicZcFvT4HLxbnRIVJbE?= =?us-ascii?Q?5/VSBvO4f9TM3lD//gAhGFYNeFc2ov3NBT3uqXScNaQfdATblmcnpykldnru?= =?us-ascii?Q?oCxdvi1UWH3gHpuxbzXWaZFBOTcYCNc62E8uJOihhh4V3QpQ2Sn2b4xuKZew?= =?us-ascii?Q?aeO4bHZq3eAeptd/URqT7RadJ6jKyP4u2Ow7ugxVTvQQdwPQWMi4WBW2AoZC?= =?us-ascii?Q?fdm+Bwk02lNhppaseJjNiVwpRI6dBO5rV4c4BNMV7RA0XgLjJcnnyT0fQw3D?= =?us-ascii?Q?ToVcstIiuxD6F/0UKYnqxOWiTii9cp6gYPAfe7H4ZGyIRda1FSVThQFdUucm?= =?us-ascii?Q?PlCDKey/+Ks+9XentEPUgozbjYdALdCE3/cUE8jqzqUMFQ43DfvTpUm77fhJ?= =?us-ascii?Q?/vjHn5ezCVOvo41veyF+ZcQ1gaOM1fkYVFSfICqEAsdNVybUPLNPBh6d8fn9?= =?us-ascii?Q?JmVKKWF1zrp7Ao5uTAeXBsx9HQJKZHyRz9KUMHbr6cf4QCp1u7POmhhCM1oz?= =?us-ascii?Q?o78qgnEv40nt8F9eeRwpeAzS8lKZwXKtqBr9PJodNTHFxBSFCCheEcm9lDHl?= =?us-ascii?Q?FInJGRCwKKn0oqW2IjnLVWVO7QG/3HEfX0mGl3nqvfUKfWdTcOoAOcO7xyES?= =?us-ascii?Q?nkT7Fumn1vaDEarxiuhwhQfH4SViW0cWqd0douoXkQN6vDa5yFrniWzFwuqS?= =?us-ascii?Q?+38+snvVk6vReqVoEB7A/R2dvHMuJEY/6ImNgZSnayEiK7Q0/ddema3pitY5?= =?us-ascii?Q?5as+A1oy0qgE00SB4qbiOxWvIAqxj84++NtO6uhPnZr5bx3I6NX1gqaXAtNq?= =?us-ascii?Q?HJ1RXeR9rtaEI7PSsjMqEjJ9?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 0f24a561-1be2-462d-b7ae-08d973832592 X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB6960.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Sep 2021 11:15:36.2209 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: x58GURKTF6FkUPAiQ+Bfi+xpXyor6KAiUPGcC9vC1qmiVsQj7ZjzACCSSxzPuww7 X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB5935 Subject: [dpdk-dev] [PATCH 6/6] doc: add user guide of DPAA DMA driver 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 Sender: "dev" This patch adds DPAA DMA user guide. Signed-off-by: Gagandeep Singh --- MAINTAINERS | 1 + doc/guides/dmadevs/dpaa.rst | 60 +++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+) create mode 100644 doc/guides/dmadevs/dpaa.rst diff --git a/MAINTAINERS b/MAINTAINERS index e3113b2e7e..0a131ede7c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1349,6 +1349,7 @@ NXP DPAA DMA M: Gagandeep Singh M: Nipun Gupta F: drivers/dma/dpaa/ +F: doc/guides/dmadevs/dpaa.rst Packet processing diff --git a/doc/guides/dmadevs/dpaa.rst b/doc/guides/dmadevs/dpaa.rst new file mode 100644 index 0000000000..ed9628ed79 --- /dev/null +++ b/doc/guides/dmadevs/dpaa.rst @@ -0,0 +1,60 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2021 NXP + +NXP DPAA DMA Driver +===================== + +The DPAA DMA is an implementation of the dmadev APIs, that provide means +to initiate a DMA transaction from CPU. The initiated DMA is performed +without CPU being involved in the actual DMA transaction. This is achieved +via using the QDMA controller of DPAA SoC. + +The QDMA controller transfers blocks of data between one source and one +destination. The blocks of data transferred can be represented in memory +as contiguous or noncontiguous using scatter/gather table(s). + +More information can be found at `NXP Official Website +`_. + +Features +-------- + +The DPAA DMA implements following features in the dmadev API: + +- Supports 1 virtual channel. +- Supports all 4 DMA transfers: MEM_TO_MEM, MEM_TO_DEV, + DEV_TO_MEM, DEV_TO_DEV. +- Supports DMA silent mode. +- Supports issuing DMA of data within memory without hogging CPU while + performing DMA operation. + +Supported DPAA SoCs +-------------------- + +- LS1046A +- LS1043A + +Prerequisites +------------- + +See :doc:`../platform/dpaa` for setup information + +- Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. + +.. note:: + + Some part of dpaa bus code (qbman and fman - library) routines are + dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace. + +Initialization +-------------- + +On EAL initialization, DPAA DMA devices will be detected on DPAA bus and +will be probed and populated into their device list. + + +Platform Requirement +~~~~~~~~~~~~~~~~~~~~ + +DPAA DMA driver for DPDK can only work on NXP SoCs as listed in the +``Supported DPAA SoCs``. -- 2.25.1