Commit 3a07d36c authored by Johannes Berg's avatar Johannes Berg Committed by Luca Coelho

iwlwifi: mvm: fix many kernel-doc warnings

Fix many kernel-doc warnings. In one case, this required adding
a new enum value to be able to document things properly.
Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
parent e4eb275a
...@@ -82,6 +82,8 @@ ...@@ -82,6 +82,8 @@
* @LTR_CFG_FLAG_SW_SET_SHORT: fixed static short LTR register * @LTR_CFG_FLAG_SW_SET_SHORT: fixed static short LTR register
* @LTR_CFG_FLAG_SW_SET_LONG: fixed static short LONG register * @LTR_CFG_FLAG_SW_SET_LONG: fixed static short LONG register
* @LTR_CFG_FLAG_DENIE_C10_ON_PD: allow going into C10 on PD * @LTR_CFG_FLAG_DENIE_C10_ON_PD: allow going into C10 on PD
* @LTR_CFG_FLAG_UPDATE_VALUES: update config values and short
* idle timeout
*/ */
enum iwl_ltr_config_flags { enum iwl_ltr_config_flags {
LTR_CFG_FLAG_FEATURE_ENABLE = BIT(0), LTR_CFG_FLAG_FEATURE_ENABLE = BIT(0),
...@@ -91,11 +93,14 @@ enum iwl_ltr_config_flags { ...@@ -91,11 +93,14 @@ enum iwl_ltr_config_flags {
LTR_CFG_FLAG_SW_SET_SHORT = BIT(4), LTR_CFG_FLAG_SW_SET_SHORT = BIT(4),
LTR_CFG_FLAG_SW_SET_LONG = BIT(5), LTR_CFG_FLAG_SW_SET_LONG = BIT(5),
LTR_CFG_FLAG_DENIE_C10_ON_PD = BIT(6), LTR_CFG_FLAG_DENIE_C10_ON_PD = BIT(6),
LTR_CFG_FLAG_UPDATE_VALUES = BIT(7),
}; };
/** /**
* struct iwl_ltr_config_cmd_v1 - configures the LTR * struct iwl_ltr_config_cmd_v1 - configures the LTR
* @flags: See &enum iwl_ltr_config_flags * @flags: See &enum iwl_ltr_config_flags
* @static_long: static LTR Long register value.
* @static_short: static LTR Short register value.
*/ */
struct iwl_ltr_config_cmd_v1 { struct iwl_ltr_config_cmd_v1 {
__le32 flags; __le32 flags;
...@@ -108,10 +113,13 @@ struct iwl_ltr_config_cmd_v1 { ...@@ -108,10 +113,13 @@ struct iwl_ltr_config_cmd_v1 {
/** /**
* struct iwl_ltr_config_cmd - configures the LTR * struct iwl_ltr_config_cmd - configures the LTR
* @flags: See &enum iwl_ltr_config_flags * @flags: See &enum iwl_ltr_config_flags
* @static_long: * @static_long: static LTR Long register value.
* @static_short: * @static_short: static LTR Short register value.
* @ltr_cfg_values: * @ltr_cfg_values: LTR parameters table values (in usec) in folowing order:
* @ltr_short_idle_timeout: * TX, RX, Short Idle, Long Idle. Used only if %LTR_CFG_FLAG_UPDATE_VALUES
* is set.
* @ltr_short_idle_timeout: LTR Short Idle timeout (in usec). Used only if
* %LTR_CFG_FLAG_UPDATE_VALUES is set.
*/ */
struct iwl_ltr_config_cmd { struct iwl_ltr_config_cmd {
__le32 flags; __le32 flags;
...@@ -140,7 +148,7 @@ struct iwl_ltr_config_cmd { ...@@ -140,7 +148,7 @@ struct iwl_ltr_config_cmd {
* PBW Snoozing enabled * PBW Snoozing enabled
* @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask * @POWER_FLAGS_ADVANCE_PM_ENA_MSK: Advanced PM (uAPSD) enable mask
* @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable. * @POWER_FLAGS_LPRX_ENA_MSK: Low Power RX enable.
* @POWER_FLAGS_AP_UAPSD_MISBEHAVING_ENA_MSK: AP/GO's uAPSD misbehaving * @POWER_FLAGS_UAPSD_MISBEHAVING_ENA_MSK: AP/GO's uAPSD misbehaving
* detection enablement * detection enablement
*/ */
enum iwl_power_flags { enum iwl_power_flags {
...@@ -166,6 +174,7 @@ enum iwl_power_flags { ...@@ -166,6 +174,7 @@ enum iwl_power_flags {
* Minimum allowed:- 3 * DTIM. Keep alive period must be * Minimum allowed:- 3 * DTIM. Keep alive period must be
* set regardless of power scheme or current power state. * set regardless of power scheme or current power state.
* FW use this value also when PM is disabled. * FW use this value also when PM is disabled.
* @debug_flags: debug flags
* @rx_data_timeout: Minimum time (usec) from last Rx packet for AM to * @rx_data_timeout: Minimum time (usec) from last Rx packet for AM to
* PSM transition - legacy PM * PSM transition - legacy PM
* @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to * @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to
...@@ -191,7 +200,8 @@ struct iwl_powertable_cmd { ...@@ -191,7 +200,8 @@ struct iwl_powertable_cmd {
/** /**
* enum iwl_device_power_flags - masks for device power command flags * enum iwl_device_power_flags - masks for device power command flags
* @DEVIC_POWER_FLAGS_POWER_SAVE_ENA_MSK: '1' Allow to save power by turning off * @DEVICE_POWER_FLAGS_POWER_SAVE_ENA_MSK:
* '1' Allow to save power by turning off
* receiver and transmitter. '0' - does not allow. * receiver and transmitter. '0' - does not allow.
*/ */
enum iwl_device_power_flags { enum iwl_device_power_flags {
...@@ -203,6 +213,7 @@ enum iwl_device_power_flags { ...@@ -203,6 +213,7 @@ enum iwl_device_power_flags {
* DEVICE_POWER_CMD = 0x77 (command, has simple generic response) * DEVICE_POWER_CMD = 0x77 (command, has simple generic response)
* *
* @flags: Power table command flags from &enum iwl_device_power_flags * @flags: Power table command flags from &enum iwl_device_power_flags
* @reserved: reserved (padding)
*/ */
struct iwl_device_power_cmd { struct iwl_device_power_cmd {
/* PM_POWER_TABLE_CMD_API_S_VER_6 */ /* PM_POWER_TABLE_CMD_API_S_VER_6 */
...@@ -223,7 +234,6 @@ struct iwl_device_power_cmd { ...@@ -223,7 +234,6 @@ struct iwl_device_power_cmd {
* PSM transition - legacy PM * PSM transition - legacy PM
* @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to * @tx_data_timeout: Minimum time (usec) from last Tx packet for AM to
* PSM transition - legacy PM * PSM transition - legacy PM
* @sleep_interval: not in use
* @skip_dtim_periods: Number of DTIM periods to skip if Skip over DTIM flag * @skip_dtim_periods: Number of DTIM periods to skip if Skip over DTIM flag
* is set. For example, if it is required to skip over * is set. For example, if it is required to skip over
* one DTIM, this value need to be set to 2 (DTIM periods). * one DTIM, this value need to be set to 2 (DTIM periods).
...@@ -233,7 +243,6 @@ struct iwl_device_power_cmd { ...@@ -233,7 +243,6 @@ struct iwl_device_power_cmd {
* PSM transition - uAPSD * PSM transition - uAPSD
* @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled. * @lprx_rssi_threshold: Signal strength up to which LP RX can be enabled.
* Default: 80dbm * Default: 80dbm
* @num_skip_dtim: Number of DTIMs to skip if Skip over DTIM flag is set
* @snooze_interval: Maximum time between attempts to retrieve buffered data * @snooze_interval: Maximum time between attempts to retrieve buffered data
* from the AP [msec] * from the AP [msec]
* @snooze_window: A window of time in which PBW snoozing insures that all * @snooze_window: A window of time in which PBW snoozing insures that all
...@@ -251,8 +260,9 @@ struct iwl_device_power_cmd { ...@@ -251,8 +260,9 @@ struct iwl_device_power_cmd {
* @heavy_rx_thld_packets: RX threshold measured in number of packets * @heavy_rx_thld_packets: RX threshold measured in number of packets
* @heavy_tx_thld_percentage: TX threshold measured in load's percentage * @heavy_tx_thld_percentage: TX threshold measured in load's percentage
* @heavy_rx_thld_percentage: RX threshold measured in load's percentage * @heavy_rx_thld_percentage: RX threshold measured in load's percentage
* @limited_ps_threshold: * @limited_ps_threshold: (unused)
*/ * @reserved: reserved (padding)
*/
struct iwl_mac_power_cmd { struct iwl_mac_power_cmd {
/* CONTEXT_DESC_API_T_VER_1 */ /* CONTEXT_DESC_API_T_VER_1 */
__le32 id_and_color; __le32 id_and_color;
...@@ -343,6 +353,7 @@ struct iwl_dev_tx_power_cmd_v3 { ...@@ -343,6 +353,7 @@ struct iwl_dev_tx_power_cmd_v3 {
* @v3: version 3 of the command, embedded here for easier software handling * @v3: version 3 of the command, embedded here for easier software handling
* @enable_ack_reduction: enable or disable close range ack TX power * @enable_ack_reduction: enable or disable close range ack TX power
* reduction. * reduction.
* @reserved: reserved (padding)
*/ */
struct iwl_dev_tx_power_cmd { struct iwl_dev_tx_power_cmd {
/* v4 is just an extension of v3 - keep this here */ /* v4 is just an extension of v3 - keep this here */
...@@ -393,7 +404,6 @@ struct iwl_geo_tx_power_profiles_cmd { ...@@ -393,7 +404,6 @@ struct iwl_geo_tx_power_profiles_cmd {
/** /**
* struct iwl_beacon_filter_cmd * struct iwl_beacon_filter_cmd
* REPLY_BEACON_FILTERING_CMD = 0xd2 (command) * REPLY_BEACON_FILTERING_CMD = 0xd2 (command)
* @id_and_color: MAC contex identifier
* @bf_energy_delta: Used for RSSI filtering, if in 'normal' state. Send beacon * @bf_energy_delta: Used for RSSI filtering, if in 'normal' state. Send beacon
* to driver if delta in Energy values calculated for this and last * to driver if delta in Energy values calculated for this and last
* passed beacon is greater than this threshold. Zero value means that * passed beacon is greater than this threshold. Zero value means that
...@@ -425,7 +435,8 @@ struct iwl_geo_tx_power_profiles_cmd { ...@@ -425,7 +435,8 @@ struct iwl_geo_tx_power_profiles_cmd {
* beacon filtering; beacons will not be forced to be sent to driver * beacon filtering; beacons will not be forced to be sent to driver
* regardless of whether its temerature has been changed. * regardless of whether its temerature has been changed.
* @bf_enable_beacon_filter: 1, beacon filtering is enabled; 0, disabled. * @bf_enable_beacon_filter: 1, beacon filtering is enabled; 0, disabled.
* @bf_filter_escape_timer: Send beacons to to driver if no beacons were passed * @bf_debug_flag: beacon filtering debug configuration
* @bf_escape_timer: Send beacons to to driver if no beacons were passed
* for a specific period of time. Units: Beacons. * for a specific period of time. Units: Beacons.
* @ba_escape_timer: Fully receive and parse beacon if no beacons were passed * @ba_escape_timer: Fully receive and parse beacon if no beacons were passed
* for a longer period of time then this escape-timeout. Units: Beacons. * for a longer period of time then this escape-timeout. Units: Beacons.
......
...@@ -118,11 +118,17 @@ struct iwl_tof_config_cmd { ...@@ -118,11 +118,17 @@ struct iwl_tof_config_cmd {
* @bandwidth: current AP Bandwidth: 0 20MHz, 1 40MHz, 2 80MHz * @bandwidth: current AP Bandwidth: 0 20MHz, 1 40MHz, 2 80MHz
* @rate: current AP rate * @rate: current AP rate
* @ctrl_ch_position: coding of the control channel position relative to * @ctrl_ch_position: coding of the control channel position relative to
* the center frequency. * the center frequency:
* 40MHz 0 below center, 1 above center *
* 80MHz bits [0..1]: 0 the near 20MHz to the center, * 40 MHz
* 1 the far 20MHz to the center * 0 below center, 1 above center
* bit[2] as above 40MHz *
* 80 MHz
* bits [0..1]
* * 0 the near 20MHz to the center,
* * 1 the far 20MHz to the center
* bit[2]
* as above 40MHz
* @ftm_per_burst: FTMs per Burst * @ftm_per_burst: FTMs per Burst
* @ftm_resp_ts_avail: '0' - we don't measure over the Initial FTM Response, * @ftm_resp_ts_avail: '0' - we don't measure over the Initial FTM Response,
* '1' - we measure over the Initial FTM Response * '1' - we measure over the Initial FTM Response
......
...@@ -74,6 +74,7 @@ ...@@ -74,6 +74,7 @@
* Otherwise, use rate_n_flags from the TX command * Otherwise, use rate_n_flags from the TX command
* @TX_CMD_FLG_BAR: this frame is a BA request, immediate BAR is expected * @TX_CMD_FLG_BAR: this frame is a BA request, immediate BAR is expected
* Must set TX_CMD_FLG_ACK with this flag. * Must set TX_CMD_FLG_ACK with this flag.
* @TX_CMD_FLG_TXOP_PROT: TXOP protection requested
* @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence * @TX_CMD_FLG_VHT_NDPA: mark frame is NDPA for VHT beamformer sequence
* @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence * @TX_CMD_FLG_HT_NDPA: mark frame is NDPA for HT beamformer sequence
* @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC) * @TX_CMD_FLG_CSI_FDBK2HOST: mark to send feedback to host (only if good CRC)
...@@ -201,7 +202,7 @@ enum iwl_tx_cmd_sec_ctrl { ...@@ -201,7 +202,7 @@ enum iwl_tx_cmd_sec_ctrl {
/** /**
* enum iwl_tx_offload_assist_flags_pos - set %iwl_tx_cmd offload_assist values * enum iwl_tx_offload_assist_flags_pos - set %iwl_tx_cmd offload_assist values
* @TX_CMD_OFFLD_IP_HDR_OFFSET: offset to start of IP header (in words) * @TX_CMD_OFFLD_IP_HDR: offset to start of IP header (in words)
* from mac header end. For normal case it is 4 words for SNAP. * from mac header end. For normal case it is 4 words for SNAP.
* note: tx_cmd, mac header and pad are not counted in the offset. * note: tx_cmd, mac header and pad are not counted in the offset.
* This is used to help the offload in case there is tunneling such as * This is used to help the offload in case there is tunneling such as
...@@ -235,12 +236,14 @@ enum iwl_tx_offload_assist_flags_pos { ...@@ -235,12 +236,14 @@ enum iwl_tx_offload_assist_flags_pos {
* @len: in bytes of the payload, see below for details * @len: in bytes of the payload, see below for details
* @offload_assist: TX offload configuration * @offload_assist: TX offload configuration
* @tx_flags: combination of TX_CMD_FLG_* * @tx_flags: combination of TX_CMD_FLG_*
* @scratch: scratch buffer used by the device
* @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
* cleared. Combination of RATE_MCS_* * cleared. Combination of RATE_MCS_*
* @sta_id: index of destination station in FW station table * @sta_id: index of destination station in FW station table
* @sec_ctl: security control, TX_CMD_SEC_* * @sec_ctl: security control, TX_CMD_SEC_*
* @initial_rate_index: index into the the rate table for initial TX attempt. * @initial_rate_index: index into the the rate table for initial TX attempt.
* Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames. * Applied if TX_CMD_FLG_STA_RATE_MSK is set, normally 0 for data frames.
* @reserved2: reserved
* @key: security key * @key: security key
* @reserved3: reserved * @reserved3: reserved
* @life_time: frame life time (usecs??) * @life_time: frame life time (usecs??)
...@@ -249,8 +252,11 @@ enum iwl_tx_offload_assist_flags_pos { ...@@ -249,8 +252,11 @@ enum iwl_tx_offload_assist_flags_pos {
* @dram_msb_ptr: upper bits of the scratch physical address * @dram_msb_ptr: upper bits of the scratch physical address
* @rts_retry_limit: max attempts for RTS * @rts_retry_limit: max attempts for RTS
* @data_retry_limit: max attempts to send the data packet * @data_retry_limit: max attempts to send the data packet
* @tid_spec: TID/tspec * @tid_tspec: TID/tspec
* @pm_frame_timeout: PM TX frame timeout * @pm_frame_timeout: PM TX frame timeout
* @reserved4: reserved
* @payload: payload (same as @hdr)
* @hdr: 802.11 header (same as @payload)
* *
* The byte count (both len and next_frame_len) includes MAC header * The byte count (both len and next_frame_len) includes MAC header
* (24/26/30/32 bytes) * (24/26/30/32 bytes)
...@@ -304,10 +310,11 @@ struct iwl_dram_sec_info { ...@@ -304,10 +310,11 @@ struct iwl_dram_sec_info {
* ( TX_CMD = 0x1c ) * ( TX_CMD = 0x1c )
* @len: in bytes of the payload, see below for details * @len: in bytes of the payload, see below for details
* @offload_assist: TX offload configuration * @offload_assist: TX offload configuration
* @tx_flags: combination of &iwl_tx_cmd_flags * @flags: combination of &enum iwl_tx_cmd_flags
* @dram_info: FW internal DRAM storage * @dram_info: FW internal DRAM storage
* @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is * @rate_n_flags: rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is
* cleared. Combination of RATE_MCS_* * cleared. Combination of RATE_MCS_*
* @hdr: 802.11 header
*/ */
struct iwl_tx_cmd_gen2 { struct iwl_tx_cmd_gen2 {
__le16 len; __le16 len;
...@@ -519,6 +526,8 @@ struct agg_tx_status { ...@@ -519,6 +526,8 @@ struct agg_tx_status {
* @pa_integ_res_b: tx power info * @pa_integ_res_b: tx power info
* @pa_integ_res_c: tx power info * @pa_integ_res_c: tx power info
* @measurement_req_id: tx power info * @measurement_req_id: tx power info
* @reduced_tpc: transmit power reduction used
* @reserved: reserved
* @tfd_info: TFD information set by the FH * @tfd_info: TFD information set by the FH
* @seq_ctl: sequence control from the Tx cmd * @seq_ctl: sequence control from the Tx cmd
* @byte_cnt: byte count from the Tx cmd * @byte_cnt: byte count from the Tx cmd
......
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