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 D7FEAA0C4B; Mon, 8 Nov 2021 10:08:19 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7237D41156; Mon, 8 Nov 2021 10:07:46 +0100 (CET) Received: from EUR03-AM5-obe.outbound.protection.outlook.com (mail-eopbgr30042.outbound.protection.outlook.com [40.107.3.42]) by mails.dpdk.org (Postfix) with ESMTP id 356AD41149 for ; Mon, 8 Nov 2021 10:07:42 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=E88gJLlqVzafPFlTgM912ibrJLb5P3c4ktDH+mpYH+e5UWfaJJMahn3tibO30avjokVmHb3mP4vXEgtrLs6owb2LZWQ2RFTx1a4umySkL1AsifBoF6K3fV/yrTYtdm1kd0f7SCK0EJPZvoxdmZjUgXFPX0Jdi+/r0wErNOMa54Wgq5aXoa3miuab6MRphsQAkaiSsuaYhIRQ5WLZW/7raxC77IXk0UPMj+Ar4LSDtPDXpHLJQ+bgkWOYllxc8OJGnvfJJtEmc4P2mDUEBY2eI3izBfUbMtTB0AVKCg5p+RGa/2EMUqKK6450LDQswE6nyFSu2sYGhty72hjBM5JZaQ== 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=Xhju688NWIaEJaXIj/E5HzIPdvLSpA3Eme26xi3Dj7M=; b=Kd4p15KZ9rh1ZASbX5bbBjGTzB/jAC0flJElFW01w37RMiwaDSToXy4+98g2Cpkbi99LmlE9W+luqnCqyKw1uf5jr4AWT8jg0lW77vV6r4P82EjWm10WBA7TQP3DMA62OR7GpgJ2E3qWy+ihyt9D8nazqfITg5CLPOScsiNJDQwFOPuOK5v9xWj+rt4w/okhL5mn7Nn7PzmTAT3rIsFNeFCN8GeqnhtOTSxhH/L4tUblZMjOyIywXqtNb6kZ720eVn7KHfeZyUviBBmqvB4+zIoKEbygomwbQLwtLTVu+gQtyDYqmMFHX0PqPysQyBenZb4P6HUS/tuYMod3LWrQOg== 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=Xhju688NWIaEJaXIj/E5HzIPdvLSpA3Eme26xi3Dj7M=; b=Rb9vTRNExYmCTvubGAJd33S9ZZqXqsb6N3Zsetsdej0RnEHWDizHjjoBXzj4wLiwpEVrBZqPk+c/hBWTRzGlPBfE/EMkeWE+nJBMdap/kSTstlNSihA/t5FXxXGsAWCLLnTHTnRcxv7qrrtkvdjRoik9hDkE0SbaAFkonGWciWo= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=nxp.com; Received: from VI1PR04MB6960.eurprd04.prod.outlook.com (2603:10a6:803:12d::10) by VI1PR0401MB2366.eurprd04.prod.outlook.com (2603:10a6:800:2b::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.13; Mon, 8 Nov 2021 09:07:41 +0000 Received: from VI1PR04MB6960.eurprd04.prod.outlook.com ([fe80::11d9:6f32:90e:80c1]) by VI1PR04MB6960.eurprd04.prod.outlook.com ([fe80::11d9:6f32:90e:80c1%7]) with mapi id 15.20.4669.016; Mon, 8 Nov 2021 09:07:41 +0000 From: Gagandeep Singh To: dev@dpdk.org Cc: nipun.gupta@nxp.com, thomas@monjalon.net, Gagandeep Singh Date: Mon, 8 Nov 2021 14:37:04 +0530 Message-Id: <20211108090704.3585175-8-g.singh@nxp.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211108090704.3585175-1-g.singh@nxp.com> References: <20211101085143.2472241-2-g.singh@nxp.com> <20211108090704.3585175-1-g.singh@nxp.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: SG2PR02CA0077.apcprd02.prod.outlook.com (2603:1096:4:90::17) To VI1PR04MB6960.eurprd04.prod.outlook.com (2603:10a6:803:12d::10) MIME-Version: 1.0 Received: from lsv03457.swis.in-blr01.nxp.com (14.142.151.118) by SG2PR02CA0077.apcprd02.prod.outlook.com (2603:1096:4:90::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4669.11 via Frontend Transport; Mon, 8 Nov 2021 09:07:39 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 570446d3-59ea-4377-324f-08d9a29737e1 X-MS-TrafficTypeDiagnostic: VI1PR0401MB2366: 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: 8fBQjf+JIN0JEhaOqoW3mBUPq2z69824I2x3851VdZuCj4KNR2q0fTORpKD/cW231+M7nAU37Hm/3Tw3Nnb2Ukkd6IIdz8cRQce/jVfC1f2oZXCBwGiREoX6h/s/XBJgZMuA6sYyDeBEMhjvPofbelzxlFJa8eTHNYl1hLLjzn/bKg2+rhC6nkE8x1hRljnh6Gh3UY4QEOVTW14NfPVd9mGUvqo2IjuezXrY8eddLnD0vIbpVJsQ+eYdhIIRZx5HalyvtY+Nj9LOoKLuEHVqqO6RwIXNtwTnnLu/BgIuagNfresqdFMXj1/bTTB1VPBGqbX+dYwD6E6msemYjE9vlGiUnE6AmnKs1QwQH4bCnHUcyV0Q4A4GR4ydt81pu6X9mNlTWj9UnibrIrtfoxMqKNqmX+YK7LVRX5qhzIUbHxPwMc9QqSR+em9wAd0vxqL2QBhMIzX4NQJiRrM9UiN9ox07ZQ/0qlaNcLFhN+q5gevSHYU5YwIsdLwO3C7eCwTDXmtjHBgQpymcyAdBcn8/Tb/XCH5RqInv0EeseaVMHtU5x8sj7xUKIljoBapVv5Ho91nwVIS0p1UR9BAZqXNVR8WfJQn1dVuQIyd225jR+DafzvWkbnC2gY5HbUR4/E62ci+VKMxXER//3hvdiUy3k9dKetp1x4C7ra1nbwKaEnObltxtvAadt3qcCntOwiAKvlBlDZHDqnY/CxxA//bb6V/4ZQfAj8mVu/RCkgIWsou9MSUk3nJBq7MqFTYgnD+O1q1TEnSGjseXkGtN9SzzvnC40MgMijK6n3WZSJjpGuHeDxu7ztmmfdtnaHYeGdjv 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)(366004)(6666004)(52116002)(6486002)(1006002)(5660300002)(316002)(8936002)(55236004)(4326008)(7696005)(8676002)(66556008)(38350700002)(66476007)(66946007)(86362001)(38100700002)(508600001)(1076003)(6916009)(2906002)(956004)(2616005)(36756003)(83380400001)(186003)(26005)(110426009); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?H++sVtqbSm2e3jfeeF49D7KZaESZzxG4o/zU/wOz2omgTdHt2yH4/2iZ6M/D?= =?us-ascii?Q?52YXhDwNsFq8k+F+YkHD7SiwsMcxzR9MMZQ0BPeyFZ1ovW2dMfKStJi19Mln?= =?us-ascii?Q?eG9BbACFpDG+o645xpW3X8R0ITFsLGrxR31qgw1YQuv+3/tx7wzj5vBx4Kqb?= =?us-ascii?Q?kwDlNZ3RxxV60sbZ9RZqx502nZrts+2Hlj3HUawZCs5cqPvNQH4WufseCVDc?= =?us-ascii?Q?K1GlaKGrbXA2caatoasHRDVmFTDjyfdPkndXndePmvgXARBRFNPCoeATSU7T?= =?us-ascii?Q?TkMOPOvI2MbS+u0jASHYgCLPeDyOiUohm/iM0g59nS4tEMM5cybbgV4Ds5vl?= =?us-ascii?Q?DHj33pg7D12BJLJ0lTsQ71ol/m1oQHzdwCUpJbJinNhts+U48X5Bqup87e1P?= =?us-ascii?Q?BqjfQtm+X4IO543WhmSW7jSOvmiXsCsBzL3jctY3RdVQYsMLeCbzYB0pbytV?= =?us-ascii?Q?drZ3QKNpdIGmEF6RMg/A4EIfSAtyyKGJVrd3wZAEdr2xNw1ZAvA6/DIgAtgi?= =?us-ascii?Q?CtmZMk+uppGjyzuDrkVqm42KyRnwN3BgnsL7MlgOXLdD0piSb/HZcPr4LvCW?= =?us-ascii?Q?icmti7+VMSjZTai5dJ2RJduxAbym9gYlRAHHX8PG4A9f7jljmiat39lefGdb?= =?us-ascii?Q?HknHlYdwdGjNNqzBXvC5nGAXq6UHszEXLkS8PWwnWMqXSrVOhaqSg1EFVqiB?= =?us-ascii?Q?gjgQatn2C4rHH0StKwwctGzKGwGsuprWyGhx7pWJMVNX3wp4HZvRFwc+dRfE?= =?us-ascii?Q?GwaZZZsCtoVQWwlbU0SvXn6WivHOojiiFF9uw8l8aZvNckKsXl2T1UyhNKiB?= =?us-ascii?Q?SQpbtQIPFR/GXlACKX21INN6SZHI/tiA143KecaKuXTq3vHraBnmnaXoDFui?= =?us-ascii?Q?sbwyrqdV+MZEr6Gj7u8tM0S5EjqrqTzHACZcvh8BxWFrjNAvCBDExc4SsoeW?= =?us-ascii?Q?Kzzz/FxgeqGNsfSEgKZL7VYfJdcBaMtZuIM9VEejNBJqdym1WIwX3+y3XeM2?= =?us-ascii?Q?jtt7AAzEVf1wOFEq0jCsSmRi1hEbUZM1lToY4fFCO4j3dSs0WJ55BnlA8pcO?= =?us-ascii?Q?1lRszShAkloByJHAdvU+P7TIy9XHvz1Oo+IP4Gi59Rn4KmHSMIzKN35q9BSN?= =?us-ascii?Q?/AXt8c0D9uEM1d+tmz5hvG2hLcpQRSDU05cF5vfzw1ogN+1mKGEwHcTzl8KT?= =?us-ascii?Q?rexGdMiykqTknznQGPnYpLO/Jrlz8r/z/9wcoyL7icBtZv8gfQT5eT72sj/u?= =?us-ascii?Q?N7iJBVyn3poG45R+4sk596ryyPla+urmDkylrEf6UNE9Pc8f47+J0g9hJu56?= =?us-ascii?Q?nnHhRB+fH6pfhLd7+67xf8VwniEzTkcxEwQz3m15m+Jp9IsGGsvJ7H+nEbHs?= =?us-ascii?Q?n0TXJ2Fg8c6PzSOfo8NsKXLvfeMKojbY57PyZznNquK7honoi6/PeO5rtiwq?= =?us-ascii?Q?CRCrpR7yzBH0l6WDLGhD/DF/QGNj0aoUAG8hbtrs902G54UEkCOONxZJFLZc?= =?us-ascii?Q?nu9enPGiHeV3F9sEAU1mxMp60hmDiv/gbZXdY5AOrBO7r5wxrOBG7XHZP2Aw?= =?us-ascii?Q?AJDAJ71zUhcgkNykbt0=3D?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: 570446d3-59ea-4377-324f-08d9a29737e1 X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB6960.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Nov 2021 09:07:41.3979 (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: uu74l53z9TzXrqO3ljMVBrII5/il7dltCnfZmxapzXIV6ASq+hQfcU6U5rHgw7QL X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR0401MB2366 Subject: [dpdk-dev] [PATCH v3 7/7] 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 76b9fb8e6c..a5ad16e309 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1361,6 +1361,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