2 * mac80211 glue code for mac80211 Prism54 drivers
4 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
5 * Copyright (c) 2007-2009, Christian Lamparter <chunkeey@web.de>
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
9 * - the islsm (softmac prism54) driver, which is:
10 * Copyright 2004-2006 Jean-Baptiste Note <jbnote@gmail.com>, et al.
12 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/firmware.h>
22 #include <linux/etherdevice.h>
23 #include <linux/module.h>
25 #include <net/mac80211.h>
30 static bool modparam_nohwcrypt;
31 module_param_named(nohwcrypt, modparam_nohwcrypt, bool, S_IRUGO);
32 MODULE_PARM_DESC(nohwcrypt, "Disable hardware encryption.");
33 MODULE_AUTHOR("Michael Wu <flamingice@sourmilk.net>");
34 MODULE_DESCRIPTION("Softmac Prism54 common code");
35 MODULE_LICENSE("GPL");
36 MODULE_ALIAS("prism54common");
38 static int p54_sta_add_remove(struct ieee80211_hw *hw,
39 struct ieee80211_vif *vif,
40 struct ieee80211_sta *sta)
42 struct p54_common *priv = hw->priv;
45 * Notify the firmware that we don't want or we don't
46 * need to buffer frames for this station anymore.
49 p54_sta_unlock(priv, sta->addr);
54 static void p54_sta_notify(struct ieee80211_hw *dev, struct ieee80211_vif *vif,
55 enum sta_notify_cmd notify_cmd,
56 struct ieee80211_sta *sta)
58 struct p54_common *priv = dev->priv;
61 case STA_NOTIFY_AWAKE:
62 /* update the firmware's filter table */
63 p54_sta_unlock(priv, sta->addr);
70 static int p54_set_tim(struct ieee80211_hw *dev, struct ieee80211_sta *sta,
73 struct p54_common *priv = dev->priv;
75 return p54_update_beacon_tim(priv, sta->aid, set);
78 u8 *p54_find_ie(struct sk_buff *skb, u8 ie)
80 struct ieee80211_mgmt *mgmt = (void *)skb->data;
83 if (skb->len <= sizeof(mgmt))
86 pos = (u8 *)mgmt->u.beacon.variable;
87 end = skb->data + skb->len;
89 if (pos + 2 + pos[1] > end)
100 static int p54_beacon_format_ie_tim(struct sk_buff *skb)
103 * the good excuse for this mess is ... the firmware.
104 * The dummy TIM MUST be at the end of the beacon frame,
105 * because it'll be overwritten!
112 tim = p54_find_ie(skb, WLAN_EID_TIM);
117 dtim_period = tim[3];
118 next = tim + 2 + dtim_len;
123 memmove(tim, next, skb_tail_pointer(skb) - next);
124 tim = skb_tail_pointer(skb) - (dtim_len + 2);
126 /* add the dummy at the end */
127 tim[0] = WLAN_EID_TIM;
130 tim[3] = dtim_period;
134 skb_trim(skb, skb->len - (dtim_len - 3));
139 static int p54_beacon_update(struct p54_common *priv,
140 struct ieee80211_vif *vif)
142 struct sk_buff *beacon;
145 beacon = ieee80211_beacon_get(priv->hw, vif);
148 ret = p54_beacon_format_ie_tim(beacon);
153 * During operation, the firmware takes care of beaconing.
154 * The driver only needs to upload a new beacon template, once
155 * the template was changed by the stack or userspace.
157 * LMAC API 3.2.2 also specifies that the driver does not need
158 * to cancel the old beacon template by hand, instead the firmware
159 * will release the previous one through the feedback mechanism.
161 p54_tx_80211(priv->hw, beacon);
162 priv->tsf_high32 = 0;
168 static int p54_start(struct ieee80211_hw *dev)
170 struct p54_common *priv = dev->priv;
173 mutex_lock(&priv->conf_mutex);
174 err = priv->open(dev);
177 P54_SET_QUEUE(priv->qos_params[0], 0x0002, 0x0003, 0x0007, 47);
178 P54_SET_QUEUE(priv->qos_params[1], 0x0002, 0x0007, 0x000f, 94);
179 P54_SET_QUEUE(priv->qos_params[2], 0x0003, 0x000f, 0x03ff, 0);
180 P54_SET_QUEUE(priv->qos_params[3], 0x0007, 0x000f, 0x03ff, 0);
181 err = p54_set_edcf(priv);
185 memset(priv->bssid, ~0, ETH_ALEN);
186 priv->mode = NL80211_IFTYPE_MONITOR;
187 err = p54_setup_mac(priv);
189 priv->mode = NL80211_IFTYPE_UNSPECIFIED;
193 ieee80211_queue_delayed_work(dev, &priv->work, 0);
195 priv->softled_state = 0;
196 err = p54_set_leds(priv);
199 mutex_unlock(&priv->conf_mutex);
203 static void p54_stop(struct ieee80211_hw *dev)
205 struct p54_common *priv = dev->priv;
208 priv->mode = NL80211_IFTYPE_UNSPECIFIED;
209 priv->softled_state = 0;
210 cancel_delayed_work_sync(&priv->work);
211 mutex_lock(&priv->conf_mutex);
214 skb_queue_purge(&priv->tx_pending);
215 skb_queue_purge(&priv->tx_queue);
216 for (i = 0; i < P54_QUEUE_NUM; i++) {
217 priv->tx_stats[i].count = 0;
218 priv->tx_stats[i].len = 0;
221 priv->beacon_req_id = cpu_to_le32(0);
222 priv->tsf_high32 = priv->tsf_low32 = 0;
223 mutex_unlock(&priv->conf_mutex);
226 static int p54_add_interface(struct ieee80211_hw *dev,
227 struct ieee80211_vif *vif)
229 struct p54_common *priv = dev->priv;
231 vif->driver_flags |= IEEE80211_VIF_BEACON_FILTER;
233 mutex_lock(&priv->conf_mutex);
234 if (priv->mode != NL80211_IFTYPE_MONITOR) {
235 mutex_unlock(&priv->conf_mutex);
242 case NL80211_IFTYPE_STATION:
243 case NL80211_IFTYPE_ADHOC:
244 case NL80211_IFTYPE_AP:
245 case NL80211_IFTYPE_MESH_POINT:
246 priv->mode = vif->type;
249 mutex_unlock(&priv->conf_mutex);
253 memcpy(priv->mac_addr, vif->addr, ETH_ALEN);
255 mutex_unlock(&priv->conf_mutex);
259 static void p54_remove_interface(struct ieee80211_hw *dev,
260 struct ieee80211_vif *vif)
262 struct p54_common *priv = dev->priv;
264 mutex_lock(&priv->conf_mutex);
268 * LMAC API 3.2.2 states that any active beacon template must be
269 * canceled by the driver before attempting a mode transition.
271 if (le32_to_cpu(priv->beacon_req_id) != 0) {
272 p54_tx_cancel(priv, priv->beacon_req_id);
273 wait_for_completion_interruptible_timeout(&priv->beacon_comp, HZ);
275 priv->mode = NL80211_IFTYPE_MONITOR;
276 memset(priv->mac_addr, 0, ETH_ALEN);
277 memset(priv->bssid, 0, ETH_ALEN);
279 mutex_unlock(&priv->conf_mutex);
282 static int p54_wait_for_stats(struct ieee80211_hw *dev)
284 struct p54_common *priv = dev->priv;
287 priv->update_stats = true;
288 ret = p54_fetch_statistics(priv);
292 ret = wait_for_completion_interruptible_timeout(&priv->stat_comp, HZ);
299 static void p54_reset_stats(struct p54_common *priv)
301 struct ieee80211_channel *chan = priv->curchan;
304 struct survey_info *info = &priv->survey[chan->hw_value];
306 /* only reset channel statistics, don't touch .filled, etc. */
307 info->channel_time = 0;
308 info->channel_time_busy = 0;
309 info->channel_time_tx = 0;
312 priv->update_stats = true;
313 priv->survey_raw.active = 0;
314 priv->survey_raw.cca = 0;
315 priv->survey_raw.tx = 0;
318 static int p54_config(struct ieee80211_hw *dev, u32 changed)
321 struct p54_common *priv = dev->priv;
322 struct ieee80211_conf *conf = &dev->conf;
324 mutex_lock(&priv->conf_mutex);
325 if (changed & IEEE80211_CONF_CHANGE_POWER)
326 priv->output_power = conf->power_level << 2;
327 if (changed & IEEE80211_CONF_CHANGE_CHANNEL) {
328 struct ieee80211_channel *oldchan;
329 WARN_ON(p54_wait_for_stats(dev));
330 oldchan = priv->curchan;
331 priv->curchan = NULL;
332 ret = p54_scan(priv, P54_SCAN_EXIT, 0);
334 priv->curchan = oldchan;
338 * TODO: Use the LM_SCAN_TRAP to determine the current
341 priv->curchan = priv->hw->conf.channel;
342 p54_reset_stats(priv);
343 WARN_ON(p54_fetch_statistics(priv));
345 if (changed & IEEE80211_CONF_CHANGE_PS) {
346 WARN_ON(p54_wait_for_stats(dev));
347 ret = p54_set_ps(priv);
350 WARN_ON(p54_wait_for_stats(dev));
352 if (changed & IEEE80211_CONF_CHANGE_IDLE) {
353 WARN_ON(p54_wait_for_stats(dev));
354 ret = p54_setup_mac(priv);
357 WARN_ON(p54_wait_for_stats(dev));
361 mutex_unlock(&priv->conf_mutex);
365 static u64 p54_prepare_multicast(struct ieee80211_hw *dev,
366 struct netdev_hw_addr_list *mc_list)
368 struct p54_common *priv = dev->priv;
369 struct netdev_hw_addr *ha;
372 BUILD_BUG_ON(ARRAY_SIZE(priv->mc_maclist) !=
373 ARRAY_SIZE(((struct p54_group_address_table *)NULL)->mac_list));
375 * The first entry is reserved for the global broadcast MAC.
376 * Otherwise the firmware will drop it and ARP will no longer work.
379 priv->mc_maclist_num = netdev_hw_addr_list_count(mc_list) + i;
380 netdev_hw_addr_list_for_each(ha, mc_list) {
381 memcpy(&priv->mc_maclist[i], ha->addr, ETH_ALEN);
383 if (i >= ARRAY_SIZE(priv->mc_maclist))
387 return 1; /* update */
390 static void p54_configure_filter(struct ieee80211_hw *dev,
391 unsigned int changed_flags,
392 unsigned int *total_flags,
395 struct p54_common *priv = dev->priv;
397 *total_flags &= FIF_PROMISC_IN_BSS |
401 priv->filter_flags = *total_flags;
403 if (changed_flags & (FIF_PROMISC_IN_BSS | FIF_OTHER_BSS))
406 if (changed_flags & FIF_ALLMULTI || multicast)
407 p54_set_groupfilter(priv);
410 static int p54_conf_tx(struct ieee80211_hw *dev,
411 struct ieee80211_vif *vif, u16 queue,
412 const struct ieee80211_tx_queue_params *params)
414 struct p54_common *priv = dev->priv;
417 mutex_lock(&priv->conf_mutex);
418 if (queue < dev->queues) {
419 P54_SET_QUEUE(priv->qos_params[queue], params->aifs,
420 params->cw_min, params->cw_max, params->txop);
421 ret = p54_set_edcf(priv);
424 mutex_unlock(&priv->conf_mutex);
428 static void p54_work(struct work_struct *work)
430 struct p54_common *priv = container_of(work, struct p54_common,
433 if (unlikely(priv->mode == NL80211_IFTYPE_UNSPECIFIED))
437 * TODO: walk through tx_queue and do the following tasks
438 * 1. initiate bursts.
439 * 2. cancel stuck frames / reset the device if necessary.
442 mutex_lock(&priv->conf_mutex);
443 WARN_ON_ONCE(p54_fetch_statistics(priv));
444 mutex_unlock(&priv->conf_mutex);
447 static int p54_get_stats(struct ieee80211_hw *dev,
448 struct ieee80211_low_level_stats *stats)
450 struct p54_common *priv = dev->priv;
452 memcpy(stats, &priv->stats, sizeof(*stats));
456 static void p54_bss_info_changed(struct ieee80211_hw *dev,
457 struct ieee80211_vif *vif,
458 struct ieee80211_bss_conf *info,
461 struct p54_common *priv = dev->priv;
463 mutex_lock(&priv->conf_mutex);
464 if (changed & BSS_CHANGED_BSSID) {
465 memcpy(priv->bssid, info->bssid, ETH_ALEN);
469 if (changed & BSS_CHANGED_BEACON) {
470 p54_scan(priv, P54_SCAN_EXIT, 0);
472 p54_beacon_update(priv, vif);
476 if (changed & (BSS_CHANGED_ERP_SLOT | BSS_CHANGED_BEACON)) {
477 priv->use_short_slot = info->use_short_slot;
480 if (changed & BSS_CHANGED_BASIC_RATES) {
481 if (dev->conf.channel->band == IEEE80211_BAND_5GHZ)
482 priv->basic_rate_mask = (info->basic_rates << 4);
484 priv->basic_rate_mask = info->basic_rates;
486 if (priv->fw_var >= 0x500)
487 p54_scan(priv, P54_SCAN_EXIT, 0);
489 if (changed & BSS_CHANGED_ASSOC) {
491 priv->aid = info->aid;
492 priv->wakeup_timer = info->beacon_int *
493 info->dtim_period * 5;
496 priv->wakeup_timer = 500;
501 mutex_unlock(&priv->conf_mutex);
504 static int p54_set_key(struct ieee80211_hw *dev, enum set_key_cmd cmd,
505 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
506 struct ieee80211_key_conf *key)
508 struct p54_common *priv = dev->priv;
513 if (modparam_nohwcrypt)
516 mutex_lock(&priv->conf_mutex);
517 if (cmd == SET_KEY) {
518 switch (key->cipher) {
519 case WLAN_CIPHER_SUITE_TKIP:
520 if (!(priv->privacy_caps & (BR_DESC_PRIV_CAP_MICHAEL |
521 BR_DESC_PRIV_CAP_TKIP))) {
525 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
526 algo = P54_CRYPTO_TKIPMICHAEL;
528 case WLAN_CIPHER_SUITE_WEP40:
529 case WLAN_CIPHER_SUITE_WEP104:
530 if (!(priv->privacy_caps & BR_DESC_PRIV_CAP_WEP)) {
534 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
535 algo = P54_CRYPTO_WEP;
537 case WLAN_CIPHER_SUITE_CCMP:
538 if (!(priv->privacy_caps & BR_DESC_PRIV_CAP_AESCCMP)) {
542 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
543 algo = P54_CRYPTO_AESCCMP;
549 slot = bitmap_find_free_region(priv->used_rxkeys,
550 priv->rx_keycache_size, 0);
554 * The device supports the chosen algorithm, but the
555 * firmware does not provide enough key slots to store
557 * But encryption offload for outgoing frames is always
558 * possible, so we just pretend that the upload was
559 * successful and do the decryption in software.
562 /* mark the key as invalid. */
563 key->hw_key_idx = 0xff;
567 slot = key->hw_key_idx;
570 /* This key was not uploaded into the rx key cache. */
575 bitmap_release_region(priv->used_rxkeys, slot, 0);
582 ret = p54_upload_key(priv, algo, slot, key->keyidx,
583 key->keylen, addr, key->key);
585 bitmap_release_region(priv->used_rxkeys, slot, 0);
590 key->hw_key_idx = slot;
593 mutex_unlock(&priv->conf_mutex);
597 static int p54_get_survey(struct ieee80211_hw *dev, int idx,
598 struct survey_info *survey)
600 struct p54_common *priv = dev->priv;
601 struct ieee80211_channel *chan;
605 if (idx >= priv->chan_num)
609 for (tries = 0; tries < MAX_TRIES; tries++) {
610 chan = priv->curchan;
611 if (chan && chan->hw_value == idx) {
612 mutex_lock(&priv->conf_mutex);
613 err = p54_wait_for_stats(dev);
614 mutex_unlock(&priv->conf_mutex);
621 memcpy(survey, &priv->survey[idx], sizeof(*survey));
624 /* test if the reported statistics are valid. */
625 if (survey->channel_time != 0) {
626 survey->filled |= SURVEY_INFO_IN_USE;
629 * hw/fw has not accumulated enough sample sets.
630 * Wait for 100ms, this ought to be enough to
631 * to get at least one non-null set of channel
644 static unsigned int p54_flush_count(struct p54_common *priv)
646 unsigned int total = 0, i;
648 BUILD_BUG_ON(P54_QUEUE_NUM > ARRAY_SIZE(priv->tx_stats));
651 * Because the firmware has the sole control over any frames
652 * in the P54_QUEUE_BEACON or P54_QUEUE_SCAN queues, they
653 * don't really count as pending or active.
655 for (i = P54_QUEUE_MGMT; i < P54_QUEUE_NUM; i++)
656 total += priv->tx_stats[i].len;
660 static void p54_flush(struct ieee80211_hw *dev, bool drop)
662 struct p54_common *priv = dev->priv;
663 unsigned int total, i;
666 * Currently, it wouldn't really matter if we wait for one second
667 * or 15 minutes. But once someone gets around and completes the
668 * TODOs [ancel stuck frames / reset device] in p54_work, it will
669 * suddenly make sense to wait that long.
671 i = P54_STATISTICS_UPDATE * 2 / 20;
674 * In this case no locking is required because as we speak the
675 * queues have already been stopped and no new frames can sneak
678 while ((total = p54_flush_count(priv) && i--)) {
683 WARN(total, "tx flush timeout, unresponsive firmware");
686 static void p54_set_coverage_class(struct ieee80211_hw *dev, u8 coverage_class)
688 struct p54_common *priv = dev->priv;
690 mutex_lock(&priv->conf_mutex);
691 /* support all coverage class values as in 802.11-2007 Table 7-27 */
692 priv->coverage_class = clamp_t(u8, coverage_class, 0, 31);
694 mutex_unlock(&priv->conf_mutex);
697 static const struct ieee80211_ops p54_ops = {
701 .add_interface = p54_add_interface,
702 .remove_interface = p54_remove_interface,
703 .set_tim = p54_set_tim,
704 .sta_notify = p54_sta_notify,
705 .sta_add = p54_sta_add_remove,
706 .sta_remove = p54_sta_add_remove,
707 .set_key = p54_set_key,
708 .config = p54_config,
710 .bss_info_changed = p54_bss_info_changed,
711 .prepare_multicast = p54_prepare_multicast,
712 .configure_filter = p54_configure_filter,
713 .conf_tx = p54_conf_tx,
714 .get_stats = p54_get_stats,
715 .get_survey = p54_get_survey,
716 .set_coverage_class = p54_set_coverage_class,
719 struct ieee80211_hw *p54_init_common(size_t priv_data_len)
721 struct ieee80211_hw *dev;
722 struct p54_common *priv;
724 dev = ieee80211_alloc_hw(priv_data_len, &p54_ops);
730 priv->mode = NL80211_IFTYPE_UNSPECIFIED;
731 priv->basic_rate_mask = 0x15f;
732 spin_lock_init(&priv->tx_stats_lock);
733 skb_queue_head_init(&priv->tx_queue);
734 skb_queue_head_init(&priv->tx_pending);
735 dev->flags = IEEE80211_HW_RX_INCLUDES_FCS |
736 IEEE80211_HW_SIGNAL_DBM |
737 IEEE80211_HW_SUPPORTS_PS |
738 IEEE80211_HW_PS_NULLFUNC_STACK |
739 IEEE80211_HW_REPORTS_TX_ACK_STATUS;
741 dev->wiphy->interface_modes = BIT(NL80211_IFTYPE_STATION) |
742 BIT(NL80211_IFTYPE_ADHOC) |
743 BIT(NL80211_IFTYPE_AP) |
744 BIT(NL80211_IFTYPE_MESH_POINT);
746 dev->channel_change_time = 1000; /* TODO: find actual value */
747 priv->beacon_req_id = cpu_to_le32(0);
748 priv->tx_stats[P54_QUEUE_BEACON].limit = 1;
749 priv->tx_stats[P54_QUEUE_FWSCAN].limit = 1;
750 priv->tx_stats[P54_QUEUE_MGMT].limit = 3;
751 priv->tx_stats[P54_QUEUE_CAB].limit = 3;
752 priv->tx_stats[P54_QUEUE_DATA].limit = 5;
756 * We support at most 8 tries no matter which rate they're at,
757 * we cannot support max_rates * max_rate_tries as we set it
758 * here, but setting it correctly to 4/2 or so would limit us
759 * artificially if the RC algorithm wants just two rates, so
760 * let's say 4/7, we'll redistribute it at TX time, see the
764 dev->max_rate_tries = 7;
765 dev->extra_tx_headroom = sizeof(struct p54_hdr) + 4 +
766 sizeof(struct p54_tx_data);
769 * For now, disable PS by default because it affects
770 * link stability significantly.
772 dev->wiphy->flags &= ~WIPHY_FLAG_PS_ON_BY_DEFAULT;
774 mutex_init(&priv->conf_mutex);
775 mutex_init(&priv->eeprom_mutex);
776 init_completion(&priv->stat_comp);
777 init_completion(&priv->eeprom_comp);
778 init_completion(&priv->beacon_comp);
779 INIT_DELAYED_WORK(&priv->work, p54_work);
781 memset(&priv->mc_maclist[0], ~0, ETH_ALEN);
782 priv->curchan = NULL;
783 p54_reset_stats(priv);
786 EXPORT_SYMBOL_GPL(p54_init_common);
788 int p54_register_common(struct ieee80211_hw *dev, struct device *pdev)
790 struct p54_common __maybe_unused *priv = dev->priv;
793 err = ieee80211_register_hw(dev);
795 dev_err(pdev, "Cannot register device (%d).\n", err);
799 #ifdef CONFIG_P54_LEDS
800 err = p54_init_leds(priv);
803 #endif /* CONFIG_P54_LEDS */
805 dev_info(pdev, "is registered as '%s'\n", wiphy_name(dev->wiphy));
808 EXPORT_SYMBOL_GPL(p54_register_common);
810 void p54_free_common(struct ieee80211_hw *dev)
812 struct p54_common *priv = dev->priv;
815 for (i = 0; i < IEEE80211_NUM_BANDS; i++)
816 kfree(priv->band_table[i]);
818 kfree(priv->iq_autocal);
819 kfree(priv->output_limit);
820 kfree(priv->curve_data);
821 kfree(priv->rssi_db);
822 kfree(priv->used_rxkeys);
824 priv->iq_autocal = NULL;
825 priv->output_limit = NULL;
826 priv->curve_data = NULL;
827 priv->rssi_db = NULL;
828 priv->used_rxkeys = NULL;
830 ieee80211_free_hw(dev);
832 EXPORT_SYMBOL_GPL(p54_free_common);
834 void p54_unregister_common(struct ieee80211_hw *dev)
836 struct p54_common *priv = dev->priv;
838 #ifdef CONFIG_P54_LEDS
839 p54_unregister_leds(priv);
840 #endif /* CONFIG_P54_LEDS */
842 ieee80211_unregister_hw(dev);
843 mutex_destroy(&priv->conf_mutex);
844 mutex_destroy(&priv->eeprom_mutex);
846 EXPORT_SYMBOL_GPL(p54_unregister_common);