Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit acf91dda authored by Johannes Berg's avatar Johannes Berg Committed by Luca Coelho
Browse files

iwlwifi: mvm: fix a bunch of kernel-doc warnings 



Fix the kernel-doc, and remove some fields even the firmware doesn't
use in ToF, RX, scan, station and generic FW APIS.

Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarLuca Coelho <luciano.coelho@intel.com>
parent 358631bf

drivers/net/wireless/intel/iwlwifi/mvm/fw-api-coex.h

+7 −4
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ 
 *

 * Copyright(c) 2013 - 2014 Intel Corporation. All rights reserved.

 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH

 * Copyright(c) 2017        Intel Deutschland GmbH

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of version 2 of the GNU General Public License as
@@ -33,6 +34,7 @@ 
 *

 * Copyright(c) 2013 - 2014 Intel Corporation. All rights reserved.

 * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH

 * Copyright(c) 2017        Intel Deutschland GmbH

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without
@@ -132,10 +134,10 @@ struct iwl_bt_coex_reduced_txp_update_cmd { 


/**

 * struct iwl_bt_coex_ci_cmd - bt coex channel inhibition command

 * @bt_primary_ci:

 * @primary_ch_phy_id:

 * @bt_secondary_ci:

 * @secondary_ch_phy_id:

 * @bt_primary_ci: primary channel inhibition bitmap

 * @primary_ch_phy_id: primary channel PHY ID

 * @bt_secondary_ci: secondary channel inhibition bitmap

 * @secondary_ch_phy_id: secondary channel PHY ID

 *

 * Used for BT_COEX_CI command

 */
@@ -238,6 +240,7 @@ enum iwl_bt_ci_compliance { 
 * @secondary_ch_lut: LUT used for secondary channel &enum iwl_bt_coex_lut_type

 * @bt_activity_grading: the activity of BT &enum iwl_bt_activity_grading

 * @ttc_rrc_status: is TTC or RRC enabled - one bit per PHY

 * @reserved: reserved

 */

struct iwl_bt_coex_profile_notif {

	__le32 mbox_msg[4];

drivers/net/wireless/intel/iwlwifi/mvm/fw-api-d3.h

+5 −0
Original line number Diff line number Diff line
@@ -139,6 +139,7 @@ struct iwl_proto_offload_cmd_common { 
 *	for each target address

 * @target_ipv6_addr: our target addresses

 * @ndp_mac_addr: neighbor solicitation response MAC address

 * @reserved2: reserved

 */

struct iwl_proto_offload_cmd_v1 {

	struct iwl_proto_offload_cmd_common common;
@@ -157,6 +158,8 @@ struct iwl_proto_offload_cmd_v1 { 
 *	for each target address

 * @target_ipv6_addr: our target addresses

 * @ndp_mac_addr: neighbor solicitation response MAC address

 * @num_valid_ipv6_addrs: number of valid IPv6 addresses

 * @reserved2: reserved

 */

struct iwl_proto_offload_cmd_v2 {

	struct iwl_proto_offload_cmd_common common;
@@ -183,6 +186,7 @@ struct iwl_targ_addr { 
/**

 * struct iwl_proto_offload_cmd_v3_small - ARP/NS offload configuration

 * @common: common/IPv4 configuration

 * @num_valid_ipv6_addrs: number of valid IPv6 addresses

 * @targ_addrs: target IPv6 addresses

 * @ns_config: NS offload configurations

 */
@@ -196,6 +200,7 @@ struct iwl_proto_offload_cmd_v3_small { 
/**

 * struct iwl_proto_offload_cmd_v3_large - ARP/NS offload configuration

 * @common: common/IPv4 configuration

 * @num_valid_ipv6_addrs: number of valid IPv6 addresses

 * @targ_addrs: target IPv6 addresses

 * @ns_config: NS offload configurations

 */

drivers/net/wireless/intel/iwlwifi/mvm/fw-api-mac.h

+2 −0
Original line number Diff line number Diff line
@@ -333,7 +333,9 @@ struct iwl_ac_qos { 
 * @mac_type: one of &enum iwl_mac_types

 * @tsf_id: TSF HW timer, one of &enum iwl_tsf_id

 * @node_addr: MAC address

 * @reserved_for_node_addr: reserved

 * @bssid_addr: BSSID

 * @reserved_for_bssid_addr: reserved

 * @cck_rates: basic rates available for CCK

 * @ofdm_rates: basic rates available for OFDM

 * @protection_flags: combination of &enum iwl_mac_protection_flags

drivers/net/wireless/intel/iwlwifi/mvm/fw-api-rs.h

+3 −0
Original line number Diff line number Diff line
@@ -368,6 +368,7 @@ enum { 
/**

 * struct iwl_lq_cmd - link quality command

 * @sta_id: station to update

 * @reduced_tpc: reduced transmit power control value

 * @control: not used

 * @flags: combination of LQ_FLAG_*

 * @mimo_delim: the first SISO index in rs_table, which separates MIMO
@@ -385,6 +386,7 @@ enum { 
 *	0: no limit

 *	1: no aggregation (one frame per aggregation)

 *	2 - 0x3f: maximal number of frames (up to 3f == 63)

 * @reserved2: reserved

 * @rs_table: array of rates for each TX try, each is rate_n_flags,

 *	meaning it is a combination of RATE_MCS_* and IWL_RATE_*_PLCP

 * @ss_params: single stream features. declare whether STBC or BFER are allowed.
@@ -407,4 +409,5 @@ struct iwl_lq_cmd { 
	__le32 rs_table[LQ_MAX_RETRY_NUM];

	__le32 ss_params;

}; /* LINK_QUALITY_CMD_API_S_VER_1 */



#endif /* __fw_api_rs_h__ */

drivers/net/wireless/intel/iwlwifi/mvm/fw-api-rx.h

+16 −17
Original line number Diff line number Diff line
@@ -90,7 +90,7 @@ enum iwl_mac_context_info { 
 * @non_cfg_phy_cnt: non configurable DSP phy data byte count

 * @cfg_phy_cnt: configurable DSP phy data byte count

 * @stat_id: configurable DSP phy data set ID

 * @reserved1:

 * @reserved1: reserved

 * @system_timestamp: GP2  at on air rise

 * @timestamp: TSF at on air rise

 * @beacon_time_stamp: beacon at on-air rise
@@ -158,10 +158,11 @@ struct iwl_rx_mpdu_res_start { 
/**

 * enum iwl_rx_phy_flags - to parse %iwl_rx_phy_info phy_flags

 * @RX_RES_PHY_FLAGS_BAND_24: true if the packet was received on 2.4 band

 * @RX_RES_PHY_FLAGS_MOD_CCK:

 * @RX_RES_PHY_FLAGS_MOD_CCK: modulation is CCK

 * @RX_RES_PHY_FLAGS_SHORT_PREAMBLE: true if packet's preamble was short

 * @RX_RES_PHY_FLAGS_NARROW_BAND:

 * @RX_RES_PHY_FLAGS_NARROW_BAND: narrow band (<20 MHz) receive

 * @RX_RES_PHY_FLAGS_ANTENNA: antenna on which the packet was received

 * @RX_RES_PHY_FLAGS_ANTENNA_POS: antenna bit position

 * @RX_RES_PHY_FLAGS_AGG: set if the packet was part of an A-MPDU

 * @RX_RES_PHY_FLAGS_OFDM_HT: The frame was an HT frame

 * @RX_RES_PHY_FLAGS_OFDM_GF: The frame used GF preamble
@@ -184,9 +185,9 @@ enum iwl_rx_phy_flags { 
 * enum iwl_mvm_rx_status - written by fw for each Rx packet

 * @RX_MPDU_RES_STATUS_CRC_OK: CRC is fine

 * @RX_MPDU_RES_STATUS_OVERRUN_OK: there was no RXE overflow

 * @RX_MPDU_RES_STATUS_SRC_STA_FOUND:

 * @RX_MPDU_RES_STATUS_KEY_VALID:

 * @RX_MPDU_RES_STATUS_KEY_PARAM_OK:

 * @RX_MPDU_RES_STATUS_SRC_STA_FOUND: station was found

 * @RX_MPDU_RES_STATUS_KEY_VALID: key was valid

 * @RX_MPDU_RES_STATUS_KEY_PARAM_OK: key parameters were usable

 * @RX_MPDU_RES_STATUS_ICV_OK: ICV is fine, if not, the packet is destroyed

 * @RX_MPDU_RES_STATUS_MIC_OK: used for CCM alg only. TKIP MIC is checked

 *	in the driver.
@@ -198,21 +199,21 @@ enum iwl_rx_phy_flags { 
 * @RX_MPDU_RES_STATUS_SEC_WEP_ENC: this frame is encrypted using WEP

 * @RX_MPDU_RES_STATUS_SEC_CCM_ENC: this frame is encrypted using CCM

 * @RX_MPDU_RES_STATUS_SEC_TKIP_ENC: this frame is encrypted using TKIP

 * @RX_MPDU_RES_STATUS_SEC_EXT_ENC: this frame is encrypted using extension

 *	algorithm

 * @RX_MPDU_RES_STATUS_SEC_CCM_CMAC_ENC: this frame is encrypted using CCM_CMAC

 * @RX_MPDU_RES_STATUS_SEC_ENC_ERR: this frame couldn't be decrypted

 * @RX_MPDU_RES_STATUS_SEC_ENC_MSK: bitmask of the encryption algorithm

 * @RX_MPDU_RES_STATUS_DEC_DONE: this frame has been successfully decrypted

 * @RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP:

 * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP:

 * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT:

 * @RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP: extended IV (set with TKIP)

 * @RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT: key ID comparison done

 * @RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME: this frame is an 11w management frame

 * @RX_MPDU_RES_STATUS_CSUM_DONE: checksum was done by the hw

 * @RX_MPDU_RES_STATUS_CSUM_OK: checksum found no errors

 * @RX_MPDU_RES_STATUS_HASH_INDEX_MSK:

 * @RX_MPDU_RES_STATUS_STA_ID_MSK:

 * @RX_MPDU_RES_STATUS_RRF_KILL:

 * @RX_MPDU_RES_STATUS_FILTERING_MSK:

 * @RX_MPDU_RES_STATUS2_FILTERING_MSK:

 * @RX_MPDU_RES_STATUS_STA_ID_MSK: station ID mask

 * @RX_MDPU_RES_STATUS_STA_ID_SHIFT: station ID bit shift

 * @RX_MPDU_RES_STATUS_FILTERING_MSK: filter status

 * @RX_MPDU_RES_STATUS2_FILTERING_MSK: filter status 2

 */

enum iwl_mvm_rx_status {

	RX_MPDU_RES_STATUS_CRC_OK			= BIT(0),
@@ -233,16 +234,13 @@ enum iwl_mvm_rx_status { 
	RX_MPDU_RES_STATUS_SEC_ENC_ERR			= (7 << 8),

	RX_MPDU_RES_STATUS_SEC_ENC_MSK			= (7 << 8),

	RX_MPDU_RES_STATUS_DEC_DONE			= BIT(11),

	RX_MPDU_RES_STATUS_PROTECT_FRAME_BIT_CMP	= BIT(12),

	RX_MPDU_RES_STATUS_EXT_IV_BIT_CMP		= BIT(13),

	RX_MPDU_RES_STATUS_KEY_ID_CMP_BIT		= BIT(14),

	RX_MPDU_RES_STATUS_ROBUST_MNG_FRAME		= BIT(15),

	RX_MPDU_RES_STATUS_CSUM_DONE			= BIT(16),

	RX_MPDU_RES_STATUS_CSUM_OK			= BIT(17),

	RX_MPDU_RES_STATUS_HASH_INDEX_MSK		= (0x3F0000),

	RX_MDPU_RES_STATUS_STA_ID_SHIFT			= 24,

	RX_MPDU_RES_STATUS_STA_ID_MSK			= 0x1f << RX_MDPU_RES_STATUS_STA_ID_SHIFT,

	RX_MPDU_RES_STATUS_RRF_KILL			= BIT(29),

	RX_MPDU_RES_STATUS_FILTERING_MSK		= (0xc00000),

	RX_MPDU_RES_STATUS2_FILTERING_MSK		= (0xc0000000),

};
@@ -476,6 +474,7 @@ enum iwl_rss_hash_func_en { 
 *

 * @flags: 1 - enable, 0 - disable

 * @hash_mask: Type of RSS to use. Values are from %iwl_rss_hash_func_en

 * @reserved: reserved

 * @secret_key: 320 bit input of random key configuration from driver

 * @indirection_table: indirection table

 */