From 980995f8cc56d560dba0c6229e50bec430c092d7 Mon Sep 17 00:00:00 2001 From: Tetsuya Mukawa Date: Thu, 9 Jul 2015 17:19:14 +0900 Subject: [PATCH] ethdev: improve API comments of close and detach functions The patch fixes doxygen comments of below functions. - rte_eth_dev_close() Add description about when the function can be called and also about what kind of resources will be freed. - rte_eth_dev_detach() Add description about when the function can be called. Signed-off-by: Tetsuya Mukawa Acked-by: Thomas Monjalon --- lib/librte_ether/rte_ethdev.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 79bde899bf..ec4a882ea8 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -1657,6 +1657,8 @@ int rte_eth_dev_attach(const char *devargs, uint8_t *port_id); /** * Detach a Ethernet device specified by port identifier. + * This function must be called when the device is in the + * closed state. * * @param port_id * The port identifier of the device to detach. @@ -2010,7 +2012,9 @@ extern int rte_eth_dev_set_link_up(uint8_t port_id); extern int rte_eth_dev_set_link_down(uint8_t port_id); /** - * Close an Ethernet device. The device cannot be restarted! + * Close a stopped Ethernet device. The device cannot be restarted! + * The function frees all resources except for needed by the + * closed state. To free these resources, call rte_eth_dev_detach(). * * @param port_id * The port identifier of the Ethernet device.