DPDK patches and discussions
 help / color / mirror / Atom feed
From: Billy O'Mahony <billy.o.mahony@intel.com>
To: declan.doherty@intel.com
Cc: dev@dpdk.org, Billy O'Mahony <billy.o.mahony@intel.com>
Subject: [dpdk-dev] [PATCH] comment: Describe how rte_cryptodev_info_get returns capabilities
Date: Tue, 24 Oct 2017 15:53:27 +0100	[thread overview]
Message-ID: <1508856807-29915-1-git-send-email-billy.o.mahony@intel.com> (raw)

Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
---
 lib/librte_cryptodev/rte_cryptodev.h | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index 88aeb87..dd37d77 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -656,6 +656,11 @@ rte_cryptodev_stats_reset(uint8_t dev_id);
  * @param	dev_info	A pointer to a structure of type
  *				*rte_cryptodev_info* to be filled with the
  *				contextual information of the device.
+ *
+ * @note The capabilities field of dev_info is set to point to the first
+ * element of an array of struct rte_cryptodev_capabilities. The element after
+ * the last valid element has it's op field set to
+ * RTE_CRYPTO_OP_TYPE_UNDEFINED.
  */
 extern void
 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info);
-- 
2.7.4

             reply	other threads:[~2017-10-24 14:53 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-24 14:53 Billy O'Mahony [this message]
2017-10-25 16:01 ` Trahe, Fiona
2017-10-25 16:13   ` De Lara Guarch, Pablo

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=1508856807-29915-1-git-send-email-billy.o.mahony@intel.com \
    --to=billy.o.mahony@intel.com \
    --cc=declan.doherty@intel.com \
    --cc=dev@dpdk.org \
    /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).