1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Device probe and register.
4 *
5 * Copyright (c) 2017-2020, Silicon Laboratories, Inc.
6 * Copyright (c) 2010, ST-Ericsson
7 * Copyright (c) 2008, Johannes Berg <johannes@sipsolutions.net>
8 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
9 * Copyright (c) 2007-2009, Christian Lamparter <chunkeey@web.de>
10 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
11 * Copyright (c) 2004-2006 Jean-Baptiste Note <jbnote@gmail.com>, et al.
12 */
13 #include <linux/module.h>
14 #include <linux/of.h>
15 #include <linux/of_net.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/mmc/sdio_func.h>
18 #include <linux/spi/spi.h>
19 #include <linux/etherdevice.h>
20 #include <linux/firmware.h>
21
22 #include "main.h"
23 #include "wfx.h"
24 #include "fwio.h"
25 #include "hwio.h"
26 #include "bus.h"
27 #include "bh.h"
28 #include "sta.h"
29 #include "key.h"
30 #include "scan.h"
31 #include "debug.h"
32 #include "data_tx.h"
33 #include "hif_tx_mib.h"
34 #include "hif_api_cmd.h"
35
36 #define WFX_PDS_TLV_TYPE 0x4450 // "PD" (Platform Data) in ascii little-endian
37 #define WFX_PDS_MAX_CHUNK_SIZE 1500
38
39 MODULE_DESCRIPTION("Silicon Labs 802.11 Wireless LAN driver for WF200");
40 MODULE_AUTHOR("Jérôme Pouiller <jerome.pouiller@silabs.com>");
41 MODULE_LICENSE("GPL");
42
43 #define RATETAB_ENT(_rate, _rateid, _flags) { \
44 .bitrate = (_rate), \
45 .hw_value = (_rateid), \
46 .flags = (_flags), \
47 }
48
49 static struct ieee80211_rate wfx_rates[] = {
50 RATETAB_ENT(10, 0, 0),
51 RATETAB_ENT(20, 1, IEEE80211_RATE_SHORT_PREAMBLE),
52 RATETAB_ENT(55, 2, IEEE80211_RATE_SHORT_PREAMBLE),
53 RATETAB_ENT(110, 3, IEEE80211_RATE_SHORT_PREAMBLE),
54 RATETAB_ENT(60, 6, 0),
55 RATETAB_ENT(90, 7, 0),
56 RATETAB_ENT(120, 8, 0),
57 RATETAB_ENT(180, 9, 0),
58 RATETAB_ENT(240, 10, 0),
59 RATETAB_ENT(360, 11, 0),
60 RATETAB_ENT(480, 12, 0),
61 RATETAB_ENT(540, 13, 0),
62 };
63
64 #define CHAN2G(_channel, _freq, _flags) { \
65 .band = NL80211_BAND_2GHZ, \
66 .center_freq = (_freq), \
67 .hw_value = (_channel), \
68 .flags = (_flags), \
69 .max_antenna_gain = 0, \
70 .max_power = 30, \
71 }
72
73 static struct ieee80211_channel wfx_2ghz_chantable[] = {
74 CHAN2G(1, 2412, 0),
75 CHAN2G(2, 2417, 0),
76 CHAN2G(3, 2422, 0),
77 CHAN2G(4, 2427, 0),
78 CHAN2G(5, 2432, 0),
79 CHAN2G(6, 2437, 0),
80 CHAN2G(7, 2442, 0),
81 CHAN2G(8, 2447, 0),
82 CHAN2G(9, 2452, 0),
83 CHAN2G(10, 2457, 0),
84 CHAN2G(11, 2462, 0),
85 CHAN2G(12, 2467, 0),
86 CHAN2G(13, 2472, 0),
87 CHAN2G(14, 2484, 0),
88 };
89
90 static const struct ieee80211_supported_band wfx_band_2ghz = {
91 .channels = wfx_2ghz_chantable,
92 .n_channels = ARRAY_SIZE(wfx_2ghz_chantable),
93 .bitrates = wfx_rates,
94 .n_bitrates = ARRAY_SIZE(wfx_rates),
95 .ht_cap = {
96 /* Receive caps */
97 .cap = IEEE80211_HT_CAP_GRN_FLD | IEEE80211_HT_CAP_SGI_20 |
98 IEEE80211_HT_CAP_MAX_AMSDU | (1 << IEEE80211_HT_CAP_RX_STBC_SHIFT),
99 .ht_supported = 1,
100 .ampdu_factor = IEEE80211_HT_MAX_AMPDU_16K,
101 .ampdu_density = IEEE80211_HT_MPDU_DENSITY_NONE,
102 .mcs = {
103 .rx_mask = { 0xFF }, /* MCS0 to MCS7 */
104 .rx_highest = cpu_to_le16(72),
105 .tx_params = IEEE80211_HT_MCS_TX_DEFINED,
106 },
107 },
108 };
109
110 static const struct ieee80211_iface_limit wdev_iface_limits[] = {
111 { .max = 1, .types = BIT(NL80211_IFTYPE_STATION) },
112 { .max = 1, .types = BIT(NL80211_IFTYPE_AP) },
113 };
114
115 static const struct ieee80211_iface_combination wfx_iface_combinations[] = {
116 {
117 .num_different_channels = 2,
118 .max_interfaces = 2,
119 .limits = wdev_iface_limits,
120 .n_limits = ARRAY_SIZE(wdev_iface_limits),
121 }
122 };
123
124 static const struct ieee80211_ops wfx_ops = {
125 .start = wfx_start,
126 .stop = wfx_stop,
127 .add_interface = wfx_add_interface,
128 .remove_interface = wfx_remove_interface,
129 .config = wfx_config,
130 .tx = wfx_tx,
131 .wake_tx_queue = ieee80211_handle_wake_tx_queue,
132 .join_ibss = wfx_join_ibss,
133 .leave_ibss = wfx_leave_ibss,
134 .conf_tx = wfx_conf_tx,
135 .hw_scan = wfx_hw_scan,
136 .cancel_hw_scan = wfx_cancel_hw_scan,
137 .start_ap = wfx_start_ap,
138 .stop_ap = wfx_stop_ap,
139 .sta_add = wfx_sta_add,
140 .sta_remove = wfx_sta_remove,
141 .set_tim = wfx_set_tim,
142 .set_key = wfx_set_key,
143 .set_rts_threshold = wfx_set_rts_threshold,
144 .set_default_unicast_key = wfx_set_default_unicast_key,
145 .bss_info_changed = wfx_bss_info_changed,
146 .configure_filter = wfx_configure_filter,
147 .ampdu_action = wfx_ampdu_action,
148 .flush = wfx_flush,
149 .add_chanctx = wfx_add_chanctx,
150 .remove_chanctx = wfx_remove_chanctx,
151 .change_chanctx = wfx_change_chanctx,
152 .assign_vif_chanctx = wfx_assign_vif_chanctx,
153 .unassign_vif_chanctx = wfx_unassign_vif_chanctx,
154 };
155
wfx_api_older_than(struct wfx_dev * wdev,int major,int minor)156 bool wfx_api_older_than(struct wfx_dev *wdev, int major, int minor)
157 {
158 if (wdev->hw_caps.api_version_major < major)
159 return true;
160 if (wdev->hw_caps.api_version_major > major)
161 return false;
162 if (wdev->hw_caps.api_version_minor < minor)
163 return true;
164 return false;
165 }
166
167 /* The device needs data about the antenna configuration. This information in provided by PDS
168 * (Platform Data Set, this is the wording used in WF200 documentation) files. For hardware
169 * integrators, the full process to create PDS files is described here:
170 * https://github.com/SiliconLabs/wfx-firmware/blob/master/PDS/README.md
171 *
172 * The PDS file is an array of Time-Length-Value structs.
173 */
wfx_send_pds(struct wfx_dev * wdev,u8 * buf,size_t len)174 int wfx_send_pds(struct wfx_dev *wdev, u8 *buf, size_t len)
175 {
176 int ret, chunk_type, chunk_len, chunk_num = 0;
177
178 if (*buf == '{') {
179 dev_err(wdev->dev, "PDS: malformed file (legacy format?)\n");
180 return -EINVAL;
181 }
182 while (len > 0) {
183 chunk_type = get_unaligned_le16(buf + 0);
184 chunk_len = get_unaligned_le16(buf + 2);
185 if (chunk_len < 4 || chunk_len > len) {
186 dev_err(wdev->dev, "PDS:%d: corrupted file\n", chunk_num);
187 return -EINVAL;
188 }
189 if (chunk_type != WFX_PDS_TLV_TYPE) {
190 dev_info(wdev->dev, "PDS:%d: skip unknown data\n", chunk_num);
191 goto next;
192 }
193 if (chunk_len > WFX_PDS_MAX_CHUNK_SIZE)
194 dev_warn(wdev->dev, "PDS:%d: unexpectedly large chunk\n", chunk_num);
195 if (buf[4] != '{' || buf[chunk_len - 1] != '}')
196 dev_warn(wdev->dev, "PDS:%d: unexpected content\n", chunk_num);
197
198 ret = wfx_hif_configuration(wdev, buf + 4, chunk_len - 4);
199 if (ret > 0) {
200 dev_err(wdev->dev, "PDS:%d: invalid data (unsupported options?)\n", chunk_num);
201 return -EINVAL;
202 }
203 if (ret == -ETIMEDOUT) {
204 dev_err(wdev->dev, "PDS:%d: chip didn't reply (corrupted file?)\n", chunk_num);
205 return ret;
206 }
207 if (ret) {
208 dev_err(wdev->dev, "PDS:%d: chip returned an unknown error\n", chunk_num);
209 return -EIO;
210 }
211 next:
212 chunk_num++;
213 len -= chunk_len;
214 buf += chunk_len;
215 }
216 return 0;
217 }
218
wfx_send_pdata_pds(struct wfx_dev * wdev)219 static int wfx_send_pdata_pds(struct wfx_dev *wdev)
220 {
221 int ret = 0;
222 const struct firmware *pds;
223 u8 *tmp_buf;
224
225 ret = request_firmware(&pds, wdev->pdata.file_pds, wdev->dev);
226 if (ret) {
227 dev_err(wdev->dev, "can't load antenna parameters (PDS file %s). The device may be unstable.\n",
228 wdev->pdata.file_pds);
229 return ret;
230 }
231 tmp_buf = kmemdup(pds->data, pds->size, GFP_KERNEL);
232 if (!tmp_buf) {
233 ret = -ENOMEM;
234 goto release_fw;
235 }
236 ret = wfx_send_pds(wdev, tmp_buf, pds->size);
237 kfree(tmp_buf);
238 release_fw:
239 release_firmware(pds);
240 return ret;
241 }
242
wfx_free_common(void * data)243 static void wfx_free_common(void *data)
244 {
245 struct wfx_dev *wdev = data;
246
247 mutex_destroy(&wdev->tx_power_loop_info_lock);
248 mutex_destroy(&wdev->rx_stats_lock);
249 mutex_destroy(&wdev->conf_mutex);
250 ieee80211_free_hw(wdev->hw);
251 }
252
wfx_init_common(struct device * dev,const struct wfx_platform_data * pdata,const struct wfx_hwbus_ops * hwbus_ops,void * hwbus_priv)253 struct wfx_dev *wfx_init_common(struct device *dev, const struct wfx_platform_data *pdata,
254 const struct wfx_hwbus_ops *hwbus_ops, void *hwbus_priv)
255 {
256 struct ieee80211_hw *hw;
257 struct wfx_dev *wdev;
258
259 hw = ieee80211_alloc_hw(sizeof(struct wfx_dev), &wfx_ops);
260 if (!hw)
261 return NULL;
262
263 SET_IEEE80211_DEV(hw, dev);
264
265 ieee80211_hw_set(hw, TX_AMPDU_SETUP_IN_HW);
266 ieee80211_hw_set(hw, AMPDU_AGGREGATION);
267 ieee80211_hw_set(hw, CONNECTION_MONITOR);
268 ieee80211_hw_set(hw, REPORTS_TX_ACK_STATUS);
269 ieee80211_hw_set(hw, SUPPORTS_DYNAMIC_PS);
270 ieee80211_hw_set(hw, SIGNAL_DBM);
271 ieee80211_hw_set(hw, SUPPORTS_PS);
272 ieee80211_hw_set(hw, MFP_CAPABLE);
273
274 hw->vif_data_size = sizeof(struct wfx_vif);
275 hw->sta_data_size = sizeof(struct wfx_sta_priv);
276 hw->queues = 4;
277 hw->max_rates = 8;
278 hw->max_rate_tries = 8;
279 hw->extra_tx_headroom = sizeof(struct wfx_hif_msg) + sizeof(struct wfx_hif_req_tx) +
280 4 /* alignment */ + 8 /* TKIP IV */;
281 hw->wiphy->interface_modes = BIT(NL80211_IFTYPE_STATION) |
282 BIT(NL80211_IFTYPE_ADHOC) |
283 BIT(NL80211_IFTYPE_AP);
284 hw->wiphy->probe_resp_offload = NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS |
285 NL80211_PROBE_RESP_OFFLOAD_SUPPORT_WPS2 |
286 NL80211_PROBE_RESP_OFFLOAD_SUPPORT_P2P |
287 NL80211_PROBE_RESP_OFFLOAD_SUPPORT_80211U;
288 hw->wiphy->features |= NL80211_FEATURE_AP_SCAN;
289 hw->wiphy->flags |= WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD;
290 hw->wiphy->flags |= WIPHY_FLAG_AP_UAPSD;
291 hw->wiphy->max_ap_assoc_sta = HIF_LINK_ID_MAX;
292 hw->wiphy->max_scan_ssids = 2;
293 hw->wiphy->max_scan_ie_len = IEEE80211_MAX_DATA_LEN;
294 hw->wiphy->n_iface_combinations = ARRAY_SIZE(wfx_iface_combinations);
295 hw->wiphy->iface_combinations = wfx_iface_combinations;
296 /* FIXME: also copy wfx_rates and wfx_2ghz_chantable */
297 hw->wiphy->bands[NL80211_BAND_2GHZ] = devm_kmemdup(dev, &wfx_band_2ghz,
298 sizeof(wfx_band_2ghz), GFP_KERNEL);
299 if (!hw->wiphy->bands[NL80211_BAND_2GHZ])
300 goto err;
301
302 wdev = hw->priv;
303 wdev->hw = hw;
304 wdev->dev = dev;
305 wdev->hwbus_ops = hwbus_ops;
306 wdev->hwbus_priv = hwbus_priv;
307 memcpy(&wdev->pdata, pdata, sizeof(*pdata));
308 of_property_read_string(dev->of_node, "silabs,antenna-config-file", &wdev->pdata.file_pds);
309 wdev->pdata.gpio_wakeup = devm_gpiod_get_optional(dev, "wakeup", GPIOD_OUT_LOW);
310 if (IS_ERR(wdev->pdata.gpio_wakeup))
311 goto err;
312
313 if (wdev->pdata.gpio_wakeup)
314 gpiod_set_consumer_name(wdev->pdata.gpio_wakeup, "wfx wakeup");
315
316 mutex_init(&wdev->conf_mutex);
317 mutex_init(&wdev->rx_stats_lock);
318 mutex_init(&wdev->tx_power_loop_info_lock);
319 init_completion(&wdev->firmware_ready);
320 INIT_DELAYED_WORK(&wdev->cooling_timeout_work, wfx_cooling_timeout_work);
321 skb_queue_head_init(&wdev->tx_pending);
322 init_waitqueue_head(&wdev->tx_dequeue);
323 wfx_init_hif_cmd(&wdev->hif_cmd);
324
325 if (devm_add_action_or_reset(dev, wfx_free_common, wdev))
326 return NULL;
327
328 return wdev;
329
330 err:
331 ieee80211_free_hw(hw);
332 return NULL;
333 }
334
wfx_probe(struct wfx_dev * wdev)335 int wfx_probe(struct wfx_dev *wdev)
336 {
337 int i;
338 int err;
339 struct gpio_desc *gpio_saved;
340
341 /* During first part of boot, gpio_wakeup cannot yet been used. So prevent bh() to touch
342 * it.
343 */
344 gpio_saved = wdev->pdata.gpio_wakeup;
345 wdev->pdata.gpio_wakeup = NULL;
346 wdev->poll_irq = true;
347
348 wdev->bh_wq = alloc_workqueue("wfx_bh_wq", WQ_HIGHPRI, 0);
349 if (!wdev->bh_wq)
350 return -ENOMEM;
351
352 wfx_bh_register(wdev);
353
354 err = wfx_init_device(wdev);
355 if (err)
356 goto bh_unregister;
357
358 wfx_bh_poll_irq(wdev);
359 err = wait_for_completion_timeout(&wdev->firmware_ready, 1 * HZ);
360 if (err == 0) {
361 dev_err(wdev->dev, "timeout while waiting for startup indication\n");
362 err = -ETIMEDOUT;
363 goto bh_unregister;
364 }
365
366 /* FIXME: fill wiphy::hw_version */
367 dev_info(wdev->dev, "started firmware %d.%d.%d \"%s\" (API: %d.%d, keyset: %02X, caps: 0x%.8X)\n",
368 wdev->hw_caps.firmware_major, wdev->hw_caps.firmware_minor,
369 wdev->hw_caps.firmware_build, wdev->hw_caps.firmware_label,
370 wdev->hw_caps.api_version_major, wdev->hw_caps.api_version_minor,
371 wdev->keyset, wdev->hw_caps.link_mode);
372 snprintf(wdev->hw->wiphy->fw_version,
373 sizeof(wdev->hw->wiphy->fw_version),
374 "%d.%d.%d",
375 wdev->hw_caps.firmware_major,
376 wdev->hw_caps.firmware_minor,
377 wdev->hw_caps.firmware_build);
378
379 if (wfx_api_older_than(wdev, 1, 0)) {
380 dev_err(wdev->dev, "unsupported firmware API version (expect 1 while firmware returns %d)\n",
381 wdev->hw_caps.api_version_major);
382 err = -EOPNOTSUPP;
383 goto bh_unregister;
384 }
385
386 if (wdev->hw_caps.link_mode == SEC_LINK_ENFORCED) {
387 dev_err(wdev->dev, "chip require secure_link, but can't negotiate it\n");
388 goto bh_unregister;
389 }
390
391 if (wdev->hw_caps.region_sel_mode) {
392 wdev->hw->wiphy->regulatory_flags |= REGULATORY_DISABLE_BEACON_HINTS;
393 wdev->hw->wiphy->bands[NL80211_BAND_2GHZ]->channels[11].flags |=
394 IEEE80211_CHAN_NO_IR;
395 wdev->hw->wiphy->bands[NL80211_BAND_2GHZ]->channels[12].flags |=
396 IEEE80211_CHAN_NO_IR;
397 wdev->hw->wiphy->bands[NL80211_BAND_2GHZ]->channels[13].flags |=
398 IEEE80211_CHAN_DISABLED;
399 }
400
401 dev_dbg(wdev->dev, "sending configuration file %s\n", wdev->pdata.file_pds);
402 err = wfx_send_pdata_pds(wdev);
403 if (err < 0 && err != -ENOENT)
404 goto bh_unregister;
405
406 wdev->poll_irq = false;
407 err = wdev->hwbus_ops->irq_subscribe(wdev->hwbus_priv);
408 if (err)
409 goto bh_unregister;
410
411 err = wfx_hif_use_multi_tx_conf(wdev, true);
412 if (err)
413 dev_err(wdev->dev, "misconfigured IRQ?\n");
414
415 wdev->pdata.gpio_wakeup = gpio_saved;
416 if (wdev->pdata.gpio_wakeup) {
417 dev_dbg(wdev->dev, "enable 'quiescent' power mode with wakeup GPIO and PDS file %s\n",
418 wdev->pdata.file_pds);
419 gpiod_set_value_cansleep(wdev->pdata.gpio_wakeup, 1);
420 wfx_control_reg_write(wdev, 0);
421 wfx_hif_set_operational_mode(wdev, HIF_OP_POWER_MODE_QUIESCENT);
422 } else {
423 wfx_hif_set_operational_mode(wdev, HIF_OP_POWER_MODE_DOZE);
424 }
425
426 for (i = 0; i < ARRAY_SIZE(wdev->addresses); i++) {
427 eth_zero_addr(wdev->addresses[i].addr);
428 err = of_get_mac_address(wdev->dev->of_node, wdev->addresses[i].addr);
429 if (!err)
430 wdev->addresses[i].addr[ETH_ALEN - 1] += i;
431 else
432 ether_addr_copy(wdev->addresses[i].addr, wdev->hw_caps.mac_addr[i]);
433 if (!is_valid_ether_addr(wdev->addresses[i].addr)) {
434 dev_warn(wdev->dev, "using random MAC address\n");
435 eth_random_addr(wdev->addresses[i].addr);
436 }
437 dev_info(wdev->dev, "MAC address %d: %pM\n", i, wdev->addresses[i].addr);
438 }
439 wdev->hw->wiphy->n_addresses = ARRAY_SIZE(wdev->addresses);
440 wdev->hw->wiphy->addresses = wdev->addresses;
441
442 if (!wfx_api_older_than(wdev, 3, 8))
443 wdev->hw->wiphy->flags |= WIPHY_FLAG_SUPPORTS_TDLS;
444
445 err = ieee80211_register_hw(wdev->hw);
446 if (err)
447 goto irq_unsubscribe;
448
449 err = wfx_debug_init(wdev);
450 if (err)
451 goto ieee80211_unregister;
452
453 return 0;
454
455 ieee80211_unregister:
456 ieee80211_unregister_hw(wdev->hw);
457 irq_unsubscribe:
458 wdev->hwbus_ops->irq_unsubscribe(wdev->hwbus_priv);
459 bh_unregister:
460 wfx_bh_unregister(wdev);
461 destroy_workqueue(wdev->bh_wq);
462 return err;
463 }
464
wfx_release(struct wfx_dev * wdev)465 void wfx_release(struct wfx_dev *wdev)
466 {
467 ieee80211_unregister_hw(wdev->hw);
468 wfx_hif_shutdown(wdev);
469 wdev->hwbus_ops->irq_unsubscribe(wdev->hwbus_priv);
470 wfx_bh_unregister(wdev);
471 destroy_workqueue(wdev->bh_wq);
472 }
473
wfx_core_init(void)474 static int __init wfx_core_init(void)
475 {
476 int ret = 0;
477
478 if (IS_ENABLED(CONFIG_SPI))
479 ret = spi_register_driver(&wfx_spi_driver);
480 if (IS_ENABLED(CONFIG_MMC) && !ret)
481 ret = sdio_register_driver(&wfx_sdio_driver);
482 return ret;
483 }
484 module_init(wfx_core_init);
485
wfx_core_exit(void)486 static void __exit wfx_core_exit(void)
487 {
488 if (IS_ENABLED(CONFIG_MMC))
489 sdio_unregister_driver(&wfx_sdio_driver);
490 if (IS_ENABLED(CONFIG_SPI))
491 spi_unregister_driver(&wfx_spi_driver);
492 }
493 module_exit(wfx_core_exit);
494