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