1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Copyright (C) 2007-2012 Siemens AG
4 *
5 * Written by:
6 * Alexander Smirnov <alex.bluesman.smirnov@gmail.com>
7 */
8
9 #include <linux/kernel.h>
10 #include <linux/module.h>
11 #include <linux/netdevice.h>
12
13 #include <net/netlink.h>
14 #include <net/nl802154.h>
15 #include <net/mac802154.h>
16 #include <net/ieee802154_netdev.h>
17 #include <net/route.h>
18 #include <net/cfg802154.h>
19
20 #include "ieee802154_i.h"
21 #include "cfg.h"
22
23 static void ieee802154_tasklet_handler(struct tasklet_struct *t)
24 {
25 struct ieee802154_local *local = from_tasklet(local, t, tasklet);
26 struct sk_buff *skb;
27
28 while ((skb = skb_dequeue(&local->skb_queue))) {
29 switch (skb->pkt_type) {
30 case IEEE802154_RX_MSG:
31 /* Clear skb->pkt_type in order to not confuse kernel
32 * netstack.
33 */
34 skb->pkt_type = 0;
35 ieee802154_rx(local, skb);
36 break;
37 default:
38 WARN(1, "mac802154: Packet is of unknown type %d\n",
39 skb->pkt_type);
40 kfree_skb(skb);
41 break;
42 }
43 }
44 }
45
46 struct ieee802154_hw *
47 ieee802154_alloc_hw(size_t priv_data_len, const struct ieee802154_ops *ops)
48 {
49 struct wpan_phy *phy;
50 struct ieee802154_local *local;
51 size_t priv_size;
52
53 if (WARN_ON(!ops || !(ops->xmit_async || ops->xmit_sync) || !ops->ed ||
54 !ops->start || !ops->stop || !ops->set_channel))
55 return NULL;
56
57 /* Ensure 32-byte alignment of our private data and hw private data.
58 * We use the wpan_phy priv data for both our ieee802154_local and for
59 * the driver's private data
60 *
61 * in memory it'll be like this:
62 *
63 * +-------------------------+
64 * | struct wpan_phy |
65 * +-------------------------+
66 * | struct ieee802154_local |
67 * +-------------------------+
68 * | driver's private data |
69 * +-------------------------+
70 *
71 * Due to ieee802154 layer isn't aware of driver and MAC structures,
72 * so lets align them here.
73 */
74
75 priv_size = ALIGN(sizeof(*local), NETDEV_ALIGN) + priv_data_len;
76
77 phy = wpan_phy_new(&mac802154_config_ops, priv_size);
78 if (!phy) {
79 pr_err("failure to allocate master IEEE802.15.4 device\n");
80 return NULL;
81 }
82
83 phy->privid = mac802154_wpan_phy_privid;
84
85 local = wpan_phy_priv(phy);
86 local->phy = phy;
87 local->hw.phy = local->phy;
88 local->hw.priv = (char *)local + ALIGN(sizeof(*local), NETDEV_ALIGN);
89 local->ops = ops;
90
91 INIT_LIST_HEAD(&local->interfaces);
92 INIT_LIST_HEAD(&local->rx_beacon_list);
93 INIT_LIST_HEAD(&local->rx_mac_cmd_list);
94 mutex_init(&local->iflist_mtx);
95
96 tasklet_setup(&local->tasklet, ieee802154_tasklet_handler);
97
98 skb_queue_head_init(&local->skb_queue);
99
100 INIT_WORK(&local->sync_tx_work, ieee802154_xmit_sync_worker);
101 INIT_DELAYED_WORK(&local->scan_work, mac802154_scan_worker);
102 INIT_WORK(&local->rx_beacon_work, mac802154_rx_beacon_worker);
103 INIT_DELAYED_WORK(&local->beacon_work, mac802154_beacon_worker);
104 INIT_WORK(&local->rx_mac_cmd_work, mac802154_rx_mac_cmd_worker);
105
106 init_completion(&local->assoc_done);
107
108 /* init supported flags with 802.15.4 default ranges */
109 phy->supported.max_minbe = 8;
110 phy->supported.min_maxbe = 3;
111 phy->supported.max_maxbe = 8;
112 phy->supported.min_frame_retries = 0;
113 phy->supported.max_frame_retries = 7;
114 phy->supported.max_csma_backoffs = 5;
115 phy->supported.lbt = NL802154_SUPPORTED_BOOL_FALSE;
116
117 /* always supported */
118 phy->supported.iftypes = BIT(NL802154_IFTYPE_NODE) | BIT(NL802154_IFTYPE_COORD);
119
120 return &local->hw;
121 }
122 EXPORT_SYMBOL(ieee802154_alloc_hw);
123
124 void ieee802154_configure_durations(struct wpan_phy *phy,
125 unsigned int page, unsigned int channel)
126 {
127 u32 duration = 0;
128
129 switch (page) {
130 case 0:
131 if (BIT(channel) & 0x1)
132 /* 868 MHz BPSK 802.15.4-2003: 20 ksym/s */
133 duration = 50 * NSEC_PER_USEC;
134 else if (BIT(channel) & 0x7FE)
135 /* 915 MHz BPSK 802.15.4-2003: 40 ksym/s */
136 duration = 25 * NSEC_PER_USEC;
137 else if (BIT(channel) & 0x7FFF800)
138 /* 2400 MHz O-QPSK 802.15.4-2006: 62.5 ksym/s */
139 duration = 16 * NSEC_PER_USEC;
140 break;
141 case 2:
142 if (BIT(channel) & 0x1)
143 /* 868 MHz O-QPSK 802.15.4-2006: 25 ksym/s */
144 duration = 40 * NSEC_PER_USEC;
145 else if (BIT(channel) & 0x7FE)
146 /* 915 MHz O-QPSK 802.15.4-2006: 62.5 ksym/s */
147 duration = 16 * NSEC_PER_USEC;
148 break;
149 case 3:
150 if (BIT(channel) & 0x3FFF)
151 /* 2.4 GHz CSS 802.15.4a-2007: 1/6 Msym/s */
152 duration = 6 * NSEC_PER_USEC;
153 break;
154 default:
155 break;
156 }
157
158 if (!duration) {
159 pr_debug("Unknown PHY symbol duration\n");
160 return;
161 }
162
163 phy->symbol_duration = duration;
164 phy->lifs_period =
165 (IEEE802154_LIFS_PERIOD * phy->symbol_duration) / NSEC_PER_USEC;
166 phy->sifs_period =
167 (IEEE802154_SIFS_PERIOD * phy->symbol_duration) / NSEC_PER_USEC;
168 }
169 EXPORT_SYMBOL(ieee802154_configure_durations);
170
171 void ieee802154_free_hw(struct ieee802154_hw *hw)
172 {
173 struct ieee802154_local *local = hw_to_local(hw);
174
175 BUG_ON(!list_empty(&local->interfaces));
176
177 mutex_destroy(&local->iflist_mtx);
178
179 wpan_phy_free(local->phy);
180 }
181 EXPORT_SYMBOL(ieee802154_free_hw);
182
183 static void ieee802154_setup_wpan_phy_pib(struct wpan_phy *wpan_phy)
184 {
185 /* TODO warn on empty symbol_duration
186 * Should be done when all drivers sets this value.
187 */
188
189 wpan_phy->lifs_period = (IEEE802154_LIFS_PERIOD *
190 wpan_phy->symbol_duration) / NSEC_PER_USEC;
191 wpan_phy->sifs_period = (IEEE802154_SIFS_PERIOD *
192 wpan_phy->symbol_duration) / NSEC_PER_USEC;
193 }
194
195 int ieee802154_register_hw(struct ieee802154_hw *hw)
196 {
197 struct ieee802154_local *local = hw_to_local(hw);
198 char mac_wq_name[IFNAMSIZ + 10] = {};
199 struct net_device *dev;
200 int rc = -ENOSYS;
201
202 local->workqueue =
203 create_singlethread_workqueue(wpan_phy_name(local->phy));
204 if (!local->workqueue) {
205 rc = -ENOMEM;
206 goto out;
207 }
208
209 snprintf(mac_wq_name, IFNAMSIZ + 10, "%s-mac-cmds", wpan_phy_name(local->phy));
210 local->mac_wq = create_singlethread_workqueue(mac_wq_name);
211 if (!local->mac_wq) {
212 rc = -ENOMEM;
213 goto out_wq;
214 }
215
216 hrtimer_init(&local->ifs_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
217 local->ifs_timer.function = ieee802154_xmit_ifs_timer;
218
219 wpan_phy_set_dev(local->phy, local->hw.parent);
220
221 ieee802154_setup_wpan_phy_pib(local->phy);
222
223 ieee802154_configure_durations(local->phy, local->phy->current_page,
224 local->phy->current_channel);
225
226 if (!(hw->flags & IEEE802154_HW_CSMA_PARAMS)) {
227 local->phy->supported.min_csma_backoffs = 4;
228 local->phy->supported.max_csma_backoffs = 4;
229 local->phy->supported.min_maxbe = 5;
230 local->phy->supported.max_maxbe = 5;
231 local->phy->supported.min_minbe = 3;
232 local->phy->supported.max_minbe = 3;
233 }
234
235 if (!(hw->flags & IEEE802154_HW_FRAME_RETRIES)) {
236 local->phy->supported.min_frame_retries = 3;
237 local->phy->supported.max_frame_retries = 3;
238 }
239
240 if (hw->flags & IEEE802154_HW_PROMISCUOUS)
241 local->phy->supported.iftypes |= BIT(NL802154_IFTYPE_MONITOR);
242
243 rc = wpan_phy_register(local->phy);
244 if (rc < 0)
245 goto out_mac_wq;
246
247 rtnl_lock();
248
249 dev = ieee802154_if_add(local, "wpan%d", NET_NAME_ENUM,
250 NL802154_IFTYPE_NODE,
251 cpu_to_le64(0x0000000000000000ULL));
252 if (IS_ERR(dev)) {
253 rtnl_unlock();
254 rc = PTR_ERR(dev);
255 goto out_phy;
256 }
257
258 rtnl_unlock();
259
260 return 0;
261
262 out_phy:
263 wpan_phy_unregister(local->phy);
264 out_mac_wq:
265 destroy_workqueue(local->mac_wq);
266 out_wq:
267 destroy_workqueue(local->workqueue);
268 out:
269 return rc;
270 }
271 EXPORT_SYMBOL(ieee802154_register_hw);
272
273 void ieee802154_unregister_hw(struct ieee802154_hw *hw)
274 {
275 struct ieee802154_local *local = hw_to_local(hw);
276
277 tasklet_kill(&local->tasklet);
278 flush_workqueue(local->workqueue);
279
280 rtnl_lock();
281
282 ieee802154_remove_interfaces(local);
283
284 rtnl_unlock();
285
286 destroy_workqueue(local->mac_wq);
287 destroy_workqueue(local->workqueue);
288 wpan_phy_unregister(local->phy);
289 }
290 EXPORT_SYMBOL(ieee802154_unregister_hw);
291
292 static int __init ieee802154_init(void)
293 {
294 return ieee802154_iface_init();
295 }
296
297 static void __exit ieee802154_exit(void)
298 {
299 ieee802154_iface_exit();
300
301 rcu_barrier();
302 }
303
304 subsys_initcall(ieee802154_init);
305 module_exit(ieee802154_exit);
306
307 MODULE_DESCRIPTION("IEEE 802.15.4 subsystem");
308 MODULE_LICENSE("GPL v2");
309
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.