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

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