2 * Copyright (C) 2008, cozybit Inc.
3 * Copyright (C) 2003-2006, Marvell International Ltd.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or (at
8 * your option) any later version.
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/slab.h>
14 #include <linux/etherdevice.h>
15 #include "libertas_tf.h"
17 #define DRIVER_RELEASE_VERSION "004.p0"
18 /* thinfirm version: 5.132.X.pX */
19 #define LBTF_FW_VER_MIN 0x05840300
20 #define LBTF_FW_VER_MAX 0x0584ffff
21 #define QOS_CONTROL_LEN 2
23 /* Module parameters */
24 unsigned int lbtf_debug;
25 EXPORT_SYMBOL_GPL(lbtf_debug);
26 module_param_named(libertas_tf_debug, lbtf_debug, int, 0644);
28 static const char lbtf_driver_version[] = "THINFIRM-USB8388-" DRIVER_RELEASE_VERSION
34 struct workqueue_struct *lbtf_wq;
36 static const struct ieee80211_channel lbtf_channels[] = {
37 { .center_freq = 2412, .hw_value = 1 },
38 { .center_freq = 2417, .hw_value = 2 },
39 { .center_freq = 2422, .hw_value = 3 },
40 { .center_freq = 2427, .hw_value = 4 },
41 { .center_freq = 2432, .hw_value = 5 },
42 { .center_freq = 2437, .hw_value = 6 },
43 { .center_freq = 2442, .hw_value = 7 },
44 { .center_freq = 2447, .hw_value = 8 },
45 { .center_freq = 2452, .hw_value = 9 },
46 { .center_freq = 2457, .hw_value = 10 },
47 { .center_freq = 2462, .hw_value = 11 },
48 { .center_freq = 2467, .hw_value = 12 },
49 { .center_freq = 2472, .hw_value = 13 },
50 { .center_freq = 2484, .hw_value = 14 },
53 /* This table contains the hardware specific values for the modulation rates. */
54 static const struct ieee80211_rate lbtf_rates[] = {
59 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
62 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
65 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
92 static void lbtf_cmd_work(struct work_struct *work)
94 struct lbtf_private *priv = container_of(work, struct lbtf_private,
97 lbtf_deb_enter(LBTF_DEB_CMD);
99 spin_lock_irq(&priv->driver_lock);
100 /* command response? */
101 if (priv->cmd_response_rxed) {
102 priv->cmd_response_rxed = 0;
103 spin_unlock_irq(&priv->driver_lock);
104 lbtf_process_rx_command(priv);
105 spin_lock_irq(&priv->driver_lock);
108 if (priv->cmd_timed_out && priv->cur_cmd) {
109 struct cmd_ctrl_node *cmdnode = priv->cur_cmd;
111 if (++priv->nr_retries > 10) {
112 lbtf_complete_command(priv, cmdnode,
114 priv->nr_retries = 0;
116 priv->cur_cmd = NULL;
118 /* Stick it back at the _top_ of the pending
119 * queue for immediate resubmission */
120 list_add(&cmdnode->list, &priv->cmdpendingq);
123 priv->cmd_timed_out = 0;
124 spin_unlock_irq(&priv->driver_lock);
126 if (!priv->fw_ready) {
127 lbtf_deb_leave_args(LBTF_DEB_CMD, "fw not ready");
131 /* Execute the next command */
133 lbtf_execute_next_command(priv);
135 lbtf_deb_leave(LBTF_DEB_CMD);
139 * lbtf_setup_firmware: initialize firmware.
141 * @priv A pointer to struct lbtf_private structure
143 * Returns: 0 on success.
145 static int lbtf_setup_firmware(struct lbtf_private *priv)
149 lbtf_deb_enter(LBTF_DEB_FW);
151 * Read priv address from HW
153 memset(priv->current_addr, 0xff, ETH_ALEN);
154 ret = lbtf_update_hw_spec(priv);
160 lbtf_set_mac_control(priv);
161 lbtf_set_radio_control(priv);
165 lbtf_deb_leave_args(LBTF_DEB_FW, "ret: %d", ret);
170 * This function handles the timeout of command sending.
171 * It will re-send the same command again.
173 static void command_timer_fn(unsigned long data)
175 struct lbtf_private *priv = (struct lbtf_private *)data;
177 lbtf_deb_enter(LBTF_DEB_CMD);
179 spin_lock_irqsave(&priv->driver_lock, flags);
181 if (!priv->cur_cmd) {
182 printk(KERN_DEBUG "libertastf: command timer expired; "
183 "no pending command\n");
187 printk(KERN_DEBUG "libertas: command %x timed out\n",
188 le16_to_cpu(priv->cur_cmd->cmdbuf->command));
190 priv->cmd_timed_out = 1;
191 queue_work(lbtf_wq, &priv->cmd_work);
193 spin_unlock_irqrestore(&priv->driver_lock, flags);
194 lbtf_deb_leave(LBTF_DEB_CMD);
197 static int lbtf_init_adapter(struct lbtf_private *priv)
199 lbtf_deb_enter(LBTF_DEB_MAIN);
200 memset(priv->current_addr, 0xff, ETH_ALEN);
201 mutex_init(&priv->lock);
204 setup_timer(&priv->command_timer, command_timer_fn,
205 (unsigned long)priv);
207 INIT_LIST_HEAD(&priv->cmdfreeq);
208 INIT_LIST_HEAD(&priv->cmdpendingq);
210 spin_lock_init(&priv->driver_lock);
212 /* Allocate the command buffers */
213 if (lbtf_allocate_cmd_buffer(priv))
216 lbtf_deb_leave(LBTF_DEB_MAIN);
220 static void lbtf_free_adapter(struct lbtf_private *priv)
222 lbtf_deb_enter(LBTF_DEB_MAIN);
223 lbtf_free_cmd_buffer(priv);
224 del_timer(&priv->command_timer);
225 lbtf_deb_leave(LBTF_DEB_MAIN);
228 static int lbtf_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb)
230 struct lbtf_private *priv = hw->priv;
232 priv->skb_to_tx = skb;
233 queue_work(lbtf_wq, &priv->tx_work);
235 * queue will be restarted when we receive transmission feedback if
236 * there are no buffered multicast frames to send
238 ieee80211_stop_queues(priv->hw);
242 static void lbtf_tx_work(struct work_struct *work)
244 struct lbtf_private *priv = container_of(work, struct lbtf_private,
247 struct ieee80211_tx_info *info;
249 struct sk_buff *skb = NULL;
252 lbtf_deb_enter(LBTF_DEB_MACOPS | LBTF_DEB_TX);
254 if ((priv->vif->type == NL80211_IFTYPE_AP) &&
255 (!skb_queue_empty(&priv->bc_ps_buf)))
256 skb = skb_dequeue(&priv->bc_ps_buf);
257 else if (priv->skb_to_tx) {
258 skb = priv->skb_to_tx;
259 priv->skb_to_tx = NULL;
261 lbtf_deb_leave(LBTF_DEB_MACOPS | LBTF_DEB_TX);
266 info = IEEE80211_SKB_CB(skb);
267 txpd = (struct txpd *) skb_push(skb, sizeof(struct txpd));
269 if (priv->surpriseremoved) {
270 dev_kfree_skb_any(skb);
271 lbtf_deb_leave(LBTF_DEB_MACOPS | LBTF_DEB_TX);
275 memset(txpd, 0, sizeof(struct txpd));
276 /* Activate per-packet rate selection */
277 txpd->tx_control |= cpu_to_le32(MRVL_PER_PACKET_RATE |
278 ieee80211_get_tx_rate(priv->hw, info)->hw_value);
280 /* copy destination address from 802.11 header */
281 memcpy(txpd->tx_dest_addr_high, skb->data + sizeof(struct txpd) + 4,
283 txpd->tx_packet_length = cpu_to_le16(len);
284 txpd->tx_packet_location = cpu_to_le32(sizeof(struct txpd));
285 lbtf_deb_hex(LBTF_DEB_TX, "TX Data", skb->data, min_t(unsigned int, skb->len, 100));
286 BUG_ON(priv->tx_skb);
287 spin_lock_irq(&priv->driver_lock);
289 err = priv->hw_host_to_card(priv, MVMS_DAT, skb->data, skb->len);
290 spin_unlock_irq(&priv->driver_lock);
292 dev_kfree_skb_any(skb);
294 pr_err("TX error: %d", err);
296 lbtf_deb_leave(LBTF_DEB_MACOPS | LBTF_DEB_TX);
299 static int lbtf_op_start(struct ieee80211_hw *hw)
301 struct lbtf_private *priv = hw->priv;
302 void *card = priv->card;
305 lbtf_deb_enter(LBTF_DEB_MACOPS);
308 /* Upload firmware */
309 if (priv->hw_prog_firmware(card))
310 goto err_prog_firmware;
312 /* poke the firmware */
313 priv->capability = WLAN_CAPABILITY_SHORT_PREAMBLE;
314 priv->radioon = RADIO_ON;
315 priv->mac_control = CMD_ACT_MAC_RX_ON | CMD_ACT_MAC_TX_ON;
316 ret = lbtf_setup_firmware(priv);
318 goto err_prog_firmware;
320 if ((priv->fwrelease < LBTF_FW_VER_MIN) ||
321 (priv->fwrelease > LBTF_FW_VER_MAX)) {
323 goto err_prog_firmware;
326 printk(KERN_INFO "libertastf: Marvell WLAN 802.11 thinfirm adapter\n");
327 lbtf_deb_leave(LBTF_DEB_MACOPS);
331 priv->hw_reset_device(card);
332 lbtf_deb_leave_args(LBTF_DEB_MACOPS, "error programing fw; ret=%d", ret);
336 static void lbtf_op_stop(struct ieee80211_hw *hw)
338 struct lbtf_private *priv = hw->priv;
342 struct cmd_ctrl_node *cmdnode;
344 lbtf_deb_enter(LBTF_DEB_MACOPS);
346 /* Flush pending command nodes */
347 spin_lock_irqsave(&priv->driver_lock, flags);
348 list_for_each_entry(cmdnode, &priv->cmdpendingq, list) {
349 cmdnode->result = -ENOENT;
350 cmdnode->cmdwaitqwoken = 1;
351 wake_up_interruptible(&cmdnode->cmdwait_q);
354 spin_unlock_irqrestore(&priv->driver_lock, flags);
355 cancel_work_sync(&priv->cmd_work);
356 cancel_work_sync(&priv->tx_work);
357 while ((skb = skb_dequeue(&priv->bc_ps_buf)))
358 dev_kfree_skb_any(skb);
359 priv->radioon = RADIO_OFF;
360 lbtf_set_radio_control(priv);
362 lbtf_deb_leave(LBTF_DEB_MACOPS);
365 static int lbtf_op_add_interface(struct ieee80211_hw *hw,
366 struct ieee80211_vif *vif)
368 struct lbtf_private *priv = hw->priv;
369 lbtf_deb_enter(LBTF_DEB_MACOPS);
370 if (priv->vif != NULL)
375 case NL80211_IFTYPE_MESH_POINT:
376 case NL80211_IFTYPE_AP:
377 lbtf_set_mode(priv, LBTF_AP_MODE);
379 case NL80211_IFTYPE_STATION:
380 lbtf_set_mode(priv, LBTF_STA_MODE);
386 lbtf_set_mac_address(priv, (u8 *) vif->addr);
387 lbtf_deb_leave(LBTF_DEB_MACOPS);
391 static void lbtf_op_remove_interface(struct ieee80211_hw *hw,
392 struct ieee80211_vif *vif)
394 struct lbtf_private *priv = hw->priv;
395 lbtf_deb_enter(LBTF_DEB_MACOPS);
397 if (priv->vif->type == NL80211_IFTYPE_AP ||
398 priv->vif->type == NL80211_IFTYPE_MESH_POINT)
399 lbtf_beacon_ctrl(priv, 0, 0);
400 lbtf_set_mode(priv, LBTF_PASSIVE_MODE);
401 lbtf_set_bssid(priv, 0, NULL);
403 lbtf_deb_leave(LBTF_DEB_MACOPS);
406 static int lbtf_op_config(struct ieee80211_hw *hw, u32 changed)
408 struct lbtf_private *priv = hw->priv;
409 struct ieee80211_conf *conf = &hw->conf;
410 lbtf_deb_enter(LBTF_DEB_MACOPS);
412 if (conf->channel->center_freq != priv->cur_freq) {
413 priv->cur_freq = conf->channel->center_freq;
414 lbtf_set_channel(priv, conf->channel->hw_value);
416 lbtf_deb_leave(LBTF_DEB_MACOPS);
420 static u64 lbtf_op_prepare_multicast(struct ieee80211_hw *hw,
421 struct netdev_hw_addr_list *mc_list)
423 struct lbtf_private *priv = hw->priv;
425 struct netdev_hw_addr *ha;
426 int mc_count = netdev_hw_addr_list_count(mc_list);
428 if (!mc_count || mc_count > MRVDRV_MAX_MULTICAST_LIST_SIZE)
431 priv->nr_of_multicastmacaddr = mc_count;
433 netdev_hw_addr_list_for_each(ha, mc_list)
434 memcpy(&priv->multicastlist[i++], ha->addr, ETH_ALEN);
439 #define SUPPORTED_FIF_FLAGS (FIF_PROMISC_IN_BSS | FIF_ALLMULTI)
440 static void lbtf_op_configure_filter(struct ieee80211_hw *hw,
441 unsigned int changed_flags,
442 unsigned int *new_flags,
445 struct lbtf_private *priv = hw->priv;
446 int old_mac_control = priv->mac_control;
448 lbtf_deb_enter(LBTF_DEB_MACOPS);
450 changed_flags &= SUPPORTED_FIF_FLAGS;
451 *new_flags &= SUPPORTED_FIF_FLAGS;
453 if (!changed_flags) {
454 lbtf_deb_leave(LBTF_DEB_MACOPS);
458 if (*new_flags & (FIF_PROMISC_IN_BSS))
459 priv->mac_control |= CMD_ACT_MAC_PROMISCUOUS_ENABLE;
461 priv->mac_control &= ~CMD_ACT_MAC_PROMISCUOUS_ENABLE;
462 if (*new_flags & (FIF_ALLMULTI) ||
463 multicast > MRVDRV_MAX_MULTICAST_LIST_SIZE) {
464 priv->mac_control |= CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
465 priv->mac_control &= ~CMD_ACT_MAC_MULTICAST_ENABLE;
466 } else if (multicast) {
467 priv->mac_control |= CMD_ACT_MAC_MULTICAST_ENABLE;
468 priv->mac_control &= ~CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
469 lbtf_cmd_set_mac_multicast_addr(priv);
471 priv->mac_control &= ~(CMD_ACT_MAC_MULTICAST_ENABLE |
472 CMD_ACT_MAC_ALL_MULTICAST_ENABLE);
473 if (priv->nr_of_multicastmacaddr) {
474 priv->nr_of_multicastmacaddr = 0;
475 lbtf_cmd_set_mac_multicast_addr(priv);
480 if (priv->mac_control != old_mac_control)
481 lbtf_set_mac_control(priv);
483 lbtf_deb_leave(LBTF_DEB_MACOPS);
486 static void lbtf_op_bss_info_changed(struct ieee80211_hw *hw,
487 struct ieee80211_vif *vif,
488 struct ieee80211_bss_conf *bss_conf,
491 struct lbtf_private *priv = hw->priv;
492 struct sk_buff *beacon;
493 lbtf_deb_enter(LBTF_DEB_MACOPS);
495 if (changes & (BSS_CHANGED_BEACON | BSS_CHANGED_BEACON_INT)) {
496 switch (priv->vif->type) {
497 case NL80211_IFTYPE_AP:
498 case NL80211_IFTYPE_MESH_POINT:
499 beacon = ieee80211_beacon_get(hw, vif);
501 lbtf_beacon_set(priv, beacon);
503 lbtf_beacon_ctrl(priv, 1,
504 bss_conf->beacon_int);
512 if (changes & BSS_CHANGED_BSSID) {
513 bool activate = !is_zero_ether_addr(bss_conf->bssid);
514 lbtf_set_bssid(priv, activate, bss_conf->bssid);
517 if (changes & BSS_CHANGED_ERP_PREAMBLE) {
518 if (bss_conf->use_short_preamble)
519 priv->preamble = CMD_TYPE_SHORT_PREAMBLE;
521 priv->preamble = CMD_TYPE_LONG_PREAMBLE;
522 lbtf_set_radio_control(priv);
525 lbtf_deb_leave(LBTF_DEB_MACOPS);
528 static const struct ieee80211_ops lbtf_ops = {
530 .start = lbtf_op_start,
531 .stop = lbtf_op_stop,
532 .add_interface = lbtf_op_add_interface,
533 .remove_interface = lbtf_op_remove_interface,
534 .config = lbtf_op_config,
535 .prepare_multicast = lbtf_op_prepare_multicast,
536 .configure_filter = lbtf_op_configure_filter,
537 .bss_info_changed = lbtf_op_bss_info_changed,
540 int lbtf_rx(struct lbtf_private *priv, struct sk_buff *skb)
542 struct ieee80211_rx_status stats;
546 struct ieee80211_hdr *hdr;
548 lbtf_deb_enter(LBTF_DEB_RX);
550 prxpd = (struct rxpd *) skb->data;
552 memset(&stats, 0, sizeof(stats));
553 if (!(prxpd->status & cpu_to_le16(MRVDRV_RXPD_STATUS_OK)))
554 stats.flag |= RX_FLAG_FAILED_FCS_CRC;
555 stats.freq = priv->cur_freq;
556 stats.band = IEEE80211_BAND_2GHZ;
557 stats.signal = prxpd->snr;
558 /* Marvell rate index has a hole at value 4 */
559 if (prxpd->rx_rate > 4)
561 stats.rate_idx = prxpd->rx_rate;
562 skb_pull(skb, sizeof(struct rxpd));
564 hdr = (struct ieee80211_hdr *)skb->data;
565 flags = le32_to_cpu(*(__le32 *)(skb->data + 4));
567 need_padding = ieee80211_is_data_qos(hdr->frame_control);
568 need_padding ^= ieee80211_has_a4(hdr->frame_control);
569 need_padding ^= ieee80211_is_data_qos(hdr->frame_control) &&
570 (*ieee80211_get_qos_ctl(hdr) &
571 IEEE80211_QOS_CONTROL_A_MSDU_PRESENT);
574 memmove(skb->data + 2, skb->data, skb->len);
578 memcpy(IEEE80211_SKB_RXCB(skb), &stats, sizeof(stats));
580 lbtf_deb_rx("rx data: skb->len-sizeof(RxPd) = %d-%zd = %zd\n",
581 skb->len, sizeof(struct rxpd), skb->len - sizeof(struct rxpd));
582 lbtf_deb_hex(LBTF_DEB_RX, "RX Data", skb->data,
583 min_t(unsigned int, skb->len, 100));
585 ieee80211_rx_irqsafe(priv->hw, skb);
587 lbtf_deb_leave(LBTF_DEB_RX);
590 EXPORT_SYMBOL_GPL(lbtf_rx);
593 * lbtf_add_card: Add and initialize the card, no fw upload yet.
595 * @card A pointer to card
597 * Returns: pointer to struct lbtf_priv.
599 struct lbtf_private *lbtf_add_card(void *card, struct device *dmdev)
601 struct ieee80211_hw *hw;
602 struct lbtf_private *priv = NULL;
604 lbtf_deb_enter(LBTF_DEB_MAIN);
606 hw = ieee80211_alloc_hw(sizeof(struct lbtf_private), &lbtf_ops);
611 if (lbtf_init_adapter(priv))
612 goto err_init_adapter;
619 hw->flags = IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING;
620 hw->extra_tx_headroom = sizeof(struct txpd);
621 memcpy(priv->channels, lbtf_channels, sizeof(lbtf_channels));
622 memcpy(priv->rates, lbtf_rates, sizeof(lbtf_rates));
623 priv->band.n_bitrates = ARRAY_SIZE(lbtf_rates);
624 priv->band.bitrates = priv->rates;
625 priv->band.n_channels = ARRAY_SIZE(lbtf_channels);
626 priv->band.channels = priv->channels;
627 hw->wiphy->bands[IEEE80211_BAND_2GHZ] = &priv->band;
628 hw->wiphy->interface_modes =
629 BIT(NL80211_IFTYPE_STATION) |
630 BIT(NL80211_IFTYPE_ADHOC);
631 skb_queue_head_init(&priv->bc_ps_buf);
633 SET_IEEE80211_DEV(hw, dmdev);
635 INIT_WORK(&priv->cmd_work, lbtf_cmd_work);
636 INIT_WORK(&priv->tx_work, lbtf_tx_work);
637 if (ieee80211_register_hw(hw))
638 goto err_init_adapter;
643 lbtf_free_adapter(priv);
644 ieee80211_free_hw(hw);
648 lbtf_deb_leave_args(LBTF_DEB_MAIN, "priv %p", priv);
651 EXPORT_SYMBOL_GPL(lbtf_add_card);
654 int lbtf_remove_card(struct lbtf_private *priv)
656 struct ieee80211_hw *hw = priv->hw;
658 lbtf_deb_enter(LBTF_DEB_MAIN);
660 priv->surpriseremoved = 1;
661 del_timer(&priv->command_timer);
662 lbtf_free_adapter(priv);
664 ieee80211_unregister_hw(hw);
665 ieee80211_free_hw(hw);
667 lbtf_deb_leave(LBTF_DEB_MAIN);
670 EXPORT_SYMBOL_GPL(lbtf_remove_card);
672 void lbtf_send_tx_feedback(struct lbtf_private *priv, u8 retrycnt, u8 fail)
674 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(priv->tx_skb);
676 ieee80211_tx_info_clear_status(info);
678 * Commented out, otherwise we never go beyond 1Mbit/s using mac80211
679 * default pid rc algorithm.
681 * info->status.retry_count = MRVL_DEFAULT_RETRIES - retrycnt;
683 if (!(info->flags & IEEE80211_TX_CTL_NO_ACK) && !fail)
684 info->flags |= IEEE80211_TX_STAT_ACK;
685 skb_pull(priv->tx_skb, sizeof(struct txpd));
686 ieee80211_tx_status_irqsafe(priv->hw, priv->tx_skb);
688 if (!priv->skb_to_tx && skb_queue_empty(&priv->bc_ps_buf))
689 ieee80211_wake_queues(priv->hw);
691 queue_work(lbtf_wq, &priv->tx_work);
693 EXPORT_SYMBOL_GPL(lbtf_send_tx_feedback);
695 void lbtf_bcn_sent(struct lbtf_private *priv)
697 struct sk_buff *skb = NULL;
699 if (priv->vif->type != NL80211_IFTYPE_AP)
702 if (skb_queue_empty(&priv->bc_ps_buf)) {
705 while ((skb = ieee80211_get_buffered_bc(priv->hw, priv->vif))) {
706 skb_queue_tail(&priv->bc_ps_buf, skb);
710 ieee80211_stop_queues(priv->hw);
711 queue_work(lbtf_wq, &priv->tx_work);
715 skb = ieee80211_beacon_get(priv->hw, priv->vif);
718 lbtf_beacon_set(priv, skb);
722 EXPORT_SYMBOL_GPL(lbtf_bcn_sent);
724 static int __init lbtf_init_module(void)
726 lbtf_deb_enter(LBTF_DEB_MAIN);
727 lbtf_wq = create_workqueue("libertastf");
728 if (lbtf_wq == NULL) {
729 printk(KERN_ERR "libertastf: couldn't create workqueue\n");
732 lbtf_deb_leave(LBTF_DEB_MAIN);
736 static void __exit lbtf_exit_module(void)
738 lbtf_deb_enter(LBTF_DEB_MAIN);
739 destroy_workqueue(lbtf_wq);
740 lbtf_deb_leave(LBTF_DEB_MAIN);
743 module_init(lbtf_init_module);
744 module_exit(lbtf_exit_module);
746 MODULE_DESCRIPTION("Libertas WLAN Thinfirm Driver Library");
747 MODULE_AUTHOR("Cozybit Inc.");
748 MODULE_LICENSE("GPL");