Linux Audio

Check our new training course

Loading...
v4.6
  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 *
 15 */
 16#ifndef NET_MAC802154_H
 17#define NET_MAC802154_H
 18
 19#include <asm/unaligned.h>
 20#include <net/af_ieee802154.h>
 21#include <linux/ieee802154.h>
 22#include <linux/skbuff.h>
 23
 24#include <net/cfg802154.h>
 25
 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
 30 * the stack to the hardware.
 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.
 42 */
 43enum ieee802154_hw_addr_filt_flags {
 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),
 48};
 49
 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 */
 62struct ieee802154_hw_addr_filt {
 63	__le16	pan_id;
 64	__le16	short_addr;
 65	__le64	ieee_addr;
 66	bool	pan_coord;
 67};
 68
 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 */
 84struct ieee802154_hw {
 85	/* filled by the driver */
 86	int	extra_tx_headroom;
 87	u32	flags;
 88	struct	device *parent;
 89	void	*priv;
 90
 91	/* filled by mac802154 core */
 92	struct	wpan_phy *phy;
 93};
 94
 95/**
 96 * enum ieee802154_hw_flags - hardware flags
 97 *
 98 * These flags are used to indicate hardware capabilities to
 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.
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.
126 */
127enum ieee802154_hw_flags {
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),
136};
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)
141
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 *
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 *
162 *	  WARNING:
163 *	  This will be deprecated soon. We don't accept synced xmit callbacks
164 *	  drivers anymore.
165 *
166 * xmit_async:
167 *	  Handler that 802.15.4 module calls for each transmitted frame.
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.
171 *	  This function should return zero or negative errno.
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.
187 *
188 * set_txpower:
189 *	  Set radio transmit power in mBm. Called with pib_lock held.
190 *	  Returns either zero, or negative errno.
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.
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.
200 *
201 * set_cca_ed_level
202 *	  Sets the CCA energy detection threshold in mBm. Called with pib_lock
203 *	  held.
204 *	  Returns either zero, or negative errno.
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.
213 *
214 * set_promiscuous_mode
215 *	  Enables or disable promiscuous mode.
216 */
217struct ieee802154_ops {
218	struct module	*owner;
219	int		(*start)(struct ieee802154_hw *hw);
220	void		(*stop)(struct ieee802154_hw *hw);
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);
225	int		(*ed)(struct ieee802154_hw *hw, u8 *level);
226	int		(*set_channel)(struct ieee802154_hw *hw, u8 page,
227				       u8 channel);
228	int		(*set_hw_addr_filt)(struct ieee802154_hw *hw,
229					    struct ieee802154_hw_addr_filt *filt,
230					    unsigned long changed);
231	int		(*set_txpower)(struct ieee802154_hw *hw, s32 mbm);
232	int		(*set_lbt)(struct ieee802154_hw *hw, bool on);
233	int		(*set_cca_mode)(struct ieee802154_hw *hw,
234					const struct wpan_phy_cca *cca);
235	int		(*set_cca_ed_level)(struct ieee802154_hw *hw, s32 mbm);
236	int		(*set_csma_params)(struct ieee802154_hw *hw,
237					   u8 min_be, u8 max_be, u8 retries);
238	int		(*set_frame_retries)(struct ieee802154_hw *hw,
239					     s8 retries);
240	int             (*set_promiscuous_mode)(struct ieee802154_hw *hw,
241						const bool on);
242};
243
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 */
248static inline __le16 ieee802154_get_fc_from_skb(const struct sk_buff *skb)
249{
 
 
250	/* check if we can fc at skb_mac_header of sk buffer */
251	if (unlikely(!skb_mac_header_was_set(skb) ||
252		     (skb_tail_pointer(skb) - skb_mac_header(skb)) < 2)) {
253		WARN_ON(1);
254		return cpu_to_le16(0);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
255	}
256
257	return get_unaligned_le16(skb_mac_header(skb));
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
258}
259
260/**
261 * ieee802154_be64_to_le64 - copies and convert be64 to le64
262 * @le64_dst: le64 destination pointer
263 * @be64_src: be64 source pointer
264 */
265static inline void ieee802154_be64_to_le64(void *le64_dst, const void *be64_src)
266{
267	put_unaligned_le64(get_unaligned_be64(be64_src), le64_dst);
268}
269
270/**
271 * ieee802154_le64_to_be64 - copies and convert le64 to be64
272 * @be64_dst: be64 destination pointer
273 * @le64_src: le64 source pointer
274 */
275static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
276{
277	put_unaligned_be64(get_unaligned_le64(le64_src), be64_dst);
278}
279
280/**
281 * ieee802154_le16_to_be16 - copies and convert le16 to be16
282 * @be16_dst: be16 destination pointer
283 * @le16_src: le16 source pointer
284 */
285static inline void ieee802154_le16_to_be16(void *be16_dst, const void *le16_src)
286{
287	put_unaligned_be16(get_unaligned_le16(le16_src), be16_dst);
 
 
 
 
 
 
 
 
 
 
288}
289
290/**
291 * ieee802154_alloc_hw - Allocate a new hardware device
292 *
293 * This must be called once for each hardware device. The returned pointer
294 * must be used to refer to this device when calling other functions.
295 * mac802154 allocates a private data area for the driver pointed to by
296 * @priv in &struct ieee802154_hw, the size of this area is given as
297 * @priv_data_len.
298 *
299 * @priv_data_len: length of private data
300 * @ops: callbacks for this device
301 *
302 * Return: A pointer to the new hardware device, or %NULL on error.
303 */
304struct ieee802154_hw *
305ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
306
307/**
308 * ieee802154_free_hw - free hardware descriptor
309 *
310 * This function frees everything that was allocated, including the
311 * private data for the driver. You must call ieee802154_unregister_hw()
312 * before calling this function.
313 *
314 * @hw: the hardware to free
315 */
316void ieee802154_free_hw(struct ieee802154_hw *hw);
317
318/**
319 * ieee802154_register_hw - Register hardware device
320 *
321 * You must call this function before any other functions in
322 * mac802154. Note that before a hardware can be registered, you
323 * need to fill the contained wpan_phy's information.
324 *
325 * @hw: the device to register as returned by ieee802154_alloc_hw()
326 *
327 * Return: 0 on success. An error code otherwise.
328 */
329int ieee802154_register_hw(struct ieee802154_hw *hw);
330
331/**
332 * ieee802154_unregister_hw - Unregister a hardware device
333 *
334 * This function instructs mac802154 to free allocated resources
335 * and unregister netdevices from the networking subsystem.
336 *
337 * @hw: the hardware to unregister
338 */
339void ieee802154_unregister_hw(struct ieee802154_hw *hw);
340
341/**
342 * ieee802154_rx_irqsafe - receive frame
343 *
344 * Like ieee802154_rx() but can be called in IRQ context
345 * (internally defers to a tasklet.)
346 *
347 * @hw: the hardware this frame came in on
348 * @skb: the buffer to receive, owned by mac802154 after this call
349 * @lqi: link quality indicator
350 */
351void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
352			   u8 lqi);
353/**
354 * ieee802154_wake_queue - wake ieee802154 queue
355 * @hw: pointer as obtained from ieee802154_alloc_hw().
356 *
357 * Drivers should use this function instead of netif_wake_queue.
358 */
359void ieee802154_wake_queue(struct ieee802154_hw *hw);
360
361/**
362 * ieee802154_stop_queue - stop ieee802154 queue
363 * @hw: pointer as obtained from ieee802154_alloc_hw().
364 *
365 * Drivers should use this function instead of netif_stop_queue.
366 */
367void ieee802154_stop_queue(struct ieee802154_hw *hw);
368
369/**
370 * ieee802154_xmit_complete - frame transmission complete
371 *
372 * @hw: pointer as obtained from ieee802154_alloc_hw().
373 * @skb: buffer for transmission
374 * @ifs_handling: indicate interframe space handling
375 */
376void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
377			      bool ifs_handling);
378
379#endif /* NET_MAC802154_H */
v4.17
  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 *
 15 */
 16#ifndef NET_MAC802154_H
 17#define NET_MAC802154_H
 18
 19#include <asm/unaligned.h>
 20#include <net/af_ieee802154.h>
 21#include <linux/ieee802154.h>
 22#include <linux/skbuff.h>
 23
 24#include <net/cfg802154.h>
 25
 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
 30 * the stack to the hardware.
 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.
 42 */
 43enum ieee802154_hw_addr_filt_flags {
 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),
 48};
 49
 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 */
 62struct ieee802154_hw_addr_filt {
 63	__le16	pan_id;
 64	__le16	short_addr;
 65	__le64	ieee_addr;
 66	bool	pan_coord;
 67};
 68
 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 */
 84struct ieee802154_hw {
 85	/* filled by the driver */
 86	int	extra_tx_headroom;
 87	u32	flags;
 88	struct	device *parent;
 89	void	*priv;
 90
 91	/* filled by mac802154 core */
 92	struct	wpan_phy *phy;
 93};
 94
 95/**
 96 * enum ieee802154_hw_flags - hardware flags
 97 *
 98 * These flags are used to indicate hardware capabilities to
 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.
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.
126 */
127enum ieee802154_hw_flags {
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),
136};
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)
141
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 *
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 *
162 *	  WARNING:
163 *	  This will be deprecated soon. We don't accept synced xmit callbacks
164 *	  drivers anymore.
165 *
166 * xmit_async:
167 *	  Handler that 802.15.4 module calls for each transmitted frame.
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.
171 *	  This function should return zero or negative errno.
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.
187 *
188 * set_txpower:
189 *	  Set radio transmit power in mBm. Called with pib_lock held.
190 *	  Returns either zero, or negative errno.
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.
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.
200 *
201 * set_cca_ed_level
202 *	  Sets the CCA energy detection threshold in mBm. Called with pib_lock
203 *	  held.
204 *	  Returns either zero, or negative errno.
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.
213 *
214 * set_promiscuous_mode
215 *	  Enables or disable promiscuous mode.
216 */
217struct ieee802154_ops {
218	struct module	*owner;
219	int		(*start)(struct ieee802154_hw *hw);
220	void		(*stop)(struct ieee802154_hw *hw);
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);
225	int		(*ed)(struct ieee802154_hw *hw, u8 *level);
226	int		(*set_channel)(struct ieee802154_hw *hw, u8 page,
227				       u8 channel);
228	int		(*set_hw_addr_filt)(struct ieee802154_hw *hw,
229					    struct ieee802154_hw_addr_filt *filt,
230					    unsigned long changed);
231	int		(*set_txpower)(struct ieee802154_hw *hw, s32 mbm);
232	int		(*set_lbt)(struct ieee802154_hw *hw, bool on);
233	int		(*set_cca_mode)(struct ieee802154_hw *hw,
234					const struct wpan_phy_cca *cca);
235	int		(*set_cca_ed_level)(struct ieee802154_hw *hw, s32 mbm);
236	int		(*set_csma_params)(struct ieee802154_hw *hw,
237					   u8 min_be, u8 max_be, u8 retries);
238	int		(*set_frame_retries)(struct ieee802154_hw *hw,
239					     s8 retries);
240	int             (*set_promiscuous_mode)(struct ieee802154_hw *hw,
241						const bool on);
242};
243
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 */
248static inline __le16 ieee802154_get_fc_from_skb(const struct sk_buff *skb)
249{
250	__le16 fc;
251
252	/* check if we can fc at skb_mac_header of sk buffer */
253	if (WARN_ON(!skb_mac_header_was_set(skb) ||
254		    (skb_tail_pointer(skb) -
255		     skb_mac_header(skb)) < IEEE802154_FC_LEN))
256		return cpu_to_le16(0);
257
258	memcpy(&fc, skb_mac_header(skb), IEEE802154_FC_LEN);
259	return fc;
260}
261
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 */
267static 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
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 */
296static 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
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 */
356static 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
369/**
370 * ieee802154_be64_to_le64 - copies and convert be64 to le64
371 * @le64_dst: le64 destination pointer
372 * @be64_src: be64 source pointer
373 */
374static inline void ieee802154_be64_to_le64(void *le64_dst, const void *be64_src)
375{
376	put_unaligned_le64(get_unaligned_be64(be64_src), le64_dst);
377}
378
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 */
384static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
385{
386	put_unaligned_be64(get_unaligned_le64(le64_src), be64_dst);
387}
388
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 */
394static inline void ieee802154_le16_to_be16(void *be16_dst, const void *le16_src)
395{
396	put_unaligned_be16(get_unaligned_le16(le16_src), be16_dst);
397}
398
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 */
404static 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
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 */
423struct ieee802154_hw *
424ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
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 */
435void ieee802154_free_hw(struct ieee802154_hw *hw);
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 */
448int ieee802154_register_hw(struct ieee802154_hw *hw);
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 */
458void ieee802154_unregister_hw(struct ieee802154_hw *hw);
459
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 */
470void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
471			   u8 lqi);
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 */
478void ieee802154_wake_queue(struct ieee802154_hw *hw);
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 */
486void ieee802154_stop_queue(struct ieee802154_hw *hw);
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 */
495void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
496			      bool ifs_handling);
497
498#endif /* NET_MAC802154_H */