diff mbox

[dpdk-dev] comment: Describe how rte_cryptodev_info_get returns capabilities

Message ID 1508856807-29915-1-git-send-email-billy.o.mahony@intel.com (mailing list archive)
State Accepted, 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

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

Comments

Fiona Trahe Oct. 25, 2017, 4:01 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Billy O'Mahony
> Sent: Tuesday, October 24, 2017 3:53 PM
> To: Doherty, Declan <declan.doherty@intel.com>
> Cc: dev@dpdk.org; O Mahony, Billy <billy.o.mahony@intel.com>
> Subject: [dpdk-dev] [PATCH] comment: Describe how rte_cryptodev_info_get returns capabilities
> 
> Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
De Lara Guarch, Pablo Oct. 25, 2017, 4:13 p.m. UTC | #2 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Trahe, Fiona
> Sent: Wednesday, October 25, 2017 5:02 PM
> To: O Mahony, Billy <billy.o.mahony@intel.com>; Doherty, Declan
> <declan.doherty@intel.com>
> Cc: dev@dpdk.org; O Mahony, Billy <billy.o.mahony@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] comment: Describe how
> rte_cryptodev_info_get returns capabilities
> 
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Billy O'Mahony
> > Sent: Tuesday, October 24, 2017 3:53 PM
> > To: Doherty, Declan <declan.doherty@intel.com>
> > Cc: dev@dpdk.org; O Mahony, Billy <billy.o.mahony@intel.com>
> > Subject: [dpdk-dev] [PATCH] comment: Describe how
> rte_cryptodev_info_get returns capabilities
> >
> > Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>

Modified to the title to "cryptodev: extend info get function documentation",
and added a small description in the commit message.

Applied to dpdk-next-crypto.
Thanks,

Pablo
diff mbox

Patch

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);