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

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

iwlwifi: mvm: add documentation links to various fields 



Link various fields to the documentation of the enums that
define their values.

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

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

+5 −5
Original line number Diff line number Diff line
@@ -99,8 +99,8 @@ enum iwl_bt_coex_enabled_modules { 


/**

 * struct iwl_bt_coex_cmd - bt coex configuration command

 * @mode: enum %iwl_bt_coex_mode

 * @enabled_modules: enum %iwl_bt_coex_enabled_modules

 * @mode: &enum iwl_bt_coex_mode

 * @enabled_modules: &enum iwl_bt_coex_enabled_modules

 *

 * The structure is used for the BT_COEX command.

 */
@@ -234,9 +234,9 @@ enum iwl_bt_ci_compliance { 
 * @mbox_msg: message from BT to WiFi

 * @msg_idx: the index of the message

 * @bt_ci_compliance: enum %iwl_bt_ci_compliance

 * @primary_ch_lut: LUT used for primary channel enum %iwl_bt_coex_lut_type

 * @secondary_ch_lut: LUT used for secondary channel enume %iwl_bt_coex_lut_type

 * @bt_activity_grading: the activity of BT enum %iwl_bt_activity_grading

 * @primary_ch_lut: LUT used for primary channel &enum iwl_bt_coex_lut_type

 * @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

 */

struct iwl_bt_coex_profile_notif {

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

+5 −5
Original line number Diff line number Diff line
@@ -329,17 +329,17 @@ struct iwl_ac_qos { 
 * ( MAC_CONTEXT_CMD = 0x28 )

 * @id_and_color: ID and color of the MAC

 * @action: action to perform, one of FW_CTXT_ACTION_*

 * @mac_type: one of FW_MAC_TYPE_*

 * @tsd_id: TSF HW timer, one of TSF_ID_*

 * @mac_type: one of &enum iwl_mac_types

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

 * @node_addr: MAC address

 * @bssid_addr: BSSID

 * @cck_rates: basic rates available for CCK

 * @ofdm_rates: basic rates available for OFDM

 * @protection_flags: combination of MAC_PROT_FLG_FLAG_*

 * @protection_flags: combination of &enum iwl_mac_protection_flags

 * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise

 * @short_slot: 0x10 for enabling short slots, 0 otherwise

 * @filter_flags: combination of MAC_FILTER_*

 * @qos_flags: from MAC_QOS_FLG_*

 * @filter_flags: combination of &enum iwl_mac_filter_flags

 * @qos_flags: from &enum iwl_mac_qos_flags

 * @ac: one iwl_mac_qos configuration for each AC

 * @mac_specific: one of struct iwl_mac_data_*, according to mac_type

 */

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

+2 −2
Original line number Diff line number Diff line
@@ -202,7 +202,7 @@ enum iwl_device_power_flags { 
 * struct iwl_device_power_cmd - device wide power command.

 * DEVICE_POWER_CMD = 0x77 (command, has simple generic response)

 *

 * @flags:	Power table command flags from DEVICE_POWER_FLAGS_*

 * @flags:	Power table command flags from &enum iwl_device_power_flags

 */

struct iwl_device_power_cmd {

	/* PM_POWER_TABLE_CMD_API_S_VER_6 */
@@ -213,7 +213,7 @@ struct iwl_device_power_cmd { 
/**

 * struct iwl_mac_power_cmd - New power command containing uAPSD support

 * MAC_PM_POWER_TABLE = 0xA9 (command, has simple generic response)

 * @id_and_color:	MAC contex identifier

 * @id_and_color:	MAC contex identifier, &enum iwl_mvm_id_and_color

 * @flags:		Power table command flags from POWER_FLAGS_*

 * @keep_alive_seconds:	Keep alive period in seconds. Default - 25 sec.

 *			Minimum allowed:- 3 * DTIM. Keep alive period must be

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

+8 −6
Original line number Diff line number Diff line
@@ -253,11 +253,12 @@ struct iwl_mvm_keyinfo { 
/**

 * struct iwl_mvm_add_sta_cmd_v7 - Add/modify a station in the fw's sta table.

 * ( REPLY_ADD_STA = 0x18 )

 * @add_modify: 1: modify existing, 0: add new station

 * @add_modify: see &enum iwl_sta_mode

 * @awake_acs:

 * @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable

 *	AMPDU for tid x. Set %STA_MODIFY_TID_DISABLE_TX to change this field.

 * @mac_id_n_color: the Mac context this station belongs to

 * @mac_id_n_color: the Mac context this station belongs to,

 *	see &enum iwl_mvm_id_and_color

 * @addr: station's MAC address

 * @sta_id: index of station in uCode's station table

 * @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave
@@ -331,11 +332,12 @@ enum iwl_sta_type { 
/**

 * struct iwl_mvm_add_sta_cmd - Add/modify a station in the fw's sta table.

 * ( REPLY_ADD_STA = 0x18 )

 * @add_modify: 1: modify existing, 0: add new station

 * @add_modify: see &enum iwl_sta_mode

 * @awake_acs:

 * @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable

 *	AMPDU for tid x. Set %STA_MODIFY_TID_DISABLE_TX to change this field.

 * @mac_id_n_color: the Mac context this station belongs to

 * @mac_id_n_color: the Mac context this station belongs to,

 *	see &enum iwl_mvm_id_and_color

 * @addr: station's MAC address

 * @sta_id: index of station in uCode's station table

 * @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave
@@ -470,7 +472,7 @@ struct iwl_mvm_rm_sta_cmd { 
/**

 * struct iwl_mvm_mgmt_mcast_key_cmd_v1

 * ( MGMT_MCAST_KEY = 0x1f )

 * @ctrl_flags: %iwl_sta_key_flag

 * @ctrl_flags: &enum iwl_sta_key_flag

 * @igtk:

 * @k1: unused

 * @k2: unused
@@ -491,7 +493,7 @@ struct iwl_mvm_mgmt_mcast_key_cmd_v1 { 
/**

 * struct iwl_mvm_mgmt_mcast_key_cmd

 * ( MGMT_MCAST_KEY = 0x1f )

 * @ctrl_flags: %iwl_sta_key_flag

 * @ctrl_flags: &enum iwl_sta_key_flag

 * @igtk: IGTK master key

 * @sta_id: station ID that support IGTK

 * @key_id:

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

+4 −0
Original line number Diff line number Diff line
@@ -326,6 +326,10 @@ struct iwl_notif_statistics_cdb { 
#define IWL_STATISTICS_FLG_CLEAR		0x1

#define IWL_STATISTICS_FLG_DISABLE_NOTIF	0x2



/**

 * struct iwl_statistics_cmd - statistics config command

 * @flags: flags from &enum iwl_statistics_flags

 */

struct iwl_statistics_cmd {

	__le32 flags;

} __packed; /* STATISTICS_CMD_API_S_VER_1 */