[mirror_ubuntu-bionic-kernel.git] / include / net / cfg802154.h

/*
 * Copyright (C) 2007, 2008, 2009 Siemens AG
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * 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/mutex.h>
#include <linux/bug.h>

#include <net/nl802154.h>

struct wpan_phy;
struct wpan_phy_cca;

#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);
#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;
}

/**
 * @WPAN_PHY_FLAG_TRANSMIT_POWER: 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.
 */
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),
};

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;

	u32 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 usec */
	u8 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;

	char priv[0] __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);
}

struct ieee802154_addr {
	u8 mode;
	__le16 pan_id;
	union {
		__le16 short_addr;
		__le64 extended_addr;
	};
};

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;

	bool promiscuous_mode;

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

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

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);
}

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);
}

#endif /* __NET_CFG802154_H */
Commit	Line	Data
2bfb1070 DES	1	/*
	2	* Copyright (C) 2007, 2008, 2009 Siemens AG
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
2bfb1070 DES	13	* Written by:
	14	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
	15	*/
	16
5ad60d36 AA	17	#ifndef __NET_CFG802154_H
5ad60d36 AA	18	#define __NET_CFG802154_H
2bfb1070	19
cb41c8dd	20	#include <linux/ieee802154.h>
2bfb1070 DES	21	#include <linux/netdevice.h>
2bfb1070 DES	22	#include <linux/mutex.h>
187f1882	23	#include <linux/bug.h>
2bfb1070	24
f3ea5e44 AA	25	#include <net/nl802154.h>
f3ea5e44 AA	26
a5dd1d72	27	struct wpan_phy;
ba2a9506	28	struct wpan_phy_cca;
a5dd1d72	29
a26c5fd7 AA	30	#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
	31	struct ieee802154_llsec_device_key;
	32	struct ieee802154_llsec_seclevel;
	33	struct ieee802154_llsec_params;
	34	struct ieee802154_llsec_device;
	35	struct ieee802154_llsec_table;
	36	struct ieee802154_llsec_key_id;
	37	struct ieee802154_llsec_key;
	38	#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
	39
a5dd1d72	40	struct cfg802154_ops {
4a9a816a AA	41	struct net_device * (add_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
4a9a816a AA	42	const char *name,
5b4a1039	43	unsigned char name_assign_type,
4a9a816a	44	int type);
9d30a8cf AA	45	void (del_virtual_intf_deprecated)(struct wpan_phy wpan_phy,
9d30a8cf AA	46	struct net_device *dev);
a6cb869b VB	47	int (suspend)(struct wpan_phy wpan_phy);
a6cb869b VB	48	int (resume)(struct wpan_phy wpan_phy);
f3ea5e44 AA	49	int (add_virtual_intf)(struct wpan_phy wpan_phy,
f3ea5e44 AA	50	const char *name,
5b4a1039	51	unsigned char name_assign_type,
0e57547e AA	52	enum nl802154_iftype type,
0e57547e AA	53	__le64 extended_addr);
b821ecd4 AA	54	int (del_virtual_intf)(struct wpan_phy wpan_phy,
b821ecd4 AA	55	struct wpan_dev *wpan_dev);
ab0bd561	56	int (set_channel)(struct wpan_phy wpan_phy, u8 page, u8 channel);
ba2a9506 AA	57	int (set_cca_mode)(struct wpan_phy wpan_phy,
ba2a9506 AA	58	const struct wpan_phy_cca *cca);
b69644c1	59	int (set_cca_ed_level)(struct wpan_phy wpan_phy, s32 ed_level);
0f999b09	60	int (set_tx_power)(struct wpan_phy wpan_phy, s32 power);
702bf371	61	int (set_pan_id)(struct wpan_phy wpan_phy,
ee7b9053	62	struct wpan_dev *wpan_dev, __le16 pan_id);
9830c62a	63	int (set_short_addr)(struct wpan_phy wpan_phy,
ee7b9053	64	struct wpan_dev *wpan_dev, __le16 short_addr);
656a999e AA	65	int (set_backoff_exponent)(struct wpan_phy wpan_phy,
	66	struct wpan_dev *wpan_dev, u8 min_be,
	67	u8 max_be);
a01ba765 AA	68	int (set_max_csma_backoffs)(struct wpan_phy wpan_phy,
	69	struct wpan_dev *wpan_dev,
	70	u8 max_csma_backoffs);
17a3a46b AA	71	int (set_max_frame_retries)(struct wpan_phy wpan_phy,
	72	struct wpan_dev *wpan_dev,
	73	s8 max_frame_retries);
c8937a1d AA	74	int (set_lbt_mode)(struct wpan_phy wpan_phy,
c8937a1d AA	75	struct wpan_dev *wpan_dev, bool mode);
c91208d8 AA	76	int (set_ackreq_default)(struct wpan_phy wpan_phy,
c91208d8 AA	77	struct wpan_dev *wpan_dev, bool ackreq);
a26c5fd7 AA	78	#ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
	79	void (get_llsec_table)(struct wpan_phy wpan_phy,
	80	struct wpan_dev *wpan_dev,
	81	struct ieee802154_llsec_table **table);
	82	void (lock_llsec_table)(struct wpan_phy wpan_phy,
	83	struct wpan_dev *wpan_dev);
	84	void (unlock_llsec_table)(struct wpan_phy wpan_phy,
	85	struct wpan_dev *wpan_dev);
	86	/* TODO remove locking/get table callbacks, this is part of the
	87	* nl802154 interface and should be accessible from ieee802154 layer.
	88	*/
	89	int (get_llsec_params)(struct wpan_phy wpan_phy,
	90	struct wpan_dev *wpan_dev,
	91	struct ieee802154_llsec_params *params);
	92	int (set_llsec_params)(struct wpan_phy wpan_phy,
	93	struct wpan_dev *wpan_dev,
	94	const struct ieee802154_llsec_params *params,
	95	int changed);
	96	int (add_llsec_key)(struct wpan_phy wpan_phy,
	97	struct wpan_dev *wpan_dev,
	98	const struct ieee802154_llsec_key_id *id,
	99	const struct ieee802154_llsec_key *key);
	100	int (del_llsec_key)(struct wpan_phy wpan_phy,
	101	struct wpan_dev *wpan_dev,
	102	const struct ieee802154_llsec_key_id *id);
	103	int (add_seclevel)(struct wpan_phy wpan_phy,
	104	struct wpan_dev *wpan_dev,
	105	const struct ieee802154_llsec_seclevel *sl);
	106	int (del_seclevel)(struct wpan_phy wpan_phy,
	107	struct wpan_dev *wpan_dev,
	108	const struct ieee802154_llsec_seclevel *sl);
	109	int (add_device)(struct wpan_phy wpan_phy,
	110	struct wpan_dev *wpan_dev,
	111	const struct ieee802154_llsec_device *dev);
	112	int (del_device)(struct wpan_phy wpan_phy,
	113	struct wpan_dev *wpan_dev, __le64 extended_addr);
	114	int (add_devkey)(struct wpan_phy wpan_phy,
	115	struct wpan_dev *wpan_dev,
	116	__le64 extended_addr,
	117	const struct ieee802154_llsec_device_key *key);
	118	int (del_devkey)(struct wpan_phy wpan_phy,
	119	struct wpan_dev *wpan_dev,
	120	__le64 extended_addr,
	121	const struct ieee802154_llsec_device_key *key);
	122	#endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
a5dd1d72 AA	123	};
a5dd1d72 AA	124
fea3318d AA	125	static inline bool
	126	wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
	127	{
	128	switch (st) {
	129	case NL802154_SUPPORTED_BOOL_TRUE:
	130	return b;
	131	case NL802154_SUPPORTED_BOOL_FALSE:
	132	return !b;
	133	case NL802154_SUPPORTED_BOOL_BOTH:
	134	return true;
	135	default:
	136	WARN_ON(1);
	137	}
	138
	139	return false;
	140	}
	141
72f655e4	142	struct wpan_phy_supported {
fea3318d	143	u32 channels[IEEE802154_MAX_PAGE + 1],
65318680	144	cca_modes, cca_opts, iftypes;
fea3318d AA	145	enum nl802154_supported_bool_states lbt;
	146	u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
	147	min_csma_backoffs, max_csma_backoffs;
	148	s8 min_frame_retries, max_frame_retries;
	149	size_t tx_powers_size, cca_ed_levels_size;
	150	const s32 tx_powers, cca_ed_levels;
72f655e4 AA	151	};
72f655e4 AA	152
7fe9a388 AA	153	struct wpan_phy_cca {
	154	enum nl802154_cca_modes mode;
	155	enum nl802154_cca_opts opt;
	156	};
	157
791021bf AA	158	static inline bool
	159	wpan_phy_cca_cmp(const struct wpan_phy_cca a, const struct wpan_phy_cca b)
	160	{
	161	if (a->mode != b->mode)
	162	return false;
	163
	164	if (a->mode == NL802154_CCA_ENERGY_CARRIER)
	165	return a->opt == b->opt;
	166
	167	return true;
	168	}
	169
edea8f7c AA	170	/**
	171	* @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
	172	* transmit power setting.
	173	* @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
	174	* level setting.
	175	* @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
	176	* setting.
	177	*/
	178	enum wpan_phy_flags {
	179	WPAN_PHY_FLAG_TXPOWER = BIT(1),
	180	WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2),
	181	WPAN_PHY_FLAG_CCA_MODE = BIT(3),
	182	};
	183
2bfb1070	184	struct wpan_phy {
6322d50d AA	185	/* If multiple wpan_phys are registered and you're handed e.g.
	186	* a regular netdev with assigned ieee802154_ptr, you won't
	187	* know whether it points to a wpan_phy your driver has registered
	188	* or not. Assign this to something global to your driver to
	189	* help determine whether you own this wpan_phy or not.
	190	*/
	191	const void *privid;
	192
edea8f7c AA	193	u32 flags;
edea8f7c AA	194
2bfb1070	195	/*
9b2777d6	196	* This is a PIB according to 802.15.4-2011.
2bfb1070 DES	197	* We do not provide timing-related variables, as they
	198	* aren't used outside of driver
	199	*/
	200	u8 current_channel;
	201	u8 current_page;
72f655e4	202	struct wpan_phy_supported supported;
e2eb173a	203	/* current transmit_power in mBm */
1a19cb68	204	s32 transmit_power;
7fe9a388	205	struct wpan_phy_cca cca;
dee56d14 AA	206
dee56d14 AA	207	__le64 perm_extended_addr;
2bfb1070	208
32b23550	209	/* current cca ed threshold in mBm */
6ca00197	210	s32 cca_ed_level;
84dda3c6	211
61f2dcba AA	212	/* PHY depended MAC PIB values */
	213
	214	/* 802.15.4 acronym: Tdsym in usec */
	215	u8 symbol_duration;
	216	/* lifs and sifs periods timing */
	217	u16 lifs_period;
	218	u16 sifs_period;
	219
2bfb1070	220	struct device dev;
2bfb1070	221
66e5c267 AA	222	/* the network namespace this phy lives in currently */
	223	possible_net_t _net;
	224
4896167d	225	char priv[0] __aligned(NETDEV_ALIGN);
2bfb1070 DES	226	};
2bfb1070 DES	227
66e5c267 AA	228	static inline struct net wpan_phy_net(struct wpan_phy wpan_phy)
	229	{
	230	return read_pnet(&wpan_phy->_net);
	231	}
	232
	233	static inline void wpan_phy_net_set(struct wpan_phy wpan_phy, struct net net)
	234	{
	235	write_pnet(&wpan_phy->_net, net);
	236	}
	237
838b83d6 AA	238	struct ieee802154_addr {
	239	u8 mode;
	240	__le16 pan_id;
	241	union {
	242	__le16 short_addr;
	243	__le64 extended_addr;
	244	};
	245	};
	246
a26c5fd7 AA	247	struct ieee802154_llsec_key_id {
	248	u8 mode;
	249	u8 id;
	250	union {
	251	struct ieee802154_addr device_addr;
	252	__le32 short_source;
	253	__le64 extended_source;
	254	};
	255	};
	256
	257	#define IEEE802154_LLSEC_KEY_SIZE 16
	258
	259	struct ieee802154_llsec_key {
	260	u8 frame_types;
	261	u32 cmd_frame_ids;
	262	/* TODO replace with NL802154_KEY_SIZE */
	263	u8 key[IEEE802154_LLSEC_KEY_SIZE];
	264	};
	265
	266	struct ieee802154_llsec_key_entry {
	267	struct list_head list;
	268
	269	struct ieee802154_llsec_key_id id;
	270	struct ieee802154_llsec_key *key;
	271	};
	272
	273	struct ieee802154_llsec_params {
	274	bool enabled;
	275
	276	__be32 frame_counter;
	277	u8 out_level;
	278	struct ieee802154_llsec_key_id out_key;
	279
	280	__le64 default_key_source;
	281
	282	__le16 pan_id;
	283	__le64 hwaddr;
	284	__le64 coord_hwaddr;
	285	__le16 coord_shortaddr;
	286	};
	287
	288	struct ieee802154_llsec_table {
	289	struct list_head keys;
	290	struct list_head devices;
	291	struct list_head security_levels;
	292	};
	293
	294	struct ieee802154_llsec_seclevel {
	295	struct list_head list;
	296
	297	u8 frame_type;
	298	u8 cmd_frame_id;
	299	bool device_override;
	300	u32 sec_levels;
	301	};
	302
	303	struct ieee802154_llsec_device {
	304	struct list_head list;
	305
	306	__le16 pan_id;
	307	__le16 short_addr;
	308	__le64 hwaddr;
	309	u32 frame_counter;
	310	bool seclevel_exempt;
311
312	u8 key_mode;
313	struct list_head keys;
314	};
315
316	struct ieee802154_llsec_device_key {
317	struct list_head list;
318
319	struct ieee802154_llsec_key_id key_id;
320	u32 frame_counter;
321	};
322
838b83d6 AA	323	struct wpan_dev_header_ops {
	324	/* TODO create callback currently assumes ieee802154_mac_cb inside
	325	* skb->cb. This should be changed to give these information as
	326	* parameter.
	327	*/
	328	int (create)(struct sk_buff skb, struct net_device *dev,
	329	const struct ieee802154_addr *daddr,
	330	const struct ieee802154_addr *saddr,
	331	unsigned int len);
	332	};
	333
d5ae67ba AA	334	struct wpan_dev {
d5ae67ba AA	335	struct wpan_phy *wpan_phy;
190ac1ca	336	int iftype;
863e88f2	337
fcf39e6e AA	338	/* the remainder of this struct should be private to cfg802154 */
	339	struct list_head list;
	340	struct net_device *netdev;
	341
838b83d6 AA	342	const struct wpan_dev_header_ops *header_ops;
838b83d6 AA	343
51e0e5d8 AA	344	/* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */
	345	struct net_device *lowpan_dev;
	346
fcf39e6e AA	347	u32 identifier;
fcf39e6e AA	348
863e88f2 AA	349	/* MAC PIB */
	350	__le16 pan_id;
	351	__le16 short_addr;
	352	__le64 extended_addr;
	353
	354	/* MAC BSN field */
344f8c11	355	atomic_t bsn;
863e88f2	356	/* MAC DSN field */
344f8c11	357	atomic_t dsn;
863e88f2 AA	358
	359	u8 min_be;
	360	u8 max_be;
	361	u8 csma_retries;
	362	s8 frame_retries;
	363
	364	bool lbt;
	365
	366	bool promiscuous_mode;
c91208d8 AA	367
	368	/* fallback for acknowledgment bit setting */
	369	bool ackreq;
d5ae67ba AA	370	};
d5ae67ba AA	371
42723448 DES	372	#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
42723448 DES	373
838b83d6 AA	374	static inline int
	375	wpan_dev_hard_header(struct sk_buff skb, struct net_device dev,
	376	const struct ieee802154_addr *daddr,
	377	const struct ieee802154_addr *saddr,
	378	unsigned int len)
	379	{
	380	struct wpan_dev *wpan_dev = dev->ieee802154_ptr;
	381
	382	return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len);
	383	}
	384
a5dd1d72	385	struct wpan_phy *
f601379f	386	wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
e9cf356c DES	387	static inline void wpan_phy_set_dev(struct wpan_phy phy, struct device dev)
	388	{
	389	phy->dev.parent = dev;
	390	}
e72740d0	391
e9cf356c	392	int wpan_phy_register(struct wpan_phy *phy);
2bfb1070 DES	393	void wpan_phy_unregister(struct wpan_phy *phy);
2bfb1070 DES	394	void wpan_phy_free(struct wpan_phy *phy);
1c889f4d DES	395	/* Same semantics as for class_for_each_device */
1c889f4d DES	396	int wpan_phy_for_each(int (fn)(struct wpan_phy phy, void data), void data);
2bfb1070 DES	397
	398	static inline void wpan_phy_priv(struct wpan_phy phy)
	399	{
	400	BUG_ON(!phy);
	401	return &phy->priv;
	402	}
	403
	404	struct wpan_phy wpan_phy_find(const char str);
69d9ab96 DES	405
	406	static inline void wpan_phy_put(struct wpan_phy *phy)
	407	{
	408	put_device(&phy->dev);
	409	}
	410
2bfb1070 DES	411	static inline const char wpan_phy_name(struct wpan_phy phy)
	412	{
	413	return dev_name(&phy->dev);
	414	}
5ad60d36 AA	415
5ad60d36 AA	416	#endif /* __NET_CFG802154_H */