[mirror_ubuntu-bionic-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/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);

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 flags;
	u8 seq;
	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;
}

#define MAC_CB_FLAG_TYPEMASK		((1 << 3) - 1)

#define MAC_CB_FLAG_ACKREQ		(1 << 3)
#define MAC_CB_FLAG_SECEN		(1 << 4)

static inline bool mac_cb_is_ackreq(struct sk_buff *skb)
{
	return mac_cb(skb)->flags & MAC_CB_FLAG_ACKREQ;
}

static inline bool mac_cb_is_secen(struct sk_buff *skb)
{
	return mac_cb(skb)->flags & MAC_CB_FLAG_SECEN;
}

static inline int mac_cb_type(struct sk_buff *skb)
{
	return mac_cb(skb)->flags & MAC_CB_FLAG_TYPEMASK;
}

#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 wpan_phy;
/*
 * 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);

	/* 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
1cd829c8	30	#include <net/af_ieee802154.h>
94b4f6c2 PB	31	#include <linux/netdevice.h>
	32	#include <linux/skbuff.h>
	33
	34	struct ieee802154_sechdr {
	35	#if defined(__LITTLE_ENDIAN_BITFIELD)
	36	u8 level:3,
	37	key_id_mode:2,
	38	reserved:3;
	39	#elif defined(__BIG_ENDIAN_BITFIELD)
	40	u8 reserved:3,
	41	key_id_mode:2,
	42	level:3;
	43	#else
	44	#error "Please fix <asm/byteorder.h>"
	45	#endif
	46	u8 key_id;
	47	__le32 frame_counter;
	48	union {
	49	__le32 short_src;
	50	__le64 extended_src;
	51	};
	52	};
1cd829c8	53
46ef0eb3 PB	54	struct ieee802154_addr {
	55	u8 mode;
	56	__le16 pan_id;
	57	union {
	58	__le16 short_addr;
	59	__le64 extended_addr;
	60	};
	61	};
	62
94b4f6c2 PB	63	struct ieee802154_hdr_fc {
	64	#if defined(__LITTLE_ENDIAN_BITFIELD)
	65	u16 type:3,
	66	security_enabled:1,
	67	frame_pending:1,
	68	ack_request:1,
	69	intra_pan:1,
	70	reserved:3,
	71	dest_addr_mode:2,
	72	version:2,
	73	source_addr_mode:2;
	74	#elif defined(__BIG_ENDIAN_BITFIELD)
	75	u16 reserved:1,
	76	intra_pan:1,
	77	ack_request:1,
	78	frame_pending:1,
	79	security_enabled:1,
	80	type:3,
	81	source_addr_mode:2,
	82	version:2,
	83	dest_addr_mode:2,
	84	reserved2:2;
	85	#else
	86	#error "Please fix <asm/byteorder.h>"
	87	#endif
	88	};
	89
	90	struct ieee802154_hdr {
	91	struct ieee802154_hdr_fc fc;
	92	u8 seq;
	93	struct ieee802154_addr source;
	94	struct ieee802154_addr dest;
	95	struct ieee802154_sechdr sec;
	96	};
	97
	98	/* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
	99	* the contents of hdr will be, and the actual value of those bits in
	100	* hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
	101	* version, if SECEN is set.
	102	*/
	103	int ieee802154_hdr_push(struct sk_buff skb, const struct ieee802154_hdr hdr);
	104
	105	/* pulls the entire 802.15.4 header off of the skb, including the security
	106	* header, and performs pan id decompression
	107	*/
	108	int ieee802154_hdr_pull(struct sk_buff skb, struct ieee802154_hdr hdr);
	109
	110	/* parses the frame control, sequence number of address fields in a given skb
	111	* and stores them into hdr, performing pan id decompression and length checks
	112	* to be suitable for use in header_ops.parse
	113	*/
	114	int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
	115	struct ieee802154_hdr *hdr);
	116
	117	static inline int ieee802154_hdr_length(struct sk_buff *skb)
	118	{
	119	struct ieee802154_hdr hdr;
	120	int len = ieee802154_hdr_pull(skb, &hdr);
	121
	122	if (len > 0)
	123	skb_push(skb, len);
	124
	125	return len;
	126	}
127
46ef0eb3 PB	128	static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
	129	const struct ieee802154_addr *a2)
	130	{
	131	if (a1->pan_id != a2->pan_id \|\| a1->mode != a2->mode)
	132	return false;
	133
	134	if ((a1->mode == IEEE802154_ADDR_LONG &&
	135	a1->extended_addr != a2->extended_addr) \|\|
	136	(a1->mode == IEEE802154_ADDR_SHORT &&
	137	a1->short_addr != a2->short_addr))
	138	return false;
	139
	140	return true;
	141	}
	142
	143	static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
	144	{
	145	u64 temp;
	146
	147	memcpy(&temp, raw, IEEE802154_ADDR_LEN);
	148	return (__force __le64)swab64(temp);
	149	}
	150
	151	static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
	152	{
	153	u64 temp = swab64((__force u64)addr);
	154
	155	memcpy(raw, &temp, IEEE802154_ADDR_LEN);
	156	}
	157
	158	static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
	159	const struct ieee802154_addr_sa *sa)
	160	{
	161	a->mode = sa->addr_type;
	162	a->pan_id = cpu_to_le16(sa->pan_id);
	163
	164	switch (a->mode) {
	165	case IEEE802154_ADDR_SHORT:
	166	a->short_addr = cpu_to_le16(sa->short_addr);
	167	break;
	168	case IEEE802154_ADDR_LONG:
	169	a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
	170	break;
	171	}
	172	}
	173
	174	static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
	175	const struct ieee802154_addr *a)
	176	{
	177	sa->addr_type = a->mode;
	178	sa->pan_id = le16_to_cpu(a->pan_id);
	179
	180	switch (a->mode) {
	181	case IEEE802154_ADDR_SHORT:
	182	sa->short_addr = le16_to_cpu(a->short_addr);
	183	break;
	184	case IEEE802154_ADDR_LONG:
	185	ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
	186	break;
	187	}
	188	}
	189
9ec76716 SL	190	/*
	191	* A control block of skb passed between the ARPHRD_IEEE802154 device
	192	* and other stack parts.
	193	*/
	194	struct ieee802154_mac_cb {
	195	u8 lqi;
9ec76716 SL	196	u8 flags;
9ec76716 SL	197	u8 seq;
ae531b94 PB	198	struct ieee802154_addr source;
ae531b94 PB	199	struct ieee802154_addr dest;
9ec76716 SL	200	};
	201
	202	static inline struct ieee802154_mac_cb mac_cb(struct sk_buff skb)
	203	{
	204	return (struct ieee802154_mac_cb *)skb->cb;
	205	}
	206
	207	#define MAC_CB_FLAG_TYPEMASK ((1 << 3) - 1)
	208
	209	#define MAC_CB_FLAG_ACKREQ (1 << 3)
	210	#define MAC_CB_FLAG_SECEN (1 << 4)
9ec76716	211
e6278d92	212	static inline bool mac_cb_is_ackreq(struct sk_buff *skb)
9ec76716 SL	213	{
	214	return mac_cb(skb)->flags & MAC_CB_FLAG_ACKREQ;
	215	}
	216
e6278d92	217	static inline bool mac_cb_is_secen(struct sk_buff *skb)
9ec76716 SL	218	{
	219	return mac_cb(skb)->flags & MAC_CB_FLAG_SECEN;
	220	}
9ec76716 SL	221
	222	static inline int mac_cb_type(struct sk_buff *skb)
	223	{
	224	return mac_cb(skb)->flags & MAC_CB_FLAG_TYPEMASK;
	225	}
	226
	227	#define IEEE802154_MAC_SCAN_ED 0
	228	#define IEEE802154_MAC_SCAN_ACTIVE 1
	229	#define IEEE802154_MAC_SCAN_PASSIVE 2
	230	#define IEEE802154_MAC_SCAN_ORPHAN 3
	231
42723448	232	struct wpan_phy;
9ec76716 SL	233	/*
9ec76716 SL	234	* This should be located at net_device->ml_priv
42723448 DES	235	*
	236	* get_phy should increment the reference counting on returned phy.
	237	* Use wpan_wpy_put to put that reference.
9ec76716 SL	238	*/
9ec76716 SL	239	struct ieee802154_mlme_ops {
56aa091d WA	240	/* The following fields are optional (can be NULL). */
56aa091d WA	241
9ec76716	242	int (assoc_req)(struct net_device dev,
ae531b94	243	struct ieee802154_addr *addr,
16eea493	244	u8 channel, u8 page, u8 cap);
9ec76716	245	int (assoc_resp)(struct net_device dev,
ae531b94	246	struct ieee802154_addr *addr,
b70ab2e8	247	__le16 short_addr, u8 status);
9ec76716	248	int (disassoc_req)(struct net_device dev,
ae531b94	249	struct ieee802154_addr *addr,
9ec76716 SL	250	u8 reason);
9ec76716 SL	251	int (start_req)(struct net_device dev,
ae531b94	252	struct ieee802154_addr *addr,
16eea493	253	u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
9ec76716 SL	254	u8 pan_coord, u8 blx, u8 coord_realign);
9ec76716 SL	255	int (scan_req)(struct net_device dev,
16eea493	256	u8 type, u32 channels, u8 page, u8 duration);
9ec76716	257
56aa091d WA	258	/* The fields below are required. */
56aa091d WA	259
42723448 DES	260	struct wpan_phy (get_phy)(const struct net_device *dev);
42723448 DES	261
9ec76716 SL	262	/*
	263	* FIXME: these should become the part of PIB/MIB interface.
	264	* However we still don't have IB interface of any kind
	265	*/
b70ab2e8 PB	266	__le16 (get_pan_id)(const struct net_device dev);
b70ab2e8 PB	267	__le16 (get_short_addr)(const struct net_device dev);
a9966b58	268	u8 (get_dsn)(const struct net_device dev);
9ec76716 SL	269	};
9ec76716 SL	270
74a02fcf	271	/* The IEEE 802.15.4 standard defines 2 type of the devices:
	272	* - FFD - full functionality device
	273	* - RFD - reduce functionality device
	274	*
	275	* So 2 sets of mlme operations are needed
	276	*/
	277	struct ieee802154_reduced_mlme_ops {
	278	struct wpan_phy (get_phy)(const struct net_device *dev);
	279	};
	280
	281	static inline struct ieee802154_mlme_ops *
	282	ieee802154_mlme_ops(const struct net_device *dev)
9ec76716 SL	283	{
	284	return dev->ml_priv;
	285	}
	286
74a02fcf	287	static inline struct ieee802154_reduced_mlme_ops *
	288	ieee802154_reduced_mlme_ops(const struct net_device *dev)
	289	{
	290	return dev->ml_priv;
	291	}
9ec76716	292
74a02fcf	293	#endif