[linux-2.6-block.git] / include / net / cfg802154.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2007, 2008, 2009 Siemens AG
 *
 * Written by:
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 */

#ifndef __NET_CFG802154_H
#define __NET_CFG802154_H

#include <linux/ieee802154.h>
#include <linux/netdevice.h>
#include <linux/spinlock.h>
#include <linux/bug.h>

#include <net/nl802154.h>

struct wpan_phy;
struct wpan_phy_cca;
struct cfg802154_scan_request;
struct cfg802154_beacon_request;
struct ieee802154_addr;

#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
struct ieee802154_llsec_device_key;
struct ieee802154_llsec_seclevel;
struct ieee802154_llsec_params;
struct ieee802154_llsec_device;
struct ieee802154_llsec_table;
struct ieee802154_llsec_key_id;
struct ieee802154_llsec_key;
#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */

struct cfg802154_ops {
	struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
							   const char *name,
							   unsigned char name_assign_type,
							   int type);
	void	(*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
					       struct net_device *dev);
	int	(*suspend)(struct wpan_phy *wpan_phy);
	int	(*resume)(struct wpan_phy *wpan_phy);
	int	(*add_virtual_intf)(struct wpan_phy *wpan_phy,
				    const char *name,
				    unsigned char name_assign_type,
				    enum nl802154_iftype type,
				    __le64 extended_addr);
	int	(*del_virtual_intf)(struct wpan_phy *wpan_phy,
				    struct wpan_dev *wpan_dev);
	int	(*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
	int	(*set_cca_mode)(struct wpan_phy *wpan_phy,
				const struct wpan_phy_cca *cca);
	int     (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level);
	int     (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power);
	int	(*set_pan_id)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev, __le16 pan_id);
	int	(*set_short_addr)(struct wpan_phy *wpan_phy,
				  struct wpan_dev *wpan_dev, __le16 short_addr);
	int	(*set_backoff_exponent)(struct wpan_phy *wpan_phy,
					struct wpan_dev *wpan_dev, u8 min_be,
					u8 max_be);
	int	(*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
					 struct wpan_dev *wpan_dev,
					 u8 max_csma_backoffs);
	int	(*set_max_frame_retries)(struct wpan_phy *wpan_phy,
					 struct wpan_dev *wpan_dev,
					 s8 max_frame_retries);
	int	(*set_lbt_mode)(struct wpan_phy *wpan_phy,
				struct wpan_dev *wpan_dev, bool mode);
	int	(*set_ackreq_default)(struct wpan_phy *wpan_phy,
				      struct wpan_dev *wpan_dev, bool ackreq);
	int	(*trigger_scan)(struct wpan_phy *wpan_phy,
				struct cfg802154_scan_request *request);
	int	(*abort_scan)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev);
	int	(*send_beacons)(struct wpan_phy *wpan_phy,
				struct cfg802154_beacon_request *request);
	int	(*stop_beacons)(struct wpan_phy *wpan_phy,
				struct wpan_dev *wpan_dev);
	int	(*associate)(struct wpan_phy *wpan_phy,
			     struct wpan_dev *wpan_dev,
			     struct ieee802154_addr *coord);
	int	(*disassociate)(struct wpan_phy *wpan_phy,
				struct wpan_dev *wpan_dev,
				struct ieee802154_addr *target);
#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
	void	(*get_llsec_table)(struct wpan_phy *wpan_phy,
				   struct wpan_dev *wpan_dev,
				   struct ieee802154_llsec_table **table);
	void	(*lock_llsec_table)(struct wpan_phy *wpan_phy,
				    struct wpan_dev *wpan_dev);
	void	(*unlock_llsec_table)(struct wpan_phy *wpan_phy,
				      struct wpan_dev *wpan_dev);
	/* TODO remove locking/get table callbacks, this is part of the
	 * nl802154 interface and should be accessible from ieee802154 layer.
	 */
	int	(*get_llsec_params)(struct wpan_phy *wpan_phy,
				    struct wpan_dev *wpan_dev,
				    struct ieee802154_llsec_params *params);
	int	(*set_llsec_params)(struct wpan_phy *wpan_phy,
				    struct wpan_dev *wpan_dev,
				    const struct ieee802154_llsec_params *params,
				    int changed);
	int	(*add_llsec_key)(struct wpan_phy *wpan_phy,
				 struct wpan_dev *wpan_dev,
				 const struct ieee802154_llsec_key_id *id,
				 const struct ieee802154_llsec_key *key);
	int	(*del_llsec_key)(struct wpan_phy *wpan_phy,
				 struct wpan_dev *wpan_dev,
				 const struct ieee802154_llsec_key_id *id);
	int	(*add_seclevel)(struct wpan_phy *wpan_phy,
				 struct wpan_dev *wpan_dev,
				 const struct ieee802154_llsec_seclevel *sl);
	int	(*del_seclevel)(struct wpan_phy *wpan_phy,
				 struct wpan_dev *wpan_dev,
				 const struct ieee802154_llsec_seclevel *sl);
	int	(*add_device)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev,
			      const struct ieee802154_llsec_device *dev);
	int	(*del_device)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev, __le64 extended_addr);
	int	(*add_devkey)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev,
			      __le64 extended_addr,
			      const struct ieee802154_llsec_device_key *key);
	int	(*del_devkey)(struct wpan_phy *wpan_phy,
			      struct wpan_dev *wpan_dev,
			      __le64 extended_addr,
			      const struct ieee802154_llsec_device_key *key);
#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
};

static inline bool
wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
{
	switch (st) {
	case NL802154_SUPPORTED_BOOL_TRUE:
		return b;
	case NL802154_SUPPORTED_BOOL_FALSE:
		return !b;
	case NL802154_SUPPORTED_BOOL_BOTH:
		return true;
	default:
		WARN_ON(1);
	}

	return false;
}

struct wpan_phy_supported {
	u32 channels[IEEE802154_MAX_PAGE + 1],
	    cca_modes, cca_opts, iftypes;
	enum nl802154_supported_bool_states lbt;
	u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
	   min_csma_backoffs, max_csma_backoffs;
	s8 min_frame_retries, max_frame_retries;
	size_t tx_powers_size, cca_ed_levels_size;
	const s32 *tx_powers, *cca_ed_levels;
};

struct wpan_phy_cca {
	enum nl802154_cca_modes mode;
	enum nl802154_cca_opts opt;
};

static inline bool
wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b)
{
	if (a->mode != b->mode)
		return false;

	if (a->mode == NL802154_CCA_ENERGY_CARRIER)
		return a->opt == b->opt;

	return true;
}

/**
 * enum wpan_phy_flags - WPAN PHY state flags
 * @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support
 *	transmit power setting.
 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
 *	level setting.
 * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
 *	setting.
 * @WPAN_PHY_FLAG_STATE_QUEUE_STOPPED: Indicates that the transmit queue was
 *	temporarily stopped.
 * @WPAN_PHY_FLAG_DATAGRAMS_ONLY: Indicates that transceiver is only able to
 *	send/receive datagrams.
 */
enum wpan_phy_flags {
	WPAN_PHY_FLAG_TXPOWER		= BIT(1),
	WPAN_PHY_FLAG_CCA_ED_LEVEL	= BIT(2),
	WPAN_PHY_FLAG_CCA_MODE		= BIT(3),
	WPAN_PHY_FLAG_STATE_QUEUE_STOPPED = BIT(4),
	WPAN_PHY_FLAG_DATAGRAMS_ONLY	= BIT(5),
};

struct wpan_phy {
	/* If multiple wpan_phys are registered and you're handed e.g.
	 * a regular netdev with assigned ieee802154_ptr, you won't
	 * know whether it points to a wpan_phy your driver has registered
	 * or not. Assign this to something global to your driver to
	 * help determine whether you own this wpan_phy or not.
	 */
	const void *privid;

	unsigned long flags;

	/*
	 * This is a PIB according to 802.15.4-2011.
	 * We do not provide timing-related variables, as they
	 * aren't used outside of driver
	 */
	u8 current_channel;
	u8 current_page;
	struct wpan_phy_supported supported;
	/* current transmit_power in mBm */
	s32 transmit_power;
	struct wpan_phy_cca cca;

	__le64 perm_extended_addr;

	/* current cca ed threshold in mBm */
	s32 cca_ed_level;

	/* PHY depended MAC PIB values */

	/* 802.15.4 acronym: Tdsym in nsec */
	u32 symbol_duration;
	/* lifs and sifs periods timing */
	u16 lifs_period;
	u16 sifs_period;

	struct device dev;

	/* the network namespace this phy lives in currently */
	possible_net_t _net;

	/* Transmission monitoring and control */
	spinlock_t queue_lock;
	atomic_t ongoing_txs;
	atomic_t hold_txs;
	wait_queue_head_t sync_txq;

	/* Current filtering level on reception.
	 * Only allowed to be changed if phy is not operational.
	 */
	enum ieee802154_filtering_level filtering;

	char priv[] __aligned(NETDEV_ALIGN);
};

static inline struct net *wpan_phy_net(struct wpan_phy *wpan_phy)
{
	return read_pnet(&wpan_phy->_net);
}

static inline void wpan_phy_net_set(struct wpan_phy *wpan_phy, struct net *net)
{
	write_pnet(&wpan_phy->_net, net);
}

static inline bool ieee802154_chan_is_valid(struct wpan_phy *phy,
					    u8 page, u8 channel)
{
	if (page > IEEE802154_MAX_PAGE ||
	    channel > IEEE802154_MAX_CHANNEL ||
	    !(phy->supported.channels[page] & BIT(channel)))
		return false;

	return true;
}

/**
 * struct ieee802154_addr - IEEE802.15.4 device address
 * @mode: Address mode from frame header. Can be one of:
 *        - @IEEE802154_ADDR_NONE
 *        - @IEEE802154_ADDR_SHORT
 *        - @IEEE802154_ADDR_LONG
 * @pan_id: The PAN ID this address belongs to
 * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT
 * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG
 */
struct ieee802154_addr {
	u8 mode;
	__le16 pan_id;
	union {
		__le16 short_addr;
		__le64 extended_addr;
	};
};

/**
 * struct ieee802154_coord_desc - Coordinator descriptor
 * @addr: PAN ID and coordinator address
 * @page: page this coordinator is using
 * @channel: channel this coordinator is using
 * @superframe_spec: SuperFrame specification as received
 * @link_quality: link quality indicator at which the beacon was received
 * @gts_permit: the coordinator accepts GTS requests
 */
struct ieee802154_coord_desc {
	struct ieee802154_addr addr;
	u8 page;
	u8 channel;
	u16 superframe_spec;
	u8 link_quality;
	bool gts_permit;
};

/**
 * struct ieee802154_pan_device - PAN device information
 * @pan_id: the PAN ID of this device
 * @mode: the preferred mode to reach the device
 * @short_addr: the short address of this device
 * @extended_addr: the extended address of this device
 * @node: the list node
 */
struct ieee802154_pan_device {
	__le16 pan_id;
	u8 mode;
	__le16 short_addr;
	__le64 extended_addr;
	struct list_head node;
};

/**
 * struct cfg802154_scan_request - Scan request
 *
 * @type: type of scan to be performed
 * @page: page on which to perform the scan
 * @channels: channels in te %page to be scanned
 * @duration: time spent on each channel, calculated with:
 *            aBaseSuperframeDuration * (2 ^ duration + 1)
 * @wpan_dev: the wpan device on which to perform the scan
 * @wpan_phy: the wpan phy on which to perform the scan
 */
struct cfg802154_scan_request {
	enum nl802154_scan_types type;
	u8 page;
	u32 channels;
	u8 duration;
	struct wpan_dev *wpan_dev;
	struct wpan_phy *wpan_phy;
};

/**
 * struct cfg802154_beacon_request - Beacon request descriptor
 *
 * @interval: interval n between sendings, in multiple order of the super frame
 *            duration: aBaseSuperframeDuration * (2^n) unless the interval
 *            order is greater or equal to 15, in this case beacons won't be
 *            passively sent out at a fixed rate but instead inform the device
 *            that it should answer beacon requests as part of active scan
 *            procedures
 * @wpan_dev: the concerned wpan device
 * @wpan_phy: the wpan phy this was for
 */
struct cfg802154_beacon_request {
	u8 interval;
	struct wpan_dev *wpan_dev;
	struct wpan_phy *wpan_phy;
};

/**
 * struct cfg802154_mac_pkt - MAC packet descriptor (beacon/command)
 * @node: MAC packets to process list member
 * @skb: the received sk_buff
 * @sdata: the interface on which @skb was received
 * @page: page configuration when @skb was received
 * @channel: channel configuration when @skb was received
 */
struct cfg802154_mac_pkt {
	struct list_head node;
	struct sk_buff *skb;
	struct ieee802154_sub_if_data *sdata;
	u8 page;
	u8 channel;
};

struct ieee802154_llsec_key_id {
	u8 mode;
	u8 id;
	union {
		struct ieee802154_addr device_addr;
		__le32 short_source;
		__le64 extended_source;
	};
};

#define IEEE802154_LLSEC_KEY_SIZE 16

struct ieee802154_llsec_key {
	u8 frame_types;
	u32 cmd_frame_ids;
	/* TODO replace with NL802154_KEY_SIZE */
	u8 key[IEEE802154_LLSEC_KEY_SIZE];
};

struct ieee802154_llsec_key_entry {
	struct list_head list;

	struct ieee802154_llsec_key_id id;
	struct ieee802154_llsec_key *key;
};

struct ieee802154_llsec_params {
	bool enabled;

	__be32 frame_counter;
	u8 out_level;
	struct ieee802154_llsec_key_id out_key;

	__le64 default_key_source;

	__le16 pan_id;
	__le64 hwaddr;
	__le64 coord_hwaddr;
	__le16 coord_shortaddr;
};

struct ieee802154_llsec_table {
	struct list_head keys;
	struct list_head devices;
	struct list_head security_levels;
};

struct ieee802154_llsec_seclevel {
	struct list_head list;

	u8 frame_type;
	u8 cmd_frame_id;
	bool device_override;
	u32 sec_levels;
};

struct ieee802154_llsec_device {
	struct list_head list;

	__le16 pan_id;
	__le16 short_addr;
	__le64 hwaddr;
	u32 frame_counter;
	bool seclevel_exempt;

	u8 key_mode;
	struct list_head keys;
};

struct ieee802154_llsec_device_key {
	struct list_head list;

	struct ieee802154_llsec_key_id key_id;
	u32 frame_counter;
};

struct wpan_dev_header_ops {
	/* TODO create callback currently assumes ieee802154_mac_cb inside
	 * skb->cb. This should be changed to give these information as
	 * parameter.
	 */
	int	(*create)(struct sk_buff *skb, struct net_device *dev,
			  const struct ieee802154_addr *daddr,
			  const struct ieee802154_addr *saddr,
			  unsigned int len);
};

struct wpan_dev {
	struct wpan_phy *wpan_phy;
	int iftype;

	/* the remainder of this struct should be private to cfg802154 */
	struct list_head list;
	struct net_device *netdev;

	const struct wpan_dev_header_ops *header_ops;

	/* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */
	struct net_device *lowpan_dev;

	u32 identifier;

	/* MAC PIB */
	__le16 pan_id;
	__le16 short_addr;
	__le64 extended_addr;

	/* MAC BSN field */
	atomic_t bsn;
	/* MAC DSN field */
	atomic_t dsn;

	u8 min_be;
	u8 max_be;
	u8 csma_retries;
	s8 frame_retries;

	bool lbt;

	/* fallback for acknowledgment bit setting */
	bool ackreq;

	/* Associations */
	struct mutex association_lock;
	struct ieee802154_pan_device *parent;
	struct list_head children;
	unsigned int max_associations;
	unsigned int nchildren;
};

#define to_phy(_dev)	container_of(_dev, struct wpan_phy, dev)

#if IS_ENABLED(CONFIG_IEEE802154) || IS_ENABLED(CONFIG_6LOWPAN)
static inline int
wpan_dev_hard_header(struct sk_buff *skb, struct net_device *dev,
		     const struct ieee802154_addr *daddr,
		     const struct ieee802154_addr *saddr,
		     unsigned int len)
{
	struct wpan_dev *wpan_dev = dev->ieee802154_ptr;

	return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len);
}
#endif

struct wpan_phy *
wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
{
	phy->dev.parent = dev;
}

int wpan_phy_register(struct wpan_phy *phy);
void wpan_phy_unregister(struct wpan_phy *phy);
void wpan_phy_free(struct wpan_phy *phy);
/* Same semantics as for class_for_each_device */
int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);

static inline void *wpan_phy_priv(struct wpan_phy *phy)
{
	BUG_ON(!phy);
	return &phy->priv;
}

struct wpan_phy *wpan_phy_find(const char *str);

static inline void wpan_phy_put(struct wpan_phy *phy)
{
	put_device(&phy->dev);
}

static inline const char *wpan_phy_name(struct wpan_phy *phy)
{
	return dev_name(&phy->dev);
}

void ieee802154_configure_durations(struct wpan_phy *phy,
				    unsigned int page, unsigned int channel);

/**
 * cfg802154_device_is_associated - Checks whether we are associated to any device
 * @wpan_dev: the wpan device
 * @return: true if we are associated
 */
bool cfg802154_device_is_associated(struct wpan_dev *wpan_dev);

/**
 * cfg802154_device_is_parent - Checks if a device is our coordinator
 * @wpan_dev: the wpan device
 * @target: the expected parent
 * @return: true if @target is our coordinator
 */
bool cfg802154_device_is_parent(struct wpan_dev *wpan_dev,
				struct ieee802154_addr *target);

/**
 * cfg802154_device_is_child - Checks whether a device is associated to us
 * @wpan_dev: the wpan device
 * @target: the expected child
 * @return: the PAN device
 */
struct ieee802154_pan_device *
cfg802154_device_is_child(struct wpan_dev *wpan_dev,
			  struct ieee802154_addr *target);

/**
 * cfg802154_set_max_associations - Limit the number of future associations
 * @wpan_dev: the wpan device
 * @max: the maximum number of devices we accept to associate
 * @return: the old maximum value
 */
unsigned int cfg802154_set_max_associations(struct wpan_dev *wpan_dev,
					    unsigned int max);

/**
 * cfg802154_get_free_short_addr - Get a free address among the known devices
 * @wpan_dev: the wpan device
 * @return: a random short address expectedly unused on our PAN
 */
__le16 cfg802154_get_free_short_addr(struct wpan_dev *wpan_dev);

#endif /* __NET_CFG802154_H */
Commit	Line	Data
1802d0be	1	/* SPDX-License-Identifier: GPL-2.0-only */
2bfb1070 DES	2	/*
	3	* Copyright (C) 2007, 2008, 2009 Siemens AG
	4	*
2bfb1070 DES	5	* Written by:
	6	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
	7	*/
	8
5ad60d36 AA	9	#ifndef __NET_CFG802154_H
5ad60d36 AA	10	#define __NET_CFG802154_H
2bfb1070	11
cb41c8dd	12	#include <linux/ieee802154.h>
2bfb1070	13	#include <linux/netdevice.h>
20a19d1d	14	#include <linux/spinlock.h>
187f1882	15	#include <linux/bug.h>
2bfb1070	16
f3ea5e44 AA	17	#include <net/nl802154.h>
f3ea5e44 AA	18
a5dd1d72	19	struct wpan_phy;
ba2a9506	20	struct wpan_phy_cca;
ed3557c9	21	struct cfg802154_scan_request;
9bc11450	22	struct cfg802154_beacon_request;
05db59a0	23	struct ieee802154_addr;
a5dd1d72	24
a26c5fd7 AA	25	#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
	26	struct ieee802154_llsec_device_key;
	27	struct ieee802154_llsec_seclevel;
	28	struct ieee802154_llsec_params;
	29	struct ieee802154_llsec_device;
	30	struct ieee802154_llsec_table;
	31	struct ieee802154_llsec_key_id;
	32	struct ieee802154_llsec_key;
	33	#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
	34
a5dd1d72	35	struct cfg802154_ops {
4a9a816a AA	36	struct net_device * (add_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
4a9a816a AA	37	const char *name,
5b4a1039	38	unsigned char name_assign_type,
4a9a816a	39	int type);
9d30a8cf AA	40	void (del_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
9d30a8cf AA	41	struct net_device *dev);
a6cb869b VB	42	int (suspend)(struct wpan_phy wpan_phy);
a6cb869b VB	43	int (resume)(struct wpan_phy wpan_phy);
f3ea5e44 AA	44	int (add_virtual_intf)(struct wpan_phy wpan_phy,
f3ea5e44 AA	45	const char *name,
5b4a1039	46	unsigned char name_assign_type,
0e57547e AA	47	enum nl802154_iftype type,
0e57547e AA	48	__le64 extended_addr);
b821ecd4 AA	49	int (del_virtual_intf)(struct wpan_phy wpan_phy,
b821ecd4 AA	50	struct wpan_dev *wpan_dev);
ab0bd561	51	int (set_channel)(struct wpan_phy wpan_phy, u8 page, u8 channel);
ba2a9506 AA	52	int (set_cca_mode)(struct wpan_phy wpan_phy,
ba2a9506 AA	53	const struct wpan_phy_cca *cca);
b69644c1	54	int (set_cca_ed_level)(struct wpan_phy wpan_phy, s32 ed_level);
0f999b09	55	int (set_tx_power)(struct wpan_phy wpan_phy, s32 power);
702bf371	56	int (set_pan_id)(struct wpan_phy wpan_phy,
ee7b9053	57	struct wpan_dev *wpan_dev, __le16 pan_id);
9830c62a	58	int (set_short_addr)(struct wpan_phy wpan_phy,
ee7b9053	59	struct wpan_dev *wpan_dev, __le16 short_addr);
656a999e AA	60	int (set_backoff_exponent)(struct wpan_phy wpan_phy,
	61	struct wpan_dev *wpan_dev, u8 min_be,
	62	u8 max_be);
a01ba765 AA	63	int (set_max_csma_backoffs)(struct wpan_phy wpan_phy,
	64	struct wpan_dev *wpan_dev,
	65	u8 max_csma_backoffs);
17a3a46b AA	66	int (set_max_frame_retries)(struct wpan_phy wpan_phy,
	67	struct wpan_dev *wpan_dev,
	68	s8 max_frame_retries);
c8937a1d AA	69	int (set_lbt_mode)(struct wpan_phy wpan_phy,
c8937a1d AA	70	struct wpan_dev *wpan_dev, bool mode);
c91208d8 AA	71	int (set_ackreq_default)(struct wpan_phy wpan_phy,
c91208d8 AA	72	struct wpan_dev *wpan_dev, bool ackreq);
ed3557c9 MR	73	int (trigger_scan)(struct wpan_phy wpan_phy,
	74	struct cfg802154_scan_request *request);
	75	int (abort_scan)(struct wpan_phy wpan_phy,
	76	struct wpan_dev *wpan_dev);
9bc11450 MR	77	int (send_beacons)(struct wpan_phy wpan_phy,
	78	struct cfg802154_beacon_request *request);
	79	int (stop_beacons)(struct wpan_phy wpan_phy,
	80	struct wpan_dev *wpan_dev);
05db59a0 MR	81	int (associate)(struct wpan_phy wpan_phy,
	82	struct wpan_dev *wpan_dev,
	83	struct ieee802154_addr *coord);
7b18313e MR	84	int (disassociate)(struct wpan_phy wpan_phy,
	85	struct wpan_dev *wpan_dev,
	86	struct ieee802154_addr *target);
a26c5fd7 AA	87	#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
	88	void (get_llsec_table)(struct wpan_phy wpan_phy,
	89	struct wpan_dev *wpan_dev,
	90	struct ieee802154_llsec_table **table);
	91	void (lock_llsec_table)(struct wpan_phy wpan_phy,
	92	struct wpan_dev *wpan_dev);
	93	void (unlock_llsec_table)(struct wpan_phy wpan_phy,
	94	struct wpan_dev *wpan_dev);
	95	/* TODO remove locking/get table callbacks, this is part of the
	96	* nl802154 interface and should be accessible from ieee802154 layer.
	97	*/
	98	int (get_llsec_params)(struct wpan_phy wpan_phy,
	99	struct wpan_dev *wpan_dev,
	100	struct ieee802154_llsec_params *params);
	101	int (set_llsec_params)(struct wpan_phy wpan_phy,
	102	struct wpan_dev *wpan_dev,
	103	const struct ieee802154_llsec_params *params,
	104	int changed);
	105	int (add_llsec_key)(struct wpan_phy wpan_phy,
	106	struct wpan_dev *wpan_dev,
	107	const struct ieee802154_llsec_key_id *id,
	108	const struct ieee802154_llsec_key *key);
	109	int (del_llsec_key)(struct wpan_phy wpan_phy,
	110	struct wpan_dev *wpan_dev,
	111	const struct ieee802154_llsec_key_id *id);
	112	int (add_seclevel)(struct wpan_phy wpan_phy,
	113	struct wpan_dev *wpan_dev,
	114	const struct ieee802154_llsec_seclevel *sl);
	115	int (del_seclevel)(struct wpan_phy wpan_phy,
	116	struct wpan_dev *wpan_dev,
	117	const struct ieee802154_llsec_seclevel *sl);
	118	int (add_device)(struct wpan_phy wpan_phy,
	119	struct wpan_dev *wpan_dev,
	120	const struct ieee802154_llsec_device *dev);
	121	int (del_device)(struct wpan_phy wpan_phy,
	122	struct wpan_dev *wpan_dev, __le64 extended_addr);
	123	int (add_devkey)(struct wpan_phy wpan_phy,
	124	struct wpan_dev *wpan_dev,
	125	__le64 extended_addr,
	126	const struct ieee802154_llsec_device_key *key);
	127	int (del_devkey)(struct wpan_phy wpan_phy,
	128	struct wpan_dev *wpan_dev,
	129	__le64 extended_addr,
	130	const struct ieee802154_llsec_device_key *key);
	131	#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
a5dd1d72 AA	132	};
a5dd1d72 AA	133
fea3318d AA	134	static inline bool
	135	wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
	136	{
	137	switch (st) {
	138	case NL802154_SUPPORTED_BOOL_TRUE:
	139	return b;
	140	case NL802154_SUPPORTED_BOOL_FALSE:
	141	return !b;
	142	case NL802154_SUPPORTED_BOOL_BOTH:
	143	return true;
	144	default:
	145	WARN_ON(1);
	146	}
	147
	148	return false;
	149	}
	150
72f655e4	151	struct wpan_phy_supported {
fea3318d	152	u32 channels[IEEE802154_MAX_PAGE + 1],
65318680	153	cca_modes, cca_opts, iftypes;
fea3318d AA	154	enum nl802154_supported_bool_states lbt;
	155	u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
	156	min_csma_backoffs, max_csma_backoffs;
	157	s8 min_frame_retries, max_frame_retries;
	158	size_t tx_powers_size, cca_ed_levels_size;
	159	const s32 tx_powers, cca_ed_levels;
72f655e4 AA	160	};
72f655e4 AA	161
7fe9a388 AA	162	struct wpan_phy_cca {
	163	enum nl802154_cca_modes mode;
	164	enum nl802154_cca_opts opt;
	165	};
	166
791021bf AA	167	static inline bool
	168	wpan_phy_cca_cmp(const struct wpan_phy_cca a, const struct wpan_phy_cca b)
	169	{
	170	if (a->mode != b->mode)
	171	return false;
	172
	173	if (a->mode == NL802154_CCA_ENERGY_CARRIER)
	174	return a->opt == b->opt;
	175
	176	return true;
	177	}
	178
edea8f7c	179	/**
a63e4044 RD	180	* enum wpan_phy_flags - WPAN PHY state flags
a63e4044 RD	181	* @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support
edea8f7c AA	182	* transmit power setting.
	183	* @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
	184	* level setting.
	185	* @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
	186	* setting.
2b13db13 MR	187	* @WPAN_PHY_FLAG_STATE_QUEUE_STOPPED: Indicates that the transmit queue was
2b13db13 MR	188	* temporarily stopped.
822452fb MR	189	* @WPAN_PHY_FLAG_DATAGRAMS_ONLY: Indicates that transceiver is only able to
822452fb MR	190	* send/receive datagrams.
edea8f7c AA	191	*/
	192	enum wpan_phy_flags {
	193	WPAN_PHY_FLAG_TXPOWER = BIT(1),
	194	WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2),
	195	WPAN_PHY_FLAG_CCA_MODE = BIT(3),
2b13db13	196	WPAN_PHY_FLAG_STATE_QUEUE_STOPPED = BIT(4),
822452fb	197	WPAN_PHY_FLAG_DATAGRAMS_ONLY = BIT(5),
edea8f7c AA	198	};
edea8f7c AA	199
2bfb1070	200	struct wpan_phy {
6322d50d AA	201	/* If multiple wpan_phys are registered and you're handed e.g.
	202	* a regular netdev with assigned ieee802154_ptr, you won't
	203	* know whether it points to a wpan_phy your driver has registered
	204	* or not. Assign this to something global to your driver to
	205	* help determine whether you own this wpan_phy or not.
	206	*/
	207	const void *privid;
	208
2b13db13	209	unsigned long flags;
edea8f7c	210
2bfb1070	211	/*
9b2777d6	212	* This is a PIB according to 802.15.4-2011.
2bfb1070 DES	213	* We do not provide timing-related variables, as they
	214	* aren't used outside of driver
	215	*/
	216	u8 current_channel;
	217	u8 current_page;
72f655e4	218	struct wpan_phy_supported supported;
e2eb173a	219	/* current transmit_power in mBm */
1a19cb68	220	s32 transmit_power;
7fe9a388	221	struct wpan_phy_cca cca;
dee56d14 AA	222
dee56d14 AA	223	__le64 perm_extended_addr;
2bfb1070	224
32b23550	225	/* current cca ed threshold in mBm */
6ca00197	226	s32 cca_ed_level;
84dda3c6	227
61f2dcba AA	228	/* PHY depended MAC PIB values */
61f2dcba AA	229
731cddce MR	230	/* 802.15.4 acronym: Tdsym in nsec */
731cddce MR	231	u32 symbol_duration;
61f2dcba AA	232	/* lifs and sifs periods timing */
	233	u16 lifs_period;
	234	u16 sifs_period;
	235
2bfb1070	236	struct device dev;
2bfb1070	237
66e5c267 AA	238	/* the network namespace this phy lives in currently */
	239	possible_net_t _net;
	240
20a19d1d MR	241	/* Transmission monitoring and control */
20a19d1d MR	242	spinlock_t queue_lock;
bde000ae	243	atomic_t ongoing_txs;
20a19d1d	244	atomic_t hold_txs;
f0feb349	245	wait_queue_head_t sync_txq;
bde000ae	246
ac8037c3 AA	247	/* Current filtering level on reception.
	248	* Only allowed to be changed if phy is not operational.
	249	*/
	250	enum ieee802154_filtering_level filtering;
	251
53cb2cfa	252	char priv[] __aligned(NETDEV_ALIGN);
2bfb1070 DES	253	};
2bfb1070 DES	254
66e5c267 AA	255	static inline struct net wpan_phy_net(struct wpan_phy wpan_phy)
	256	{
	257	return read_pnet(&wpan_phy->_net);
	258	}
	259
	260	static inline void wpan_phy_net_set(struct wpan_phy wpan_phy, struct net net)
	261	{
	262	write_pnet(&wpan_phy->_net, net);
	263	}
	264
d2aaf2a0 MR	265	static inline bool ieee802154_chan_is_valid(struct wpan_phy *phy,
	266	u8 page, u8 channel)
	267	{
	268	if (page > IEEE802154_MAX_PAGE \|\|
	269	channel > IEEE802154_MAX_CHANNEL \|\|
	270	!(phy->supported.channels[page] & BIT(channel)))
	271	return false;
	272
	273	return true;
	274	}
	275
02b2a91c DG	276	/**
	277	* struct ieee802154_addr - IEEE802.15.4 device address
	278	* @mode: Address mode from frame header. Can be one of:
	279	* - @IEEE802154_ADDR_NONE
	280	* - @IEEE802154_ADDR_SHORT
	281	* - @IEEE802154_ADDR_LONG
	282	* @pan_id: The PAN ID this address belongs to
	283	* @short_addr: address if @mode is @IEEE802154_ADDR_SHORT
	284	* @extended_addr: address if @mode is @IEEE802154_ADDR_LONG
	285	*/
838b83d6 AA	286	struct ieee802154_addr {
	287	u8 mode;
	288	__le16 pan_id;
	289	union {
	290	__le16 short_addr;
	291	__le64 extended_addr;
	292	};
	293	};
	294
51147284 MR	295	/**
	296	* struct ieee802154_coord_desc - Coordinator descriptor
	297	* @addr: PAN ID and coordinator address
	298	* @page: page this coordinator is using
	299	* @channel: channel this coordinator is using
	300	* @superframe_spec: SuperFrame specification as received
	301	* @link_quality: link quality indicator at which the beacon was received
	302	* @gts_permit: the coordinator accepts GTS requests
	303	*/
	304	struct ieee802154_coord_desc {
	305	struct ieee802154_addr addr;
	306	u8 page;
	307	u8 channel;
	308	u16 superframe_spec;
	309	u8 link_quality;
	310	bool gts_permit;
	311	};
	312
2e7ed75e MR	313	/**
	314	* struct ieee802154_pan_device - PAN device information
	315	* @pan_id: the PAN ID of this device
	316	* @mode: the preferred mode to reach the device
	317	* @short_addr: the short address of this device
	318	* @extended_addr: the extended address of this device
	319	* @node: the list node
	320	*/
	321	struct ieee802154_pan_device {
	322	__le16 pan_id;
	323	u8 mode;
	324	__le16 short_addr;
	325	__le64 extended_addr;
	326	struct list_head node;
	327	};
	328
ed3557c9 MR	329	/**
	330	* struct cfg802154_scan_request - Scan request
	331	*
	332	* @type: type of scan to be performed
	333	* @page: page on which to perform the scan
	334	* @channels: channels in te %page to be scanned
	335	* @duration: time spent on each channel, calculated with:
	336	* aBaseSuperframeDuration * (2 ^ duration + 1)
	337	* @wpan_dev: the wpan device on which to perform the scan
	338	* @wpan_phy: the wpan phy on which to perform the scan
	339	*/
	340	struct cfg802154_scan_request {
	341	enum nl802154_scan_types type;
	342	u8 page;
	343	u32 channels;
	344	u8 duration;
	345	struct wpan_dev *wpan_dev;
	346	struct wpan_phy *wpan_phy;
	347	};
	348
9bc11450 MR	349	/**
	350	* struct cfg802154_beacon_request - Beacon request descriptor
	351	*
	352	* @interval: interval n between sendings, in multiple order of the super frame
	353	* duration: aBaseSuperframeDuration * (2^n) unless the interval
	354	* order is greater or equal to 15, in this case beacons won't be
	355	* passively sent out at a fixed rate but instead inform the device
	356	* that it should answer beacon requests as part of active scan
	357	* procedures
	358	* @wpan_dev: the concerned wpan device
	359	* @wpan_phy: the wpan phy this was for
	360	*/
	361	struct cfg802154_beacon_request {
	362	u8 interval;
	363	struct wpan_dev *wpan_dev;
	364	struct wpan_phy *wpan_phy;
	365	};
	366
57588c71 MR	367	/**
	368	* struct cfg802154_mac_pkt - MAC packet descriptor (beacon/command)
	369	* @node: MAC packets to process list member
	370	* @skb: the received sk_buff
	371	* @sdata: the interface on which @skb was received
	372	* @page: page configuration when @skb was received
	373	* @channel: channel configuration when @skb was received
	374	*/
	375	struct cfg802154_mac_pkt {
	376	struct list_head node;
	377	struct sk_buff *skb;
	378	struct ieee802154_sub_if_data *sdata;
	379	u8 page;
	380	u8 channel;
	381	};
	382
a26c5fd7 AA	383	struct ieee802154_llsec_key_id {
	384	u8 mode;
	385	u8 id;
	386	union {
	387	struct ieee802154_addr device_addr;
	388	__le32 short_source;
	389	__le64 extended_source;
	390	};
	391	};
	392
	393	#define IEEE802154_LLSEC_KEY_SIZE 16
	394
	395	struct ieee802154_llsec_key {
	396	u8 frame_types;
	397	u32 cmd_frame_ids;
	398	/* TODO replace with NL802154_KEY_SIZE */
	399	u8 key[IEEE802154_LLSEC_KEY_SIZE];
	400	};
	401
	402	struct ieee802154_llsec_key_entry {
	403	struct list_head list;
	404
	405	struct ieee802154_llsec_key_id id;
	406	struct ieee802154_llsec_key *key;
	407	};
	408
	409	struct ieee802154_llsec_params {
	410	bool enabled;
	411
	412	__be32 frame_counter;
	413	u8 out_level;
	414	struct ieee802154_llsec_key_id out_key;
	415
	416	__le64 default_key_source;
	417
	418	__le16 pan_id;
	419	__le64 hwaddr;
	420	__le64 coord_hwaddr;
	421	__le16 coord_shortaddr;
	422	};
	423
	424	struct ieee802154_llsec_table {
	425	struct list_head keys;
	426	struct list_head devices;
	427	struct list_head security_levels;
	428	};
	429
	430	struct ieee802154_llsec_seclevel {
	431	struct list_head list;
	432
	433	u8 frame_type;
	434	u8 cmd_frame_id;
	435	bool device_override;
	436	u32 sec_levels;
	437	};
	438
	439	struct ieee802154_llsec_device {
	440	struct list_head list;
	441
	442	__le16 pan_id;
	443	__le16 short_addr;
	444	__le64 hwaddr;
	445	u32 frame_counter;
	446	bool seclevel_exempt;
447
448	u8 key_mode;
449	struct list_head keys;
450	};
451
452	struct ieee802154_llsec_device_key {
453	struct list_head list;
454
455	struct ieee802154_llsec_key_id key_id;
456	u32 frame_counter;
457	};
458
838b83d6 AA	459	struct wpan_dev_header_ops {
	460	/* TODO create callback currently assumes ieee802154_mac_cb inside
	461	* skb->cb. This should be changed to give these information as
	462	* parameter.
	463	*/
	464	int (create)(struct sk_buff skb, struct net_device *dev,
	465	const struct ieee802154_addr *daddr,
	466	const struct ieee802154_addr *saddr,
	467	unsigned int len);
	468	};
	469
d5ae67ba AA	470	struct wpan_dev {
d5ae67ba AA	471	struct wpan_phy *wpan_phy;
190ac1ca	472	int iftype;
863e88f2	473
fcf39e6e AA	474	/* the remainder of this struct should be private to cfg802154 */
	475	struct list_head list;
	476	struct net_device *netdev;
	477
838b83d6 AA	478	const struct wpan_dev_header_ops *header_ops;
838b83d6 AA	479
51e0e5d8 AA	480	/* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */
	481	struct net_device *lowpan_dev;
	482
fcf39e6e AA	483	u32 identifier;
fcf39e6e AA	484
863e88f2 AA	485	/* MAC PIB */
	486	__le16 pan_id;
	487	__le16 short_addr;
	488	__le64 extended_addr;
	489
	490	/* MAC BSN field */
344f8c11	491	atomic_t bsn;
863e88f2	492	/* MAC DSN field */
344f8c11	493	atomic_t dsn;
863e88f2 AA	494
	495	u8 min_be;
	496	u8 max_be;
	497	u8 csma_retries;
	498	s8 frame_retries;
	499
	500	bool lbt;
	501
c91208d8 AA	502	/* fallback for acknowledgment bit setting */
c91208d8 AA	503	bool ackreq;
2e7ed75e MR	504
	505	/* Associations */
	506	struct mutex association_lock;
	507	struct ieee802154_pan_device *parent;
	508	struct list_head children;
ce93b937	509	unsigned int max_associations;
80f8bf9a	510	unsigned int nchildren;
d5ae67ba AA	511	};
d5ae67ba AA	512
42723448 DES	513	#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
42723448 DES	514
c304eddc	515	#if IS_ENABLED(CONFIG_IEEE802154) \|\| IS_ENABLED(CONFIG_6LOWPAN)
838b83d6 AA	516	static inline int
	517	wpan_dev_hard_header(struct sk_buff skb, struct net_device dev,
	518	const struct ieee802154_addr *daddr,
	519	const struct ieee802154_addr *saddr,
	520	unsigned int len)
	521	{
	522	struct wpan_dev *wpan_dev = dev->ieee802154_ptr;
	523
	524	return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len);
	525	}
c304eddc	526	#endif
838b83d6	527
a5dd1d72	528	struct wpan_phy *
f601379f	529	wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
e9cf356c DES	530	static inline void wpan_phy_set_dev(struct wpan_phy phy, struct device dev)
	531	{
	532	phy->dev.parent = dev;
	533	}
e72740d0	534
e9cf356c	535	int wpan_phy_register(struct wpan_phy *phy);
2bfb1070 DES	536	void wpan_phy_unregister(struct wpan_phy *phy);
2bfb1070 DES	537	void wpan_phy_free(struct wpan_phy *phy);
1c889f4d DES	538	/* Same semantics as for class_for_each_device */
1c889f4d DES	539	int wpan_phy_for_each(int (fn)(struct wpan_phy phy, void data), void data);
2bfb1070 DES	540
	541	static inline void wpan_phy_priv(struct wpan_phy phy)
	542	{
	543	BUG_ON(!phy);
	544	return &phy->priv;
	545	}
	546
	547	struct wpan_phy wpan_phy_find(const char str);
69d9ab96 DES	548
	549	static inline void wpan_phy_put(struct wpan_phy *phy)
	550	{
	551	put_device(&phy->dev);
	552	}
	553
2bfb1070 DES	554	static inline const char wpan_phy_name(struct wpan_phy phy)
	555	{
	556	return dev_name(&phy->dev);
	557	}
5ad60d36	558
5755cd4d MR	559	void ieee802154_configure_durations(struct wpan_phy *phy,
5755cd4d MR	560	unsigned int page, unsigned int channel);
781830c8	561
2e7ed75e MR	562	/**
	563	* cfg802154_device_is_associated - Checks whether we are associated to any device
	564	* @wpan_dev: the wpan device
	565	* @return: true if we are associated
	566	*/
	567	bool cfg802154_device_is_associated(struct wpan_dev *wpan_dev);
	568
	569	/**
	570	* cfg802154_device_is_parent - Checks if a device is our coordinator
	571	* @wpan_dev: the wpan device
	572	* @target: the expected parent
	573	* @return: true if @target is our coordinator
	574	*/
	575	bool cfg802154_device_is_parent(struct wpan_dev *wpan_dev,
	576	struct ieee802154_addr *target);
	577
	578	/**
	579	* cfg802154_device_is_child - Checks whether a device is associated to us
	580	* @wpan_dev: the wpan device
	581	* @target: the expected child
	582	* @return: the PAN device
	583	*/
	584	struct ieee802154_pan_device *
	585	cfg802154_device_is_child(struct wpan_dev *wpan_dev,
	586	struct ieee802154_addr *target);
	587
ce93b937 MR	588	/**
	589	* cfg802154_set_max_associations - Limit the number of future associations
	590	* @wpan_dev: the wpan device
	591	* @max: the maximum number of devices we accept to associate
23736995	592	* @return: the old maximum value
ce93b937	593	*/
23736995 MR	594	unsigned int cfg802154_set_max_associations(struct wpan_dev *wpan_dev,
23736995 MR	595	unsigned int max);
ce93b937	596
601f160b MR	597	/**
	598	* cfg802154_get_free_short_addr - Get a free address among the known devices
	599	* @wpan_dev: the wpan device
	600	* @return: a random short address expectedly unused on our PAN
	601	*/
	602	__le16 cfg802154_get_free_short_addr(struct wpan_dev *wpan_dev);
	603
5ad60d36	604	#endif /* __NET_CFG802154_H */