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

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * IEEE802.15.4-2003 specification
 *
 * Copyright (C) 2007-2012 Siemens AG
 */
#ifndef NET_MAC802154_H
#define NET_MAC802154_H

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

#include <net/cfg802154.h>

/**
 * enum ieee802154_hw_addr_filt_flags - hardware address filtering flags
 *
 * The following flags are used to indicate changed address settings from
 * the stack to the hardware.
 *
 * @IEEE802154_AFILT_SADDR_CHANGED: Indicates that the short address will be
 *	change.
 *
 * @IEEE802154_AFILT_IEEEADDR_CHANGED: Indicates that the extended address
 *	will be change.
 *
 * @IEEE802154_AFILT_PANID_CHANGED: Indicates that the pan id will be change.
 *
 * @IEEE802154_AFILT_PANC_CHANGED: Indicates that the address filter will
 *	do frame address filtering as a pan coordinator.
 */
enum ieee802154_hw_addr_filt_flags {
	IEEE802154_AFILT_SADDR_CHANGED		= BIT(0),
	IEEE802154_AFILT_IEEEADDR_CHANGED	= BIT(1),
	IEEE802154_AFILT_PANID_CHANGED		= BIT(2),
	IEEE802154_AFILT_PANC_CHANGED		= BIT(3),
};

/**
 * struct ieee802154_hw_addr_filt - hardware address filtering settings
 *
 * @pan_id: pan_id which should be set to the hardware address filter.
 *
 * @short_addr: short_addr which should be set to the hardware address filter.
 *
 * @ieee_addr: extended address which should be set to the hardware address
 *	filter.
 *
 * @pan_coord: boolean if hardware filtering should be operate as coordinator.
 */
struct ieee802154_hw_addr_filt {
	__le16	pan_id;
	__le16	short_addr;
	__le64	ieee_addr;
	bool	pan_coord;
};

/**
 * struct ieee802154_hw - ieee802154 hardware
 *
 * @extra_tx_headroom: headroom to reserve in each transmit skb for use by the
 *	driver (e.g. for transmit headers.)
 *
 * @flags: hardware flags, see &enum ieee802154_hw_flags
 *
 * @parent: parent device of the hardware.
 *
 * @priv: pointer to private area that was allocated for driver use along with
 *	this structure.
 *
 * @phy: This points to the &struct wpan_phy allocated for this 802.15.4 PHY.
 */
struct ieee802154_hw {
	/* filled by the driver */
	int	extra_tx_headroom;
	u32	flags;
	struct	device *parent;
	void	*priv;

	/* filled by mac802154 core */
	struct	wpan_phy *phy;
};

/**
 * enum ieee802154_hw_flags - hardware flags
 *
 * These flags are used to indicate hardware capabilities to
 * the stack. Generally, flags here should have their meaning
 * done in a way that the simplest hardware doesn't need setting
 * any particular flags. There are some exceptions to this rule,
 * however, so you are advised to review these flags carefully.
 *
 * @IEEE802154_HW_TX_OMIT_CKSUM: Indicates that xmitter will add FCS on it's
 *	own.
 *
 * @IEEE802154_HW_LBT: Indicates that transceiver will support listen before
 *	transmit.
 *
 * @IEEE802154_HW_CSMA_PARAMS: Indicates that transceiver will support csma
 *	parameters (max_be, min_be, backoff exponents).
 *
 * @IEEE802154_HW_FRAME_RETRIES: Indicates that transceiver will support ARET
 *	frame retries setting.
 *
 * @IEEE802154_HW_AFILT: Indicates that transceiver will support hardware
 *	address filter setting.
 *
 * @IEEE802154_HW_PROMISCUOUS: Indicates that transceiver will support
 *	promiscuous mode setting.
 *
 * @IEEE802154_HW_RX_OMIT_CKSUM: Indicates that receiver omits FCS.
 *
 * @IEEE802154_HW_RX_DROP_BAD_CKSUM: Indicates that receiver will not filter
 *	frames with bad checksum.
 */
enum ieee802154_hw_flags {
	IEEE802154_HW_TX_OMIT_CKSUM	= BIT(0),
	IEEE802154_HW_LBT		= BIT(1),
	IEEE802154_HW_CSMA_PARAMS	= BIT(2),
	IEEE802154_HW_FRAME_RETRIES	= BIT(3),
	IEEE802154_HW_AFILT		= BIT(4),
	IEEE802154_HW_PROMISCUOUS	= BIT(5),
	IEEE802154_HW_RX_OMIT_CKSUM	= BIT(6),
	IEEE802154_HW_RX_DROP_BAD_CKSUM	= BIT(7),
};

/* Indicates that receiver omits FCS and xmitter will add FCS on it's own. */
#define IEEE802154_HW_OMIT_CKSUM	(IEEE802154_HW_TX_OMIT_CKSUM | \
					 IEEE802154_HW_RX_OMIT_CKSUM)

/* struct ieee802154_ops - callbacks from mac802154 to the driver
 *
 * This structure contains various callbacks that the driver may
 * handle or, in some cases, must handle, for example to transmit
 * a frame.
 *
 * start: Handler that 802.15.4 module calls for device initialization.
 *	  This function is called before the first interface is attached.
 *
 * stop:  Handler that 802.15.4 module calls for device cleanup.
 *	  This function is called after the last interface is removed.
 *
 * xmit_sync:
 *	  Handler that 802.15.4 module calls for each transmitted frame.
 *	  skb cntains the buffer starting from the IEEE 802.15.4 header.
 *	  The low-level driver should send the frame based on available
 *	  configuration. This is called by a workqueue and useful for
 *	  synchronous 802.15.4 drivers.
 *	  This function should return zero or negative errno.
 *
 *	  WARNING:
 *	  This will be deprecated soon. We don't accept synced xmit callbacks
 *	  drivers anymore.
 *
 * xmit_async:
 *	  Handler that 802.15.4 module calls for each transmitted frame.
 *	  skb cntains the buffer starting from the IEEE 802.15.4 header.
 *	  The low-level driver should send the frame based on available
 *	  configuration.
 *	  This function should return zero or negative errno.
 *
 * ed:    Handler that 802.15.4 module calls for Energy Detection.
 *	  This function should place the value for detected energy
 *	  (usually device-dependant) in the level pointer and return
 *	  either zero or negative errno. Called with pib_lock held.
 *
 * set_channel:
 * 	  Set radio for listening on specific channel.
 *	  Set the device for listening on specified channel.
 *	  Returns either zero, or negative errno. Called with pib_lock held.
 *
 * set_hw_addr_filt:
 *	  Set radio for listening on specific address.
 *	  Set the device for listening on specified address.
 *	  Returns either zero, or negative errno.
 *
 * set_txpower:
 *	  Set radio transmit power in mBm. Called with pib_lock held.
 *	  Returns either zero, or negative errno.
 *
 * set_lbt
 *	  Enables or disables listen before talk on the device. Called with
 *	  pib_lock held.
 *	  Returns either zero, or negative errno.
 *
 * set_cca_mode
 *	  Sets the CCA mode used by the device. Called with pib_lock held.
 *	  Returns either zero, or negative errno.
 *
 * set_cca_ed_level
 *	  Sets the CCA energy detection threshold in mBm. Called with pib_lock
 *	  held.
 *	  Returns either zero, or negative errno.
 *
 * set_csma_params
 *	  Sets the CSMA parameter set for the PHY. Called with pib_lock held.
 *	  Returns either zero, or negative errno.
 *
 * set_frame_retries
 *	  Sets the retransmission attempt limit. Called with pib_lock held.
 *	  Returns either zero, or negative errno.
 *
 * set_promiscuous_mode
 *	  Enables or disable promiscuous mode.
 */
struct ieee802154_ops {
	struct module	*owner;
	int		(*start)(struct ieee802154_hw *hw);
	void		(*stop)(struct ieee802154_hw *hw);
	int		(*xmit_sync)(struct ieee802154_hw *hw,
				     struct sk_buff *skb);
	int		(*xmit_async)(struct ieee802154_hw *hw,
				      struct sk_buff *skb);
	int		(*ed)(struct ieee802154_hw *hw, u8 *level);
	int		(*set_channel)(struct ieee802154_hw *hw, u8 page,
				       u8 channel);
	int		(*set_hw_addr_filt)(struct ieee802154_hw *hw,
					    struct ieee802154_hw_addr_filt *filt,
					    unsigned long changed);
	int		(*set_txpower)(struct ieee802154_hw *hw, s32 mbm);
	int		(*set_lbt)(struct ieee802154_hw *hw, bool on);
	int		(*set_cca_mode)(struct ieee802154_hw *hw,
					const struct wpan_phy_cca *cca);
	int		(*set_cca_ed_level)(struct ieee802154_hw *hw, s32 mbm);
	int		(*set_csma_params)(struct ieee802154_hw *hw,
					   u8 min_be, u8 max_be, u8 retries);
	int		(*set_frame_retries)(struct ieee802154_hw *hw,
					     s8 retries);
	int             (*set_promiscuous_mode)(struct ieee802154_hw *hw,
						const bool on);
};

/**
 * ieee802154_get_fc_from_skb - get the frame control field from an skb
 * @skb: skb where the frame control field will be get from
 */
static inline __le16 ieee802154_get_fc_from_skb(const struct sk_buff *skb)
{
	__le16 fc;

	/* check if we can fc at skb_mac_header of sk buffer */
	if (WARN_ON(!skb_mac_header_was_set(skb) ||
		    (skb_tail_pointer(skb) -
		     skb_mac_header(skb)) < IEEE802154_FC_LEN))
		return cpu_to_le16(0);

	memcpy(&fc, skb_mac_header(skb), IEEE802154_FC_LEN);
	return fc;
}

/**
 * ieee802154_skb_dst_pan - get the pointer to destination pan field
 * @fc: mac header frame control field
 * @skb: skb where the destination pan pointer will be get from
 */
static inline unsigned char *ieee802154_skb_dst_pan(__le16 fc,
						    const struct sk_buff *skb)
{
	unsigned char *dst_pan;

	switch (ieee802154_daddr_mode(fc)) {
	case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
		dst_pan = NULL;
		break;
	case cpu_to_le16(IEEE802154_FCTL_DADDR_SHORT):
	case cpu_to_le16(IEEE802154_FCTL_DADDR_EXTENDED):
		dst_pan = skb_mac_header(skb) +
			  IEEE802154_FC_LEN +
			  IEEE802154_SEQ_LEN;
		break;
	default:
		WARN_ONCE(1, "invalid addr mode detected");
		dst_pan = NULL;
		break;
	}

	return dst_pan;
}

/**
 * ieee802154_skb_src_pan - get the pointer to source pan field
 * @fc: mac header frame control field
 * @skb: skb where the source pan pointer will be get from
 */
static inline unsigned char *ieee802154_skb_src_pan(__le16 fc,
						    const struct sk_buff *skb)
{
	unsigned char *src_pan;

	switch (ieee802154_saddr_mode(fc)) {
	case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
		src_pan = NULL;
		break;
	case cpu_to_le16(IEEE802154_FCTL_SADDR_SHORT):
	case cpu_to_le16(IEEE802154_FCTL_SADDR_EXTENDED):
		/* if intra-pan and source addr mode is non none,
		 * then source pan id is equal destination pan id.
		 */
		if (ieee802154_is_intra_pan(fc)) {
			src_pan = ieee802154_skb_dst_pan(fc, skb);
			break;
		}

		switch (ieee802154_daddr_mode(fc)) {
		case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
			src_pan = skb_mac_header(skb) +
				  IEEE802154_FC_LEN +
				  IEEE802154_SEQ_LEN;
			break;
		case cpu_to_le16(IEEE802154_FCTL_DADDR_SHORT):
			src_pan = skb_mac_header(skb) +
				  IEEE802154_FC_LEN +
				  IEEE802154_SEQ_LEN +
				  IEEE802154_PAN_ID_LEN +
				  IEEE802154_SHORT_ADDR_LEN;
			break;
		case cpu_to_le16(IEEE802154_FCTL_DADDR_EXTENDED):
			src_pan = skb_mac_header(skb) +
				  IEEE802154_FC_LEN +
				  IEEE802154_SEQ_LEN +
				  IEEE802154_PAN_ID_LEN +
				  IEEE802154_EXTENDED_ADDR_LEN;
			break;
		default:
			WARN_ONCE(1, "invalid addr mode detected");
			src_pan = NULL;
			break;
		}
		break;
	default:
		WARN_ONCE(1, "invalid addr mode detected");
		src_pan = NULL;
		break;
	}

	return src_pan;
}

/**
 * ieee802154_skb_is_intra_pan_addressing - checks whenever the mac addressing
 *	is an intra pan communication
 * @fc: mac header frame control field
 * @skb: skb where the source and destination pan should be get from
 */
static inline bool ieee802154_skb_is_intra_pan_addressing(__le16 fc,
							  const struct sk_buff *skb)
{
	unsigned char *dst_pan = ieee802154_skb_dst_pan(fc, skb),
		      *src_pan = ieee802154_skb_src_pan(fc, skb);

	/* if one is NULL is no intra pan addressing */
	if (!dst_pan || !src_pan)
		return false;

	return !memcmp(dst_pan, src_pan, IEEE802154_PAN_ID_LEN);
}

/**
 * ieee802154_be64_to_le64 - copies and convert be64 to le64
 * @le64_dst: le64 destination pointer
 * @be64_src: be64 source pointer
 */
static inline void ieee802154_be64_to_le64(void *le64_dst, const void *be64_src)
{
	put_unaligned_le64(get_unaligned_be64(be64_src), le64_dst);
}

/**
 * ieee802154_le64_to_be64 - copies and convert le64 to be64
 * @be64_dst: be64 destination pointer
 * @le64_src: le64 source pointer
 */
static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
{
	put_unaligned_be64(get_unaligned_le64(le64_src), be64_dst);
}

/**
 * ieee802154_le16_to_be16 - copies and convert le16 to be16
 * @be16_dst: be16 destination pointer
 * @le16_src: le16 source pointer
 */
static inline void ieee802154_le16_to_be16(void *be16_dst, const void *le16_src)
{
	put_unaligned_be16(get_unaligned_le16(le16_src), be16_dst);
}

/**
 * ieee802154_be16_to_le16 - copies and convert be16 to le16
 * @le16_dst: le16 destination pointer
 * @be16_src: be16 source pointer
 */
static inline void ieee802154_be16_to_le16(void *le16_dst, const void *be16_src)
{
	put_unaligned_le16(get_unaligned_be16(be16_src), le16_dst);
}

/**
 * ieee802154_alloc_hw - Allocate a new hardware device
 *
 * This must be called once for each hardware device. The returned pointer
 * must be used to refer to this device when calling other functions.
 * mac802154 allocates a private data area for the driver pointed to by
 * @priv in &struct ieee802154_hw, the size of this area is given as
 * @priv_data_len.
 *
 * @priv_data_len: length of private data
 * @ops: callbacks for this device
 *
 * Return: A pointer to the new hardware device, or %NULL on error.
 */
struct ieee802154_hw *
ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);

/**
 * ieee802154_free_hw - free hardware descriptor
 *
 * This function frees everything that was allocated, including the
 * private data for the driver. You must call ieee802154_unregister_hw()
 * before calling this function.
 *
 * @hw: the hardware to free
 */
void ieee802154_free_hw(struct ieee802154_hw *hw);

/**
 * ieee802154_register_hw - Register hardware device
 *
 * You must call this function before any other functions in
 * mac802154. Note that before a hardware can be registered, you
 * need to fill the contained wpan_phy's information.
 *
 * @hw: the device to register as returned by ieee802154_alloc_hw()
 *
 * Return: 0 on success. An error code otherwise.
 */
int ieee802154_register_hw(struct ieee802154_hw *hw);

/**
 * ieee802154_unregister_hw - Unregister a hardware device
 *
 * This function instructs mac802154 to free allocated resources
 * and unregister netdevices from the networking subsystem.
 *
 * @hw: the hardware to unregister
 */
void ieee802154_unregister_hw(struct ieee802154_hw *hw);

/**
 * ieee802154_rx_irqsafe - receive frame
 *
 * Like ieee802154_rx() but can be called in IRQ context
 * (internally defers to a tasklet.)
 *
 * @hw: the hardware this frame came in on
 * @skb: the buffer to receive, owned by mac802154 after this call
 * @lqi: link quality indicator
 */
void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
			   u8 lqi);
/**
 * ieee802154_wake_queue - wake ieee802154 queue
 * @hw: pointer as obtained from ieee802154_alloc_hw().
 *
 * Drivers should use this function instead of netif_wake_queue.
 */
void ieee802154_wake_queue(struct ieee802154_hw *hw);

/**
 * ieee802154_stop_queue - stop ieee802154 queue
 * @hw: pointer as obtained from ieee802154_alloc_hw().
 *
 * Drivers should use this function instead of netif_stop_queue.
 */
void ieee802154_stop_queue(struct ieee802154_hw *hw);

/**
 * ieee802154_xmit_complete - frame transmission complete
 *
 * @hw: pointer as obtained from ieee802154_alloc_hw().
 * @skb: buffer for transmission
 * @ifs_handling: indicate interframe space handling
 */
void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
			      bool ifs_handling);

#endif /* NET_MAC802154_H */
Commit	Line	Data
1802d0be	1	/* SPDX-License-Identifier: GPL-2.0-only */
0afd7ad9	2	/*
	3	* IEEE802.15.4-2003 specification
	4	*
	5	* Copyright (C) 2007-2012 Siemens AG
0afd7ad9	6	*/
	7	#ifndef NET_MAC802154_H
	8	#define NET_MAC802154_H
	9
f1608920	10	#include <asm/unaligned.h>
0afd7ad9	11	#include <net/af_ieee802154.h>
239a84a9	12	#include <linux/ieee802154.h>
94b4f6c2	13	#include <linux/skbuff.h>
0afd7ad9	14
7fe9a388 AA	15	#include <net/cfg802154.h>
7fe9a388 AA	16
6b70a43c AA	17	/**
	18	* enum ieee802154_hw_addr_filt_flags - hardware address filtering flags
	19	*
	20	* The following flags are used to indicate changed address settings from
0afd7ad9	21	* the stack to the hardware.
6b70a43c AA	22	*
	23	* @IEEE802154_AFILT_SADDR_CHANGED: Indicates that the short address will be
	24	* change.
	25	*
	26	* @IEEE802154_AFILT_IEEEADDR_CHANGED: Indicates that the extended address
	27	* will be change.
	28	*
	29	* @IEEE802154_AFILT_PANID_CHANGED: Indicates that the pan id will be change.
	30	*
	31	* @IEEE802154_AFILT_PANC_CHANGED: Indicates that the address filter will
	32	* do frame address filtering as a pan coordinator.
0afd7ad9	33	*/
6b70a43c	34	enum ieee802154_hw_addr_filt_flags {
70f36507 AA	35	IEEE802154_AFILT_SADDR_CHANGED = BIT(0),
	36	IEEE802154_AFILT_IEEEADDR_CHANGED = BIT(1),
	37	IEEE802154_AFILT_PANID_CHANGED = BIT(2),
	38	IEEE802154_AFILT_PANC_CHANGED = BIT(3),
6b70a43c	39	};
0afd7ad9	40
a0825b03 AA	41	/**
	42	* struct ieee802154_hw_addr_filt - hardware address filtering settings
	43	*
	44	* @pan_id: pan_id which should be set to the hardware address filter.
	45	*
	46	* @short_addr: short_addr which should be set to the hardware address filter.
	47	*
	48	* @ieee_addr: extended address which should be set to the hardware address
	49	* filter.
	50	*
	51	* @pan_coord: boolean if hardware filtering should be operate as coordinator.
	52	*/
0afd7ad9	53	struct ieee802154_hw_addr_filt {
a0825b03	54	__le16 pan_id;
0afd7ad9	55	__le16 short_addr;
b70ab2e8	56	__le64 ieee_addr;
623c1234	57	bool pan_coord;
0afd7ad9	58	};
0afd7ad9	59
a0825b03 AA	60	/**
	61	* struct ieee802154_hw - ieee802154 hardware
	62	*
	63	* @extra_tx_headroom: headroom to reserve in each transmit skb for use by the
	64	* driver (e.g. for transmit headers.)
	65	*
	66	* @flags: hardware flags, see &enum ieee802154_hw_flags
	67	*
	68	* @parent: parent device of the hardware.
	69	*
	70	* @priv: pointer to private area that was allocated for driver use along with
	71	* this structure.
	72	*
	73	* @phy: This points to the &struct wpan_phy allocated for this 802.15.4 PHY.
	74	*/
5a504397	75	struct ieee802154_hw {
0afd7ad9	76	/* filled by the driver */
	77	int extra_tx_headroom;
	78	u32 flags;
	79	struct device *parent;
af69a345	80	void *priv;
0afd7ad9	81
0afd7ad9	82	/* filled by mac802154 core */
0afd7ad9	83	struct wpan_phy *phy;
	84	};
	85
bcbfd207 AA	86	/**
bcbfd207 AA	87	* enum ieee802154_hw_flags - hardware flags
0afd7ad9	88	*
bcbfd207	89	* These flags are used to indicate hardware capabilities to
0afd7ad9	90	* the stack. Generally, flags here should have their meaning
	91	* done in a way that the simplest hardware doesn't need setting
	92	* any particular flags. There are some exceptions to this rule,
	93	* however, so you are advised to review these flags carefully.
bcbfd207 AA	94	*
	95	* @IEEE802154_HW_TX_OMIT_CKSUM: Indicates that xmitter will add FCS on it's
	96	* own.
	97	*
	98	* @IEEE802154_HW_LBT: Indicates that transceiver will support listen before
	99	* transmit.
	100	*
	101	* @IEEE802154_HW_CSMA_PARAMS: Indicates that transceiver will support csma
	102	* parameters (max_be, min_be, backoff exponents).
	103	*
	104	* @IEEE802154_HW_FRAME_RETRIES: Indicates that transceiver will support ARET
	105	* frame retries setting.
	106	*
	107	* @IEEE802154_HW_AFILT: Indicates that transceiver will support hardware
	108	* address filter setting.
	109	*
	110	* @IEEE802154_HW_PROMISCUOUS: Indicates that transceiver will support
	111	* promiscuous mode setting.
	112	*
	113	* @IEEE802154_HW_RX_OMIT_CKSUM: Indicates that receiver omits FCS.
	114	*
	115	* @IEEE802154_HW_RX_DROP_BAD_CKSUM: Indicates that receiver will not filter
	116	* frames with bad checksum.
0afd7ad9	117	*/
bcbfd207	118	enum ieee802154_hw_flags {
70f36507 AA	119	IEEE802154_HW_TX_OMIT_CKSUM = BIT(0),
	120	IEEE802154_HW_LBT = BIT(1),
	121	IEEE802154_HW_CSMA_PARAMS = BIT(2),
	122	IEEE802154_HW_FRAME_RETRIES = BIT(3),
	123	IEEE802154_HW_AFILT = BIT(4),
	124	IEEE802154_HW_PROMISCUOUS = BIT(5),
	125	IEEE802154_HW_RX_OMIT_CKSUM = BIT(6),
	126	IEEE802154_HW_RX_DROP_BAD_CKSUM = BIT(7),
bcbfd207	127	};
90386a7e AA	128
	129	/* Indicates that receiver omits FCS and xmitter will add FCS on it's own. */
	130	#define IEEE802154_HW_OMIT_CKSUM (IEEE802154_HW_TX_OMIT_CKSUM \| \
	131	IEEE802154_HW_RX_OMIT_CKSUM)
640985ec	132
0afd7ad9	133	/* struct ieee802154_ops - callbacks from mac802154 to the driver
	134	*
	135	* This structure contains various callbacks that the driver may
	136	* handle or, in some cases, must handle, for example to transmit
	137	* a frame.
	138	*
	139	* start: Handler that 802.15.4 module calls for device initialization.
	140	* This function is called before the first interface is attached.
	141	*
	142	* stop: Handler that 802.15.4 module calls for device cleanup.
	143	* This function is called after the last interface is removed.
	144	*
ed0a5dce AA	145	* xmit_sync:
	146	* Handler that 802.15.4 module calls for each transmitted frame.
	147	* skb cntains the buffer starting from the IEEE 802.15.4 header.
	148	* The low-level driver should send the frame based on available
	149	* configuration. This is called by a workqueue and useful for
	150	* synchronous 802.15.4 drivers.
	151	* This function should return zero or negative errno.
	152	*
1e7283a2 AA	153	* WARNING:
	154	* This will be deprecated soon. We don't accept synced xmit callbacks
	155	* drivers anymore.
	156	*
ed0a5dce AA	157	* xmit_async:
ed0a5dce AA	158	* Handler that 802.15.4 module calls for each transmitted frame.
0afd7ad9	159	* skb cntains the buffer starting from the IEEE 802.15.4 header.
	160	* The low-level driver should send the frame based on available
	161	* configuration.
dc67c6b3	162	* This function should return zero or negative errno.
0afd7ad9	163	*
	164	* ed: Handler that 802.15.4 module calls for Energy Detection.
	165	* This function should place the value for detected energy
	166	* (usually device-dependant) in the level pointer and return
	167	* either zero or negative errno. Called with pib_lock held.
	168	*
	169	* set_channel:
	170	* Set radio for listening on specific channel.
	171	* Set the device for listening on specified channel.
	172	* Returns either zero, or negative errno. Called with pib_lock held.
	173	*
	174	* set_hw_addr_filt:
	175	* Set radio for listening on specific address.
	176	* Set the device for listening on specified address.
	177	* Returns either zero, or negative errno.
9b2777d6 PB	178	*
9b2777d6 PB	179	* set_txpower:
e2eb173a	180	* Set radio transmit power in mBm. Called with pib_lock held.
9b2777d6	181	* Returns either zero, or negative errno.
84dda3c6 PB	182	*
	183	* set_lbt
	184	* Enables or disables listen before talk on the device. Called with
	185	* pib_lock held.
	186	* Returns either zero, or negative errno.
ba08fea5 PB	187	*
	188	* set_cca_mode
	189	* Sets the CCA mode used by the device. Called with pib_lock held.
	190	* Returns either zero, or negative errno.
6ca00197 PB	191	*
6ca00197 PB	192	* set_cca_ed_level
32b23550	193	* Sets the CCA energy detection threshold in mBm. Called with pib_lock
6ca00197 PB	194	* held.
6ca00197 PB	195	* Returns either zero, or negative errno.
4244db1b PB	196	*
	197	* set_csma_params
	198	* Sets the CSMA parameter set for the PHY. Called with pib_lock held.
	199	* Returns either zero, or negative errno.
	200	*
	201	* set_frame_retries
	202	* Sets the retransmission attempt limit. Called with pib_lock held.
	203	* Returns either zero, or negative errno.
94b79222 AA	204	*
	205	* set_promiscuous_mode
	206	* Enables or disable promiscuous mode.
0afd7ad9	207	*/
	208	struct ieee802154_ops {
	209	struct module *owner;
5a504397 AA	210	int (start)(struct ieee802154_hw hw);
5a504397 AA	211	void (stop)(struct ieee802154_hw hw);
ed0a5dce AA	212	int (xmit_sync)(struct ieee802154_hw hw,
	213	struct sk_buff *skb);
	214	int (xmit_async)(struct ieee802154_hw hw,
	215	struct sk_buff *skb);
5a504397	216	int (ed)(struct ieee802154_hw hw, u8 *level);
e37d2ec8 AA	217	int (set_channel)(struct ieee802154_hw hw, u8 page,
e37d2ec8 AA	218	u8 channel);
5a504397 AA	219	int (set_hw_addr_filt)(struct ieee802154_hw hw,
5a504397 AA	220	struct ieee802154_hw_addr_filt *filt,
0afd7ad9	221	unsigned long changed);
e2eb173a	222	int (set_txpower)(struct ieee802154_hw hw, s32 mbm);
5a504397	223	int (set_lbt)(struct ieee802154_hw hw, bool on);
7fe9a388 AA	224	int (set_cca_mode)(struct ieee802154_hw hw,
7fe9a388 AA	225	const struct wpan_phy_cca *cca);
32b23550	226	int (set_cca_ed_level)(struct ieee802154_hw hw, s32 mbm);
5a504397	227	int (set_csma_params)(struct ieee802154_hw hw,
4244db1b	228	u8 min_be, u8 max_be, u8 retries);
5a504397	229	int (set_frame_retries)(struct ieee802154_hw hw,
4244db1b	230	s8 retries);
94b79222 AA	231	int (set_promiscuous_mode)(struct ieee802154_hw hw,
94b79222 AA	232	const bool on);
0afd7ad9	233	};
0afd7ad9	234
54552d03 AA	235	/**
	236	* ieee802154_get_fc_from_skb - get the frame control field from an skb
	237	* @skb: skb where the frame control field will be get from
	238	*/
	239	static inline __le16 ieee802154_get_fc_from_skb(const struct sk_buff *skb)
	240	{
aaa7088e AA	241	__le16 fc;
aaa7088e AA	242
07b0188a	243	/* check if we can fc at skb_mac_header of sk buffer */
048e7f7e AA	244	if (WARN_ON(!skb_mac_header_was_set(skb) \|\|
	245	(skb_tail_pointer(skb) -
	246	skb_mac_header(skb)) < IEEE802154_FC_LEN))
54552d03	247	return cpu_to_le16(0);
54552d03	248
aaa7088e AA	249	memcpy(&fc, skb_mac_header(skb), IEEE802154_FC_LEN);
aaa7088e AA	250	return fc;
54552d03 AA	251	}
54552d03 AA	252
9cc577dd AA	253	/**
	254	* ieee802154_skb_dst_pan - get the pointer to destination pan field
	255	* @fc: mac header frame control field
	256	* @skb: skb where the destination pan pointer will be get from
	257	*/
	258	static inline unsigned char *ieee802154_skb_dst_pan(__le16 fc,
	259	const struct sk_buff *skb)
	260	{
	261	unsigned char *dst_pan;
	262
	263	switch (ieee802154_daddr_mode(fc)) {
	264	case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
	265	dst_pan = NULL;
	266	break;
	267	case cpu_to_le16(IEEE802154_FCTL_DADDR_SHORT):
	268	case cpu_to_le16(IEEE802154_FCTL_DADDR_EXTENDED):
	269	dst_pan = skb_mac_header(skb) +
	270	IEEE802154_FC_LEN +
	271	IEEE802154_SEQ_LEN;
	272	break;
	273	default:
	274	WARN_ONCE(1, "invalid addr mode detected");
	275	dst_pan = NULL;
	276	break;
	277	}
	278
	279	return dst_pan;
	280	}
	281
19580cc1 AA	282	/**
	283	* ieee802154_skb_src_pan - get the pointer to source pan field
	284	* @fc: mac header frame control field
	285	* @skb: skb where the source pan pointer will be get from
	286	*/
	287	static inline unsigned char *ieee802154_skb_src_pan(__le16 fc,
	288	const struct sk_buff *skb)
	289	{
	290	unsigned char *src_pan;
	291
	292	switch (ieee802154_saddr_mode(fc)) {
	293	case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
	294	src_pan = NULL;
	295	break;
	296	case cpu_to_le16(IEEE802154_FCTL_SADDR_SHORT):
	297	case cpu_to_le16(IEEE802154_FCTL_SADDR_EXTENDED):
	298	/* if intra-pan and source addr mode is non none,
	299	* then source pan id is equal destination pan id.
	300	*/
	301	if (ieee802154_is_intra_pan(fc)) {
	302	src_pan = ieee802154_skb_dst_pan(fc, skb);
	303	break;
	304	}
	305
	306	switch (ieee802154_daddr_mode(fc)) {
	307	case cpu_to_le16(IEEE802154_FCTL_ADDR_NONE):
	308	src_pan = skb_mac_header(skb) +
	309	IEEE802154_FC_LEN +
	310	IEEE802154_SEQ_LEN;
	311	break;
	312	case cpu_to_le16(IEEE802154_FCTL_DADDR_SHORT):
	313	src_pan = skb_mac_header(skb) +
	314	IEEE802154_FC_LEN +
	315	IEEE802154_SEQ_LEN +
	316	IEEE802154_PAN_ID_LEN +
	317	IEEE802154_SHORT_ADDR_LEN;
	318	break;
	319	case cpu_to_le16(IEEE802154_FCTL_DADDR_EXTENDED):
	320	src_pan = skb_mac_header(skb) +
	321	IEEE802154_FC_LEN +
	322	IEEE802154_SEQ_LEN +
	323	IEEE802154_PAN_ID_LEN +
	324	IEEE802154_EXTENDED_ADDR_LEN;
	325	break;
	326	default:
	327	WARN_ONCE(1, "invalid addr mode detected");
	328	src_pan = NULL;
	329	break;
	330	}
	331	break;
	332	default:
	333	WARN_ONCE(1, "invalid addr mode detected");
	334	src_pan = NULL;
	335	break;
	336	}
	337
	338	return src_pan;
	339	}
	340
0ea0b9af AA	341	/**
	342	* ieee802154_skb_is_intra_pan_addressing - checks whenever the mac addressing
	343	* is an intra pan communication
	344	* @fc: mac header frame control field
	345	* @skb: skb where the source and destination pan should be get from
	346	*/
	347	static inline bool ieee802154_skb_is_intra_pan_addressing(__le16 fc,
	348	const struct sk_buff *skb)
	349	{
	350	unsigned char *dst_pan = ieee802154_skb_dst_pan(fc, skb),
	351	*src_pan = ieee802154_skb_src_pan(fc, skb);
	352
	353	/* if one is NULL is no intra pan addressing */
	354	if (!dst_pan \|\| !src_pan)
	355	return false;
	356
	357	return !memcmp(dst_pan, src_pan, IEEE802154_PAN_ID_LEN);
	358	}
	359
ab24f50f	360	/**
705cbbbe AA	361	* ieee802154_be64_to_le64 - copies and convert be64 to le64
	362	* @le64_dst: le64 destination pointer
	363	* @be64_src: be64 source pointer
ab24f50f	364	*/
705cbbbe	365	static inline void ieee802154_be64_to_le64(void le64_dst, const void be64_src)
ab24f50f	366	{
f1608920	367	put_unaligned_le64(get_unaligned_be64(be64_src), le64_dst);
ab24f50f AA	368	}
ab24f50f AA	369
239a84a9 AA	370	/**
	371	* ieee802154_le64_to_be64 - copies and convert le64 to be64
	372	* @be64_dst: be64 destination pointer
	373	* @le64_src: le64 source pointer
	374	*/
	375	static inline void ieee802154_le64_to_be64(void be64_dst, const void le64_src)
	376	{
f1608920	377	put_unaligned_be64(get_unaligned_le64(le64_src), be64_dst);
239a84a9 AA	378	}
239a84a9 AA	379
8911d774 AA	380	/**
	381	* ieee802154_le16_to_be16 - copies and convert le16 to be16
	382	* @be16_dst: be16 destination pointer
	383	* @le16_src: le16 source pointer
	384	*/
	385	static inline void ieee802154_le16_to_be16(void be16_dst, const void le16_src)
	386	{
f1608920	387	put_unaligned_be16(get_unaligned_le16(le16_src), be16_dst);
8911d774 AA	388	}
8911d774 AA	389
118a5cf8 AA	390	/**
	391	* ieee802154_be16_to_le16 - copies and convert be16 to le16
	392	* @le16_dst: le16 destination pointer
	393	* @be16_src: be16 source pointer
	394	*/
	395	static inline void ieee802154_be16_to_le16(void le16_dst, const void be16_src)
	396	{
	397	put_unaligned_le16(get_unaligned_be16(be16_src), le16_dst);
	398	}
	399
42fb23e2 VB	400	/**
	401	* ieee802154_alloc_hw - Allocate a new hardware device
	402	*
	403	* This must be called once for each hardware device. The returned pointer
	404	* must be used to refer to this device when calling other functions.
	405	* mac802154 allocates a private data area for the driver pointed to by
	406	* @priv in &struct ieee802154_hw, the size of this area is given as
	407	* @priv_data_len.
	408	*
	409	* @priv_data_len: length of private data
	410	* @ops: callbacks for this device
	411	*
	412	* Return: A pointer to the new hardware device, or %NULL on error.
	413	*/
5a504397	414	struct ieee802154_hw *
16301861	415	ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
42fb23e2 VB	416
	417	/**
	418	* ieee802154_free_hw - free hardware descriptor
	419	*
	420	* This function frees everything that was allocated, including the
	421	* private data for the driver. You must call ieee802154_unregister_hw()
	422	* before calling this function.
	423	*
	424	* @hw: the hardware to free
	425	*/
5a504397	426	void ieee802154_free_hw(struct ieee802154_hw *hw);
42fb23e2 VB	427
	428	/**
	429	* ieee802154_register_hw - Register hardware device
	430	*
	431	* You must call this function before any other functions in
	432	* mac802154. Note that before a hardware can be registered, you
	433	* need to fill the contained wpan_phy's information.
	434	*
	435	* @hw: the device to register as returned by ieee802154_alloc_hw()
	436	*
	437	* Return: 0 on success. An error code otherwise.
	438	*/
5a504397	439	int ieee802154_register_hw(struct ieee802154_hw *hw);
42fb23e2 VB	440
	441	/**
	442	* ieee802154_unregister_hw - Unregister a hardware device
	443	*
	444	* This function instructs mac802154 to free allocated resources
	445	* and unregister netdevices from the networking subsystem.
	446	*
	447	* @hw: the hardware to unregister
	448	*/
5a504397	449	void ieee802154_unregister_hw(struct ieee802154_hw *hw);
1010f540	450
42fb23e2 VB	451	/**
	452	* ieee802154_rx_irqsafe - receive frame
	453	*
	454	* Like ieee802154_rx() but can be called in IRQ context
	455	* (internally defers to a tasklet.)
	456	*
	457	* @hw: the hardware this frame came in on
	458	* @skb: the buffer to receive, owned by mac802154 after this call
	459	* @lqi: link quality indicator
	460	*/
5a504397	461	void ieee802154_rx_irqsafe(struct ieee802154_hw hw, struct sk_buff skb,
1cd829c8	462	u8 lqi);
42fb23e2 VB	463	/**
	464	* ieee802154_wake_queue - wake ieee802154 queue
	465	* @hw: pointer as obtained from ieee802154_alloc_hw().
	466	*
	467	* Drivers should use this function instead of netif_wake_queue.
	468	*/
c2085103	469	void ieee802154_wake_queue(struct ieee802154_hw *hw);
42fb23e2 VB	470
	471	/**
	472	* ieee802154_stop_queue - stop ieee802154 queue
	473	* @hw: pointer as obtained from ieee802154_alloc_hw().
	474	*
	475	* Drivers should use this function instead of netif_stop_queue.
	476	*/
c2085103	477	void ieee802154_stop_queue(struct ieee802154_hw *hw);
42fb23e2 VB	478
	479	/**
	480	* ieee802154_xmit_complete - frame transmission complete
	481	*
	482	* @hw: pointer as obtained from ieee802154_alloc_hw().
	483	* @skb: buffer for transmission
	484	* @ifs_handling: indicate interframe space handling
	485	*/
61f2dcba AA	486	void ieee802154_xmit_complete(struct ieee802154_hw hw, struct sk_buff skb,
61f2dcba AA	487	bool ifs_handling);
c2085103	488
0afd7ad9	489	#endif /* NET_MAC802154_H */