1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (C) 2007-2012 Siemens AG
4 *
5 * Written by:
6 * Pavel Smolenskiy <pavel.smolenskiy@gmail.com>
7 * Maxim Gorbachyov <maxim.gorbachev@siemens.com>
8 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
9 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
10 */
11 #ifndef __IEEE802154_I_H
12 #define __IEEE802154_I_H
13
14 #include <linux/interrupt.h>
15 #include <linux/mutex.h>
16 #include <linux/hrtimer.h>
17 #include <net/cfg802154.h>
18 #include <net/mac802154.h>
19 #include <net/nl802154.h>
20 #include <net/ieee802154_netdev.h>
21
22 #include "llsec.h"
23
24 enum ieee802154_ongoing {
25 IEEE802154_IS_SCANNING = BIT(0),
26 IEEE802154_IS_BEACONING = BIT(1),
27 IEEE802154_IS_ASSOCIATING = BIT(2),
28 };
29
30 /* mac802154 device private data */
31 struct ieee802154_local {
32 struct ieee802154_hw hw;
33 const struct ieee802154_ops *ops;
34
35 /* hardware address filter */
36 struct ieee802154_hw_addr_filt addr_filt;
37 /* ieee802154 phy */
38 struct wpan_phy *phy;
39
40 int open_count;
41
42 /* As in mac80211 slaves list is modified:
43 * 1) under the RTNL
44 * 2) protected by slaves_mtx;
45 * 3) in an RCU manner
46 *
47 * So atomic readers can use any of this protection methods.
48 */
49 struct list_head interfaces;
50 struct mutex iflist_mtx;
51
52 /* Data related workqueue */
53 struct workqueue_struct *workqueue;
54 /* MAC commands related workqueue */
55 struct workqueue_struct *mac_wq;
56
57 struct hrtimer ifs_timer;
58
59 /* Scanning */
60 u8 scan_page;
61 u8 scan_channel;
62 struct ieee802154_beacon_req_frame scan_beacon_req;
63 struct cfg802154_scan_request __rcu *scan_req;
64 struct delayed_work scan_work;
65
66 /* Beaconing */
67 unsigned int beacon_interval;
68 struct ieee802154_beacon_frame beacon;
69 struct cfg802154_beacon_request __rcu *beacon_req;
70 struct delayed_work beacon_work;
71
72 /* Asynchronous tasks */
73 struct list_head rx_beacon_list;
74 struct work_struct rx_beacon_work;
75 struct list_head rx_mac_cmd_list;
76 struct work_struct rx_mac_cmd_work;
77 /* Serializes rx_beacon_list and rx_mac_cmd_list against the RX
78 * softirq producer, the mac_wq workers and the teardown flush.
79 */
80 spinlock_t rx_lock;
81
82 /* Association */
83 /* assoc_lock protects assoc_dev_extended_addr, assoc_addr,
84 * assoc_status, the assoc_done reinit/complete pairing and the
85 * IEEE802154_IS_ASSOCIATING bit in @ongoing.
86 */
87 spinlock_t assoc_lock;
88 __le64 assoc_dev_extended_addr;
89 struct completion assoc_done;
90 __le16 assoc_addr;
91 u8 assoc_status;
92 struct work_struct assoc_work;
93
94 bool started;
95 bool suspended;
96 unsigned long ongoing;
97
98 struct tasklet_struct tasklet;
99 struct sk_buff_head skb_queue;
100
101 struct sk_buff *tx_skb;
102 struct work_struct sync_tx_work;
103 /* A negative Linux error code or a null/positive MLME error status */
104 int tx_result;
105 };
106
107 enum {
108 IEEE802154_RX_MSG = 1,
109 };
110
111 enum ieee802154_sdata_state_bits {
112 SDATA_STATE_RUNNING,
113 };
114
115 /* Slave interface definition.
116 *
117 * Slaves represent typical network interfaces available from userspace.
118 * Each ieee802154 device/transceiver may have several slaves and able
119 * to be associated with several networks at the same time.
120 */
121 struct ieee802154_sub_if_data {
122 struct list_head list; /* the ieee802154_priv->slaves list */
123
124 struct wpan_dev wpan_dev;
125
126 struct ieee802154_local *local;
127 struct net_device *dev;
128
129 /* Each interface starts and works in nominal state at a given filtering
130 * level given by iface_default_filtering, which is set once for all at
131 * the interface creation and should not evolve over time. For some MAC
132 * operations however, the filtering level may change temporarily, as
133 * reflected in the required_filtering field. The actual filtering at
134 * the PHY level may be different and is shown in struct wpan_phy.
135 */
136 enum ieee802154_filtering_level iface_default_filtering;
137 enum ieee802154_filtering_level required_filtering;
138
139 unsigned long state;
140 char name[IFNAMSIZ];
141
142 /* protects sec from concurrent access by netlink. access by
143 * encrypt/decrypt/header_create safe without additional protection.
144 */
145 struct mutex sec_mtx;
146
147 struct mac802154_llsec sec;
148 };
149
150 /* utility functions/constants */
151 extern const void *const mac802154_wpan_phy_privid; /* for wpan_phy privid */
152
153 static inline struct ieee802154_local *
hw_to_local(struct ieee802154_hw * hw)154 hw_to_local(struct ieee802154_hw *hw)
155 {
156 return container_of(hw, struct ieee802154_local, hw);
157 }
158
159 static inline struct ieee802154_sub_if_data *
IEEE802154_DEV_TO_SUB_IF(const struct net_device * dev)160 IEEE802154_DEV_TO_SUB_IF(const struct net_device *dev)
161 {
162 return netdev_priv(dev);
163 }
164
165 static inline struct ieee802154_sub_if_data *
IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev * wpan_dev)166 IEEE802154_WPAN_DEV_TO_SUB_IF(struct wpan_dev *wpan_dev)
167 {
168 return container_of(wpan_dev, struct ieee802154_sub_if_data, wpan_dev);
169 }
170
171 static inline bool
ieee802154_sdata_running(struct ieee802154_sub_if_data * sdata)172 ieee802154_sdata_running(struct ieee802154_sub_if_data *sdata)
173 {
174 return test_bit(SDATA_STATE_RUNNING, &sdata->state);
175 }
176
ieee802154_get_mac_cmd(struct sk_buff * skb,u8 * mac_cmd)177 static inline int ieee802154_get_mac_cmd(struct sk_buff *skb, u8 *mac_cmd)
178 {
179 struct ieee802154_mac_cmd_pl mac_pl;
180 int ret;
181
182 if (mac_cb(skb)->type != IEEE802154_FC_TYPE_MAC_CMD)
183 return -EINVAL;
184
185 ret = ieee802154_mac_cmd_pl_pull(skb, &mac_pl);
186 if (ret)
187 return ret;
188
189 *mac_cmd = mac_pl.cmd_id;
190 return 0;
191 }
192
193 extern struct ieee802154_mlme_ops mac802154_mlme_wpan;
194
195 void ieee802154_rx(struct ieee802154_local *local, struct sk_buff *skb);
196 void ieee802154_xmit_sync_worker(struct work_struct *work);
197 int ieee802154_sync_and_hold_queue(struct ieee802154_local *local);
198 int ieee802154_mlme_op_pre(struct ieee802154_local *local);
199 int ieee802154_mlme_tx(struct ieee802154_local *local,
200 struct ieee802154_sub_if_data *sdata,
201 struct sk_buff *skb);
202 int ieee802154_mlme_tx_locked(struct ieee802154_local *local,
203 struct ieee802154_sub_if_data *sdata,
204 struct sk_buff *skb);
205 void ieee802154_mlme_op_post(struct ieee802154_local *local);
206 int ieee802154_mlme_tx_one_locked(struct ieee802154_local *local,
207 struct ieee802154_sub_if_data *sdata,
208 struct sk_buff *skb);
209 netdev_tx_t
210 ieee802154_monitor_start_xmit(struct sk_buff *skb, struct net_device *dev);
211 netdev_tx_t
212 ieee802154_subif_start_xmit(struct sk_buff *skb, struct net_device *dev);
213 enum hrtimer_restart ieee802154_xmit_ifs_timer(struct hrtimer *timer);
214
215 /**
216 * ieee802154_hold_queue - hold ieee802154 queue
217 * @local: main mac object
218 *
219 * Hold a queue by incrementing an atomic counter and requesting the netif
220 * queues to be stopped. The queues cannot be woken up while the counter has not
221 * been reset with as any ieee802154_release_queue() calls as needed.
222 */
223 void ieee802154_hold_queue(struct ieee802154_local *local);
224
225 /**
226 * ieee802154_release_queue - release ieee802154 queue
227 * @local: main mac object
228 *
229 * Release a queue which is held by decrementing an atomic counter and wake it
230 * up only if the counter reaches 0.
231 */
232 void ieee802154_release_queue(struct ieee802154_local *local);
233
234 /**
235 * ieee802154_disable_queue - disable ieee802154 queue
236 * @local: main mac object
237 *
238 * When trying to sync the Tx queue, we cannot just stop the queue
239 * (which is basically a bit being set without proper lock handling)
240 * because it would be racy. We actually need to call netif_tx_disable()
241 * instead, which is done by this helper. Restarting the queue can
242 * however still be done with a regular wake call.
243 */
244 void ieee802154_disable_queue(struct ieee802154_local *local);
245
246 /* MIB callbacks */
247 void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan);
248
249 int mac802154_get_params(struct net_device *dev,
250 struct ieee802154_llsec_params *params);
251 int mac802154_set_params(struct net_device *dev,
252 const struct ieee802154_llsec_params *params,
253 int changed);
254
255 int mac802154_add_key(struct net_device *dev,
256 const struct ieee802154_llsec_key_id *id,
257 const struct ieee802154_llsec_key *key);
258 int mac802154_del_key(struct net_device *dev,
259 const struct ieee802154_llsec_key_id *id);
260
261 int mac802154_add_dev(struct net_device *dev,
262 const struct ieee802154_llsec_device *llsec_dev);
263 int mac802154_del_dev(struct net_device *dev, __le64 dev_addr);
264
265 int mac802154_add_devkey(struct net_device *dev,
266 __le64 device_addr,
267 const struct ieee802154_llsec_device_key *key);
268 int mac802154_del_devkey(struct net_device *dev,
269 __le64 device_addr,
270 const struct ieee802154_llsec_device_key *key);
271
272 int mac802154_add_seclevel(struct net_device *dev,
273 const struct ieee802154_llsec_seclevel *sl);
274 int mac802154_del_seclevel(struct net_device *dev,
275 const struct ieee802154_llsec_seclevel *sl);
276
277 void mac802154_lock_table(struct net_device *dev);
278 void mac802154_get_table(struct net_device *dev,
279 struct ieee802154_llsec_table **t);
280 void mac802154_unlock_table(struct net_device *dev);
281
282 int mac802154_wpan_update_llsec(struct net_device *dev);
283
284 /* PAN management handling */
285 void mac802154_scan_worker(struct work_struct *work);
286 int mac802154_trigger_scan_locked(struct ieee802154_sub_if_data *sdata,
287 struct cfg802154_scan_request *request);
288 int mac802154_abort_scan_locked(struct ieee802154_local *local,
289 struct ieee802154_sub_if_data *sdata);
290 int mac802154_process_beacon(struct ieee802154_local *local,
291 struct sk_buff *skb,
292 u8 page, u8 channel);
293 void mac802154_rx_beacon_worker(struct work_struct *work);
294
mac802154_is_scanning(struct ieee802154_local * local)295 static inline bool mac802154_is_scanning(struct ieee802154_local *local)
296 {
297 return test_bit(IEEE802154_IS_SCANNING, &local->ongoing);
298 }
299
300 void mac802154_beacon_worker(struct work_struct *work);
301 int mac802154_send_beacons_locked(struct ieee802154_sub_if_data *sdata,
302 struct cfg802154_beacon_request *request);
303 int mac802154_stop_beacons_locked(struct ieee802154_local *local,
304 struct ieee802154_sub_if_data *sdata);
305
mac802154_is_beaconing(struct ieee802154_local * local)306 static inline bool mac802154_is_beaconing(struct ieee802154_local *local)
307 {
308 return test_bit(IEEE802154_IS_BEACONING, &local->ongoing);
309 }
310
311 void mac802154_rx_mac_cmd_worker(struct work_struct *work);
312 void mac802154_flush_list(struct list_head *list,
313 struct ieee802154_sub_if_data *sdata);
314 void mac802154_flush_queued_pkts(struct ieee802154_local *local,
315 struct ieee802154_sub_if_data *sdata);
316
317 int mac802154_perform_association(struct ieee802154_sub_if_data *sdata,
318 struct ieee802154_pan_device *coord,
319 __le16 *short_addr);
320 int mac802154_process_association_resp(struct ieee802154_sub_if_data *sdata,
321 struct sk_buff *skb);
322
mac802154_is_associating(struct ieee802154_local * local)323 static inline bool mac802154_is_associating(struct ieee802154_local *local)
324 {
325 return test_bit(IEEE802154_IS_ASSOCIATING, &local->ongoing);
326 }
327
328 int mac802154_send_disassociation_notif(struct ieee802154_sub_if_data *sdata,
329 struct ieee802154_pan_device *target,
330 u8 reason);
331 int mac802154_process_disassociation_notif(struct ieee802154_sub_if_data *sdata,
332 struct sk_buff *skb);
333 int mac802154_process_association_req(struct ieee802154_sub_if_data *sdata,
334 struct sk_buff *skb);
335
336 /* interface handling */
337 int ieee802154_iface_init(void);
338 void ieee802154_iface_exit(void);
339 void ieee802154_if_remove(struct ieee802154_sub_if_data *sdata);
340 struct net_device *
341 ieee802154_if_add(struct ieee802154_local *local, const char *name,
342 unsigned char name_assign_type, enum nl802154_iftype type,
343 __le64 extended_addr);
344 void ieee802154_remove_interfaces(struct ieee802154_local *local);
345 void ieee802154_stop_device(struct ieee802154_local *local);
346
347 #endif /* __IEEE802154_I_H */
348