[mirror_ubuntu-eoan-kernel.git] / include / net / ieee802154_netdev.h

/*
 * An interface between IEEE802.15.4 device and rest of the kernel.
 *
 * Copyright (C) 2007-2012 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.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Written by:
 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
 * Maxim Osipov <maxim.osipov@siemens.com>
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
 */

#ifndef IEEE802154_NETDEVICE_H
#define IEEE802154_NETDEVICE_H

#include <net/ieee802154.h>
#include <net/af_ieee802154.h>
#include <linux/netdevice.h>
#include <linux/skbuff.h>

struct ieee802154_sechdr {
#if defined(__LITTLE_ENDIAN_BITFIELD)
	u8 level:3,
	   key_id_mode:2,
	   reserved:3;
#elif defined(__BIG_ENDIAN_BITFIELD)
	u8 reserved:3,
	   key_id_mode:2,
	   level:3;
#else
#error	"Please fix <asm/byteorder.h>"
#endif
	u8 key_id;
	__le32 frame_counter;
	union {
		__le32 short_src;
		__le64 extended_src;
	};
};

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

struct ieee802154_hdr_fc {
#if defined(__LITTLE_ENDIAN_BITFIELD)
	u16 type:3,
	    security_enabled:1,
	    frame_pending:1,
	    ack_request:1,
	    intra_pan:1,
	    reserved:3,
	    dest_addr_mode:2,
	    version:2,
	    source_addr_mode:2;
#elif defined(__BIG_ENDIAN_BITFIELD)
	u16 reserved:1,
	    intra_pan:1,
	    ack_request:1,
	    frame_pending:1,
	    security_enabled:1,
	    type:3,
	    source_addr_mode:2,
	    version:2,
	    dest_addr_mode:2,
	    reserved2:2;
#else
#error	"Please fix <asm/byteorder.h>"
#endif
};

struct ieee802154_hdr {
	struct ieee802154_hdr_fc fc;
	u8 seq;
	struct ieee802154_addr source;
	struct ieee802154_addr dest;
	struct ieee802154_sechdr sec;
};

/* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
 * the contents of hdr will be, and the actual value of those bits in
 * hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
 * version, if SECEN is set.
 */
int ieee802154_hdr_push(struct sk_buff *skb, const struct ieee802154_hdr *hdr);

/* pulls the entire 802.15.4 header off of the skb, including the security
 * header, and performs pan id decompression
 */
int ieee802154_hdr_pull(struct sk_buff *skb, struct ieee802154_hdr *hdr);

/* parses the frame control, sequence number of address fields in a given skb
 * and stores them into hdr, performing pan id decompression and length checks
 * to be suitable for use in header_ops.parse
 */
int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
			      struct ieee802154_hdr *hdr);

/* parses the full 802.15.4 header a given skb and stores them into hdr,
 * performing pan id decompression and length checks to be suitable for use in
 * header_ops.parse
 */
int ieee802154_hdr_peek(const struct sk_buff *skb, struct ieee802154_hdr *hdr);

int ieee802154_max_payload(const struct ieee802154_hdr *hdr);

static inline int
ieee802154_sechdr_authtag_len(const struct ieee802154_sechdr *sec)
{
	switch (sec->level) {
	case IEEE802154_SCF_SECLEVEL_MIC32:
	case IEEE802154_SCF_SECLEVEL_ENC_MIC32:
		return 4;
	case IEEE802154_SCF_SECLEVEL_MIC64:
	case IEEE802154_SCF_SECLEVEL_ENC_MIC64:
		return 8;
	case IEEE802154_SCF_SECLEVEL_MIC128:
	case IEEE802154_SCF_SECLEVEL_ENC_MIC128:
		return 16;
	case IEEE802154_SCF_SECLEVEL_NONE:
	case IEEE802154_SCF_SECLEVEL_ENC:
	default:
		return 0;
	}
}

static inline int ieee802154_hdr_length(struct sk_buff *skb)
{
	struct ieee802154_hdr hdr;
	int len = ieee802154_hdr_pull(skb, &hdr);

	if (len > 0)
		skb_push(skb, len);

	return len;
}

static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
					 const struct ieee802154_addr *a2)
{
	if (a1->pan_id != a2->pan_id || a1->mode != a2->mode)
		return false;

	if ((a1->mode == IEEE802154_ADDR_LONG &&
	     a1->extended_addr != a2->extended_addr) ||
	    (a1->mode == IEEE802154_ADDR_SHORT &&
	     a1->short_addr != a2->short_addr))
		return false;

	return true;
}

static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
{
	u64 temp;

	memcpy(&temp, raw, IEEE802154_ADDR_LEN);
	return (__force __le64)swab64(temp);
}

static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
{
	u64 temp = swab64((__force u64)addr);

	memcpy(raw, &temp, IEEE802154_ADDR_LEN);
}

static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
					   const struct ieee802154_addr_sa *sa)
{
	a->mode = sa->addr_type;
	a->pan_id = cpu_to_le16(sa->pan_id);

	switch (a->mode) {
	case IEEE802154_ADDR_SHORT:
		a->short_addr = cpu_to_le16(sa->short_addr);
		break;
	case IEEE802154_ADDR_LONG:
		a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
		break;
	}
}

static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
					 const struct ieee802154_addr *a)
{
	sa->addr_type = a->mode;
	sa->pan_id = le16_to_cpu(a->pan_id);

	switch (a->mode) {
	case IEEE802154_ADDR_SHORT:
		sa->short_addr = le16_to_cpu(a->short_addr);
		break;
	case IEEE802154_ADDR_LONG:
		ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
		break;
	}
}

/*
 * A control block of skb passed between the ARPHRD_IEEE802154 device
 * and other stack parts.
 */
struct ieee802154_mac_cb {
	u8 lqi;
	u8 type;
	bool ackreq;
	bool secen;
	bool secen_override;
	u8 seclevel;
	bool seclevel_override;
	struct ieee802154_addr source;
	struct ieee802154_addr dest;
};

static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
{
	return (struct ieee802154_mac_cb *)skb->cb;
}

static inline struct ieee802154_mac_cb *mac_cb_init(struct sk_buff *skb)
{
	BUILD_BUG_ON(sizeof(struct ieee802154_mac_cb) > sizeof(skb->cb));

	memset(skb->cb, 0, sizeof(struct ieee802154_mac_cb));
	return mac_cb(skb);
}

#define IEEE802154_LLSEC_KEY_SIZE 16

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

struct ieee802154_llsec_key {
	u8 frame_types;
	u32 cmd_frame_ids;
	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_device_key {
	struct list_head list;

	struct ieee802154_llsec_key_id key_id;
	u32 frame_counter;
};

enum {
	IEEE802154_LLSEC_DEVKEY_IGNORE,
	IEEE802154_LLSEC_DEVKEY_RESTRICT,

	__IEEE802154_LLSEC_DEVKEY_MAX,
};

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_seclevel {
	struct list_head list;

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

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

#define IEEE802154_MAC_SCAN_ED		0
#define IEEE802154_MAC_SCAN_ACTIVE	1
#define IEEE802154_MAC_SCAN_PASSIVE	2
#define IEEE802154_MAC_SCAN_ORPHAN	3

struct ieee802154_mac_params {
	s8 transmit_power;
	u8 min_be;
	u8 max_be;
	u8 csma_retries;
	s8 frame_retries;

	bool lbt;
	u8 cca_mode;
	s32 cca_ed_level;
};

struct wpan_phy;

enum {
	IEEE802154_LLSEC_PARAM_ENABLED = 1 << 0,
	IEEE802154_LLSEC_PARAM_FRAME_COUNTER = 1 << 1,
	IEEE802154_LLSEC_PARAM_OUT_LEVEL = 1 << 2,
	IEEE802154_LLSEC_PARAM_OUT_KEY = 1 << 3,
	IEEE802154_LLSEC_PARAM_KEY_SOURCE = 1 << 4,
	IEEE802154_LLSEC_PARAM_PAN_ID = 1 << 5,
	IEEE802154_LLSEC_PARAM_HWADDR = 1 << 6,
	IEEE802154_LLSEC_PARAM_COORD_HWADDR = 1 << 7,
	IEEE802154_LLSEC_PARAM_COORD_SHORTADDR = 1 << 8,
};

struct ieee802154_llsec_ops {
	int (*get_params)(struct net_device *dev,
			  struct ieee802154_llsec_params *params);
	int (*set_params)(struct net_device *dev,
			  const struct ieee802154_llsec_params *params,
			  int changed);

	int (*add_key)(struct net_device *dev,
		       const struct ieee802154_llsec_key_id *id,
		       const struct ieee802154_llsec_key *key);
	int (*del_key)(struct net_device *dev,
		       const struct ieee802154_llsec_key_id *id);

	int (*add_dev)(struct net_device *dev,
		       const struct ieee802154_llsec_device *llsec_dev);
	int (*del_dev)(struct net_device *dev, __le64 dev_addr);

	int (*add_devkey)(struct net_device *dev,
			  __le64 device_addr,
			  const struct ieee802154_llsec_device_key *key);
	int (*del_devkey)(struct net_device *dev,
			  __le64 device_addr,
			  const struct ieee802154_llsec_device_key *key);

	int (*add_seclevel)(struct net_device *dev,
			    const struct ieee802154_llsec_seclevel *sl);
	int (*del_seclevel)(struct net_device *dev,
			    const struct ieee802154_llsec_seclevel *sl);

	void (*lock_table)(struct net_device *dev);
	void (*get_table)(struct net_device *dev,
			  struct ieee802154_llsec_table **t);
	void (*unlock_table)(struct net_device *dev);
};
/*
 * This should be located at net_device->ml_priv
 *
 * get_phy should increment the reference counting on returned phy.
 * Use wpan_wpy_put to put that reference.
 */
struct ieee802154_mlme_ops {
	/* The following fields are optional (can be NULL). */

	int (*assoc_req)(struct net_device *dev,
			struct ieee802154_addr *addr,
			u8 channel, u8 page, u8 cap);
	int (*assoc_resp)(struct net_device *dev,
			struct ieee802154_addr *addr,
			__le16 short_addr, u8 status);
	int (*disassoc_req)(struct net_device *dev,
			struct ieee802154_addr *addr,
			u8 reason);
	int (*start_req)(struct net_device *dev,
			struct ieee802154_addr *addr,
			u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
			u8 pan_coord, u8 blx, u8 coord_realign);
	int (*scan_req)(struct net_device *dev,
			u8 type, u32 channels, u8 page, u8 duration);

	int (*set_mac_params)(struct net_device *dev,
			      const struct ieee802154_mac_params *params);
	void (*get_mac_params)(struct net_device *dev,
			       struct ieee802154_mac_params *params);

	struct ieee802154_llsec_ops *llsec;

	/* The fields below are required. */

	struct wpan_phy *(*get_phy)(const struct net_device *dev);

	/*
	 * FIXME: these should become the part of PIB/MIB interface.
	 * However we still don't have IB interface of any kind
	 */
	__le16 (*get_pan_id)(const struct net_device *dev);
	__le16 (*get_short_addr)(const struct net_device *dev);
	u8 (*get_dsn)(const struct net_device *dev);
};

/* The IEEE 802.15.4 standard defines 2 type of the devices:
 * - FFD - full functionality device
 * - RFD - reduce functionality device
 *
 * So 2 sets of mlme operations are needed
 */
struct ieee802154_reduced_mlme_ops {
	struct wpan_phy *(*get_phy)(const struct net_device *dev);
};

static inline struct ieee802154_mlme_ops *
ieee802154_mlme_ops(const struct net_device *dev)
{
	return dev->ml_priv;
}

static inline struct ieee802154_reduced_mlme_ops *
ieee802154_reduced_mlme_ops(const struct net_device *dev)
{
	return dev->ml_priv;
}

#endif
Commit	Line	Data
9ec76716 SL	1	/*
	2	* An interface between IEEE802.15.4 device and rest of the kernel.
	3	*
74a02fcf	4	* Copyright (C) 2007-2012 Siemens AG
9ec76716 SL	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License version 2
	8	* as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License along
	16	* with this program; if not, write to the Free Software Foundation, Inc.,
	17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	18	*
	19	* Written by:
	20	* Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
	21	* Maxim Gorbachyov <maxim.gorbachev@siemens.com>
	22	* Maxim Osipov <maxim.osipov@siemens.com>
	23	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
74a02fcf	24	* Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
9ec76716 SL	25	*/
	26
	27	#ifndef IEEE802154_NETDEVICE_H
	28	#define IEEE802154_NETDEVICE_H
	29
c3a6114f	30	#include <net/ieee802154.h>
1cd829c8	31	#include <net/af_ieee802154.h>
94b4f6c2 PB	32	#include <linux/netdevice.h>
	33	#include <linux/skbuff.h>
	34
	35	struct ieee802154_sechdr {
	36	#if defined(__LITTLE_ENDIAN_BITFIELD)
	37	u8 level:3,
	38	key_id_mode:2,
	39	reserved:3;
	40	#elif defined(__BIG_ENDIAN_BITFIELD)
	41	u8 reserved:3,
	42	key_id_mode:2,
	43	level:3;
	44	#else
	45	#error "Please fix <asm/byteorder.h>"
	46	#endif
	47	u8 key_id;
	48	__le32 frame_counter;
	49	union {
	50	__le32 short_src;
	51	__le64 extended_src;
	52	};
	53	};
1cd829c8	54
46ef0eb3 PB	55	struct ieee802154_addr {
	56	u8 mode;
	57	__le16 pan_id;
	58	union {
	59	__le16 short_addr;
	60	__le64 extended_addr;
	61	};
	62	};
	63
94b4f6c2 PB	64	struct ieee802154_hdr_fc {
	65	#if defined(__LITTLE_ENDIAN_BITFIELD)
	66	u16 type:3,
	67	security_enabled:1,
	68	frame_pending:1,
	69	ack_request:1,
	70	intra_pan:1,
	71	reserved:3,
	72	dest_addr_mode:2,
	73	version:2,
	74	source_addr_mode:2;
	75	#elif defined(__BIG_ENDIAN_BITFIELD)
	76	u16 reserved:1,
	77	intra_pan:1,
	78	ack_request:1,
	79	frame_pending:1,
	80	security_enabled:1,
	81	type:3,
	82	source_addr_mode:2,
	83	version:2,
	84	dest_addr_mode:2,
	85	reserved2:2;
	86	#else
	87	#error "Please fix <asm/byteorder.h>"
	88	#endif
	89	};
	90
	91	struct ieee802154_hdr {
	92	struct ieee802154_hdr_fc fc;
	93	u8 seq;
	94	struct ieee802154_addr source;
	95	struct ieee802154_addr dest;
	96	struct ieee802154_sechdr sec;
	97	};
	98
	99	/* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
	100	* the contents of hdr will be, and the actual value of those bits in
	101	* hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
	102	* version, if SECEN is set.
	103	*/
	104	int ieee802154_hdr_push(struct sk_buff skb, const struct ieee802154_hdr hdr);
	105
	106	/* pulls the entire 802.15.4 header off of the skb, including the security
	107	* header, and performs pan id decompression
	108	*/
	109	int ieee802154_hdr_pull(struct sk_buff skb, struct ieee802154_hdr hdr);
	110
	111	/* parses the frame control, sequence number of address fields in a given skb
	112	* and stores them into hdr, performing pan id decompression and length checks
	113	* to be suitable for use in header_ops.parse
	114	*/
	115	int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
	116	struct ieee802154_hdr *hdr);
	117
c3a6114f PB	118	/* parses the full 802.15.4 header a given skb and stores them into hdr,
	119	* performing pan id decompression and length checks to be suitable for use in
	120	* header_ops.parse
	121	*/
	122	int ieee802154_hdr_peek(const struct sk_buff skb, struct ieee802154_hdr hdr);
	123
	124	int ieee802154_max_payload(const struct ieee802154_hdr *hdr);
	125
	126	static inline int
	127	ieee802154_sechdr_authtag_len(const struct ieee802154_sechdr *sec)
	128	{
	129	switch (sec->level) {
	130	case IEEE802154_SCF_SECLEVEL_MIC32:
	131	case IEEE802154_SCF_SECLEVEL_ENC_MIC32:
	132	return 4;
	133	case IEEE802154_SCF_SECLEVEL_MIC64:
	134	case IEEE802154_SCF_SECLEVEL_ENC_MIC64:
	135	return 8;
	136	case IEEE802154_SCF_SECLEVEL_MIC128:
	137	case IEEE802154_SCF_SECLEVEL_ENC_MIC128:
	138	return 16;
	139	case IEEE802154_SCF_SECLEVEL_NONE:
	140	case IEEE802154_SCF_SECLEVEL_ENC:
	141	default:
	142	return 0;
	143	}
	144	}
	145
94b4f6c2 PB	146	static inline int ieee802154_hdr_length(struct sk_buff *skb)
	147	{
	148	struct ieee802154_hdr hdr;
	149	int len = ieee802154_hdr_pull(skb, &hdr);
	150
	151	if (len > 0)
	152	skb_push(skb, len);
	153
	154	return len;
	155	}
	156
46ef0eb3 PB	157	static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
	158	const struct ieee802154_addr *a2)
	159	{
	160	if (a1->pan_id != a2->pan_id \|\| a1->mode != a2->mode)
	161	return false;
	162
	163	if ((a1->mode == IEEE802154_ADDR_LONG &&
	164	a1->extended_addr != a2->extended_addr) \|\|
	165	(a1->mode == IEEE802154_ADDR_SHORT &&
	166	a1->short_addr != a2->short_addr))
	167	return false;
	168
	169	return true;
	170	}
	171
	172	static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
	173	{
	174	u64 temp;
	175
	176	memcpy(&temp, raw, IEEE802154_ADDR_LEN);
	177	return (__force __le64)swab64(temp);
	178	}
	179
	180	static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
	181	{
	182	u64 temp = swab64((__force u64)addr);
	183
	184	memcpy(raw, &temp, IEEE802154_ADDR_LEN);
	185	}
	186
	187	static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
	188	const struct ieee802154_addr_sa *sa)
	189	{
	190	a->mode = sa->addr_type;
	191	a->pan_id = cpu_to_le16(sa->pan_id);
	192
	193	switch (a->mode) {
	194	case IEEE802154_ADDR_SHORT:
	195	a->short_addr = cpu_to_le16(sa->short_addr);
	196	break;
	197	case IEEE802154_ADDR_LONG:
	198	a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
	199	break;
	200	}
	201	}
	202
	203	static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
	204	const struct ieee802154_addr *a)
	205	{
	206	sa->addr_type = a->mode;
	207	sa->pan_id = le16_to_cpu(a->pan_id);
	208
	209	switch (a->mode) {
	210	case IEEE802154_ADDR_SHORT:
	211	sa->short_addr = le16_to_cpu(a->short_addr);
	212	break;
	213	case IEEE802154_ADDR_LONG:
	214	ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
	215	break;
	216	}
	217	}
	218
9ec76716 SL	219	/*
	220	* A control block of skb passed between the ARPHRD_IEEE802154 device
	221	* and other stack parts.
	222	*/
	223	struct ieee802154_mac_cb {
	224	u8 lqi;
32edc40a PB	225	u8 type;
	226	bool ackreq;
	227	bool secen;
f30be4d5 PB	228	bool secen_override;
	229	u8 seclevel;
	230	bool seclevel_override;
ae531b94 PB	231	struct ieee802154_addr source;
ae531b94 PB	232	struct ieee802154_addr dest;
9ec76716 SL	233	};
	234
	235	static inline struct ieee802154_mac_cb mac_cb(struct sk_buff skb)
	236	{
	237	return (struct ieee802154_mac_cb *)skb->cb;
	238	}
	239
32edc40a	240	static inline struct ieee802154_mac_cb mac_cb_init(struct sk_buff skb)
9ec76716	241	{
32edc40a	242	BUILD_BUG_ON(sizeof(struct ieee802154_mac_cb) > sizeof(skb->cb));
9ec76716	243
32edc40a PB	244	memset(skb->cb, 0, sizeof(struct ieee802154_mac_cb));
32edc40a PB	245	return mac_cb(skb);
9ec76716 SL	246	}
9ec76716 SL	247
dc20759f PB	248	#define IEEE802154_LLSEC_KEY_SIZE 16
	249
	250	struct ieee802154_llsec_key_id {
	251	u8 mode;
	252	u8 id;
	253	union {
	254	struct ieee802154_addr device_addr;
	255	__le32 short_source;
	256	__le64 extended_source;
	257	};
	258	};
	259
	260	struct ieee802154_llsec_key {
	261	u8 frame_types;
	262	u32 cmd_frame_ids;
	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_device_key {
	274	struct list_head list;
	275
	276	struct ieee802154_llsec_key_id key_id;
	277	u32 frame_counter;
	278	};
	279
	280	enum {
	281	IEEE802154_LLSEC_DEVKEY_IGNORE,
	282	IEEE802154_LLSEC_DEVKEY_RESTRICT,
	283
	284	__IEEE802154_LLSEC_DEVKEY_MAX,
	285	};
	286
	287	struct ieee802154_llsec_device {
	288	struct list_head list;
	289
	290	__le16 pan_id;
	291	__le16 short_addr;
	292	__le64 hwaddr;
	293	u32 frame_counter;
	294	bool seclevel_exempt;
	295
	296	u8 key_mode;
	297	struct list_head keys;
	298	};
	299
	300	struct ieee802154_llsec_seclevel {
	301	struct list_head list;
	302
	303	u8 frame_type;
	304	u8 cmd_frame_id;
	305	bool device_override;
	306	u32 sec_levels;
	307	};
	308
	309	struct ieee802154_llsec_params {
	310	bool enabled;
	311
312	__be32 frame_counter;
313	u8 out_level;
314	struct ieee802154_llsec_key_id out_key;
315
316	__le64 default_key_source;
317
318	__le16 pan_id;
319	__le64 hwaddr;
320	__le64 coord_hwaddr;
321	__le16 coord_shortaddr;
322	};
323
324	struct ieee802154_llsec_table {
325	struct list_head keys;
326	struct list_head devices;
327	struct list_head security_levels;
328	};
329
9ec76716 SL	330	#define IEEE802154_MAC_SCAN_ED 0
	331	#define IEEE802154_MAC_SCAN_ACTIVE 1
	332	#define IEEE802154_MAC_SCAN_PASSIVE 2
	333	#define IEEE802154_MAC_SCAN_ORPHAN 3
	334
e462ded6 PB	335	struct ieee802154_mac_params {
	336	s8 transmit_power;
	337	u8 min_be;
	338	u8 max_be;
	339	u8 csma_retries;
	340	s8 frame_retries;
	341
	342	bool lbt;
	343	u8 cca_mode;
	344	s32 cca_ed_level;
	345	};
	346
42723448	347	struct wpan_phy;
dc20759f PB	348
	349	enum {
	350	IEEE802154_LLSEC_PARAM_ENABLED = 1 << 0,
	351	IEEE802154_LLSEC_PARAM_FRAME_COUNTER = 1 << 1,
	352	IEEE802154_LLSEC_PARAM_OUT_LEVEL = 1 << 2,
	353	IEEE802154_LLSEC_PARAM_OUT_KEY = 1 << 3,
	354	IEEE802154_LLSEC_PARAM_KEY_SOURCE = 1 << 4,
	355	IEEE802154_LLSEC_PARAM_PAN_ID = 1 << 5,
	356	IEEE802154_LLSEC_PARAM_HWADDR = 1 << 6,
	357	IEEE802154_LLSEC_PARAM_COORD_HWADDR = 1 << 7,
	358	IEEE802154_LLSEC_PARAM_COORD_SHORTADDR = 1 << 8,
	359	};
	360
29e02374 PB	361	struct ieee802154_llsec_ops {
	362	int (get_params)(struct net_device dev,
	363	struct ieee802154_llsec_params *params);
	364	int (set_params)(struct net_device dev,
	365	const struct ieee802154_llsec_params *params,
	366	int changed);
	367
	368	int (add_key)(struct net_device dev,
	369	const struct ieee802154_llsec_key_id *id,
	370	const struct ieee802154_llsec_key *key);
	371	int (del_key)(struct net_device dev,
	372	const struct ieee802154_llsec_key_id *id);
	373
	374	int (add_dev)(struct net_device dev,
	375	const struct ieee802154_llsec_device *llsec_dev);
	376	int (del_dev)(struct net_device dev, __le64 dev_addr);
	377
	378	int (add_devkey)(struct net_device dev,
	379	__le64 device_addr,
	380	const struct ieee802154_llsec_device_key *key);
	381	int (del_devkey)(struct net_device dev,
	382	__le64 device_addr,
	383	const struct ieee802154_llsec_device_key *key);
	384
	385	int (add_seclevel)(struct net_device dev,
	386	const struct ieee802154_llsec_seclevel *sl);
	387	int (del_seclevel)(struct net_device dev,
	388	const struct ieee802154_llsec_seclevel *sl);
	389
	390	void (lock_table)(struct net_device dev);
	391	void (get_table)(struct net_device dev,
	392	struct ieee802154_llsec_table **t);
	393	void (unlock_table)(struct net_device dev);
	394	};
9ec76716 SL	395	/*
9ec76716 SL	396	* This should be located at net_device->ml_priv
42723448 DES	397	*
	398	* get_phy should increment the reference counting on returned phy.
	399	* Use wpan_wpy_put to put that reference.
9ec76716 SL	400	*/
9ec76716 SL	401	struct ieee802154_mlme_ops {
56aa091d WA	402	/* The following fields are optional (can be NULL). */
56aa091d WA	403
9ec76716	404	int (assoc_req)(struct net_device dev,
ae531b94	405	struct ieee802154_addr *addr,
16eea493	406	u8 channel, u8 page, u8 cap);
9ec76716	407	int (assoc_resp)(struct net_device dev,
ae531b94	408	struct ieee802154_addr *addr,
b70ab2e8	409	__le16 short_addr, u8 status);
9ec76716	410	int (disassoc_req)(struct net_device dev,
ae531b94	411	struct ieee802154_addr *addr,
9ec76716 SL	412	u8 reason);
9ec76716 SL	413	int (start_req)(struct net_device dev,
ae531b94	414	struct ieee802154_addr *addr,
16eea493	415	u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
9ec76716 SL	416	u8 pan_coord, u8 blx, u8 coord_realign);
9ec76716 SL	417	int (scan_req)(struct net_device dev,
16eea493	418	u8 type, u32 channels, u8 page, u8 duration);
9ec76716	419
e462ded6 PB	420	int (set_mac_params)(struct net_device dev,
	421	const struct ieee802154_mac_params *params);
	422	void (get_mac_params)(struct net_device dev,
	423	struct ieee802154_mac_params *params);
	424
29e02374 PB	425	struct ieee802154_llsec_ops *llsec;
29e02374 PB	426
56aa091d WA	427	/* The fields below are required. */
56aa091d WA	428
42723448 DES	429	struct wpan_phy (get_phy)(const struct net_device *dev);
42723448 DES	430
9ec76716 SL	431	/*
	432	* FIXME: these should become the part of PIB/MIB interface.
	433	* However we still don't have IB interface of any kind
	434	*/
b70ab2e8 PB	435	__le16 (get_pan_id)(const struct net_device dev);
b70ab2e8 PB	436	__le16 (get_short_addr)(const struct net_device dev);
a9966b58	437	u8 (get_dsn)(const struct net_device dev);
9ec76716 SL	438	};
9ec76716 SL	439
74a02fcf	440	/* The IEEE 802.15.4 standard defines 2 type of the devices:
	441	* - FFD - full functionality device
	442	* - RFD - reduce functionality device
	443	*
	444	* So 2 sets of mlme operations are needed
	445	*/
	446	struct ieee802154_reduced_mlme_ops {
	447	struct wpan_phy (get_phy)(const struct net_device *dev);
	448	};
	449
	450	static inline struct ieee802154_mlme_ops *
	451	ieee802154_mlme_ops(const struct net_device *dev)
9ec76716 SL	452	{
	453	return dev->ml_priv;
	454	}
	455
74a02fcf	456	static inline struct ieee802154_reduced_mlme_ops *
	457	ieee802154_reduced_mlme_ops(const struct net_device *dev)
	458	{
	459	return dev->ml_priv;
	460	}
9ec76716	461
74a02fcf	462	#endif