ethdev: clarify rate limit parameter
authorSimon Kagstrom <simon.kagstrom@netinsight.net>
Tue, 20 Oct 2015 13:20:55 +0000 (15:20 +0200)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Wed, 4 Nov 2015 22:01:12 +0000 (23:01 +0100)
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>
lib/librte_ether/rte_ethdev.h

index eee1194..48a540d 100644 (file)
@@ -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.