Commit 59505471 authored by Johannes Berg's avatar Johannes Berg
Browse files

wifi: iwlwifi: api: link context action in kernel-doc 



This is clearer in kernel-doc than spelling out the prefix.
It also lets us generate better tracing data.

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/20230601171633.e11ece794f60.I9874c7b0437071a2620d68ca5a16efed60da07a9@changeid


Signed-off-by: default avatarJohannes Berg <johannes.berg@intel.com>
parent 4c8d5c8d

drivers/net/wireless/intel/iwlwifi/fw/api/binding.h

+3 −3
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */

/*

 * Copyright (C) 2012-2014, 2020 Intel Corporation

 * Copyright (C) 2012-2014, 2020, 2022 Intel Corporation

 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH

 * Copyright (C) 2016-2017 Intel Deutschland GmbH

 */
@@ -18,7 +18,7 @@ 
 * ( BINDING_CONTEXT_CMD = 0x2b )

 * @id_and_color: ID and color of the relevant Binding,

 *	&enum iwl_ctxt_id_and_color

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @macs: array of MAC id and colors which belong to the binding,

 *	&enum iwl_ctxt_id_and_color

 * @phy: PHY id and color which belongs to the binding,
@@ -38,7 +38,7 @@ struct iwl_binding_cmd_v1 { 
 * ( BINDING_CONTEXT_CMD = 0x2b )

 * @id_and_color: ID and color of the relevant Binding,

 *	&enum iwl_ctxt_id_and_color

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @macs: array of MAC id and colors which belong to the binding

 *	&enum iwl_ctxt_id_and_color

 * @phy: PHY id and color which belongs to the binding

drivers/net/wireless/intel/iwlwifi/fw/api/context.h

+9 −4
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */

/*

 * Copyright (C) 2012-2014 Intel Corporation

 * Copyright (C) 2012-2014, 2022 Intel Corporation

 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH

 * Copyright (C) 2016-2017 Intel Deutschland GmbH

 */
@@ -26,13 +26,18 @@ enum iwl_ctxt_id_and_color { 
#define FW_CMD_ID_AND_COLOR(_id, _color) (((_id) << FW_CTXT_ID_POS) |\

					  ((_color) << FW_CTXT_COLOR_POS))



/* Possible actions on PHYs, MACs and Bindings */

/**

 * enum iwl_ctxt_action - Posssible actions on PHYs, MACs, Bindings and other

 * @FW_CTXT_ACTION_INVALID: unused, invalid action

 * @FW_CTXT_ACTION_ADD: add the context

 * @FW_CTXT_ACTION_MODIFY: modify the context

 * @FW_CTXT_ACTION_REMOVE: remove the context

 */

enum iwl_ctxt_action {

	FW_CTXT_ACTION_STUB = 0,

	FW_CTXT_ACTION_INVALID = 0,

	FW_CTXT_ACTION_ADD,

	FW_CTXT_ACTION_MODIFY,

	FW_CTXT_ACTION_REMOVE,

	FW_CTXT_ACTION_NUM

}; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */



#endif /* __iwl_fw_api_context_h__ */

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

+3 −3
Original line number Diff line number Diff line
@@ -193,7 +193,7 @@ struct iwl_cancel_channel_switch_cmd { 
 * struct iwl_chan_switch_te_cmd - Channel Switch Time Event command

 *

 * @mac_id: MAC ID for channel switch

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @tsf: beacon tsf

 * @cs_count: channel switch count from CSA/eCSA IE

 * @cs_delayed_bcn_count: if set to N (!= 0) GO/AP can delay N beacon intervals
@@ -296,7 +296,7 @@ enum iwl_mac_config_filter_flags { 
 * ( MAC_CONTEXT_CONFIG_CMD = 0x8 )

 *

 * @id_and_color: ID and color of the MAC

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @mac_type: one of &enum iwl_mac_types

 * @local_mld_addr: mld address

 * @reserved_for_local_mld_addr: reserved
@@ -423,7 +423,7 @@ enum iwl_link_ctx_flags { 
 *	in MLD API

 * ( LINK_CONFIG_CMD =0x9 )

 *

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @link_id: the id of the link that this cmd configures

 * @mac_id: interface ID. Relevant only if action is FW_CTXT_ACTION_ADD

 * @phy_id: PHY index. Can be changed only if the link was inactive

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

+1 −1
Original line number Diff line number Diff line
@@ -295,7 +295,7 @@ struct iwl_ac_qos { 
 * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts

 * ( MAC_CONTEXT_CMD = 0x28 )

 * @id_and_color: ID and color of the MAC

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @mac_type: one of &enum iwl_mac_types

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

 * @node_addr: MAC address

drivers/net/wireless/intel/iwlwifi/fw/api/phy-ctxt.h

+3 −3
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */

/*

 * Copyright (C) 2012-2014, 2018, 2020-2021 Intel Corporation

 * Copyright (C) 2012-2014, 2018, 2020-2022 Intel Corporation

 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH

 * Copyright (C) 2016-2017 Intel Deutschland GmbH

 */
@@ -116,7 +116,7 @@ struct iwl_phy_context_cmd_tail { 
 * struct iwl_phy_context_cmd - config of the PHY context

 * ( PHY_CONTEXT_CMD = 0x8 )

 * @id_and_color: ID and color of the relevant Binding

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @apply_time: 0 means immediate apply and context switch.

 *	other value means apply new params after X usecs

 * @tx_param_color: ???
@@ -138,7 +138,7 @@ struct iwl_phy_context_cmd_v1 { 
 * struct iwl_phy_context_cmd - config of the PHY context

 * ( PHY_CONTEXT_CMD = 0x8 )

 * @id_and_color: ID and color of the relevant Binding

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

 * @action: action to perform, see &enum iwl_ctxt_action

 * @lmac_id: the lmac id the phy context belongs to

 * @ci: channel info

 * @rxchain_info: ???