treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 174
[sfrench/cifs-2.6.git] / net / mac802154 / main.c
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(unsigned long data)
24 {
25         struct ieee802154_local *local = (struct ieee802154_local *)data;
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         mutex_init(&local->iflist_mtx);
93
94         tasklet_init(&local->tasklet,
95                      ieee802154_tasklet_handler,
96                      (unsigned long)local);
97
98         skb_queue_head_init(&local->skb_queue);
99
100         INIT_WORK(&local->tx_work, ieee802154_xmit_worker);
101
102         /* init supported flags with 802.15.4 default ranges */
103         phy->supported.max_minbe = 8;
104         phy->supported.min_maxbe = 3;
105         phy->supported.max_maxbe = 8;
106         phy->supported.min_frame_retries = 0;
107         phy->supported.max_frame_retries = 7;
108         phy->supported.max_csma_backoffs = 5;
109         phy->supported.lbt = NL802154_SUPPORTED_BOOL_FALSE;
110
111         /* always supported */
112         phy->supported.iftypes = BIT(NL802154_IFTYPE_NODE);
113
114         return &local->hw;
115 }
116 EXPORT_SYMBOL(ieee802154_alloc_hw);
117
118 void ieee802154_free_hw(struct ieee802154_hw *hw)
119 {
120         struct ieee802154_local *local = hw_to_local(hw);
121
122         BUG_ON(!list_empty(&local->interfaces));
123
124         mutex_destroy(&local->iflist_mtx);
125
126         wpan_phy_free(local->phy);
127 }
128 EXPORT_SYMBOL(ieee802154_free_hw);
129
130 static void ieee802154_setup_wpan_phy_pib(struct wpan_phy *wpan_phy)
131 {
132         /* TODO warn on empty symbol_duration
133          * Should be done when all drivers sets this value.
134          */
135
136         wpan_phy->lifs_period = IEEE802154_LIFS_PERIOD *
137                                 wpan_phy->symbol_duration;
138         wpan_phy->sifs_period = IEEE802154_SIFS_PERIOD *
139                                 wpan_phy->symbol_duration;
140 }
141
142 int ieee802154_register_hw(struct ieee802154_hw *hw)
143 {
144         struct ieee802154_local *local = hw_to_local(hw);
145         struct net_device *dev;
146         int rc = -ENOSYS;
147
148         local->workqueue =
149                 create_singlethread_workqueue(wpan_phy_name(local->phy));
150         if (!local->workqueue) {
151                 rc = -ENOMEM;
152                 goto out;
153         }
154
155         hrtimer_init(&local->ifs_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
156         local->ifs_timer.function = ieee802154_xmit_ifs_timer;
157
158         wpan_phy_set_dev(local->phy, local->hw.parent);
159
160         ieee802154_setup_wpan_phy_pib(local->phy);
161
162         if (!(hw->flags & IEEE802154_HW_CSMA_PARAMS)) {
163                 local->phy->supported.min_csma_backoffs = 4;
164                 local->phy->supported.max_csma_backoffs = 4;
165                 local->phy->supported.min_maxbe = 5;
166                 local->phy->supported.max_maxbe = 5;
167                 local->phy->supported.min_minbe = 3;
168                 local->phy->supported.max_minbe = 3;
169         }
170
171         if (!(hw->flags & IEEE802154_HW_FRAME_RETRIES)) {
172                 local->phy->supported.min_frame_retries = 3;
173                 local->phy->supported.max_frame_retries = 3;
174         }
175
176         if (hw->flags & IEEE802154_HW_PROMISCUOUS)
177                 local->phy->supported.iftypes |= BIT(NL802154_IFTYPE_MONITOR);
178
179         rc = wpan_phy_register(local->phy);
180         if (rc < 0)
181                 goto out_wq;
182
183         rtnl_lock();
184
185         dev = ieee802154_if_add(local, "wpan%d", NET_NAME_ENUM,
186                                 NL802154_IFTYPE_NODE,
187                                 cpu_to_le64(0x0000000000000000ULL));
188         if (IS_ERR(dev)) {
189                 rtnl_unlock();
190                 rc = PTR_ERR(dev);
191                 goto out_phy;
192         }
193
194         rtnl_unlock();
195
196         return 0;
197
198 out_phy:
199         wpan_phy_unregister(local->phy);
200 out_wq:
201         destroy_workqueue(local->workqueue);
202 out:
203         return rc;
204 }
205 EXPORT_SYMBOL(ieee802154_register_hw);
206
207 void ieee802154_unregister_hw(struct ieee802154_hw *hw)
208 {
209         struct ieee802154_local *local = hw_to_local(hw);
210
211         tasklet_kill(&local->tasklet);
212         flush_workqueue(local->workqueue);
213
214         rtnl_lock();
215
216         ieee802154_remove_interfaces(local);
217
218         rtnl_unlock();
219
220         destroy_workqueue(local->workqueue);
221         wpan_phy_unregister(local->phy);
222 }
223 EXPORT_SYMBOL(ieee802154_unregister_hw);
224
225 static int __init ieee802154_init(void)
226 {
227         return ieee802154_iface_init();
228 }
229
230 static void __exit ieee802154_exit(void)
231 {
232         ieee802154_iface_exit();
233
234         rcu_barrier();
235 }
236
237 subsys_initcall(ieee802154_init);
238 module_exit(ieee802154_exit);
239
240 MODULE_DESCRIPTION("IEEE 802.15.4 subsystem");
241 MODULE_LICENSE("GPL v2");