From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <nipun.gupta@nxp.com>
Received: from EUR01-VE1-obe.outbound.protection.outlook.com
(mail-ve1eur01on0050.outbound.protection.outlook.com [104.47.1.50])
by dpdk.org (Postfix) with ESMTP id B03424C95
for <dev@dpdk.org>; Tue, 1 May 2018 11:59:37 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version;
bh=UvGKjwlYADUYj6y/WJjlzqBHj3XvnPs187K+wRVatic=;
b=QVucTjd9pa0N2ijnLEkWOnF8BObWoEUSBW9cwtyaYlIP5MoRPVow0aj6xgJ3QMBHoapAZtMrIt5jzn5DBPNN6yZZu8cmglUj0eZ3QmzxISb0+UCsnPHnqC+RthkZ/OJw7HGjgkcUnmRgxBFMXk9+jEt22anEtvyzy9lCTPX2Wkg=
Authentication-Results: spf=none (sender IP is )
smtp.mailfrom=nipun.gupta@nxp.com;
Received: from b27504-OptiPlex-790.ap.freescale.net (14.142.187.166) by
HE1PR0401MB2427.eurprd04.prod.outlook.com (2603:10a6:3:25::24) with Microsoft
SMTP Server (version=TLS1_2,
cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.715.23; Tue, 1
May 2018 09:59:35 +0000
From: Nipun Gupta <nipun.gupta@nxp.com>
To: shreyansh.jain@nxp.com,
thomas@monjalon.net,
hemant.agrawal@nxp.com
Cc: dev@dpdk.org,
Nipun Gupta <nipun.gupta@nxp.com>
Date: Tue, 1 May 2018 15:28:51 +0530
Message-Id: <1525168731-30912-9-git-send-email-nipun.gupta@nxp.com>
X-Mailer: git-send-email 1.9.1
In-Reply-To: <1525168731-30912-1-git-send-email-nipun.gupta@nxp.com>
References: <1524570589-20148-1-git-send-email-nipun.gupta@nxp.com>
<1525168731-30912-1-git-send-email-nipun.gupta@nxp.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-Originating-IP: [14.142.187.166]
X-ClientProxiedBy: PN1PR0101CA0028.INDPRD01.PROD.OUTLOOK.COM
(2603:1096:c00:c::14) To HE1PR0401MB2427.eurprd04.prod.outlook.com
(2603:10a6:3:25::24)
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-HT: Tenant
X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0;
RULEID:(7020095)(4652020)(48565401081)(5600026)(2017052603328)(7153060)(7193020);
SRVR:HE1PR0401MB2427;
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0401MB2427;
3:BLFFTkuvrOlafubDSOPtTRdK04ASvwRMpqnZ2pPIgi/7iwQMZWxSfVbYUu3l7cFfdaOwMwXWqWXgVEKRAgehNr+rTS6dufk8fg0UWDEs2yrxLp2AFElR7PndYBXNc2QSD7ILuKOkAW7kBQZipvAGAaVUKf/AqZ3iGpyvwijcgBWF46hVUGcJkhDbJhvEw6zWNe0UDxWBn69n1ZrCywXtthE47BfG8DF3sTvw+plrOHdiewKnYyLP7ypZWXdIv9AE;
25:Hr9ivaE15E+v/WFNDoYM2p7gfSTLWrEAKlW7O9W/ppqu1+y9O+aqfShRGJabKaiBECVzgW0AWWnX2w51PSIZqdC8UpDosNtIRJIHEYTrP5pzShVA0G6Uk0vxKPM2mIDhx/VKg7EgIrQn8SlIO+JCpzH/0UQZcxRGwQk+fykCxvkoseI2SMnWWnOj+ZZkkmg4PZOuYsXv178VbTuMY0e9DQoFP+khFIK2UREM4vQYzCf3jcU227XI20QMHwHl2GEmKTFiLCmqQ6pwNUaeLJ7T8w5WoziVWPf6aoHRyCEekGcDNJzItkF6QrkGBS668rJDkCNr1ZNjXmWeZ0HoJHnouA==;
31:FfDLIZwcv+l+rcXI98FQbu/hTGZGMpRoaQAS9iko19H4TXiuKN/OuDqFu9W+glaqvRpFMqhMG9IHuM6ZtB+8h7Gvra6EgDVRscCKTQB/q8NJW+gXkEFwk4ckzXoCMumFpcbRT1gkdBFIgmS/NEN3AAqRjRjVpBZ2Px1kPXEwsz7XBzCY59tZPcqxex9t+jiS/z+v7jEAUDqI48EJGKMRluv3659so3a0RJezaeNeBJ8=
X-MS-TrafficTypeDiagnostic: HE1PR0401MB2427:
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0401MB2427;
20:QAjCYZ6pHnOJgT8w3oc+VypBlngKhNsH4bKNUmOEYHgqsVVGLt/pTLR/JNSy02WNRyldtWezPbyqAg5pIdpF3iDE+o762fSOdqu8z8Ce3219sbh0fmnHVaT8VjYe5ifCTqp8aswLpNjlLTmxaqMUHWcHYycwcPvTg/PF+4hKpwFZveBYckd9svnT9RIdKaRdkBynvU5GTFSZtCGQDzkaggdGe28CV+GQ2BIc7BVVwU3DarzMhaIT7dETwM3SB35i69SnYBhRk6vit6C++BnbGPZRbvnOv2HSsi/8EvYiNRNp/B/GBh0n51aXzXsq4VrWHKi6RBh55XEQhCREPEl0cZBJulnn7CcGxSkDlNPIF5T6WdQRh9XJZHrgaHVeGUQZN8MVKd7Ju56efoiPlexlM+VafU/p5IkNqmAwjUhe4TyoO8KGJJg3JEDkkAlAaVL9h2c6oFenBWcARr9XlbbOxVXGFzPqRyuhbAc/ZAOw4AnMFNHHoRbANNe4aQH+2i0G;
4:l4vbuKRFdnBvfXrQVdPLGNhz+J1/RQT9UaEqQTWAUcSnMEaUpqFiSTCEfv4XjcUErVgUf9rJA8CGT8CqD8dUUuqi4qrGSl7cbwbLmhAmRzQn/0wff83G8Jp9fzpygwP56ZxqswYnIbIFgrAUmHpShHhtxosU7B9XsWhD5y75tFlDIO1nd9Ybb3oF3B6F8yETkhPpNNSODUkCmGF1DwC/yQOM2dZtUFpbnPcQsFsxgRALDYczlGLSYm68CBXrA4iF9JQKLfWLdzq1GadO5BRLXwZxE1jDjy4MiOLrlVXmM9FO/9ubTG3ShAsd5DrgiPX7RIMJJkqdd8E3TVnDNl/GlBNu2XqdStiNqEgSJi4SJ8nLQhqj0imBFLCaX+8RdWKS
X-Microsoft-Antispam-PRVS: <HE1PR0401MB2427C6B7B5921AF13DB3AEBAE6810@HE1PR0401MB2427.eurprd04.prod.outlook.com>
X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(185117386973197)(264314650089876);
X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0;
RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3231254)(944501410)(52105095)(10201501046)(3002001)(93006095)(93001095)(6055026)(6041310)(20161123562045)(20161123564045)(20161123558120)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011);
SRVR:HE1PR0401MB2427; BCL:0; PCL:0; RULEID:; SRVR:HE1PR0401MB2427;
X-Forefront-PRVS: 06592CCE58
X-Forefront-Antispam-Report: SFV:NSPM;
SFS:(10009020)(39380400002)(39860400002)(366004)(396003)(346002)(376002)(199004)(189003)(81156014)(3846002)(8936002)(97736004)(50226002)(81166006)(316002)(50466002)(2906002)(551934003)(36756003)(44832011)(2870700001)(478600001)(5660300001)(8676002)(6116002)(486006)(16526019)(6512007)(53936002)(6306002)(476003)(4326008)(446003)(956004)(11346002)(386003)(5009440100003)(76176011)(23676004)(52116002)(26005)(305945005)(68736007)(6506007)(105586002)(106356001)(47776003)(6636002)(66066001)(7736002)(86362001)(6666003)(25786009)(6486002)(2616005)(110426005);
DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR0401MB2427;
H:b27504-OptiPlex-790.ap.freescale.net; FPR:; SPF:None; LANG:en;
PTR:InfoNoRecords; A:1; MX:1;
Received-SPF: None (protection.outlook.com: nxp.com does not designate
permitted sender hosts)
X-Microsoft-Exchange-Diagnostics: =?utf-8?B?MTtIRTFQUjA0MDFNQjI0Mjc7MjM6QUhxY0FZbG5OaExuNUIwNkdmTUVwZGNk?=
=?utf-8?B?NHYrQm40Y255QVdtWEtRV3ZQVzdkTEVUQ1duOWh6d1c3VjdOZDlveERrZElF?=
=?utf-8?B?dmpTczQxa2JhUTI5SEt3alI1RytaZkExVTdjQU5WYVpzOTVNKzFYVUlxWnVs?=
=?utf-8?B?cDNyVmNCZFpqcm5Va25RVHpQczRZZVprK1pTNHQ0WUNBaCtWeTZNWFZaL3RI?=
=?utf-8?B?NzRPQ3JCREhhMXdJbjRmdk82cWVGa0gyaEFZeXZsTG0xSjRnUExGK01pMWV4?=
=?utf-8?B?ZWprWHRoS25mZ2hPbW1HNThGVGNBN1JCRXdzUUlScUc0SWMyT1BNNGFhQUxJ?=
=?utf-8?B?TWZUQUd2RUMvS0c5ZWpQZEZlMTdvT1FYTkRtMnljbEx1KzZ0cnBNOEtqUk5X?=
=?utf-8?B?bXJnNHBYbXpZL1dsSGFkamd1blpZSklsbGhpOUNvRFdVbXRkNW1hOWJuL0pu?=
=?utf-8?B?alEwTmhyc0ZxVDV2dC9QMGZabitPVzdmRjBsVkpWODNHNFd6Tmw4Wjh4dDVH?=
=?utf-8?B?QTdDVTRqcGNJT2xhblpKWTFXekdldTVic0dncGc3Y1ROOGNrNG1YdldQUGlh?=
=?utf-8?B?bXdhR0V4WFY0UzJFWWJYWkNQaGRlMDlVMUZvdkMzcE5rZk5yY1ptNVRvVmFj?=
=?utf-8?B?K25VaUd5RDZIWFJUUTEzVnIrMFJRT0tDZnZUcldEM2lyN0NjVWg4LzhoY2Za?=
=?utf-8?B?SXpHdUhINTJnL3ZSTTFnaHB4Vlg5K1pEMXlGaDNKMFlYSVJuL1lxQkxwS3Nj?=
=?utf-8?B?NUZVekhURTNqdHhsei9tK2xESXlzYjBna3hhWXp5Wm94LzIyaGFYTGxWMGpO?=
=?utf-8?B?eWFzWThsVjhZYlRLallpMnQ3a3BWWEYvbGJLRGs4TFlYM1ZOaWZ6SlRia2xS?=
=?utf-8?B?RDdZb2V3eFdSK01RQ0R3dWFRUzVTMGFIRTlDdi9zYmNDUUR5OUpJR0tIakFU?=
=?utf-8?B?Q3dsMkNIbVlpbVVOSzc1Um1vNC92cHFaUEpOV3FGanlYbGJYSmFIeG1qTHlE?=
=?utf-8?B?ZStOU0xmTEhkSjlhSDRSMXkzVXp2ZlVCSlJYT3F2RHo1RW5XV3c2UHA2OFky?=
=?utf-8?B?TEo4SW5GMXlEY3h1K2c3MytEMTNrZm1kYncwYlhaeUxrck9lOTNaVllWNXdH?=
=?utf-8?B?ZVB0KzVDQVB3cXFCMHhSZ0NnTGZqWFdWUWJXczNQN0FnVmRiVkV5VURLcU1x?=
=?utf-8?B?aGJlM1JxWXR0YnRsK2YyejA4SUFTZ1JLUGhRc2EyZzFVQzUwTzN4Q0lKVURR?=
=?utf-8?B?UVJ5Y3lVVXRQUXhtYXlKdE0yNnZiNWJVU1JiOXZQMERMbi9yaEd4ZU54UGpk?=
=?utf-8?B?RDRXSWY4YjY4ejhqMFBVY0JZS1RVdEtwN3JYVFdQT1dDdE5aZ1lmMWVGNXpH?=
=?utf-8?B?bU9jcUIwaHUwclVHUHQ4c3h5NFkzblV1eWlSc0hEWldaWjUvN2xTd2NzSjdw?=
=?utf-8?B?djRUbHR1cEFDcFFMbUNQVFhMbDhnczUzWDBHWnpJNmx0Y0xBUTJoM2tMcDRi?=
=?utf-8?B?S0FOSTVqUjlxZEJZYlBxRmpDUjVzWC9UZTU3UGRJek90Z1RJaXVXc2ZndCtp?=
=?utf-8?B?SFJrRzZjUEVkMkI0dFd5M05ZNDM5bW4xcWxkMDBKTUtsTlpVbnBOUkdiaUh1?=
=?utf-8?B?QjZoaU5DcVhTY1RpUFVqMWg5WTRqTU5oaEJvVDNHSnJNR3hWRXhNbUMrcXVY?=
=?utf-8?Q?J7gJNn/9CfuR/PlcAD0XB+mxH5ZTiD+YAitXQmOq5?=
X-Microsoft-Antispam-Message-Info: j4Z2Mt7G1Ufe3qsO5oDF3+9bonGbWgrlx6uIKs3XvY2BtF3Husjuli3vWmY+aSvflWn3lbifTQqcZmLEs+fHFqMxB5QJy2hI62DvAdGOHEacGQ1ZslbFAIUbJPrmrhMflIJvawY+hzqVtHK8aMA/Y5457+gejxoMcIgar8ASCuwhZoWktET/CY0M0V0F2RlX
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0401MB2427;
6:boca1iiHM7F30kdWVh1FF4E8wAija3V0yaSgQmXsOBiURZKUhyYo5VH7P/bIA1FNLc4Pc+EyHJ/o+f6643+v7K6WtKCQd8YbJazajnQ2IWNtXUSEYFuk4TB/bPG+szqNJM8+q1JsFwI//NFE9QJU4Q/ziRiJOrHQdu357im88Bcmga91JoBaYjNyPRg/S4LZRo0Z1VWBQARYbOS7XCkf2V/l8VqEipyh0LQNyrHazcOkEuaIPMnY3gJASD7z6h95lJdggdnKyhMDHPk/Woxfsa6C+GBsAksLhfTfrpeLS5jjq5qAsv0Fzw+RnRMfI/hTFA+ZazBrG/unxIFVNWX54nMDGYfh2Tb78g3XVt3m/j1GtDbnoeaOuhzXzZVxk2yZTqUxTaDhSc9yYxdNY6d/hrhmAtlScXPdLmPqQagckNfMmifG9PhyoAzHhc6jNeAjp7UePBPk/rL3ED645TuCYg==;
5:2r7xQaerfQol8b/AlO7ZzaxQgrlp/0cMC0vypMtuYtXxj1/3lmE6lJcy1B13o3WrQIH2bVE3+OgvWhqONZrmn9e2Ds3nq89l6B7SBZ6Gr+zJkSF23IEmuEkExzvL5hex/SKG562ceaF3QCUoe+w44jKoly4UEnOdTs33yMH3oCc=;
24:iZaQjF/U9Hs+8IAXZSBZ4CNW3JW1bdzX/U7+s1trJj7scil+4OrmSBmnZFq6+vepN5eyn1j5SErlZytHlsdTAj21G58ETKsJxcmykwmyTUo=
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-Microsoft-Exchange-Diagnostics: 1; HE1PR0401MB2427;
7:NLk7xrEYfe0qlItQWpHswH68jweXhE/gzuyIg6+0o9SNH4nhZtv3jprQsGPO9E6zxYnNY3VktvFvCvX0tPrrsHpmoujQdfn6m7ktWeTBed/3Gb25Ca4cP4g/oAdcCdWqKlVIS3mkyolG41iOoSLLMgGo4WdPrqtgleVkm/BEb78IAoq6xEAkut5cEqaTyL1YPVTMj8vLUHeG96IzJSfdY+rqMyBhYW8c3ZYkdw6fLasGc5W0whqigHNmB4v4WXyo
X-MS-Office365-Filtering-Correlation-Id: 094446da-138b-4786-2501-08d5af4a3f1a
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 01 May 2018 09:59:35.2193 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 094446da-138b-4786-2501-08d5af4a3f1a
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0401MB2427
Subject: [dpdk-dev] [PATCH v5 8/8] doc: add DPAA2 QDMA rawdev guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 01 May 2018 09:59:38 -0000
Signed-off-by: Nipun Gupta <nipun.gupta@nxp.com>
---
MAINTAINERS | 1 +
doc/guides/index.rst | 1 +
doc/guides/rawdevs/dpaa2_qdma.rst | 140 +++++++++++++++++++++++++++++++++
doc/guides/rawdevs/index.rst | 14 ++++
doc/guides/rel_notes/release_18_05.rst | 8 ++
5 files changed, 164 insertions(+)
create mode 100644 doc/guides/rawdevs/dpaa2_qdma.rst
create mode 100644 doc/guides/rawdevs/index.rst
diff --git a/MAINTAINERS b/MAINTAINERS
index 5ca021d..3fc4a2c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -811,6 +811,7 @@ Rawdev Drivers
NXP DPAA2 QDMA
M: Nipun Gupta <nipun.gupta@nxp.com>
F: drivers/raw/dpaa2_qdma/
+F: doc/guides/rawdevs/dpaa2_qdma.rst
Eventdev Drivers
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index d60529d..a93baac 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -20,6 +20,7 @@ DPDK documentation
eventdevs/index
mempool/index
platform/index
+ rawdevs/index
contributing/index
rel_notes/index
faq/index
diff --git a/doc/guides/rawdevs/dpaa2_qdma.rst b/doc/guides/rawdevs/dpaa2_qdma.rst
new file mode 100644
index 0000000..b9bc4ec
--- /dev/null
+++ b/doc/guides/rawdevs/dpaa2_qdma.rst
@@ -0,0 +1,140 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 NXP
+
+NXP DPAA2 QDMA Driver
+=====================
+
+The DPAA2 QDMA is an implementation of the rawdev API, 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 DPDMAI device exposed by MC.
+
+More information can be found at `NXP Official Website
+<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_.
+
+Features
+--------
+
+The DPAA2 QDMA implements following features in the rawdev API;
+
+- Supports issuing DMA of data within memory without hogging CPU while
+ performing DMA operation.
+- Supports configuring to optionally get status of the DMA translation on
+ per DMA operation basis.
+
+Supported DPAA2 SoCs
+--------------------
+
+- LS2084A/LS2044A
+- LS2088A/LS2048A
+- LS1088A/LS1048A
+
+Prerequisites
+-------------
+
+There are three main pre-requisities for executing DPAA2 QDMA on a DPAA2
+compatible board:
+
+1. **ARM 64 Tool Chain**
+
+ For example, the `*aarch64* Linaro Toolchain <https://releases.linaro.org/components/toolchain/binaries/6.3-2017.02/aarch64-linux-gnu>`_.
+
+2. **Linux Kernel**
+
+ It can be obtained from `NXP's Github hosting <https://github.com/qoriq-open-source/linux>`_.
+
+3. **Rootfile system**
+
+ Any *aarch64* supporting filesystem can be used. For example,
+ Ubuntu 15.10 (Wily) or 16.04 LTS (Xenial) userland which can be obtained
+ from `here <http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.1-base-arm64.tar.gz>`_.
+
+As an alternative method, DPAA2 QDMA can also be executed using images provided
+as part of SDK from NXP. The SDK includes all the above prerequisites necessary
+to bring up a DPAA2 board.
+
+The following dependencies are not part of DPDK and must be installed
+separately:
+
+- **NXP Linux SDK**
+
+ NXP Linux software development kit (SDK) includes support for family
+ of QorIQ® ARM-Architecture-based system on chip (SoC) processors
+ and corresponding boards.
+
+ It includes the Linux board support packages (BSPs) for NXP SoCs,
+ a fully operational tool chain, kernel and board specific modules.
+
+ SDK and related information can be obtained from: `NXP QorIQ SDK <http://www.nxp.com/products/software-and-tools/run-time-software/linux-sdk/linux-sdk-for-qoriq-processors:SDKLINUX>`_.
+
+- **DPDK Extra Scripts**
+
+ DPAA2 based resources can be configured easily with the help of ready scripts
+ as provided in the DPDK Extra repository.
+
+ `DPDK Extras Scripts <https://github.com/qoriq-open-source/dpdk-extras>`_.
+
+Currently supported by DPDK:
+
+- NXP LSDK **17.12+**.
+- MC Firmware version **10.3.0** and higher.
+- Supported architectures: **arm64 LE**.
+
+- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
+
+.. note::
+
+ Some part of fslmc bus code (mc flib - object library) routines are
+ dual licensed (BSD & GPLv2).
+
+Pre-Installation Configuration
+------------------------------
+
+Config File Options
+~~~~~~~~~~~~~~~~~~~
+
+The following options can be modified in the ``config`` file.
+
+- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_QDMA_RAWDEV`` (default ``y``)
+
+ Toggle compilation of the ``lrte_pmd_dpaa2_qdma`` driver.
+
+Enabling logs
+-------------
+
+For enabling logs, use the following EAL parameter:
+
+.. code-block:: console
+
+ ./your_qdma_application <EAL args> --log-level=pmd.raw.dpaa2.qdma,<level>
+
+Using ``pmd.raw.dpaa2.qdma`` as log matching criteria, all Event PMD logs can be
+enabled which are lower than logging ``level``.
+
+Driver Compilation
+~~~~~~~~~~~~~~~~~~
+
+To compile the DPAA2 QDMA PMD for Linux arm64 gcc target, run the
+following ``make`` command:
+
+.. code-block:: console
+
+ cd <DPDK-source-directory>
+ make config T=arm64-dpaa2-linuxapp-gcc install
+
+Initialization
+--------------
+
+The DPAA2 QDMA is exposed as a vdev device which consists of dpdmai devices.
+On EAL initialization, dpdmai devices will be probed and populated into the
+rawdevices. The rawdev ID of the device can be obtained using
+
+* Invoking ``rte_rawdev_get_dev_id("dpdmai.x")`` from the application
+ where x is the object ID of the DPDMAI object created by MC. Use can
+ use this index for further rawdev function calls.
+
+Platform Requirement
+~~~~~~~~~~~~~~~~~~~~
+
+DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the
+``Supported DPAA2 SoCs``.
diff --git a/doc/guides/rawdevs/index.rst b/doc/guides/rawdevs/index.rst
new file mode 100644
index 0000000..29b4f6c
--- /dev/null
+++ b/doc/guides/rawdevs/index.rst
@@ -0,0 +1,14 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 NXP
+
+Rawdev Drivers
+==============
+
+The following are a list of raw device PMDs, which can be used from an
+application through rawdev API.
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ dpaa2_qdma
diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
index 0ae61e8..22fa74d 100644
--- a/doc/guides/rel_notes/release_18_05.rst
+++ b/doc/guides/rel_notes/release_18_05.rst
@@ -164,6 +164,14 @@ New Features
stats/xstats on shared memory from secondary process, and also pdump packets on
those virtual devices.
+* **Added DPAA2 QDMA Driver (in rawdev).**
+
+ The DPAA2 QDMA is an implementation of the rawdev API, that provide means
+ to initiate a DMA transaction from CPU. The initiated DMA is performed
+ without CPU being involved in the actual DMA transaction.
+
+ See the :doc:`../rawdevs/dpaa2_qdma` guide for more details.
+
API Changes
-----------
--
1.9.1