1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2007, 2008, 2009 Siemens AG
6 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
9 #ifndef __NET_CFG802154_H
10 #define __NET_CFG802154_H
12 #include <linux/ieee802154.h>
13 #include <linux/netdevice.h>
14 #include <linux/spinlock.h>
15 #include <linux/bug.h>
17 #include <net/nl802154.h>
22 #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
23 struct ieee802154_llsec_device_key;
24 struct ieee802154_llsec_seclevel;
25 struct ieee802154_llsec_params;
26 struct ieee802154_llsec_device;
27 struct ieee802154_llsec_table;
28 struct ieee802154_llsec_key_id;
29 struct ieee802154_llsec_key;
30 #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
32 struct cfg802154_ops {
33 struct net_device * (*add_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
35 unsigned char name_assign_type,
37 void (*del_virtual_intf_deprecated)(struct wpan_phy *wpan_phy,
38 struct net_device *dev);
39 int (*suspend)(struct wpan_phy *wpan_phy);
40 int (*resume)(struct wpan_phy *wpan_phy);
41 int (*add_virtual_intf)(struct wpan_phy *wpan_phy,
43 unsigned char name_assign_type,
44 enum nl802154_iftype type,
45 __le64 extended_addr);
46 int (*del_virtual_intf)(struct wpan_phy *wpan_phy,
47 struct wpan_dev *wpan_dev);
48 int (*set_channel)(struct wpan_phy *wpan_phy, u8 page, u8 channel);
49 int (*set_cca_mode)(struct wpan_phy *wpan_phy,
50 const struct wpan_phy_cca *cca);
51 int (*set_cca_ed_level)(struct wpan_phy *wpan_phy, s32 ed_level);
52 int (*set_tx_power)(struct wpan_phy *wpan_phy, s32 power);
53 int (*set_pan_id)(struct wpan_phy *wpan_phy,
54 struct wpan_dev *wpan_dev, __le16 pan_id);
55 int (*set_short_addr)(struct wpan_phy *wpan_phy,
56 struct wpan_dev *wpan_dev, __le16 short_addr);
57 int (*set_backoff_exponent)(struct wpan_phy *wpan_phy,
58 struct wpan_dev *wpan_dev, u8 min_be,
60 int (*set_max_csma_backoffs)(struct wpan_phy *wpan_phy,
61 struct wpan_dev *wpan_dev,
62 u8 max_csma_backoffs);
63 int (*set_max_frame_retries)(struct wpan_phy *wpan_phy,
64 struct wpan_dev *wpan_dev,
65 s8 max_frame_retries);
66 int (*set_lbt_mode)(struct wpan_phy *wpan_phy,
67 struct wpan_dev *wpan_dev, bool mode);
68 int (*set_ackreq_default)(struct wpan_phy *wpan_phy,
69 struct wpan_dev *wpan_dev, bool ackreq);
70 #ifdef CONFIG_IEEE802154_NL802154_EXPERIMENTAL
71 void (*get_llsec_table)(struct wpan_phy *wpan_phy,
72 struct wpan_dev *wpan_dev,
73 struct ieee802154_llsec_table **table);
74 void (*lock_llsec_table)(struct wpan_phy *wpan_phy,
75 struct wpan_dev *wpan_dev);
76 void (*unlock_llsec_table)(struct wpan_phy *wpan_phy,
77 struct wpan_dev *wpan_dev);
78 /* TODO remove locking/get table callbacks, this is part of the
79 * nl802154 interface and should be accessible from ieee802154 layer.
81 int (*get_llsec_params)(struct wpan_phy *wpan_phy,
82 struct wpan_dev *wpan_dev,
83 struct ieee802154_llsec_params *params);
84 int (*set_llsec_params)(struct wpan_phy *wpan_phy,
85 struct wpan_dev *wpan_dev,
86 const struct ieee802154_llsec_params *params,
88 int (*add_llsec_key)(struct wpan_phy *wpan_phy,
89 struct wpan_dev *wpan_dev,
90 const struct ieee802154_llsec_key_id *id,
91 const struct ieee802154_llsec_key *key);
92 int (*del_llsec_key)(struct wpan_phy *wpan_phy,
93 struct wpan_dev *wpan_dev,
94 const struct ieee802154_llsec_key_id *id);
95 int (*add_seclevel)(struct wpan_phy *wpan_phy,
96 struct wpan_dev *wpan_dev,
97 const struct ieee802154_llsec_seclevel *sl);
98 int (*del_seclevel)(struct wpan_phy *wpan_phy,
99 struct wpan_dev *wpan_dev,
100 const struct ieee802154_llsec_seclevel *sl);
101 int (*add_device)(struct wpan_phy *wpan_phy,
102 struct wpan_dev *wpan_dev,
103 const struct ieee802154_llsec_device *dev);
104 int (*del_device)(struct wpan_phy *wpan_phy,
105 struct wpan_dev *wpan_dev, __le64 extended_addr);
106 int (*add_devkey)(struct wpan_phy *wpan_phy,
107 struct wpan_dev *wpan_dev,
108 __le64 extended_addr,
109 const struct ieee802154_llsec_device_key *key);
110 int (*del_devkey)(struct wpan_phy *wpan_phy,
111 struct wpan_dev *wpan_dev,
112 __le64 extended_addr,
113 const struct ieee802154_llsec_device_key *key);
114 #endif /* CONFIG_IEEE802154_NL802154_EXPERIMENTAL */
118 wpan_phy_supported_bool(bool b, enum nl802154_supported_bool_states st)
121 case NL802154_SUPPORTED_BOOL_TRUE:
123 case NL802154_SUPPORTED_BOOL_FALSE:
125 case NL802154_SUPPORTED_BOOL_BOTH:
134 struct wpan_phy_supported {
135 u32 channels[IEEE802154_MAX_PAGE + 1],
136 cca_modes, cca_opts, iftypes;
137 enum nl802154_supported_bool_states lbt;
138 u8 min_minbe, max_minbe, min_maxbe, max_maxbe,
139 min_csma_backoffs, max_csma_backoffs;
140 s8 min_frame_retries, max_frame_retries;
141 size_t tx_powers_size, cca_ed_levels_size;
142 const s32 *tx_powers, *cca_ed_levels;
145 struct wpan_phy_cca {
146 enum nl802154_cca_modes mode;
147 enum nl802154_cca_opts opt;
151 wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b)
153 if (a->mode != b->mode)
156 if (a->mode == NL802154_CCA_ENERGY_CARRIER)
157 return a->opt == b->opt;
163 * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support
164 * transmit power setting.
165 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed
167 * @WPAN_PHY_FLAG_CCA_MODE: Indicates that transceiver will support cca mode
169 * @WPAN_PHY_FLAG_STATE_QUEUE_STOPPED: Indicates that the transmit queue was
170 * temporarily stopped.
172 enum wpan_phy_flags {
173 WPAN_PHY_FLAG_TXPOWER = BIT(1),
174 WPAN_PHY_FLAG_CCA_ED_LEVEL = BIT(2),
175 WPAN_PHY_FLAG_CCA_MODE = BIT(3),
176 WPAN_PHY_FLAG_STATE_QUEUE_STOPPED = BIT(4),
180 /* If multiple wpan_phys are registered and you're handed e.g.
181 * a regular netdev with assigned ieee802154_ptr, you won't
182 * know whether it points to a wpan_phy your driver has registered
183 * or not. Assign this to something global to your driver to
184 * help determine whether you own this wpan_phy or not.
191 * This is a PIB according to 802.15.4-2011.
192 * We do not provide timing-related variables, as they
193 * aren't used outside of driver
197 struct wpan_phy_supported supported;
198 /* current transmit_power in mBm */
200 struct wpan_phy_cca cca;
202 __le64 perm_extended_addr;
204 /* current cca ed threshold in mBm */
207 /* PHY depended MAC PIB values */
209 /* 802.15.4 acronym: Tdsym in nsec */
211 /* lifs and sifs periods timing */
217 /* the network namespace this phy lives in currently */
220 /* Transmission monitoring and control */
221 spinlock_t queue_lock;
222 atomic_t ongoing_txs;
224 wait_queue_head_t sync_txq;
226 /* Current filtering level on reception.
227 * Only allowed to be changed if phy is not operational.
229 enum ieee802154_filtering_level filtering;
231 char priv[] __aligned(NETDEV_ALIGN);
234 static inline struct net *wpan_phy_net(struct wpan_phy *wpan_phy)
236 return read_pnet(&wpan_phy->_net);
239 static inline void wpan_phy_net_set(struct wpan_phy *wpan_phy, struct net *net)
241 write_pnet(&wpan_phy->_net, net);
245 * struct ieee802154_addr - IEEE802.15.4 device address
246 * @mode: Address mode from frame header. Can be one of:
247 * - @IEEE802154_ADDR_NONE
248 * - @IEEE802154_ADDR_SHORT
249 * - @IEEE802154_ADDR_LONG
250 * @pan_id: The PAN ID this address belongs to
251 * @short_addr: address if @mode is @IEEE802154_ADDR_SHORT
252 * @extended_addr: address if @mode is @IEEE802154_ADDR_LONG
254 struct ieee802154_addr {
259 __le64 extended_addr;
264 * struct ieee802154_coord_desc - Coordinator descriptor
265 * @addr: PAN ID and coordinator address
266 * @page: page this coordinator is using
267 * @channel: channel this coordinator is using
268 * @superframe_spec: SuperFrame specification as received
269 * @link_quality: link quality indicator at which the beacon was received
270 * @gts_permit: the coordinator accepts GTS requests
272 struct ieee802154_coord_desc {
273 struct ieee802154_addr addr;
281 struct ieee802154_llsec_key_id {
285 struct ieee802154_addr device_addr;
287 __le64 extended_source;
291 #define IEEE802154_LLSEC_KEY_SIZE 16
293 struct ieee802154_llsec_key {
296 /* TODO replace with NL802154_KEY_SIZE */
297 u8 key[IEEE802154_LLSEC_KEY_SIZE];
300 struct ieee802154_llsec_key_entry {
301 struct list_head list;
303 struct ieee802154_llsec_key_id id;
304 struct ieee802154_llsec_key *key;
307 struct ieee802154_llsec_params {
310 __be32 frame_counter;
312 struct ieee802154_llsec_key_id out_key;
314 __le64 default_key_source;
319 __le16 coord_shortaddr;
322 struct ieee802154_llsec_table {
323 struct list_head keys;
324 struct list_head devices;
325 struct list_head security_levels;
328 struct ieee802154_llsec_seclevel {
329 struct list_head list;
333 bool device_override;
337 struct ieee802154_llsec_device {
338 struct list_head list;
344 bool seclevel_exempt;
347 struct list_head keys;
350 struct ieee802154_llsec_device_key {
351 struct list_head list;
353 struct ieee802154_llsec_key_id key_id;
357 struct wpan_dev_header_ops {
358 /* TODO create callback currently assumes ieee802154_mac_cb inside
359 * skb->cb. This should be changed to give these information as
362 int (*create)(struct sk_buff *skb, struct net_device *dev,
363 const struct ieee802154_addr *daddr,
364 const struct ieee802154_addr *saddr,
369 struct wpan_phy *wpan_phy;
372 /* the remainder of this struct should be private to cfg802154 */
373 struct list_head list;
374 struct net_device *netdev;
376 const struct wpan_dev_header_ops *header_ops;
378 /* lowpan interface, set when the wpan_dev belongs to one lowpan_dev */
379 struct net_device *lowpan_dev;
386 __le64 extended_addr;
400 /* fallback for acknowledgment bit setting */
404 #define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
406 #if IS_ENABLED(CONFIG_IEEE802154) || IS_ENABLED(CONFIG_6LOWPAN)
408 wpan_dev_hard_header(struct sk_buff *skb, struct net_device *dev,
409 const struct ieee802154_addr *daddr,
410 const struct ieee802154_addr *saddr,
413 struct wpan_dev *wpan_dev = dev->ieee802154_ptr;
415 return wpan_dev->header_ops->create(skb, dev, daddr, saddr, len);
420 wpan_phy_new(const struct cfg802154_ops *ops, size_t priv_size);
421 static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
423 phy->dev.parent = dev;
426 int wpan_phy_register(struct wpan_phy *phy);
427 void wpan_phy_unregister(struct wpan_phy *phy);
428 void wpan_phy_free(struct wpan_phy *phy);
429 /* Same semantics as for class_for_each_device */
430 int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);
432 static inline void *wpan_phy_priv(struct wpan_phy *phy)
438 struct wpan_phy *wpan_phy_find(const char *str);
440 static inline void wpan_phy_put(struct wpan_phy *phy)
442 put_device(&phy->dev);
445 static inline const char *wpan_phy_name(struct wpan_phy *phy)
447 return dev_name(&phy->dev);
450 void ieee802154_configure_durations(struct wpan_phy *phy);
452 #endif /* __NET_CFG802154_H */