2 * An interface between IEEE802.15.4 device and rest of the kernel.
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.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
21 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
22 * Maxim Osipov <maxim.osipov@siemens.com>
23 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
24 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
27 #ifndef IEEE802154_NETDEVICE_H
28 #define IEEE802154_NETDEVICE_H
30 #include <net/af_ieee802154.h>
31 #include <linux/netdevice.h>
32 #include <linux/skbuff.h>
34 struct ieee802154_sechdr
{
35 #if defined(__LITTLE_ENDIAN_BITFIELD)
39 #elif defined(__BIG_ENDIAN_BITFIELD)
44 #error "Please fix <asm/byteorder.h>"
54 struct ieee802154_addr
{
63 struct ieee802154_hdr_fc
{
64 #if defined(__LITTLE_ENDIAN_BITFIELD)
74 #elif defined(__BIG_ENDIAN_BITFIELD)
86 #error "Please fix <asm/byteorder.h>"
90 struct ieee802154_hdr
{
91 struct ieee802154_hdr_fc fc
;
93 struct ieee802154_addr source
;
94 struct ieee802154_addr dest
;
95 struct ieee802154_sechdr sec
;
98 /* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
99 * the contents of hdr will be, and the actual value of those bits in
100 * hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
101 * version, if SECEN is set.
103 int ieee802154_hdr_push(struct sk_buff
*skb
, const struct ieee802154_hdr
*hdr
);
105 /* pulls the entire 802.15.4 header off of the skb, including the security
106 * header, and performs pan id decompression
108 int ieee802154_hdr_pull(struct sk_buff
*skb
, struct ieee802154_hdr
*hdr
);
110 /* parses the frame control, sequence number of address fields in a given skb
111 * and stores them into hdr, performing pan id decompression and length checks
112 * to be suitable for use in header_ops.parse
114 int ieee802154_hdr_peek_addrs(const struct sk_buff
*skb
,
115 struct ieee802154_hdr
*hdr
);
117 static inline int ieee802154_hdr_length(struct sk_buff
*skb
)
119 struct ieee802154_hdr hdr
;
120 int len
= ieee802154_hdr_pull(skb
, &hdr
);
128 static inline bool ieee802154_addr_equal(const struct ieee802154_addr
*a1
,
129 const struct ieee802154_addr
*a2
)
131 if (a1
->pan_id
!= a2
->pan_id
|| a1
->mode
!= a2
->mode
)
134 if ((a1
->mode
== IEEE802154_ADDR_LONG
&&
135 a1
->extended_addr
!= a2
->extended_addr
) ||
136 (a1
->mode
== IEEE802154_ADDR_SHORT
&&
137 a1
->short_addr
!= a2
->short_addr
))
143 static inline __le64
ieee802154_devaddr_from_raw(const void *raw
)
147 memcpy(&temp
, raw
, IEEE802154_ADDR_LEN
);
148 return (__force __le64
)swab64(temp
);
151 static inline void ieee802154_devaddr_to_raw(void *raw
, __le64 addr
)
153 u64 temp
= swab64((__force u64
)addr
);
155 memcpy(raw
, &temp
, IEEE802154_ADDR_LEN
);
158 static inline void ieee802154_addr_from_sa(struct ieee802154_addr
*a
,
159 const struct ieee802154_addr_sa
*sa
)
161 a
->mode
= sa
->addr_type
;
162 a
->pan_id
= cpu_to_le16(sa
->pan_id
);
165 case IEEE802154_ADDR_SHORT
:
166 a
->short_addr
= cpu_to_le16(sa
->short_addr
);
168 case IEEE802154_ADDR_LONG
:
169 a
->extended_addr
= ieee802154_devaddr_from_raw(sa
->hwaddr
);
174 static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa
*sa
,
175 const struct ieee802154_addr
*a
)
177 sa
->addr_type
= a
->mode
;
178 sa
->pan_id
= le16_to_cpu(a
->pan_id
);
181 case IEEE802154_ADDR_SHORT
:
182 sa
->short_addr
= le16_to_cpu(a
->short_addr
);
184 case IEEE802154_ADDR_LONG
:
185 ieee802154_devaddr_to_raw(sa
->hwaddr
, a
->extended_addr
);
191 * A control block of skb passed between the ARPHRD_IEEE802154 device
192 * and other stack parts.
194 struct ieee802154_mac_cb
{
198 struct ieee802154_addr source
;
199 struct ieee802154_addr dest
;
202 static inline struct ieee802154_mac_cb
*mac_cb(struct sk_buff
*skb
)
204 return (struct ieee802154_mac_cb
*)skb
->cb
;
207 #define MAC_CB_FLAG_TYPEMASK ((1 << 3) - 1)
209 #define MAC_CB_FLAG_ACKREQ (1 << 3)
210 #define MAC_CB_FLAG_SECEN (1 << 4)
212 static inline bool mac_cb_is_ackreq(struct sk_buff
*skb
)
214 return mac_cb(skb
)->flags
& MAC_CB_FLAG_ACKREQ
;
217 static inline bool mac_cb_is_secen(struct sk_buff
*skb
)
219 return mac_cb(skb
)->flags
& MAC_CB_FLAG_SECEN
;
222 static inline int mac_cb_type(struct sk_buff
*skb
)
224 return mac_cb(skb
)->flags
& MAC_CB_FLAG_TYPEMASK
;
227 #define IEEE802154_MAC_SCAN_ED 0
228 #define IEEE802154_MAC_SCAN_ACTIVE 1
229 #define IEEE802154_MAC_SCAN_PASSIVE 2
230 #define IEEE802154_MAC_SCAN_ORPHAN 3
232 struct ieee802154_mac_params
{
246 * This should be located at net_device->ml_priv
248 * get_phy should increment the reference counting on returned phy.
249 * Use wpan_wpy_put to put that reference.
251 struct ieee802154_mlme_ops
{
252 /* The following fields are optional (can be NULL). */
254 int (*assoc_req
)(struct net_device
*dev
,
255 struct ieee802154_addr
*addr
,
256 u8 channel
, u8 page
, u8 cap
);
257 int (*assoc_resp
)(struct net_device
*dev
,
258 struct ieee802154_addr
*addr
,
259 __le16 short_addr
, u8 status
);
260 int (*disassoc_req
)(struct net_device
*dev
,
261 struct ieee802154_addr
*addr
,
263 int (*start_req
)(struct net_device
*dev
,
264 struct ieee802154_addr
*addr
,
265 u8 channel
, u8 page
, u8 bcn_ord
, u8 sf_ord
,
266 u8 pan_coord
, u8 blx
, u8 coord_realign
);
267 int (*scan_req
)(struct net_device
*dev
,
268 u8 type
, u32 channels
, u8 page
, u8 duration
);
270 int (*set_mac_params
)(struct net_device
*dev
,
271 const struct ieee802154_mac_params
*params
);
272 void (*get_mac_params
)(struct net_device
*dev
,
273 struct ieee802154_mac_params
*params
);
275 /* The fields below are required. */
277 struct wpan_phy
*(*get_phy
)(const struct net_device
*dev
);
280 * FIXME: these should become the part of PIB/MIB interface.
281 * However we still don't have IB interface of any kind
283 __le16 (*get_pan_id
)(const struct net_device
*dev
);
284 __le16 (*get_short_addr
)(const struct net_device
*dev
);
285 u8 (*get_dsn
)(const struct net_device
*dev
);
288 /* The IEEE 802.15.4 standard defines 2 type of the devices:
289 * - FFD - full functionality device
290 * - RFD - reduce functionality device
292 * So 2 sets of mlme operations are needed
294 struct ieee802154_reduced_mlme_ops
{
295 struct wpan_phy
*(*get_phy
)(const struct net_device
*dev
);
298 static inline struct ieee802154_mlme_ops
*
299 ieee802154_mlme_ops(const struct net_device
*dev
)
304 static inline struct ieee802154_reduced_mlme_ops
*
305 ieee802154_reduced_mlme_ops(const struct net_device
*dev
)