]> git.ipfire.org Git - people/ms/linux.git/blame - net/mac80211/mesh.h
Merge tag 'for-linus-5.19-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/rw/uml
[people/ms/linux.git] / net / mac80211 / mesh.h
CommitLineData
d2912cb1 1/* SPDX-License-Identifier: GPL-2.0-only */
ccf80ddf 2/*
264d9b7d 3 * Copyright (c) 2008, 2009 open80211s Ltd.
ccf80ddf
LCC
4 * Authors: Luis Carlos Cobo <luisca@cozybit.com>
5 * Javier Cardona <javier@cozybit.com>
ccf80ddf
LCC
6 */
7
8#ifndef IEEE80211S_H
9#define IEEE80211S_H
10
902acc78 11#include <linux/types.h>
ccf80ddf 12#include <linux/jhash.h>
902acc78 13#include "ieee80211_i.h"
ccf80ddf 14
ccf80ddf
LCC
15
16/* Data structures */
17
18/**
19 * enum mesh_path_flags - mac80211 mesh path flags
20 *
eb80ed8d
RR
21 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
22 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 23 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
bf7cd94d 24 * number
ccf80ddf 25 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
bf7cd94d 26 * modified
ccf80ddf 27 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9 28 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
bf7cd94d 29 * already queued up, waiting for the discovery process to start.
74932959
BC
30 * @MESH_PATH_DELETED: the mesh path has been deleted and should no longer
31 * be used
ccf80ddf 32 *
eb80ed8d 33 * MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf
LCC
34 * decide when to stop or cancel the mesh path discovery.
35 */
36enum mesh_path_flags {
37 MESH_PATH_ACTIVE = BIT(0),
38 MESH_PATH_RESOLVING = BIT(1),
d19b3bf6 39 MESH_PATH_SN_VALID = BIT(2),
ccf80ddf
LCC
40 MESH_PATH_FIXED = BIT(3),
41 MESH_PATH_RESOLVED = BIT(4),
f3011cf9 42 MESH_PATH_REQ_QUEUED = BIT(5),
74932959 43 MESH_PATH_DELETED = BIT(6),
ccf80ddf
LCC
44};
45
18889231
JC
46/**
47 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
48 *
49 *
50 *
51 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
e304bfd3 52 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb
JC
53 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
54 * mesh nodes
f81a9ded 55 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
18889231
JC
56 */
57enum mesh_deferred_task_flags {
58 MESH_WORK_HOUSEKEEPING,
e304bfd3 59 MESH_WORK_ROOT,
dbf498fb 60 MESH_WORK_DRIFT_ADJUST,
f81a9ded 61 MESH_WORK_MBSS_CHANGED,
18889231
JC
62};
63
ccf80ddf
LCC
64/**
65 * struct mesh_path - mac80211 mesh path structure
66 *
67 * @dst: mesh path destination mac address
68bb54b4
BC
68 * @mpp: mesh proxy mac address
69 * @rhash: rhashtable list pointer
b4c3fbe6 70 * @walk_list: linked list containing all mesh_path objects.
68bb54b4 71 * @gate_list: list pointer for known gates list
f698d856 72 * @sdata: mesh subif
ccf80ddf 73 * @next_hop: mesh neighbor to which frames for this destination will be
bf7cd94d 74 * forwarded
ccf80ddf
LCC
75 * @timer: mesh path discovery timer
76 * @frame_queue: pending queue for frames sent to this destination while the
bf7cd94d 77 * path is unresolved
68bb54b4 78 * @rcu: rcu head for freeing mesh path
d19b3bf6 79 * @sn: target sequence number
ccf80ddf
LCC
80 * @metric: current metric to this destination
81 * @hop_count: hops to destination
82 * @exp_time: in jiffies, when the path will expire or when it expired
83 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
bf7cd94d 84 * retry
ccf80ddf
LCC
85 * @discovery_retries: number of discovery retries
86 * @flags: mesh path flags, as specified on &enum mesh_path_flags
f5e50cd0
JC
87 * @state_lock: mesh path state lock used to protect changes to the
88 * mpath itself. No need to take this lock when adding or removing
89 * an mpath to a hash bucket on a path table.
3d045a54 90 * @rann_snd_addr: the RANN sender address
d2a079fd 91 * @rann_metric: the aggregated path metric towards the root node
728b19e5 92 * @last_preq_to_root: Timestamp of last PREQ sent to root
3d045a54 93 * @is_root: the destination station of this path is a root node
5ee68e5b 94 * @is_gate: the destination station of this path is a mesh gate
540bbcb9 95 * @path_change_count: the number of path changes to destination
ccf80ddf
LCC
96 *
97 *
68bb54b4
BC
98 * The dst address is unique in the mesh path table. Since the mesh_path is
99 * protected by RCU, deleting the next_hop STA must remove / substitute the
100 * mesh_path structure and wait until that is no longer reachable before
101 * destroying the STA completely.
ccf80ddf
LCC
102 */
103struct mesh_path {
104 u8 dst[ETH_ALEN];
79617dee 105 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
60854fd9 106 struct rhash_head rhash;
b4c3fbe6 107 struct hlist_node walk_list;
947c2a0e 108 struct hlist_node gate_list;
f698d856 109 struct ieee80211_sub_if_data *sdata;
40b275b6 110 struct sta_info __rcu *next_hop;
ccf80ddf
LCC
111 struct timer_list timer;
112 struct sk_buff_head frame_queue;
113 struct rcu_head rcu;
d19b3bf6 114 u32 sn;
ccf80ddf
LCC
115 u32 metric;
116 u8 hop_count;
117 unsigned long exp_time;
118 u32 discovery_timeout;
119 u8 discovery_retries;
120 enum mesh_path_flags flags;
121 spinlock_t state_lock;
3d045a54 122 u8 rann_snd_addr[ETH_ALEN];
d2a079fd 123 u32 rann_metric;
728b19e5 124 unsigned long last_preq_to_root;
3d045a54 125 bool is_root;
5ee68e5b 126 bool is_gate;
540bbcb9 127 u32 path_change_count;
ccf80ddf
LCC
128};
129
ccf80ddf
LCC
130/* Recent multicast cache */
131/* RMC_BUCKETS must be a power of 2, maximum 256 */
132#define RMC_BUCKETS 256
133#define RMC_QUEUE_MAX_LEN 4
134#define RMC_TIMEOUT (3 * HZ)
135
136/**
137 * struct rmc_entry - entry in the Recent Multicast Cache
138 *
139 * @seqnum: mesh sequence number of the frame
140 * @exp_time: expiration time of the entry, in jiffies
141 * @sa: source address of the frame
68bb54b4 142 * @list: hashtable list pointer
ccf80ddf
LCC
143 *
144 * The Recent Multicast Cache keeps track of the latest multicast frames that
145 * have been received by a mesh interface and discards received multicast frames
146 * that are found in the cache.
147 */
148struct rmc_entry {
47a0489c 149 struct hlist_node list;
ccf80ddf 150 unsigned long exp_time;
3257523b 151 u32 seqnum;
ccf80ddf
LCC
152 u8 sa[ETH_ALEN];
153};
154
155struct mesh_rmc {
47a0489c 156 struct hlist_head bucket[RMC_BUCKETS];
51ceddad 157 u32 idx_mask;
ccf80ddf
LCC
158};
159
25d49e4d 160#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf 161
ccf80ddf
LCC
162#define MESH_PATH_EXPIRE (600 * HZ)
163
ccf80ddf
LCC
164/* Default maximum number of plinks per interface */
165#define MESH_MAX_PLINKS 256
166
167/* Maximum number of paths per interface */
168#define MESH_MAX_MPATHS 1024
169
4bd4c2dd
TP
170/* Number of frames buffered per destination for unresolved destinations */
171#define MESH_FRAME_QUEUE_LEN 10
172
ccf80ddf
LCC
173/* Public interfaces */
174/* Various */
3c5772a5 175int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
15ff6365 176 const u8 *da, const u8 *sa);
5edfcee5
AH
177unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
178 struct ieee80211s_hdr *meshhdr,
179 const char *addr4or5, const char *addr6);
bf7cd94d
JB
180int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
181 const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
f743ff49
TP
182bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
183 struct ieee802_11_elems *ie);
472dbc45 184void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
bf7cd94d
JB
185int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
186 struct sk_buff *skb);
187int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
188 struct sk_buff *skb);
189int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
190 struct sk_buff *skb);
191int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
192 struct sk_buff *skb);
193int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
194 struct sk_buff *skb);
195int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
196 struct sk_buff *skb);
c85fb53c
BC
197int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
198 struct sk_buff *skb);
199int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
200 struct sk_buff *skb);
60ad72da
SE
201int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata,
202 struct sk_buff *skb, u8 ie_len);
203int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata,
204 struct sk_buff *skb);
24a2042c
RM
205int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata,
206 struct sk_buff *skb);
f698d856
JBG
207void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
208int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf 209void ieee80211s_init(void);
bfc32e6a 210void ieee80211s_update_metric(struct ieee80211_local *local,
c4205510
YCP
211 struct sta_info *sta,
212 struct ieee80211_tx_status *st);
902acc78 213void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
0371a08f 214void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967 215int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45 216void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 217void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3 218const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967
TP
219/* wrapper for ieee80211_bss_info_change_notify() */
220void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
221 u32 changed);
902acc78 222
3f52b7e3 223/* mesh power save */
39886b61
TP
224u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
225u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
226 enum nl80211_mesh_power_mode pm);
3f52b7e3
MP
227void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
228 struct sta_info *sta,
229 struct ieee80211_hdr *hdr);
230void ieee80211_mps_sta_status_update(struct sta_info *sta);
231void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
232 struct ieee80211_hdr *hdr);
233void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
234 bool tx, bool acked);
235void ieee80211_mps_frame_release(struct sta_info *sta,
236 struct ieee802_11_elems *elems);
237
ccf80ddf 238/* Mesh paths */
bf7cd94d
JB
239int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
240 struct sk_buff *skb);
241int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
242 struct sk_buff *skb);
f698d856 243void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d
JB
244struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
245 const u8 *dst);
246struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
247 const u8 *dst);
248int mpp_path_add(struct ieee80211_sub_if_data *sdata,
249 const u8 *dst, const u8 *mpp);
250struct mesh_path *
251mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
a2db2ed3
HR
252struct mesh_path *
253mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf 254void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856 255void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856 256void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d 257 struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0
BC
258struct mesh_path *
259mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
5ee68e5b
JC
260
261int mesh_path_add_gate(struct mesh_path *mpath);
262int mesh_path_send_to_gates(struct mesh_path *mpath);
263int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
ab60633c
NM
264u32 airtime_link_metric_get(struct ieee80211_local *local,
265 struct sta_info *sta);
bf7cd94d 266
ccf80ddf 267/* Mesh plinks */
f743ff49 268void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
ecbc12ad
BC
269 u8 *hw_addr, struct ieee802_11_elems *ie,
270 struct ieee80211_rx_status *rx_status);
f698d856 271bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
df323818 272u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
4c02d62f 273void mesh_plink_timer(struct timer_list *t);
ccf80ddf 274void mesh_plink_broken(struct sta_info *sta);
45b5028e 275u32 mesh_plink_deactivate(struct sta_info *sta);
39886b61
TP
276u32 mesh_plink_open(struct sta_info *sta);
277u32 mesh_plink_block(struct sta_info *sta);
f698d856
JBG
278void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
279 struct ieee80211_mgmt *mgmt, size_t len,
280 struct ieee80211_rx_status *rx_status);
45b5028e 281void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf
LCC
282
283/* Private interfaces */
ccf80ddf 284/* Mesh paths */
bf7cd94d 285int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
f63f8421
CYY
286 u8 ttl, const u8 *target, u32 target_sn,
287 u16 target_rcode, const u8 *ra);
ccf80ddf
LCC
288void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
289void mesh_path_flush_pending(struct mesh_path *mpath);
290void mesh_path_tx_pending(struct mesh_path *mpath);
8b5cb7e4 291void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
2bdaf386 292void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
bf7cd94d 293int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
34f11cd3 294void mesh_path_timer(struct timer_list *t);
ccf80ddf 295void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d
JB
296void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
297 struct sk_buff *skb);
e304bfd3 298void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 299
25d49e4d 300bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
f5ea9120 301
902acc78 302#ifdef CONFIG_MAC80211_MESH
1617bab8
MP
303static inline
304u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
305{
306 atomic_inc(&sdata->u.mesh.estab_plinks);
e05ecccd 307 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP
308}
309
310static inline
311u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
312{
313 atomic_dec(&sdata->u.mesh.estab_plinks);
e05ecccd 314 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP
315}
316
ccf80ddf
LCC
317static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
318{
472dbc45 319 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976 320 atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf
LCC
321}
322
323static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
324{
d0709a65 325 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC
326 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
327}
328
329static inline void mesh_path_activate(struct mesh_path *mpath)
330{
331 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
332}
333
c7108a71
JC
334static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
335{
336 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
337}
338
94c514fe 339void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
445cd452 340void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
bf7cd94d 341void ieee80211s_stop(void);
902acc78 342#else
c7108a71
JC
343static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
344{ return false; }
94c514fe
AE
345static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
346{}
bf7cd94d 347static inline void ieee80211s_stop(void) {}
902acc78
JB
348#endif
349
ccf80ddf 350#endif /* IEEE80211S_H */