Commit 15d23b4c authored by Jacob Keller's avatar Jacob Keller Committed by Jeff Kirsher

i40e: comment that udp_port must be in host byte order

The firmware expects the port number passed when setting up
the UDP tunnel configuration to be in Little Endian format.
The i40e_aq_add_udp_tunnel command byte swaps the value from
host order to Little Endian.

Since commit fe0b0cd9 ("i40e: send correct port number to
AdminQ when enabling UDP tunnels") we've correctly
sent the value in host order.

Let's also add a comment to the function explaining that it must
be in host order, as the port numbers are commonly stored as Big
Endian values.
Signed-off-by: default avatarJacob Keller <jacob.e.keller@intel.com>
Tested-by: default avatarAndrew Bowers <andrewx.bowers@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent 59e331e3
...@@ -3614,11 +3614,15 @@ i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw, ...@@ -3614,11 +3614,15 @@ i40e_status i40e_aq_get_cee_dcb_config(struct i40e_hw *hw,
/** /**
* i40e_aq_add_udp_tunnel * i40e_aq_add_udp_tunnel
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @udp_port: the UDP port to add * @udp_port: the UDP port to add in Host byte order
* @header_len: length of the tunneling header length in DWords * @header_len: length of the tunneling header length in DWords
* @protocol_index: protocol index type * @protocol_index: protocol index type
* @filter_index: pointer to filter index * @filter_index: pointer to filter index
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
*
* Note: Firmware expects the udp_port value to be in Little Endian format,
* and this function will call cpu_to_le16 to convert from Host byte order to
* Little Endian order.
**/ **/
i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw, i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
u16 udp_port, u8 protocol_index, u16 udp_port, u8 protocol_index,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment