xref: /linux/drivers/net/wireless/intel/iwlwifi/mld/iface.h (revision ccde82e909467abdf098a8ee6f63e1ecf9a47ce5)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2024-2025 Intel Corporation
4  */
5 #ifndef __iwl_mld_iface_h__
6 #define __iwl_mld_iface_h__
7 
8 #include <net/mac80211.h>
9 
10 #include "link.h"
11 #include "session-protect.h"
12 #include "d3.h"
13 #include "fw/api/time-event.h"
14 
15 enum iwl_mld_cca_40mhz_wa_status {
16 	CCA_40_MHZ_WA_NONE,
17 	CCA_40_MHZ_WA_RESET,
18 	CCA_40_MHZ_WA_RECONNECT,
19 };
20 
21 /**
22  * enum iwl_mld_emlsr_blocked - defines reasons for which EMLSR is blocked
23  *
24  * These blocks are applied/stored per-VIF.
25  *
26  * @IWL_MLD_EMLSR_BLOCKED_PREVENTION: Prevent repeated EMLSR enter/exit
27  * @IWL_MLD_EMLSR_BLOCKED_WOWLAN: WOWLAN is preventing EMLSR
28  * @IWL_MLD_EMLSR_BLOCKED_ROC: remain-on-channel is preventing EMLSR
29  * @IWL_MLD_EMLSR_BLOCKED_NON_BSS: An active non-BSS interface's link is
30  *      preventing EMLSR
31  * @IWL_MLD_EMLSR_BLOCKED_TMP_NON_BSS: An expected active non-BSS interface's
32  *      link is preventing EMLSR. This is a temporary blocking that is set when
33  *      there is an indication that a non-BSS interface is to be added.
34  * @IWL_MLD_EMLSR_BLOCKED_TPT: throughput is too low to make EMLSR worthwhile
35  */
36 enum iwl_mld_emlsr_blocked {
37 	IWL_MLD_EMLSR_BLOCKED_PREVENTION	= 0x1,
38 	IWL_MLD_EMLSR_BLOCKED_WOWLAN		= 0x2,
39 	IWL_MLD_EMLSR_BLOCKED_ROC		= 0x4,
40 	IWL_MLD_EMLSR_BLOCKED_NON_BSS		= 0x8,
41 	IWL_MLD_EMLSR_BLOCKED_TMP_NON_BSS	= 0x10,
42 	IWL_MLD_EMLSR_BLOCKED_TPT		= 0x20,
43 };
44 
45 /**
46  * enum iwl_mld_emlsr_exit - defines reasons for exiting EMLSR
47  *
48  * Reasons to exit EMLSR may be either link specific or even specific to a
49  * combination of links.
50  *
51  * @IWL_MLD_EMLSR_EXIT_BLOCK: Exit due to a block reason being set
52  * @IWL_MLD_EMLSR_EXIT_MISSED_BEACON: Exit due to missed beacons
53  * @IWL_MLD_EMLSR_EXIT_FAIL_ENTRY: FW failed to enter EMLSR
54  * @IWL_MLD_EMLSR_EXIT_CSA: EMLSR prevented due to channel switch on link
55  * @IWL_MLD_EMLSR_EXIT_EQUAL_BAND: EMLSR prevented as both links share the band
56  * @IWL_MLD_EMLSR_EXIT_LOW_RSSI: Link RSSI is unsuitable for EMLSR
57  * @IWL_MLD_EMLSR_EXIT_LINK_USAGE: Exit EMLSR due to low TPT on secondary link
58  * @IWL_MLD_EMLSR_EXIT_BT_COEX: Exit EMLSR due to BT coexistence
59  * @IWL_MLD_EMLSR_EXIT_CHAN_LOAD: Exit EMLSR because the primary channel is not
60  *	loaded enough to justify EMLSR.
61  * @IWL_MLD_EMLSR_EXIT_RFI: Exit EMLSR due to RFI
62  * @IWL_MLD_EMLSR_EXIT_FW_REQUEST: Exit EMLSR because the FW requested it
63  * @IWL_MLD_EMLSR_EXIT_INVALID: internal exit reason due to invalid data
64  */
65 enum iwl_mld_emlsr_exit {
66 	IWL_MLD_EMLSR_EXIT_BLOCK		= 0x1,
67 	IWL_MLD_EMLSR_EXIT_MISSED_BEACON	= 0x2,
68 	IWL_MLD_EMLSR_EXIT_FAIL_ENTRY		= 0x4,
69 	IWL_MLD_EMLSR_EXIT_CSA			= 0x8,
70 	IWL_MLD_EMLSR_EXIT_EQUAL_BAND		= 0x10,
71 	IWL_MLD_EMLSR_EXIT_LOW_RSSI		= 0x20,
72 	IWL_MLD_EMLSR_EXIT_LINK_USAGE		= 0x40,
73 	IWL_MLD_EMLSR_EXIT_BT_COEX		= 0x80,
74 	IWL_MLD_EMLSR_EXIT_CHAN_LOAD		= 0x100,
75 	IWL_MLD_EMLSR_EXIT_RFI			= 0x200,
76 	IWL_MLD_EMLSR_EXIT_FW_REQUEST		= 0x400,
77 	IWL_MLD_EMLSR_EXIT_INVALID		= 0x800,
78 };
79 
80 /**
81  * struct iwl_mld_emlsr - per-VIF data about EMLSR operation
82  *
83  * @primary: The current primary link
84  * @selected_primary: Primary link as selected during the last link selection
85  * @selected_links: Links as selected during the last link selection
86  * @blocked_reasons: Reasons preventing EMLSR from being enabled
87  * @last_exit_reason: Reason for the last EMLSR exit
88  * @last_exit_ts: Time of the last EMLSR exit (if @last_exit_reason is non-zero)
89  * @exit_repeat_count: Number of times EMLSR was exited for the same reason
90  * @last_entry_ts: the time of the last EMLSR entry (if iwl_mld_emlsr_active()
91  *	is true)
92  * @unblock_tpt_wk: Unblock EMLSR because the throughput limit was reached
93  * @check_tpt_wk: a worker to check if IWL_MLD_EMLSR_BLOCKED_TPT should be
94  *	added, for example if there is no longer enough traffic.
95  * @prevent_done_wk: Worker to remove %IWL_MLD_EMLSR_BLOCKED_PREVENTION
96  * @tmp_non_bss_done_wk: Worker to remove %IWL_MLD_EMLSR_BLOCKED_TMP_NON_BSS
97  */
98 struct iwl_mld_emlsr {
99 	struct_group(zeroed_on_not_authorized,
100 		u8 primary;
101 
102 		u8 selected_primary;
103 		u16 selected_links;
104 
105 		enum iwl_mld_emlsr_blocked blocked_reasons;
106 
107 		enum iwl_mld_emlsr_exit last_exit_reason;
108 		unsigned long last_exit_ts;
109 		u8 exit_repeat_count;
110 		unsigned long last_entry_ts;
111 	);
112 
113 	struct wiphy_work unblock_tpt_wk;
114 	struct wiphy_delayed_work check_tpt_wk;
115 
116 	struct wiphy_delayed_work prevent_done_wk;
117 	struct wiphy_delayed_work tmp_non_bss_done_wk;
118 };
119 
120 /**
121  * struct iwl_mld_vif - virtual interface (MAC context) configuration parameters
122  *
123  * @fw_id: fw id of the mac context.
124  * @session_protect: session protection parameters
125  * @ap_sta: pointer to AP sta, for easier access to it.
126  *	Relevant only for STA vifs.
127  * @authorized: indicates the AP station was set to authorized
128  * @num_associated_stas: number of associated STAs. Relevant only for AP mode.
129  * @ap_ibss_active: whether the AP/IBSS was started
130  * @cca_40mhz_workaround: When we are connected in 2.4 GHz and 40 MHz, and the
131  *	environment is too loaded, we work around this by reconnecting to the
132  *	same AP with 20 MHz. This manages the status of the workaround.
133  * @beacon_inject_active: indicates an active debugfs beacon ie injection
134  * @low_latency_causes: bit flags, indicating the causes for low-latency,
135  *	see @iwl_mld_low_latency_cause.
136  * @ps_disabled: indicates that PS is disabled for this interface
137  * @last_link_activation_time: last time a link was activated, for
138  *	deferring MLO scans (to make them more reliable)
139  * @mld: pointer to the mld structure.
140  * @deflink: default link data, for use in non-MLO,
141  * @link: reference to link data for each valid link, for use in MLO.
142  * @emlsr: information related to EMLSR
143  * @wowlan_data: data used by the wowlan suspend flow
144  * @use_ps_poll: use ps_poll frames
145  * @disable_bf: disable beacon filter
146  * @dbgfs_slink: debugfs symlink for this interface
147  * @roc_activity: the id of the roc_activity running. Relevant for STA and
148  *	p2p device only. Set to %ROC_NUM_ACTIVITIES when not in use.
149  * @aux_sta: station used for remain on channel. Used in P2P device.
150  * @mlo_scan_start_wk: worker to start a deferred MLO scan
151  */
152 struct iwl_mld_vif {
153 	/* Add here fields that need clean up on restart */
154 	struct_group(zeroed_on_hw_restart,
155 		u8 fw_id;
156 		struct iwl_mld_session_protect session_protect;
157 		struct ieee80211_sta *ap_sta;
158 		bool authorized;
159 		u8 num_associated_stas;
160 		bool ap_ibss_active;
161 		enum iwl_mld_cca_40mhz_wa_status cca_40mhz_workaround;
162 #ifdef CONFIG_IWLWIFI_DEBUGFS
163 		bool beacon_inject_active;
164 #endif
165 		u8 low_latency_causes;
166 		bool ps_disabled;
167 		time64_t last_link_activation_time;
168 	);
169 	/* And here fields that survive a fw restart */
170 	struct iwl_mld *mld;
171 	struct iwl_mld_link deflink;
172 	struct iwl_mld_link __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
173 
174 	struct iwl_mld_emlsr emlsr;
175 
176 #ifdef CONFIG_PM_SLEEP
177 	struct iwl_mld_wowlan_data wowlan_data;
178 #endif
179 #ifdef CONFIG_IWLWIFI_DEBUGFS
180 	bool use_ps_poll;
181 	bool disable_bf;
182 	struct dentry *dbgfs_slink;
183 #endif
184 	enum iwl_roc_activity roc_activity;
185 	struct iwl_mld_int_sta aux_sta;
186 
187 	struct wiphy_delayed_work mlo_scan_start_wk;
188 };
189 
190 static inline struct iwl_mld_vif *
191 iwl_mld_vif_from_mac80211(struct ieee80211_vif *vif)
192 {
193 	return (void *)vif->drv_priv;
194 }
195 
196 static inline struct ieee80211_vif *
197 iwl_mld_vif_to_mac80211(struct iwl_mld_vif *mld_vif)
198 {
199 	return container_of((void *)mld_vif, struct ieee80211_vif, drv_priv);
200 }
201 
202 #define iwl_mld_link_dereference_check(mld_vif, link_id)		\
203 	rcu_dereference_check((mld_vif)->link[link_id],			\
204 			      lockdep_is_held(&mld_vif->mld->wiphy->mtx))
205 
206 #define for_each_mld_vif_valid_link(mld_vif, mld_link)			\
207 	for (int link_id = 0; link_id < ARRAY_SIZE((mld_vif)->link);	\
208 	     link_id++)							\
209 		if ((mld_link = iwl_mld_link_dereference_check(mld_vif, link_id)))
210 
211 /* Retrieve pointer to mld link from mac80211 structures */
212 static inline struct iwl_mld_link *
213 iwl_mld_link_from_mac80211(struct ieee80211_bss_conf *bss_conf)
214 {
215 	struct iwl_mld_vif *mld_vif = iwl_mld_vif_from_mac80211(bss_conf->vif);
216 
217 	return iwl_mld_link_dereference_check(mld_vif, bss_conf->link_id);
218 }
219 
220 int iwl_mld_mac80211_iftype_to_fw(const struct ieee80211_vif *vif);
221 
222 /* Cleanup function for struct iwl_mld_vif, will be called in restart */
223 void iwl_mld_cleanup_vif(void *data, u8 *mac, struct ieee80211_vif *vif);
224 int iwl_mld_mac_fw_action(struct iwl_mld *mld, struct ieee80211_vif *vif,
225 			  u32 action);
226 int iwl_mld_add_vif(struct iwl_mld *mld, struct ieee80211_vif *vif);
227 void iwl_mld_rm_vif(struct iwl_mld *mld, struct ieee80211_vif *vif);
228 void iwl_mld_set_vif_associated(struct iwl_mld *mld,
229 				struct ieee80211_vif *vif);
230 u8 iwl_mld_get_fw_bss_vifs_ids(struct iwl_mld *mld);
231 void iwl_mld_handle_probe_resp_data_notif(struct iwl_mld *mld,
232 					  struct iwl_rx_packet *pkt);
233 
234 void iwl_mld_handle_datapath_monitor_notif(struct iwl_mld *mld,
235 					   struct iwl_rx_packet *pkt);
236 
237 void iwl_mld_handle_uapsd_misbehaving_ap_notif(struct iwl_mld *mld,
238 					       struct iwl_rx_packet *pkt);
239 
240 void iwl_mld_reset_cca_40mhz_workaround(struct iwl_mld *mld,
241 					struct ieee80211_vif *vif);
242 
243 static inline bool iwl_mld_vif_low_latency(const struct iwl_mld_vif *mld_vif)
244 {
245 	return !!mld_vif->low_latency_causes;
246 }
247 
248 struct ieee80211_vif *iwl_mld_get_bss_vif(struct iwl_mld *mld);
249 
250 #endif /* __iwl_mld_iface_h__ */
251