[linux-block.git] / net / mac80211 / mesh.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2008, 2009 open80211s Ltd.
 * Authors:    Luis Carlos Cobo <luisca@cozybit.com>
 *             Javier Cardona <javier@cozybit.com>
 */

#ifndef IEEE80211S_H
#define IEEE80211S_H

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


/* Data structures */

/**
 * 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_DELETED: the mesh path has been deleted and should no longer
 *	be used
 *
 * 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),
	MESH_PATH_DELETED =	BIT(6),
};

/**
 * enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
 *
 *
 *
 * @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
 * @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
 * @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
 */
enum mesh_deferred_task_flags {
	MESH_WORK_HOUSEKEEPING,
	MESH_WORK_ROOT,
	MESH_WORK_DRIFT_ADJUST,
	MESH_WORK_MBSS_CHANGED,
};

/**
 * struct mesh_path - mac80211 mesh path structure
 *
 * @dst: mesh path destination mac address
 * @mpp: mesh proxy mac address
 * @rhash: rhashtable list pointer
 * @walk_list: linked list containing all mesh_path objects.
 * @gate_list: list pointer for known gates list
 * @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
 * @rcu: rcu head for freeing mesh path
 * @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
 * @path_change_count: the number of path changes to destination
 *
 *
 * The dst address is unique in the mesh path table. Since the mesh_path is
 * protected by RCU, deleting the next_hop STA must 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 rhash_head rhash;
	struct hlist_node walk_list;
	struct hlist_node gate_list;
	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;
	unsigned long fast_tx_check;
	bool is_root;
	bool is_gate;
	u32 path_change_count;
};

#define MESH_FAST_TX_CACHE_MAX_SIZE		512
#define MESH_FAST_TX_CACHE_THRESHOLD_SIZE	384
#define MESH_FAST_TX_CACHE_TIMEOUT		8000 /* msecs */

/**
 * struct ieee80211_mesh_fast_tx - cached mesh fast tx entry
 * @rhash: rhashtable pointer
 * @addr_key: The Ethernet DA which is the key for this entry
 * @fast_tx: base fast_tx data
 * @hdr: cached mesh and rfc1042 headers
 * @hdrlen: length of mesh + rfc1042
 * @walk_list: list containing all the fast tx entries
 * @mpath: mesh path corresponding to the Mesh DA
 * @mppath: MPP entry corresponding to this DA
 * @timestamp: Last used time of this entry
 */
struct ieee80211_mesh_fast_tx {
	struct rhash_head rhash;
	u8 addr_key[ETH_ALEN] __aligned(2);

	struct ieee80211_fast_tx fast_tx;
	u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)];
	u16 hdrlen;

	struct mesh_path *mpath, *mppath;
	struct hlist_node walk_list;
	unsigned long timestamp;
};

/* 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
 * @list: hashtable list pointer
 *
 * 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 hlist_node list;
	unsigned long exp_time;
	u32 seqnum;
	u8 sa[ETH_ALEN];
};

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

#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)

#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

/* Number of frames buffered per destination for unresolved destinations */
#define MESH_FRAME_QUEUE_LEN	10

/* Public interfaces */
/* Various */
int ieee80211_fill_mesh_addresses(struct ieee80211_hdr *hdr, __le16 *fc,
				  const u8 *da, const u8 *sa);
unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
				       struct ieee80211s_hdr *meshhdr,
				       const char *addr4or5, const char *addr6);
int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
		   const u8 *addr, struct ieee80211s_hdr *mesh_hdr);
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);
int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
		       struct sk_buff *skb);
int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
		    struct sk_buff *skb);
int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
		       struct sk_buff *skb);
int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata,
		       struct sk_buff *skb, u8 ie_len);
int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata,
			    struct sk_buff *skb);
int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb, u8 ie_len);
int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
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 ieee80211_tx_status *st);
void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
int 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);
const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
/* wrapper for ieee80211_bss_info_change_notify() */
void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
				       u32 changed);

/* mesh power save */
u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
				   enum nl80211_mesh_power_mode pm);
void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
				   struct sta_info *sta,
				   struct ieee80211_hdr *hdr);
void ieee80211_mps_sta_status_update(struct sta_info *sta);
void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
				    struct ieee80211_hdr *hdr);
void ieee80211_mpsp_trigger_process(u8 *qc, struct sta_info *sta,
				    bool tx, bool acked);
void ieee80211_mps_frame_release(struct sta_info *sta,
				 struct ieee802_11_elems *elems);

/* Mesh paths */
int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb);
int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
			 struct sk_buff *skb);
void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
struct mesh_path *mesh_path_lookup(struct ieee80211_sub_if_data *sdata,
				   const u8 *dst);
struct mesh_path *mpp_path_lookup(struct ieee80211_sub_if_data *sdata,
				  const u8 *dst);
int mpp_path_add(struct ieee80211_sub_if_data *sdata,
		 const u8 *dst, const u8 *mpp);
struct mesh_path *
mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
struct mesh_path *
mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
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);
struct mesh_path *
mesh_path_add(struct ieee80211_sub_if_data *sdata, const u8 *dst);

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);
u32 airtime_link_metric_get(struct ieee80211_local *local,
			    struct sta_info *sta);

/* Mesh plinks */
void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
			   u8 *hw_addr, struct ieee802_11_elems *ie,
			   struct ieee80211_rx_status *rx_status);
bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
void mesh_plink_timer(struct timer_list *t);
void mesh_plink_broken(struct sta_info *sta);
u32 mesh_plink_deactivate(struct sta_info *sta);
u32 mesh_plink_open(struct sta_info *sta);
u32 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);
void mesh_sta_cleanup(struct sta_info *sta);

/* Private interfaces */
/* Mesh paths */
int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
		       u8 ttl, const u8 *target, u32 target_sn,
		       u16 target_rcode, const u8 *ra);
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);
void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
int mesh_path_del(struct ieee80211_sub_if_data *sdata, const u8 *addr);
void mesh_path_timer(struct timer_list *t);
void mesh_path_flush_by_nexthop(struct sta_info *sta);
void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
			     struct sk_buff *skb);
void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);

bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
struct ieee80211_mesh_fast_tx *
mesh_fast_tx_get(struct ieee80211_sub_if_data *sdata, const u8 *addr);
bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata,
			      struct sk_buff *skb, u32 ctrl_flags);
void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata,
			struct sk_buff *skb, struct mesh_path *mpath);
void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata);
void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata,
			     const u8 *addr);
void mesh_fast_tx_flush_mpath(struct mesh_path *mpath);
void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata,
			    struct sta_info *sta);
void mesh_path_refresh(struct ieee80211_sub_if_data *sdata,
		       struct mesh_path *mpath, const u8 *addr);

#ifdef CONFIG_MAC80211_MESH
static inline
u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
{
	atomic_inc(&sdata->u.mesh.estab_plinks);
	return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
}

static inline
u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
{
	atomic_dec(&sdata->u.mesh.estab_plinks);
	return mesh_accept_plinks_update(sdata) | BSS_CHANGED_BEACON;
}

static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
{
	return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
	       atomic_read(&sdata->u.mesh.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 mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
void ieee80211s_stop(void);
#else
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)
{}
static inline void ieee80211s_stop(void) {}
#endif

#endif /* IEEE80211S_H */
Commit	Line	Data
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>
ccf80ddf LCC	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
eb80ed8d RR	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
74932959 BC	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	*/
	36	enum 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),
ccf80ddf LCC	41	MESH_PATH_RESOLVED = BIT(4),
f3011cf9	42	MESH_PATH_REQ_QUEUED = BIT(5),
74932959	43	MESH_PATH_DELETED = BIT(6),
ccf80ddf LCC	44	};
ccf80ddf LCC	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
dbf498fb JC	54	* mesh nodes
f81a9ded	55	* @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
18889231 JC	56	*/
	57	enum 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	};
18889231 JC	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
68bb54b4 BC	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
ccf80ddf LCC	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
ccf80ddf LCC	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	*
ccf80ddf LCC	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	*/
	103	struct 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;
d5edb9ae	125	unsigned long fast_tx_check;
3d045a54	126	bool is_root;
5ee68e5b	127	bool is_gate;
540bbcb9	128	u32 path_change_count;
ccf80ddf LCC	129	};
ccf80ddf LCC	130
d5edb9ae FF	131	#define MESH_FAST_TX_CACHE_MAX_SIZE 512
	132	#define MESH_FAST_TX_CACHE_THRESHOLD_SIZE 384
	133	#define MESH_FAST_TX_CACHE_TIMEOUT 8000 /* msecs */
	134
	135	/**
	136	* struct ieee80211_mesh_fast_tx - cached mesh fast tx entry
	137	* @rhash: rhashtable pointer
	138	* @addr_key: The Ethernet DA which is the key for this entry
	139	* @fast_tx: base fast_tx data
	140	* @hdr: cached mesh and rfc1042 headers
	141	* @hdrlen: length of mesh + rfc1042
	142	* @walk_list: list containing all the fast tx entries
	143	* @mpath: mesh path corresponding to the Mesh DA
	144	* @mppath: MPP entry corresponding to this DA
	145	* @timestamp: Last used time of this entry
	146	*/
	147	struct ieee80211_mesh_fast_tx {
	148	struct rhash_head rhash;
	149	u8 addr_key[ETH_ALEN] __aligned(2);
	150
	151	struct ieee80211_fast_tx fast_tx;
	152	u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)];
	153	u16 hdrlen;
	154
	155	struct mesh_path mpath, mppath;
	156	struct hlist_node walk_list;
	157	unsigned long timestamp;
	158	};
	159
ccf80ddf LCC	160	/* Recent multicast cache */
	161	/* RMC_BUCKETS must be a power of 2, maximum 256 */
	162	#define RMC_BUCKETS 256
	163	#define RMC_QUEUE_MAX_LEN 4
	164	#define RMC_TIMEOUT (3 * HZ)
	165
	166	/**
	167	* struct rmc_entry - entry in the Recent Multicast Cache
	168	*
	169	* @seqnum: mesh sequence number of the frame
	170	* @exp_time: expiration time of the entry, in jiffies
	171	* @sa: source address of the frame
68bb54b4	172	* @list: hashtable list pointer
ccf80ddf LCC	173	*
	174	* The Recent Multicast Cache keeps track of the latest multicast frames that
	175	* have been received by a mesh interface and discards received multicast frames
	176	* that are found in the cache.
	177	*/
	178	struct rmc_entry {
47a0489c	179	struct hlist_node list;
ccf80ddf	180	unsigned long exp_time;
3257523b	181	u32 seqnum;
ccf80ddf LCC	182	u8 sa[ETH_ALEN];
	183	};
	184
	185	struct mesh_rmc {
47a0489c	186	struct hlist_head bucket[RMC_BUCKETS];
51ceddad	187	u32 idx_mask;
ccf80ddf LCC	188	};
ccf80ddf LCC	189
25d49e4d	190	#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf	191
ccf80ddf LCC	192	#define MESH_PATH_EXPIRE (600 * HZ)
ccf80ddf LCC	193
ccf80ddf LCC	194	/* Default maximum number of plinks per interface */
	195	#define MESH_MAX_PLINKS 256
	196
	197	/* Maximum number of paths per interface */
	198	#define MESH_MAX_MPATHS 1024
	199
4bd4c2dd TP	200	/* Number of frames buffered per destination for unresolved destinations */
	201	#define MESH_FRAME_QUEUE_LEN 10
	202
ccf80ddf LCC	203	/* Public interfaces */
ccf80ddf LCC	204	/* Various */
3c5772a5	205	int ieee80211_fill_mesh_addresses(struct ieee80211_hdr hdr, __le16 fc,
15ff6365	206	const u8 da, const u8 sa);
5edfcee5 AH	207	unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
	208	struct ieee80211s_hdr *meshhdr,
	209	const char addr4or5, const char addr6);
bf7cd94d JB	210	int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
bf7cd94d JB	211	const u8 addr, struct ieee80211s_hdr mesh_hdr);
f743ff49 TP	212	bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
f743ff49 TP	213	struct ieee802_11_elems *ie);
472dbc45	214	void mesh_ids_set_default(struct ieee80211_if_mesh *mesh);
bf7cd94d JB	215	int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
	216	struct sk_buff *skb);
	217	int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
	218	struct sk_buff *skb);
	219	int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
	220	struct sk_buff *skb);
	221	int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
	222	struct sk_buff *skb);
	223	int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
	224	struct sk_buff *skb);
	225	int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
	226	struct sk_buff *skb);
c85fb53c BC	227	int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
	228	struct sk_buff *skb);
	229	int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
	230	struct sk_buff *skb);
60ad72da SE	231	int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata,
	232	struct sk_buff *skb, u8 ie_len);
	233	int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata,
	234	struct sk_buff *skb);
24a2042c RM	235	int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata,
24a2042c RM	236	struct sk_buff *skb);
df1875c4 RL	237	int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata,
	238	struct sk_buff *skb, u8 ie_len);
	239	int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata,
	240	struct sk_buff *skb);
f698d856 JBG	241	void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
f698d856 JBG	242	int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf	243	void ieee80211s_init(void);
bfc32e6a	244	void ieee80211s_update_metric(struct ieee80211_local *local,
c4205510 YCP	245	struct sta_info *sta,
c4205510 YCP	246	struct ieee80211_tx_status *st);
902acc78	247	void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
0371a08f	248	void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967	249	int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45	250	void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b	251	void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3	252	const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967 TP	253	/* wrapper for ieee80211_bss_info_change_notify() */
	254	void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
	255	u32 changed);
902acc78	256
3f52b7e3	257	/* mesh power save */
39886b61 TP	258	u32 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
	259	u32 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
	260	enum nl80211_mesh_power_mode pm);
3f52b7e3 MP	261	void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
	262	struct sta_info *sta,
	263	struct ieee80211_hdr *hdr);
	264	void ieee80211_mps_sta_status_update(struct sta_info *sta);
	265	void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
	266	struct ieee80211_hdr *hdr);
	267	void ieee80211_mpsp_trigger_process(u8 qc, struct sta_info sta,
	268	bool tx, bool acked);
	269	void ieee80211_mps_frame_release(struct sta_info *sta,
	270	struct ieee802_11_elems *elems);
	271
ccf80ddf	272	/* Mesh paths */
bf7cd94d JB	273	int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
	274	struct sk_buff *skb);
	275	int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
	276	struct sk_buff *skb);
f698d856	277	void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d JB	278	struct mesh_path mesh_path_lookup(struct ieee80211_sub_if_data sdata,
	279	const u8 *dst);
	280	struct mesh_path mpp_path_lookup(struct ieee80211_sub_if_data sdata,
	281	const u8 *dst);
	282	int mpp_path_add(struct ieee80211_sub_if_data *sdata,
	283	const u8 dst, const u8 mpp);
	284	struct mesh_path *
	285	mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
a2db2ed3 HR	286	struct mesh_path *
a2db2ed3 HR	287	mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf	288	void mesh_path_fix_nexthop(struct mesh_path mpath, struct sta_info next_hop);
f698d856	289	void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856	290	void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d	291	struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0 BC	292	struct mesh_path *
ae76eef0 BC	293	mesh_path_add(struct ieee80211_sub_if_data sdata, const u8 dst);
5ee68e5b JC	294
	295	int mesh_path_add_gate(struct mesh_path *mpath);
	296	int mesh_path_send_to_gates(struct mesh_path *mpath);
	297	int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
ab60633c NM	298	u32 airtime_link_metric_get(struct ieee80211_local *local,
ab60633c NM	299	struct sta_info *sta);
bf7cd94d	300
ccf80ddf	301	/* Mesh plinks */
f743ff49	302	void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
ecbc12ad BC	303	u8 hw_addr, struct ieee802_11_elems ie,
ecbc12ad BC	304	struct ieee80211_rx_status *rx_status);
f698d856	305	bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
df323818	306	u32 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
4c02d62f	307	void mesh_plink_timer(struct timer_list *t);
ccf80ddf	308	void mesh_plink_broken(struct sta_info *sta);
45b5028e	309	u32 mesh_plink_deactivate(struct sta_info *sta);
39886b61 TP	310	u32 mesh_plink_open(struct sta_info *sta);
39886b61 TP	311	u32 mesh_plink_block(struct sta_info *sta);
f698d856 JBG	312	void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
	313	struct ieee80211_mgmt *mgmt, size_t len,
	314	struct ieee80211_rx_status *rx_status);
45b5028e	315	void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf LCC	316
ccf80ddf LCC	317	/* Private interfaces */
ccf80ddf	318	/* Mesh paths */
bf7cd94d	319	int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
f63f8421 CYY	320	u8 ttl, const u8 *target, u32 target_sn,
f63f8421 CYY	321	u16 target_rcode, const u8 *ra);
ccf80ddf LCC	322	void mesh_path_assign_nexthop(struct mesh_path mpath, struct sta_info sta);
	323	void mesh_path_flush_pending(struct mesh_path *mpath);
	324	void mesh_path_tx_pending(struct mesh_path *mpath);
8b5cb7e4	325	void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
2bdaf386	326	void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
bf7cd94d	327	int mesh_path_del(struct ieee80211_sub_if_data sdata, const u8 addr);
34f11cd3	328	void mesh_path_timer(struct timer_list *t);
ccf80ddf	329	void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d JB	330	void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d JB	331	struct sk_buff *skb);
e304bfd3	332	void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf	333
25d49e4d	334	bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
d5edb9ae FF	335	struct ieee80211_mesh_fast_tx *
	336	mesh_fast_tx_get(struct ieee80211_sub_if_data sdata, const u8 addr);
	337	bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata,
	338	struct sk_buff *skb, u32 ctrl_flags);
	339	void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata,
	340	struct sk_buff skb, struct mesh_path mpath);
	341	void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata);
	342	void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata,
	343	const u8 *addr);
	344	void mesh_fast_tx_flush_mpath(struct mesh_path *mpath);
	345	void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata,
	346	struct sta_info *sta);
	347	void mesh_path_refresh(struct ieee80211_sub_if_data *sdata,
	348	struct mesh_path mpath, const u8 addr);
f5ea9120	349
902acc78	350	#ifdef CONFIG_MAC80211_MESH
1617bab8 MP	351	static inline
	352	u32 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
	353	{
	354	atomic_inc(&sdata->u.mesh.estab_plinks);
e05ecccd	355	return mesh_accept_plinks_update(sdata) \| BSS_CHANGED_BEACON;
1617bab8 MP	356	}
	357
	358	static inline
	359	u32 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
	360	{
	361	atomic_dec(&sdata->u.mesh.estab_plinks);
e05ecccd	362	return mesh_accept_plinks_update(sdata) \| BSS_CHANGED_BEACON;
1617bab8 MP	363	}
1617bab8 MP	364
ccf80ddf LCC	365	static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
ccf80ddf LCC	366	{
472dbc45	367	return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976	368	atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf LCC	369	}
	370
	371	static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
	372	{
d0709a65	373	return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf LCC	374	MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
	375	}
	376
	377	static inline void mesh_path_activate(struct mesh_path *mpath)
	378	{
	379	mpath->flags \|= MESH_PATH_ACTIVE \| MESH_PATH_RESOLVED;
	380	}
	381
c7108a71 JC	382	static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
	383	{
	384	return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
	385	}
	386
94c514fe	387	void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
445cd452	388	void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
bf7cd94d	389	void ieee80211s_stop(void);
902acc78	390	#else
c7108a71 JC	391	static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
c7108a71 JC	392	{ return false; }
94c514fe AE	393	static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
94c514fe AE	394	{}
bf7cd94d	395	static inline void ieee80211s_stop(void) {}
902acc78 JB	396	#endif
902acc78 JB	397
ccf80ddf	398	#endif /* IEEE80211S_H */