[dpdk-dev] ethdev: add missing doxygen

Message ID 1516362154-4097-1-git-send-email-radu.nicolau@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

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

Commit Message

Radu Nicolau Jan. 19, 2018, 11:42 a.m. UTC
  Added missing doxygen for rte_eth_dev_get_sec_ctx
and moved the declaration to the proper place.

Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---
 lib/librte_ether/rte_ethdev.h | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)
  

Comments

Ferruh Yigit Jan. 19, 2018, 8:10 p.m. UTC | #1
On 1/19/2018 11:42 AM, Radu Nicolau wrote:
> Added missing doxygen for rte_eth_dev_get_sec_ctx
> and moved the declaration to the proper place.
> 
> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Ferruh Yigit Jan. 19, 2018, 8:11 p.m. UTC | #2
On 1/19/2018 8:10 PM, Ferruh Yigit wrote:
> On 1/19/2018 11:42 AM, Radu Nicolau wrote:
>> Added missing doxygen for rte_eth_dev_get_sec_ctx
>> and moved the declaration to the proper place.
>>
>> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.
  

Patch

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index a5ba564..f5053c2 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -1721,9 +1721,6 @@  struct rte_eth_dev {
 	void *security_ctx; /**< Context for security ops */
 } __rte_cache_aligned;
 
-void *
-rte_eth_dev_get_sec_ctx(uint8_t port_id);
-
 struct rte_eth_dev_sriov {
 	uint8_t active;               /**< SRIOV is active with 16, 32 or 64 pools */
 	uint8_t nb_q_per_pool;        /**< rx queue number per pool */
@@ -4582,6 +4579,20 @@  int rte_eth_dev_adjust_nb_rx_tx_desc(uint16_t port_id,
 int
 rte_eth_dev_pool_ops_supported(uint16_t port_id, const char *pool);
 
+
+/**
+ * Get the security context for the Ethernet device.
+ *
+ * @param port_id
+ *   Port identifier of the Ethernet device
+ * @return
+ *   - NULL on error.
+ *   - pointer to security context on success.
+ */
+void *
+rte_eth_dev_get_sec_ctx(uint8_t port_id);
+
+
 #ifdef __cplusplus
 }
 #endif