From: Billy O'Mahony Date: Tue, 24 Oct 2017 14:53:27 +0000 (+0100) Subject: cryptodev: extend info get function documentation X-Git-Tag: spdx-start~1184 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=e297a47fb365f6970c9fc4c4c981b4ca8dcd11b4;p=dpdk.git cryptodev: extend info get function documentation Extend the Doxygen documentation of rte_cryptodev_info_get, to describe how it returns the capabilities of a device. Signed-off-by: Billy O'Mahony Acked-by: Fiona Trahe --- diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h index 9037534f90..a74d9b92bd 100644 --- a/lib/librte_cryptodev/rte_cryptodev.h +++ b/lib/librte_cryptodev/rte_cryptodev.h @@ -688,6 +688,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);