diff mbox

[dpdk-dev,v2,30/31] doc/qat: specify QAT driver and device name formats

Message ID 1526037249-25545-31-git-send-email-fiona.trahe@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Fiona Trahe May 11, 2018, 11:14 a.m. UTC 
  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(+)

Comments

Kovacevic, Marko May 14, 2018, 3:38 p.m. UTC | #1 
> 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
> +----------------------------------------

Try to keep the underscores aligned for the heading doesn't affect the build but for consistency 

> +The qat crypto driver name is "crypto_qat".
> +This name is passed to the dpdk-test-crypto-perf tool in the -devtype
> parameter.

``-devtype``

> +The rte_cryptodev_devices_get() can return the devices exposed by a
> driver.

Try  putting rte_cryptodev_devices_get() like this --> ``rte_cryptodev_devices_get()``

> +Each qat crypto device has a unique name, in format <pci
> +bdf>_<service>, e.g. "0000:41:01.0_qat_sym".

And these two  ``<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 also ``rte_cryptodev_get_dev_id()``

> +This is also the format of the slave parameter passed to the crypto scheduler.

Marko K.
diff mbox

Patch

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.