[linux-block.git] / include / linux / ieee802154.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * IEEE802.15.4-2003 specification
 *
 * Copyright (C) 2007, 2008 Siemens AG
 *
 * 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 LINUX_IEEE802154_H
#define LINUX_IEEE802154_H

#include <linux/types.h>
#include <linux/random.h>

#define IEEE802154_MTU			127
#define IEEE802154_ACK_PSDU_LEN		5
#define IEEE802154_MIN_PSDU_LEN		9
#define IEEE802154_FCS_LEN		2
#define IEEE802154_MAX_AUTH_TAG_LEN	16
#define IEEE802154_FC_LEN		2
#define IEEE802154_SEQ_LEN		1

/*  General MAC frame format:
 *  2 bytes: Frame Control
 *  1 byte:  Sequence Number
 * 20 bytes: Addressing fields
 * 14 bytes: Auxiliary Security Header
 */
#define IEEE802154_MAX_HEADER_LEN	(2 + 1 + 20 + 14)
#define IEEE802154_MIN_HEADER_LEN	(IEEE802154_ACK_PSDU_LEN - \
					 IEEE802154_FCS_LEN)

#define IEEE802154_PAN_ID_BROADCAST	0xffff
#define IEEE802154_ADDR_SHORT_BROADCAST	0xffff
#define IEEE802154_ADDR_SHORT_UNSPEC	0xfffe

#define IEEE802154_EXTENDED_ADDR_LEN	8
#define IEEE802154_SHORT_ADDR_LEN	2
#define IEEE802154_PAN_ID_LEN		2

/* Duration in superframe order */
#define IEEE802154_MAX_SCAN_DURATION	14
#define IEEE802154_ACTIVE_SCAN_DURATION	15
/* Superframe duration in slots */
#define IEEE802154_SUPERFRAME_PERIOD	16
/* Various periods expressed in symbols */
#define IEEE802154_SLOT_PERIOD		60
#define IEEE802154_LIFS_PERIOD		40
#define IEEE802154_SIFS_PERIOD		12
#define IEEE802154_MAX_SIFS_FRAME_SIZE	18

#define IEEE802154_MAX_CHANNEL		26
#define IEEE802154_MAX_PAGE		31

#define IEEE802154_FC_TYPE_BEACON	0x0	/* Frame is beacon */
#define	IEEE802154_FC_TYPE_DATA		0x1	/* Frame is data */
#define IEEE802154_FC_TYPE_ACK		0x2	/* Frame is acknowledgment */
#define IEEE802154_FC_TYPE_MAC_CMD	0x3	/* Frame is MAC command */

#define IEEE802154_FC_TYPE_SHIFT		0
#define IEEE802154_FC_TYPE_MASK		((1 << 3) - 1)
#define IEEE802154_FC_TYPE(x)		((x & IEEE802154_FC_TYPE_MASK) >> IEEE802154_FC_TYPE_SHIFT)
#define IEEE802154_FC_SET_TYPE(v, x)	do {	\
	v = (((v) & ~IEEE802154_FC_TYPE_MASK) | \
	    (((x) << IEEE802154_FC_TYPE_SHIFT) & IEEE802154_FC_TYPE_MASK)); \
	} while (0)

#define IEEE802154_FC_SECEN_SHIFT	3
#define IEEE802154_FC_SECEN		(1 << IEEE802154_FC_SECEN_SHIFT)
#define IEEE802154_FC_FRPEND_SHIFT	4
#define IEEE802154_FC_FRPEND		(1 << IEEE802154_FC_FRPEND_SHIFT)
#define IEEE802154_FC_ACK_REQ_SHIFT	5
#define IEEE802154_FC_ACK_REQ		(1 << IEEE802154_FC_ACK_REQ_SHIFT)
#define IEEE802154_FC_INTRA_PAN_SHIFT	6
#define IEEE802154_FC_INTRA_PAN		(1 << IEEE802154_FC_INTRA_PAN_SHIFT)

#define IEEE802154_FC_SAMODE_SHIFT	14
#define IEEE802154_FC_SAMODE_MASK	(3 << IEEE802154_FC_SAMODE_SHIFT)
#define IEEE802154_FC_DAMODE_SHIFT	10
#define IEEE802154_FC_DAMODE_MASK	(3 << IEEE802154_FC_DAMODE_SHIFT)

#define IEEE802154_FC_VERSION_SHIFT	12
#define IEEE802154_FC_VERSION_MASK	(3 << IEEE802154_FC_VERSION_SHIFT)
#define IEEE802154_FC_VERSION(x)	((x & IEEE802154_FC_VERSION_MASK) >> IEEE802154_FC_VERSION_SHIFT)

#define IEEE802154_FC_SAMODE(x)		\
	(((x) & IEEE802154_FC_SAMODE_MASK) >> IEEE802154_FC_SAMODE_SHIFT)

#define IEEE802154_FC_DAMODE(x)		\
	(((x) & IEEE802154_FC_DAMODE_MASK) >> IEEE802154_FC_DAMODE_SHIFT)

#define IEEE802154_SCF_SECLEVEL_MASK		7
#define IEEE802154_SCF_SECLEVEL_SHIFT		0
#define IEEE802154_SCF_SECLEVEL(x)		(x & IEEE802154_SCF_SECLEVEL_MASK)
#define IEEE802154_SCF_KEY_ID_MODE_SHIFT	3
#define IEEE802154_SCF_KEY_ID_MODE_MASK		(3 << IEEE802154_SCF_KEY_ID_MODE_SHIFT)
#define IEEE802154_SCF_KEY_ID_MODE(x)		\
	((x & IEEE802154_SCF_KEY_ID_MODE_MASK) >> IEEE802154_SCF_KEY_ID_MODE_SHIFT)

#define IEEE802154_SCF_KEY_IMPLICIT		0
#define IEEE802154_SCF_KEY_INDEX		1
#define IEEE802154_SCF_KEY_SHORT_INDEX		2
#define IEEE802154_SCF_KEY_HW_INDEX		3

#define IEEE802154_SCF_SECLEVEL_NONE		0
#define IEEE802154_SCF_SECLEVEL_MIC32		1
#define IEEE802154_SCF_SECLEVEL_MIC64		2
#define IEEE802154_SCF_SECLEVEL_MIC128		3
#define IEEE802154_SCF_SECLEVEL_ENC		4
#define IEEE802154_SCF_SECLEVEL_ENC_MIC32	5
#define IEEE802154_SCF_SECLEVEL_ENC_MIC64	6
#define IEEE802154_SCF_SECLEVEL_ENC_MIC128	7

/* MAC footer size */
#define IEEE802154_MFR_SIZE	2 /* 2 octets */

/* MAC's Command Frames Identifiers */
#define IEEE802154_CMD_ASSOCIATION_REQ		0x01
#define IEEE802154_CMD_ASSOCIATION_RESP		0x02
#define IEEE802154_CMD_DISASSOCIATION_NOTIFY	0x03
#define IEEE802154_CMD_DATA_REQ			0x04
#define IEEE802154_CMD_PANID_CONFLICT_NOTIFY	0x05
#define IEEE802154_CMD_ORPHAN_NOTIFY		0x06
#define IEEE802154_CMD_BEACON_REQ		0x07
#define IEEE802154_CMD_COORD_REALIGN_NOTIFY	0x08
#define IEEE802154_CMD_GTS_REQ			0x09

/*
 * The return values of MAC operations
 */
enum {
	/*
	 * The requested operation was completed successfully.
	 * For a transmission request, this value indicates
	 * a successful transmission.
	 */
	IEEE802154_SUCCESS = 0x0,
	/* The requested operation failed. */
	IEEE802154_MAC_ERROR = 0x1,
	/* The requested operation has been cancelled. */
	IEEE802154_CANCELLED = 0x2,
	/*
	 * Device is ready to poll the coordinator for data in a non beacon
	 * enabled PAN.
	 */
	IEEE802154_READY_FOR_POLL = 0x3,
	/* Wrong frame counter. */
	IEEE802154_COUNTER_ERROR = 0xdb,
	/*
	 * The frame does not conforms to the incoming key usage policy checking
	 * procedure.
	 */
	IEEE802154_IMPROPER_KEY_TYPE = 0xdc,
	/*
	 * The frame does not conforms to the incoming security level usage
	 * policy checking procedure.
	 */
	IEEE802154_IMPROPER_SECURITY_LEVEL = 0xdd,
	/* Secured frame received with an empty Frame Version field. */
	IEEE802154_UNSUPPORTED_LEGACY = 0xde,
	/*
	 * A secured frame is received or must be sent but security is not
	 * enabled in the device. Or, the Auxiliary Security Header has security
	 * level of zero in it.
	 */
	IEEE802154_UNSUPPORTED_SECURITY = 0xdf,
	/* The beacon was lost following a synchronization request. */
	IEEE802154_BEACON_LOST = 0xe0,
	/*
	 * A transmission could not take place due to activity on the
	 * channel, i.e., the CSMA-CA mechanism has failed.
	 */
	IEEE802154_CHANNEL_ACCESS_FAILURE = 0xe1,
	/* The GTS request has been denied by the PAN coordinator. */
	IEEE802154_DENIED = 0xe2,
	/* The attempt to disable the transceiver has failed. */
	IEEE802154_DISABLE_TRX_FAILURE = 0xe3,
	/*
	 * The received frame induces a failed security check according to
	 * the security suite.
	 */
	IEEE802154_FAILED_SECURITY_CHECK = 0xe4,
	/*
	 * The frame resulting from secure processing has a length that is
	 * greater than aMACMaxFrameSize.
	 */
	IEEE802154_FRAME_TOO_LONG = 0xe5,
	/*
	 * The requested GTS transmission failed because the specified GTS
	 * either did not have a transmit GTS direction or was not defined.
	 */
	IEEE802154_INVALID_GTS = 0xe6,
	/*
	 * A request to purge an MSDU from the transaction queue was made using
	 * an MSDU handle that was not found in the transaction table.
	 */
	IEEE802154_INVALID_HANDLE = 0xe7,
	/* A parameter in the primitive is out of the valid range.*/
	IEEE802154_INVALID_PARAMETER = 0xe8,
	/* No acknowledgment was received after aMaxFrameRetries. */
	IEEE802154_NO_ACK = 0xe9,
	/* A scan operation failed to find any network beacons.*/
	IEEE802154_NO_BEACON = 0xea,
	/* No response data were available following a request. */
	IEEE802154_NO_DATA = 0xeb,
	/* The operation failed because a short address was not allocated. */
	IEEE802154_NO_SHORT_ADDRESS = 0xec,
	/*
	 * A receiver enable request was unsuccessful because it could not be
	 * completed within the CAP.
	 */
	IEEE802154_OUT_OF_CAP = 0xed,
	/*
	 * A PAN identifier conflict has been detected and communicated to the
	 * PAN coordinator.
	 */
	IEEE802154_PAN_ID_CONFLICT = 0xee,
	/* A coordinator realignment command has been received. */
	IEEE802154_REALIGNMENT = 0xef,
	/* The transaction has expired and its information discarded. */
	IEEE802154_TRANSACTION_EXPIRED = 0xf0,
	/* There is no capacity to store the transaction. */
	IEEE802154_TRANSACTION_OVERFLOW = 0xf1,
	/*
	 * The transceiver was in the transmitter enabled state when the
	 * receiver was requested to be enabled.
	 */
	IEEE802154_TX_ACTIVE = 0xf2,
	/* The appropriate key is not available in the ACL. */
	IEEE802154_UNAVAILABLE_KEY = 0xf3,
	/*
	 * A SET/GET request was issued with the identifier of a PIB attribute
	 * that is not supported.
	 */
	IEEE802154_UNSUPPORTED_ATTRIBUTE = 0xf4,
	/* Missing source or destination address or address mode. */
	IEEE802154_INVALID_ADDRESS = 0xf5,
	/*
	 * MLME asked to turn the receiver on, but the on time duration is too
	 * big compared to the macBeaconOrder.
	 */
	IEEE802154_ON_TIME_TOO_LONG = 0xf6,
	/*
	 * MLME asaked to turn the receiver on, but the request was delayed for
	 * too long before getting processed.
	 */
	IEEE802154_PAST_TIME = 0xf7,
	/*
	 * The StartTime parameter is nonzero, and the MLME is not currently
	 * tracking the beacon of the coordinator through which it is
	 * associated.
	 */
	IEEE802154_TRACKING_OFF = 0xf8,
	/*
	 * The index inside the hierarchical values in PIBAttribute is out of
	 * range.
	 */
	IEEE802154_INVALID_INDEX = 0xf9,
	/*
	 * The number of PAN descriptors discovered during a scan has been
	 * reached.
	 */
	IEEE802154_LIMIT_REACHED = 0xfa,
	/*
	 * The PIBAttribute parameter specifies an attribute that is a read-only
	 * attribute.
	 */
	IEEE802154_READ_ONLY = 0xfb,
	/*
	 * A request to perform a scan operation failed because the MLME was
	 * in the process of performing a previously initiated scan operation.
	 */
	IEEE802154_SCAN_IN_PROGRESS = 0xfc,
	/* The outgoing superframe overlaps the incoming superframe. */
	IEEE802154_SUPERFRAME_OVERLAP = 0xfd,
	/* Any other error situation. */
	IEEE802154_SYSTEM_ERROR = 0xff,
};

/**
 * enum ieee802154_filtering_level - Filtering levels applicable to a PHY
 *
 * @IEEE802154_FILTERING_NONE: No filtering at all, what is received is
 *	forwarded to the softMAC
 * @IEEE802154_FILTERING_1_FCS: First filtering level, frames with an invalid
 *	FCS should be dropped
 * @IEEE802154_FILTERING_2_PROMISCUOUS: Second filtering level, promiscuous
 *	mode as described in the spec, identical in terms of filtering to the
 *	level one on PHY side, but at the MAC level the frame should be
 *	forwarded to the upper layer directly
 * @IEEE802154_FILTERING_3_SCAN: Third filtering level, scan related, where
 *	only beacons must be processed, all remaining traffic gets dropped
 * @IEEE802154_FILTERING_4_FRAME_FIELDS: Fourth filtering level actually
 *	enforcing the validity of the content of the frame with various checks
 */
enum ieee802154_filtering_level {
	IEEE802154_FILTERING_NONE,
	IEEE802154_FILTERING_1_FCS,
	IEEE802154_FILTERING_2_PROMISCUOUS,
	IEEE802154_FILTERING_3_SCAN,
	IEEE802154_FILTERING_4_FRAME_FIELDS,
};

/* frame control handling */
#define IEEE802154_FCTL_FTYPE		0x0003
#define IEEE802154_FCTL_ACKREQ		0x0020
#define IEEE802154_FCTL_SECEN		0x0004
#define IEEE802154_FCTL_INTRA_PAN	0x0040
#define IEEE802154_FCTL_DADDR		0x0c00
#define IEEE802154_FCTL_SADDR		0xc000

#define IEEE802154_FTYPE_DATA		0x0001

#define IEEE802154_FCTL_ADDR_NONE	0x0000
#define IEEE802154_FCTL_DADDR_SHORT	0x0800
#define IEEE802154_FCTL_DADDR_EXTENDED	0x0c00
#define IEEE802154_FCTL_SADDR_SHORT	0x8000
#define IEEE802154_FCTL_SADDR_EXTENDED	0xc000

/*
 * ieee802154_is_data - check if type is IEEE802154_FTYPE_DATA
 * @fc: frame control bytes in little-endian byteorder
 */
static inline int ieee802154_is_data(__le16 fc)
{
	return (fc & cpu_to_le16(IEEE802154_FCTL_FTYPE)) ==
		cpu_to_le16(IEEE802154_FTYPE_DATA);
}

/**
 * ieee802154_is_secen - check if Security bit is set
 * @fc: frame control bytes in little-endian byteorder
 */
static inline bool ieee802154_is_secen(__le16 fc)
{
	return fc & cpu_to_le16(IEEE802154_FCTL_SECEN);
}

/**
 * ieee802154_is_ackreq - check if acknowledgment request bit is set
 * @fc: frame control bytes in little-endian byteorder
 */
static inline bool ieee802154_is_ackreq(__le16 fc)
{
	return fc & cpu_to_le16(IEEE802154_FCTL_ACKREQ);
}

/**
 * ieee802154_is_intra_pan - check if intra pan id communication
 * @fc: frame control bytes in little-endian byteorder
 */
static inline bool ieee802154_is_intra_pan(__le16 fc)
{
	return fc & cpu_to_le16(IEEE802154_FCTL_INTRA_PAN);
}

/*
 * ieee802154_daddr_mode - get daddr mode from fc
 * @fc: frame control bytes in little-endian byteorder
 */
static inline __le16 ieee802154_daddr_mode(__le16 fc)
{
	return fc & cpu_to_le16(IEEE802154_FCTL_DADDR);
}

/*
 * ieee802154_saddr_mode - get saddr mode from fc
 * @fc: frame control bytes in little-endian byteorder
 */
static inline __le16 ieee802154_saddr_mode(__le16 fc)
{
	return fc & cpu_to_le16(IEEE802154_FCTL_SADDR);
}

/**
 * ieee802154_is_valid_psdu_len - check if psdu len is valid
 * available lengths:
 *	0-4	Reserved
 *	5	MPDU (Acknowledgment)
 *	6-8	Reserved
 *	9-127	MPDU
 *
 * @len: psdu len with (MHR + payload + MFR)
 */
static inline bool ieee802154_is_valid_psdu_len(u8 len)
{
	return (len == IEEE802154_ACK_PSDU_LEN ||
		(len >= IEEE802154_MIN_PSDU_LEN && len <= IEEE802154_MTU));
}

/**
 * ieee802154_is_valid_extended_unicast_addr - check if extended addr is valid
 * @addr: extended addr to check
 */
static inline bool ieee802154_is_valid_extended_unicast_addr(__le64 addr)
{
	/* Bail out if the address is all zero, or if the group
	 * address bit is set.
	 */
	return ((addr != cpu_to_le64(0x0000000000000000ULL)) &&
		!(addr & cpu_to_le64(0x0100000000000000ULL)));
}

/**
 * ieee802154_is_broadcast_short_addr - check if short addr is broadcast
 * @addr: short addr to check
 */
static inline bool ieee802154_is_broadcast_short_addr(__le16 addr)
{
	return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_BROADCAST));
}

/**
 * ieee802154_is_unspec_short_addr - check if short addr is unspecified
 * @addr: short addr to check
 */
static inline bool ieee802154_is_unspec_short_addr(__le16 addr)
{
	return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_UNSPEC));
}

/**
 * ieee802154_is_valid_src_short_addr - check if source short address is valid
 * @addr: short addr to check
 */
static inline bool ieee802154_is_valid_src_short_addr(__le16 addr)
{
	return !(ieee802154_is_broadcast_short_addr(addr) ||
		 ieee802154_is_unspec_short_addr(addr));
}

/**
 * ieee802154_random_extended_addr - generates a random extended address
 * @addr: extended addr pointer to place the random address
 */
static inline void ieee802154_random_extended_addr(__le64 *addr)
{
	get_random_bytes(addr, IEEE802154_EXTENDED_ADDR_LEN);

	/* clear the group bit, and set the locally administered bit */
	((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] &= ~0x01;
	((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] |= 0x02;
}

#endif /* LINUX_IEEE802154_H */
Commit	Line	Data
1802d0be	1	/* SPDX-License-Identifier: GPL-2.0-only */
9ec76716 SL	2	/*
	3	* IEEE802.15.4-2003 specification
	4	*
	5	* Copyright (C) 2007, 2008 Siemens AG
	6	*
9ec76716 SL	7	* Written by:
	8	* Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
	9	* Maxim Gorbachyov <maxim.gorbachev@siemens.com>
	10	* Maxim Osipov <maxim.osipov@siemens.com>
	11	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
719269af	12	* Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
9ec76716 SL	13	*/
9ec76716 SL	14
4ca24aca AA	15	#ifndef LINUX_IEEE802154_H
4ca24aca AA	16	#define LINUX_IEEE802154_H
9ec76716	17
fa491001	18	#include <linux/types.h>
35d5a374	19	#include <linux/random.h>
fa491001	20
719269af	21	#define IEEE802154_MTU 127
306f7aa1 AA	22	#define IEEE802154_ACK_PSDU_LEN 5
306f7aa1 AA	23	#define IEEE802154_MIN_PSDU_LEN 9
3f3c4bb5	24	#define IEEE802154_FCS_LEN 2
87a93e4e	25	#define IEEE802154_MAX_AUTH_TAG_LEN 16
9cc577dd AA	26	#define IEEE802154_FC_LEN 2
9cc577dd AA	27	#define IEEE802154_SEQ_LEN 1
87a93e4e AA	28
	29	/* General MAC frame format:
	30	* 2 bytes: Frame Control
	31	* 1 byte: Sequence Number
	32	* 20 bytes: Addressing fields
	33	* 14 bytes: Auxiliary Security Header
	34	*/
	35	#define IEEE802154_MAX_HEADER_LEN (2 + 1 + 20 + 14)
	36	#define IEEE802154_MIN_HEADER_LEN (IEEE802154_ACK_PSDU_LEN - \
	37	IEEE802154_FCS_LEN)
719269af	38
702bf371	39	#define IEEE802154_PAN_ID_BROADCAST 0xffff
9830c62a AA	40	#define IEEE802154_ADDR_SHORT_BROADCAST 0xffff
9830c62a AA	41	#define IEEE802154_ADDR_SHORT_UNSPEC 0xfffe
702bf371	42
1906bbbd	43	#define IEEE802154_EXTENDED_ADDR_LEN 8
118a5cf8	44	#define IEEE802154_SHORT_ADDR_LEN 2
19580cc1	45	#define IEEE802154_PAN_ID_LEN 2
1906bbbd	46
ed3557c9 MR	47	/* Duration in superframe order */
	48	#define IEEE802154_MAX_SCAN_DURATION 14
	49	#define IEEE802154_ACTIVE_SCAN_DURATION 15
57588c71 MR	50	/* Superframe duration in slots */
	51	#define IEEE802154_SUPERFRAME_PERIOD 16
	52	/* Various periods expressed in symbols */
	53	#define IEEE802154_SLOT_PERIOD 60
61f2dcba AA	54	#define IEEE802154_LIFS_PERIOD 40
61f2dcba AA	55	#define IEEE802154_SIFS_PERIOD 12
3f3c4bb5	56	#define IEEE802154_MAX_SIFS_FRAME_SIZE 18
61f2dcba	57
cb41c8dd AA	58	#define IEEE802154_MAX_CHANNEL 26
	59	#define IEEE802154_MAX_PAGE 31
	60
9ec76716 SL	61	#define IEEE802154_FC_TYPE_BEACON 0x0 /* Frame is beacon */
	62	#define IEEE802154_FC_TYPE_DATA 0x1 /* Frame is data */
	63	#define IEEE802154_FC_TYPE_ACK 0x2 /* Frame is acknowledgment */
	64	#define IEEE802154_FC_TYPE_MAC_CMD 0x3 /* Frame is MAC command */
	65
	66	#define IEEE802154_FC_TYPE_SHIFT 0
	67	#define IEEE802154_FC_TYPE_MASK ((1 << 3) - 1)
	68	#define IEEE802154_FC_TYPE(x) ((x & IEEE802154_FC_TYPE_MASK) >> IEEE802154_FC_TYPE_SHIFT)
	69	#define IEEE802154_FC_SET_TYPE(v, x) do { \
	70	v = (((v) & ~IEEE802154_FC_TYPE_MASK) \| \
	71	(((x) << IEEE802154_FC_TYPE_SHIFT) & IEEE802154_FC_TYPE_MASK)); \
	72	} while (0)
	73
94b4f6c2 PB	74	#define IEEE802154_FC_SECEN_SHIFT 3
	75	#define IEEE802154_FC_SECEN (1 << IEEE802154_FC_SECEN_SHIFT)
	76	#define IEEE802154_FC_FRPEND_SHIFT 4
	77	#define IEEE802154_FC_FRPEND (1 << IEEE802154_FC_FRPEND_SHIFT)
	78	#define IEEE802154_FC_ACK_REQ_SHIFT 5
	79	#define IEEE802154_FC_ACK_REQ (1 << IEEE802154_FC_ACK_REQ_SHIFT)
	80	#define IEEE802154_FC_INTRA_PAN_SHIFT 6
	81	#define IEEE802154_FC_INTRA_PAN (1 << IEEE802154_FC_INTRA_PAN_SHIFT)
9ec76716 SL	82
	83	#define IEEE802154_FC_SAMODE_SHIFT 14
	84	#define IEEE802154_FC_SAMODE_MASK (3 << IEEE802154_FC_SAMODE_SHIFT)
	85	#define IEEE802154_FC_DAMODE_SHIFT 10
	86	#define IEEE802154_FC_DAMODE_MASK (3 << IEEE802154_FC_DAMODE_SHIFT)
	87
94b4f6c2 PB	88	#define IEEE802154_FC_VERSION_SHIFT 12
	89	#define IEEE802154_FC_VERSION_MASK (3 << IEEE802154_FC_VERSION_SHIFT)
	90	#define IEEE802154_FC_VERSION(x) ((x & IEEE802154_FC_VERSION_MASK) >> IEEE802154_FC_VERSION_SHIFT)
	91
9ec76716 SL	92	#define IEEE802154_FC_SAMODE(x) \
	93	(((x) & IEEE802154_FC_SAMODE_MASK) >> IEEE802154_FC_SAMODE_SHIFT)
	94
	95	#define IEEE802154_FC_DAMODE(x) \
	96	(((x) & IEEE802154_FC_DAMODE_MASK) >> IEEE802154_FC_DAMODE_SHIFT)
	97
94b4f6c2 PB	98	#define IEEE802154_SCF_SECLEVEL_MASK 7
	99	#define IEEE802154_SCF_SECLEVEL_SHIFT 0
	100	#define IEEE802154_SCF_SECLEVEL(x) (x & IEEE802154_SCF_SECLEVEL_MASK)
	101	#define IEEE802154_SCF_KEY_ID_MODE_SHIFT 3
	102	#define IEEE802154_SCF_KEY_ID_MODE_MASK (3 << IEEE802154_SCF_KEY_ID_MODE_SHIFT)
	103	#define IEEE802154_SCF_KEY_ID_MODE(x) \
	104	((x & IEEE802154_SCF_KEY_ID_MODE_MASK) >> IEEE802154_SCF_KEY_ID_MODE_SHIFT)
	105
	106	#define IEEE802154_SCF_KEY_IMPLICIT 0
	107	#define IEEE802154_SCF_KEY_INDEX 1
	108	#define IEEE802154_SCF_KEY_SHORT_INDEX 2
	109	#define IEEE802154_SCF_KEY_HW_INDEX 3
9ec76716	110
c3a6114f PB	111	#define IEEE802154_SCF_SECLEVEL_NONE 0
	112	#define IEEE802154_SCF_SECLEVEL_MIC32 1
	113	#define IEEE802154_SCF_SECLEVEL_MIC64 2
	114	#define IEEE802154_SCF_SECLEVEL_MIC128 3
	115	#define IEEE802154_SCF_SECLEVEL_ENC 4
	116	#define IEEE802154_SCF_SECLEVEL_ENC_MIC32 5
	117	#define IEEE802154_SCF_SECLEVEL_ENC_MIC64 6
	118	#define IEEE802154_SCF_SECLEVEL_ENC_MIC128 7
	119
719269af	120	/* MAC footer size */
	121	#define IEEE802154_MFR_SIZE 2 /* 2 octets */
	122
9ec76716 SL	123	/* MAC's Command Frames Identifiers */
	124	#define IEEE802154_CMD_ASSOCIATION_REQ 0x01
	125	#define IEEE802154_CMD_ASSOCIATION_RESP 0x02
	126	#define IEEE802154_CMD_DISASSOCIATION_NOTIFY 0x03
	127	#define IEEE802154_CMD_DATA_REQ 0x04
	128	#define IEEE802154_CMD_PANID_CONFLICT_NOTIFY 0x05
	129	#define IEEE802154_CMD_ORPHAN_NOTIFY 0x06
	130	#define IEEE802154_CMD_BEACON_REQ 0x07
	131	#define IEEE802154_CMD_COORD_REALIGN_NOTIFY 0x08
	132	#define IEEE802154_CMD_GTS_REQ 0x09
	133
	134	/*
	135	* The return values of MAC operations
	136	*/
	137	enum {
	138	/*
	139	* The requested operation was completed successfully.
	140	* For a transmission request, this value indicates
	141	* a successful transmission.
	142	*/
	143	IEEE802154_SUCCESS = 0x0,
f06cfc23 MR	144	/* The requested operation failed. */
	145	IEEE802154_MAC_ERROR = 0x1,
	146	/* The requested operation has been cancelled. */
	147	IEEE802154_CANCELLED = 0x2,
	148	/*
	149	* Device is ready to poll the coordinator for data in a non beacon
	150	* enabled PAN.
	151	*/
	152	IEEE802154_READY_FOR_POLL = 0x3,
	153	/* Wrong frame counter. */
	154	IEEE802154_COUNTER_ERROR = 0xdb,
	155	/*
	156	* The frame does not conforms to the incoming key usage policy checking
	157	* procedure.
	158	*/
	159	IEEE802154_IMPROPER_KEY_TYPE = 0xdc,
	160	/*
	161	* The frame does not conforms to the incoming security level usage
	162	* policy checking procedure.
	163	*/
	164	IEEE802154_IMPROPER_SECURITY_LEVEL = 0xdd,
	165	/* Secured frame received with an empty Frame Version field. */
	166	IEEE802154_UNSUPPORTED_LEGACY = 0xde,
	167	/*
	168	* A secured frame is received or must be sent but security is not
	169	* enabled in the device. Or, the Auxiliary Security Header has security
	170	* level of zero in it.
	171	*/
	172	IEEE802154_UNSUPPORTED_SECURITY = 0xdf,
9ec76716	173	/* The beacon was lost following a synchronization request. */
5b0e5854	174	IEEE802154_BEACON_LOST = 0xe0,
9ec76716 SL	175	/*
	176	* A transmission could not take place due to activity on the
	177	* channel, i.e., the CSMA-CA mechanism has failed.
	178	*/
5b0e5854	179	IEEE802154_CHANNEL_ACCESS_FAILURE = 0xe1,
9ec76716	180	/* The GTS request has been denied by the PAN coordinator. */
5b0e5854	181	IEEE802154_DENIED = 0xe2,
9ec76716	182	/* The attempt to disable the transceiver has failed. */
5b0e5854	183	IEEE802154_DISABLE_TRX_FAILURE = 0xe3,
9ec76716 SL	184	/*
	185	* The received frame induces a failed security check according to
	186	* the security suite.
	187	*/
	188	IEEE802154_FAILED_SECURITY_CHECK = 0xe4,
	189	/*
	190	* The frame resulting from secure processing has a length that is
	191	* greater than aMACMaxFrameSize.
	192	*/
	193	IEEE802154_FRAME_TOO_LONG = 0xe5,
	194	/*
	195	* The requested GTS transmission failed because the specified GTS
	196	* either did not have a transmit GTS direction or was not defined.
	197	*/
	198	IEEE802154_INVALID_GTS = 0xe6,
	199	/*
	200	* A request to purge an MSDU from the transaction queue was made using
	201	* an MSDU handle that was not found in the transaction table.
	202	*/
	203	IEEE802154_INVALID_HANDLE = 0xe7,
	204	/* A parameter in the primitive is out of the valid range.*/
	205	IEEE802154_INVALID_PARAMETER = 0xe8,
	206	/* No acknowledgment was received after aMaxFrameRetries. */
	207	IEEE802154_NO_ACK = 0xe9,
	208	/* A scan operation failed to find any network beacons.*/
	209	IEEE802154_NO_BEACON = 0xea,
	210	/* No response data were available following a request. */
	211	IEEE802154_NO_DATA = 0xeb,
	212	/* The operation failed because a short address was not allocated. */
	213	IEEE802154_NO_SHORT_ADDRESS = 0xec,
	214	/*
	215	* A receiver enable request was unsuccessful because it could not be
	216	* completed within the CAP.
	217	*/
	218	IEEE802154_OUT_OF_CAP = 0xed,
	219	/*
	220	* A PAN identifier conflict has been detected and communicated to the
	221	* PAN coordinator.
	222	*/
5b0e5854	223	IEEE802154_PAN_ID_CONFLICT = 0xee,
9ec76716	224	/* A coordinator realignment command has been received. */
5b0e5854	225	IEEE802154_REALIGNMENT = 0xef,
9ec76716 SL	226	/* The transaction has expired and its information discarded. */
	227	IEEE802154_TRANSACTION_EXPIRED = 0xf0,
	228	/* There is no capacity to store the transaction. */
	229	IEEE802154_TRANSACTION_OVERFLOW = 0xf1,
	230	/*
	231	* The transceiver was in the transmitter enabled state when the
	232	* receiver was requested to be enabled.
	233	*/
	234	IEEE802154_TX_ACTIVE = 0xf2,
	235	/* The appropriate key is not available in the ACL. */
	236	IEEE802154_UNAVAILABLE_KEY = 0xf3,
	237	/*
	238	* A SET/GET request was issued with the identifier of a PIB attribute
	239	* that is not supported.
	240	*/
5b0e5854	241	IEEE802154_UNSUPPORTED_ATTRIBUTE = 0xf4,
f06cfc23 MR	242	/* Missing source or destination address or address mode. */
	243	IEEE802154_INVALID_ADDRESS = 0xf5,
	244	/*
	245	* MLME asked to turn the receiver on, but the on time duration is too
	246	* big compared to the macBeaconOrder.
	247	*/
	248	IEEE802154_ON_TIME_TOO_LONG = 0xf6,
	249	/*
	250	* MLME asaked to turn the receiver on, but the request was delayed for
	251	* too long before getting processed.
	252	*/
	253	IEEE802154_PAST_TIME = 0xf7,
	254	/*
	255	* The StartTime parameter is nonzero, and the MLME is not currently
	256	* tracking the beacon of the coordinator through which it is
	257	* associated.
	258	*/
	259	IEEE802154_TRACKING_OFF = 0xf8,
	260	/*
	261	* The index inside the hierarchical values in PIBAttribute is out of
	262	* range.
	263	*/
	264	IEEE802154_INVALID_INDEX = 0xf9,
	265	/*
	266	* The number of PAN descriptors discovered during a scan has been
	267	* reached.
	268	*/
	269	IEEE802154_LIMIT_REACHED = 0xfa,
	270	/*
	271	* The PIBAttribute parameter specifies an attribute that is a read-only
	272	* attribute.
	273	*/
	274	IEEE802154_READ_ONLY = 0xfb,
9ec76716 SL	275	/*
	276	* A request to perform a scan operation failed because the MLME was
	277	* in the process of performing a previously initiated scan operation.
	278	*/
	279	IEEE802154_SCAN_IN_PROGRESS = 0xfc,
f06cfc23 MR	280	/* The outgoing superframe overlaps the incoming superframe. */
	281	IEEE802154_SUPERFRAME_OVERLAP = 0xfd,
	282	/* Any other error situation. */
	283	IEEE802154_SYSTEM_ERROR = 0xff,
9ec76716 SL	284	};
9ec76716 SL	285
a6a6163b MR	286	/**
	287	* enum ieee802154_filtering_level - Filtering levels applicable to a PHY
	288	*
	289	* @IEEE802154_FILTERING_NONE: No filtering at all, what is received is
	290	* forwarded to the softMAC
	291	* @IEEE802154_FILTERING_1_FCS: First filtering level, frames with an invalid
	292	* FCS should be dropped
	293	* @IEEE802154_FILTERING_2_PROMISCUOUS: Second filtering level, promiscuous
	294	* mode as described in the spec, identical in terms of filtering to the
	295	* level one on PHY side, but at the MAC level the frame should be
	296	* forwarded to the upper layer directly
	297	* @IEEE802154_FILTERING_3_SCAN: Third filtering level, scan related, where
	298	* only beacons must be processed, all remaining traffic gets dropped
	299	* @IEEE802154_FILTERING_4_FRAME_FIELDS: Fourth filtering level actually
	300	* enforcing the validity of the content of the frame with various checks
	301	*/
	302	enum ieee802154_filtering_level {
	303	IEEE802154_FILTERING_NONE,
	304	IEEE802154_FILTERING_1_FCS,
	305	IEEE802154_FILTERING_2_PROMISCUOUS,
	306	IEEE802154_FILTERING_3_SCAN,
	307	IEEE802154_FILTERING_4_FRAME_FIELDS,
	308	};
	309
54552d03 AA	310	/* frame control handling */
54552d03 AA	311	#define IEEE802154_FCTL_FTYPE 0x0003
79750ac4	312	#define IEEE802154_FCTL_ACKREQ 0x0020
bc405cd6	313	#define IEEE802154_FCTL_SECEN 0x0004
54552d03	314	#define IEEE802154_FCTL_INTRA_PAN 0x0040
9cc577dd	315	#define IEEE802154_FCTL_DADDR 0x0c00
19580cc1	316	#define IEEE802154_FCTL_SADDR 0xc000
54552d03 AA	317
	318	#define IEEE802154_FTYPE_DATA 0x0001
	319
9cc577dd AA	320	#define IEEE802154_FCTL_ADDR_NONE 0x0000
	321	#define IEEE802154_FCTL_DADDR_SHORT 0x0800
	322	#define IEEE802154_FCTL_DADDR_EXTENDED 0x0c00
19580cc1 AA	323	#define IEEE802154_FCTL_SADDR_SHORT 0x8000
19580cc1 AA	324	#define IEEE802154_FCTL_SADDR_EXTENDED 0xc000
9cc577dd	325
54552d03 AA	326	/*
	327	* ieee802154_is_data - check if type is IEEE802154_FTYPE_DATA
	328	* @fc: frame control bytes in little-endian byteorder
	329	*/
	330	static inline int ieee802154_is_data(__le16 fc)
	331	{
	332	return (fc & cpu_to_le16(IEEE802154_FCTL_FTYPE)) ==
	333	cpu_to_le16(IEEE802154_FTYPE_DATA);
	334	}
	335
bc405cd6 AM	336	/**
	337	* ieee802154_is_secen - check if Security bit is set
	338	* @fc: frame control bytes in little-endian byteorder
	339	*/
	340	static inline bool ieee802154_is_secen(__le16 fc)
	341	{
	342	return fc & cpu_to_le16(IEEE802154_FCTL_SECEN);
	343	}
	344
79750ac4 AA	345	/**
	346	* ieee802154_is_ackreq - check if acknowledgment request bit is set
	347	* @fc: frame control bytes in little-endian byteorder
	348	*/
	349	static inline bool ieee802154_is_ackreq(__le16 fc)
	350	{
	351	return fc & cpu_to_le16(IEEE802154_FCTL_ACKREQ);
	352	}
	353
54552d03 AA	354	/**
	355	* ieee802154_is_intra_pan - check if intra pan id communication
	356	* @fc: frame control bytes in little-endian byteorder
	357	*/
	358	static inline bool ieee802154_is_intra_pan(__le16 fc)
	359	{
	360	return fc & cpu_to_le16(IEEE802154_FCTL_INTRA_PAN);
	361	}
	362
9cc577dd AA	363	/*
	364	* ieee802154_daddr_mode - get daddr mode from fc
	365	* @fc: frame control bytes in little-endian byteorder
	366	*/
	367	static inline __le16 ieee802154_daddr_mode(__le16 fc)
	368	{
	369	return fc & cpu_to_le16(IEEE802154_FCTL_DADDR);
	370	}
	371
19580cc1 AA	372	/*
	373	* ieee802154_saddr_mode - get saddr mode from fc
	374	* @fc: frame control bytes in little-endian byteorder
	375	*/
	376	static inline __le16 ieee802154_saddr_mode(__le16 fc)
	377	{
	378	return fc & cpu_to_le16(IEEE802154_FCTL_SADDR);
	379	}
	380
fa491001 AA	381	/**
fa491001 AA	382	* ieee802154_is_valid_psdu_len - check if psdu len is valid
306f7aa1 AA	383	* available lengths:
	384	* 0-4 Reserved
	385	* 5 MPDU (Acknowledgment)
	386	* 6-8 Reserved
	387	* 9-127 MPDU
	388	*
fa491001 AA	389	* @len: psdu len with (MHR + payload + MFR)
fa491001 AA	390	*/
b7594148	391	static inline bool ieee802154_is_valid_psdu_len(u8 len)
fa491001	392	{
306f7aa1 AA	393	return (len == IEEE802154_ACK_PSDU_LEN \|\|
306f7aa1 AA	394	(len >= IEEE802154_MIN_PSDU_LEN && len <= IEEE802154_MTU));
fa491001	395	}
9ec76716	396
cb904b0a	397	/**
b7594148	398	* ieee802154_is_valid_extended_unicast_addr - check if extended addr is valid
cb904b0a AA	399	* @addr: extended addr to check
cb904b0a AA	400	*/
b7594148	401	static inline bool ieee802154_is_valid_extended_unicast_addr(__le64 addr)
cb904b0a	402	{
daf4e2c8 LB	403	/* Bail out if the address is all zero, or if the group
daf4e2c8 LB	404	* address bit is set.
cb904b0a	405	*/
0d8a52f9	406	return ((addr != cpu_to_le64(0x0000000000000000ULL)) &&
daf4e2c8	407	!(addr & cpu_to_le64(0x0100000000000000ULL)));
cb904b0a AA	408	}
cb904b0a AA	409
118a5cf8 AA	410	/**
	411	* ieee802154_is_broadcast_short_addr - check if short addr is broadcast
	412	* @addr: short addr to check
	413	*/
	414	static inline bool ieee802154_is_broadcast_short_addr(__le16 addr)
	415	{
	416	return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_BROADCAST));
	417	}
	418
	419	/**
	420	* ieee802154_is_unspec_short_addr - check if short addr is unspecified
	421	* @addr: short addr to check
	422	*/
	423	static inline bool ieee802154_is_unspec_short_addr(__le16 addr)
	424	{
	425	return (addr == cpu_to_le16(IEEE802154_ADDR_SHORT_UNSPEC));
	426	}
	427
	428	/**
	429	* ieee802154_is_valid_src_short_addr - check if source short address is valid
	430	* @addr: short addr to check
	431	*/
	432	static inline bool ieee802154_is_valid_src_short_addr(__le16 addr)
	433	{
	434	return !(ieee802154_is_broadcast_short_addr(addr) \|\|
	435	ieee802154_is_unspec_short_addr(addr));
	436	}
	437
35d5a374 AA	438	/**
	439	* ieee802154_random_extended_addr - generates a random extended address
	440	* @addr: extended addr pointer to place the random address
	441	*/
	442	static inline void ieee802154_random_extended_addr(__le64 *addr)
	443	{
	444	get_random_bytes(addr, IEEE802154_EXTENDED_ADDR_LEN);
	445
3b369bd2 LB	446	/* clear the group bit, and set the locally administered bit */
	447	((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] &= ~0x01;
	448	((u8 *)addr)[IEEE802154_EXTENDED_ADDR_LEN - 1] \|= 0x02;
35d5a374 AA	449	}
35d5a374 AA	450
4ca24aca	451	#endif /* LINUX_IEEE802154_H */