1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * An interface between IEEE802.15.4 device and rest of the kernel.
5 * Copyright (C) 2007-2012 Siemens AG
8 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
9 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
10 * Maxim Osipov <maxim.osipov@siemens.com>
11 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
12 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
15 #ifndef IEEE802154_NETDEVICE_H
16 #define IEEE802154_NETDEVICE_H
18 #define IEEE802154_REQUIRED_SIZE(struct_type, member) \
19 (offsetof(typeof(struct_type), member) + \
20 sizeof(((typeof(struct_type) *)(NULL))->member))
22 #define IEEE802154_ADDR_OFFSET \
23 offsetof(typeof(struct sockaddr_ieee802154), addr)
25 #define IEEE802154_MIN_NAMELEN (IEEE802154_ADDR_OFFSET + \
26 IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, addr_type))
28 #define IEEE802154_NAMELEN_SHORT (IEEE802154_ADDR_OFFSET + \
29 IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, short_addr))
31 #define IEEE802154_NAMELEN_LONG (IEEE802154_ADDR_OFFSET + \
32 IEEE802154_REQUIRED_SIZE(struct ieee802154_addr_sa, hwaddr))
34 #include <net/af_ieee802154.h>
35 #include <linux/netdevice.h>
36 #include <linux/skbuff.h>
37 #include <linux/ieee802154.h>
39 #include <net/cfg802154.h>
41 struct ieee802154_sechdr {
42 #if defined(__LITTLE_ENDIAN_BITFIELD)
46 #elif defined(__BIG_ENDIAN_BITFIELD)
51 #error "Please fix <asm/byteorder.h>"
61 struct ieee802154_hdr_fc {
62 #if defined(__LITTLE_ENDIAN_BITFIELD)
72 #elif defined(__BIG_ENDIAN_BITFIELD)
84 #error "Please fix <asm/byteorder.h>"
88 enum ieee802154_frame_version {
92 IEEE802154_RESERVED_STD,
93 IEEE802154_MULTIPURPOSE_STD = IEEE802154_2003_STD,
96 struct ieee802154_hdr {
97 struct ieee802154_hdr_fc fc;
99 struct ieee802154_addr source;
100 struct ieee802154_addr dest;
101 struct ieee802154_sechdr sec;
104 /* pushes hdr onto the skb. fields of hdr->fc that can be calculated from
105 * the contents of hdr will be, and the actual value of those bits in
106 * hdr->fc will be ignored. this includes the INTRA_PAN bit and the frame
107 * version, if SECEN is set.
109 int ieee802154_hdr_push(struct sk_buff *skb, struct ieee802154_hdr *hdr);
111 /* pulls the entire 802.15.4 header off of the skb, including the security
112 * header, and performs pan id decompression
114 int ieee802154_hdr_pull(struct sk_buff *skb, struct ieee802154_hdr *hdr);
116 /* parses the frame control, sequence number of address fields in a given skb
117 * and stores them into hdr, performing pan id decompression and length checks
118 * to be suitable for use in header_ops.parse
120 int ieee802154_hdr_peek_addrs(const struct sk_buff *skb,
121 struct ieee802154_hdr *hdr);
123 /* parses the full 802.15.4 header a given skb and stores them into hdr,
124 * performing pan id decompression and length checks to be suitable for use in
127 int ieee802154_hdr_peek(const struct sk_buff *skb, struct ieee802154_hdr *hdr);
129 int ieee802154_max_payload(const struct ieee802154_hdr *hdr);
132 ieee802154_sechdr_authtag_len(const struct ieee802154_sechdr *sec)
134 switch (sec->level) {
135 case IEEE802154_SCF_SECLEVEL_MIC32:
136 case IEEE802154_SCF_SECLEVEL_ENC_MIC32:
138 case IEEE802154_SCF_SECLEVEL_MIC64:
139 case IEEE802154_SCF_SECLEVEL_ENC_MIC64:
141 case IEEE802154_SCF_SECLEVEL_MIC128:
142 case IEEE802154_SCF_SECLEVEL_ENC_MIC128:
144 case IEEE802154_SCF_SECLEVEL_NONE:
145 case IEEE802154_SCF_SECLEVEL_ENC:
151 static inline int ieee802154_hdr_length(struct sk_buff *skb)
153 struct ieee802154_hdr hdr;
154 int len = ieee802154_hdr_pull(skb, &hdr);
162 static inline bool ieee802154_addr_equal(const struct ieee802154_addr *a1,
163 const struct ieee802154_addr *a2)
165 if (a1->pan_id != a2->pan_id || a1->mode != a2->mode)
168 if ((a1->mode == IEEE802154_ADDR_LONG &&
169 a1->extended_addr != a2->extended_addr) ||
170 (a1->mode == IEEE802154_ADDR_SHORT &&
171 a1->short_addr != a2->short_addr))
177 static inline __le64 ieee802154_devaddr_from_raw(const void *raw)
181 memcpy(&temp, raw, IEEE802154_ADDR_LEN);
182 return (__force __le64)swab64(temp);
185 static inline void ieee802154_devaddr_to_raw(void *raw, __le64 addr)
187 u64 temp = swab64((__force u64)addr);
189 memcpy(raw, &temp, IEEE802154_ADDR_LEN);
193 ieee802154_sockaddr_check_size(struct sockaddr_ieee802154 *daddr, int len)
195 struct ieee802154_addr_sa *sa;
199 if (len < IEEE802154_MIN_NAMELEN)
201 switch (sa->addr_type) {
202 case IEEE802154_ADDR_NONE:
204 case IEEE802154_ADDR_SHORT:
205 if (len < IEEE802154_NAMELEN_SHORT)
208 case IEEE802154_ADDR_LONG:
209 if (len < IEEE802154_NAMELEN_LONG)
219 static inline void ieee802154_addr_from_sa(struct ieee802154_addr *a,
220 const struct ieee802154_addr_sa *sa)
222 a->mode = sa->addr_type;
223 a->pan_id = cpu_to_le16(sa->pan_id);
226 case IEEE802154_ADDR_SHORT:
227 a->short_addr = cpu_to_le16(sa->short_addr);
229 case IEEE802154_ADDR_LONG:
230 a->extended_addr = ieee802154_devaddr_from_raw(sa->hwaddr);
235 static inline void ieee802154_addr_to_sa(struct ieee802154_addr_sa *sa,
236 const struct ieee802154_addr *a)
238 sa->addr_type = a->mode;
239 sa->pan_id = le16_to_cpu(a->pan_id);
242 case IEEE802154_ADDR_SHORT:
243 sa->short_addr = le16_to_cpu(a->short_addr);
245 case IEEE802154_ADDR_LONG:
246 ieee802154_devaddr_to_raw(sa->hwaddr, a->extended_addr);
252 * A control block of skb passed between the ARPHRD_IEEE802154 device
253 * and other stack parts.
255 struct ieee802154_mac_cb {
262 bool seclevel_override;
263 struct ieee802154_addr source;
264 struct ieee802154_addr dest;
267 static inline struct ieee802154_mac_cb *mac_cb(struct sk_buff *skb)
269 return (struct ieee802154_mac_cb *)skb->cb;
272 static inline struct ieee802154_mac_cb *mac_cb_init(struct sk_buff *skb)
274 BUILD_BUG_ON(sizeof(struct ieee802154_mac_cb) > sizeof(skb->cb));
276 memset(skb->cb, 0, sizeof(struct ieee802154_mac_cb));
281 IEEE802154_LLSEC_DEVKEY_IGNORE,
282 IEEE802154_LLSEC_DEVKEY_RESTRICT,
283 IEEE802154_LLSEC_DEVKEY_RECORD,
285 __IEEE802154_LLSEC_DEVKEY_MAX,
288 #define IEEE802154_MAC_SCAN_ED 0
289 #define IEEE802154_MAC_SCAN_ACTIVE 1
290 #define IEEE802154_MAC_SCAN_PASSIVE 2
291 #define IEEE802154_MAC_SCAN_ORPHAN 3
293 struct ieee802154_mac_params {
301 struct wpan_phy_cca cca;
308 IEEE802154_LLSEC_PARAM_ENABLED = BIT(0),
309 IEEE802154_LLSEC_PARAM_FRAME_COUNTER = BIT(1),
310 IEEE802154_LLSEC_PARAM_OUT_LEVEL = BIT(2),
311 IEEE802154_LLSEC_PARAM_OUT_KEY = BIT(3),
312 IEEE802154_LLSEC_PARAM_KEY_SOURCE = BIT(4),
313 IEEE802154_LLSEC_PARAM_PAN_ID = BIT(5),
314 IEEE802154_LLSEC_PARAM_HWADDR = BIT(6),
315 IEEE802154_LLSEC_PARAM_COORD_HWADDR = BIT(7),
316 IEEE802154_LLSEC_PARAM_COORD_SHORTADDR = BIT(8),
319 struct ieee802154_llsec_ops {
320 int (*get_params)(struct net_device *dev,
321 struct ieee802154_llsec_params *params);
322 int (*set_params)(struct net_device *dev,
323 const struct ieee802154_llsec_params *params,
326 int (*add_key)(struct net_device *dev,
327 const struct ieee802154_llsec_key_id *id,
328 const struct ieee802154_llsec_key *key);
329 int (*del_key)(struct net_device *dev,
330 const struct ieee802154_llsec_key_id *id);
332 int (*add_dev)(struct net_device *dev,
333 const struct ieee802154_llsec_device *llsec_dev);
334 int (*del_dev)(struct net_device *dev, __le64 dev_addr);
336 int (*add_devkey)(struct net_device *dev,
338 const struct ieee802154_llsec_device_key *key);
339 int (*del_devkey)(struct net_device *dev,
341 const struct ieee802154_llsec_device_key *key);
343 int (*add_seclevel)(struct net_device *dev,
344 const struct ieee802154_llsec_seclevel *sl);
345 int (*del_seclevel)(struct net_device *dev,
346 const struct ieee802154_llsec_seclevel *sl);
348 void (*lock_table)(struct net_device *dev);
349 void (*get_table)(struct net_device *dev,
350 struct ieee802154_llsec_table **t);
351 void (*unlock_table)(struct net_device *dev);
354 * This should be located at net_device->ml_priv
356 * get_phy should increment the reference counting on returned phy.
357 * Use wpan_wpy_put to put that reference.
359 struct ieee802154_mlme_ops {
360 /* The following fields are optional (can be NULL). */
362 int (*assoc_req)(struct net_device *dev,
363 struct ieee802154_addr *addr,
364 u8 channel, u8 page, u8 cap);
365 int (*assoc_resp)(struct net_device *dev,
366 struct ieee802154_addr *addr,
367 __le16 short_addr, u8 status);
368 int (*disassoc_req)(struct net_device *dev,
369 struct ieee802154_addr *addr,
371 int (*start_req)(struct net_device *dev,
372 struct ieee802154_addr *addr,
373 u8 channel, u8 page, u8 bcn_ord, u8 sf_ord,
374 u8 pan_coord, u8 blx, u8 coord_realign);
375 int (*scan_req)(struct net_device *dev,
376 u8 type, u32 channels, u8 page, u8 duration);
378 int (*set_mac_params)(struct net_device *dev,
379 const struct ieee802154_mac_params *params);
380 void (*get_mac_params)(struct net_device *dev,
381 struct ieee802154_mac_params *params);
383 const struct ieee802154_llsec_ops *llsec;
386 static inline struct ieee802154_mlme_ops *
387 ieee802154_mlme_ops(const struct net_device *dev)