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 F1816A0C57; Mon, 1 Nov 2021 09:52:56 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 615DB41148; Mon, 1 Nov 2021 09:52:21 +0100 (CET) Received: from EUR03-VE1-obe.outbound.protection.outlook.com (mail-eopbgr50050.outbound.protection.outlook.com [40.107.5.50]) by mails.dpdk.org (Postfix) with ESMTP id 3930A4113B for ; Mon, 1 Nov 2021 09:52:20 +0100 (CET) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=IXG0KliH+c0bPrqK92oXGA1LOFbi19DdlkixfopNdr614/DqWLXu8sPWAcE1MhUsFnfLrzwovNFN5eqJTAqg+4mdEuc2G3laO+JOIfvBE7ub7bjn0JTOHCx+kN1eW/5Lu6M3+vQocP8O1lYXzRyH17fxg7kVy9dW0fWyWKXoyVpUsIJyUz4my32OyJevyIJRG/oWNGdt5dYxCjVBSjEtlohNH8MoEgewqmqQZrrSm8hEPH2VEMslH9S+ksHo0/XxBUKUEhNFH3q2pfYvV2cKzz91kLFgpZvosleOLf9ZFX28FRaDvHtHqf1qcxocGq8U3bknuiL8B5NedsUED+40BA== 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=frk79SDm5jzBtXccftDJNY4kHBfI0NiCoUlO5TRbiasiBvZBaXLtBX7uM2JMsMrHBZHsHpLiB2B9sgLFIYPYAGZDnkunn5dm1paCJH4+3KzrxBftv3AqyvGDFnEJ6xtP5v4c1UoOm2be4QUMrlgWZXY3mrf/XRv9ww/Xpb10jYemDF6ktnhMzKZCWxflcmp4Qa2m7G3D9YP/ppAUq6gX+Yd9xqSh8XGZka+qdEdZ6TvgpXXzcEXqnODYa9xlZ+Z3XuMRSoD0ns8joBWpUSogg0tflWkvNBE/l+eNmAHCVVhqcYu5f/lfXT14359efBESMhmysvFLKTFo35+Ux088Fw== 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=a9unE9EqNk6qAxFV7MBns5T07vKXVudF1ZYJJzvGN7l5nD1h3uImNaLSsajvwP9F0sdVdSfEANZil4z3QeMQyM2Bmorob89wielhFtYrfYrlR7f3aBWeJzxT0aKETQAYSDc2wxDUwhRENh0ExSk02Zq0hbBlQWTzzt7tYRSnibg= 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 VI1PR04MB5086.eurprd04.prod.outlook.com (2603:10a6:803:62::31) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4649.15; Mon, 1 Nov 2021 08:52:19 +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.4649.019; Mon, 1 Nov 2021 08:52:19 +0000 From: Gagandeep Singh To: thomas@monjalon.net, dev@dpdk.org Cc: nipun.gupta@nxp.com, Gagandeep Singh Date: Mon, 1 Nov 2021 14:21:43 +0530 Message-Id: <20211101085143.2472241-7-g.singh@nxp.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211101085143.2472241-1-g.singh@nxp.com> References: <20210909111500.3901706-1-g.singh@nxp.com> <20211101085143.2472241-1-g.singh@nxp.com> Content-Transfer-Encoding: 8bit Content-Type: text/plain X-ClientProxiedBy: SG2PR02CA0092.apcprd02.prod.outlook.com (2603:1096:4:90::32) 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 SG2PR02CA0092.apcprd02.prod.outlook.com (2603:1096:4:90::32) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4649.15 via Frontend Transport; Mon, 1 Nov 2021 08:52:17 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: a8f13674-9179-40d3-2f78-08d99d14e95f X-MS-TrafficTypeDiagnostic: VI1PR04MB5086: 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: zhkw80BJvoE9h5PBYgX53iJHzl2RMYxhw+VCEHJ6j5VfyCUcReM49NaunoIpWIrUsGeHydrbZv11Ze4fujT0yMgLUsx2DUAQo+V/ftzhg1HaRLqj4m+HsHnu9vso5Xo8yrKnONn9c4Ep7Q0d3EZ3xfQJzwKIvyFu0zma13mPjw1zBGfDO5QGyEeWFjYiG5NJYLmBY8TsS/Z+Nk+GtnBcyisrntCQ4gY2/fe4uChmLIcXiOusRm9jkikgCZvdYWpxL7Jt0AG7VXb2UUMYoIbyVQgN/fhYieUeTneJlrNwNXhRH1NqAH/8OMcw1idgIJ3Y29o+dRpj7FMKjOqMB5X/LTCC6ABNzLn5LPTMZl0WJuj7y/nq5o/EbThWKaUxDdgNtKm0QKcMiyvDRYL0G0OOyAEBuJSD5GPIN35Zo/LFrWEgQk0ViPyCX8wazG6MnCe+M+YET0ZFKojrb71z4/Y8z0IejjVw58/2sEZ0PK79ikDSYhxCFun9uJPRLRebW6Dl1pDD8e+FuL3ARF8K1BjKngBv8qwzZSMaqTWbA7k6VtRMV+3tNE2/XuxMOCQma1kGZ2U5dgJeR6OpmodJI09win0EhynxCpYeJUFrg6m0ttFZv8bC5Bg7t05h90d/yG5R9IBGoG02ILo+Q0hJrV/tJeAK+SDYoQOXm14Hf0GRLaN5jEPgNcg8TyebjQwp6YP5GiV7P1eqyRuB1h+bU913Popenth/4h30Gaf+rsipmxpJ9RMZ8QOzTH4DOZNWyotWPDeBWKj5/4YsUgnCFmzI+jQV7PVtl7RA33pPS0EMjdwQE3ojgOd58/xyE+qqZ67o 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)(38350700002)(38100700002)(55236004)(6486002)(6666004)(186003)(1006002)(4326008)(5660300002)(316002)(956004)(2616005)(86362001)(66556008)(7696005)(66476007)(26005)(36756003)(52116002)(8936002)(2906002)(66946007)(8676002)(83380400001)(508600001)(1076003)(110426009); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?jKNXTP43LieyJd5JJBKANP6FEpD1hMkZIukUy/hlBmL0sbbFsoT0DAhVkp/f?= =?us-ascii?Q?DptSxThmnmMU4XgIGMLNaNqwi8ZWl7YR1xwQb6o4JzIc+NvsQINjtQn/LmYn?= =?us-ascii?Q?AqKGoIJfGgs8MxPLGnVQPV6pwKQQAyv/70hofDlkYytZM0dE9dnGJOaA/yPx?= =?us-ascii?Q?GOCgSxk2j79tvte1mScTFvA6gFlxK9QaQcigCU7p0tb7iAIz6tQTG2PI7u4I?= =?us-ascii?Q?mJftd99goo5CSLX0owQg3NC1OdhdrZVw7pFKnZtEuCmkKcInIHyObTEyU8R4?= =?us-ascii?Q?kdp64ShazUXOKwnnhtL5PSmmEk+SB8FbERf3pfxh/jNEI3ZmKMXXtYZ7XOJ+?= =?us-ascii?Q?VodBnMw4szWzC2tPdIeNtQmot5Uak8o+SIssQVKcZeqgyeWtaS03qnHRcjoT?= =?us-ascii?Q?NyoLWCdqC33juitUh++QfMZnH0ybUtGh7MAEqjAI80AJuS70evb95lIZNRxz?= =?us-ascii?Q?RFxdP7coOay03SnXmL04DSrcsTxVvOsjktrqkA67F5LgN9LW0SeBRknLTtLZ?= =?us-ascii?Q?yfRqqzqg4IR1d5y8NZyCPQHNU+zNrDT38sBdn4G8dZ3n4rABf4YhkC1SvpEe?= =?us-ascii?Q?dUC+GhalU52vP7p13YTk2jXZp8mhzHRSGkGm8WeSvZ9K8k5AnKTzDNV+c6Bb?= =?us-ascii?Q?0upYXfhkGi7jCA39kZTtWhU+NLBD6tvCPx7HIzrXJpWGJtKTvo8Don89WSZa?= =?us-ascii?Q?X2V0GvNz7X8s5MPfDX8QyRxBxUykOsdJP04miUitkWcQtQyTnyhthnwkiHET?= =?us-ascii?Q?FHvJ07QivhflPQ/KFTqwaamvNRrVeb1VnsHU6DxNxPCmSujDFw8vK9ts9Syh?= =?us-ascii?Q?Kxg85XRsxMDrux959ZU2+FxaDJpJPrNPRfyK9vggZ+vFMYc1sNt4uLR4g/eM?= =?us-ascii?Q?DW3DZcBe8kZF5M+SOOpuugvAsDlQ6T//Hb+F2xlEIGy5Kmwd5kreHqxccRvP?= =?us-ascii?Q?F5V0bxgqlkO6Uosypqt74njJ5mKe0fBGAWo4sDTcGlp7Ds3gDpHiG6lmpRRM?= =?us-ascii?Q?RuSZdVTbQtWxl5z/hWacq8hqdpOpodjg39ryzE9BJptrzsNx09T94pnPiPOs?= =?us-ascii?Q?aLe/OEC2kTBpVdvGTKX7/z4nzqW/r0rqVPU0LbDllu/xiwsXIAiYNxwhda3b?= =?us-ascii?Q?CnRiRtFPducodwA6nwaxGb5JadLmHBlREiO3Mf8igkcSJvA/XTQA1tHuTNNq?= =?us-ascii?Q?D3ow0E4+8t/m/fmEJg1/KvA5fJxH+QBmV/xx3dL8KHbbn8N+zOxUPRdhhNm1?= =?us-ascii?Q?MQPCtydsu8HL5vYwNb5YKeREJJSbXbfnUOzhDVyl7mpD7E7pfbIWm8vMOYyG?= =?us-ascii?Q?czlOwU8Ydny4Qbz8U2SXsbm5JFgTzY6QSwBm4gkhmVX/LdatZCpJeHYEguF8?= =?us-ascii?Q?UCrkeY2f1drw/SQfjpNMQIOvEyAV0MvCmAPqJ6BhWjpeKi5uJjdUIZP2oMhW?= =?us-ascii?Q?ge6KVe/HawQYUEeYudh5LG1e1Qu205p8Xmg6hCZRanICvvLndcAvclpMB1Qg?= =?us-ascii?Q?OVJ/fM12L37QzVRxyU4/KC/WkVdaS4OYGL9wc+lOlSL/N6AuoR0k/l57L1VW?= =?us-ascii?Q?UtPugc0CeqjGZq4mRIg=3D?= X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-Network-Message-Id: a8f13674-9179-40d3-2f78-08d99d14e95f X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB6960.eurprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 Nov 2021 08:52:19.3018 (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: y898+diydRf3cyqpUV5MdPE0rwCrvXccsCy6PSfpCX7NEvh31siU0VJtJU3c7an5 X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR04MB5086 Subject: [dpdk-dev] [PATCH v2 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 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