From mboxrd@z Thu Jan  1 00:00:00 1970
From: Fiona Trahe <fiona.trahe@intel.com>
Subject: [PATCH v2 30/31] doc/qat: specify QAT driver and device
	name formats
Date: Fri, 11 May 2018 12:14:08 +0100
Message-ID: <1526037249-25545-31-git-send-email-fiona.trahe@intel.com>
References: <1523040732-3290-1-git-send-email-fiona.trahe@intel.com>
Cc: pablo.de.lara.guarch@intel.com, fiona.trahe@intel.com,
 tomaszx.jozwiak@intel.com
To: dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from mga17.intel.com (mga17.intel.com [192.55.52.151])
 by dpdk.org (Postfix) with ESMTP id C06481C624
 for <dev@dpdk.org>; Fri, 11 May 2018 13:16:09 +0200 (CEST)
In-Reply-To: <1523040732-3290-1-git-send-email-fiona.trahe@intel.com>
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>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Document the driver and device naming formats.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/cryptodevs/qat.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 8c8fefaa0..67176bd81 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -359,3 +359,15 @@ length of data to authenticate (op.sym.auth.data.length) must be the length
 of all the items described above, including the padding at the end.
 Also, offset of data to authenticate (op.sym.auth.data.offset)
 must be such that points at the start of the COUNT bytes.
+
+Device and driver naming
+----------------------------------------
+
+The qat crypto driver name is "crypto_qat".
+This name is passed to the dpdk-test-crypto-perf tool in the -devtype parameter.
+The rte_cryptodev_devices_get() can return the devices exposed by a driver.
+
+Each qat crypto device has a unique name, in format
+<pci bdf>_<service>, e.g. "0000:41:01.0_qat_sym".
+This name can be passed to rte_cryptodev_get_dev_id() to get the device_id.
+This is also the format of the slave parameter passed to the crypto scheduler.
-- 
2.13.6