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;
92 * mesh_plink_alloc - allocate a new mesh peer link
94 * @sdata: local mesh interface
95 * @hw_addr: hardware address (ETH_ALEN length)
96 * @rates: rates the mesh peer supports
98 * The initial state of the new plink is set to LISTEN
100 * Returns: NULL on error.
102 struct sta_info *mesh_plink_alloc(struct ieee80211_sub_if_data *sdata,
103 u8 *hw_addr, u64 rates, gfp_t gfp)
105 struct ieee80211_local *local = sdata->local;
106 struct sta_info *sta;
108 if (compare_ether_addr(hw_addr, sdata->dev->dev_addr) == 0)
109 /* never add ourselves as neighbours */
112 if (is_multicast_ether_addr(hw_addr))
115 if (local->num_sta >= MESH_MAX_PLINKS)
118 sta = sta_info_alloc(sdata, hw_addr, gfp);
122 sta->plink_state = LISTEN;
123 spin_lock_init(&sta->plink_lock);
124 init_timer(&sta->plink_timer);
125 sta->flags |= WLAN_STA_AUTHORIZED;
126 sta->supp_rates[local->hw.conf.channel->band] = rates;
132 * mesh_plink_deactivate - deactivate mesh peer link
134 * @sta: mesh peer link to deactivate
136 * All mesh paths with this peer as next hop will be flushed
138 * Locking: the caller must hold sta->plink_lock
140 static void __mesh_plink_deactivate(struct sta_info *sta)
142 struct ieee80211_sub_if_data *sdata = sta->sdata;
144 if (sta->plink_state == ESTAB)
145 mesh_plink_dec_estab_count(sdata);
146 sta->plink_state = BLOCKED;
147 mesh_path_flush_by_nexthop(sta);
151 * __mesh_plink_deactivate - deactivate mesh peer link
153 * @sta: mesh peer link to deactivate
155 * All mesh paths with this peer as next hop will be flushed
157 void mesh_plink_deactivate(struct sta_info *sta)
159 spin_lock_bh(&sta->plink_lock);
160 __mesh_plink_deactivate(sta);
161 spin_unlock_bh(&sta->plink_lock);
164 static int mesh_plink_frame_tx(struct net_device *dev,
165 enum plink_frame_type action, u8 *da, __le16 llid, __le16 plid,
167 struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
168 struct sk_buff *skb = dev_alloc_skb(local->hw.extra_tx_headroom + 400);
169 struct ieee80211_mgmt *mgmt;
170 bool include_plid = false;
176 skb_reserve(skb, local->hw.extra_tx_headroom);
177 /* 25 is the size of the common mgmt part (24) plus the size of the
178 * common action part (1)
180 mgmt = (struct ieee80211_mgmt *)
181 skb_put(skb, 25 + sizeof(mgmt->u.action.u.plink_action));
182 memset(mgmt, 0, 25 + sizeof(mgmt->u.action.u.plink_action));
183 mgmt->frame_control = IEEE80211_FC(IEEE80211_FTYPE_MGMT,
184 IEEE80211_STYPE_ACTION);
185 memcpy(mgmt->da, da, ETH_ALEN);
186 memcpy(mgmt->sa, dev->dev_addr, ETH_ALEN);
187 /* BSSID is left zeroed, wildcard value */
188 mgmt->u.action.category = PLINK_CATEGORY;
189 mgmt->u.action.u.plink_action.action_code = action;
191 if (action == PLINK_CLOSE)
192 mgmt->u.action.u.plink_action.aux = reason;
194 mgmt->u.action.u.plink_action.aux = cpu_to_le16(0x0);
195 if (action == PLINK_CONFIRM) {
196 pos = skb_put(skb, 4);
197 /* two-byte status code followed by two-byte AID */
200 mesh_mgmt_ies_add(skb, dev);
203 /* Add Peer Link Management element */
223 pos = skb_put(skb, 2 + ie_len);
224 *pos++ = WLAN_EID_PEER_LINK;
227 memcpy(pos, &llid, 2);
230 memcpy(pos, &plid, 2);
232 if (action == PLINK_CLOSE) {
234 memcpy(pos, &reason, 2);
237 ieee80211_sta_tx(dev, skb, 0);
241 void mesh_neighbour_update(u8 *hw_addr, u64 rates, struct net_device *dev,
242 bool peer_accepting_plinks)
244 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
245 struct ieee80211_local *local = wdev_priv(dev->ieee80211_ptr);
246 struct sta_info *sta;
250 sta = sta_info_get(local, hw_addr);
252 sta = mesh_plink_alloc(sdata, hw_addr, rates, GFP_ATOMIC);
257 if (sta_info_insert(sta)) {
258 sta_info_destroy(sta);
264 sta->last_rx = jiffies;
265 sta->supp_rates[local->hw.conf.channel->band] = rates;
266 if (peer_accepting_plinks && sta->plink_state == LISTEN &&
267 sdata->u.sta.accepting_plinks &&
268 sdata->u.sta.mshcfg.auto_open_plinks)
269 mesh_plink_open(sta);
274 static void mesh_plink_timer(unsigned long data)
276 struct sta_info *sta;
277 __le16 llid, plid, reason;
278 struct net_device *dev = NULL;
279 struct ieee80211_sub_if_data *sdata;
280 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
281 DECLARE_MAC_BUF(mac);
285 * This STA is valid because sta_info_destroy() will
286 * del_timer_sync() this timer after having made sure
287 * it cannot be readded (by deleting the plink.)
289 sta = (struct sta_info *) data;
291 spin_lock_bh(&sta->plink_lock);
292 if (sta->ignore_plink_timer) {
293 sta->ignore_plink_timer = false;
294 spin_unlock_bh(&sta->plink_lock);
297 mpl_dbg("Mesh plink timer for %s fired on state %d\n",
298 print_mac(mac, sta->addr), sta->plink_state);
305 switch (sta->plink_state) {
309 if (sta->plink_retries < dot11MeshMaxRetries(sdata)) {
311 mpl_dbg("Mesh plink for %s (retry, timeout): %d %d\n",
312 print_mac(mac, sta->addr),
313 sta->plink_retries, sta->plink_timeout);
314 get_random_bytes(&rand, sizeof(u32));
315 sta->plink_timeout = sta->plink_timeout +
316 rand % sta->plink_timeout;
317 ++sta->plink_retries;
318 mod_plink_timer(sta, sta->plink_timeout);
319 spin_unlock_bh(&sta->plink_lock);
320 mesh_plink_frame_tx(dev, PLINK_OPEN, sta->addr, llid,
324 reason = cpu_to_le16(MESH_MAX_RETRIES);
325 /* fall through on else */
329 reason = cpu_to_le16(MESH_CONFIRM_TIMEOUT);
330 sta->plink_state = HOLDING;
331 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
332 spin_unlock_bh(&sta->plink_lock);
333 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid, plid,
338 del_timer(&sta->plink_timer);
339 mesh_plink_fsm_restart(sta);
340 spin_unlock_bh(&sta->plink_lock);
343 spin_unlock_bh(&sta->plink_lock);
348 static inline void mesh_plink_timer_set(struct sta_info *sta, int timeout)
350 sta->plink_timer.expires = jiffies + (HZ * timeout / 1000);
351 sta->plink_timer.data = (unsigned long) sta;
352 sta->plink_timer.function = mesh_plink_timer;
353 sta->plink_timeout = timeout;
354 add_timer(&sta->plink_timer);
357 int mesh_plink_open(struct sta_info *sta)
360 struct ieee80211_sub_if_data *sdata = sta->sdata;
361 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
362 DECLARE_MAC_BUF(mac);
365 spin_lock_bh(&sta->plink_lock);
366 get_random_bytes(&llid, 2);
368 if (sta->plink_state != LISTEN) {
369 spin_unlock_bh(&sta->plink_lock);
372 sta->plink_state = OPN_SNT;
373 mesh_plink_timer_set(sta, dot11MeshRetryTimeout(sdata));
374 spin_unlock_bh(&sta->plink_lock);
375 mpl_dbg("Mesh plink: starting establishment with %s\n",
376 print_mac(mac, sta->addr));
378 return mesh_plink_frame_tx(sdata->dev, PLINK_OPEN,
379 sta->addr, llid, 0, 0);
382 void mesh_plink_block(struct sta_info *sta)
384 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
385 DECLARE_MAC_BUF(mac);
388 spin_lock_bh(&sta->plink_lock);
389 __mesh_plink_deactivate(sta);
390 sta->plink_state = BLOCKED;
391 spin_unlock_bh(&sta->plink_lock);
394 int mesh_plink_close(struct sta_info *sta)
396 struct ieee80211_sub_if_data *sdata = sta->sdata;
397 int llid, plid, reason;
398 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
399 DECLARE_MAC_BUF(mac);
402 mpl_dbg("Mesh plink: closing link with %s\n",
403 print_mac(mac, sta->addr));
404 spin_lock_bh(&sta->plink_lock);
405 sta->reason = cpu_to_le16(MESH_LINK_CANCELLED);
406 reason = sta->reason;
408 if (sta->plink_state == LISTEN || sta->plink_state == BLOCKED) {
409 mesh_plink_fsm_restart(sta);
410 spin_unlock_bh(&sta->plink_lock);
412 } else if (sta->plink_state == ESTAB) {
413 __mesh_plink_deactivate(sta);
414 /* The timer should not be running */
415 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
416 } else if (!mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata)))
417 sta->ignore_plink_timer = true;
419 sta->plink_state = HOLDING;
422 spin_unlock_bh(&sta->plink_lock);
423 mesh_plink_frame_tx(sta->sdata->dev, PLINK_CLOSE, sta->addr, llid,
428 void mesh_rx_plink_frame(struct net_device *dev, struct ieee80211_mgmt *mgmt,
429 size_t len, struct ieee80211_rx_status *rx_status)
431 struct ieee80211_sub_if_data *sdata = IEEE80211_DEV_TO_SUB_IF(dev);
432 struct ieee80211_local *local = sdata->local;
433 struct ieee802_11_elems elems;
434 struct sta_info *sta;
435 enum plink_event event;
436 enum plink_frame_type ftype;
440 __le16 plid, llid, reason;
441 #ifdef CONFIG_MAC80211_VERBOSE_MPL_DEBUG
442 DECLARE_MAC_BUF(mac);
445 if (is_multicast_ether_addr(mgmt->da)) {
446 mpl_dbg("Mesh plink: ignore frame from multicast address");
450 baseaddr = mgmt->u.action.u.plink_action.variable;
451 baselen = (u8 *) mgmt->u.action.u.plink_action.variable - (u8 *) mgmt;
452 if (mgmt->u.action.u.plink_action.action_code == PLINK_CONFIRM) {
456 ieee802_11_parse_elems(baseaddr, len - baselen, &elems);
457 if (!elems.peer_link) {
458 mpl_dbg("Mesh plink: missing necessary peer link ie\n");
462 ftype = *((u8 *)PLINK_GET_FRAME_SUBTYPE(elems.peer_link));
463 ie_len = elems.peer_link_len;
464 if ((ftype == PLINK_OPEN && ie_len != 3) ||
465 (ftype == PLINK_CONFIRM && ie_len != 5) ||
466 (ftype == PLINK_CLOSE && ie_len != 5 && ie_len != 7)) {
467 mpl_dbg("Mesh plink: incorrect plink ie length\n");
471 if (ftype != PLINK_CLOSE && (!elems.mesh_id || !elems.mesh_config)) {
472 mpl_dbg("Mesh plink: missing necessary ie\n");
475 /* Note the lines below are correct, the llid in the frame is the plid
476 * from the point of view of this host.
478 memcpy(&plid, PLINK_GET_LLID(elems.peer_link), 2);
479 if (ftype == PLINK_CONFIRM || (ftype == PLINK_CLOSE && ie_len == 7))
480 memcpy(&llid, PLINK_GET_PLID(elems.peer_link), 2);
484 sta = sta_info_get(local, mgmt->sa);
485 if (!sta && ftype != PLINK_OPEN) {
486 mpl_dbg("Mesh plink: cls or cnf from unknown peer\n");
491 if (sta && sta->plink_state == BLOCKED) {
496 /* Now we will figure out the appropriate event... */
497 event = PLINK_UNDEFINED;
498 if (ftype != PLINK_CLOSE && (!mesh_matches_local(&elems, dev))) {
510 spin_lock_bh(&sta->plink_lock);
512 /* ftype == PLINK_OPEN */
514 if (!mesh_plink_free_count(sdata)) {
515 mpl_dbg("Mesh plink error: no more free plinks\n");
520 rates = ieee80211_sta_get_rates(local, &elems, rx_status->band);
521 sta = mesh_plink_alloc(sdata, mgmt->sa, rates, GFP_ATOMIC);
523 mpl_dbg("Mesh plink error: plink table full\n");
527 if (sta_info_insert(sta)) {
528 sta_info_destroy(sta);
533 spin_lock_bh(&sta->plink_lock);
535 spin_lock_bh(&sta->plink_lock);
538 if (!mesh_plink_free_count(sdata) ||
539 (sta->plid && sta->plid != plid))
545 if (!mesh_plink_free_count(sdata) ||
546 (sta->llid != llid || sta->plid != plid))
552 if (sta->plink_state == ESTAB)
553 /* Do not check for llid or plid. This does not
554 * follow the standard but since multiple plinks
555 * per sta are not supported, it is necessary in
556 * order to avoid a livelock when MP A sees an
557 * establish peer link to MP B but MP B does not
558 * see it. This can be caused by a timeout in
559 * B's peer link establishment or B beign
563 else if (sta->plid != plid)
565 else if (ie_len == 7 && sta->llid != llid)
571 mpl_dbg("Mesh plink: unknown frame subtype\n");
572 spin_unlock_bh(&sta->plink_lock);
578 mpl_dbg("Mesh plink (peer, state, llid, plid, event): %s %d %d %d %d\n",
579 print_mac(mac, mgmt->sa), sta->plink_state,
580 __le16_to_cpu(sta->llid), __le16_to_cpu(sta->plid),
583 switch (sta->plink_state) {
584 /* spin_unlock as soon as state is updated at each case */
588 mesh_plink_fsm_restart(sta);
589 spin_unlock_bh(&sta->plink_lock);
592 sta->plink_state = OPN_RCVD;
594 get_random_bytes(&llid, 2);
596 mesh_plink_timer_set(sta, dot11MeshRetryTimeout(sdata));
597 spin_unlock_bh(&sta->plink_lock);
598 mesh_plink_frame_tx(dev, PLINK_OPEN, sta->addr, llid,
600 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr,
604 spin_unlock_bh(&sta->plink_lock);
613 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
616 reason = cpu_to_le16(MESH_CLOSE_RCVD);
617 sta->reason = reason;
618 sta->plink_state = HOLDING;
619 if (!mod_plink_timer(sta,
620 dot11MeshHoldingTimeout(sdata)))
621 sta->ignore_plink_timer = true;
624 spin_unlock_bh(&sta->plink_lock);
625 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
629 /* retry timer is left untouched */
630 sta->plink_state = OPN_RCVD;
633 spin_unlock_bh(&sta->plink_lock);
634 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
638 sta->plink_state = CNF_RCVD;
639 if (!mod_plink_timer(sta,
640 dot11MeshConfirmTimeout(sdata)))
641 sta->ignore_plink_timer = true;
643 spin_unlock_bh(&sta->plink_lock);
646 spin_unlock_bh(&sta->plink_lock);
655 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
658 reason = cpu_to_le16(MESH_CLOSE_RCVD);
659 sta->reason = reason;
660 sta->plink_state = HOLDING;
661 if (!mod_plink_timer(sta,
662 dot11MeshHoldingTimeout(sdata)))
663 sta->ignore_plink_timer = true;
666 spin_unlock_bh(&sta->plink_lock);
667 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
672 spin_unlock_bh(&sta->plink_lock);
673 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
677 del_timer(&sta->plink_timer);
678 sta->plink_state = ESTAB;
679 mesh_plink_inc_estab_count(sdata);
680 spin_unlock_bh(&sta->plink_lock);
681 mpl_dbg("Mesh plink with %s ESTABLISHED\n",
682 print_mac(mac, sta->addr));
685 spin_unlock_bh(&sta->plink_lock);
694 reason = cpu_to_le16(MESH_CAPABILITY_POLICY_VIOLATION);
697 reason = cpu_to_le16(MESH_CLOSE_RCVD);
698 sta->reason = reason;
699 sta->plink_state = HOLDING;
700 if (!mod_plink_timer(sta,
701 dot11MeshHoldingTimeout(sdata)))
702 sta->ignore_plink_timer = true;
705 spin_unlock_bh(&sta->plink_lock);
706 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
710 del_timer(&sta->plink_timer);
711 sta->plink_state = ESTAB;
712 mesh_plink_inc_estab_count(sdata);
713 spin_unlock_bh(&sta->plink_lock);
714 mpl_dbg("Mesh plink with %s ESTABLISHED\n",
715 print_mac(mac, sta->addr));
716 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
720 spin_unlock_bh(&sta->plink_lock);
728 reason = cpu_to_le16(MESH_CLOSE_RCVD);
729 sta->reason = reason;
730 __mesh_plink_deactivate(sta);
731 sta->plink_state = HOLDING;
733 mod_plink_timer(sta, dot11MeshHoldingTimeout(sdata));
734 spin_unlock_bh(&sta->plink_lock);
735 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
740 spin_unlock_bh(&sta->plink_lock);
741 mesh_plink_frame_tx(dev, PLINK_CONFIRM, sta->addr, llid,
745 spin_unlock_bh(&sta->plink_lock);
752 if (del_timer(&sta->plink_timer))
753 sta->ignore_plink_timer = 1;
754 mesh_plink_fsm_restart(sta);
755 spin_unlock_bh(&sta->plink_lock);
762 reason = sta->reason;
763 spin_unlock_bh(&sta->plink_lock);
764 mesh_plink_frame_tx(dev, PLINK_CLOSE, sta->addr, llid,
768 spin_unlock_bh(&sta->plink_lock);
772 /* should not get here, BLOCKED is dealt with at the beggining
775 spin_unlock_bh(&sta->plink_lock);