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, NULL, 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;
232 vif->driver_flags |= IEEE80211_VIF_BEACON_FILTER;
234 mutex_lock(&priv->conf_mutex);
235 if (priv->mode != NL80211_IFTYPE_MONITOR) {
236 mutex_unlock(&priv->conf_mutex);
243 case NL80211_IFTYPE_STATION:
244 case NL80211_IFTYPE_ADHOC:
245 case NL80211_IFTYPE_AP:
246 case NL80211_IFTYPE_MESH_POINT:
247 priv->mode = vif->type;
250 mutex_unlock(&priv->conf_mutex);
254 memcpy(priv->mac_addr, vif->addr, ETH_ALEN);
255 err = p54_setup_mac(priv);
256 mutex_unlock(&priv->conf_mutex);
260 static void p54_remove_interface(struct ieee80211_hw *dev,
261 struct ieee80211_vif *vif)
263 struct p54_common *priv = dev->priv;
265 mutex_lock(&priv->conf_mutex);
269 * LMAC API 3.2.2 states that any active beacon template must be
270 * canceled by the driver before attempting a mode transition.
272 if (le32_to_cpu(priv->beacon_req_id) != 0) {
273 p54_tx_cancel(priv, priv->beacon_req_id);
274 wait_for_completion_interruptible_timeout(&priv->beacon_comp, HZ);
276 priv->mode = NL80211_IFTYPE_MONITOR;
277 memset(priv->mac_addr, 0, ETH_ALEN);
278 memset(priv->bssid, 0, ETH_ALEN);
280 mutex_unlock(&priv->conf_mutex);
283 static int p54_wait_for_stats(struct ieee80211_hw *dev)
285 struct p54_common *priv = dev->priv;
288 priv->update_stats = true;
289 ret = p54_fetch_statistics(priv);
293 ret = wait_for_completion_interruptible_timeout(&priv->stat_comp, HZ);
300 static void p54_reset_stats(struct p54_common *priv)
302 struct ieee80211_channel *chan = priv->curchan;
305 struct survey_info *info = &priv->survey[chan->hw_value];
307 /* only reset channel statistics, don't touch .filled, etc. */
308 info->channel_time = 0;
309 info->channel_time_busy = 0;
310 info->channel_time_tx = 0;
313 priv->update_stats = true;
314 priv->survey_raw.active = 0;
315 priv->survey_raw.cca = 0;
316 priv->survey_raw.tx = 0;
319 static int p54_config(struct ieee80211_hw *dev, u32 changed)
322 struct p54_common *priv = dev->priv;
323 struct ieee80211_conf *conf = &dev->conf;
325 mutex_lock(&priv->conf_mutex);
326 if (changed & IEEE80211_CONF_CHANGE_POWER)
327 priv->output_power = conf->power_level << 2;
328 if (changed & IEEE80211_CONF_CHANGE_CHANNEL) {
329 struct ieee80211_channel *oldchan;
330 WARN_ON(p54_wait_for_stats(dev));
331 oldchan = priv->curchan;
332 priv->curchan = NULL;
333 ret = p54_scan(priv, P54_SCAN_EXIT, 0);
335 priv->curchan = oldchan;
339 * TODO: Use the LM_SCAN_TRAP to determine the current
342 priv->curchan = priv->hw->conf.channel;
343 p54_reset_stats(priv);
344 WARN_ON(p54_fetch_statistics(priv));
346 if (changed & IEEE80211_CONF_CHANGE_PS) {
347 WARN_ON(p54_wait_for_stats(dev));
348 ret = p54_set_ps(priv);
351 WARN_ON(p54_wait_for_stats(dev));
353 if (changed & IEEE80211_CONF_CHANGE_IDLE) {
354 WARN_ON(p54_wait_for_stats(dev));
355 ret = p54_setup_mac(priv);
358 WARN_ON(p54_wait_for_stats(dev));
362 mutex_unlock(&priv->conf_mutex);
366 static u64 p54_prepare_multicast(struct ieee80211_hw *dev,
367 struct netdev_hw_addr_list *mc_list)
369 struct p54_common *priv = dev->priv;
370 struct netdev_hw_addr *ha;
373 BUILD_BUG_ON(ARRAY_SIZE(priv->mc_maclist) !=
374 ARRAY_SIZE(((struct p54_group_address_table *)NULL)->mac_list));
376 * The first entry is reserved for the global broadcast MAC.
377 * Otherwise the firmware will drop it and ARP will no longer work.
380 priv->mc_maclist_num = netdev_hw_addr_list_count(mc_list) + i;
381 netdev_hw_addr_list_for_each(ha, mc_list) {
382 memcpy(&priv->mc_maclist[i], ha->addr, ETH_ALEN);
384 if (i >= ARRAY_SIZE(priv->mc_maclist))
388 return 1; /* update */
391 static void p54_configure_filter(struct ieee80211_hw *dev,
392 unsigned int changed_flags,
393 unsigned int *total_flags,
396 struct p54_common *priv = dev->priv;
398 *total_flags &= FIF_PROMISC_IN_BSS |
402 priv->filter_flags = *total_flags;
404 if (changed_flags & (FIF_PROMISC_IN_BSS | FIF_OTHER_BSS))
407 if (changed_flags & FIF_ALLMULTI || multicast)
408 p54_set_groupfilter(priv);
411 static int p54_conf_tx(struct ieee80211_hw *dev,
412 struct ieee80211_vif *vif, u16 queue,
413 const struct ieee80211_tx_queue_params *params)
415 struct p54_common *priv = dev->priv;
418 mutex_lock(&priv->conf_mutex);
419 if (queue < dev->queues) {
420 P54_SET_QUEUE(priv->qos_params[queue], params->aifs,
421 params->cw_min, params->cw_max, params->txop);
422 ret = p54_set_edcf(priv);
425 mutex_unlock(&priv->conf_mutex);
429 static void p54_work(struct work_struct *work)
431 struct p54_common *priv = container_of(work, struct p54_common,
434 if (unlikely(priv->mode == NL80211_IFTYPE_UNSPECIFIED))
438 * TODO: walk through tx_queue and do the following tasks
439 * 1. initiate bursts.
440 * 2. cancel stuck frames / reset the device if necessary.
443 mutex_lock(&priv->conf_mutex);
444 WARN_ON_ONCE(p54_fetch_statistics(priv));
445 mutex_unlock(&priv->conf_mutex);
448 static int p54_get_stats(struct ieee80211_hw *dev,
449 struct ieee80211_low_level_stats *stats)
451 struct p54_common *priv = dev->priv;
453 memcpy(stats, &priv->stats, sizeof(*stats));
457 static void p54_bss_info_changed(struct ieee80211_hw *dev,
458 struct ieee80211_vif *vif,
459 struct ieee80211_bss_conf *info,
462 struct p54_common *priv = dev->priv;
464 mutex_lock(&priv->conf_mutex);
465 if (changed & BSS_CHANGED_BSSID) {
466 memcpy(priv->bssid, info->bssid, ETH_ALEN);
470 if (changed & BSS_CHANGED_BEACON) {
471 p54_scan(priv, P54_SCAN_EXIT, 0);
473 p54_beacon_update(priv, vif);
477 if (changed & (BSS_CHANGED_ERP_SLOT | BSS_CHANGED_BEACON)) {
478 priv->use_short_slot = info->use_short_slot;
481 if (changed & BSS_CHANGED_BASIC_RATES) {
482 if (dev->conf.channel->band == IEEE80211_BAND_5GHZ)
483 priv->basic_rate_mask = (info->basic_rates << 4);
485 priv->basic_rate_mask = info->basic_rates;
487 if (priv->fw_var >= 0x500)
488 p54_scan(priv, P54_SCAN_EXIT, 0);
490 if (changed & BSS_CHANGED_ASSOC) {
492 priv->aid = info->aid;
493 priv->wakeup_timer = info->beacon_int *
494 info->dtim_period * 5;
497 priv->wakeup_timer = 500;
502 mutex_unlock(&priv->conf_mutex);
505 static int p54_set_key(struct ieee80211_hw *dev, enum set_key_cmd cmd,
506 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
507 struct ieee80211_key_conf *key)
509 struct p54_common *priv = dev->priv;
514 if (modparam_nohwcrypt)
517 mutex_lock(&priv->conf_mutex);
518 if (cmd == SET_KEY) {
519 switch (key->cipher) {
520 case WLAN_CIPHER_SUITE_TKIP:
521 if (!(priv->privacy_caps & (BR_DESC_PRIV_CAP_MICHAEL |
522 BR_DESC_PRIV_CAP_TKIP))) {
526 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
527 algo = P54_CRYPTO_TKIPMICHAEL;
529 case WLAN_CIPHER_SUITE_WEP40:
530 case WLAN_CIPHER_SUITE_WEP104:
531 if (!(priv->privacy_caps & BR_DESC_PRIV_CAP_WEP)) {
535 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
536 algo = P54_CRYPTO_WEP;
538 case WLAN_CIPHER_SUITE_CCMP:
539 if (!(priv->privacy_caps & BR_DESC_PRIV_CAP_AESCCMP)) {
543 key->flags |= IEEE80211_KEY_FLAG_GENERATE_IV;
544 algo = P54_CRYPTO_AESCCMP;
550 slot = bitmap_find_free_region(priv->used_rxkeys,
551 priv->rx_keycache_size, 0);
555 * The device supports the chosen algorithm, but the
556 * firmware does not provide enough key slots to store
558 * But encryption offload for outgoing frames is always
559 * possible, so we just pretend that the upload was
560 * successful and do the decryption in software.
563 /* mark the key as invalid. */
564 key->hw_key_idx = 0xff;
568 slot = key->hw_key_idx;
571 /* This key was not uploaded into the rx key cache. */
576 bitmap_release_region(priv->used_rxkeys, slot, 0);
583 ret = p54_upload_key(priv, algo, slot, key->keyidx,
584 key->keylen, addr, key->key);
586 bitmap_release_region(priv->used_rxkeys, slot, 0);
591 key->hw_key_idx = slot;
594 mutex_unlock(&priv->conf_mutex);
598 static int p54_get_survey(struct ieee80211_hw *dev, int idx,
599 struct survey_info *survey)
601 struct p54_common *priv = dev->priv;
602 struct ieee80211_channel *chan;
606 if (idx >= priv->chan_num)
610 for (tries = 0; tries < MAX_TRIES; tries++) {
611 chan = priv->curchan;
612 if (chan && chan->hw_value == idx) {
613 mutex_lock(&priv->conf_mutex);
614 err = p54_wait_for_stats(dev);
615 mutex_unlock(&priv->conf_mutex);
622 memcpy(survey, &priv->survey[idx], sizeof(*survey));
625 /* test if the reported statistics are valid. */
626 if (survey->channel_time != 0) {
627 survey->filled |= SURVEY_INFO_IN_USE;
630 * hw/fw has not accumulated enough sample sets.
631 * Wait for 100ms, this ought to be enough to
632 * to get at least one non-null set of channel
645 static unsigned int p54_flush_count(struct p54_common *priv)
647 unsigned int total = 0, i;
649 BUILD_BUG_ON(P54_QUEUE_NUM > ARRAY_SIZE(priv->tx_stats));
652 * Because the firmware has the sole control over any frames
653 * in the P54_QUEUE_BEACON or P54_QUEUE_SCAN queues, they
654 * don't really count as pending or active.
656 for (i = P54_QUEUE_MGMT; i < P54_QUEUE_NUM; i++)
657 total += priv->tx_stats[i].len;
661 static void p54_flush(struct ieee80211_hw *dev, bool drop)
663 struct p54_common *priv = dev->priv;
664 unsigned int total, i;
667 * Currently, it wouldn't really matter if we wait for one second
668 * or 15 minutes. But once someone gets around and completes the
669 * TODOs [ancel stuck frames / reset device] in p54_work, it will
670 * suddenly make sense to wait that long.
672 i = P54_STATISTICS_UPDATE * 2 / 20;
675 * In this case no locking is required because as we speak the
676 * queues have already been stopped and no new frames can sneak
679 while ((total = p54_flush_count(priv) && i--)) {
684 WARN(total, "tx flush timeout, unresponsive firmware");
687 static void p54_set_coverage_class(struct ieee80211_hw *dev, u8 coverage_class)
689 struct p54_common *priv = dev->priv;
691 mutex_lock(&priv->conf_mutex);
692 /* support all coverage class values as in 802.11-2007 Table 7-27 */
693 priv->coverage_class = clamp_t(u8, coverage_class, 0, 31);
695 mutex_unlock(&priv->conf_mutex);
698 static const struct ieee80211_ops p54_ops = {
702 .add_interface = p54_add_interface,
703 .remove_interface = p54_remove_interface,
704 .set_tim = p54_set_tim,
705 .sta_notify = p54_sta_notify,
706 .sta_add = p54_sta_add_remove,
707 .sta_remove = p54_sta_add_remove,
708 .set_key = p54_set_key,
709 .config = p54_config,
711 .bss_info_changed = p54_bss_info_changed,
712 .prepare_multicast = p54_prepare_multicast,
713 .configure_filter = p54_configure_filter,
714 .conf_tx = p54_conf_tx,
715 .get_stats = p54_get_stats,
716 .get_survey = p54_get_survey,
717 .set_coverage_class = p54_set_coverage_class,
720 struct ieee80211_hw *p54_init_common(size_t priv_data_len)
722 struct ieee80211_hw *dev;
723 struct p54_common *priv;
725 dev = ieee80211_alloc_hw(priv_data_len, &p54_ops);
731 priv->mode = NL80211_IFTYPE_UNSPECIFIED;
732 priv->basic_rate_mask = 0x15f;
733 spin_lock_init(&priv->tx_stats_lock);
734 skb_queue_head_init(&priv->tx_queue);
735 skb_queue_head_init(&priv->tx_pending);
736 dev->flags = IEEE80211_HW_RX_INCLUDES_FCS |
737 IEEE80211_HW_SIGNAL_DBM |
738 IEEE80211_HW_SUPPORTS_PS |
739 IEEE80211_HW_PS_NULLFUNC_STACK |
740 IEEE80211_HW_REPORTS_TX_ACK_STATUS;
742 dev->wiphy->interface_modes = BIT(NL80211_IFTYPE_STATION) |
743 BIT(NL80211_IFTYPE_ADHOC) |
744 BIT(NL80211_IFTYPE_AP) |
745 BIT(NL80211_IFTYPE_MESH_POINT);
747 dev->channel_change_time = 1000; /* TODO: find actual value */
748 priv->beacon_req_id = cpu_to_le32(0);
749 priv->tx_stats[P54_QUEUE_BEACON].limit = 1;
750 priv->tx_stats[P54_QUEUE_FWSCAN].limit = 1;
751 priv->tx_stats[P54_QUEUE_MGMT].limit = 3;
752 priv->tx_stats[P54_QUEUE_CAB].limit = 3;
753 priv->tx_stats[P54_QUEUE_DATA].limit = 5;
757 * We support at most 8 tries no matter which rate they're at,
758 * we cannot support max_rates * max_rate_tries as we set it
759 * here, but setting it correctly to 4/2 or so would limit us
760 * artificially if the RC algorithm wants just two rates, so
761 * let's say 4/7, we'll redistribute it at TX time, see the
765 dev->max_rate_tries = 7;
766 dev->extra_tx_headroom = sizeof(struct p54_hdr) + 4 +
767 sizeof(struct p54_tx_data);
770 * For now, disable PS by default because it affects
771 * link stability significantly.
773 dev->wiphy->flags &= ~WIPHY_FLAG_PS_ON_BY_DEFAULT;
775 mutex_init(&priv->conf_mutex);
776 mutex_init(&priv->eeprom_mutex);
777 init_completion(&priv->stat_comp);
778 init_completion(&priv->eeprom_comp);
779 init_completion(&priv->beacon_comp);
780 INIT_DELAYED_WORK(&priv->work, p54_work);
782 memset(&priv->mc_maclist[0], ~0, ETH_ALEN);
783 priv->curchan = NULL;
784 p54_reset_stats(priv);
787 EXPORT_SYMBOL_GPL(p54_init_common);
789 int p54_register_common(struct ieee80211_hw *dev, struct device *pdev)
791 struct p54_common __maybe_unused *priv = dev->priv;
794 err = ieee80211_register_hw(dev);
796 dev_err(pdev, "Cannot register device (%d).\n", err);
799 priv->registered = true;
801 #ifdef CONFIG_P54_LEDS
802 err = p54_init_leds(priv);
804 p54_unregister_common(dev);
807 #endif /* CONFIG_P54_LEDS */
809 dev_info(pdev, "is registered as '%s'\n", wiphy_name(dev->wiphy));
812 EXPORT_SYMBOL_GPL(p54_register_common);
814 void p54_free_common(struct ieee80211_hw *dev)
816 struct p54_common *priv = dev->priv;
819 for (i = 0; i < IEEE80211_NUM_BANDS; i++)
820 kfree(priv->band_table[i]);
822 kfree(priv->iq_autocal);
823 kfree(priv->output_limit);
824 kfree(priv->curve_data);
825 kfree(priv->rssi_db);
826 kfree(priv->used_rxkeys);
828 priv->iq_autocal = NULL;
829 priv->output_limit = NULL;
830 priv->curve_data = NULL;
831 priv->rssi_db = NULL;
832 priv->used_rxkeys = NULL;
834 ieee80211_free_hw(dev);
836 EXPORT_SYMBOL_GPL(p54_free_common);
838 void p54_unregister_common(struct ieee80211_hw *dev)
840 struct p54_common *priv = dev->priv;
842 #ifdef CONFIG_P54_LEDS
843 p54_unregister_leds(priv);
844 #endif /* CONFIG_P54_LEDS */
846 if (priv->registered) {
847 priv->registered = false;
848 ieee80211_unregister_hw(dev);
851 mutex_destroy(&priv->conf_mutex);
852 mutex_destroy(&priv->eeprom_mutex);
854 EXPORT_SYMBOL_GPL(p54_unregister_common);