Commit 744b7e1e authored by Johannes Berg's avatar Johannes Berg

wifi: iwlwifi: dvm: remove kernel-doc warnings

Mostly remove kernel-doc comment annotation since
the comments really aren't kernel-doc, and fix a
few other places.
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarGregory Greenman <gregory.greenman@intel.com>
Link: https://lore.kernel.org/r/20230830112059.7178fb7c96fb.I6af1f291e306c50a3c4f5afcdc2ba0bbd4bea01f@changeidSigned-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent 2ce9c747
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
/* /*
* Copyright (C) 2005-2014 Intel Corporation * Copyright (C) 2005-2014, 2023 Intel Corporation
*/ */
/* /*
* Please use this file (commands.h) only for uCode API definitions. * Please use this file (commands.h) only for uCode API definitions.
...@@ -270,7 +270,7 @@ enum { ...@@ -270,7 +270,7 @@ enum {
#define IWL_PWR_NUM_HT_OFDM_ENTRIES 24 #define IWL_PWR_NUM_HT_OFDM_ENTRIES 24
#define IWL_PWR_CCK_ENTRIES 2 #define IWL_PWR_CCK_ENTRIES 2
/** /*
* struct tx_power_dual_stream * struct tx_power_dual_stream
* *
* Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
...@@ -281,7 +281,7 @@ struct tx_power_dual_stream { ...@@ -281,7 +281,7 @@ struct tx_power_dual_stream {
__le32 dw; __le32 dw;
} __packed; } __packed;
/** /*
* Command REPLY_TX_POWER_DBM_CMD = 0x98 * Command REPLY_TX_POWER_DBM_CMD = 0x98
* struct iwlagn_tx_power_dbm_cmd * struct iwlagn_tx_power_dbm_cmd
*/ */
...@@ -295,7 +295,7 @@ struct iwlagn_tx_power_dbm_cmd { ...@@ -295,7 +295,7 @@ struct iwlagn_tx_power_dbm_cmd {
u8 reserved; u8 reserved;
} __packed; } __packed;
/** /*
* Command TX_ANT_CONFIGURATION_CMD = 0x98 * Command TX_ANT_CONFIGURATION_CMD = 0x98
* This command is used to configure valid Tx antenna. * This command is used to configure valid Tx antenna.
* By default uCode concludes the valid antenna according to the radio flavor. * By default uCode concludes the valid antenna according to the radio flavor.
...@@ -313,7 +313,7 @@ struct iwl_tx_ant_config_cmd { ...@@ -313,7 +313,7 @@ struct iwl_tx_ant_config_cmd {
#define UCODE_VALID_OK cpu_to_le32(0x1) #define UCODE_VALID_OK cpu_to_le32(0x1)
/** /*
* REPLY_ALIVE = 0x1 (response only, not a command) * REPLY_ALIVE = 0x1 (response only, not a command)
* *
* uCode issues this "alive" notification once the runtime image is ready * uCode issues this "alive" notification once the runtime image is ready
...@@ -534,7 +534,7 @@ enum { ...@@ -534,7 +534,7 @@ enum {
/* transfer to host non bssid beacons in associated state */ /* transfer to host non bssid beacons in associated state */
#define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6) #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
/** /*
* REPLY_RXON = 0x10 (command, has simple generic response) * REPLY_RXON = 0x10 (command, has simple generic response)
* *
* RXON tunes the radio tuner to a service channel, and sets up a number * RXON tunes the radio tuner to a service channel, and sets up a number
...@@ -681,6 +681,7 @@ struct iwl_csa_notification { ...@@ -681,6 +681,7 @@ struct iwl_csa_notification {
* @aifsn: Number of slots in Arbitration Interframe Space (before * @aifsn: Number of slots in Arbitration Interframe Space (before
* performing random backoff timing prior to Tx). Device default 1. * performing random backoff timing prior to Tx). Device default 1.
* @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0. * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
* @reserved1: reserved for alignment
* *
* Device will automatically increase contention window by (2*CW) + 1 for each * Device will automatically increase contention window by (2*CW) + 1 for each
* transmission retry. Device uses cw_max as a bit mask, ANDed with new CW * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
...@@ -791,9 +792,11 @@ struct iwl_keyinfo { ...@@ -791,9 +792,11 @@ struct iwl_keyinfo {
/** /**
* struct sta_id_modify * struct sta_id_modify
* @addr[ETH_ALEN]: station's MAC address * @addr: station's MAC address
* @reserved1: reserved for alignment
* @sta_id: index of station in uCode's station table * @sta_id: index of station in uCode's station table
* @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
* @reserved2: reserved for alignment
* *
* Driver selects unused table index when adding new station, * Driver selects unused table index when adding new station,
* or the index to a pre-existing station entry when modifying that station. * or the index to a pre-existing station entry when modifying that station.
...@@ -1464,7 +1467,7 @@ struct iwl_compressed_ba_resp { ...@@ -1464,7 +1467,7 @@ struct iwl_compressed_ba_resp {
#define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK) #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
/** /*
* struct iwl_link_qual_general_params * struct iwl_link_qual_general_params
* *
* Used in REPLY_TX_LINK_QUALITY_CMD * Used in REPLY_TX_LINK_QUALITY_CMD
...@@ -1507,7 +1510,7 @@ struct iwl_link_qual_general_params { ...@@ -1507,7 +1510,7 @@ struct iwl_link_qual_general_params {
#define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63) #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
#define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0) #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
/** /*
* struct iwl_link_qual_agg_params * struct iwl_link_qual_agg_params
* *
* Used in REPLY_TX_LINK_QUALITY_CMD * Used in REPLY_TX_LINK_QUALITY_CMD
...@@ -2040,7 +2043,7 @@ struct iwl_spectrum_notification { ...@@ -2040,7 +2043,7 @@ struct iwl_spectrum_notification {
* *
*****************************************************************************/ *****************************************************************************/
/** /*
* struct iwl_powertable_cmd - Power Table Command * struct iwl_powertable_cmd - Power Table Command
* @flags: See below: * @flags: See below:
* *
...@@ -2171,7 +2174,7 @@ struct iwl_ct_kill_throttling_config { ...@@ -2171,7 +2174,7 @@ struct iwl_ct_kill_throttling_config {
#define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0) #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
#define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1) #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
/** /*
* struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
* *
* One for each channel in the scan list. * One for each channel in the scan list.
...@@ -2210,7 +2213,7 @@ struct iwl_scan_channel { ...@@ -2210,7 +2213,7 @@ struct iwl_scan_channel {
/* set number of direct probes __le32 type */ /* set number of direct probes __le32 type */
#define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1)))) #define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
/** /*
* struct iwl_ssid_ie - directed scan network information element * struct iwl_ssid_ie - directed scan network information element
* *
* Up to 20 of these may appear in REPLY_SCAN_CMD, * Up to 20 of these may appear in REPLY_SCAN_CMD,
...@@ -2560,6 +2563,7 @@ struct statistics_rx_bt { ...@@ -2560,6 +2563,7 @@ struct statistics_rx_bt {
* @ant_a: current tx power on chain a in 1/2 dB step * @ant_a: current tx power on chain a in 1/2 dB step
* @ant_b: current tx power on chain b in 1/2 dB step * @ant_b: current tx power on chain b in 1/2 dB step
* @ant_c: current tx power on chain c in 1/2 dB step * @ant_c: current tx power on chain c in 1/2 dB step
* @reserved: reserved for alignment
*/ */
struct statistics_tx_power { struct statistics_tx_power {
u8 ant_a; u8 ant_a;
...@@ -3006,7 +3010,7 @@ struct iwl_enhance_sensitivity_cmd { ...@@ -3006,7 +3010,7 @@ struct iwl_enhance_sensitivity_cmd {
} __packed; } __packed;
/** /*
* REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response) * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
* *
* This command sets the relative gains of agn device's 3 radio receiver chains. * This command sets the relative gains of agn device's 3 radio receiver chains.
...@@ -3847,6 +3851,7 @@ struct iwlagn_wowlan_status { ...@@ -3847,6 +3851,7 @@ struct iwlagn_wowlan_status {
* @type: * @type:
* 0 - BSS * 0 - BSS
* 1 - PAN * 1 - PAN
* @reserved: reserved for alignment
*/ */
struct iwl_wipan_slot { struct iwl_wipan_slot {
__le16 width; __le16 width;
...@@ -3874,6 +3879,8 @@ struct iwl_wipan_slot { ...@@ -3874,6 +3879,8 @@ struct iwl_wipan_slot {
* uCode will perform leaving channel methods in context switch * uCode will perform leaving channel methods in context switch
* also when working in same channel mode * also when working in same channel mode
* @num_slots: 1 - 10 * @num_slots: 1 - 10
* @slots: per-slot data
* @reserved: reserved for alignment
*/ */
struct iwl_wipan_params_cmd { struct iwl_wipan_params_cmd {
__le16 flags; __le16 flags;
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/****************************************************************************** /******************************************************************************
* *
* Copyright(c) 2003 - 2014, 2020 Intel Corporation. All rights reserved. * Copyright(c) 2003 - 2014, 2020, 2023 Intel Corporation. All rights reserved.
*****************************************************************************/ *****************************************************************************/
/* /*
* Please use this file (dev.h) for driver implementation definitions. * Please use this file (dev.h) for driver implementation definitions.
...@@ -126,11 +126,11 @@ enum iwl_agg_state { ...@@ -126,11 +126,11 @@ enum iwl_agg_state {
/** /**
* struct iwl_ht_agg - aggregation state machine * struct iwl_ht_agg - aggregation state machine
*
* This structs holds the states for the BA agreement establishment and tear * This structs holds the states for the BA agreement establishment and tear
* down. It also holds the state during the BA session itself. This struct is * down. It also holds the state during the BA session itself. This struct is
* duplicated for each RA / TID. * duplicated for each RA / TID.
*
* @rate_n_flags: Rate at which Tx was attempted. Holds the data between the * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the
* Tx response (REPLY_TX), and the block ack notification * Tx response (REPLY_TX), and the block ack notification
* (REPLY_COMPRESSED_BA). * (REPLY_COMPRESSED_BA).
...@@ -152,9 +152,9 @@ struct iwl_ht_agg { ...@@ -152,9 +152,9 @@ struct iwl_ht_agg {
/** /**
* struct iwl_tid_data - one for each RA / TID * struct iwl_tid_data - one for each RA / TID
*
* This structs holds the states for each RA / TID. * This structs holds the states for each RA / TID.
*
* @seq_number: the next WiFi sequence number to use * @seq_number: the next WiFi sequence number to use
* @next_reclaimed: the WiFi sequence number of the next packet to be acked. * @next_reclaimed: the WiFi sequence number of the next packet to be acked.
* This is basically (last acked packet++). * This is basically (last acked packet++).
...@@ -195,7 +195,7 @@ struct iwl_station_priv { ...@@ -195,7 +195,7 @@ struct iwl_station_priv {
u8 sta_id; u8 sta_id;
}; };
/** /*
* struct iwl_vif_priv - driver's private per-interface information * struct iwl_vif_priv - driver's private per-interface information
* *
* When mac80211 allocates a virtual interface, it can allocate * When mac80211 allocates a virtual interface, it can allocate
...@@ -529,6 +529,7 @@ enum iwl_scan_type { ...@@ -529,6 +529,7 @@ enum iwl_scan_type {
* relevant for 1000, 6000 and up * relevant for 1000, 6000 and up
* @struct iwl_sensitivity_ranges: range of sensitivity values * @struct iwl_sensitivity_ranges: range of sensitivity values
* @use_rts_for_aggregation: use rts/cts protection for HT traffic * @use_rts_for_aggregation: use rts/cts protection for HT traffic
* @sens: sensitivity ranges pointer
*/ */
struct iwl_hw_params { struct iwl_hw_params {
u8 tx_chains_num; u8 tx_chains_num;
...@@ -547,6 +548,7 @@ struct iwl_hw_params { ...@@ -547,6 +548,7 @@ struct iwl_hw_params {
* @bt_prio_boost: default bt priority boost value * @bt_prio_boost: default bt priority boost value
* @agg_time_limit: maximum number of uSec in aggregation * @agg_time_limit: maximum number of uSec in aggregation
* @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
* @bt_session_2: indicates version 2 of the BT command is used
*/ */
struct iwl_dvm_bt_params { struct iwl_dvm_bt_params {
bool advanced_bt_coexist; bool advanced_bt_coexist;
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/****************************************************************************** /******************************************************************************
* *
* Copyright(c) 2003 - 2014 Intel Corporation. All rights reserved. * Copyright(c) 2003 - 2014, 2023 Intel Corporation. All rights reserved.
*****************************************************************************/ *****************************************************************************/
#ifndef __iwl_agn_rs_h__ #ifndef __iwl_agn_rs_h__
...@@ -269,7 +269,7 @@ struct iwl_rate_mcs_info { ...@@ -269,7 +269,7 @@ struct iwl_rate_mcs_info {
char mcs[IWL_MAX_MCS_DISPLAY_SIZE]; char mcs[IWL_MAX_MCS_DISPLAY_SIZE];
}; };
/** /*
* struct iwl_rate_scale_data -- tx success history for one rate * struct iwl_rate_scale_data -- tx success history for one rate
*/ */
struct iwl_rate_scale_data { struct iwl_rate_scale_data {
...@@ -281,7 +281,7 @@ struct iwl_rate_scale_data { ...@@ -281,7 +281,7 @@ struct iwl_rate_scale_data {
unsigned long stamp; unsigned long stamp;
}; };
/** /*
* struct iwl_scale_tbl_info -- tx params and success history for all rates * struct iwl_scale_tbl_info -- tx params and success history for all rates
* *
* There are two of these in struct iwl_lq_sta, * There are two of these in struct iwl_lq_sta,
...@@ -311,7 +311,7 @@ struct iwl_traffic_load { ...@@ -311,7 +311,7 @@ struct iwl_traffic_load {
u8 head; /* start of the circular buffer */ u8 head; /* start of the circular buffer */
}; };
/** /*
* struct iwl_lq_sta -- driver's rate scaling private structure * struct iwl_lq_sta -- driver's rate scaling private structure
* *
* Pointer to this gets passed back and forth between driver and mac80211. * Pointer to this gets passed back and forth between driver and mac80211.
...@@ -379,7 +379,7 @@ static inline u8 first_antenna(u8 mask) ...@@ -379,7 +379,7 @@ static inline u8 first_antenna(u8 mask)
void iwl_rs_rate_init(struct iwl_priv *priv, struct ieee80211_sta *sta, void iwl_rs_rate_init(struct iwl_priv *priv, struct ieee80211_sta *sta,
u8 sta_id); u8 sta_id);
/** /*
* iwl_rate_control_register - Register the rate control algorithm callbacks * iwl_rate_control_register - Register the rate control algorithm callbacks
* *
* Since the rate control algorithm is hardware specific, there is no need * Since the rate control algorithm is hardware specific, there is no need
...@@ -391,7 +391,7 @@ void iwl_rs_rate_init(struct iwl_priv *priv, struct ieee80211_sta *sta, ...@@ -391,7 +391,7 @@ void iwl_rs_rate_init(struct iwl_priv *priv, struct ieee80211_sta *sta,
*/ */
int iwlagn_rate_control_register(void); int iwlagn_rate_control_register(void);
/** /*
* iwl_rate_control_unregister - Unregister the rate control callbacks * iwl_rate_control_unregister - Unregister the rate control callbacks
* *
* This should be called after calling ieee80211_unregister_hw, but before * This should be called after calling ieee80211_unregister_hw, but before
......
/* SPDX-License-Identifier: GPL-2.0-only */ /* SPDX-License-Identifier: GPL-2.0-only */
/****************************************************************************** /******************************************************************************
* *
* Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved. * Copyright(c) 2007 - 2014, 2023 Intel Corporation. All rights reserved.
* *
* Portions of this file are derived from the ipw3945 project, as well * Portions of this file are derived from the ipw3945 project, as well
* as portions of the ieee80211 subsystem header files. * as portions of the ieee80211 subsystem header files.
...@@ -72,14 +72,15 @@ struct iwl_tt_trans { ...@@ -72,14 +72,15 @@ struct iwl_tt_trans {
* when thermal throttling state != IWL_TI_0 * when thermal throttling state != IWL_TI_0
* the tt_power_mode should set to different * the tt_power_mode should set to different
* power mode based on the current tt state * power mode based on the current tt state
* @tt_previous_temperature: last measured temperature * @tt_previous_temp: last measured temperature
* @iwl_tt_restriction: ptr to restriction tbl, used by advance * @restriction: ptr to restriction tbl, used by advance
* thermal throttling to determine how many tx/rx streams * thermal throttling to determine how many tx/rx streams
* should be used in tt state; and can HT be enabled or not * should be used in tt state; and can HT be enabled or not
* @iwl_tt_trans: ptr to adv trans table, used by advance thermal throttling * @transaction: ptr to adv trans table, used by advance thermal throttling
* state transaction * state transaction
* @ct_kill_toggle: used to toggle the CSR bit when checking uCode temperature * @ct_kill_toggle: used to toggle the CSR bit when checking uCode temperature
* @ct_kill_exit_tm: timer to exit thermal kill * @ct_kill_exit_tm: timer to exit thermal kill
* @ct_kill_waiting_tm: timer to enter thermal kill
*/ */
struct iwl_tt_mgmt { struct iwl_tt_mgmt {
enum iwl_tt_state state; enum iwl_tt_state state;
......
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