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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (c) 2008, 2009 open80211s Ltd.
 * Copyright (C) 2023-2024 Intel Corporation
 * 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
 * @fast_tx_check: timestamp of last fast-xmit enable attempt
 *
 *
 * 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 */

/**
 * enum ieee80211_mesh_fast_tx_type - cached mesh fast tx entry type
 *
 * @MESH_FAST_TX_TYPE_LOCAL: tx from the local vif address as SA
 * @MESH_FAST_TX_TYPE_PROXIED: local tx with a different SA (e.g. bridged)
 * @MESH_FAST_TX_TYPE_FORWARDED: forwarded from a different mesh point
 * @NUM_MESH_FAST_TX_TYPE: number of entry types
 */
enum ieee80211_mesh_fast_tx_type {
	MESH_FAST_TX_TYPE_LOCAL,
	MESH_FAST_TX_TYPE_PROXIED,
	MESH_FAST_TX_TYPE_FORWARDED,

	/* must be last */
	NUM_MESH_FAST_TX_TYPE
};


/**
 * struct ieee80211_mesh_fast_tx_key - cached mesh fast tx entry key
 *
 * @addr: The Ethernet DA for this entry
 * @type: cache entry type
 */
struct ieee80211_mesh_fast_tx_key {
	u8 addr[ETH_ALEN] __aligned(2);
	u16 type;
};

/**
 * struct ieee80211_mesh_fast_tx - cached mesh fast tx entry
 * @rhash: rhashtable pointer
 * @key: the lookup key for this cache 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;
	struct ieee80211_mesh_fast_tx_key key;

	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);
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,
				       u64 changed);

/* mesh power save */
u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
u64 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);
u64 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);
u64 mesh_plink_deactivate(struct sta_info *sta);
u64 mesh_plink_open(struct sta_info *sta);
u64 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,
		 struct ieee80211_mesh_fast_tx_key *key);
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
u64 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
u64 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.
03145a1d	4	* Copyright (C) 2023-2024 Intel Corporation
ccf80ddf LCC	5	* Authors: Luis Carlos Cobo <luisca@cozybit.com>
ccf80ddf LCC	6	* Javier Cardona <javier@cozybit.com>
ccf80ddf LCC	7	*/
	8
	9	#ifndef IEEE80211S_H
	10	#define IEEE80211S_H
	11
902acc78	12	#include <linux/types.h>
ccf80ddf	13	#include <linux/jhash.h>
902acc78	14	#include "ieee80211_i.h"
ccf80ddf	15
ccf80ddf LCC	16
	17	/* Data structures */
	18
	19	/**
	20	* enum mesh_path_flags - mac80211 mesh path flags
	21	*
eb80ed8d RR	22	* @MESH_PATH_ACTIVE: the mesh path can be used for forwarding
eb80ed8d RR	23	* @MESH_PATH_RESOLVING: the discovery process is running for this mesh path
d19b3bf6	24	* @MESH_PATH_SN_VALID: the mesh path contains a valid destination sequence
bf7cd94d	25	* number
ccf80ddf	26	* @MESH_PATH_FIXED: the mesh path has been manually set and should not be
bf7cd94d	27	* modified
ccf80ddf	28	* @MESH_PATH_RESOLVED: the mesh path can has been resolved
f3011cf9	29	* @MESH_PATH_REQ_QUEUED: there is an unsent path request for this destination
bf7cd94d	30	* already queued up, waiting for the discovery process to start.
74932959 BC	31	* @MESH_PATH_DELETED: the mesh path has been deleted and should no longer
74932959 BC	32	* be used
ccf80ddf	33	*
eb80ed8d	34	* MESH_PATH_RESOLVED is used by the mesh path timer to
ccf80ddf LCC	35	* decide when to stop or cancel the mesh path discovery.
	36	*/
	37	enum mesh_path_flags {
	38	MESH_PATH_ACTIVE = BIT(0),
	39	MESH_PATH_RESOLVING = BIT(1),
d19b3bf6	40	MESH_PATH_SN_VALID = BIT(2),
ccf80ddf LCC	41	MESH_PATH_FIXED = BIT(3),
ccf80ddf LCC	42	MESH_PATH_RESOLVED = BIT(4),
f3011cf9	43	MESH_PATH_REQ_QUEUED = BIT(5),
74932959	44	MESH_PATH_DELETED = BIT(6),
ccf80ddf LCC	45	};
ccf80ddf LCC	46
18889231 JC	47	/**
	48	* enum mesh_deferred_task_flags - mac80211 mesh deferred tasks
	49	*
	50	*
	51	*
	52	* @MESH_WORK_HOUSEKEEPING: run the periodic mesh housekeeping tasks
e304bfd3	53	* @MESH_WORK_ROOT: the mesh root station needs to send a frame
dbf498fb JC	54	* @MESH_WORK_DRIFT_ADJUST: time to compensate for clock drift relative to other
dbf498fb JC	55	* mesh nodes
f81a9ded	56	* @MESH_WORK_MBSS_CHANGED: rebuild beacon and notify driver of BSS changes
18889231 JC	57	*/
	58	enum mesh_deferred_task_flags {
	59	MESH_WORK_HOUSEKEEPING,
e304bfd3	60	MESH_WORK_ROOT,
dbf498fb	61	MESH_WORK_DRIFT_ADJUST,
f81a9ded	62	MESH_WORK_MBSS_CHANGED,
18889231 JC	63	};
18889231 JC	64
ccf80ddf LCC	65	/**
	66	* struct mesh_path - mac80211 mesh path structure
	67	*
	68	* @dst: mesh path destination mac address
68bb54b4 BC	69	* @mpp: mesh proxy mac address
68bb54b4 BC	70	* @rhash: rhashtable list pointer
b4c3fbe6	71	* @walk_list: linked list containing all mesh_path objects.
68bb54b4	72	* @gate_list: list pointer for known gates list
f698d856	73	* @sdata: mesh subif
ccf80ddf	74	* @next_hop: mesh neighbor to which frames for this destination will be
bf7cd94d	75	* forwarded
ccf80ddf LCC	76	* @timer: mesh path discovery timer
ccf80ddf LCC	77	* @frame_queue: pending queue for frames sent to this destination while the
bf7cd94d	78	* path is unresolved
68bb54b4	79	* @rcu: rcu head for freeing mesh path
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
ccf80ddf LCC	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
540bbcb9	96	* @path_change_count: the number of path changes to destination
03145a1d	97	* @fast_tx_check: timestamp of last fast-xmit enable attempt
ccf80ddf LCC	98	*
ccf80ddf LCC	99	*
68bb54b4 BC	100	* The dst address is unique in the mesh path table. Since the mesh_path is
	101	* protected by RCU, deleting the next_hop STA must remove / substitute the
	102	* mesh_path structure and wait until that is no longer reachable before
	103	* destroying the STA completely.
ccf80ddf LCC	104	*/
	105	struct mesh_path {
	106	u8 dst[ETH_ALEN];
79617dee	107	u8 mpp[ETH_ALEN]; /* used for MPP or MAP */
60854fd9	108	struct rhash_head rhash;
b4c3fbe6	109	struct hlist_node walk_list;
947c2a0e	110	struct hlist_node gate_list;
f698d856	111	struct ieee80211_sub_if_data *sdata;
40b275b6	112	struct sta_info __rcu *next_hop;
ccf80ddf LCC	113	struct timer_list timer;
	114	struct sk_buff_head frame_queue;
	115	struct rcu_head rcu;
d19b3bf6	116	u32 sn;
ccf80ddf LCC	117	u32 metric;
	118	u8 hop_count;
	119	unsigned long exp_time;
	120	u32 discovery_timeout;
	121	u8 discovery_retries;
	122	enum mesh_path_flags flags;
	123	spinlock_t state_lock;
3d045a54	124	u8 rann_snd_addr[ETH_ALEN];
d2a079fd	125	u32 rann_metric;
728b19e5	126	unsigned long last_preq_to_root;
d5edb9ae	127	unsigned long fast_tx_check;
3d045a54	128	bool is_root;
5ee68e5b	129	bool is_gate;
540bbcb9	130	u32 path_change_count;
ccf80ddf LCC	131	};
ccf80ddf LCC	132
d5edb9ae FF	133	#define MESH_FAST_TX_CACHE_MAX_SIZE 512
	134	#define MESH_FAST_TX_CACHE_THRESHOLD_SIZE 384
	135	#define MESH_FAST_TX_CACHE_TIMEOUT 8000 /* msecs */
	136
8c75cdcd FF	137	/**
	138	* enum ieee80211_mesh_fast_tx_type - cached mesh fast tx entry type
	139	*
	140	* @MESH_FAST_TX_TYPE_LOCAL: tx from the local vif address as SA
	141	* @MESH_FAST_TX_TYPE_PROXIED: local tx with a different SA (e.g. bridged)
	142	* @MESH_FAST_TX_TYPE_FORWARDED: forwarded from a different mesh point
	143	* @NUM_MESH_FAST_TX_TYPE: number of entry types
	144	*/
	145	enum ieee80211_mesh_fast_tx_type {
	146	MESH_FAST_TX_TYPE_LOCAL,
	147	MESH_FAST_TX_TYPE_PROXIED,
	148	MESH_FAST_TX_TYPE_FORWARDED,
	149
	150	/* must be last */
	151	NUM_MESH_FAST_TX_TYPE
	152	};
	153
	154
	155	/**
	156	* struct ieee80211_mesh_fast_tx_key - cached mesh fast tx entry key
	157	*
	158	* @addr: The Ethernet DA for this entry
	159	* @type: cache entry type
	160	*/
	161	struct ieee80211_mesh_fast_tx_key {
	162	u8 addr[ETH_ALEN] __aligned(2);
	163	u16 type;
	164	};
	165
d5edb9ae FF	166	/**
	167	* struct ieee80211_mesh_fast_tx - cached mesh fast tx entry
	168	* @rhash: rhashtable pointer
8c75cdcd	169	* @key: the lookup key for this cache entry
d5edb9ae FF	170	* @fast_tx: base fast_tx data
	171	* @hdr: cached mesh and rfc1042 headers
	172	* @hdrlen: length of mesh + rfc1042
	173	* @walk_list: list containing all the fast tx entries
	174	* @mpath: mesh path corresponding to the Mesh DA
	175	* @mppath: MPP entry corresponding to this DA
	176	* @timestamp: Last used time of this entry
	177	*/
	178	struct ieee80211_mesh_fast_tx {
	179	struct rhash_head rhash;
8c75cdcd	180	struct ieee80211_mesh_fast_tx_key key;
d5edb9ae FF	181
	182	struct ieee80211_fast_tx fast_tx;
	183	u8 hdr[sizeof(struct ieee80211s_hdr) + sizeof(rfc1042_header)];
	184	u16 hdrlen;
	185
	186	struct mesh_path mpath, mppath;
	187	struct hlist_node walk_list;
	188	unsigned long timestamp;
	189	};
	190
ccf80ddf LCC	191	/* Recent multicast cache */
	192	/* RMC_BUCKETS must be a power of 2, maximum 256 */
	193	#define RMC_BUCKETS 256
	194	#define RMC_QUEUE_MAX_LEN 4
	195	#define RMC_TIMEOUT (3 * HZ)
	196
	197	/**
	198	* struct rmc_entry - entry in the Recent Multicast Cache
	199	*
	200	* @seqnum: mesh sequence number of the frame
	201	* @exp_time: expiration time of the entry, in jiffies
	202	* @sa: source address of the frame
68bb54b4	203	* @list: hashtable list pointer
ccf80ddf LCC	204	*
	205	* The Recent Multicast Cache keeps track of the latest multicast frames that
	206	* have been received by a mesh interface and discards received multicast frames
	207	* that are found in the cache.
	208	*/
	209	struct rmc_entry {
47a0489c	210	struct hlist_node list;
ccf80ddf	211	unsigned long exp_time;
3257523b	212	u32 seqnum;
ccf80ddf LCC	213	u8 sa[ETH_ALEN];
	214	};
	215
	216	struct mesh_rmc {
47a0489c	217	struct hlist_head bucket[RMC_BUCKETS];
51ceddad	218	u32 idx_mask;
ccf80ddf LCC	219	};
ccf80ddf LCC	220
25d49e4d	221	#define IEEE80211_MESH_HOUSEKEEPING_INTERVAL (60 * HZ)
ccf80ddf	222
ccf80ddf LCC	223	#define MESH_PATH_EXPIRE (600 * HZ)
ccf80ddf LCC	224
ccf80ddf LCC	225	/* Default maximum number of plinks per interface */
	226	#define MESH_MAX_PLINKS 256
	227
	228	/* Maximum number of paths per interface */
	229	#define MESH_MAX_MPATHS 1024
	230
4bd4c2dd TP	231	/* Number of frames buffered per destination for unresolved destinations */
	232	#define MESH_FRAME_QUEUE_LEN 10
	233
ccf80ddf LCC	234	/* Public interfaces */
ccf80ddf LCC	235	/* Various */
3c5772a5	236	int ieee80211_fill_mesh_addresses(struct ieee80211_hdr hdr, __le16 fc,
15ff6365	237	const u8 da, const u8 sa);
5edfcee5 AH	238	unsigned int ieee80211_new_mesh_header(struct ieee80211_sub_if_data *sdata,
	239	struct ieee80211s_hdr *meshhdr,
	240	const char addr4or5, const char addr6);
bf7cd94d JB	241	int mesh_rmc_check(struct ieee80211_sub_if_data *sdata,
bf7cd94d JB	242	const u8 addr, struct ieee80211s_hdr mesh_hdr);
f743ff49 TP	243	bool mesh_matches_local(struct ieee80211_sub_if_data *sdata,
f743ff49 TP	244	struct ieee802_11_elems *ie);
bf7cd94d JB	245	int mesh_add_meshconf_ie(struct ieee80211_sub_if_data *sdata,
	246	struct sk_buff *skb);
	247	int mesh_add_meshid_ie(struct ieee80211_sub_if_data *sdata,
	248	struct sk_buff *skb);
	249	int mesh_add_rsn_ie(struct ieee80211_sub_if_data *sdata,
	250	struct sk_buff *skb);
	251	int mesh_add_vendor_ies(struct ieee80211_sub_if_data *sdata,
	252	struct sk_buff *skb);
	253	int mesh_add_ht_cap_ie(struct ieee80211_sub_if_data *sdata,
	254	struct sk_buff *skb);
	255	int mesh_add_ht_oper_ie(struct ieee80211_sub_if_data *sdata,
	256	struct sk_buff *skb);
c85fb53c BC	257	int mesh_add_vht_cap_ie(struct ieee80211_sub_if_data *sdata,
	258	struct sk_buff *skb);
	259	int mesh_add_vht_oper_ie(struct ieee80211_sub_if_data *sdata,
	260	struct sk_buff *skb);
60ad72da SE	261	int mesh_add_he_cap_ie(struct ieee80211_sub_if_data *sdata,
	262	struct sk_buff *skb, u8 ie_len);
	263	int mesh_add_he_oper_ie(struct ieee80211_sub_if_data *sdata,
	264	struct sk_buff *skb);
24a2042c RM	265	int mesh_add_he_6ghz_cap_ie(struct ieee80211_sub_if_data *sdata,
24a2042c RM	266	struct sk_buff *skb);
df1875c4 RL	267	int mesh_add_eht_cap_ie(struct ieee80211_sub_if_data *sdata,
	268	struct sk_buff *skb, u8 ie_len);
	269	int mesh_add_eht_oper_ie(struct ieee80211_sub_if_data *sdata,
	270	struct sk_buff *skb);
f698d856 JBG	271	void mesh_rmc_free(struct ieee80211_sub_if_data *sdata);
f698d856 JBG	272	int mesh_rmc_init(struct ieee80211_sub_if_data *sdata);
ccf80ddf	273	void ieee80211s_init(void);
bfc32e6a	274	void ieee80211s_update_metric(struct ieee80211_local *local,
c4205510 YCP	275	struct sta_info *sta,
c4205510 YCP	276	struct ieee80211_tx_status *st);
902acc78	277	void ieee80211_mesh_init_sdata(struct ieee80211_sub_if_data *sdata);
0371a08f	278	void ieee80211_mesh_teardown_sdata(struct ieee80211_sub_if_data *sdata);
2b5e1967	279	int ieee80211_start_mesh(struct ieee80211_sub_if_data *sdata);
472dbc45	280	void ieee80211_stop_mesh(struct ieee80211_sub_if_data *sdata);
63c5723b	281	void ieee80211_mesh_root_setup(struct ieee80211_if_mesh *ifmsh);
8ba7acf3	282	const struct ieee80211_mesh_sync_ops *ieee80211_mesh_sync_ops_get(u8 method);
2b5e1967 TP	283	/* wrapper for ieee80211_bss_info_change_notify() */
2b5e1967 TP	284	void ieee80211_mbss_info_change_notify(struct ieee80211_sub_if_data *sdata,
15ddba5f	285	u64 changed);
902acc78	286
3f52b7e3	287	/* mesh power save */
15ddba5f A	288	u64 ieee80211_mps_local_status_update(struct ieee80211_sub_if_data *sdata);
15ddba5f A	289	u64 ieee80211_mps_set_sta_local_pm(struct sta_info *sta,
39886b61	290	enum nl80211_mesh_power_mode pm);
3f52b7e3 MP	291	void ieee80211_mps_set_frame_flags(struct ieee80211_sub_if_data *sdata,
	292	struct sta_info *sta,
	293	struct ieee80211_hdr *hdr);
	294	void ieee80211_mps_sta_status_update(struct sta_info *sta);
	295	void ieee80211_mps_rx_h_sta_process(struct sta_info *sta,
	296	struct ieee80211_hdr *hdr);
	297	void ieee80211_mpsp_trigger_process(u8 qc, struct sta_info sta,
	298	bool tx, bool acked);
	299	void ieee80211_mps_frame_release(struct sta_info *sta,
	300	struct ieee802_11_elems *elems);
	301
ccf80ddf	302	/* Mesh paths */
bf7cd94d JB	303	int mesh_nexthop_lookup(struct ieee80211_sub_if_data *sdata,
	304	struct sk_buff *skb);
	305	int mesh_nexthop_resolve(struct ieee80211_sub_if_data *sdata,
	306	struct sk_buff *skb);
f698d856	307	void mesh_path_start_discovery(struct ieee80211_sub_if_data *sdata);
bf7cd94d JB	308	struct mesh_path mesh_path_lookup(struct ieee80211_sub_if_data sdata,
	309	const u8 *dst);
	310	struct mesh_path mpp_path_lookup(struct ieee80211_sub_if_data sdata,
	311	const u8 *dst);
	312	int mpp_path_add(struct ieee80211_sub_if_data *sdata,
	313	const u8 dst, const u8 mpp);
	314	struct mesh_path *
	315	mesh_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
a2db2ed3 HR	316	struct mesh_path *
a2db2ed3 HR	317	mpp_path_lookup_by_idx(struct ieee80211_sub_if_data *sdata, int idx);
ccf80ddf	318	void mesh_path_fix_nexthop(struct mesh_path mpath, struct sta_info next_hop);
f698d856	319	void mesh_path_expire(struct ieee80211_sub_if_data *sdata);
f698d856	320	void mesh_rx_path_sel_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d	321	struct ieee80211_mgmt *mgmt, size_t len);
ae76eef0 BC	322	struct mesh_path *
ae76eef0 BC	323	mesh_path_add(struct ieee80211_sub_if_data sdata, const u8 dst);
5ee68e5b JC	324
	325	int mesh_path_add_gate(struct mesh_path *mpath);
	326	int mesh_path_send_to_gates(struct mesh_path *mpath);
	327	int mesh_gate_num(struct ieee80211_sub_if_data *sdata);
ab60633c NM	328	u32 airtime_link_metric_get(struct ieee80211_local *local,
ab60633c NM	329	struct sta_info *sta);
bf7cd94d	330
ccf80ddf	331	/* Mesh plinks */
f743ff49	332	void mesh_neighbour_update(struct ieee80211_sub_if_data *sdata,
ecbc12ad BC	333	u8 hw_addr, struct ieee802_11_elems ie,
ecbc12ad BC	334	struct ieee80211_rx_status *rx_status);
f698d856	335	bool mesh_peer_accepts_plinks(struct ieee802_11_elems *ie);
15ddba5f	336	u64 mesh_accept_plinks_update(struct ieee80211_sub_if_data *sdata);
4c02d62f	337	void mesh_plink_timer(struct timer_list *t);
ccf80ddf	338	void mesh_plink_broken(struct sta_info *sta);
15ddba5f A	339	u64 mesh_plink_deactivate(struct sta_info *sta);
	340	u64 mesh_plink_open(struct sta_info *sta);
	341	u64 mesh_plink_block(struct sta_info *sta);
f698d856 JBG	342	void mesh_rx_plink_frame(struct ieee80211_sub_if_data *sdata,
	343	struct ieee80211_mgmt *mgmt, size_t len,
	344	struct ieee80211_rx_status *rx_status);
45b5028e	345	void mesh_sta_cleanup(struct sta_info *sta);
ccf80ddf LCC	346
ccf80ddf LCC	347	/* Private interfaces */
ccf80ddf	348	/* Mesh paths */
bf7cd94d	349	int mesh_path_error_tx(struct ieee80211_sub_if_data *sdata,
f63f8421 CYY	350	u8 ttl, const u8 *target, u32 target_sn,
f63f8421 CYY	351	u16 target_rcode, const u8 *ra);
ccf80ddf LCC	352	void mesh_path_assign_nexthop(struct mesh_path mpath, struct sta_info sta);
	353	void mesh_path_flush_pending(struct mesh_path *mpath);
	354	void mesh_path_tx_pending(struct mesh_path *mpath);
8b5cb7e4	355	void mesh_pathtbl_init(struct ieee80211_sub_if_data *sdata);
2bdaf386	356	void mesh_pathtbl_unregister(struct ieee80211_sub_if_data *sdata);
bf7cd94d	357	int mesh_path_del(struct ieee80211_sub_if_data sdata, const u8 addr);
34f11cd3	358	void mesh_path_timer(struct timer_list *t);
ccf80ddf	359	void mesh_path_flush_by_nexthop(struct sta_info *sta);
bf7cd94d JB	360	void mesh_path_discard_frame(struct ieee80211_sub_if_data *sdata,
bf7cd94d JB	361	struct sk_buff *skb);
e304bfd3	362	void mesh_path_tx_root_frame(struct ieee80211_sub_if_data *sdata);
ccf80ddf	363
25d49e4d	364	bool mesh_action_is_path_sel(struct ieee80211_mgmt *mgmt);
d5edb9ae	365	struct ieee80211_mesh_fast_tx *
8c75cdcd FF	366	mesh_fast_tx_get(struct ieee80211_sub_if_data *sdata,
8c75cdcd FF	367	struct ieee80211_mesh_fast_tx_key *key);
d5edb9ae FF	368	bool ieee80211_mesh_xmit_fast(struct ieee80211_sub_if_data *sdata,
	369	struct sk_buff *skb, u32 ctrl_flags);
	370	void mesh_fast_tx_cache(struct ieee80211_sub_if_data *sdata,
	371	struct sk_buff skb, struct mesh_path mpath);
	372	void mesh_fast_tx_gc(struct ieee80211_sub_if_data *sdata);
	373	void mesh_fast_tx_flush_addr(struct ieee80211_sub_if_data *sdata,
	374	const u8 *addr);
	375	void mesh_fast_tx_flush_mpath(struct mesh_path *mpath);
	376	void mesh_fast_tx_flush_sta(struct ieee80211_sub_if_data *sdata,
	377	struct sta_info *sta);
	378	void mesh_path_refresh(struct ieee80211_sub_if_data *sdata,
	379	struct mesh_path mpath, const u8 addr);
f5ea9120	380
902acc78	381	#ifdef CONFIG_MAC80211_MESH
1617bab8	382	static inline
15ddba5f	383	u64 mesh_plink_inc_estab_count(struct ieee80211_sub_if_data *sdata)
1617bab8 MP	384	{
1617bab8 MP	385	atomic_inc(&sdata->u.mesh.estab_plinks);
e05ecccd	386	return mesh_accept_plinks_update(sdata) \| BSS_CHANGED_BEACON;
1617bab8 MP	387	}
	388
	389	static inline
15ddba5f	390	u64 mesh_plink_dec_estab_count(struct ieee80211_sub_if_data *sdata)
1617bab8 MP	391	{
1617bab8 MP	392	atomic_dec(&sdata->u.mesh.estab_plinks);
e05ecccd	393	return mesh_accept_plinks_update(sdata) \| BSS_CHANGED_BEACON;
1617bab8 MP	394	}
1617bab8 MP	395
ccf80ddf LCC	396	static inline int mesh_plink_free_count(struct ieee80211_sub_if_data *sdata)
ccf80ddf LCC	397	{
472dbc45	398	return sdata->u.mesh.mshcfg.dot11MeshMaxPeerLinks -
1258d976	399	atomic_read(&sdata->u.mesh.estab_plinks);
ccf80ddf LCC	400	}
	401
	402	static inline bool mesh_plink_availables(struct ieee80211_sub_if_data *sdata)
	403	{
d0709a65	404	return (min_t(long, mesh_plink_free_count(sdata),
ccf80ddf LCC	405	MESH_MAX_PLINKS - sdata->local->num_sta)) > 0;
	406	}
	407
	408	static inline void mesh_path_activate(struct mesh_path *mpath)
	409	{
	410	mpath->flags \|= MESH_PATH_ACTIVE \| MESH_PATH_RESOLVED;
	411	}
	412
c7108a71 JC	413	static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
	414	{
	415	return sdata->u.mesh.mesh_pp_id == IEEE80211_PATH_PROTOCOL_HWMP;
	416	}
	417
94c514fe	418	void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata);
445cd452	419	void mesh_sync_adjust_tsf(struct ieee80211_sub_if_data *sdata);
bf7cd94d	420	void ieee80211s_stop(void);
902acc78	421	#else
c7108a71 JC	422	static inline bool mesh_path_sel_is_hwmp(struct ieee80211_sub_if_data *sdata)
c7108a71 JC	423	{ return false; }
94c514fe AE	424	static inline void mesh_path_flush_by_iface(struct ieee80211_sub_if_data *sdata)
94c514fe AE	425	{}
bf7cd94d	426	static inline void ieee80211s_stop(void) {}
902acc78 JB	427	#endif
902acc78 JB	428
ccf80ddf	429	#endif /* IEEE80211S_H */