mac80211: mesh: fix mesh path kerneldoc
[deliverable/linux.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 *
eb80ed8d
RR
24 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
25 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6 26 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
bf7cd94d 27 * number
ccf80ddf 28 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
bf7cd94d 29 * modified
ccf80ddf 30 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9 31 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
bf7cd94d 32 * already queued up, waiting for the discovery process to start.
74932959
BC
33 * @MESH_PATH_DELETED: the mesh path has been deleted and should no longer
34 * be used
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),
74932959 46 MESH_PATH_DELETED = BIT(6),
ccf80ddf
LCC
47};
48
18889231
JC
49/**
50 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
51 *
52 *
53 *
54 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
e304bfd3 55 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb
JC
56 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
57 * mesh nodes
f81a9ded 58 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
18889231
JC
59 */
60enum mesh_deferred_task_flags {
61 MESH_WORK_HOUSEKEEPING,
e304bfd3 62 MESH_WORK_ROOT,
dbf498fb 63 MESH_WORK_DRIFT_ADJUST,
f81a9ded 64 MESH_WORK_MBSS_CHANGED,
18889231
JC
65};
66
ccf80ddf
LCC
67/**
68 * struct mesh_path - mac80211 mesh path structure
69 *
70 * @dst: mesh path destination mac address
68bb54b4
BC
71 * @mpp: mesh proxy mac address
72 * @rhash: rhashtable list pointer
73 * @gate_list: list pointer for known gates list
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
68bb54b4 80 * @rcu: rcu head for freeing mesh path
d19b3bf6 81 * @sn: target sequence number
ccf80ddf
LCC
82 * @metric: current metric to this destination
83 * @hop_count: hops to destination
84 * @exp_time: in jiffies, when the path will expire or when it expired
85 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
bf7cd94d 86 * retry
ccf80ddf
LCC
87 * @discovery_retries: number of discovery retries
88 * @flags: mesh path flags, as specified on &enum mesh_path_flags
f5e50cd0
JC
89 * @state_lock: mesh path state lock used to protect changes to the
90 * mpath itself. No need to take this lock when adding or removing
91 * an mpath to a hash bucket on a path table.
3d045a54 92 * @rann_snd_addr: the RANN sender address
d2a079fd 93 * @rann_metric: the aggregated path metric towards the root node
728b19e5 94 * @last_preq_to_root: Timestamp of last PREQ sent to root
3d045a54 95 * @is_root: the destination station of this path is a root node
5ee68e5b 96 * @is_gate: the destination station of this path is a mesh gate
ccf80ddf
LCC
97 *
98 *
68bb54b4
BC
99 * The dst address is unique in the mesh path table. Since the mesh_path is
100 * protected by RCU, deleting the next_hop STA must remove / substitute the
101 * mesh_path structure and wait until that is no longer reachable before
102 * destroying the STA completely.
ccf80ddf
LCC
103 */
104struct mesh_path {
105 u8 dst[ETH_ALEN];
79617dee 106 u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
60854fd9 107 struct rhash_head rhash;
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;
ccf80ddf
LCC
127};
128
129/**
130 * struct mesh_table
131 *
5ee68e5b
JC
132 * @known_gates: list of known mesh gates and their mpaths by the station. The
133 * gate's mpath may or may not be resolved and active.
68bb54b4
BC
134 * @gates_lock: protects updates to known_gates
135 * @rhead: the rhashtable containing struct mesh_paths, keyed by dest addr
136 * @entries: number of entries in the table
ccf80ddf
LCC
137 */
138struct mesh_table {
18b27ff7 139 struct hlist_head known_gates;
5ee68e5b 140 spinlock_t gates_lock;
60854fd9 141 struct rhashtable rhead;
3257523b 142 atomic_t entries; /* Up to MAX_MESH_NEIGHBOURS */
ccf80ddf
LCC
143};
144
145/* Recent multicast cache */
146/* RMC_BUCKETS must be a power of 2, maximum 256 */
147#define RMC_BUCKETS 256
148#define RMC_QUEUE_MAX_LEN 4
149#define RMC_TIMEOUT (3 * HZ)
150
151/**
152 * struct rmc_entry - entry in the Recent Multicast Cache
153 *
154 * @seqnum: mesh sequence number of the frame
155 * @exp_time: expiration time of the entry, in jiffies
156 * @sa: source address of the frame
68bb54b4 157 * @list: hashtable list pointer
ccf80ddf
LCC
158 *
159 * The Recent Multicast Cache keeps track of the latest multicast frames that
160 * have been received by a mesh interface and discards received multicast frames
161 * that are found in the cache.
162 */
163struct rmc_entry {
47a0489c 164 struct hlist_node list;
ccf80ddf 165 unsigned long exp_time;
3257523b 166 u32 seqnum;
ccf80ddf
LCC
167 u8 sa[ETH_ALEN];
168};
169
170struct mesh_rmc {
47a0489c 171 struct hlist_head bucket[RMC_BUCKETS];
51ceddad 172 u32 idx_mask;
ccf80ddf
LCC
173};
174
25d49e4d 175#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf 176
ccf80ddf
LCC
177#define MESH_PATH_EXPIRE (600 * HZ)
178
ccf80ddf
LCC
179/* Default maximum number of plinks per interface */
180#define MESH_MAX_PLINKS 256
181
182/* Maximum number of paths per interface */
183#define MESH_MAX_MPATHS 1024
184
4bd4c2dd
TP
185/* Number of frames buffered per destination for unresolved destinations */
186#define MESH_FRAME_QUEUE_LEN 10
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);
5edfcee5
AH
192unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
193 struct ieee80211s_hdr *meshhdr,
194 const char *addr4or5, const char *addr6);
bf7cd94d
JB
195int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
196 const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
f743ff49
TP
197bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
198 struct ieee802_11_elems *ie);
472dbc45 199void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
bf7cd94d
JB
200int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
201 struct sk_buff *skb);
202int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
203 struct sk_buff *skb);
204int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
205 struct sk_buff *skb);
206int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
207 struct sk_buff *skb);
208int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
209 struct sk_buff *skb);
210int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
211 struct sk_buff *skb);
c85fb53c
BC
212int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
213 struct sk_buff *skb);
214int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
215 struct sk_buff *skb);
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 219void ieee80211s_update_metric(struct ieee80211_local *local,
bf7cd94d 220 struct sta_info *sta, struct sk_buff *skb);
902acc78 221void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967 222int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45 223void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b 224void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3 225const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967
TP
226/* wrapper for ieee80211_bss_info_change_notify() */
227void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
228 u32 changed);
902acc78 229
3f52b7e3 230/* mesh power save */
39886b61
TP
231u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
232u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
233 enum nl80211_mesh_power_mode pm);
3f52b7e3
MP
234void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
235 struct sta_info *sta,
236 struct ieee80211_hdr *hdr);
237void ieee80211_mps_sta_status_update(struct sta_info *sta);
238void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
239 struct ieee80211_hdr *hdr);
240void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
241 bool tx, bool acked);
242void ieee80211_mps_frame_release(struct sta_info *sta,
243 struct ieee802_11_elems *elems);
244
ccf80ddf 245/* Mesh paths */
bf7cd94d
JB
246int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
247 struct sk_buff *skb);
248int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
249 struct sk_buff *skb);
f698d856 250void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d
JB
251struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
252 const u8 *dst);
253struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
254 const u8 *dst);
255int mpp_path_add(struct ieee80211_sub_if_data *sdata,
256 const u8 *dst, const u8 *mpp);
257struct mesh_path *
258mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
a2db2ed3
HR
259struct mesh_path *
260mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf 261void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
f698d856 262void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856 263void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d 264 struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0
BC
265struct mesh_path *
266mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);
5ee68e5b
JC
267
268int mesh_path_add_gate(struct mesh_path *mpath);
269int mesh_path_send_to_gates(struct mesh_path *mpath);
270int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
bf7cd94d 271
ccf80ddf 272/* Mesh plinks */
f743ff49 273void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
bf7cd94d 274 u8 *hw_addr, struct ieee802_11_elems *ie);
f698d856 275bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
df323818 276u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
ccf80ddf 277void mesh_plink_broken(struct sta_info *sta);
45b5028e 278u32 mesh_plink_deactivate(struct sta_info *sta);
39886b61
TP
279u32 mesh_plink_open(struct sta_info *sta);
280u32 mesh_plink_block(struct sta_info *sta);
f698d856
JBG
281void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
282 struct ieee80211_mgmt *mgmt, size_t len,
283 struct ieee80211_rx_status *rx_status);
45b5028e 284void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf
LCC
285
286/* Private interfaces */
ccf80ddf 287/* Mesh paths */
bf7cd94d 288int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
f63f8421
CYY
289 u8 ttl, const u8 *target, u32 target_sn,
290 u16 target_rcode, const u8 *ra);
ccf80ddf
LCC
291void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
292void mesh_path_flush_pending(struct mesh_path *mpath);
293void mesh_path_tx_pending(struct mesh_path *mpath);
2bdaf386
BC
294int mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
295void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
bf7cd94d 296int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
ccf80ddf
LCC
297void mesh_path_timer(unsigned long data);
298void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d
JB
299void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
300 struct sk_buff *skb);
e304bfd3 301void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf 302
25d49e4d 303bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
f5ea9120 304
902acc78 305#ifdef CONFIG_MAC80211_MESH
1617bab8
MP
306static inline
307u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
308{
309 atomic_inc(&sdata->u.mesh.estab_plinks);
e05ecccd 310 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP
311}
312
313static inline
314u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
315{
316 atomic_dec(&sdata->u.mesh.estab_plinks);
e05ecccd 317 return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
1617bab8
MP
318}
319
ccf80ddf
LCC
320static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
321{
472dbc45 322 return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976 323 atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf
LCC
324}
325
326static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
327{
d0709a65 328 return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf
LCC
329 MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
330}
331
332static inline void mesh_path_activate(struct mesh_path *mpath)
333{
334 mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
335}
336
c7108a71
JC
337static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
338{
339 return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
340}
341
94c514fe 342void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
dbf498fb 343void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
bf7cd94d 344void ieee80211s_stop(void);
902acc78 345#else
c7108a71
JC
346static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
347{ return false; }
94c514fe
AE
348static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
349{}
bf7cd94d 350static inline void ieee80211s_stop(void) {}
902acc78
JB
351#endif
352
ccf80ddf 353#endif /* IEEE80211S_H */
This page took 0.630065 seconds and 5 git commands to generate.