mirror of
https://github.com/torvalds/linux.git
synced 2026-06-01 19:13:47 +02:00
wifi: iwlwifi: fix some kernel-doc issues
Add return descriptions, move description contents after (parameter) sections and fix short descriptions. Signed-off-by: Johannes Berg <johannes.berg@intel.com> Reviewed-by: Gregory Greenman <gregory.greenman@intel.com> Signed-off-by: Miri Korenblit <miriam.rachel.korenblit@intel.com> Link: https://msgid.link/20240128084842.02ac00f67239.I4ad17097badfcbb82ccdb8c126f61a6f3170798e@changeid Signed-off-by: Johannes Berg <johannes.berg@intel.com>
This commit is contained in:
parent
7255263962
commit
8a41c01740
|
|
@ -1728,10 +1728,12 @@ iwl_dump_ini_mem_fill_header(struct iwl_fw_runtime *fwrt,
|
|||
/**
|
||||
* mask_apply_and_normalize - applies mask on val and normalize the result
|
||||
*
|
||||
* The normalization is based on the first set bit in the mask
|
||||
*
|
||||
* @val: value
|
||||
* @mask: mask to apply and to normalize with
|
||||
*
|
||||
* The normalization is based on the first set bit in the mask
|
||||
*
|
||||
* Returns: the extracted value
|
||||
*/
|
||||
static u32 mask_apply_and_normalize(u32 val, u32 mask)
|
||||
{
|
||||
|
|
@ -2200,15 +2202,16 @@ struct iwl_dump_ini_mem_ops {
|
|||
};
|
||||
|
||||
/**
|
||||
* iwl_dump_ini_mem
|
||||
*
|
||||
* Creates a dump tlv and copy a memory region into it.
|
||||
* Returns the size of the current dump tlv or 0 if failed
|
||||
* iwl_dump_ini_mem - dump memory region
|
||||
*
|
||||
* @fwrt: fw runtime struct
|
||||
* @list: list to add the dump tlv to
|
||||
* @reg_data: memory region
|
||||
* @ops: memory dump operations
|
||||
*
|
||||
* Creates a dump tlv and copy a memory region into it.
|
||||
*
|
||||
* Returns: the size of the current dump tlv or 0 if failed
|
||||
*/
|
||||
static u32 iwl_dump_ini_mem(struct iwl_fw_runtime *fwrt, struct list_head *list,
|
||||
struct iwl_dump_ini_region_data *reg_data,
|
||||
|
|
|
|||
|
|
@ -270,7 +270,7 @@ enum iwl_eeprom_enhanced_txpwr_flags {
|
|||
};
|
||||
|
||||
/**
|
||||
* struct iwl_eeprom_enhanced_txpwr
|
||||
* struct iwl_eeprom_enhanced_txpwr - enhanced regulatory TX power limits
|
||||
* @flags: entry flags
|
||||
* @channel: channel number
|
||||
* @chain_a_max: chain a max power in 1/2 dBm
|
||||
|
|
|
|||
|
|
@ -259,7 +259,7 @@ static void iwl_mvm_rx_thermal_dual_chain_req(struct iwl_mvm *mvm,
|
|||
}
|
||||
|
||||
/**
|
||||
* enum iwl_rx_handler_context context for Rx handler
|
||||
* enum iwl_rx_handler_context: context for Rx handler
|
||||
* @RX_HANDLER_SYNC : this means that it will be called in the Rx path
|
||||
* which can't acquire mvm->mutex.
|
||||
* @RX_HANDLER_ASYNC_LOCKED : If the handler needs to hold mvm->mutex
|
||||
|
|
@ -279,7 +279,7 @@ enum iwl_rx_handler_context {
|
|||
};
|
||||
|
||||
/**
|
||||
* struct iwl_rx_handlers handler for FW notification
|
||||
* struct iwl_rx_handlers: handler for FW notification
|
||||
* @cmd_id: command id
|
||||
* @min_size: minimum size to expect for the notification
|
||||
* @context: see &iwl_rx_handler_context
|
||||
|
|
|
|||
|
|
@ -4161,6 +4161,8 @@ static int rs_drv_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
|
|||
* @mvm: The mvm component
|
||||
* @mvmsta: The station
|
||||
* @enable: Enable Tx protection?
|
||||
*
|
||||
* Returns: an error code
|
||||
*/
|
||||
int iwl_mvm_tx_protection(struct iwl_mvm *mvm, struct iwl_mvm_sta *mvmsta,
|
||||
bool enable)
|
||||
|
|
|
|||
|
|
@ -249,6 +249,8 @@ u8 iwl_mvm_next_antenna(struct iwl_mvm *mvm, u8 valid, u8 last_idx)
|
|||
* This is the special case in which init is set and we call a callback in
|
||||
* this case to clear the state indicating that station creation is in
|
||||
* progress.
|
||||
*
|
||||
* Returns: an error code indicating success or failure
|
||||
*/
|
||||
int iwl_mvm_send_lq_cmd(struct iwl_mvm *mvm, struct iwl_lq_cmd *lq)
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user