net/i40e: add more explanation for QoS APIs

According to HW implementation, the bandwidth of QoS
means the L2 bandwidth, not count the bytes added by
physical layer.

Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>

diff --git a/drivers/net/i40e/rte_pmd_i40e.h b/drivers/net/i40e/rte_pmd_i40e.h
index 8e15630..22a5c64 100644 (file)
--- a/drivers/net/i40e/rte_pmd_i40e.h
+++ b/drivers/net/i40e/rte_pmd_i40e.h
@@ -386,6 +386,9 @@ int rte_pmd_i40e_reset_vf_stats(uint8_t port,
  *    ID specifying VF.
  * @param bw
  *    Bandwidth for this VF.
+ *    The value should be an absolute bandwidth in Mbps.
+ *    The bandwidth is a L2 bandwidth counting the bytes of ethernet packets.
+ *    Not count the bytes added by physical layer.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.
@@ -433,6 +436,9 @@ int rte_pmd_i40e_set_vf_tc_bw_alloc(uint8_t port,
  *    Number specifying TC.
  * @param bw
  *    Max bandwidth for this TC.
+ *    The value should be an absolute bandwidth in Mbps.
+ *    The bandwidth is a L2 bandwidth counting the bytes of ethernet packets.
+ *    Not count the bytes added by physical layer.
  * @return
  *   - (0) if successful.
  *   - (-ENODEV) if *port* invalid.