Merge branch 'fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/evalenti/linux...
[linux/fpc-iii.git] / include / net / mac802154.h
blob6cd7a70706a90a0427920fa2820c5493a2d3f9fb
1 /*
2 * IEEE802.15.4-2003 specification
4 * Copyright (C) 2007-2012 Siemens AG
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.
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.
16 #ifndef NET_MAC802154_H
17 #define NET_MAC802154_H
19 #include <asm/unaligned.h>
20 #include <net/af_ieee802154.h>
21 #include <linux/ieee802154.h>
22 #include <linux/skbuff.h>
24 #include <net/cfg802154.h>
26 /**
27 * enum ieee802154_hw_addr_filt_flags - hardware address filtering flags
29 * The following flags are used to indicate changed address settings from
30 * the stack to the hardware.
32 * @IEEE802154_AFILT_SADDR_CHANGED: Indicates that the short address will be
33 * change.
35 * @IEEE802154_AFILT_IEEEADDR_CHANGED: Indicates that the extended address
36 * will be change.
38 * @IEEE802154_AFILT_PANID_CHANGED: Indicates that the pan id will be change.
40 * @IEEE802154_AFILT_PANC_CHANGED: Indicates that the address filter will
41 * do frame address filtering as a pan coordinator.
43 enum 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),
50 /**
51 * struct ieee802154_hw_addr_filt - hardware address filtering settings
53 * @pan_id: pan_id which should be set to the hardware address filter.
55 * @short_addr: short_addr which should be set to the hardware address filter.
57 * @ieee_addr: extended address which should be set to the hardware address
58 * filter.
60 * @pan_coord: boolean if hardware filtering should be operate as coordinator.
62 struct ieee802154_hw_addr_filt {
63 __le16 pan_id;
64 __le16 short_addr;
65 __le64 ieee_addr;
66 bool pan_coord;
69 /**
70 * struct ieee802154_hw - ieee802154 hardware
72 * @extra_tx_headroom: headroom to reserve in each transmit skb for use by the
73 * driver (e.g. for transmit headers.)
75 * @flags: hardware flags, see &enum ieee802154_hw_flags
77 * @parent: parent device of the hardware.
79 * @priv: pointer to private area that was allocated for driver use along with
80 * this structure.
82 * @phy: This points to the &struct wpan_phy allocated for this 802.15.4 PHY.
84 struct ieee802154_hw {
85 /* filled by the driver */
86 int extra_tx_headroom;
87 u32 flags;
88 struct device *parent;
89 void *priv;
91 /* filled by mac802154 core */
92 struct wpan_phy *phy;
95 /**
96 * enum ieee802154_hw_flags - hardware flags
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.
104 * @IEEE802154_HW_TX_OMIT_CKSUM: Indicates that xmitter will add FCS on it's
105 * own.
107 * @IEEE802154_HW_LBT: Indicates that transceiver will support listen before
108 * transmit.
110 * @IEEE802154_HW_CSMA_PARAMS: Indicates that transceiver will support csma
111 * parameters (max_be, min_be, backoff exponents).
113 * @IEEE802154_HW_FRAME_RETRIES: Indicates that transceiver will support ARET
114 * frame retries setting.
116 * @IEEE802154_HW_AFILT: Indicates that transceiver will support hardware
117 * address filter setting.
119 * @IEEE802154_HW_PROMISCUOUS: Indicates that transceiver will support
120 * promiscuous mode setting.
122 * @IEEE802154_HW_RX_OMIT_CKSUM: Indicates that receiver omits FCS.
124 * @IEEE802154_HW_RX_DROP_BAD_CKSUM: Indicates that receiver will not filter
125 * frames with bad checksum.
127 enum 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),
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)
142 /* struct ieee802154_ops - callbacks from mac802154 to the driver
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.
148 * start: Handler that 802.15.4 module calls for device initialization.
149 * This function is called before the first interface is attached.
151 * stop: Handler that 802.15.4 module calls for device cleanup.
152 * This function is called after the last interface is removed.
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.
162 * WARNING:
163 * This will be deprecated soon. We don't accept synced xmit callbacks
164 * drivers anymore.
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.
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.
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.
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.
188 * set_txpower:
189 * Set radio transmit power in mBm. Called with pib_lock held.
190 * Returns either zero, or negative errno.
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.
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.
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.
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.
210 * set_frame_retries
211 * Sets the retransmission attempt limit. Called with pib_lock held.
212 * Returns either zero, or negative errno.
214 * set_promiscuous_mode
215 * Enables or disable promiscuous mode.
217 struct 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);
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
248 static inline __le16 ieee802154_get_fc_from_skb(const struct sk_buff *skb)
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);
257 return get_unaligned_le16(skb_mac_header(skb));
261 * ieee802154_be64_to_le64 - copies and convert be64 to le64
262 * @le64_dst: le64 destination pointer
263 * @be64_src: be64 source pointer
265 static inline void ieee802154_be64_to_le64(void *le64_dst, const void *be64_src)
267 put_unaligned_le64(get_unaligned_be64(be64_src), le64_dst);
271 * ieee802154_le64_to_be64 - copies and convert le64 to be64
272 * @be64_dst: be64 destination pointer
273 * @le64_src: le64 source pointer
275 static inline void ieee802154_le64_to_be64(void *be64_dst, const void *le64_src)
277 put_unaligned_be64(get_unaligned_le64(le64_src), be64_dst);
281 * ieee802154_le16_to_be16 - copies and convert le16 to be16
282 * @be16_dst: be16 destination pointer
283 * @le16_src: le16 source pointer
285 static inline void ieee802154_le16_to_be16(void *be16_dst, const void *le16_src)
287 put_unaligned_be16(get_unaligned_le16(le16_src), be16_dst);
291 * ieee802154_alloc_hw - Allocate a new hardware device
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.
299 * @priv_data_len: length of private data
300 * @ops: callbacks for this device
302 * Return: A pointer to the new hardware device, or %NULL on error.
304 struct ieee802154_hw *
305 ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops);
308 * ieee802154_free_hw - free hardware descriptor
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.
314 * @hw: the hardware to free
316 void ieee802154_free_hw(struct ieee802154_hw *hw);
319 * ieee802154_register_hw - Register hardware device
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.
325 * @hw: the device to register as returned by ieee802154_alloc_hw()
327 * Return: 0 on success. An error code otherwise.
329 int ieee802154_register_hw(struct ieee802154_hw *hw);
332 * ieee802154_unregister_hw - Unregister a hardware device
334 * This function instructs mac802154 to free allocated resources
335 * and unregister netdevices from the networking subsystem.
337 * @hw: the hardware to unregister
339 void ieee802154_unregister_hw(struct ieee802154_hw *hw);
342 * ieee802154_rx_irqsafe - receive frame
344 * Like ieee802154_rx() but can be called in IRQ context
345 * (internally defers to a tasklet.)
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
351 void ieee802154_rx_irqsafe(struct ieee802154_hw *hw, struct sk_buff *skb,
352 u8 lqi);
354 * ieee802154_wake_queue - wake ieee802154 queue
355 * @hw: pointer as obtained from ieee802154_alloc_hw().
357 * Drivers should use this function instead of netif_wake_queue.
359 void ieee802154_wake_queue(struct ieee802154_hw *hw);
362 * ieee802154_stop_queue - stop ieee802154 queue
363 * @hw: pointer as obtained from ieee802154_alloc_hw().
365 * Drivers should use this function instead of netif_stop_queue.
367 void ieee802154_stop_queue(struct ieee802154_hw *hw);
370 * ieee802154_xmit_complete - frame transmission complete
372 * @hw: pointer as obtained from ieee802154_alloc_hw().
373 * @skb: buffer for transmission
374 * @ifs_handling: indicate interframe space handling
376 void ieee802154_xmit_complete(struct ieee802154_hw *hw, struct sk_buff *skb,
377 bool ifs_handling);
379 #endif /* NET_MAC802154_H */