Commit | Line | Data |
---|---|---|
2bfb1070 DES |
1 | /* |
2 | * Copyright (C) 2007, 2008, 2009 Siemens AG | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify | |
5 | * it under the terms of the GNU General Public License version 2 | |
6 | * as published by the Free Software Foundation. | |
7 | * | |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
2bfb1070 DES |
13 | * Written by: |
14 | * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com> | |
15 | */ | |
16 | ||
5ad60d36 AA |
17 | #ifndef __NET_CFG802154_H |
18 | #define __NET_CFG802154_H | |
2bfb1070 | 19 | |
cb41c8dd | 20 | #include <linux/ieee802154.h> |
2bfb1070 DES |
21 | #include <linux/netdevice.h> |
22 | #include <linux/mutex.h> | |
187f1882 | 23 | #include <linux/bug.h> |
2bfb1070 | 24 | |
f3ea5e44 AA |
25 | #include <net/nl802154.h> |
26 | ||
a5dd1d72 | 27 | struct wpan_phy; |
ba2a9506 | 28 | struct wpan_phy_cca; |
a5dd1d72 | 29 | |
a26c5fd7 AA |
30 | #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL |
31 | struct ieee802154_llsec_device_key; | |
32 | struct ieee802154_llsec_seclevel; | |
33 | struct ieee802154_llsec_params; | |
34 | struct ieee802154_llsec_device; | |
35 | struct ieee802154_llsec_table; | |
36 | struct ieee802154_llsec_key_id; | |
37 | struct ieee802154_llsec_key; | |
38 | #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */ | |
39 | ||
a5dd1d72 | 40 | struct cfg802154_ops { |
4a9a816a AA |
41 | struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
42 | const char *name, | |
5b4a1039 | 43 | unsigned char name_assign_type, |
4a9a816a | 44 | int type); |
9d30a8cf AA |
45 | void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
46 | struct net_device *dev); | |
a6cb869b VB |
47 | int (*suspend)(struct wpan_phy *wpan_phy); |
48 | int (*resume)(struct wpan_phy *wpan_phy); | |
f3ea5e44 AA |
49 | int (*add_virtual_intf)(struct wpan_phy *wpan_phy, |
50 | const char *name, | |
5b4a1039 | 51 | unsigned char name_assign_type, |
0e57547e AA |
52 | enum nl802154_iftype type, |
53 | __le64 extended_addr); | |
b821ecd4 AA |
54 | int (*del_virtual_intf)(struct wpan_phy *wpan_phy, |
55 | struct wpan_dev *wpan_dev); | |
ab0bd561 | 56 | int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); |
ba2a9506 AA |
57 | int (*set_cca_mode)(struct wpan_phy *wpan_phy, |
58 | const struct wpan_phy_cca *cca); | |
b69644c1 | 59 | int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level); |
0f999b09 | 60 | int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power); |
702bf371 | 61 | int (*set_pan_id)(struct wpan_phy *wpan_phy, |
ee7b9053 | 62 | struct wpan_dev *wpan_dev, __le16 pan_id); |
9830c62a | 63 | int (*set_short_addr)(struct wpan_phy *wpan_phy, |
ee7b9053 | 64 | struct wpan_dev *wpan_dev, __le16 short_addr); |
656a999e AA |
65 | int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, |
66 | struct wpan_dev *wpan_dev, u8 min_be, | |
67 | u8 max_be); | |
a01ba765 AA |
68 | int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, |
69 | struct wpan_dev *wpan_dev, | |
70 | u8 max_csma_backoffs); | |
17a3a46b AA |
71 | int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, |
72 | struct wpan_dev *wpan_dev, | |
73 | s8 max_frame_retries); | |
c8937a1d AA |
74 | int (*set_lbt_mode)(struct wpan_phy *wpan_phy, |
75 | struct wpan_dev *wpan_dev, bool mode); | |
c91208d8 AA |
76 | int (*set_ackreq_default)(struct wpan_phy *wpan_phy, |
77 | struct wpan_dev *wpan_dev, bool ackreq); | |
a26c5fd7 AA |
78 | #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL |
79 | void (*get_llsec_table)(struct wpan_phy *wpan_phy, | |
80 | struct wpan_dev *wpan_dev, | |
81 | struct ieee802154_llsec_table **table); | |
82 | void (*lock_llsec_table)(struct wpan_phy *wpan_phy, | |
83 | struct wpan_dev *wpan_dev); | |
84 | void (*unlock_llsec_table)(struct wpan_phy *wpan_phy, | |
85 | struct wpan_dev *wpan_dev); | |
86 | /* TODO remove locking/get table callbacks, this is part of the | |
87 | * nl802154 interface and should be accessible from ieee802154 layer. | |
88 | */ | |
89 | int (*get_llsec_params)(struct wpan_phy *wpan_phy, | |
90 | struct wpan_dev *wpan_dev, | |
91 | struct ieee802154_llsec_params *params); | |
92 | int (*set_llsec_params)(struct wpan_phy *wpan_phy, | |
93 | struct wpan_dev *wpan_dev, | |
94 | const struct ieee802154_llsec_params *params, | |
95 | int changed); | |
96 | int (*add_llsec_key)(struct wpan_phy *wpan_phy, | |
97 | struct wpan_dev *wpan_dev, | |
98 | const struct ieee802154_llsec_key_id *id, | |
99 | const struct ieee802154_llsec_key *key); | |
100 | int (*del_llsec_key)(struct wpan_phy *wpan_phy, | |
101 | struct wpan_dev *wpan_dev, | |
102 | const struct ieee802154_llsec_key_id *id); | |
103 | int (*add_seclevel)(struct wpan_phy *wpan_phy, | |
104 | struct wpan_dev *wpan_dev, | |
105 | const struct ieee802154_llsec_seclevel *sl); | |
106 | int (*del_seclevel)(struct wpan_phy *wpan_phy, | |
107 | struct wpan_dev *wpan_dev, | |
108 | const struct ieee802154_llsec_seclevel *sl); | |
109 | int (*add_device)(struct wpan_phy *wpan_phy, | |
110 | struct wpan_dev *wpan_dev, | |
111 | const struct ieee802154_llsec_device *dev); | |
112 | int (*del_device)(struct wpan_phy *wpan_phy, | |
113 | struct wpan_dev *wpan_dev, __le64 extended_addr); | |
114 | int (*add_devkey)(struct wpan_phy *wpan_phy, | |
115 | struct wpan_dev *wpan_dev, | |
116 | __le64 extended_addr, | |
117 | const struct ieee802154_llsec_device_key *key); | |
118 | int (*del_devkey)(struct wpan_phy *wpan_phy, | |
119 | struct wpan_dev *wpan_dev, | |
120 | __le64 extended_addr, | |
121 | const struct ieee802154_llsec_device_key *key); | |
122 | #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */ | |
a5dd1d72 AA |
123 | }; |
124 | ||
fea3318d AA |
125 | static inline bool |
126 | wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st) | |
127 | { | |
128 | switch (st) { | |
129 | case NL802154_SUPPORTED_BOOL_TRUE: | |
130 | return b; | |
131 | case NL802154_SUPPORTED_BOOL_FALSE: | |
132 | return !b; | |
133 | case NL802154_SUPPORTED_BOOL_BOTH: | |
134 | return true; | |
135 | default: | |
136 | WARN_ON(1); | |
137 | } | |
138 | ||
139 | return false; | |
140 | } | |
141 | ||
72f655e4 | 142 | struct wpan_phy_supported { |
fea3318d | 143 | u32 channels[IEEE802154_MAX_PAGE + 1], |
65318680 | 144 | cca_modes, cca_opts, iftypes; |
fea3318d AA |
145 | enum nl802154_supported_bool_states lbt; |
146 | u8 min_minbe, max_minbe, min_maxbe, max_maxbe, | |
147 | min_csma_backoffs, max_csma_backoffs; | |
148 | s8 min_frame_retries, max_frame_retries; | |
149 | size_t tx_powers_size, cca_ed_levels_size; | |
150 | const s32 *tx_powers, *cca_ed_levels; | |
72f655e4 AA |
151 | }; |
152 | ||
7fe9a388 AA |
153 | struct wpan_phy_cca { |
154 | enum nl802154_cca_modes mode; | |
155 | enum nl802154_cca_opts opt; | |
156 | }; | |
157 | ||
791021bf AA |
158 | static inline bool |
159 | wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b) | |
160 | { | |
161 | if (a->mode != b->mode) | |
162 | return false; | |
163 | ||
164 | if (a->mode == NL802154_CCA_ENERGY_CARRIER) | |
165 | return a->opt == b->opt; | |
166 | ||
167 | return true; | |
168 | } | |
169 | ||
edea8f7c AA |
170 | /** |
171 | * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support | |
172 | * transmit power setting. | |
173 | * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed | |
174 | * level setting. | |
175 | * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode | |
176 | * setting. | |
177 | */ | |
178 | enum wpan_phy_flags { | |
179 | WPAN_PHY_FLAG_TXPOWER = BIT(1), | |
180 | WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2), | |
181 | WPAN_PHY_FLAG_CCA_MODE = BIT(3), | |
182 | }; | |
183 | ||
2bfb1070 | 184 | struct wpan_phy { |
6322d50d AA |
185 | /* If multiple wpan_phys are registered and you're handed e.g. |
186 | * a regular netdev with assigned ieee802154_ptr, you won't | |
187 | * know whether it points to a wpan_phy your driver has registered | |
188 | * or not. Assign this to something global to your driver to | |
189 | * help determine whether you own this wpan_phy or not. | |
190 | */ | |
191 | const void *privid; | |
192 | ||
edea8f7c AA |
193 | u32 flags; |
194 | ||
2bfb1070 | 195 | /* |
9b2777d6 | 196 | * This is a PIB according to 802.15.4-2011. |
2bfb1070 DES |
197 | * We do not provide timing-related variables, as they |
198 | * aren't used outside of driver | |
199 | */ | |
200 | u8 current_channel; | |
201 | u8 current_page; | |
72f655e4 | 202 | struct wpan_phy_supported supported; |
e2eb173a | 203 | /* current transmit_power in mBm */ |
1a19cb68 | 204 | s32 transmit_power; |
7fe9a388 | 205 | struct wpan_phy_cca cca; |
dee56d14 AA |
206 | |
207 | __le64 perm_extended_addr; | |
2bfb1070 | 208 | |
32b23550 | 209 | /* current cca ed threshold in mBm */ |
6ca00197 | 210 | s32 cca_ed_level; |
84dda3c6 | 211 | |
61f2dcba AA |
212 | /* PHY depended MAC PIB values */ |
213 | ||
214 | /* 802.15.4 acronym: Tdsym in usec */ | |
215 | u8 symbol_duration; | |
216 | /* lifs and sifs periods timing */ | |
217 | u16 lifs_period; | |
218 | u16 sifs_period; | |
219 | ||
2bfb1070 | 220 | struct device dev; |
2bfb1070 | 221 | |
4896167d | 222 | char priv[0] __aligned(NETDEV_ALIGN); |
2bfb1070 DES |
223 | }; |
224 | ||
838b83d6 AA |
225 | struct ieee802154_addr { |
226 | u8 mode; | |
227 | __le16 pan_id; | |
228 | union { | |
229 | __le16 short_addr; | |
230 | __le64 extended_addr; | |
231 | }; | |
232 | }; | |
233 | ||
a26c5fd7 AA |
234 | struct ieee802154_llsec_key_id { |
235 | u8 mode; | |
236 | u8 id; | |
237 | union { | |
238 | struct ieee802154_addr device_addr; | |
239 | __le32 short_source; | |
240 | __le64 extended_source; | |
241 | }; | |
242 | }; | |
243 | ||
244 | #define IEEE802154_LLSEC_KEY_SIZE 16 | |
245 | ||
246 | struct ieee802154_llsec_key { | |
247 | u8 frame_types; | |
248 | u32 cmd_frame_ids; | |
249 | /* TODO replace with NL802154_KEY_SIZE */ | |
250 | u8 key[IEEE802154_LLSEC_KEY_SIZE]; | |
251 | }; | |
252 | ||
253 | struct ieee802154_llsec_key_entry { | |
254 | struct list_head list; | |
255 | ||
256 | struct ieee802154_llsec_key_id id; | |
257 | struct ieee802154_llsec_key *key; | |
258 | }; | |
259 | ||
260 | struct ieee802154_llsec_params { | |
261 | bool enabled; | |
262 | ||
263 | __be32 frame_counter; | |
264 | u8 out_level; | |
265 | struct ieee802154_llsec_key_id out_key; | |
266 | ||
267 | __le64 default_key_source; | |
268 | ||
269 | __le16 pan_id; | |
270 | __le64 hwaddr; | |
271 | __le64 coord_hwaddr; | |
272 | __le16 coord_shortaddr; | |
273 | }; | |
274 | ||
275 | struct ieee802154_llsec_table { | |
276 | struct list_head keys; | |
277 | struct list_head devices; | |
278 | struct list_head security_levels; | |
279 | }; | |
280 | ||
281 | struct ieee802154_llsec_seclevel { | |
282 | struct list_head list; | |
283 | ||
284 | u8 frame_type; | |
285 | u8 cmd_frame_id; | |
286 | bool device_override; | |
287 | u32 sec_levels; | |
288 | }; | |
289 | ||
290 | struct ieee802154_llsec_device { | |
291 | struct list_head list; | |
292 | ||
293 | __le16 pan_id; | |
294 | __le16 short_addr; | |
295 | __le64 hwaddr; | |
296 | u32 frame_counter; | |
297 | bool seclevel_exempt; | |
298 | ||
299 | u8 key_mode; | |
300 | struct list_head keys; | |
301 | }; | |
302 | ||
303 | struct ieee802154_llsec_device_key { | |
304 | struct list_head list; | |
305 | ||
306 | struct ieee802154_llsec_key_id key_id; | |
307 | u32 frame_counter; | |
308 | }; | |
309 | ||
838b83d6 AA |
310 | struct wpan_dev_header_ops { |
311 | /* TODO create callback currently assumes ieee802154_mac_cb inside | |
312 | * skb->cb. This should be changed to give these information as | |
313 | * parameter. | |
314 | */ | |
315 | int (*create)(struct sk_buff *skb, struct net_device *dev, | |
316 | const struct ieee802154_addr *daddr, | |
317 | const struct ieee802154_addr *saddr, | |
318 | unsigned int len); | |
319 | }; | |
320 | ||
d5ae67ba AA |
321 | struct wpan_dev { |
322 | struct wpan_phy *wpan_phy; | |
190ac1ca | 323 | int iftype; |
863e88f2 | 324 | |
fcf39e6e AA |
325 | /* the remainder of this struct should be private to cfg802154 */ |
326 | struct list_head list; | |
327 | struct net_device *netdev; | |
328 | ||
838b83d6 AA |
329 | const struct wpan_dev_header_ops *header_ops; |
330 | ||
51e0e5d8 AA |
331 | /* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */ |
332 | struct net_device *lowpan_dev; | |
333 | ||
fcf39e6e AA |
334 | u32 identifier; |
335 | ||
863e88f2 AA |
336 | /* MAC PIB */ |
337 | __le16 pan_id; | |
338 | __le16 short_addr; | |
339 | __le64 extended_addr; | |
340 | ||
341 | /* MAC BSN field */ | |
344f8c11 | 342 | atomic_t bsn; |
863e88f2 | 343 | /* MAC DSN field */ |
344f8c11 | 344 | atomic_t dsn; |
863e88f2 AA |
345 | |
346 | u8 min_be; | |
347 | u8 max_be; | |
348 | u8 csma_retries; | |
349 | s8 frame_retries; | |
350 | ||
351 | bool lbt; | |
352 | ||
353 | bool promiscuous_mode; | |
c91208d8 AA |
354 | |
355 | /* fallback for acknowledgment bit setting */ | |
356 | bool ackreq; | |
d5ae67ba AA |
357 | }; |
358 | ||
42723448 DES |
359 | #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) |
360 | ||
838b83d6 AA |
361 | static inline int |
362 | wpan_dev_hard_header(struct sk_buff *skb, struct net_device *dev, | |
363 | const struct ieee802154_addr *daddr, | |
364 | const struct ieee802154_addr *saddr, | |
365 | unsigned int len) | |
366 | { | |
367 | struct wpan_dev *wpan_dev = dev->ieee802154_ptr; | |
368 | ||
369 | return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len); | |
370 | } | |
371 | ||
a5dd1d72 | 372 | struct wpan_phy * |
f601379f | 373 | wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); |
e9cf356c DES |
374 | static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) |
375 | { | |
376 | phy->dev.parent = dev; | |
377 | } | |
e72740d0 | 378 | |
e9cf356c | 379 | int wpan_phy_register(struct wpan_phy *phy); |
2bfb1070 DES |
380 | void wpan_phy_unregister(struct wpan_phy *phy); |
381 | void wpan_phy_free(struct wpan_phy *phy); | |
1c889f4d DES |
382 | /* Same semantics as for class_for_each_device */ |
383 | int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data); | |
2bfb1070 DES |
384 | |
385 | static inline void *wpan_phy_priv(struct wpan_phy *phy) | |
386 | { | |
387 | BUG_ON(!phy); | |
388 | return &phy->priv; | |
389 | } | |
390 | ||
391 | struct wpan_phy *wpan_phy_find(const char *str); | |
69d9ab96 DES |
392 | |
393 | static inline void wpan_phy_put(struct wpan_phy *phy) | |
394 | { | |
395 | put_device(&phy->dev); | |
396 | } | |
397 | ||
2bfb1070 DES |
398 | static inline const char *wpan_phy_name(struct wpan_phy *phy) |
399 | { | |
400 | return dev_name(&phy->dev); | |
401 | } | |
5ad60d36 AA |
402 | |
403 | #endif /* __NET_CFG802154_H */ |