1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* |
3 | * Copyright (C) 2007, 2008, 2009 Siemens AG |
4 | * |
5 | * Written by: |
6 | * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com> |
7 | */ |
8 | |
9 | #ifndef __NET_CFG802154_H |
10 | #define __NET_CFG802154_H |
11 | |
12 | #include <linux/ieee802154.h> |
13 | #include <linux/netdevice.h> |
14 | #include <linux/spinlock.h> |
15 | #include <linux/bug.h> |
16 | |
17 | #include <net/nl802154.h> |
18 | |
19 | struct wpan_phy; |
20 | struct wpan_phy_cca; |
21 | struct cfg802154_scan_request; |
22 | struct cfg802154_beacon_request; |
23 | |
24 | #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL |
25 | struct ieee802154_llsec_device_key; |
26 | struct ieee802154_llsec_seclevel; |
27 | struct ieee802154_llsec_params; |
28 | struct ieee802154_llsec_device; |
29 | struct ieee802154_llsec_table; |
30 | struct ieee802154_llsec_key_id; |
31 | struct ieee802154_llsec_key; |
32 | #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */ |
33 | |
34 | struct cfg802154_ops { |
35 | struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
36 | const char *name, |
37 | unsigned char name_assign_type, |
38 | int type); |
39 | void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy, |
40 | struct net_device *dev); |
41 | int (*suspend)(struct wpan_phy *wpan_phy); |
42 | int (*resume)(struct wpan_phy *wpan_phy); |
43 | int (*add_virtual_intf)(struct wpan_phy *wpan_phy, |
44 | const char *name, |
45 | unsigned char name_assign_type, |
46 | enum nl802154_iftype type, |
47 | __le64 extended_addr); |
48 | int (*del_virtual_intf)(struct wpan_phy *wpan_phy, |
49 | struct wpan_dev *wpan_dev); |
50 | int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel); |
51 | int (*set_cca_mode)(struct wpan_phy *wpan_phy, |
52 | const struct wpan_phy_cca *cca); |
53 | int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level); |
54 | int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power); |
55 | int (*set_pan_id)(struct wpan_phy *wpan_phy, |
56 | struct wpan_dev *wpan_dev, __le16 pan_id); |
57 | int (*set_short_addr)(struct wpan_phy *wpan_phy, |
58 | struct wpan_dev *wpan_dev, __le16 short_addr); |
59 | int (*set_backoff_exponent)(struct wpan_phy *wpan_phy, |
60 | struct wpan_dev *wpan_dev, u8 min_be, |
61 | u8 max_be); |
62 | int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy, |
63 | struct wpan_dev *wpan_dev, |
64 | u8 max_csma_backoffs); |
65 | int (*set_max_frame_retries)(struct wpan_phy *wpan_phy, |
66 | struct wpan_dev *wpan_dev, |
67 | s8 max_frame_retries); |
68 | int (*set_lbt_mode)(struct wpan_phy *wpan_phy, |
69 | struct wpan_dev *wpan_dev, bool mode); |
70 | int (*set_ackreq_default)(struct wpan_phy *wpan_phy, |
71 | struct wpan_dev *wpan_dev, bool ackreq); |
72 | int (*trigger_scan)(struct wpan_phy *wpan_phy, |
73 | struct cfg802154_scan_request *request); |
74 | int (*abort_scan)(struct wpan_phy *wpan_phy, |
75 | struct wpan_dev *wpan_dev); |
76 | int (*send_beacons)(struct wpan_phy *wpan_phy, |
77 | struct cfg802154_beacon_request *request); |
78 | int (*stop_beacons)(struct wpan_phy *wpan_phy, |
79 | struct wpan_dev *wpan_dev); |
80 | #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL |
81 | void (*get_llsec_table)(struct wpan_phy *wpan_phy, |
82 | struct wpan_dev *wpan_dev, |
83 | struct ieee802154_llsec_table **table); |
84 | void (*lock_llsec_table)(struct wpan_phy *wpan_phy, |
85 | struct wpan_dev *wpan_dev); |
86 | void (*unlock_llsec_table)(struct wpan_phy *wpan_phy, |
87 | struct wpan_dev *wpan_dev); |
88 | /* TODO remove locking/get table callbacks, this is part of the |
89 | * nl802154 interface and should be accessible from ieee802154 layer. |
90 | */ |
91 | int (*get_llsec_params)(struct wpan_phy *wpan_phy, |
92 | struct wpan_dev *wpan_dev, |
93 | struct ieee802154_llsec_params *params); |
94 | int (*set_llsec_params)(struct wpan_phy *wpan_phy, |
95 | struct wpan_dev *wpan_dev, |
96 | const struct ieee802154_llsec_params *params, |
97 | int changed); |
98 | int (*add_llsec_key)(struct wpan_phy *wpan_phy, |
99 | struct wpan_dev *wpan_dev, |
100 | const struct ieee802154_llsec_key_id *id, |
101 | const struct ieee802154_llsec_key *key); |
102 | int (*del_llsec_key)(struct wpan_phy *wpan_phy, |
103 | struct wpan_dev *wpan_dev, |
104 | const struct ieee802154_llsec_key_id *id); |
105 | int (*add_seclevel)(struct wpan_phy *wpan_phy, |
106 | struct wpan_dev *wpan_dev, |
107 | const struct ieee802154_llsec_seclevel *sl); |
108 | int (*del_seclevel)(struct wpan_phy *wpan_phy, |
109 | struct wpan_dev *wpan_dev, |
110 | const struct ieee802154_llsec_seclevel *sl); |
111 | int (*add_device)(struct wpan_phy *wpan_phy, |
112 | struct wpan_dev *wpan_dev, |
113 | const struct ieee802154_llsec_device *dev); |
114 | int (*del_device)(struct wpan_phy *wpan_phy, |
115 | struct wpan_dev *wpan_dev, __le64 extended_addr); |
116 | int (*add_devkey)(struct wpan_phy *wpan_phy, |
117 | struct wpan_dev *wpan_dev, |
118 | __le64 extended_addr, |
119 | const struct ieee802154_llsec_device_key *key); |
120 | int (*del_devkey)(struct wpan_phy *wpan_phy, |
121 | struct wpan_dev *wpan_dev, |
122 | __le64 extended_addr, |
123 | const struct ieee802154_llsec_device_key *key); |
124 | #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */ |
125 | }; |
126 | |
127 | static inline bool |
128 | wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st) |
129 | { |
130 | switch (st) { |
131 | case NL802154_SUPPORTED_BOOL_TRUE: |
132 | return b; |
133 | case NL802154_SUPPORTED_BOOL_FALSE: |
134 | return !b; |
135 | case NL802154_SUPPORTED_BOOL_BOTH: |
136 | return true; |
137 | default: |
138 | WARN_ON(1); |
139 | } |
140 | |
141 | return false; |
142 | } |
143 | |
144 | struct wpan_phy_supported { |
145 | u32 channels[IEEE802154_MAX_PAGE + 1], |
146 | cca_modes, cca_opts, iftypes; |
147 | enum nl802154_supported_bool_states lbt; |
148 | u8 min_minbe, max_minbe, min_maxbe, max_maxbe, |
149 | min_csma_backoffs, max_csma_backoffs; |
150 | s8 min_frame_retries, max_frame_retries; |
151 | size_t tx_powers_size, cca_ed_levels_size; |
152 | const s32 *tx_powers, *cca_ed_levels; |
153 | }; |
154 | |
155 | struct wpan_phy_cca { |
156 | enum nl802154_cca_modes mode; |
157 | enum nl802154_cca_opts opt; |
158 | }; |
159 | |
160 | static inline bool |
161 | wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b) |
162 | { |
163 | if (a->mode != b->mode) |
164 | return false; |
165 | |
166 | if (a->mode == NL802154_CCA_ENERGY_CARRIER) |
167 | return a->opt == b->opt; |
168 | |
169 | return true; |
170 | } |
171 | |
172 | /** |
173 | * enum wpan_phy_flags - WPAN PHY state flags |
174 | * @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support |
175 | * transmit power setting. |
176 | * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed |
177 | * level setting. |
178 | * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode |
179 | * setting. |
180 | * @WPAN_PHY_FLAG_STATE_QUEUE_STOPPED: Indicates that the transmit queue was |
181 | * temporarily stopped. |
182 | * @WPAN_PHY_FLAG_DATAGRAMS_ONLY: Indicates that transceiver is only able to |
183 | * send/receive datagrams. |
184 | */ |
185 | enum wpan_phy_flags { |
186 | WPAN_PHY_FLAG_TXPOWER = BIT(1), |
187 | WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2), |
188 | WPAN_PHY_FLAG_CCA_MODE = BIT(3), |
189 | WPAN_PHY_FLAG_STATE_QUEUE_STOPPED = BIT(4), |
190 | WPAN_PHY_FLAG_DATAGRAMS_ONLY = BIT(5), |
191 | }; |
192 | |
193 | struct wpan_phy { |
194 | /* If multiple wpan_phys are registered and you're handed e.g. |
195 | * a regular netdev with assigned ieee802154_ptr, you won't |
196 | * know whether it points to a wpan_phy your driver has registered |
197 | * or not. Assign this to something global to your driver to |
198 | * help determine whether you own this wpan_phy or not. |
199 | */ |
200 | const void *privid; |
201 | |
202 | unsigned long flags; |
203 | |
204 | /* |
205 | * This is a PIB according to 802.15.4-2011. |
206 | * We do not provide timing-related variables, as they |
207 | * aren't used outside of driver |
208 | */ |
209 | u8 current_channel; |
210 | u8 current_page; |
211 | struct wpan_phy_supported supported; |
212 | /* current transmit_power in mBm */ |
213 | s32 transmit_power; |
214 | struct wpan_phy_cca cca; |
215 | |
216 | __le64 perm_extended_addr; |
217 | |
218 | /* current cca ed threshold in mBm */ |
219 | s32 cca_ed_level; |
220 | |
221 | /* PHY depended MAC PIB values */ |
222 | |
223 | /* 802.15.4 acronym: Tdsym in nsec */ |
224 | u32 symbol_duration; |
225 | /* lifs and sifs periods timing */ |
226 | u16 lifs_period; |
227 | u16 sifs_period; |
228 | |
229 | struct device dev; |
230 | |
231 | /* the network namespace this phy lives in currently */ |
232 | possible_net_t _net; |
233 | |
234 | /* Transmission monitoring and control */ |
235 | spinlock_t queue_lock; |
236 | atomic_t ongoing_txs; |
237 | atomic_t hold_txs; |
238 | wait_queue_head_t sync_txq; |
239 | |
240 | /* Current filtering level on reception. |
241 | * Only allowed to be changed if phy is not operational. |
242 | */ |
243 | enum ieee802154_filtering_level filtering; |
244 | |
245 | char priv[] __aligned(NETDEV_ALIGN); |
246 | }; |
247 | |
248 | static inline struct net *wpan_phy_net(struct wpan_phy *wpan_phy) |
249 | { |
250 | return read_pnet(pnet: &wpan_phy->_net); |
251 | } |
252 | |
253 | static inline void wpan_phy_net_set(struct wpan_phy *wpan_phy, struct net *net) |
254 | { |
255 | write_pnet(pnet: &wpan_phy->_net, net); |
256 | } |
257 | |
258 | static inline bool ieee802154_chan_is_valid(struct wpan_phy *phy, |
259 | u8 page, u8 channel) |
260 | { |
261 | if (page > IEEE802154_MAX_PAGE || |
262 | channel > IEEE802154_MAX_CHANNEL || |
263 | !(phy->supported.channels[page] & BIT(channel))) |
264 | return false; |
265 | |
266 | return true; |
267 | } |
268 | |
269 | /** |
270 | * struct ieee802154_addr - IEEE802.15.4 device address |
271 | * @mode: Address mode from frame header. Can be one of: |
272 | * - @IEEE802154_ADDR_NONE |
273 | * - @IEEE802154_ADDR_SHORT |
274 | * - @IEEE802154_ADDR_LONG |
275 | * @pan_id: The PAN ID this address belongs to |
276 | * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT |
277 | * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG |
278 | */ |
279 | struct ieee802154_addr { |
280 | u8 mode; |
281 | __le16 pan_id; |
282 | union { |
283 | __le16 short_addr; |
284 | __le64 extended_addr; |
285 | }; |
286 | }; |
287 | |
288 | /** |
289 | * struct ieee802154_coord_desc - Coordinator descriptor |
290 | * @addr: PAN ID and coordinator address |
291 | * @page: page this coordinator is using |
292 | * @channel: channel this coordinator is using |
293 | * @superframe_spec: SuperFrame specification as received |
294 | * @link_quality: link quality indicator at which the beacon was received |
295 | * @gts_permit: the coordinator accepts GTS requests |
296 | */ |
297 | struct ieee802154_coord_desc { |
298 | struct ieee802154_addr addr; |
299 | u8 page; |
300 | u8 channel; |
301 | u16 superframe_spec; |
302 | u8 link_quality; |
303 | bool gts_permit; |
304 | }; |
305 | |
306 | /** |
307 | * struct cfg802154_scan_request - Scan request |
308 | * |
309 | * @type: type of scan to be performed |
310 | * @page: page on which to perform the scan |
311 | * @channels: channels in te %page to be scanned |
312 | * @duration: time spent on each channel, calculated with: |
313 | * aBaseSuperframeDuration * (2 ^ duration + 1) |
314 | * @wpan_dev: the wpan device on which to perform the scan |
315 | * @wpan_phy: the wpan phy on which to perform the scan |
316 | */ |
317 | struct cfg802154_scan_request { |
318 | enum nl802154_scan_types type; |
319 | u8 page; |
320 | u32 channels; |
321 | u8 duration; |
322 | struct wpan_dev *wpan_dev; |
323 | struct wpan_phy *wpan_phy; |
324 | }; |
325 | |
326 | /** |
327 | * struct cfg802154_beacon_request - Beacon request descriptor |
328 | * |
329 | * @interval: interval n between sendings, in multiple order of the super frame |
330 | * duration: aBaseSuperframeDuration * (2^n) unless the interval |
331 | * order is greater or equal to 15, in this case beacons won't be |
332 | * passively sent out at a fixed rate but instead inform the device |
333 | * that it should answer beacon requests as part of active scan |
334 | * procedures |
335 | * @wpan_dev: the concerned wpan device |
336 | * @wpan_phy: the wpan phy this was for |
337 | */ |
338 | struct cfg802154_beacon_request { |
339 | u8 interval; |
340 | struct wpan_dev *wpan_dev; |
341 | struct wpan_phy *wpan_phy; |
342 | }; |
343 | |
344 | /** |
345 | * struct cfg802154_mac_pkt - MAC packet descriptor (beacon/command) |
346 | * @node: MAC packets to process list member |
347 | * @skb: the received sk_buff |
348 | * @sdata: the interface on which @skb was received |
349 | * @page: page configuration when @skb was received |
350 | * @channel: channel configuration when @skb was received |
351 | */ |
352 | struct cfg802154_mac_pkt { |
353 | struct list_head node; |
354 | struct sk_buff *skb; |
355 | struct ieee802154_sub_if_data *sdata; |
356 | u8 page; |
357 | u8 channel; |
358 | }; |
359 | |
360 | struct ieee802154_llsec_key_id { |
361 | u8 mode; |
362 | u8 id; |
363 | union { |
364 | struct ieee802154_addr device_addr; |
365 | __le32 short_source; |
366 | __le64 extended_source; |
367 | }; |
368 | }; |
369 | |
370 | #define IEEE802154_LLSEC_KEY_SIZE 16 |
371 | |
372 | struct ieee802154_llsec_key { |
373 | u8 frame_types; |
374 | u32 cmd_frame_ids; |
375 | /* TODO replace with NL802154_KEY_SIZE */ |
376 | u8 key[IEEE802154_LLSEC_KEY_SIZE]; |
377 | }; |
378 | |
379 | struct ieee802154_llsec_key_entry { |
380 | struct list_head list; |
381 | |
382 | struct ieee802154_llsec_key_id id; |
383 | struct ieee802154_llsec_key *key; |
384 | }; |
385 | |
386 | struct ieee802154_llsec_params { |
387 | bool enabled; |
388 | |
389 | __be32 frame_counter; |
390 | u8 out_level; |
391 | struct ieee802154_llsec_key_id out_key; |
392 | |
393 | __le64 default_key_source; |
394 | |
395 | __le16 pan_id; |
396 | __le64 hwaddr; |
397 | __le64 coord_hwaddr; |
398 | __le16 coord_shortaddr; |
399 | }; |
400 | |
401 | struct ieee802154_llsec_table { |
402 | struct list_head keys; |
403 | struct list_head devices; |
404 | struct list_head security_levels; |
405 | }; |
406 | |
407 | struct ieee802154_llsec_seclevel { |
408 | struct list_head list; |
409 | |
410 | u8 frame_type; |
411 | u8 cmd_frame_id; |
412 | bool device_override; |
413 | u32 sec_levels; |
414 | }; |
415 | |
416 | struct ieee802154_llsec_device { |
417 | struct list_head list; |
418 | |
419 | __le16 pan_id; |
420 | __le16 short_addr; |
421 | __le64 hwaddr; |
422 | u32 frame_counter; |
423 | bool seclevel_exempt; |
424 | |
425 | u8 key_mode; |
426 | struct list_head keys; |
427 | }; |
428 | |
429 | struct ieee802154_llsec_device_key { |
430 | struct list_head list; |
431 | |
432 | struct ieee802154_llsec_key_id key_id; |
433 | u32 frame_counter; |
434 | }; |
435 | |
436 | struct { |
437 | /* TODO create callback currently assumes ieee802154_mac_cb inside |
438 | * skb->cb. This should be changed to give these information as |
439 | * parameter. |
440 | */ |
441 | int (*)(struct sk_buff *skb, struct net_device *dev, |
442 | const struct ieee802154_addr *daddr, |
443 | const struct ieee802154_addr *saddr, |
444 | unsigned int len); |
445 | }; |
446 | |
447 | struct wpan_dev { |
448 | struct wpan_phy *wpan_phy; |
449 | int iftype; |
450 | |
451 | /* the remainder of this struct should be private to cfg802154 */ |
452 | struct list_head list; |
453 | struct net_device *netdev; |
454 | |
455 | const struct wpan_dev_header_ops *; |
456 | |
457 | /* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */ |
458 | struct net_device *lowpan_dev; |
459 | |
460 | u32 identifier; |
461 | |
462 | /* MAC PIB */ |
463 | __le16 pan_id; |
464 | __le16 short_addr; |
465 | __le64 extended_addr; |
466 | |
467 | /* MAC BSN field */ |
468 | atomic_t bsn; |
469 | /* MAC DSN field */ |
470 | atomic_t dsn; |
471 | |
472 | u8 min_be; |
473 | u8 max_be; |
474 | u8 csma_retries; |
475 | s8 frame_retries; |
476 | |
477 | bool lbt; |
478 | |
479 | /* fallback for acknowledgment bit setting */ |
480 | bool ackreq; |
481 | }; |
482 | |
483 | #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev) |
484 | |
485 | #if IS_ENABLED(CONFIG_IEEE802154) || IS_ENABLED(CONFIG_6LOWPAN) |
486 | static inline int |
487 | (struct sk_buff *skb, struct net_device *dev, |
488 | const struct ieee802154_addr *daddr, |
489 | const struct ieee802154_addr *saddr, |
490 | unsigned int len) |
491 | { |
492 | struct wpan_dev *wpan_dev = dev->ieee802154_ptr; |
493 | |
494 | return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len); |
495 | } |
496 | #endif |
497 | |
498 | struct wpan_phy * |
499 | wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size); |
500 | static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev) |
501 | { |
502 | phy->dev.parent = dev; |
503 | } |
504 | |
505 | int wpan_phy_register(struct wpan_phy *phy); |
506 | void wpan_phy_unregister(struct wpan_phy *phy); |
507 | void wpan_phy_free(struct wpan_phy *phy); |
508 | /* Same semantics as for class_for_each_device */ |
509 | int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data); |
510 | |
511 | static inline void *wpan_phy_priv(struct wpan_phy *phy) |
512 | { |
513 | BUG_ON(!phy); |
514 | return &phy->priv; |
515 | } |
516 | |
517 | struct wpan_phy *wpan_phy_find(const char *str); |
518 | |
519 | static inline void wpan_phy_put(struct wpan_phy *phy) |
520 | { |
521 | put_device(dev: &phy->dev); |
522 | } |
523 | |
524 | static inline const char *wpan_phy_name(struct wpan_phy *phy) |
525 | { |
526 | return dev_name(dev: &phy->dev); |
527 | } |
528 | |
529 | void ieee802154_configure_durations(struct wpan_phy *phy, |
530 | unsigned int page, unsigned int channel); |
531 | |
532 | #endif /* __NET_CFG802154_H */ |
533 | |