Merge tag 'v3.10.65' into update
[GitHub/mt8127/android_kernel_alcatel_ttab.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>
902acc78 16#include "ieee80211_i.h"
ccf80ddf 17
ccf80ddf
LCC
18
19/* Data structures */
20
21/**
22 * enum mesh_path_flags - mac80211 mesh path flags
23 *
24 *
25 *
eb80ed8d
RR
26 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
27 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 28 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
bf7cd94d 29 * number
ccf80ddf 30 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
bf7cd94d 31 * modified
ccf80ddf 32 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9 33 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
bf7cd94d 34 * already queued up, waiting for the discovery process to start.
ccf80ddf 35 *
eb80ed8d 36 * MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf
LCC
37 * decide when to stop or cancel the mesh path discovery.
38 */
39enum mesh_path_flags {
40 MESH_PATH_ACTIVE = BIT(0),
41 MESH_PATH_RESOLVING = BIT(1),
d19b3bf6 42 MESH_PATH_SN_VALID = BIT(2),
ccf80ddf
LCC
43 MESH_PATH_FIXED = BIT(3),
44 MESH_PATH_RESOLVED = BIT(4),
f3011cf9 45 MESH_PATH_REQ_QUEUED = BIT(5),
ccf80ddf
LCC
46};
47
18889231
JC
48/**
49 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
50 *
51 *
52 *
53 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
54 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
55 * to grow.
56 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
57 * grow
e304bfd3 58 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb
JC
59 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
60 * mesh nodes
18889231
JC
61 */
62enum mesh_deferred_task_flags {
63 MESH_WORK_HOUSEKEEPING,
64 MESH_WORK_GROW_MPATH_TABLE,
65 MESH_WORK_GROW_MPP_TABLE,
e304bfd3 66 MESH_WORK_ROOT,
dbf498fb 67 MESH_WORK_DRIFT_ADJUST,
18889231
JC
68};
69
ccf80ddf
LCC
70/**
71 * struct mesh_path - mac80211 mesh path structure
72 *
73 * @dst: mesh path destination mac address
f698d856 74 * @sdata: mesh subif
ccf80ddf 75 * @next_hop: mesh neighbor to which frames for this destination will be
bf7cd94d 76 * forwarded
ccf80ddf
LCC
77 * @timer: mesh path discovery timer
78 * @frame_queue: pending queue for frames sent to this destination while the
bf7cd94d 79 * path is unresolved
d19b3bf6 80 * @sn: target sequence number
ccf80ddf
LCC
81 * @metric: current metric to this destination
82 * @hop_count: hops to destination
83 * @exp_time: in jiffies, when the path will expire or when it expired
84 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
bf7cd94d 85 * retry
ccf80ddf
LCC
86 * @discovery_retries: number of discovery retries
87 * @flags: mesh path flags, as specified on &enum mesh_path_flags
f5e50cd0
JC
88 * @state_lock: mesh path state lock used to protect changes to the
89 * mpath itself. No need to take this lock when adding or removing
90 * an mpath to a hash bucket on a path table.
3d045a54 91 * @rann_snd_addr: the RANN sender address
d2a079fd 92 * @rann_metric: the aggregated path metric towards the root node
728b19e5 93 * @last_preq_to_root: Timestamp of last PREQ sent to root
3d045a54 94 * @is_root: the destination station of this path is a root node
5ee68e5b 95 * @is_gate: the destination station of this path is a mesh gate
ccf80ddf
LCC
96 *
97 *
f698d856 98 * The combination of dst and sdata is unique in the mesh path table. Since the
d0709a65
JB
99 * next_hop STA is only protected by RCU as well, deleting the STA must also
100 * remove/substitute the mesh_path structure and wait until that is no longer
101 * reachable before 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 */
f698d856 106 struct ieee80211_sub_if_data *sdata;
40b275b6 107 struct sta_info __rcu *next_hop;
ccf80ddf
LCC
108 struct timer_list timer;
109 struct sk_buff_head frame_queue;
110 struct rcu_head rcu;
d19b3bf6 111 u32 sn;
ccf80ddf
LCC
112 u32 metric;
113 u8 hop_count;
114 unsigned long exp_time;
115 u32 discovery_timeout;
116 u8 discovery_retries;
117 enum mesh_path_flags flags;
118 spinlock_t state_lock;
3d045a54 119 u8 rann_snd_addr[ETH_ALEN];
d2a079fd 120 u32 rann_metric;
728b19e5 121 unsigned long last_preq_to_root;
3d045a54 122 bool is_root;
5ee68e5b 123 bool is_gate;
ccf80ddf
LCC
124};
125
126/**
127 * struct mesh_table
128 *
129 * @hash_buckets: array of hash buckets of the table
130 * @hashwlock: array of locks to protect write operations, one per bucket
131 * @hash_mask: 2^size_order - 1, used to compute hash idx
132 * @hash_rnd: random value used for hash computations
133 * @entries: number of entries in the table
134 * @free_node: function to free nodes of the table
eef35c2d 135 * @copy_node: function to copy nodes of the table
ccf80ddf
LCC
136 * @size_order: determines size of the table, there will be 2^size_order hash
137 * buckets
138 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
139 * reached, the table will grow
5ee68e5b
JC
140 * @known_gates: list of known mesh gates and their mpaths by the station. The
141 * gate's mpath may or may not be resolved and active.
142 *
1928ecab 143 * rcu_head: RCU head to free the table
ccf80ddf
LCC
144 */
145struct mesh_table {
146 /* Number of buckets will be 2^N */
147 struct hlist_head *hash_buckets;
148 spinlock_t *hashwlock; /* One per bucket, for add/del */
149 unsigned int hash_mask; /* (2^size_order) - 1 */
150 __u32 hash_rnd; /* Used for hash generation */
151 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
152 void (*free_node) (struct hlist_node *p, bool free_leafs);
4caf86c6 153 int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
ccf80ddf
LCC
154 int size_order;
155 int mean_chain_len;
5ee68e5b
JC
156 struct hlist_head *known_gates;
157 spinlock_t gates_lock;
1928ecab
JB
158
159 struct rcu_head rcu_head;
ccf80ddf
LCC
160};
161
162/* Recent multicast cache */
163/* RMC_BUCKETS must be a power of 2, maximum 256 */
164#define RMC_BUCKETS 256
165#define RMC_QUEUE_MAX_LEN 4
166#define RMC_TIMEOUT (3 * HZ)
167
168/**
169 * struct rmc_entry - entry in the Recent Multicast Cache
170 *
171 * @seqnum: mesh sequence number of the frame
172 * @exp_time: expiration time of the entry, in jiffies
173 * @sa: source address of the frame
174 *
175 * The Recent Multicast Cache keeps track of the latest multicast frames that
176 * have been received by a mesh interface and discards received multicast frames
177 * that are found in the cache.
178 */
179struct rmc_entry {
180 struct list_head list;
181 u32 seqnum;
182 unsigned long exp_time;
183 u8 sa[ETH_ALEN];
184};
185
186struct mesh_rmc {
b7cfcd11 187 struct list_head bucket[RMC_BUCKETS];
51ceddad 188 u32 idx_mask;
ccf80ddf
LCC
189};
190
25d49e4d
TP
191#define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ)
192#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf 193
ccf80ddf
LCC
194#define MESH_PATH_EXPIRE (600 * HZ)
195
ccf80ddf
LCC
196/* Default maximum number of plinks per interface */
197#define MESH_MAX_PLINKS 256
198
199/* Maximum number of paths per interface */
200#define MESH_MAX_MPATHS 1024
201
4bd4c2dd
TP
202/* Number of frames buffered per destination for unresolved destinations */
203#define MESH_FRAME_QUEUE_LEN 10
204
ccf80ddf
LCC
205/* Public interfaces */
206/* Various */
3c5772a5 207int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
15ff6365 208 const u8 *da, const u8 *sa);
bf7cd94d
JB
209int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
210 struct ieee80211s_hdr *meshhdr,
211 const char *addr4or5, const char *addr6);
212int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
213 const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
f743ff49
TP
214bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
215 struct ieee802_11_elems *ie);
472dbc45 216void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
bf7cd94d
JB
217void mesh_mgmt_ies_add(struct ieee80211_sub_if_data *sdata,
218 struct sk_buff *skb);
219int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
220 struct sk_buff *skb);
221int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
222 struct sk_buff *skb);
223int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
224 struct sk_buff *skb);
225int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
226 struct sk_buff *skb);
227int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
228 struct sk_buff *skb);
229int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
230 struct sk_buff *skb);
f698d856
JBG
231void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
232int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf 233void ieee80211s_init(void);
bfc32e6a 234void ieee80211s_update_metric(struct ieee80211_local *local,
bf7cd94d 235 struct sta_info *sta, struct sk_buff *skb);
902acc78 236void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967 237int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45 238void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 239void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3 240const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967
TP
241/* wrapper for ieee80211_bss_info_change_notify() */
242void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
243 u32 changed);
902acc78 244
3f52b7e3 245/* mesh power save */
39886b61
TP
246u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
247u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
248 enum nl80211_mesh_power_mode pm);
3f52b7e3
MP
249void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
250 struct sta_info *sta,
251 struct ieee80211_hdr *hdr);
252void ieee80211_mps_sta_status_update(struct sta_info *sta);
253void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
254 struct ieee80211_hdr *hdr);
255void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
256 bool tx, bool acked);
257void ieee80211_mps_frame_release(struct sta_info *sta,
258 struct ieee802_11_elems *elems);
259
ccf80ddf 260/* Mesh paths */
bf7cd94d
JB
261int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
262 struct sk_buff *skb);
263int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
264 struct sk_buff *skb);
f698d856 265void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d
JB
266struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
267 const u8 *dst);
268struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
269 const u8 *dst);
270int mpp_path_add(struct ieee80211_sub_if_data *sdata,
271 const u8 *dst, const u8 *mpp);
272struct mesh_path *
273mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf 274void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856 275void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856 276void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d 277 struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0
BC
278struct mesh_path *
279mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
5ee68e5b
JC
280
281int mesh_path_add_gate(struct mesh_path *mpath);
282int mesh_path_send_to_gates(struct mesh_path *mpath);
283int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
bf7cd94d 284
ccf80ddf 285/* Mesh plinks */
f743ff49 286void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
bf7cd94d 287 u8 *hw_addr, struct ieee802_11_elems *ie);
f698d856 288bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
df323818 289u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
ccf80ddf 290void mesh_plink_broken(struct sta_info *sta);
45b5028e 291u32 mesh_plink_deactivate(struct sta_info *sta);
39886b61
TP
292u32 mesh_plink_open(struct sta_info *sta);
293u32 mesh_plink_block(struct sta_info *sta);
f698d856
JBG
294void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
295 struct ieee80211_mgmt *mgmt, size_t len,
296 struct ieee80211_rx_status *rx_status);
45b5028e 297void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf
LCC
298
299/* Private interfaces */
300/* Mesh tables */
18889231
JC
301void mesh_mpath_table_grow(void);
302void mesh_mpp_table_grow(void);
ccf80ddf 303/* Mesh paths */
bf7cd94d
JB
304int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
305 u8 ttl, const u8 *target, __le32 target_sn,
306 __le16 target_rcode, const u8 *ra);
ccf80ddf
LCC
307void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
308void mesh_path_flush_pending(struct mesh_path *mpath);
309void mesh_path_tx_pending(struct mesh_path *mpath);
310int mesh_pathtbl_init(void);
311void mesh_pathtbl_unregister(void);
bf7cd94d 312int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
ccf80ddf
LCC
313void mesh_path_timer(unsigned long data);
314void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d
JB
315void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
316 struct sk_buff *skb);
e304bfd3 317void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 318
25d49e4d 319bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
f5ea9120
JB
320extern int mesh_paths_generation;
321
902acc78 322#ifdef CONFIG_MAC80211_MESH
1617bab8
MP
323static inline
324u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
325{
326 atomic_inc(&sdata->u.mesh.estab_plinks);
327 return mesh_accept_plinks_update(sdata);
328}
329
330static inline
331u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
332{
333 atomic_dec(&sdata->u.mesh.estab_plinks);
334 return mesh_accept_plinks_update(sdata);
335}
336
ccf80ddf
LCC
337static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
338{
472dbc45 339 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976 340 atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf
LCC
341}
342
343static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
344{
d0709a65 345 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC
346 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
347}
348
349static inline void mesh_path_activate(struct mesh_path *mpath)
350{
351 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
352}
353
c7108a71
JC
354static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
355{
356 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
357}
358
472dbc45
JB
359void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);
360
94c514fe 361void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
dbf498fb 362void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
bf7cd94d 363void ieee80211s_stop(void);
902acc78 364#else
472dbc45
JB
365static inline void
366ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
c7108a71
JC
367static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
368{ return false; }
94c514fe
AE
369static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
370{}
bf7cd94d 371static inline void ieee80211s_stop(void) {}
902acc78
JB
372#endif
373
ccf80ddf 374#endif /* IEEE80211S_H */