DPDK patches and discussions
 help / color / mirror / Atom feed
From: Fiona Trahe <fiona.trahe@intel.com>
To: dev@dpdk.org, pablo.de.lara.guarch@intel.com,
	tomaszx.jozwiak@intel.com, thomas@monjalon.net
Cc: fiona.trahe@intel.com
Subject: [dpdk-dev] [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes
Date: Fri, 10 Aug 2018 15:10:50 +0100	[thread overview]
Message-ID: <1533910253-29652-4-git-send-email-fiona.trahe@intel.com> (raw)
In-Reply-To: <1533833430-29134-8-git-send-email-fiona.trahe@intel.com>

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

diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index 7df49ca44..17b313c9d 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -72,17 +72,18 @@ Extra notes on KASUMI F9
 ------------------------
 
 When using KASUMI F9 authentication algorithm, the input buffer must be
-constructed according to the 3GPP KASUMI specifications (section 4.4, page 13):
-`<http://cryptome.org/3gpp/35201-900.pdf>`_.
-Input buffer has to have COUNT (4 bytes), FRESH (4 bytes), MESSAGE and DIRECTION (1 bit)
-concatenated. After the DIRECTION bit, a single '1' bit is appended, followed by
-between 0 and 7 '0' bits, so that the total length of the buffer is multiple of 8 bits.
-Note that the actual message can be any length, specified in bits.
+constructed according to the
+`3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
+(section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
+FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
+bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
+the total length of the buffer is multiple of 8 bits. Note that the actual
+message can be any length, specified in bits.
 
 Once this buffer is passed this way, when creating the crypto operation,
-length of data to authenticate (op.sym.auth.data.length) must be the length
+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)
+Also, offset of data to authenticate "op.sym.auth.data.offset"
 must be such that points at the start of the COUNT bytes.
 
 
@@ -142,19 +143,19 @@ Device and driver naming
 ------------------------
 
 * The qat cryptodev driver name is "crypto_qat".
-  The rte_cryptodev_devices_get() returns the devices exposed by this driver.
+  The "rte_cryptodev_devices_get()" returns the devices exposed by this 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.
+  "<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.
 
 .. Note::
 
-	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the -devtype parameter.
+	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
 
 	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
 
-* The qat compressdev driver name is "comp_qat".
+* The qat compressdev driver name is "qat".
   The rte_compressdev_devices_get() returns the devices exposed by this driver.
 
 * Each qat compression device has a unique name, in format
@@ -166,7 +167,7 @@ Available kernel drivers
 ------------------------
 
 Kernel drivers for each device are listed in the following table. Scroll right
-to check that the driver and device supports the servic you require.
+to check that the driver and device supports the service you require.
 
 
 .. _table_qat_pmds_drivers:
-- 
2.13.6

  parent reply	other threads:[~2018-08-10 14:11 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-09 13:17 [dpdk-dev] [PATCH] doc/qat: clarify build config options Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 0/8] " Fiona Trahe
2018-08-09 17:08   ` De Lara Guarch, Pablo
2018-08-09 19:49   ` Thomas Monjalon
2018-08-10  7:57     ` Trahe, Fiona
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 1/8] doc/qat: add limitations to compressdev PMD Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 2/8] doc/qat: add information on how to test Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 3/8] doc/qat: fix typos and make cosmetic changes Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 4/8] doc/qat: add overview of doc sections Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 5/8] doc/qat: remove unnecessary text Fiona Trahe
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 6/8] doc/qat: update kernel dependency section Fiona Trahe
2018-08-09 19:36   ` Thomas Monjalon
2018-08-10  7:45     ` Trahe, Fiona
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2 7/8] doc/qat: update PMD build section Fiona Trahe
2018-08-09 19:47   ` Thomas Monjalon
2018-08-10  7:51     ` Trahe, Fiona
2018-08-10  9:00       ` Thomas Monjalon
2018-08-10 13:14         ` Trahe, Fiona
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 0/6] doc/qat: clarify build config options Fiona Trahe
2018-08-13 14:51     ` Jozwiak, TomaszX
2018-08-23 11:12     ` Akhil Goyal
2018-08-23 11:24       ` Thomas Monjalon
2018-08-23 11:28         ` Akhil Goyal
2018-08-23 11:35           ` Thomas Monjalon
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 1/6] doc/qat: add limitations to compressdev PMD Fiona Trahe
2018-08-13 14:31     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 2/6] doc/qat: add information on how to test Fiona Trahe
2018-08-13 14:32     ` Jozwiak, TomaszX
2018-08-10 14:10   ` Fiona Trahe [this message]
2018-08-13 14:33     ` [dpdk-dev] [PATCH v3 3/6] doc/qat: fix typos and make cosmetic changes Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 4/6] doc/qat: add overview of doc sections Fiona Trahe
2018-08-13 14:37     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 5/6] doc/qat: update build instructions for both PMDs Fiona Trahe
2018-08-13 14:37     ` Jozwiak, TomaszX
2018-08-10 14:10   ` [dpdk-dev] [PATCH v3 6/6] doc/qat: describe build config options Fiona Trahe
2018-08-13 14:38     ` Jozwiak, TomaszX
2018-08-09 16:50 ` [dpdk-dev] [PATCH v2] " Fiona Trahe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1533910253-29652-4-git-send-email-fiona.trahe@intel.com \
    --to=fiona.trahe@intel.com \
    --cc=dev@dpdk.org \
    --cc=pablo.de.lara.guarch@intel.com \
    --cc=thomas@monjalon.net \
    --cc=tomaszx.jozwiak@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).