From: Simon Kagstrom <simon.kagstrom@netinsight.net>
Date: Tue, 20 Oct 2015 13:20:55 +0000 (+0200)
Subject: ethdev: clarify rate limit parameter
X-Git-Tag: spdx-start~8112
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=b375513c118a753c24c7f3d4de288c6914d05099;p=dpdk.git

ethdev: clarify rate limit parameter

The tx_rate unit is Mbps.

Gleaned from the ixgbe implementation, the 82599 datasheet and the use
in test-pmd.

Signed-off-by: Simon Kagstrom <simon.kagstrom@netinsight.net>
---

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index eee11946a1..48a540d3db 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -3122,7 +3122,7 @@ int rte_eth_mirror_rule_reset(uint8_t port_id,
  * @param queue_idx
  *   The queue id.
  * @param tx_rate
- *   The tx rate allocated from the total link speed for this queue.
+ *   The tx rate in Mbps. Allocated from the total port link speed.
  * @return
  *   - (0) if successful.
  *   - (-ENOTSUP) if hardware doesn't support this feature.