d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ethdev: improve API comments of close and detach functions

Browse Source 
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 <mukawa@igel.co.jp>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
This commit is contained in:
Tetsuya Mukawa 2015-07-09 17:19:14 +09:00 committed by Thomas Monjalon
parent 27bb9216bb
commit 980995f8cc
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/librte_ether/rte_ethdev.h
View File

@ -1657,6 +1657,8 @@ int rte_eth_dev_attach(const char *devargs, uint8_t *port_id);
/** /**
* Detach a Ethernet device specified by port identifier. * Detach a Ethernet device specified by port identifier.
* This function must be called when the device is in the
* closed state.
* *
* @param port_id * @param port_id
* The port identifier of the device to detach. * 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); 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 * @param port_id
* The port identifier of the Ethernet device. * The port identifier of the Ethernet device.