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 #include <linux/slab.h>
12 #include "libertas_tf.h"
13 #include "linux/etherdevice.h"
15 #define DRIVER_RELEASE_VERSION "004.p0"
16 /* thinfirm version: 5.132.X.pX */
17 #define LBTF_FW_VER_MIN 0x05840300
18 #define LBTF_FW_VER_MAX 0x0584ffff
19 #define QOS_CONTROL_LEN 2
21 static const char lbtf_driver_version[] = "THINFIRM-USB8388-" DRIVER_RELEASE_VERSION;
22 struct workqueue_struct *lbtf_wq;
24 static const struct ieee80211_channel lbtf_channels[] = {
25 { .center_freq = 2412, .hw_value = 1 },
26 { .center_freq = 2417, .hw_value = 2 },
27 { .center_freq = 2422, .hw_value = 3 },
28 { .center_freq = 2427, .hw_value = 4 },
29 { .center_freq = 2432, .hw_value = 5 },
30 { .center_freq = 2437, .hw_value = 6 },
31 { .center_freq = 2442, .hw_value = 7 },
32 { .center_freq = 2447, .hw_value = 8 },
33 { .center_freq = 2452, .hw_value = 9 },
34 { .center_freq = 2457, .hw_value = 10 },
35 { .center_freq = 2462, .hw_value = 11 },
36 { .center_freq = 2467, .hw_value = 12 },
37 { .center_freq = 2472, .hw_value = 13 },
38 { .center_freq = 2484, .hw_value = 14 },
41 /* This table contains the hardware specific values for the modulation rates. */
42 static const struct ieee80211_rate lbtf_rates[] = {
47 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
50 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
53 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
80 static void lbtf_cmd_work(struct work_struct *work)
82 struct lbtf_private *priv = container_of(work, struct lbtf_private,
84 spin_lock_irq(&priv->driver_lock);
85 /* command response? */
86 if (priv->cmd_response_rxed) {
87 priv->cmd_response_rxed = 0;
88 spin_unlock_irq(&priv->driver_lock);
89 lbtf_process_rx_command(priv);
90 spin_lock_irq(&priv->driver_lock);
93 if (priv->cmd_timed_out && priv->cur_cmd) {
94 struct cmd_ctrl_node *cmdnode = priv->cur_cmd;
96 if (++priv->nr_retries > 10) {
97 lbtf_complete_command(priv, cmdnode,
101 priv->cur_cmd = NULL;
103 /* Stick it back at the _top_ of the pending
104 * queue for immediate resubmission */
105 list_add(&cmdnode->list, &priv->cmdpendingq);
108 priv->cmd_timed_out = 0;
109 spin_unlock_irq(&priv->driver_lock);
113 /* Execute the next command */
115 lbtf_execute_next_command(priv);
119 * lbtf_setup_firmware: initialize firmware.
121 * @priv A pointer to struct lbtf_private structure
123 * Returns: 0 on success.
125 static int lbtf_setup_firmware(struct lbtf_private *priv)
130 * Read priv address from HW
132 memset(priv->current_addr, 0xff, ETH_ALEN);
133 ret = lbtf_update_hw_spec(priv);
139 lbtf_set_mac_control(priv);
140 lbtf_set_radio_control(priv);
148 * This function handles the timeout of command sending.
149 * It will re-send the same command again.
151 static void command_timer_fn(unsigned long data)
153 struct lbtf_private *priv = (struct lbtf_private *)data;
156 spin_lock_irqsave(&priv->driver_lock, flags);
158 if (!priv->cur_cmd) {
159 printk(KERN_DEBUG "libertastf: command timer expired; "
160 "no pending command\n");
164 printk(KERN_DEBUG "libertas: command %x timed out\n",
165 le16_to_cpu(priv->cur_cmd->cmdbuf->command));
167 priv->cmd_timed_out = 1;
168 queue_work(lbtf_wq, &priv->cmd_work);
170 spin_unlock_irqrestore(&priv->driver_lock, flags);
173 static int lbtf_init_adapter(struct lbtf_private *priv)
175 memset(priv->current_addr, 0xff, ETH_ALEN);
176 mutex_init(&priv->lock);
179 setup_timer(&priv->command_timer, command_timer_fn,
180 (unsigned long)priv);
182 INIT_LIST_HEAD(&priv->cmdfreeq);
183 INIT_LIST_HEAD(&priv->cmdpendingq);
185 spin_lock_init(&priv->driver_lock);
187 /* Allocate the command buffers */
188 if (lbtf_allocate_cmd_buffer(priv))
194 static void lbtf_free_adapter(struct lbtf_private *priv)
196 lbtf_free_cmd_buffer(priv);
197 del_timer(&priv->command_timer);
200 static int lbtf_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb)
202 struct lbtf_private *priv = hw->priv;
204 priv->skb_to_tx = skb;
205 queue_work(lbtf_wq, &priv->tx_work);
207 * queue will be restarted when we receive transmission feedback if
208 * there are no buffered multicast frames to send
210 ieee80211_stop_queues(priv->hw);
214 static void lbtf_tx_work(struct work_struct *work)
216 struct lbtf_private *priv = container_of(work, struct lbtf_private,
219 struct ieee80211_tx_info *info;
221 struct sk_buff *skb = NULL;
224 if ((priv->vif->type == NL80211_IFTYPE_AP) &&
225 (!skb_queue_empty(&priv->bc_ps_buf)))
226 skb = skb_dequeue(&priv->bc_ps_buf);
227 else if (priv->skb_to_tx) {
228 skb = priv->skb_to_tx;
229 priv->skb_to_tx = NULL;
234 info = IEEE80211_SKB_CB(skb);
235 txpd = (struct txpd *) skb_push(skb, sizeof(struct txpd));
237 if (priv->surpriseremoved) {
238 dev_kfree_skb_any(skb);
242 memset(txpd, 0, sizeof(struct txpd));
243 /* Activate per-packet rate selection */
244 txpd->tx_control |= cpu_to_le32(MRVL_PER_PACKET_RATE |
245 ieee80211_get_tx_rate(priv->hw, info)->hw_value);
247 /* copy destination address from 802.11 header */
248 memcpy(txpd->tx_dest_addr_high, skb->data + sizeof(struct txpd) + 4,
250 txpd->tx_packet_length = cpu_to_le16(len);
251 txpd->tx_packet_location = cpu_to_le32(sizeof(struct txpd));
252 BUG_ON(priv->tx_skb);
253 spin_lock_irq(&priv->driver_lock);
255 err = priv->hw_host_to_card(priv, MVMS_DAT, skb->data, skb->len);
256 spin_unlock_irq(&priv->driver_lock);
258 dev_kfree_skb_any(skb);
263 static int lbtf_op_start(struct ieee80211_hw *hw)
265 struct lbtf_private *priv = hw->priv;
266 void *card = priv->card;
270 /* Upload firmware */
271 if (priv->hw_prog_firmware(card))
272 goto err_prog_firmware;
274 /* poke the firmware */
275 priv->capability = WLAN_CAPABILITY_SHORT_PREAMBLE;
276 priv->radioon = RADIO_ON;
277 priv->mac_control = CMD_ACT_MAC_RX_ON | CMD_ACT_MAC_TX_ON;
278 ret = lbtf_setup_firmware(priv);
280 goto err_prog_firmware;
282 if ((priv->fwrelease < LBTF_FW_VER_MIN) ||
283 (priv->fwrelease > LBTF_FW_VER_MAX)) {
285 goto err_prog_firmware;
288 printk(KERN_INFO "libertastf: Marvell WLAN 802.11 thinfirm adapter\n");
292 priv->hw_reset_device(card);
296 static void lbtf_op_stop(struct ieee80211_hw *hw)
298 struct lbtf_private *priv = hw->priv;
302 struct cmd_ctrl_node *cmdnode;
303 /* Flush pending command nodes */
304 spin_lock_irqsave(&priv->driver_lock, flags);
305 list_for_each_entry(cmdnode, &priv->cmdpendingq, list) {
306 cmdnode->result = -ENOENT;
307 cmdnode->cmdwaitqwoken = 1;
308 wake_up_interruptible(&cmdnode->cmdwait_q);
311 spin_unlock_irqrestore(&priv->driver_lock, flags);
312 cancel_work_sync(&priv->cmd_work);
313 cancel_work_sync(&priv->tx_work);
314 while ((skb = skb_dequeue(&priv->bc_ps_buf)))
315 dev_kfree_skb_any(skb);
316 priv->radioon = RADIO_OFF;
317 lbtf_set_radio_control(priv);
322 static int lbtf_op_add_interface(struct ieee80211_hw *hw,
323 struct ieee80211_vif *vif)
325 struct lbtf_private *priv = hw->priv;
326 if (priv->vif != NULL)
331 case NL80211_IFTYPE_MESH_POINT:
332 case NL80211_IFTYPE_AP:
333 lbtf_set_mode(priv, LBTF_AP_MODE);
335 case NL80211_IFTYPE_STATION:
336 lbtf_set_mode(priv, LBTF_STA_MODE);
342 lbtf_set_mac_address(priv, (u8 *) vif->addr);
346 static void lbtf_op_remove_interface(struct ieee80211_hw *hw,
347 struct ieee80211_vif *vif)
349 struct lbtf_private *priv = hw->priv;
351 if (priv->vif->type == NL80211_IFTYPE_AP ||
352 priv->vif->type == NL80211_IFTYPE_MESH_POINT)
353 lbtf_beacon_ctrl(priv, 0, 0);
354 lbtf_set_mode(priv, LBTF_PASSIVE_MODE);
355 lbtf_set_bssid(priv, 0, NULL);
359 static int lbtf_op_config(struct ieee80211_hw *hw, u32 changed)
361 struct lbtf_private *priv = hw->priv;
362 struct ieee80211_conf *conf = &hw->conf;
364 if (conf->channel->center_freq != priv->cur_freq) {
365 priv->cur_freq = conf->channel->center_freq;
366 lbtf_set_channel(priv, conf->channel->hw_value);
371 static u64 lbtf_op_prepare_multicast(struct ieee80211_hw *hw,
372 int mc_count, struct dev_addr_list *mclist)
374 struct lbtf_private *priv = hw->priv;
377 if (!mc_count || mc_count > MRVDRV_MAX_MULTICAST_LIST_SIZE)
380 priv->nr_of_multicastmacaddr = mc_count;
381 for (i = 0; i < mc_count; i++) {
384 memcpy(&priv->multicastlist[i], mclist->da_addr,
386 mclist = mclist->next;
392 #define SUPPORTED_FIF_FLAGS (FIF_PROMISC_IN_BSS | FIF_ALLMULTI)
393 static void lbtf_op_configure_filter(struct ieee80211_hw *hw,
394 unsigned int changed_flags,
395 unsigned int *new_flags,
398 struct lbtf_private *priv = hw->priv;
399 int old_mac_control = priv->mac_control;
400 changed_flags &= SUPPORTED_FIF_FLAGS;
401 *new_flags &= SUPPORTED_FIF_FLAGS;
406 if (*new_flags & (FIF_PROMISC_IN_BSS))
407 priv->mac_control |= CMD_ACT_MAC_PROMISCUOUS_ENABLE;
409 priv->mac_control &= ~CMD_ACT_MAC_PROMISCUOUS_ENABLE;
410 if (*new_flags & (FIF_ALLMULTI) ||
411 multicast > MRVDRV_MAX_MULTICAST_LIST_SIZE) {
412 priv->mac_control |= CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
413 priv->mac_control &= ~CMD_ACT_MAC_MULTICAST_ENABLE;
414 } else if (multicast) {
415 priv->mac_control |= CMD_ACT_MAC_MULTICAST_ENABLE;
416 priv->mac_control &= ~CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
417 lbtf_cmd_set_mac_multicast_addr(priv);
419 priv->mac_control &= ~(CMD_ACT_MAC_MULTICAST_ENABLE |
420 CMD_ACT_MAC_ALL_MULTICAST_ENABLE);
421 if (priv->nr_of_multicastmacaddr) {
422 priv->nr_of_multicastmacaddr = 0;
423 lbtf_cmd_set_mac_multicast_addr(priv);
428 if (priv->mac_control != old_mac_control)
429 lbtf_set_mac_control(priv);
432 static void lbtf_op_bss_info_changed(struct ieee80211_hw *hw,
433 struct ieee80211_vif *vif,
434 struct ieee80211_bss_conf *bss_conf,
437 struct lbtf_private *priv = hw->priv;
438 struct sk_buff *beacon;
440 if (changes & (BSS_CHANGED_BEACON | BSS_CHANGED_BEACON_INT)) {
441 switch (priv->vif->type) {
442 case NL80211_IFTYPE_AP:
443 case NL80211_IFTYPE_MESH_POINT:
444 beacon = ieee80211_beacon_get(hw, vif);
446 lbtf_beacon_set(priv, beacon);
448 lbtf_beacon_ctrl(priv, 1,
449 bss_conf->beacon_int);
457 if (changes & BSS_CHANGED_BSSID) {
458 bool activate = !is_zero_ether_addr(bss_conf->bssid);
459 lbtf_set_bssid(priv, activate, bss_conf->bssid);
462 if (changes & BSS_CHANGED_ERP_PREAMBLE) {
463 if (bss_conf->use_short_preamble)
464 priv->preamble = CMD_TYPE_SHORT_PREAMBLE;
466 priv->preamble = CMD_TYPE_LONG_PREAMBLE;
467 lbtf_set_radio_control(priv);
471 static const struct ieee80211_ops lbtf_ops = {
473 .start = lbtf_op_start,
474 .stop = lbtf_op_stop,
475 .add_interface = lbtf_op_add_interface,
476 .remove_interface = lbtf_op_remove_interface,
477 .config = lbtf_op_config,
478 .prepare_multicast = lbtf_op_prepare_multicast,
479 .configure_filter = lbtf_op_configure_filter,
480 .bss_info_changed = lbtf_op_bss_info_changed,
483 int lbtf_rx(struct lbtf_private *priv, struct sk_buff *skb)
485 struct ieee80211_rx_status stats;
489 struct ieee80211_hdr *hdr;
491 prxpd = (struct rxpd *) skb->data;
494 if (!(prxpd->status & cpu_to_le16(MRVDRV_RXPD_STATUS_OK)))
495 stats.flag |= RX_FLAG_FAILED_FCS_CRC;
496 stats.freq = priv->cur_freq;
497 stats.band = IEEE80211_BAND_2GHZ;
498 stats.signal = prxpd->snr;
499 stats.noise = prxpd->nf;
500 /* Marvell rate index has a hole at value 4 */
501 if (prxpd->rx_rate > 4)
503 stats.rate_idx = prxpd->rx_rate;
504 skb_pull(skb, sizeof(struct rxpd));
506 hdr = (struct ieee80211_hdr *)skb->data;
507 flags = le32_to_cpu(*(__le32 *)(skb->data + 4));
509 need_padding = ieee80211_is_data_qos(hdr->frame_control);
510 need_padding ^= ieee80211_has_a4(hdr->frame_control);
511 need_padding ^= ieee80211_is_data_qos(hdr->frame_control) &&
512 (*ieee80211_get_qos_ctl(hdr) &
513 IEEE80211_QOS_CONTROL_A_MSDU_PRESENT);
516 memmove(skb->data + 2, skb->data, skb->len);
520 memcpy(IEEE80211_SKB_RXCB(skb), &stats, sizeof(stats));
521 ieee80211_rx_irqsafe(priv->hw, skb);
524 EXPORT_SYMBOL_GPL(lbtf_rx);
527 * lbtf_add_card: Add and initialize the card, no fw upload yet.
529 * @card A pointer to card
531 * Returns: pointer to struct lbtf_priv.
533 struct lbtf_private *lbtf_add_card(void *card, struct device *dmdev)
535 struct ieee80211_hw *hw;
536 struct lbtf_private *priv = NULL;
538 hw = ieee80211_alloc_hw(sizeof(struct lbtf_private), &lbtf_ops);
543 if (lbtf_init_adapter(priv))
544 goto err_init_adapter;
551 hw->flags = IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING;
552 hw->extra_tx_headroom = sizeof(struct txpd);
553 memcpy(priv->channels, lbtf_channels, sizeof(lbtf_channels));
554 memcpy(priv->rates, lbtf_rates, sizeof(lbtf_rates));
555 priv->band.n_bitrates = ARRAY_SIZE(lbtf_rates);
556 priv->band.bitrates = priv->rates;
557 priv->band.n_channels = ARRAY_SIZE(lbtf_channels);
558 priv->band.channels = priv->channels;
559 hw->wiphy->bands[IEEE80211_BAND_2GHZ] = &priv->band;
560 hw->wiphy->interface_modes =
561 BIT(NL80211_IFTYPE_STATION) |
562 BIT(NL80211_IFTYPE_ADHOC);
563 skb_queue_head_init(&priv->bc_ps_buf);
565 SET_IEEE80211_DEV(hw, dmdev);
567 INIT_WORK(&priv->cmd_work, lbtf_cmd_work);
568 INIT_WORK(&priv->tx_work, lbtf_tx_work);
569 if (ieee80211_register_hw(hw))
570 goto err_init_adapter;
575 lbtf_free_adapter(priv);
576 ieee80211_free_hw(hw);
582 EXPORT_SYMBOL_GPL(lbtf_add_card);
585 int lbtf_remove_card(struct lbtf_private *priv)
587 struct ieee80211_hw *hw = priv->hw;
589 priv->surpriseremoved = 1;
590 del_timer(&priv->command_timer);
591 lbtf_free_adapter(priv);
593 ieee80211_unregister_hw(hw);
594 ieee80211_free_hw(hw);
598 EXPORT_SYMBOL_GPL(lbtf_remove_card);
600 void lbtf_send_tx_feedback(struct lbtf_private *priv, u8 retrycnt, u8 fail)
602 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(priv->tx_skb);
604 ieee80211_tx_info_clear_status(info);
606 * Commented out, otherwise we never go beyond 1Mbit/s using mac80211
607 * default pid rc algorithm.
609 * info->status.retry_count = MRVL_DEFAULT_RETRIES - retrycnt;
611 if (!(info->flags & IEEE80211_TX_CTL_NO_ACK) && !fail)
612 info->flags |= IEEE80211_TX_STAT_ACK;
613 skb_pull(priv->tx_skb, sizeof(struct txpd));
614 ieee80211_tx_status_irqsafe(priv->hw, priv->tx_skb);
616 if (!priv->skb_to_tx && skb_queue_empty(&priv->bc_ps_buf))
617 ieee80211_wake_queues(priv->hw);
619 queue_work(lbtf_wq, &priv->tx_work);
621 EXPORT_SYMBOL_GPL(lbtf_send_tx_feedback);
623 void lbtf_bcn_sent(struct lbtf_private *priv)
625 struct sk_buff *skb = NULL;
627 if (priv->vif->type != NL80211_IFTYPE_AP)
630 if (skb_queue_empty(&priv->bc_ps_buf)) {
633 while ((skb = ieee80211_get_buffered_bc(priv->hw, priv->vif))) {
634 skb_queue_tail(&priv->bc_ps_buf, skb);
638 ieee80211_stop_queues(priv->hw);
639 queue_work(lbtf_wq, &priv->tx_work);
643 skb = ieee80211_beacon_get(priv->hw, priv->vif);
646 lbtf_beacon_set(priv, skb);
650 EXPORT_SYMBOL_GPL(lbtf_bcn_sent);
652 static int __init lbtf_init_module(void)
654 lbtf_wq = create_workqueue("libertastf");
655 if (lbtf_wq == NULL) {
656 printk(KERN_ERR "libertastf: couldn't create workqueue\n");
662 static void __exit lbtf_exit_module(void)
664 destroy_workqueue(lbtf_wq);
667 module_init(lbtf_init_module);
668 module_exit(lbtf_exit_module);
670 MODULE_DESCRIPTION("Libertas WLAN Thinfirm Driver Library");
671 MODULE_AUTHOR("Cozybit Inc.");
672 MODULE_LICENSE("GPL");