Linux 5.7.7
[linux/fpc-iii.git] / net / mac80211 / mesh_ps.c
blob031e905f684a2b61dc390231bebcdaea60fd8d73
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Copyright 2012-2013, Marco Porsch <marco.porsch@s2005.tu-chemnitz.de>
4 * Copyright 2012-2013, cozybit Inc.
5 */
7 #include "mesh.h"
8 #include "wme.h"
11 /* mesh PS management */
13 /**
14 * mps_qos_null_get - create pre-addressed QoS Null frame for mesh powersave
16 static struct sk_buff *mps_qos_null_get(struct sta_info *sta)
18 struct ieee80211_sub_if_data *sdata = sta->sdata;
19 struct ieee80211_local *local = sdata->local;
20 struct ieee80211_hdr *nullfunc; /* use 4addr header */
21 struct sk_buff *skb;
22 int size = sizeof(*nullfunc);
23 __le16 fc;
25 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size + 2);
26 if (!skb)
27 return NULL;
28 skb_reserve(skb, local->hw.extra_tx_headroom);
30 nullfunc = skb_put(skb, size);
31 fc = cpu_to_le16(IEEE80211_FTYPE_DATA | IEEE80211_STYPE_QOS_NULLFUNC);
32 ieee80211_fill_mesh_addresses(nullfunc, &fc, sta->sta.addr,
33 sdata->vif.addr);
34 nullfunc->frame_control = fc;
35 nullfunc->duration_id = 0;
36 nullfunc->seq_ctrl = 0;
37 /* no address resolution for this frame -> set addr 1 immediately */
38 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
39 skb_put_zero(skb, 2); /* append QoS control field */
40 ieee80211_mps_set_frame_flags(sdata, sta, nullfunc);
42 return skb;
45 /**
46 * mps_qos_null_tx - send a QoS Null to indicate link-specific power mode
48 static void mps_qos_null_tx(struct sta_info *sta)
50 struct sk_buff *skb;
52 skb = mps_qos_null_get(sta);
53 if (!skb)
54 return;
56 mps_dbg(sta->sdata, "announcing peer-specific power mode to %pM\n",
57 sta->sta.addr);
59 /* don't unintentionally start a MPSP */
60 if (!test_sta_flag(sta, WLAN_STA_PS_STA)) {
61 u8 *qc = ieee80211_get_qos_ctl((void *) skb->data);
63 qc[0] |= IEEE80211_QOS_CTL_EOSP;
66 ieee80211_tx_skb(sta->sdata, skb);
69 /**
70 * ieee80211_mps_local_status_update - track status of local link-specific PMs
72 * @sdata: local mesh subif
74 * sets the non-peer power mode and triggers the driver PS (re-)configuration
75 * Return BSS_CHANGED_BEACON if a beacon update is necessary.
77 u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata)
79 struct ieee80211_if_mesh *ifmsh = &sdata->u.mesh;
80 struct sta_info *sta;
81 bool peering = false;
82 int light_sleep_cnt = 0;
83 int deep_sleep_cnt = 0;
84 u32 changed = 0;
85 enum nl80211_mesh_power_mode nonpeer_pm;
87 rcu_read_lock();
88 list_for_each_entry_rcu(sta, &sdata->local->sta_list, list) {
89 if (sdata != sta->sdata)
90 continue;
92 switch (sta->mesh->plink_state) {
93 case NL80211_PLINK_OPN_SNT:
94 case NL80211_PLINK_OPN_RCVD:
95 case NL80211_PLINK_CNF_RCVD:
96 peering = true;
97 break;
98 case NL80211_PLINK_ESTAB:
99 if (sta->mesh->local_pm == NL80211_MESH_POWER_LIGHT_SLEEP)
100 light_sleep_cnt++;
101 else if (sta->mesh->local_pm == NL80211_MESH_POWER_DEEP_SLEEP)
102 deep_sleep_cnt++;
103 break;
104 default:
105 break;
108 rcu_read_unlock();
111 * Set non-peer mode to active during peering/scanning/authentication
112 * (see IEEE802.11-2012 13.14.8.3). The non-peer mesh power mode is
113 * deep sleep if the local STA is in light or deep sleep towards at
114 * least one mesh peer (see 13.14.3.1). Otherwise, set it to the
115 * user-configured default value.
117 if (peering) {
118 mps_dbg(sdata, "setting non-peer PM to active for peering\n");
119 nonpeer_pm = NL80211_MESH_POWER_ACTIVE;
120 } else if (light_sleep_cnt || deep_sleep_cnt) {
121 mps_dbg(sdata, "setting non-peer PM to deep sleep\n");
122 nonpeer_pm = NL80211_MESH_POWER_DEEP_SLEEP;
123 } else {
124 mps_dbg(sdata, "setting non-peer PM to user value\n");
125 nonpeer_pm = ifmsh->mshcfg.power_mode;
128 /* need update if sleep counts move between 0 and non-zero */
129 if (ifmsh->nonpeer_pm != nonpeer_pm ||
130 !ifmsh->ps_peers_light_sleep != !light_sleep_cnt ||
131 !ifmsh->ps_peers_deep_sleep != !deep_sleep_cnt)
132 changed = BSS_CHANGED_BEACON;
134 ifmsh->nonpeer_pm = nonpeer_pm;
135 ifmsh->ps_peers_light_sleep = light_sleep_cnt;
136 ifmsh->ps_peers_deep_sleep = deep_sleep_cnt;
138 return changed;
142 * ieee80211_mps_set_sta_local_pm - set local PM towards a mesh STA
144 * @sta: mesh STA
145 * @pm: the power mode to set
146 * Return BSS_CHANGED_BEACON if a beacon update is in order.
148 u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
149 enum nl80211_mesh_power_mode pm)
151 struct ieee80211_sub_if_data *sdata = sta->sdata;
153 if (sta->mesh->local_pm == pm)
154 return 0;
156 mps_dbg(sdata, "local STA operates in mode %d with %pM\n",
157 pm, sta->sta.addr);
159 sta->mesh->local_pm = pm;
162 * announce peer-specific power mode transition
163 * (see IEEE802.11-2012 13.14.3.2 and 13.14.3.3)
165 if (sta->mesh->plink_state == NL80211_PLINK_ESTAB)
166 mps_qos_null_tx(sta);
168 return ieee80211_mps_local_status_update(sdata);
172 * ieee80211_mps_set_frame_flags - set mesh PS flags in FC (and QoS Control)
174 * @sdata: local mesh subif
175 * @sta: mesh STA
176 * @hdr: 802.11 frame header
178 * see IEEE802.11-2012 8.2.4.1.7 and 8.2.4.5.11
180 * NOTE: sta must be given when an individually-addressed QoS frame header
181 * is handled, for group-addressed and management frames it is not used
183 void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
184 struct sta_info *sta,
185 struct ieee80211_hdr *hdr)
187 enum nl80211_mesh_power_mode pm;
188 u8 *qc;
190 if (WARN_ON(is_unicast_ether_addr(hdr->addr1) &&
191 ieee80211_is_data_qos(hdr->frame_control) &&
192 !sta))
193 return;
195 if (is_unicast_ether_addr(hdr->addr1) &&
196 ieee80211_is_data_qos(hdr->frame_control) &&
197 sta->mesh->plink_state == NL80211_PLINK_ESTAB)
198 pm = sta->mesh->local_pm;
199 else
200 pm = sdata->u.mesh.nonpeer_pm;
202 if (pm == NL80211_MESH_POWER_ACTIVE)
203 hdr->frame_control &= cpu_to_le16(~IEEE80211_FCTL_PM);
204 else
205 hdr->frame_control |= cpu_to_le16(IEEE80211_FCTL_PM);
207 if (!ieee80211_is_data_qos(hdr->frame_control))
208 return;
210 qc = ieee80211_get_qos_ctl(hdr);
212 if ((is_unicast_ether_addr(hdr->addr1) &&
213 pm == NL80211_MESH_POWER_DEEP_SLEEP) ||
214 (is_multicast_ether_addr(hdr->addr1) &&
215 sdata->u.mesh.ps_peers_deep_sleep > 0))
216 qc[1] |= (IEEE80211_QOS_CTL_MESH_PS_LEVEL >> 8);
217 else
218 qc[1] &= ~(IEEE80211_QOS_CTL_MESH_PS_LEVEL >> 8);
222 * ieee80211_mps_sta_status_update - update buffering status of neighbor STA
224 * @sta: mesh STA
226 * called after change of peering status or non-peer/peer-specific power mode
228 void ieee80211_mps_sta_status_update(struct sta_info *sta)
230 enum nl80211_mesh_power_mode pm;
231 bool do_buffer;
233 /* For non-assoc STA, prevent buffering or frame transmission */
234 if (sta->sta_state < IEEE80211_STA_ASSOC)
235 return;
238 * use peer-specific power mode if peering is established and the
239 * peer's power mode is known
241 if (sta->mesh->plink_state == NL80211_PLINK_ESTAB &&
242 sta->mesh->peer_pm != NL80211_MESH_POWER_UNKNOWN)
243 pm = sta->mesh->peer_pm;
244 else
245 pm = sta->mesh->nonpeer_pm;
247 do_buffer = (pm != NL80211_MESH_POWER_ACTIVE);
249 /* clear the MPSP flags for non-peers or active STA */
250 if (sta->mesh->plink_state != NL80211_PLINK_ESTAB) {
251 clear_sta_flag(sta, WLAN_STA_MPSP_OWNER);
252 clear_sta_flag(sta, WLAN_STA_MPSP_RECIPIENT);
253 } else if (!do_buffer) {
254 clear_sta_flag(sta, WLAN_STA_MPSP_OWNER);
257 /* Don't let the same PS state be set twice */
258 if (test_sta_flag(sta, WLAN_STA_PS_STA) == do_buffer)
259 return;
261 if (do_buffer) {
262 set_sta_flag(sta, WLAN_STA_PS_STA);
263 atomic_inc(&sta->sdata->u.mesh.ps.num_sta_ps);
264 mps_dbg(sta->sdata, "start PS buffering frames towards %pM\n",
265 sta->sta.addr);
266 } else {
267 ieee80211_sta_ps_deliver_wakeup(sta);
271 static void mps_set_sta_peer_pm(struct sta_info *sta,
272 struct ieee80211_hdr *hdr)
274 enum nl80211_mesh_power_mode pm;
275 u8 *qc = ieee80211_get_qos_ctl(hdr);
278 * Test Power Management field of frame control (PW) and
279 * mesh power save level subfield of QoS control field (PSL)
281 * | PM | PSL| Mesh PM |
282 * +----+----+---------+
283 * | 0 |Rsrv| Active |
284 * | 1 | 0 | Light |
285 * | 1 | 1 | Deep |
287 if (ieee80211_has_pm(hdr->frame_control)) {
288 if (qc[1] & (IEEE80211_QOS_CTL_MESH_PS_LEVEL >> 8))
289 pm = NL80211_MESH_POWER_DEEP_SLEEP;
290 else
291 pm = NL80211_MESH_POWER_LIGHT_SLEEP;
292 } else {
293 pm = NL80211_MESH_POWER_ACTIVE;
296 if (sta->mesh->peer_pm == pm)
297 return;
299 mps_dbg(sta->sdata, "STA %pM enters mode %d\n",
300 sta->sta.addr, pm);
302 sta->mesh->peer_pm = pm;
304 ieee80211_mps_sta_status_update(sta);
307 static void mps_set_sta_nonpeer_pm(struct sta_info *sta,
308 struct ieee80211_hdr *hdr)
310 enum nl80211_mesh_power_mode pm;
312 if (ieee80211_has_pm(hdr->frame_control))
313 pm = NL80211_MESH_POWER_DEEP_SLEEP;
314 else
315 pm = NL80211_MESH_POWER_ACTIVE;
317 if (sta->mesh->nonpeer_pm == pm)
318 return;
320 mps_dbg(sta->sdata, "STA %pM sets non-peer mode to %d\n",
321 sta->sta.addr, pm);
323 sta->mesh->nonpeer_pm = pm;
325 ieee80211_mps_sta_status_update(sta);
329 * ieee80211_mps_rx_h_sta_process - frame receive handler for mesh powersave
331 * @sta: STA info that transmitted the frame
332 * @hdr: IEEE 802.11 (QoS) Header
334 void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
335 struct ieee80211_hdr *hdr)
337 if (is_unicast_ether_addr(hdr->addr1) &&
338 ieee80211_is_data_qos(hdr->frame_control)) {
340 * individually addressed QoS Data/Null frames contain
341 * peer link-specific PS mode towards the local STA
343 mps_set_sta_peer_pm(sta, hdr);
345 /* check for mesh Peer Service Period trigger frames */
346 ieee80211_mpsp_trigger_process(ieee80211_get_qos_ctl(hdr),
347 sta, false, false);
348 } else {
350 * can only determine non-peer PS mode
351 * (see IEEE802.11-2012 8.2.4.1.7)
353 mps_set_sta_nonpeer_pm(sta, hdr);
358 /* mesh PS frame release */
360 static void mpsp_trigger_send(struct sta_info *sta, bool rspi, bool eosp)
362 struct ieee80211_sub_if_data *sdata = sta->sdata;
363 struct sk_buff *skb;
364 struct ieee80211_hdr *nullfunc;
365 struct ieee80211_tx_info *info;
366 u8 *qc;
368 skb = mps_qos_null_get(sta);
369 if (!skb)
370 return;
372 nullfunc = (struct ieee80211_hdr *) skb->data;
373 if (!eosp)
374 nullfunc->frame_control |=
375 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
377 * | RSPI | EOSP | MPSP triggering |
378 * +------+------+--------------------+
379 * | 0 | 0 | local STA is owner |
380 * | 0 | 1 | no MPSP (MPSP end) |
381 * | 1 | 0 | both STA are owner |
382 * | 1 | 1 | peer STA is owner | see IEEE802.11-2012 13.14.9.2
384 qc = ieee80211_get_qos_ctl(nullfunc);
385 if (rspi)
386 qc[1] |= (IEEE80211_QOS_CTL_RSPI >> 8);
387 if (eosp)
388 qc[0] |= IEEE80211_QOS_CTL_EOSP;
390 info = IEEE80211_SKB_CB(skb);
392 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER |
393 IEEE80211_TX_CTL_REQ_TX_STATUS;
395 mps_dbg(sdata, "sending MPSP trigger%s%s to %pM\n",
396 rspi ? " RSPI" : "", eosp ? " EOSP" : "", sta->sta.addr);
398 ieee80211_tx_skb(sdata, skb);
402 * mpsp_qos_null_append - append QoS Null frame to MPSP skb queue if needed
404 * To properly end a mesh MPSP the last transmitted frame has to set the EOSP
405 * flag in the QoS Control field. In case the current tailing frame is not a
406 * QoS Data frame, append a QoS Null to carry the flag.
408 static void mpsp_qos_null_append(struct sta_info *sta,
409 struct sk_buff_head *frames)
411 struct ieee80211_sub_if_data *sdata = sta->sdata;
412 struct sk_buff *new_skb, *skb = skb_peek_tail(frames);
413 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *) skb->data;
414 struct ieee80211_tx_info *info;
416 if (ieee80211_is_data_qos(hdr->frame_control))
417 return;
419 new_skb = mps_qos_null_get(sta);
420 if (!new_skb)
421 return;
423 mps_dbg(sdata, "appending QoS Null in MPSP towards %pM\n",
424 sta->sta.addr);
426 * This frame has to be transmitted last. Assign lowest priority to
427 * make sure it cannot pass other frames when releasing multiple ACs.
429 new_skb->priority = 1;
430 skb_set_queue_mapping(new_skb, IEEE80211_AC_BK);
431 ieee80211_set_qos_hdr(sdata, new_skb);
433 info = IEEE80211_SKB_CB(new_skb);
434 info->control.vif = &sdata->vif;
435 info->flags |= IEEE80211_TX_INTFL_NEED_TXPROCESSING;
437 __skb_queue_tail(frames, new_skb);
441 * mps_frame_deliver - transmit frames during mesh powersave
443 * @sta: STA info to transmit to
444 * @n_frames: number of frames to transmit. -1 for all
446 static void mps_frame_deliver(struct sta_info *sta, int n_frames)
448 struct ieee80211_local *local = sta->sdata->local;
449 int ac;
450 struct sk_buff_head frames;
451 struct sk_buff *skb;
452 bool more_data = false;
454 skb_queue_head_init(&frames);
456 /* collect frame(s) from buffers */
457 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
458 while (n_frames != 0) {
459 skb = skb_dequeue(&sta->tx_filtered[ac]);
460 if (!skb) {
461 skb = skb_dequeue(
462 &sta->ps_tx_buf[ac]);
463 if (skb)
464 local->total_ps_buffered--;
466 if (!skb)
467 break;
468 n_frames--;
469 __skb_queue_tail(&frames, skb);
472 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
473 !skb_queue_empty(&sta->ps_tx_buf[ac]))
474 more_data = true;
477 /* nothing to send? -> EOSP */
478 if (skb_queue_empty(&frames)) {
479 mpsp_trigger_send(sta, false, true);
480 return;
483 /* in a MPSP make sure the last skb is a QoS Data frame */
484 if (test_sta_flag(sta, WLAN_STA_MPSP_OWNER))
485 mpsp_qos_null_append(sta, &frames);
487 mps_dbg(sta->sdata, "sending %d frames to PS STA %pM\n",
488 skb_queue_len(&frames), sta->sta.addr);
490 /* prepare collected frames for transmission */
491 skb_queue_walk(&frames, skb) {
492 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
493 struct ieee80211_hdr *hdr = (void *) skb->data;
496 * Tell TX path to send this frame even though the
497 * STA may still remain is PS mode after this frame
498 * exchange.
500 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER;
502 if (more_data || !skb_queue_is_last(&frames, skb))
503 hdr->frame_control |=
504 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
505 else
506 hdr->frame_control &=
507 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
509 if (skb_queue_is_last(&frames, skb) &&
510 ieee80211_is_data_qos(hdr->frame_control)) {
511 u8 *qoshdr = ieee80211_get_qos_ctl(hdr);
513 /* MPSP trigger frame ends service period */
514 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
515 info->flags |= IEEE80211_TX_CTL_REQ_TX_STATUS;
519 ieee80211_add_pending_skbs(local, &frames);
520 sta_info_recalc_tim(sta);
524 * ieee80211_mpsp_trigger_process - track status of mesh Peer Service Periods
526 * @qc: QoS Control field
527 * @sta: peer to start a MPSP with
528 * @tx: frame was transmitted by the local STA
529 * @acked: frame has been transmitted successfully
531 * NOTE: active mode STA may only serve as MPSP owner
533 void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
534 bool tx, bool acked)
536 u8 rspi = qc[1] & (IEEE80211_QOS_CTL_RSPI >> 8);
537 u8 eosp = qc[0] & IEEE80211_QOS_CTL_EOSP;
539 if (tx) {
540 if (rspi && acked)
541 set_sta_flag(sta, WLAN_STA_MPSP_RECIPIENT);
543 if (eosp)
544 clear_sta_flag(sta, WLAN_STA_MPSP_OWNER);
545 else if (acked &&
546 test_sta_flag(sta, WLAN_STA_PS_STA) &&
547 !test_and_set_sta_flag(sta, WLAN_STA_MPSP_OWNER))
548 mps_frame_deliver(sta, -1);
549 } else {
550 if (eosp)
551 clear_sta_flag(sta, WLAN_STA_MPSP_RECIPIENT);
552 else if (sta->mesh->local_pm != NL80211_MESH_POWER_ACTIVE)
553 set_sta_flag(sta, WLAN_STA_MPSP_RECIPIENT);
555 if (rspi && !test_and_set_sta_flag(sta, WLAN_STA_MPSP_OWNER))
556 mps_frame_deliver(sta, -1);
561 * ieee80211_mps_frame_release - release frames buffered due to mesh power save
563 * @sta: mesh STA
564 * @elems: IEs of beacon or probe response
566 * For peers if we have individually-addressed frames buffered or the peer
567 * indicates buffered frames, send a corresponding MPSP trigger frame. Since
568 * we do not evaluate the awake window duration, QoS Nulls are used as MPSP
569 * trigger frames. If the neighbour STA is not a peer, only send single frames.
571 void ieee80211_mps_frame_release(struct sta_info *sta,
572 struct ieee802_11_elems *elems)
574 int ac, buffer_local = 0;
575 bool has_buffered = false;
577 if (sta->mesh->plink_state == NL80211_PLINK_ESTAB)
578 has_buffered = ieee80211_check_tim(elems->tim, elems->tim_len,
579 sta->mesh->aid);
581 if (has_buffered)
582 mps_dbg(sta->sdata, "%pM indicates buffered frames\n",
583 sta->sta.addr);
585 /* only transmit to PS STA with announced, non-zero awake window */
586 if (test_sta_flag(sta, WLAN_STA_PS_STA) &&
587 (!elems->awake_window || !le16_to_cpu(*elems->awake_window)))
588 return;
590 if (!test_sta_flag(sta, WLAN_STA_MPSP_OWNER))
591 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
592 buffer_local += skb_queue_len(&sta->ps_tx_buf[ac]) +
593 skb_queue_len(&sta->tx_filtered[ac]);
595 if (!has_buffered && !buffer_local)
596 return;
598 if (sta->mesh->plink_state == NL80211_PLINK_ESTAB)
599 mpsp_trigger_send(sta, has_buffered, !buffer_local);
600 else
601 mps_frame_deliver(sta, 1);