2 * Copyright (c) 2008 open80211s Ltd.
3 * Author: Luis Carlos Cobo <luisca@cozybit.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 #include <linux/kernel.h>
10 #include <linux/random.h>
11 #include "ieee80211_i.h"
12 #include "ieee80211_rate.h"
15 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
16 #define mpl_dbg(fmt, args...) printk(KERN_DEBUG fmt, ##args)
18 #define mpl_dbg(fmt, args...) do { (void)(0); } while (0)
21 #define IEEE80211_FC(type, stype) cpu_to_le16(type | stype)
22 #define PLINK_GET_FRAME_SUBTYPE(p) (p)
23 #define PLINK_GET_LLID(p) (p + 1)
24 #define PLINK_GET_PLID(p) (p + 3)
26 #define mod_plink_timer(s, t) (mod_timer(&s->plink_timer, \
27 jiffies + HZ * t / 1000))
29 /* Peer link cancel reasons, all subject to ANA approval */
30 #define MESH_LINK_CANCELLED 2
31 #define MESH_MAX_NEIGHBORS 3
32 #define MESH_CAPABILITY_POLICY_VIOLATION 4
33 #define MESH_CLOSE_RCVD 5
34 #define MESH_MAX_RETRIES 6
35 #define MESH_CONFIRM_TIMEOUT 7
36 #define MESH_SECURITY_ROLE_NEGOTIATION_DIFFERS 8
37 #define MESH_SECURITY_AUTHENTICATION_IMPOSSIBLE 9
38 #define MESH_SECURITY_FAILED_VERIFICATION 10
40 #define dot11MeshMaxRetries(s) (s->u.sta.mshcfg.dot11MeshMaxRetries)
41 #define dot11MeshRetryTimeout(s) (s->u.sta.mshcfg.dot11MeshRetryTimeout)
42 #define dot11MeshConfirmTimeout(s) (s->u.sta.mshcfg.dot11MeshConfirmTimeout)
43 #define dot11MeshHoldingTimeout(s) (s->u.sta.mshcfg.dot11MeshHoldingTimeout)
44 #define dot11MeshMaxPeerLinks(s) (s->u.sta.mshcfg.dot11MeshMaxPeerLinks)
46 enum plink_frame_type {
65 void mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
67 atomic_inc(&sdata->u.sta.mshstats.estab_plinks);
68 mesh_accept_plinks_update(sdata);
72 void mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
74 atomic_dec(&sdata->u.sta.mshstats.estab_plinks);
75 mesh_accept_plinks_update(sdata);
79 * mesh_plink_fsm_restart - restart a mesh peer link finite state machine
81 * @sta: mes peer link to restart
83 * Locking: this function must be called holding sta->plink_lock
85 static inline void mesh_plink_fsm_restart(struct sta_info *sta)
87 sta->plink_state = LISTEN;
88 sta->llid = sta->plid = sta->reason = sta->plink_retries = 0;
91 static struct sta_info *mesh_plink_alloc(struct ieee80211_sub_if_data *sdata,
92 u8 *hw_addr, u64 rates)
94 struct ieee80211_local *local = sdata->local;
97 if (local->num_sta >= MESH_MAX_PLINKS)
100 sta = sta_info_alloc(sdata, hw_addr, GFP_ATOMIC);
104 sta->flags |= WLAN_STA_AUTHORIZED;
105 sta->supp_rates[local->hw.conf.channel->band] = rates;
111 * mesh_plink_deactivate - deactivate mesh peer link
113 * @sta: mesh peer link to deactivate
115 * All mesh paths with this peer as next hop will be flushed
117 * Locking: the caller must hold sta->plink_lock
119 static void __mesh_plink_deactivate(struct sta_info *sta)
121 struct ieee80211_sub_if_data *sdata = sta->sdata;
123 if (sta->plink_state == ESTAB)
124 mesh_plink_dec_estab_count(sdata);
125 sta->plink_state = BLOCKED;
126 mesh_path_flush_by_nexthop(sta);
130 * __mesh_plink_deactivate - deactivate mesh peer link
132 * @sta: mesh peer link to deactivate
134 * All mesh paths with this peer as next hop will be flushed
136 void mesh_plink_deactivate(struct sta_info *sta)
138 spin_lock_bh(&sta->plink_lock);
139 __mesh_plink_deactivate(sta);
140 spin_unlock_bh(&sta->plink_lock);
143 static int mesh_plink_frame_tx(struct net_device *dev,
144 enum plink_frame_type action, u8 *da, __le16 llid, __le16 plid,
146 struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
147 struct sk_buff *skb = dev_alloc_skb(local->hw.extra_tx_headroom + 400);
148 struct ieee80211_mgmt *mgmt;
149 bool include_plid = false;
155 skb_reserve(skb, local->hw.extra_tx_headroom);
156 /* 25 is the size of the common mgmt part (24) plus the size of the
157 * common action part (1)
159 mgmt = (struct ieee80211_mgmt *)
160 skb_put(skb, 25 + sizeof(mgmt->u.action.u.plink_action));
161 memset(mgmt, 0, 25 + sizeof(mgmt->u.action.u.plink_action));
162 mgmt->frame_control = IEEE80211_FC(IEEE80211_FTYPE_MGMT,
163 IEEE80211_STYPE_ACTION);
164 memcpy(mgmt->da, da, ETH_ALEN);
165 memcpy(mgmt->sa, dev->dev_addr, ETH_ALEN);
166 /* BSSID is left zeroed, wildcard value */
167 mgmt->u.action.category = PLINK_CATEGORY;
168 mgmt->u.action.u.plink_action.action_code = action;
170 if (action == PLINK_CLOSE)
171 mgmt->u.action.u.plink_action.aux = reason;
173 mgmt->u.action.u.plink_action.aux = cpu_to_le16(0x0);
174 if (action == PLINK_CONFIRM) {
175 pos = skb_put(skb, 4);
176 /* two-byte status code followed by two-byte AID */
179 mesh_mgmt_ies_add(skb, dev);
182 /* Add Peer Link Management element */
202 pos = skb_put(skb, 2 + ie_len);
203 *pos++ = WLAN_EID_PEER_LINK;
206 memcpy(pos, &llid, 2);
209 memcpy(pos, &plid, 2);
211 if (action == PLINK_CLOSE) {
213 memcpy(pos, &reason, 2);
216 ieee80211_sta_tx(dev, skb, 0);
220 void mesh_neighbour_update(u8 *hw_addr, u64 rates, struct net_device *dev,
221 bool peer_accepting_plinks)
223 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
224 struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
225 struct sta_info *sta;
229 sta = sta_info_get(local, hw_addr);
231 sta = mesh_plink_alloc(sdata, hw_addr, rates);
236 if (sta_info_insert(sta)) {
237 sta_info_destroy(sta);
243 sta->last_rx = jiffies;
244 sta->supp_rates[local->hw.conf.channel->band] = rates;
245 if (peer_accepting_plinks && sta->plink_state == LISTEN &&
246 sdata->u.sta.accepting_plinks &&
247 sdata->u.sta.mshcfg.auto_open_plinks)
248 mesh_plink_open(sta);
253 static void mesh_plink_timer(unsigned long data)
255 struct sta_info *sta;
256 __le16 llid, plid, reason;
257 struct net_device *dev = NULL;
258 struct ieee80211_sub_if_data *sdata;
259 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
260 DECLARE_MAC_BUF(mac);
264 * This STA is valid because sta_info_destroy() will
265 * del_timer_sync() this timer after having made sure
266 * it cannot be readded (by deleting the plink.)
268 sta = (struct sta_info *) data;
270 spin_lock_bh(&sta->plink_lock);
271 if (sta->ignore_plink_timer) {
272 sta->ignore_plink_timer = false;
273 spin_unlock_bh(&sta->plink_lock);
276 mpl_dbg("Mesh plink timer for %s fired on state %d\n",
277 print_mac(mac, sta->addr), sta->plink_state);
284 switch (sta->plink_state) {
288 if (sta->plink_retries < dot11MeshMaxRetries(sdata)) {
290 mpl_dbg("Mesh plink for %s (retry, timeout): %d %d\n",
291 print_mac(mac, sta->addr),
292 sta->plink_retries, sta->plink_timeout);
293 get_random_bytes(&rand, sizeof(u32));
294 sta->plink_timeout = sta->plink_timeout +
295 rand % sta->plink_timeout;
296 ++sta->plink_retries;
297 mod_plink_timer(sta, sta->plink_timeout);
298 spin_unlock_bh(&sta->plink_lock);
299 mesh_plink_frame_tx(dev, PLINK_OPEN, sta->addr, llid,
303 reason = cpu_to_le16(MESH_MAX_RETRIES);
304 /* fall through on else */
308 reason = cpu_to_le16(MESH_CONFIRM_TIMEOUT);
309 sta->plink_state = HOLDING;
310 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
311 spin_unlock_bh(&sta->plink_lock);
312 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid, plid,
317 del_timer(&sta->plink_timer);
318 mesh_plink_fsm_restart(sta);
319 spin_unlock_bh(&sta->plink_lock);
322 spin_unlock_bh(&sta->plink_lock);
327 static inline void mesh_plink_timer_set(struct sta_info *sta, int timeout)
329 sta->plink_timer.expires = jiffies + (HZ * timeout / 1000);
330 sta->plink_timer.data = (unsigned long) sta;
331 sta->plink_timer.function = mesh_plink_timer;
332 sta->plink_timeout = timeout;
333 add_timer(&sta->plink_timer);
336 int mesh_plink_open(struct sta_info *sta)
339 struct ieee80211_sub_if_data *sdata = sta->sdata;
340 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
341 DECLARE_MAC_BUF(mac);
344 spin_lock_bh(&sta->plink_lock);
345 get_random_bytes(&llid, 2);
347 if (sta->plink_state != LISTEN) {
348 spin_unlock_bh(&sta->plink_lock);
351 sta->plink_state = OPN_SNT;
352 mesh_plink_timer_set(sta, dot11MeshRetryTimeout(sdata));
353 spin_unlock_bh(&sta->plink_lock);
354 mpl_dbg("Mesh plink: starting establishment with %s\n",
355 print_mac(mac, sta->addr));
357 return mesh_plink_frame_tx(sdata->dev, PLINK_OPEN,
358 sta->addr, llid, 0, 0);
361 void mesh_plink_block(struct sta_info *sta)
363 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
364 DECLARE_MAC_BUF(mac);
367 spin_lock_bh(&sta->plink_lock);
368 __mesh_plink_deactivate(sta);
369 sta->plink_state = BLOCKED;
370 spin_unlock_bh(&sta->plink_lock);
373 int mesh_plink_close(struct sta_info *sta)
375 struct ieee80211_sub_if_data *sdata = sta->sdata;
376 int llid, plid, reason;
377 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
378 DECLARE_MAC_BUF(mac);
381 mpl_dbg("Mesh plink: closing link with %s\n",
382 print_mac(mac, sta->addr));
383 spin_lock_bh(&sta->plink_lock);
384 sta->reason = cpu_to_le16(MESH_LINK_CANCELLED);
385 reason = sta->reason;
387 if (sta->plink_state == LISTEN || sta->plink_state == BLOCKED) {
388 mesh_plink_fsm_restart(sta);
389 spin_unlock_bh(&sta->plink_lock);
391 } else if (sta->plink_state == ESTAB) {
392 __mesh_plink_deactivate(sta);
393 /* The timer should not be running */
394 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
395 } else if (!mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata)))
396 sta->ignore_plink_timer = true;
398 sta->plink_state = HOLDING;
401 spin_unlock_bh(&sta->plink_lock);
402 mesh_plink_frame_tx(sta->sdata->dev, PLINK_CLOSE, sta->addr, llid,
407 void mesh_rx_plink_frame(struct net_device *dev, struct ieee80211_mgmt *mgmt,
408 size_t len, struct ieee80211_rx_status *rx_status)
410 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
411 struct ieee80211_local *local = sdata->local;
412 struct ieee802_11_elems elems;
413 struct sta_info *sta;
414 enum plink_event event;
415 enum plink_frame_type ftype;
419 __le16 plid, llid, reason;
420 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
421 DECLARE_MAC_BUF(mac);
424 if (is_multicast_ether_addr(mgmt->da)) {
425 mpl_dbg("Mesh plink: ignore frame from multicast address");
429 baseaddr = mgmt->u.action.u.plink_action.variable;
430 baselen = (u8 *) mgmt->u.action.u.plink_action.variable - (u8 *) mgmt;
431 if (mgmt->u.action.u.plink_action.action_code == PLINK_CONFIRM) {
435 ieee802_11_parse_elems(baseaddr, len - baselen, &elems);
436 if (!elems.peer_link) {
437 mpl_dbg("Mesh plink: missing necessary peer link ie\n");
441 ftype = *((u8 *)PLINK_GET_FRAME_SUBTYPE(elems.peer_link));
442 ie_len = elems.peer_link_len;
443 if ((ftype == PLINK_OPEN && ie_len != 3) ||
444 (ftype == PLINK_CONFIRM && ie_len != 5) ||
445 (ftype == PLINK_CLOSE && ie_len != 5 && ie_len != 7)) {
446 mpl_dbg("Mesh plink: incorrect plink ie length\n");
450 if (ftype != PLINK_CLOSE && (!elems.mesh_id || !elems.mesh_config)) {
451 mpl_dbg("Mesh plink: missing necessary ie\n");
454 /* Note the lines below are correct, the llid in the frame is the plid
455 * from the point of view of this host.
457 memcpy(&plid, PLINK_GET_LLID(elems.peer_link), 2);
458 if (ftype == PLINK_CONFIRM || (ftype == PLINK_CLOSE && ie_len == 7))
459 memcpy(&llid, PLINK_GET_PLID(elems.peer_link), 2);
463 sta = sta_info_get(local, mgmt->sa);
464 if (!sta && ftype != PLINK_OPEN) {
465 mpl_dbg("Mesh plink: cls or cnf from unknown peer\n");
470 if (sta && sta->plink_state == BLOCKED) {
475 /* Now we will figure out the appropriate event... */
476 event = PLINK_UNDEFINED;
477 if (ftype != PLINK_CLOSE && (!mesh_matches_local(&elems, dev))) {
489 spin_lock_bh(&sta->plink_lock);
491 /* ftype == PLINK_OPEN */
493 if (!mesh_plink_free_count(sdata)) {
494 mpl_dbg("Mesh plink error: no more free plinks\n");
499 rates = ieee80211_sta_get_rates(local, &elems, rx_status->band);
500 sta = mesh_plink_alloc(sdata, mgmt->sa, rates);
502 mpl_dbg("Mesh plink error: plink table full\n");
506 if (sta_info_insert(sta)) {
507 sta_info_destroy(sta);
512 spin_lock_bh(&sta->plink_lock);
514 spin_lock_bh(&sta->plink_lock);
517 if (!mesh_plink_free_count(sdata) ||
518 (sta->plid && sta->plid != plid))
524 if (!mesh_plink_free_count(sdata) ||
525 (sta->llid != llid || sta->plid != plid))
531 if (sta->plink_state == ESTAB)
532 /* Do not check for llid or plid. This does not
533 * follow the standard but since multiple plinks
534 * per sta are not supported, it is necessary in
535 * order to avoid a livelock when MP A sees an
536 * establish peer link to MP B but MP B does not
537 * see it. This can be caused by a timeout in
538 * B's peer link establishment or B beign
542 else if (sta->plid != plid)
544 else if (ie_len == 7 && sta->llid != llid)
550 mpl_dbg("Mesh plink: unknown frame subtype\n");
551 spin_unlock_bh(&sta->plink_lock);
557 mpl_dbg("Mesh plink (peer, state, llid, plid, event): %s %d %d %d %d\n",
558 print_mac(mac, mgmt->sa), sta->plink_state,
559 __le16_to_cpu(sta->llid), __le16_to_cpu(sta->plid),
562 switch (sta->plink_state) {
563 /* spin_unlock as soon as state is updated at each case */
567 mesh_plink_fsm_restart(sta);
568 spin_unlock_bh(&sta->plink_lock);
571 sta->plink_state = OPN_RCVD;
573 get_random_bytes(&llid, 2);
575 mesh_plink_timer_set(sta, dot11MeshRetryTimeout(sdata));
576 spin_unlock_bh(&sta->plink_lock);
577 mesh_plink_frame_tx(dev, PLINK_OPEN, sta->addr, llid,
579 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr,
583 spin_unlock_bh(&sta->plink_lock);
592 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
595 reason = cpu_to_le16(MESH_CLOSE_RCVD);
596 sta->reason = reason;
597 sta->plink_state = HOLDING;
598 if (!mod_plink_timer(sta,
599 dot11MeshHoldingTimeout(sdata)))
600 sta->ignore_plink_timer = true;
603 spin_unlock_bh(&sta->plink_lock);
604 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
608 /* retry timer is left untouched */
609 sta->plink_state = OPN_RCVD;
612 spin_unlock_bh(&sta->plink_lock);
613 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
617 sta->plink_state = CNF_RCVD;
618 if (!mod_plink_timer(sta,
619 dot11MeshConfirmTimeout(sdata)))
620 sta->ignore_plink_timer = true;
622 spin_unlock_bh(&sta->plink_lock);
625 spin_unlock_bh(&sta->plink_lock);
634 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
637 reason = cpu_to_le16(MESH_CLOSE_RCVD);
638 sta->reason = reason;
639 sta->plink_state = HOLDING;
640 if (!mod_plink_timer(sta,
641 dot11MeshHoldingTimeout(sdata)))
642 sta->ignore_plink_timer = true;
645 spin_unlock_bh(&sta->plink_lock);
646 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
651 spin_unlock_bh(&sta->plink_lock);
652 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
656 del_timer(&sta->plink_timer);
657 sta->plink_state = ESTAB;
658 mesh_plink_inc_estab_count(sdata);
659 spin_unlock_bh(&sta->plink_lock);
660 mpl_dbg("Mesh plink with %s ESTABLISHED\n",
661 print_mac(mac, sta->addr));
664 spin_unlock_bh(&sta->plink_lock);
673 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
676 reason = cpu_to_le16(MESH_CLOSE_RCVD);
677 sta->reason = reason;
678 sta->plink_state = HOLDING;
679 if (!mod_plink_timer(sta,
680 dot11MeshHoldingTimeout(sdata)))
681 sta->ignore_plink_timer = true;
684 spin_unlock_bh(&sta->plink_lock);
685 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
689 del_timer(&sta->plink_timer);
690 sta->plink_state = ESTAB;
691 mesh_plink_inc_estab_count(sdata);
692 spin_unlock_bh(&sta->plink_lock);
693 mpl_dbg("Mesh plink with %s ESTABLISHED\n",
694 print_mac(mac, sta->addr));
695 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
699 spin_unlock_bh(&sta->plink_lock);
707 reason = cpu_to_le16(MESH_CLOSE_RCVD);
708 sta->reason = reason;
709 __mesh_plink_deactivate(sta);
710 sta->plink_state = HOLDING;
712 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
713 spin_unlock_bh(&sta->plink_lock);
714 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
719 spin_unlock_bh(&sta->plink_lock);
720 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
724 spin_unlock_bh(&sta->plink_lock);
731 if (del_timer(&sta->plink_timer))
732 sta->ignore_plink_timer = 1;
733 mesh_plink_fsm_restart(sta);
734 spin_unlock_bh(&sta->plink_lock);
741 reason = sta->reason;
742 spin_unlock_bh(&sta->plink_lock);
743 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
747 spin_unlock_bh(&sta->plink_lock);
751 /* should not get here, BLOCKED is dealt with at the beggining
754 spin_unlock_bh(&sta->plink_lock);