[deliverable/linux.git] / net / mac80211 / mesh.h

/*
 * Copyright (c) 2008, 2009 open80211s Ltd.
 * Authors:    Luis Carlos Cobo <luisca@cozybit.com>
 *             Javier Cardona <javier@cozybit.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#ifndef IEEE80211S_H
#define IEEE80211S_H

#include <linux/types.h>
#include <linux/jhash.h>
#include "ieee80211_i.h"


/* Data structures */

/**
 * enum mesh_config_capab_flags - mesh config IE capability flags
 *
 * @MESHCONF_CAPAB_ACCEPT_PLINKS: STA is willing to establish
 * additional mesh peerings with other mesh STAs
 * @MESHCONF_CAPAB_FORWARDING: the STA forwards MSDUs
 * @MESHCONF_CAPAB_TBTT_ADJUSTING: TBTT adjustment procedure is ongoing
 */
enum mesh_config_capab_flags {
	MESHCONF_CAPAB_ACCEPT_PLINKS = BIT(0),
	MESHCONF_CAPAB_FORWARDING = BIT(3),
	MESHCONF_CAPAB_TBTT_ADJUSTING = BIT(5),
};

/**
 * enum mesh_path_flags - mac80211 mesh path flags
 *
 *
 *
 * @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
 * @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
 * @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
 * 	number
 * @MESH_PATH_FIXED: the mesh path has been manually set and should not be
 * 	modified
 * @MESH_PATH_RESOLVED: the mesh path can has been resolved
 * @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
 * already queued up, waiting for the discovery process to start.
 *
 * MESH_PATH_RESOLVED is used by the mesh path timer to
 * decide when to stop or cancel the mesh path discovery.
 */
enum mesh_path_flags {
	MESH_PATH_ACTIVE =	BIT(0),
	MESH_PATH_RESOLVING =	BIT(1),
	MESH_PATH_SN_VALID =	BIT(2),
	MESH_PATH_FIXED	=	BIT(3),
	MESH_PATH_RESOLVED =	BIT(4),
	MESH_PATH_REQ_QUEUED =	BIT(5),
};

/**
 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
 *
 *
 *
 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
 * @MESH_WORK_GROW_MPATH_TABLE: the mesh path table is full and needs
 * to grow.
 * @MESH_WORK_GROW_MPP_TABLE: the mesh portals table is full and needs to
 * grow
 * @MESH_WORK_ROOT: the mesh root station needs to send a frame
 * @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
 * mesh nodes
 */
enum mesh_deferred_task_flags {
	MESH_WORK_HOUSEKEEPING,
	MESH_WORK_GROW_MPATH_TABLE,
	MESH_WORK_GROW_MPP_TABLE,
	MESH_WORK_ROOT,
	MESH_WORK_DRIFT_ADJUST,
};

/**
 * struct mesh_path - mac80211 mesh path structure
 *
 * @dst: mesh path destination mac address
 * @sdata: mesh subif
 * @next_hop: mesh neighbor to which frames for this destination will be
 * 	forwarded
 * @timer: mesh path discovery timer
 * @frame_queue: pending queue for frames sent to this destination while the
 * 	path is unresolved
 * @sn: target sequence number
 * @metric: current metric to this destination
 * @hop_count: hops to destination
 * @exp_time: in jiffies, when the path will expire or when it expired
 * @discovery_timeout: timeout (lapse in jiffies) used for the last discovery
 * 	retry
 * @discovery_retries: number of discovery retries
 * @flags: mesh path flags, as specified on &enum mesh_path_flags
 * @state_lock: mesh path state lock used to protect changes to the
 * mpath itself.  No need to take this lock when adding or removing
 * an mpath to a hash bucket on a path table.
 * @rann_snd_addr: the RANN sender address
 * @rann_metric: the aggregated path metric towards the root node
 * @last_preq_to_root: Timestamp of last PREQ sent to root
 * @is_root: the destination station of this path is a root node
 * @is_gate: the destination station of this path is a mesh gate
 *
 *
 * The combination of dst and sdata is unique in the mesh path table. Since the
 * next_hop STA is only protected by RCU as well, deleting the STA must also
 * remove/substitute the mesh_path structure and wait until that is no longer
 * reachable before destroying the STA completely.
 */
struct mesh_path {
	u8 dst[ETH_ALEN];
	u8 mpp[ETH_ALEN];	/* used for MPP or MAP */
	struct ieee80211_sub_if_data *sdata;
	struct sta_info __rcu *next_hop;
	struct timer_list timer;
	struct sk_buff_head frame_queue;
	struct rcu_head rcu;
	u32 sn;
	u32 metric;
	u8 hop_count;
	unsigned long exp_time;
	u32 discovery_timeout;
	u8 discovery_retries;
	enum mesh_path_flags flags;
	spinlock_t state_lock;
	u8 rann_snd_addr[ETH_ALEN];
	u32 rann_metric;
	unsigned long last_preq_to_root;
	bool is_root;
	bool is_gate;
};

/**
 * struct mesh_table
 *
 * @hash_buckets: array of hash buckets of the table
 * @hashwlock: array of locks to protect write operations, one per bucket
 * @hash_mask: 2^size_order - 1, used to compute hash idx
 * @hash_rnd: random value used for hash computations
 * @entries: number of entries in the table
 * @free_node: function to free nodes of the table
 * @copy_node: function to copy nodes of the table
 * @size_order: determines size of the table, there will be 2^size_order hash
 *	buckets
 * @mean_chain_len: maximum average length for the hash buckets' list, if it is
 *	reached, the table will grow
 * @known_gates: list of known mesh gates and their mpaths by the station. The
 * gate's mpath may or may not be resolved and active.
 *
 * rcu_head: RCU head to free the table
 */
struct mesh_table {
	/* Number of buckets will be 2^N */
	struct hlist_head *hash_buckets;
	spinlock_t *hashwlock;		/* One per bucket, for add/del */
	unsigned int hash_mask;		/* (2^size_order) - 1 */
	__u32 hash_rnd;			/* Used for hash generation */
	atomic_t entries;		/* Up to MAX_MESH_NEIGHBOURS */
	void (*free_node) (struct hlist_node *p, bool free_leafs);
	int (*copy_node) (struct hlist_node *p, struct mesh_table *newtbl);
	int size_order;
	int mean_chain_len;
	struct hlist_head *known_gates;
	spinlock_t gates_lock;

	struct rcu_head rcu_head;
};

/* Recent multicast cache */
/* RMC_BUCKETS must be a power of 2, maximum 256 */
#define RMC_BUCKETS		256
#define RMC_QUEUE_MAX_LEN	4
#define RMC_TIMEOUT		(3 * HZ)

/**
 * struct rmc_entry - entry in the Recent Multicast Cache
 *
 * @seqnum: mesh sequence number of the frame
 * @exp_time: expiration time of the entry, in jiffies
 * @sa: source address of the frame
 *
 * The Recent Multicast Cache keeps track of the latest multicast frames that
 * have been received by a mesh interface and discards received multicast frames
 * that are found in the cache.
 */
struct rmc_entry {
	struct list_head list;
	u32 seqnum;
	unsigned long exp_time;
	u8 sa[ETH_ALEN];
};

struct mesh_rmc {
	struct rmc_entry bucket[RMC_BUCKETS];
	u32 idx_mask;
};

#define IEEE80211_MESH_PEER_INACTIVITY_LIMIT (1800 * HZ)
#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)

#define MESH_DEFAULT_BEACON_INTERVAL		1000 	/* in 1024 us units */

#define MESH_PATH_EXPIRE (600 * HZ)

/* Default maximum number of plinks per interface */
#define MESH_MAX_PLINKS		256

/* Maximum number of paths per interface */
#define MESH_MAX_MPATHS		1024

/* Public interfaces */
/* Various */
int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
				  const u8 *da, const u8 *sa);
int ieee80211_new_mesh_header(struct ieee80211s_hdr *meshhdr,
		struct ieee80211_sub_if_data *sdata, char *addr4or5,
		char *addr6);
int mesh_rmc_check(u8 *addr, struct ieee80211s_hdr *mesh_hdr,
		struct ieee80211_sub_if_data *sdata);
bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
			struct ieee802_11_elems *ie);
void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
void mesh_mgmt_ies_add(struct sk_buff *skb,
		struct ieee80211_sub_if_data *sdata);
int mesh_add_meshconf_ie(struct sk_buff *skb,
			 struct ieee80211_sub_if_data *sdata);
int mesh_add_meshid_ie(struct sk_buff *skb,
		       struct ieee80211_sub_if_data *sdata);
int mesh_add_rsn_ie(struct sk_buff *skb,
		    struct ieee80211_sub_if_data *sdata);
int mesh_add_vendor_ies(struct sk_buff *skb,
			struct ieee80211_sub_if_data *sdata);
int mesh_add_ds_params_ie(struct sk_buff *skb,
			  struct ieee80211_sub_if_data *sdata);
int mesh_add_ht_cap_ie(struct sk_buff *skb,
		       struct ieee80211_sub_if_data *sdata);
int mesh_add_ht_oper_ie(struct sk_buff *skb,
			struct ieee80211_sub_if_data *sdata);
void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
void ieee80211s_init(void);
void ieee80211s_update_metric(struct ieee80211_local *local,
		struct sta_info *sta, struct sk_buff *skb);
void ieee80211s_stop(void);
void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
void ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);

/* Mesh paths */
int mesh_nexthop_lookup(struct sk_buff *skb,
		struct ieee80211_sub_if_data *sdata);
int mesh_nexthop_resolve(struct sk_buff *skb,
			 struct ieee80211_sub_if_data *sdata);
void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
struct mesh_path *mesh_path_lookup(u8 *dst,
		struct ieee80211_sub_if_data *sdata);
struct mesh_path *mpp_path_lookup(u8 *dst,
				  struct ieee80211_sub_if_data *sdata);
int mpp_path_add(u8 *dst, u8 *mpp, struct ieee80211_sub_if_data *sdata);
struct mesh_path *mesh_path_lookup_by_idx(int idx,
		struct ieee80211_sub_if_data *sdata);
void mesh_path_fix_nexthop(struct mesh_path *mpath, struct sta_info *next_hop);
void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
		struct ieee80211_mgmt *mgmt, size_t len);
int mesh_path_add(u8 *dst, struct ieee80211_sub_if_data *sdata);

int mesh_path_add_gate(struct mesh_path *mpath);
int mesh_path_send_to_gates(struct mesh_path *mpath);
int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
/* Mesh plinks */
void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
			   u8 *hw_addr,
			   struct ieee802_11_elems *ie);
bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
void mesh_plink_broken(struct sta_info *sta);
void mesh_plink_deactivate(struct sta_info *sta);
int mesh_plink_open(struct sta_info *sta);
void mesh_plink_block(struct sta_info *sta);
void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
			 struct ieee80211_mgmt *mgmt, size_t len,
			 struct ieee80211_rx_status *rx_status);

/* Private interfaces */
/* Mesh tables */
void mesh_mpath_table_grow(void);
void mesh_mpp_table_grow(void);
/* Mesh paths */
int mesh_path_error_tx(u8 ttl, u8 *target, __le32 target_sn, __le16 target_rcode,
		       const u8 *ra, struct ieee80211_sub_if_data *sdata);
void mesh_path_assign_nexthop(struct mesh_path *mpath, struct sta_info *sta);
void mesh_path_flush_pending(struct mesh_path *mpath);
void mesh_path_tx_pending(struct mesh_path *mpath);
int mesh_pathtbl_init(void);
void mesh_pathtbl_unregister(void);
int mesh_path_del(u8 *addr, struct ieee80211_sub_if_data *sdata);
void mesh_path_timer(unsigned long data);
void mesh_path_flush_by_nexthop(struct sta_info *sta);
void mesh_path_discard_frame(struct sk_buff *skb,
		struct ieee80211_sub_if_data *sdata);
void mesh_path_quiesce(struct ieee80211_sub_if_data *sdata);
void mesh_path_restart(struct ieee80211_sub_if_data *sdata);
void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);

bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
extern int mesh_paths_generation;

#ifdef CONFIG_MAC80211_MESH
extern int mesh_allocated;

static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
{
	return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
	       atomic_read(&sdata->u.mesh.mshstats.estab_plinks);
}

static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
{
	return (min_t(long, mesh_plink_free_count(sdata),
		   MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
}

static inline void mesh_path_activate(struct mesh_path *mpath)
{
	mpath->flags |= MESH_PATH_ACTIVE | MESH_PATH_RESOLVED;
}

static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
{
	return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
}

void ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local);

void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata);
void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata);
void mesh_plink_quiesce(struct sta_info *sta);
void mesh_plink_restart(struct sta_info *sta);
void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
void mesh_sync_adjust_tbtt(struct ieee80211_sub_if_data *sdata);
#else
#define mesh_allocated	0
static inline void
ieee80211_mesh_notify_scan_completed(struct ieee80211_local *local) {}
static inline void ieee80211_mesh_quiesce(struct ieee80211_sub_if_data *sdata)
{}
static inline void ieee80211_mesh_restart(struct ieee80211_sub_if_data *sdata)
{}
static inline void mesh_plink_quiesce(struct sta_info *sta) {}
static inline void mesh_plink_restart(struct sta_info *sta) {}
static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
{ return false; }
static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
{}
#endif

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