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