[linux-block.git] / net / mac802154 / ieee802154_i.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2007-2012 Siemens AG
 *
 * Written by:
 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
 */
#ifndef __IEEE802154_I_H
#define __IEEE802154_I_H

#include <linux/interrupt.h>
#include <linux/mutex.h>
#include <linux/hrtimer.h>
#include <net/cfg802154.h>
#include <net/mac802154.h>
#include <net/nl802154.h>
#include <net/ieee802154_netdev.h>

#include "llsec.h"

enum ieee802154_ongoing {
	IEEE802154_IS_SCANNING = BIT(0),
	IEEE802154_IS_BEACONING = BIT(1),
};

/* mac802154 device private data */
struct ieee802154_local {
	struct ieee802154_hw hw;
	const struct ieee802154_ops *ops;

	/* hardware address filter */
	struct ieee802154_hw_addr_filt addr_filt;
	/* ieee802154 phy */
	struct wpan_phy *phy;

	int open_count;

	/* As in mac80211 slaves list is modified:
	 * 1) under the RTNL
	 * 2) protected by slaves_mtx;
	 * 3) in an RCU manner
	 *
	 * So atomic readers can use any of this protection methods.
	 */
	struct list_head	interfaces;
	struct mutex		iflist_mtx;

	/* Data related workqueue */
	struct workqueue_struct	*workqueue;
	/* MAC commands related workqueue */
	struct workqueue_struct	*mac_wq;

	struct hrtimer ifs_timer;

	/* Scanning */
	u8 scan_page;
	u8 scan_channel;
	struct ieee802154_beacon_req_frame scan_beacon_req;
	struct cfg802154_scan_request __rcu *scan_req;
	struct delayed_work scan_work;

	/* Beaconing */
	unsigned int beacon_interval;
	struct ieee802154_beacon_frame beacon;
	struct cfg802154_beacon_request __rcu *beacon_req;
	struct delayed_work beacon_work;

	/* Asynchronous tasks */
	struct list_head rx_beacon_list;
	struct work_struct rx_beacon_work;

	bool started;
	bool suspended;
	unsigned long ongoing;

	struct tasklet_struct tasklet;
	struct sk_buff_head skb_queue;

	struct sk_buff *tx_skb;
	struct work_struct sync_tx_work;
	/* A negative Linux error code or a null/positive MLME error status */
	int tx_result;
};

enum {
	IEEE802154_RX_MSG        = 1,
};

enum ieee802154_sdata_state_bits {
	SDATA_STATE_RUNNING,
};

/* Slave interface definition.
 *
 * Slaves represent typical network interfaces available from userspace.
 * Each ieee802154 device/transceiver may have several slaves and able
 * to be associated with several networks at the same time.
 */
struct ieee802154_sub_if_data {
	struct list_head list; /* the ieee802154_priv->slaves list */

	struct wpan_dev wpan_dev;

	struct ieee802154_local *local;
	struct net_device *dev;

	/* Each interface starts and works in nominal state at a given filtering
	 * level given by iface_default_filtering, which is set once for all at
	 * the interface creation and should not evolve over time. For some MAC
	 * operations however, the filtering level may change temporarily, as
	 * reflected in the required_filtering field. The actual filtering at
	 * the PHY level may be different and is shown in struct wpan_phy.
	 */
	enum ieee802154_filtering_level iface_default_filtering;
	enum ieee802154_filtering_level required_filtering;

	unsigned long state;
	char name[IFNAMSIZ];

	/* protects sec from concurrent access by netlink. access by
	 * encrypt/decrypt/header_create safe without additional protection.
	 */
	struct mutex sec_mtx;

	struct mac802154_llsec sec;
};

/* utility functions/constants */
extern const void *const mac802154_wpan_phy_privid; /*  for wpan_phy privid */

static inline struct ieee802154_local *
hw_to_local(struct ieee802154_hw *hw)
{
	return container_of(hw, struct ieee802154_local, hw);
}

static inline struct ieee802154_sub_if_data *
IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev)
{
	return netdev_priv(dev);
}

static inline struct ieee802154_sub_if_data *
IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev)
{
	return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev);
}

static inline bool
ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata)
{
	return test_bit(SDATA_STATE_RUNNING, &sdata->state);
}

extern struct ieee802154_mlme_ops mac802154_mlme_wpan;

void ieee802154_rx(struct ieee802154_local *local, struct sk_buff *skb);
void ieee802154_xmit_sync_worker(struct work_struct *work);
int ieee802154_sync_and_hold_queue(struct ieee802154_local *local);
int ieee802154_mlme_op_pre(struct ieee802154_local *local);
int ieee802154_mlme_tx(struct ieee802154_local *local,
		       struct ieee802154_sub_if_data *sdata,
		       struct sk_buff *skb);
int ieee802154_mlme_tx_locked(struct ieee802154_local *local,
			      struct ieee802154_sub_if_data *sdata,
			      struct sk_buff *skb);
void ieee802154_mlme_op_post(struct ieee802154_local *local);
int ieee802154_mlme_tx_one(struct ieee802154_local *local,
			   struct ieee802154_sub_if_data *sdata,
			   struct sk_buff *skb);
int ieee802154_mlme_tx_one_locked(struct ieee802154_local *local,
				  struct ieee802154_sub_if_data *sdata,
				  struct sk_buff *skb);
netdev_tx_t
ieee802154_monitor_start_xmit(struct sk_buff *skb, struct net_device *dev);
netdev_tx_t
ieee802154_subif_start_xmit(struct sk_buff *skb, struct net_device *dev);
enum hrtimer_restart ieee802154_xmit_ifs_timer(struct hrtimer *timer);

/**
 * ieee802154_hold_queue - hold ieee802154 queue
 * @local: main mac object
 *
 * Hold a queue by incrementing an atomic counter and requesting the netif
 * queues to be stopped. The queues cannot be woken up while the counter has not
 * been reset with as any ieee802154_release_queue() calls as needed.
 */
void ieee802154_hold_queue(struct ieee802154_local *local);

/**
 * ieee802154_release_queue - release ieee802154 queue
 * @local: main mac object
 *
 * Release a queue which is held by decrementing an atomic counter and wake it
 * up only if the counter reaches 0.
 */
void ieee802154_release_queue(struct ieee802154_local *local);

/**
 * ieee802154_disable_queue - disable ieee802154 queue
 * @local: main mac object
 *
 * When trying to sync the Tx queue, we cannot just stop the queue
 * (which is basically a bit being set without proper lock handling)
 * because it would be racy. We actually need to call netif_tx_disable()
 * instead, which is done by this helper. Restarting the queue can
 * however still be done with a regular wake call.
 */
void ieee802154_disable_queue(struct ieee802154_local *local);

/* MIB callbacks */
void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan);

int mac802154_get_params(struct net_device *dev,
			 struct ieee802154_llsec_params *params);
int mac802154_set_params(struct net_device *dev,
			 const struct ieee802154_llsec_params *params,
			 int changed);

int mac802154_add_key(struct net_device *dev,
		      const struct ieee802154_llsec_key_id *id,
		      const struct ieee802154_llsec_key *key);
int mac802154_del_key(struct net_device *dev,
		      const struct ieee802154_llsec_key_id *id);

int mac802154_add_dev(struct net_device *dev,
		      const struct ieee802154_llsec_device *llsec_dev);
int mac802154_del_dev(struct net_device *dev, __le64 dev_addr);

int mac802154_add_devkey(struct net_device *dev,
			 __le64 device_addr,
			 const struct ieee802154_llsec_device_key *key);
int mac802154_del_devkey(struct net_device *dev,
			 __le64 device_addr,
			 const struct ieee802154_llsec_device_key *key);

int mac802154_add_seclevel(struct net_device *dev,
			   const struct ieee802154_llsec_seclevel *sl);
int mac802154_del_seclevel(struct net_device *dev,
			   const struct ieee802154_llsec_seclevel *sl);

void mac802154_lock_table(struct net_device *dev);
void mac802154_get_table(struct net_device *dev,
			 struct ieee802154_llsec_table **t);
void mac802154_unlock_table(struct net_device *dev);

int mac802154_wpan_update_llsec(struct net_device *dev);

/* PAN management handling */
void mac802154_scan_worker(struct work_struct *work);
int mac802154_trigger_scan_locked(struct ieee802154_sub_if_data *sdata,
				  struct cfg802154_scan_request *request);
int mac802154_abort_scan_locked(struct ieee802154_local *local,
				struct ieee802154_sub_if_data *sdata);
int mac802154_process_beacon(struct ieee802154_local *local,
			     struct sk_buff *skb,
			     u8 page, u8 channel);
void mac802154_rx_beacon_worker(struct work_struct *work);

static inline bool mac802154_is_scanning(struct ieee802154_local *local)
{
	return test_bit(IEEE802154_IS_SCANNING, &local->ongoing);
}

void mac802154_beacon_worker(struct work_struct *work);
int mac802154_send_beacons_locked(struct ieee802154_sub_if_data *sdata,
				  struct cfg802154_beacon_request *request);
int mac802154_stop_beacons_locked(struct ieee802154_local *local,
				  struct ieee802154_sub_if_data *sdata);

static inline bool mac802154_is_beaconing(struct ieee802154_local *local)
{
	return test_bit(IEEE802154_IS_BEACONING, &local->ongoing);
}

/* interface handling */
int ieee802154_iface_init(void);
void ieee802154_iface_exit(void);
void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata);
struct net_device *
ieee802154_if_add(struct ieee802154_local *local, const char *name,
		  unsigned char name_assign_type, enum nl802154_iftype type,
		  __le64 extended_addr);
void ieee802154_remove_interfaces(struct ieee802154_local *local);
void ieee802154_stop_device(struct ieee802154_local *local);

#endif /* __IEEE802154_I_H */
Commit	Line	Data
1802d0be	1	/* SPDX-License-Identifier: GPL-2.0-only */
1010f540	2	/*
	3	* Copyright (C) 2007-2012 Siemens AG
	4	*
1010f540	5	* Written by:
	6	* Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
	7	* Maxim Gorbachyov <maxim.gorbachev@siemens.com>
	8	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
	9	* Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
	10	*/
0f1556bc AA	11	#ifndef __IEEE802154_I_H
0f1556bc AA	12	#define __IEEE802154_I_H
1010f540	13
282ccf6e	14	#include <linux/interrupt.h>
f30be4d5	15	#include <linux/mutex.h>
61f2dcba	16	#include <linux/hrtimer.h>
d5ae67ba	17	#include <net/cfg802154.h>
5d637d5a	18	#include <net/mac802154.h>
944742a3	19	#include <net/nl802154.h>
e462ded6 PB	20	#include <net/ieee802154_netdev.h>
e462ded6 PB	21
f30be4d5 PB	22	#include "llsec.h"
f30be4d5 PB	23
57588c71 MR	24	enum ieee802154_ongoing {
57588c71 MR	25	IEEE802154_IS_SCANNING = BIT(0),
3accf476	26	IEEE802154_IS_BEACONING = BIT(1),
57588c71 MR	27	};
57588c71 MR	28
1010f540	29	/* mac802154 device private data */
a5e1ec53	30	struct ieee802154_local {
5a504397	31	struct ieee802154_hw hw;
16301861	32	const struct ieee802154_ops *ops;
1010f540	33
ac8037c3 AA	34	/* hardware address filter */
ac8037c3 AA	35	struct ieee802154_hw_addr_filt addr_filt;
1010f540	36	/* ieee802154 phy */
	37	struct wpan_phy *phy;
	38
	39	int open_count;
	40
	41	/* As in mac80211 slaves list is modified:
	42	* 1) under the RTNL
	43	* 2) protected by slaves_mtx;
	44	* 3) in an RCU manner
	45	*
	46	* So atomic readers can use any of this protection methods.
	47	*/
d98be45b AA	48	struct list_head interfaces;
d98be45b AA	49	struct mutex iflist_mtx;
1010f540	50
57588c71	51	/* Data related workqueue */
f7730542	52	struct workqueue_struct *workqueue;
57588c71 MR	53	/* MAC commands related workqueue */
57588c71 MR	54	struct workqueue_struct *mac_wq;
1010f540	55
61f2dcba AA	56	struct hrtimer ifs_timer;
61f2dcba AA	57
57588c71 MR	58	/* Scanning */
	59	u8 scan_page;
	60	u8 scan_channel;
e2c3e6f5	61	struct ieee802154_beacon_req_frame scan_beacon_req;
57588c71 MR	62	struct cfg802154_scan_request __rcu *scan_req;
	63	struct delayed_work scan_work;
	64
3accf476 MR	65	/* Beaconing */
	66	unsigned int beacon_interval;
	67	struct ieee802154_beacon_frame beacon;
	68	struct cfg802154_beacon_request __rcu *beacon_req;
	69	struct delayed_work beacon_work;
	70
57588c71 MR	71	/* Asynchronous tasks */
	72	struct list_head rx_beacon_list;
	73	struct work_struct rx_beacon_work;
	74
5d65cae4	75	bool started;
3cf24cf8	76	bool suspended;
57588c71	77	unsigned long ongoing;
c5c47e67 AA	78
	79	struct tasklet_struct tasklet;
	80	struct sk_buff_head skb_queue;
c22ff7b4 LB	81
c22ff7b4 LB	82	struct sk_buff *tx_skb;
983a974b	83	struct work_struct sync_tx_work;
337e2f86 MR	84	/* A negative Linux error code or a null/positive MLME error status */
337e2f86 MR	85	int tx_result;
1010f540	86	};
1010f540	87
c5c47e67 AA	88	enum {
	89	IEEE802154_RX_MSG = 1,
	90	};
	91
0ea3da64 AA	92	enum ieee802154_sdata_state_bits {
	93	SDATA_STATE_RUNNING,
	94	};
	95
4d23c9cc	96	/* Slave interface definition.
	97	*
	98	* Slaves represent typical network interfaces available from userspace.
	99	* Each ieee802154 device/transceiver may have several slaves and able
	100	* to be associated with several networks at the same time.
	101	*/
036562f9	102	struct ieee802154_sub_if_data {
4d23c9cc	103	struct list_head list; /* the ieee802154_priv->slaves list */
4d23c9cc	104
d5ae67ba AA	105	struct wpan_dev wpan_dev;
d5ae67ba AA	106
04e850fe	107	struct ieee802154_local *local;
4d23c9cc	108	struct net_device *dev;
4d23c9cc	109
ac8037c3 AA	110	/* Each interface starts and works in nominal state at a given filtering
	111	* level given by iface_default_filtering, which is set once for all at
	112	* the interface creation and should not evolve over time. For some MAC
	113	* operations however, the filtering level may change temporarily, as
	114	* reflected in the required_filtering field. The actual filtering at
	115	* the PHY level may be different and is shown in struct wpan_phy.
	116	*/
	117	enum ieee802154_filtering_level iface_default_filtering;
	118	enum ieee802154_filtering_level required_filtering;
	119
0ea3da64	120	unsigned long state;
d5ae67ba	121	char name[IFNAMSIZ];
4d23c9cc	122
f30be4d5 PB	123	/* protects sec from concurrent access by netlink. access by
	124	* encrypt/decrypt/header_create safe without additional protection.
	125	*/
	126	struct mutex sec_mtx;
	127
	128	struct mac802154_llsec sec;
4d23c9cc	129	};
4d23c9cc	130
6322d50d AA	131	/* utility functions/constants */
	132	extern const void const mac802154_wpan_phy_privid; / for wpan_phy privid */
	133
60741361 AA	134	static inline struct ieee802154_local *
	135	hw_to_local(struct ieee802154_hw *hw)
	136	{
	137	return container_of(hw, struct ieee802154_local, hw);
	138	}
	139
59d19cd7 AA	140	static inline struct ieee802154_sub_if_data *
	141	IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev)
	142	{
	143	return netdev_priv(dev);
	144	}
	145
b821ecd4 AA	146	static inline struct ieee802154_sub_if_data *
	147	IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev)
	148	{
	149	return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev);
	150	}
	151
0ea3da64 AA	152	static inline bool
	153	ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata)
	154	{
	155	return test_bit(SDATA_STATE_RUNNING, &sdata->state);
	156	}
	157
32bad7e3	158	extern struct ieee802154_mlme_ops mac802154_mlme_wpan;
6e2128d4	159
d10270ce	160	void ieee802154_rx(struct ieee802154_local local, struct sk_buff skb);
be8c6d86	161	void ieee802154_xmit_sync_worker(struct work_struct *work);
f0feb349	162	int ieee802154_sync_and_hold_queue(struct ieee802154_local *local);
ddd9ee7c	163	int ieee802154_mlme_op_pre(struct ieee802154_local *local);
fbdaa5ba MR	164	int ieee802154_mlme_tx(struct ieee802154_local *local,
	165	struct ieee802154_sub_if_data *sdata,
	166	struct sk_buff *skb);
dd180962 MR	167	int ieee802154_mlme_tx_locked(struct ieee802154_local *local,
	168	struct ieee802154_sub_if_data *sdata,
	169	struct sk_buff *skb);
ddd9ee7c	170	void ieee802154_mlme_op_post(struct ieee802154_local *local);
fbdaa5ba MR	171	int ieee802154_mlme_tx_one(struct ieee802154_local *local,
	172	struct ieee802154_sub_if_data *sdata,
	173	struct sk_buff *skb);
dd180962 MR	174	int ieee802154_mlme_tx_one_locked(struct ieee802154_local *local,
	175	struct ieee802154_sub_if_data *sdata,
	176	struct sk_buff *skb);
e5e584fc AA	177	netdev_tx_t
e5e584fc AA	178	ieee802154_monitor_start_xmit(struct sk_buff skb, struct net_device dev);
e5e584fc AA	179	netdev_tx_t
e5e584fc AA	180	ieee802154_subif_start_xmit(struct sk_buff skb, struct net_device dev);
61f2dcba	181	enum hrtimer_restart ieee802154_xmit_ifs_timer(struct hrtimer *timer);
5b641ebe	182
20a19d1d MR	183	/**
	184	* ieee802154_hold_queue - hold ieee802154 queue
	185	* @local: main mac object
	186	*
	187	* Hold a queue by incrementing an atomic counter and requesting the netif
	188	* queues to be stopped. The queues cannot be woken up while the counter has not
	189	* been reset with as any ieee802154_release_queue() calls as needed.
	190	*/
	191	void ieee802154_hold_queue(struct ieee802154_local *local);
	192
	193	/**
	194	* ieee802154_release_queue - release ieee802154 queue
	195	* @local: main mac object
	196	*
	197	* Release a queue which is held by decrementing an atomic counter and wake it
	198	* up only if the counter reaches 0.
	199	*/
	200	void ieee802154_release_queue(struct ieee802154_local *local);
	201
a40612f3 MR	202	/**
	203	* ieee802154_disable_queue - disable ieee802154 queue
	204	* @local: main mac object
	205	*
	206	* When trying to sync the Tx queue, we cannot just stop the queue
	207	* (which is basically a bit being set without proper lock handling)
	208	* because it would be racy. We actually need to call netif_tx_disable()
	209	* instead, which is done by this helper. Restarting the queue can
	210	* however still be done with a regular wake call.
	211	*/
	212	void ieee802154_disable_queue(struct ieee802154_local *local);
	213
ef2486f5	214	/* MIB callbacks */
66b69d4d	215	void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan);
ef2486f5	216
29e02374 PB	217	int mac802154_get_params(struct net_device *dev,
	218	struct ieee802154_llsec_params *params);
	219	int mac802154_set_params(struct net_device *dev,
	220	const struct ieee802154_llsec_params *params,
	221	int changed);
	222
	223	int mac802154_add_key(struct net_device *dev,
	224	const struct ieee802154_llsec_key_id *id,
	225	const struct ieee802154_llsec_key *key);
	226	int mac802154_del_key(struct net_device *dev,
	227	const struct ieee802154_llsec_key_id *id);
	228
	229	int mac802154_add_dev(struct net_device *dev,
	230	const struct ieee802154_llsec_device *llsec_dev);
	231	int mac802154_del_dev(struct net_device *dev, __le64 dev_addr);
	232
	233	int mac802154_add_devkey(struct net_device *dev,
	234	__le64 device_addr,
	235	const struct ieee802154_llsec_device_key *key);
	236	int mac802154_del_devkey(struct net_device *dev,
	237	__le64 device_addr,
	238	const struct ieee802154_llsec_device_key *key);
	239
	240	int mac802154_add_seclevel(struct net_device *dev,
	241	const struct ieee802154_llsec_seclevel *sl);
	242	int mac802154_del_seclevel(struct net_device *dev,
	243	const struct ieee802154_llsec_seclevel *sl);
	244
	245	void mac802154_lock_table(struct net_device *dev);
	246	void mac802154_get_table(struct net_device *dev,
	247	struct ieee802154_llsec_table **t);
	248	void mac802154_unlock_table(struct net_device *dev);
	249
d77b4852 AA	250	int mac802154_wpan_update_llsec(struct net_device *dev);
d77b4852 AA	251
57588c71 MR	252	/* PAN management handling */
	253	void mac802154_scan_worker(struct work_struct *work);
	254	int mac802154_trigger_scan_locked(struct ieee802154_sub_if_data *sdata,
	255	struct cfg802154_scan_request *request);
	256	int mac802154_abort_scan_locked(struct ieee802154_local *local,
	257	struct ieee802154_sub_if_data *sdata);
	258	int mac802154_process_beacon(struct ieee802154_local *local,
	259	struct sk_buff *skb,
	260	u8 page, u8 channel);
	261	void mac802154_rx_beacon_worker(struct work_struct *work);
	262
	263	static inline bool mac802154_is_scanning(struct ieee802154_local *local)
	264	{
	265	return test_bit(IEEE802154_IS_SCANNING, &local->ongoing);
	266	}
	267
3accf476 MR	268	void mac802154_beacon_worker(struct work_struct *work);
	269	int mac802154_send_beacons_locked(struct ieee802154_sub_if_data *sdata,
	270	struct cfg802154_beacon_request *request);
	271	int mac802154_stop_beacons_locked(struct ieee802154_local *local,
	272	struct ieee802154_sub_if_data *sdata);
	273
	274	static inline bool mac802154_is_beaconing(struct ieee802154_local *local)
	275	{
	276	return test_bit(IEEE802154_IS_BEACONING, &local->ongoing);
	277	}
	278
be4fd8e5 AA	279	/* interface handling */
	280	int ieee802154_iface_init(void);
	281	void ieee802154_iface_exit(void);
b210b187	282	void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata);
986a8abf AA	283	struct net_device *
986a8abf AA	284	ieee802154_if_add(struct ieee802154_local local, const char name,
5b4a1039 VB	285	unsigned char name_assign_type, enum nl802154_iftype type,
5b4a1039 VB	286	__le64 extended_addr);
592dfbfc	287	void ieee802154_remove_interfaces(struct ieee802154_local *local);
c4227c8a	288	void ieee802154_stop_device(struct ieee802154_local *local);
4a9a816a	289
0f1556bc	290	#endif /* __IEEE802154_I_H */