Commit 98d44381 authored by Jeff Kirsher's avatar Jeff Kirsher

i40e: Cleanup Doxygen warnings

These changes make Doxygen/kdoc work correctly without warnings.

Change-ID: I2941f38860be805ff7548d84dae35754c83f1d62
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: default avatarJesse Brandeburg <jesse.brandeburg@intel.com>
Tested-by: default avatarKavindya Deegala <kavindya.s.deegala@intel.com>
parent 885552a2
...@@ -626,7 +626,7 @@ i40e_status i40e_shutdown_adminq(struct i40e_hw *hw) ...@@ -626,7 +626,7 @@ i40e_status i40e_shutdown_adminq(struct i40e_hw *hw)
/** /**
* i40e_clean_asq - cleans Admin send queue * i40e_clean_asq - cleans Admin send queue
* @asq: pointer to the adminq send ring * @hw: pointer to the hardware structure
* *
* returns the number of free desc * returns the number of free desc
**/ **/
......
...@@ -74,7 +74,8 @@ static i40e_status i40e_set_mac_type(struct i40e_hw *hw) ...@@ -74,7 +74,8 @@ static i40e_status i40e_set_mac_type(struct i40e_hw *hw)
/** /**
* i40e_debug_aq * i40e_debug_aq
* @hw: debug mask related to admin queue * @hw: debug mask related to admin queue
* @cap: pointer to adminq command descriptor * @mask: debug mask
* @desc: pointer to admin queue descriptor
* @buffer: pointer to command buffer * @buffer: pointer to command buffer
* *
* Dumps debug log about adminq command with descriptor contents. * Dumps debug log about adminq command with descriptor contents.
...@@ -629,7 +630,7 @@ i40e_status i40e_aq_get_link_info(struct i40e_hw *hw, ...@@ -629,7 +630,7 @@ i40e_status i40e_aq_get_link_info(struct i40e_hw *hw,
/** /**
* i40e_aq_add_vsi * i40e_aq_add_vsi
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @vsi: pointer to a vsi context struct * @vsi_ctx: pointer to a vsi context struct
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
* *
* Add a VSI context to the hardware. * Add a VSI context to the hardware.
...@@ -776,7 +777,7 @@ i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw, ...@@ -776,7 +777,7 @@ i40e_status i40e_aq_set_vsi_broadcast(struct i40e_hw *hw,
/** /**
* i40e_get_vsi_params - get VSI configuration info * i40e_get_vsi_params - get VSI configuration info
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @vsi: pointer to a vsi context struct * @vsi_ctx: pointer to a vsi context struct
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
**/ **/
i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw, i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw,
...@@ -818,7 +819,7 @@ i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw, ...@@ -818,7 +819,7 @@ i40e_status i40e_aq_get_vsi_params(struct i40e_hw *hw,
/** /**
* i40e_aq_update_vsi_params * i40e_aq_update_vsi_params
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @vsi: pointer to a vsi context struct * @vsi_ctx: pointer to a vsi context struct
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
* *
* Update a VSI context. * Update a VSI context.
...@@ -921,7 +922,6 @@ i40e_status i40e_aq_get_firmware_version(struct i40e_hw *hw, ...@@ -921,7 +922,6 @@ i40e_status i40e_aq_get_firmware_version(struct i40e_hw *hw,
/** /**
* i40e_aq_send_driver_version * i40e_aq_send_driver_version
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @event: driver event: driver ok, start or stop
* @dv: driver's major, minor version * @dv: driver's major, minor version
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
* *
...@@ -1039,10 +1039,10 @@ i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid, ...@@ -1039,10 +1039,10 @@ i40e_status i40e_aq_add_veb(struct i40e_hw *hw, u16 uplink_seid,
* @hw: pointer to the hw struct * @hw: pointer to the hw struct
* @veb_seid: the SEID of the VEB to query * @veb_seid: the SEID of the VEB to query
* @switch_id: the uplink switch id * @switch_id: the uplink switch id
* @floating_veb: set to true if the VEB is floating * @floating: set to true if the VEB is floating
* @statistic_index: index of the stats counter block for this VEB * @statistic_index: index of the stats counter block for this VEB
* @vebs_used: number of VEB's used by function * @vebs_used: number of VEB's used by function
* @vebs_unallocated: total VEB's not reserved by any function * @vebs_free: total VEB's not reserved by any function
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
* *
* This retrieves the parameters for a particular VEB, specified by * This retrieves the parameters for a particular VEB, specified by
...@@ -1179,6 +1179,8 @@ i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 seid, ...@@ -1179,6 +1179,8 @@ i40e_status i40e_aq_remove_macvlan(struct i40e_hw *hw, u16 seid,
* i40e_aq_send_msg_to_vf * i40e_aq_send_msg_to_vf
* @hw: pointer to the hardware structure * @hw: pointer to the hardware structure
* @vfid: vf id to send msg * @vfid: vf id to send msg
* @v_opcode: opcodes for VF-PF communication
* @v_retval: return error code
* @msg: pointer to the msg buffer * @msg: pointer to the msg buffer
* @msglen: msg length * @msglen: msg length
* @cmd_details: pointer to command details * @cmd_details: pointer to command details
...@@ -1723,6 +1725,7 @@ i40e_status i40e_aq_start_lldp(struct i40e_hw *hw, ...@@ -1723,6 +1725,7 @@ i40e_status i40e_aq_start_lldp(struct i40e_hw *hw,
* @udp_port: the UDP port to add * @udp_port: the UDP port to add
* @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
* @cmd_details: pointer to command details structure or NULL * @cmd_details: pointer to command details structure or NULL
**/ **/
i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw, i40e_status i40e_aq_add_udp_tunnel(struct i40e_hw *hw,
......
...@@ -116,7 +116,6 @@ struct i40e_hmc_info { ...@@ -116,7 +116,6 @@ struct i40e_hmc_info {
* @hw: pointer to our hw struct * @hw: pointer to our hw struct
* @pa: pointer to physical address * @pa: pointer to physical address
* @sd_index: segment descriptor index * @sd_index: segment descriptor index
* @hmc_fn_id: hmc function id
* @type: if sd entry is direct or paged * @type: if sd entry is direct or paged
**/ **/
#define I40E_SET_PF_SD_ENTRY(hw, pa, sd_index, type) \ #define I40E_SET_PF_SD_ENTRY(hw, pa, sd_index, type) \
...@@ -138,7 +137,6 @@ struct i40e_hmc_info { ...@@ -138,7 +137,6 @@ struct i40e_hmc_info {
* I40E_CLEAR_PF_SD_ENTRY - marks the sd entry as invalid in the hardware * I40E_CLEAR_PF_SD_ENTRY - marks the sd entry as invalid in the hardware
* @hw: pointer to our hw struct * @hw: pointer to our hw struct
* @sd_index: segment descriptor index * @sd_index: segment descriptor index
* @hmc_fn_id: hmc function id
* @type: if sd entry is direct or paged * @type: if sd entry is direct or paged
**/ **/
#define I40E_CLEAR_PF_SD_ENTRY(hw, sd_index, type) \ #define I40E_CLEAR_PF_SD_ENTRY(hw, sd_index, type) \
...@@ -159,7 +157,6 @@ struct i40e_hmc_info { ...@@ -159,7 +157,6 @@ struct i40e_hmc_info {
* @hw: pointer to our hw struct * @hw: pointer to our hw struct
* @sd_idx: segment descriptor index * @sd_idx: segment descriptor index
* @pd_idx: page descriptor index * @pd_idx: page descriptor index
* @hmc_fn_id: hmc function id
**/ **/
#define I40E_INVALIDATE_PF_HMC_PD(hw, sd_idx, pd_idx) \ #define I40E_INVALIDATE_PF_HMC_PD(hw, sd_idx, pd_idx) \
wr32((hw), I40E_PFHMC_PDINV, \ wr32((hw), I40E_PFHMC_PDINV, \
......
...@@ -244,6 +244,7 @@ i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset, ...@@ -244,6 +244,7 @@ i40e_status i40e_read_nvm_buffer(struct i40e_hw *hw, u16 offset,
/** /**
* i40e_calc_nvm_checksum - Calculates and returns the checksum * i40e_calc_nvm_checksum - Calculates and returns the checksum
* @hw: pointer to hardware structure * @hw: pointer to hardware structure
* @checksum: pointer to the checksum
* *
* This function calculate SW Checksum that covers the whole 64kB shadow RAM * This function calculate SW Checksum that covers the whole 64kB shadow RAM
* except the VPD and PCIe ALT Auto-load modules. The structure and size of VPD * except the VPD and PCIe ALT Auto-load modules. The structure and size of VPD
......
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