[dpdk-dev] [PATCH] ethdev: fix documentation for queue start/stop functions

[dpdk-dev] [PATCH] ethdev: fix documentation for queue start/stop functions

[Nikhil P Rao]

From: nikhil.rao@intel.com

Fix documentation for rte_eth_dev_tx/rx_queue_start/stop() functions

Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
---
 lib/librte_ether/rte_ethdev.h | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index 022733e..d72fab9 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -2039,9 +2039,7 @@ int rte_eth_dev_socket_id(uint8_t port_id);
 int rte_eth_dev_is_valid_port(uint8_t port_id);
 
 /*
- * Allocate mbuf from mempool, setup the DMA physical address
- * and then start RX for specified queue of a port. It is used
- * when rx_deferred_start flag of the specified queue is true.
+ * Start specified RX queue of a port.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
@@ -2050,7 +2048,7 @@ int rte_eth_dev_is_valid_port(uint8_t port_id);
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the receive queue is enabled.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2066,7 +2064,7 @@ int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the receive queue is disabled.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2083,7 +2081,7 @@ int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the transmit queue is started
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2099,7 +2097,7 @@ int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the transmit queue is stopped
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
-- 
2.7.4

Re: [dpdk-dev] [PATCH] ethdev: fix documentation for queue start/stop functions

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Nikhil P Rao
> Sent: Tuesday, July 26, 2016 1:37 PM
> To: dev@dpdk.org
> Cc: thomas.monjalon@6wind.com; Rao, Nikhil <nikhil.rao@intel.com>
> Subject: [dpdk-dev] [PATCH] ethdev: fix documentation for queue start/stop
> functions
> 
> From: nikhil.rao@intel.com
> 
> Fix documentation for rte_eth_dev_tx/rx_queue_start/stop() functions

Hi,

Thanks for this. Some comments below.


> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> ---
>  lib/librte_ether/rte_ethdev.h | 12 +++++-------
>  1 file changed, 5 insertions(+), 7 deletions(-)
> 
> diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
> index 022733e..d72fab9 100644
> --- a/lib/librte_ether/rte_ethdev.h
> +++ b/lib/librte_ether/rte_ethdev.h
> @@ -2039,9 +2039,7 @@ int rte_eth_dev_socket_id(uint8_t port_id);  int
> rte_eth_dev_is_valid_port(uint8_t port_id);
> 
>  /*
> - * Allocate mbuf from mempool, setup the DMA physical address
> - * and then start RX for specified queue of a port. It is used
> - * when rx_deferred_start flag of the specified queue is true.
> + * Start specified RX queue of a port.

This change, more or less, reverts the change to this description added in 
commit 3111eae26e2296ec049e6dfc3c0c522d7b9e1c62.

I don't know if "Allocate mbuf from mempool, setup the DMA physical address"
is correct for all pmds so maybe that could be omitted. However, it is 
probably worth keeping the part about the rx_deferred_start flag.



>   *
>   * @param port_id
>   *   The port identifier of the Ethernet device
> @@ -2050,7 +2048,7 @@ int rte_eth_dev_is_valid_port(uint8_t port_id);
>   *   The value must be in the range [0, nb_rx_queue - 1] previously
> supplied
>   *   to rte_eth_dev_configure().
>   * @return
> - *   - 0: Success, the transmit queue is correctly set up.
> + *   - 0: Success, the receive queue is enabled.

+1 to this and the other changes.

John