hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

iwlwifi: mvm: add documentation links to various fields 

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

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Luca Coelho <luciano.coelho@intel.com>
This commit is contained in:
Johannes Berg 2017-03-14 11:01:27 +01:00 committed by Luca Coelho
parent 31a658b2af
commit 6762586517
7 changed files with 45 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -99,8 +99,8 @@ enum iwl_bt_coex_enabled_modules {
/** /**
* struct iwl_bt_coex_cmd - bt coex configuration command * struct iwl_bt_coex_cmd - bt coex configuration command
* @mode: enum %iwl_bt_coex_mode * @mode: &enum iwl_bt_coex_mode
* @enabled_modules: enum %iwl_bt_coex_enabled_modules * @enabled_modules: &enum iwl_bt_coex_enabled_modules
* *
* The structure is used for the BT_COEX command. * 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 * @mbox_msg: message from BT to WiFi
* @msg_idx: the index of the message * @msg_idx: the index of the message
* @bt_ci_compliance: enum %iwl_bt_ci_compliance * @bt_ci_compliance: enum %iwl_bt_ci_compliance
* @primary_ch_lut: LUT used for primary channel enum %iwl_bt_coex_lut_type * @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 * @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 * @bt_activity_grading: the activity of BT &enum iwl_bt_activity_grading
* @ttc_rrc_status: is TTC or RRC enabled - one bit per PHY * @ttc_rrc_status: is TTC or RRC enabled - one bit per PHY
*/ */
struct iwl_bt_coex_profile_notif { struct iwl_bt_coex_profile_notif {

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

@ -329,17 +329,17 @@ struct iwl_ac_qos {
* ( MAC_CONTEXT_CMD = 0x28 ) * ( MAC_CONTEXT_CMD = 0x28 )
* @id_and_color: ID and color of the MAC * @id_and_color: ID and color of the MAC
* @action: action to perform, one of FW_CTXT_ACTION_* * @action: action to perform, one of FW_CTXT_ACTION_*
* @mac_type: one of FW_MAC_TYPE_* * @mac_type: one of &enum iwl_mac_types
* @tsd_id: TSF HW timer, one of TSF_ID_* * @tsd_id: TSF HW timer, one of &enum iwl_tsf_id
* @node_addr: MAC address * @node_addr: MAC address
* @bssid_addr: BSSID * @bssid_addr: BSSID
* @cck_rates: basic rates available for CCK * @cck_rates: basic rates available for CCK
* @ofdm_rates: basic rates available for OFDM * @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 * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
* @short_slot: 0x10 for enabling short slots, 0 otherwise * @short_slot: 0x10 for enabling short slots, 0 otherwise
* @filter_flags: combination of MAC_FILTER_* * @filter_flags: combination of &enum iwl_mac_filter_flags
* @qos_flags: from MAC_QOS_FLG_* * @qos_flags: from &enum iwl_mac_qos_flags
* @ac: one iwl_mac_qos configuration for each AC * @ac: one iwl_mac_qos configuration for each AC
* @mac_specific: one of struct iwl_mac_data_*, according to mac_type * @mac_specific: one of struct iwl_mac_data_*, according to mac_type
*/ */

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

@ -202,7 +202,7 @@ enum iwl_device_power_flags {
* struct iwl_device_power_cmd - device wide power command. * struct iwl_device_power_cmd - device wide power command.
* DEVICE_POWER_CMD = 0x77 (command, has simple generic response) * 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 { struct iwl_device_power_cmd {
/* PM_POWER_TABLE_CMD_API_S_VER_6 */ /* 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 * struct iwl_mac_power_cmd - New power command containing uAPSD support
* MAC_PM_POWER_TABLE = 0xA9 (command, has simple generic response) * 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_* * @flags: Power table command flags from POWER_FLAGS_*
* @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec. * @keep_alive_seconds: Keep alive period in seconds. Default - 25 sec.
* Minimum allowed:- 3 * DTIM. Keep alive period must be * Minimum allowed:- 3 * DTIM. Keep alive period must be

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

@ -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. * struct iwl_mvm_add_sta_cmd_v7 - Add/modify a station in the fw's sta table.
* ( REPLY_ADD_STA = 0x18 ) * ( REPLY_ADD_STA = 0x18 )
* @add_modify: 1: modify existing, 0: add new station * @add_modify: see &enum iwl_sta_mode
* @awake_acs: * @awake_acs:
* @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable * @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. * 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 * @addr: station's MAC address
* @sta_id: index of station in uCode's station table * @sta_id: index of station in uCode's station table
* @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave * @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. * struct iwl_mvm_add_sta_cmd - Add/modify a station in the fw's sta table.
* ( REPLY_ADD_STA = 0x18 ) * ( REPLY_ADD_STA = 0x18 )
* @add_modify: 1: modify existing, 0: add new station * @add_modify: see &enum iwl_sta_mode
* @awake_acs: * @awake_acs:
* @tid_disable_tx: is tid BIT(tid) enabled for Tx. Clear BIT(x) to enable * @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. * 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 * @addr: station's MAC address
* @sta_id: index of station in uCode's station table * @sta_id: index of station in uCode's station table
* @modify_mask: STA_MODIFY_*, selects which parameters to modify vs. leave * @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 * struct iwl_mvm_mgmt_mcast_key_cmd_v1
* ( MGMT_MCAST_KEY = 0x1f ) * ( MGMT_MCAST_KEY = 0x1f )
* @ctrl_flags: %iwl_sta_key_flag * @ctrl_flags: &enum iwl_sta_key_flag
* @igtk: * @igtk:
* @k1: unused * @k1: unused
* @k2: unused * @k2: unused
@ -491,7 +493,7 @@ struct iwl_mvm_mgmt_mcast_key_cmd_v1 {
/** /**
* struct iwl_mvm_mgmt_mcast_key_cmd * struct iwl_mvm_mgmt_mcast_key_cmd
* ( MGMT_MCAST_KEY = 0x1f ) * ( MGMT_MCAST_KEY = 0x1f )
* @ctrl_flags: %iwl_sta_key_flag * @ctrl_flags: &enum iwl_sta_key_flag
* @igtk: IGTK master key * @igtk: IGTK master key
* @sta_id: station ID that support IGTK * @sta_id: station ID that support IGTK
* @key_id: * @key_id:

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

@ -326,6 +326,10 @@ struct iwl_notif_statistics_cdb {
#define IWL_STATISTICS_FLG_CLEAR 0x1 #define IWL_STATISTICS_FLG_CLEAR 0x1
#define IWL_STATISTICS_FLG_DISABLE_NOTIF 0x2 #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 { struct iwl_statistics_cmd {
__le32 flags; __le32 flags;
} __packed; /* STATISTICS_CMD_API_S_VER_1 */ } __packed; /* STATISTICS_CMD_API_S_VER_1 */

4
drivers/net/wireless/intel/iwlwifi/mvm/fw-api-tx.h
View File

@ -828,9 +828,9 @@ enum iwl_scd_cfg_actions {
* @tid: TID * @tid: TID
* @scd_queue: scheduler queue to confiug * @scd_queue: scheduler queue to confiug
* @action: 1 queue enable, 0 queue disable, 2 change txq's tid owner * @action: 1 queue enable, 0 queue disable, 2 change txq's tid owner
* Value is one of %iwl_scd_cfg_actions options * Value is one of &enum iwl_scd_cfg_actions options
* @aggregate: 1 aggregated queue, 0 otherwise * @aggregate: 1 aggregated queue, 0 otherwise
* @tx_fifo: %enum iwl_mvm_tx_fifo * @tx_fifo: &enum iwl_mvm_tx_fifo
* @window: BA window size * @window: BA window size
* @ssn: SSN for the BA agreement * @ssn: SSN for the BA agreement
* @reserved: reserved * @reserved: reserved

31
drivers/net/wireless/intel/iwlwifi/mvm/fw-api.h
View File

@ -491,10 +491,10 @@ enum {
}; };
/** /**
* struct iwl_nvm_access_cmd_ver2 - Request the device to send an NVM section * struct iwl_nvm_access_cmd - Request the device to send an NVM section
* @op_code: 0 - read, 1 - write * @op_code: &enum iwl_nvm_access_op
* @target: NVM_ACCESS_TARGET_* * @target: &enum iwl_nvm_access_target
* @type: NVM_SECTION_TYPE_* * @type: &enum iwl_nvm_section_type
* @offset: offset in bytes into the section * @offset: offset in bytes into the section
* @length: in bytes, to read/write * @length: in bytes, to read/write
* @data: if write operation, the data to write. On read its empty * @data: if write operation, the data to write. On read its empty
@ -918,12 +918,13 @@ enum {
}; };
/** /**
* struct iwl_time_event_cmd_api - configuring Time Events * struct iwl_time_event_cmd - configuring Time Events
* with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also * with struct MAC_TIME_EVENT_DATA_API_S_VER_2 (see also
* with version 1. determined by IWL_UCODE_TLV_FLAGS) * with version 1. determined by IWL_UCODE_TLV_FLAGS)
* ( TIME_EVENT_CMD = 0x29 ) * ( TIME_EVENT_CMD = 0x29 )
* @id_and_color: ID and color of the relevant MAC * @id_and_color: ID and color of the relevant MAC,
* @action: action to perform, one of FW_CTXT_ACTION_* * &enum iwl_mvm_id_and_color
* @action: action to perform, one of &enum iwl_phy_ctxt_action
* @id: this field has two meanings, depending on the action: * @id: this field has two meanings, depending on the action:
* If the action is ADD, then it means the type of event to add. * If the action is ADD, then it means the type of event to add.
* For all other actions it is the unique event ID assigned when the * For all other actions it is the unique event ID assigned when the
@ -939,7 +940,8 @@ enum {
* on event and/or fragment start and/or end * on event and/or fragment start and/or end
* using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF * using one of TE_INDEPENDENT, TE_DEP_OTHER, TE_DEP_TSF
* TE_EVENT_SOCIOPATHIC * TE_EVENT_SOCIOPATHIC
* using TE_ABSENCE and using TE_NOTIF_* * using TE_ABSENCE and using TE_NOTIF_*,
* &enum iwl_time_event_policy
*/ */
struct iwl_time_event_cmd { struct iwl_time_event_cmd {
/* COMMON_INDEX_HDR_API_S_VER_1 */ /* COMMON_INDEX_HDR_API_S_VER_1 */
@ -962,7 +964,8 @@ struct iwl_time_event_cmd {
* @status: bit 0 indicates success, all others specify errors * @status: bit 0 indicates success, all others specify errors
* @id: the Time Event type * @id: the Time Event type
* @unique_id: the unique ID assigned (in ADD) or given (others) to the TE * @unique_id: the unique ID assigned (in ADD) or given (others) to the TE
* @id_and_color: ID and color of the relevant MAC * @id_and_color: ID and color of the relevant MAC,
* &enum iwl_mvm_id_and_color
*/ */
struct iwl_time_event_resp { struct iwl_time_event_resp {
__le32 status; __le32 status;
@ -978,7 +981,7 @@ struct iwl_time_event_resp {
* @session_id: session's unique id * @session_id: session's unique id
* @unique_id: unique id of the Time Event itself * @unique_id: unique id of the Time Event itself
* @id_and_color: ID and color of the relevant MAC * @id_and_color: ID and color of the relevant MAC
* @action: one of TE_NOTIF_START or TE_NOTIF_END * @action: &enum iwl_time_event_policy
* @status: true if scheduled, false otherwise (not executed) * @status: true if scheduled, false otherwise (not executed)
*/ */
struct iwl_time_event_notif { struct iwl_time_event_notif {
@ -996,10 +999,13 @@ struct iwl_time_event_notif {
/** /**
* struct iwl_binding_cmd - configuring bindings * struct iwl_binding_cmd - configuring bindings
* ( BINDING_CONTEXT_CMD = 0x2b ) * ( BINDING_CONTEXT_CMD = 0x2b )
* @id_and_color: ID and color of the relevant Binding * @id_and_color: ID and color of the relevant Binding,
* &enum iwl_mvm_id_and_color
* @action: action to perform, one of FW_CTXT_ACTION_* * @action: action to perform, one of FW_CTXT_ACTION_*
* @macs: array of MAC id and colors which belong to the binding * @macs: array of MAC id and colors which belong to the binding
* &enum iwl_mvm_id_and_color
* @phy: PHY id and color which belongs to the binding * @phy: PHY id and color which belongs to the binding
* &enum iwl_mvm_id_and_color
* @lmac_id: the lmac id the binding belongs to * @lmac_id: the lmac id the binding belongs to
*/ */
struct iwl_binding_cmd { struct iwl_binding_cmd {
@ -1022,7 +1028,8 @@ struct iwl_binding_cmd {
/** /**
* struct iwl_time_quota_data - configuration of time quota per binding * struct iwl_time_quota_data - configuration of time quota per binding
* @id_and_color: ID and color of the relevant Binding * @id_and_color: ID and color of the relevant Binding,
* &enum iwl_mvm_id_and_color
* @quota: absolute time quota in TU. The scheduler will try to divide the * @quota: absolute time quota in TU. The scheduler will try to divide the
* remainig quota (after Time Events) according to this quota. * remainig quota (after Time Events) according to this quota.
* @max_duration: max uninterrupted context duration in TU * @max_duration: max uninterrupted context duration in TU