]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - net/mac80211/mesh.h
ieee80211: add mesh action codes
[mirror_ubuntu-hirsute-kernel.git] / net / mac80211 / mesh.h
CommitLineData
ccf80ddf 1/*
264d9b7d 2 * Copyright (c) 2008, 2009 open80211s Ltd.
ccf80ddf
LCC
3 * Authors: Luis Carlos Cobo <luisca@cozybit.com>
4 * Javier Cardona <javier@cozybit.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
9 */
10
11#ifndef IEEE80211S_H
12#define IEEE80211S_H
13
902acc78 14#include <linux/types.h>
ccf80ddf 15#include <linux/jhash.h>
f375d558 16#include <asm/unaligned.h>
902acc78 17#include "ieee80211_i.h"
ccf80ddf 18
ccf80ddf
LCC
19
20/* Data structures */
21
22/**
23 * enum mesh_path_flags - mac80211 mesh path flags
24 *
25 *
26 *
eb80ed8d
RR
27 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
28 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 29 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
ccf80ddf
LCC
30 * number
31 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
32 * modified
33 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
ccf80ddf 34 *
eb80ed8d 35 * MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf
LCC
36 * decide when to stop or cancel the mesh path discovery.
37 */
38enum mesh_path_flags {
39 MESH_PATH_ACTIVE = BIT(0),
40 MESH_PATH_RESOLVING = BIT(1),
d19b3bf6 41 MESH_PATH_SN_VALID = BIT(2),
ccf80ddf
LCC
42 MESH_PATH_FIXED = BIT(3),
43 MESH_PATH_RESOLVED = BIT(4),
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
52 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
53 * to grow.
54 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
55 * grow
e304bfd3 56 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
18889231
JC
57 */
58enum mesh_deferred_task_flags {
59 MESH_WORK_HOUSEKEEPING,
60 MESH_WORK_GROW_MPATH_TABLE,
61 MESH_WORK_GROW_MPP_TABLE,
e304bfd3 62 MESH_WORK_ROOT,
18889231
JC
63};
64
ccf80ddf
LCC
65/**
66 * struct mesh_path - mac80211 mesh path structure
67 *
68 * @dst: mesh path destination mac address
f698d856 69 * @sdata: mesh subif
ccf80ddf
LCC
70 * @next_hop: mesh neighbor to which frames for this destination will be
71 * forwarded
72 * @timer: mesh path discovery timer
73 * @frame_queue: pending queue for frames sent to this destination while the
74 * path is unresolved
d19b3bf6 75 * @sn: target sequence number
ccf80ddf
LCC
76 * @metric: current metric to this destination
77 * @hop_count: hops to destination
78 * @exp_time: in jiffies, when the path will expire or when it expired
79 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
80 * retry
81 * @discovery_retries: number of discovery retries
82 * @flags: mesh path flags, as specified on &enum mesh_path_flags
fe583434 83 * @state_lock: mesh path state lock
ccf80ddf
LCC
84 *
85 *
f698d856 86 * The combination of dst and sdata is unique in the mesh path table. Since the
d0709a65
JB
87 * next_hop STA is only protected by RCU as well, deleting the STA must also
88 * remove/substitute the mesh_path structure and wait until that is no longer
89 * reachable before destroying the STA completely.
ccf80ddf
LCC
90 */
91struct mesh_path {
92 u8 dst[ETH_ALEN];
79617dee 93 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
f698d856 94 struct ieee80211_sub_if_data *sdata;
40b275b6 95 struct sta_info __rcu *next_hop;
ccf80ddf
LCC
96 struct timer_list timer;
97 struct sk_buff_head frame_queue;
98 struct rcu_head rcu;
d19b3bf6 99 u32 sn;
ccf80ddf
LCC
100 u32 metric;
101 u8 hop_count;
102 unsigned long exp_time;
103 u32 discovery_timeout;
104 u8 discovery_retries;
105 enum mesh_path_flags flags;
106 spinlock_t state_lock;
107};
108
109/**
110 * struct mesh_table
111 *
112 * @hash_buckets: array of hash buckets of the table
113 * @hashwlock: array of locks to protect write operations, one per bucket
114 * @hash_mask: 2^size_order - 1, used to compute hash idx
115 * @hash_rnd: random value used for hash computations
116 * @entries: number of entries in the table
117 * @free_node: function to free nodes of the table
eef35c2d 118 * @copy_node: function to copy nodes of the table
ccf80ddf
LCC
119 * @size_order: determines size of the table, there will be 2^size_order hash
120 * buckets
121 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
122 * reached, the table will grow
1928ecab 123 * rcu_head: RCU head to free the table
ccf80ddf
LCC
124 */
125struct mesh_table {
126 /* Number of buckets will be 2^N */
127 struct hlist_head *hash_buckets;
128 spinlock_t *hashwlock; /* One per bucket, for add/del */
129 unsigned int hash_mask; /* (2^size_order) - 1 */
130 __u32 hash_rnd; /* Used for hash generation */
131 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
132 void (*free_node) (struct hlist_node *p, bool free_leafs);
4caf86c6 133 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
ccf80ddf
LCC
134 int size_order;
135 int mean_chain_len;
1928ecab
JB
136
137 struct rcu_head rcu_head;
ccf80ddf
LCC
138};
139
140/* Recent multicast cache */
141/* RMC_BUCKETS must be a power of 2, maximum 256 */
142#define RMC_BUCKETS 256
143#define RMC_QUEUE_MAX_LEN 4
144#define RMC_TIMEOUT (3 * HZ)
145
146/**
147 * struct rmc_entry - entry in the Recent Multicast Cache
148 *
149 * @seqnum: mesh sequence number of the frame
150 * @exp_time: expiration time of the entry, in jiffies
151 * @sa: source address of the frame
152 *
153 * The Recent Multicast Cache keeps track of the latest multicast frames that
154 * have been received by a mesh interface and discards received multicast frames
155 * that are found in the cache.
156 */
157struct rmc_entry {
158 struct list_head list;
159 u32 seqnum;
160 unsigned long exp_time;
161 u8 sa[ETH_ALEN];
162};
163
164struct mesh_rmc {
165 struct rmc_entry bucket[RMC_BUCKETS];
51ceddad 166 u32 idx_mask;
ccf80ddf
LCC
167};
168
169
5b365834 170#define MESH_DEFAULT_BEACON_INTERVAL 1000 /* in 1024 us units */
ccf80ddf 171
ccf80ddf
LCC
172#define MESH_PATH_EXPIRE (600 * HZ)
173
ccf80ddf
LCC
174/* Default maximum number of plinks per interface */
175#define MESH_MAX_PLINKS 256
176
177/* Maximum number of paths per interface */
178#define MESH_MAX_MPATHS 1024
179
180/* Pending ANA approval */
095de013 181#define MESH_PATH_SEL_ACTION 0
ccf80ddf 182
d611f062
RP
183/* PERR reason codes */
184#define PEER_RCODE_UNSPECIFIED 11
185#define PERR_RCODE_NO_ROUTE 12
186#define PERR_RCODE_DEST_UNREACH 13
187
ccf80ddf
LCC
188/* Public interfaces */
189/* Various */
3c5772a5 190int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
15ff6365 191 const u8 *da, const u8 *sa);
ccf80ddf 192int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
61ad5394
JC
193 struct ieee80211_sub_if_data *sdata, char *addr4or5,
194 char *addr6);
ccf80ddf 195int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
f698d856
JBG
196 struct ieee80211_sub_if_data *sdata);
197bool mesh_matches_local(struct ieee802_11_elems *ie,
198 struct ieee80211_sub_if_data *sdata);
472dbc45 199void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
f698d856
JBG
200void mesh_mgmt_ies_add(struct sk_buff *skb,
201 struct ieee80211_sub_if_data *sdata);
082ebb0c
TP
202int mesh_add_meshconf_ie(struct sk_buff *skb,
203 struct ieee80211_sub_if_data *sdata);
204int mesh_add_meshid_ie(struct sk_buff *skb,
205 struct ieee80211_sub_if_data *sdata);
206int mesh_add_rsn_ie(struct sk_buff *skb,
207 struct ieee80211_sub_if_data *sdata);
208int mesh_add_vendor_ies(struct sk_buff *skb,
209 struct ieee80211_sub_if_data *sdata);
210int mesh_add_srates_ie(struct sk_buff *skb,
211 struct ieee80211_sub_if_data *sdata);
212int mesh_add_ext_srates_ie(struct sk_buff *skb,
213 struct ieee80211_sub_if_data *sdata);
214int mesh_add_ds_params_ie(struct sk_buff *skb,
215 struct ieee80211_sub_if_data *sdata);
f698d856
JBG
216void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
217int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf 218void ieee80211s_init(void);
bfc32e6a
JC
219void ieee80211s_update_metric(struct ieee80211_local *local,
220 struct sta_info *stainfo, struct sk_buff *skb);
ccf80ddf 221void ieee80211s_stop(void);
902acc78 222void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
472dbc45
JB
223void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
224void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 225void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
902acc78 226
ccf80ddf 227/* Mesh paths */
f698d856
JBG
228int mesh_nexthop_lookup(struct sk_buff *skb,
229 struct ieee80211_sub_if_data *sdata);
230void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
231struct mesh_path *mesh_path_lookup(u8 *dst,
232 struct ieee80211_sub_if_data *sdata);
79617dee
Y
233struct mesh_path *mpp_path_lookup(u8 *dst,
234 struct ieee80211_sub_if_data *sdata);
235int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
f698d856
JBG
236struct mesh_path *mesh_path_lookup_by_idx(int idx,
237 struct ieee80211_sub_if_data *sdata);
ccf80ddf 238void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856
JBG
239void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
240void mesh_path_flush(struct ieee80211_sub_if_data *sdata);
241void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
242 struct ieee80211_mgmt *mgmt, size_t len);
243int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);
ccf80ddf 244/* Mesh plinks */
881d948c 245void mesh_neighbour_update(u8 *hw_addr, u32 rates,
1570ca59
JC
246 struct ieee80211_sub_if_data *sdata,
247 struct ieee802_11_elems *ie);
f698d856 248bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
d0709a65 249void mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
250void mesh_plink_broken(struct sta_info *sta);
251void mesh_plink_deactivate(struct sta_info *sta);
252int mesh_plink_open(struct sta_info *sta);
ccf80ddf 253void mesh_plink_block(struct sta_info *sta);
f698d856
JBG
254void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
255 struct ieee80211_mgmt *mgmt, size_t len,
256 struct ieee80211_rx_status *rx_status);
ccf80ddf
LCC
257
258/* Private interfaces */
259/* Mesh tables */
18889231
JC
260void mesh_mpath_table_grow(void);
261void mesh_mpp_table_grow(void);
ccf80ddf 262/* Mesh paths */
d19b3bf6 263int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
15ff6365 264 const u8 *ra, struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
265void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
266void mesh_path_flush_pending(struct mesh_path *mpath);
267void mesh_path_tx_pending(struct mesh_path *mpath);
268int mesh_pathtbl_init(void);
269void mesh_pathtbl_unregister(void);
f698d856 270int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
ccf80ddf
LCC
271void mesh_path_timer(unsigned long data);
272void mesh_path_flush_by_nexthop(struct sta_info *sta);
f698d856
JBG
273void mesh_path_discard_frame(struct sk_buff *skb,
274 struct ieee80211_sub_if_data *sdata);
5bb644a0
JB
275void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
276void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
e304bfd3 277void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 278
f5ea9120
JB
279extern int mesh_paths_generation;
280
902acc78
JB
281#ifdef CONFIG_MAC80211_MESH
282extern int mesh_allocated;
283
ccf80ddf
LCC
284static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
285{
472dbc45
JB
286 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
287 atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
ccf80ddf
LCC
288}
289
290static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
291{
d0709a65 292 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC
293 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
294}
295
296static inline void mesh_path_activate(struct mesh_path *mpath)
297{
298 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
299}
300
c7108a71
JC
301static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
302{
303 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
304}
305
472dbc45
JB
306void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
307
5bb644a0
JB
308void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
309void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
310void mesh_plink_quiesce(struct sta_info *sta);
311void mesh_plink_restart(struct sta_info *sta);
902acc78
JB
312#else
313#define mesh_allocated 0
472dbc45
JB
314static inline void
315ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
5bb644a0
JB
316static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
317{}
318static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
319{}
320static inline void mesh_plink_quiesce(struct sta_info *sta) {}
321static inline void mesh_plink_restart(struct sta_info *sta) {}
c7108a71
JC
322static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
323{ return false; }
902acc78
JB
324#endif
325
ccf80ddf 326#endif /* IEEE80211S_H */