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 "libertas_tf.h"
11 #include "linux/etherdevice.h"
13 #define DRIVER_RELEASE_VERSION "004.p0"
14 /* thinfirm version: 5.132.X.pX */
15 #define LBTF_FW_VER_MIN 0x05840300
16 #define LBTF_FW_VER_MAX 0x0584ffff
17 #define QOS_CONTROL_LEN 2
19 static const char lbtf_driver_version[] = "THINFIRM-USB8388-" DRIVER_RELEASE_VERSION;
20 struct workqueue_struct *lbtf_wq;
22 static const struct ieee80211_channel lbtf_channels[] = {
23 { .center_freq = 2412, .hw_value = 1 },
24 { .center_freq = 2417, .hw_value = 2 },
25 { .center_freq = 2422, .hw_value = 3 },
26 { .center_freq = 2427, .hw_value = 4 },
27 { .center_freq = 2432, .hw_value = 5 },
28 { .center_freq = 2437, .hw_value = 6 },
29 { .center_freq = 2442, .hw_value = 7 },
30 { .center_freq = 2447, .hw_value = 8 },
31 { .center_freq = 2452, .hw_value = 9 },
32 { .center_freq = 2457, .hw_value = 10 },
33 { .center_freq = 2462, .hw_value = 11 },
34 { .center_freq = 2467, .hw_value = 12 },
35 { .center_freq = 2472, .hw_value = 13 },
36 { .center_freq = 2484, .hw_value = 14 },
39 /* This table contains the hardware specific values for the modulation rates. */
40 static const struct ieee80211_rate lbtf_rates[] = {
45 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
48 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
51 .flags = IEEE80211_RATE_SHORT_PREAMBLE },
78 static void lbtf_cmd_work(struct work_struct *work)
80 struct lbtf_private *priv = container_of(work, struct lbtf_private,
82 spin_lock_irq(&priv->driver_lock);
83 /* command response? */
84 if (priv->cmd_response_rxed) {
85 priv->cmd_response_rxed = 0;
86 spin_unlock_irq(&priv->driver_lock);
87 lbtf_process_rx_command(priv);
88 spin_lock_irq(&priv->driver_lock);
91 if (priv->cmd_timed_out && priv->cur_cmd) {
92 struct cmd_ctrl_node *cmdnode = priv->cur_cmd;
94 if (++priv->nr_retries > 10) {
95 lbtf_complete_command(priv, cmdnode,
101 /* Stick it back at the _top_ of the pending
102 * queue for immediate resubmission */
103 list_add(&cmdnode->list, &priv->cmdpendingq);
106 priv->cmd_timed_out = 0;
107 spin_unlock_irq(&priv->driver_lock);
111 /* Execute the next command */
113 lbtf_execute_next_command(priv);
117 * lbtf_setup_firmware: initialize firmware.
119 * @priv A pointer to struct lbtf_private structure
121 * Returns: 0 on success.
123 static int lbtf_setup_firmware(struct lbtf_private *priv)
128 * Read priv address from HW
130 memset(priv->current_addr, 0xff, ETH_ALEN);
131 ret = lbtf_update_hw_spec(priv);
137 lbtf_set_mac_control(priv);
138 lbtf_set_radio_control(priv);
146 * This function handles the timeout of command sending.
147 * It will re-send the same command again.
149 static void command_timer_fn(unsigned long data)
151 struct lbtf_private *priv = (struct lbtf_private *)data;
154 spin_lock_irqsave(&priv->driver_lock, flags);
156 if (!priv->cur_cmd) {
157 printk(KERN_DEBUG "libertastf: command timer expired; "
158 "no pending command\n");
162 printk(KERN_DEBUG "libertas: command %x timed out\n",
163 le16_to_cpu(priv->cur_cmd->cmdbuf->command));
165 priv->cmd_timed_out = 1;
166 queue_work(lbtf_wq, &priv->cmd_work);
168 spin_unlock_irqrestore(&priv->driver_lock, flags);
171 static int lbtf_init_adapter(struct lbtf_private *priv)
173 memset(priv->current_addr, 0xff, ETH_ALEN);
174 mutex_init(&priv->lock);
177 setup_timer(&priv->command_timer, command_timer_fn,
178 (unsigned long)priv);
180 INIT_LIST_HEAD(&priv->cmdfreeq);
181 INIT_LIST_HEAD(&priv->cmdpendingq);
183 spin_lock_init(&priv->driver_lock);
185 /* Allocate the command buffers */
186 if (lbtf_allocate_cmd_buffer(priv))
192 static void lbtf_free_adapter(struct lbtf_private *priv)
194 lbtf_free_cmd_buffer(priv);
195 del_timer(&priv->command_timer);
198 static int lbtf_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb)
200 struct lbtf_private *priv = hw->priv;
202 priv->skb_to_tx = skb;
203 queue_work(lbtf_wq, &priv->tx_work);
205 * queue will be restarted when we receive transmission feedback if
206 * there are no buffered multicast frames to send
208 ieee80211_stop_queues(priv->hw);
212 static void lbtf_tx_work(struct work_struct *work)
214 struct lbtf_private *priv = container_of(work, struct lbtf_private,
217 struct ieee80211_tx_info *info;
219 struct sk_buff *skb = NULL;
222 if ((priv->vif->type == NL80211_IFTYPE_AP) &&
223 (!skb_queue_empty(&priv->bc_ps_buf)))
224 skb = skb_dequeue(&priv->bc_ps_buf);
225 else if (priv->skb_to_tx) {
226 skb = priv->skb_to_tx;
227 priv->skb_to_tx = NULL;
232 info = IEEE80211_SKB_CB(skb);
233 txpd = (struct txpd *) skb_push(skb, sizeof(struct txpd));
235 if (priv->surpriseremoved) {
236 dev_kfree_skb_any(skb);
240 memset(txpd, 0, sizeof(struct txpd));
241 /* Activate per-packet rate selection */
242 txpd->tx_control |= cpu_to_le32(MRVL_PER_PACKET_RATE |
243 ieee80211_get_tx_rate(priv->hw, info)->hw_value);
245 /* copy destination address from 802.11 header */
246 memcpy(txpd->tx_dest_addr_high, skb->data + sizeof(struct txpd) + 4,
248 txpd->tx_packet_length = cpu_to_le16(len);
249 txpd->tx_packet_location = cpu_to_le32(sizeof(struct txpd));
250 BUG_ON(priv->tx_skb);
251 spin_lock_irq(&priv->driver_lock);
253 err = priv->hw_host_to_card(priv, MVMS_DAT, skb->data, skb->len);
254 spin_unlock_irq(&priv->driver_lock);
256 dev_kfree_skb_any(skb);
261 static int lbtf_op_start(struct ieee80211_hw *hw)
263 struct lbtf_private *priv = hw->priv;
264 void *card = priv->card;
268 /* Upload firmware */
269 if (priv->hw_prog_firmware(card))
270 goto err_prog_firmware;
272 /* poke the firmware */
273 priv->capability = WLAN_CAPABILITY_SHORT_PREAMBLE;
274 priv->radioon = RADIO_ON;
275 priv->mac_control = CMD_ACT_MAC_RX_ON | CMD_ACT_MAC_TX_ON;
276 ret = lbtf_setup_firmware(priv);
278 goto err_prog_firmware;
280 if ((priv->fwrelease < LBTF_FW_VER_MIN) ||
281 (priv->fwrelease > LBTF_FW_VER_MAX)) {
283 goto err_prog_firmware;
286 printk(KERN_INFO "libertastf: Marvell WLAN 802.11 thinfirm adapter\n");
290 priv->hw_reset_device(card);
294 static void lbtf_op_stop(struct ieee80211_hw *hw)
296 struct lbtf_private *priv = hw->priv;
300 struct cmd_ctrl_node *cmdnode;
301 /* Flush pending command nodes */
302 spin_lock_irqsave(&priv->driver_lock, flags);
303 list_for_each_entry(cmdnode, &priv->cmdpendingq, list) {
304 cmdnode->result = -ENOENT;
305 cmdnode->cmdwaitqwoken = 1;
306 wake_up_interruptible(&cmdnode->cmdwait_q);
309 spin_unlock_irqrestore(&priv->driver_lock, flags);
310 cancel_work_sync(&priv->cmd_work);
311 cancel_work_sync(&priv->tx_work);
312 while ((skb = skb_dequeue(&priv->bc_ps_buf)))
313 dev_kfree_skb_any(skb);
314 priv->radioon = RADIO_OFF;
315 lbtf_set_radio_control(priv);
320 static int lbtf_op_add_interface(struct ieee80211_hw *hw,
321 struct ieee80211_if_init_conf *conf)
323 struct lbtf_private *priv = hw->priv;
324 if (priv->vif != NULL)
327 priv->vif = conf->vif;
328 switch (conf->type) {
329 case NL80211_IFTYPE_MESH_POINT:
330 case NL80211_IFTYPE_AP:
331 lbtf_set_mode(priv, LBTF_AP_MODE);
333 case NL80211_IFTYPE_STATION:
334 lbtf_set_mode(priv, LBTF_STA_MODE);
340 lbtf_set_mac_address(priv, (u8 *) conf->mac_addr);
344 static void lbtf_op_remove_interface(struct ieee80211_hw *hw,
345 struct ieee80211_if_init_conf *conf)
347 struct lbtf_private *priv = hw->priv;
349 if (priv->vif->type == NL80211_IFTYPE_AP ||
350 priv->vif->type == NL80211_IFTYPE_MESH_POINT)
351 lbtf_beacon_ctrl(priv, 0, 0);
352 lbtf_set_mode(priv, LBTF_PASSIVE_MODE);
353 lbtf_set_bssid(priv, 0, NULL);
357 static int lbtf_op_config(struct ieee80211_hw *hw, u32 changed)
359 struct lbtf_private *priv = hw->priv;
360 struct ieee80211_conf *conf = &hw->conf;
362 if (conf->channel->center_freq != priv->cur_freq) {
363 priv->cur_freq = conf->channel->center_freq;
364 lbtf_set_channel(priv, conf->channel->hw_value);
369 #define SUPPORTED_FIF_FLAGS (FIF_PROMISC_IN_BSS | FIF_ALLMULTI)
370 static void lbtf_op_configure_filter(struct ieee80211_hw *hw,
371 unsigned int changed_flags,
372 unsigned int *new_flags,
373 int mc_count, struct dev_mc_list *mclist)
375 struct lbtf_private *priv = hw->priv;
376 int old_mac_control = priv->mac_control;
378 changed_flags &= SUPPORTED_FIF_FLAGS;
379 *new_flags &= SUPPORTED_FIF_FLAGS;
384 if (*new_flags & (FIF_PROMISC_IN_BSS))
385 priv->mac_control |= CMD_ACT_MAC_PROMISCUOUS_ENABLE;
387 priv->mac_control &= ~CMD_ACT_MAC_PROMISCUOUS_ENABLE;
388 if (*new_flags & (FIF_ALLMULTI) ||
389 mc_count > MRVDRV_MAX_MULTICAST_LIST_SIZE) {
390 priv->mac_control |= CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
391 priv->mac_control &= ~CMD_ACT_MAC_MULTICAST_ENABLE;
392 } else if (mc_count) {
393 priv->mac_control |= CMD_ACT_MAC_MULTICAST_ENABLE;
394 priv->mac_control &= ~CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
395 priv->nr_of_multicastmacaddr = mc_count;
396 for (i = 0; i < mc_count; i++) {
399 memcpy(&priv->multicastlist[i], mclist->da_addr,
401 mclist = mclist->next;
403 lbtf_cmd_set_mac_multicast_addr(priv);
405 priv->mac_control &= ~(CMD_ACT_MAC_MULTICAST_ENABLE |
406 CMD_ACT_MAC_ALL_MULTICAST_ENABLE);
407 if (priv->nr_of_multicastmacaddr) {
408 priv->nr_of_multicastmacaddr = 0;
409 lbtf_cmd_set_mac_multicast_addr(priv);
414 if (priv->mac_control != old_mac_control)
415 lbtf_set_mac_control(priv);
418 static void lbtf_op_bss_info_changed(struct ieee80211_hw *hw,
419 struct ieee80211_vif *vif,
420 struct ieee80211_bss_conf *bss_conf,
423 struct lbtf_private *priv = hw->priv;
424 struct sk_buff *beacon;
426 if (changes & (BSS_CHANGED_BEACON | BSS_CHANGED_BEACON_INT)) {
427 switch (priv->vif->type) {
428 case NL80211_IFTYPE_AP:
429 case NL80211_IFTYPE_MESH_POINT:
430 beacon = ieee80211_beacon_get(hw, vif);
432 lbtf_beacon_set(priv, beacon);
434 lbtf_beacon_ctrl(priv, 1,
435 bss_conf->beacon_int);
443 if (changes & BSS_CHANGED_BSSID) {
444 bool activate = !is_zero_ether_addr(bss_conf->bssid);
445 lbtf_set_bssid(priv, activate, bss_conf->bssid);
448 if (changes & BSS_CHANGED_ERP_PREAMBLE) {
449 if (bss_conf->use_short_preamble)
450 priv->preamble = CMD_TYPE_SHORT_PREAMBLE;
452 priv->preamble = CMD_TYPE_LONG_PREAMBLE;
453 lbtf_set_radio_control(priv);
457 static const struct ieee80211_ops lbtf_ops = {
459 .start = lbtf_op_start,
460 .stop = lbtf_op_stop,
461 .add_interface = lbtf_op_add_interface,
462 .remove_interface = lbtf_op_remove_interface,
463 .config = lbtf_op_config,
464 .configure_filter = lbtf_op_configure_filter,
465 .bss_info_changed = lbtf_op_bss_info_changed,
468 int lbtf_rx(struct lbtf_private *priv, struct sk_buff *skb)
470 struct ieee80211_rx_status stats;
474 struct ieee80211_hdr *hdr;
476 prxpd = (struct rxpd *) skb->data;
479 if (!(prxpd->status & cpu_to_le16(MRVDRV_RXPD_STATUS_OK)))
480 stats.flag |= RX_FLAG_FAILED_FCS_CRC;
481 stats.freq = priv->cur_freq;
482 stats.band = IEEE80211_BAND_2GHZ;
483 stats.signal = prxpd->snr;
484 stats.noise = prxpd->nf;
485 stats.qual = prxpd->snr - prxpd->nf;
486 /* Marvell rate index has a hole at value 4 */
487 if (prxpd->rx_rate > 4)
489 stats.rate_idx = prxpd->rx_rate;
490 skb_pull(skb, sizeof(struct rxpd));
492 hdr = (struct ieee80211_hdr *)skb->data;
493 flags = le32_to_cpu(*(__le32 *)(skb->data + 4));
495 need_padding = ieee80211_is_data_qos(hdr->frame_control);
496 need_padding ^= ieee80211_has_a4(hdr->frame_control);
497 need_padding ^= ieee80211_is_data_qos(hdr->frame_control) &&
498 (*ieee80211_get_qos_ctl(hdr) &
499 IEEE80211_QOS_CONTROL_A_MSDU_PRESENT);
502 memmove(skb->data + 2, skb->data, skb->len);
506 ieee80211_rx_irqsafe(priv->hw, skb, &stats);
509 EXPORT_SYMBOL_GPL(lbtf_rx);
512 * lbtf_add_card: Add and initialize the card, no fw upload yet.
514 * @card A pointer to card
516 * Returns: pointer to struct lbtf_priv.
518 struct lbtf_private *lbtf_add_card(void *card, struct device *dmdev)
520 struct ieee80211_hw *hw;
521 struct lbtf_private *priv = NULL;
523 hw = ieee80211_alloc_hw(sizeof(struct lbtf_private), &lbtf_ops);
528 if (lbtf_init_adapter(priv))
529 goto err_init_adapter;
536 hw->flags = IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING;
537 hw->extra_tx_headroom = sizeof(struct txpd);
538 memcpy(priv->channels, lbtf_channels, sizeof(lbtf_channels));
539 memcpy(priv->rates, lbtf_rates, sizeof(lbtf_rates));
540 priv->band.n_bitrates = ARRAY_SIZE(lbtf_rates);
541 priv->band.bitrates = priv->rates;
542 priv->band.n_channels = ARRAY_SIZE(lbtf_channels);
543 priv->band.channels = priv->channels;
544 hw->wiphy->bands[IEEE80211_BAND_2GHZ] = &priv->band;
545 skb_queue_head_init(&priv->bc_ps_buf);
547 SET_IEEE80211_DEV(hw, dmdev);
549 INIT_WORK(&priv->cmd_work, lbtf_cmd_work);
550 INIT_WORK(&priv->tx_work, lbtf_tx_work);
551 if (ieee80211_register_hw(hw))
552 goto err_init_adapter;
557 lbtf_free_adapter(priv);
558 ieee80211_free_hw(hw);
564 EXPORT_SYMBOL_GPL(lbtf_add_card);
567 int lbtf_remove_card(struct lbtf_private *priv)
569 struct ieee80211_hw *hw = priv->hw;
571 priv->surpriseremoved = 1;
572 del_timer(&priv->command_timer);
573 lbtf_free_adapter(priv);
575 ieee80211_unregister_hw(hw);
576 ieee80211_free_hw(hw);
580 EXPORT_SYMBOL_GPL(lbtf_remove_card);
582 void lbtf_send_tx_feedback(struct lbtf_private *priv, u8 retrycnt, u8 fail)
584 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(priv->tx_skb);
586 ieee80211_tx_info_clear_status(info);
588 * Commented out, otherwise we never go beyond 1Mbit/s using mac80211
589 * default pid rc algorithm.
591 * info->status.retry_count = MRVL_DEFAULT_RETRIES - retrycnt;
593 if (!(info->flags & IEEE80211_TX_CTL_NO_ACK) && !fail)
594 info->flags |= IEEE80211_TX_STAT_ACK;
595 skb_pull(priv->tx_skb, sizeof(struct txpd));
596 ieee80211_tx_status_irqsafe(priv->hw, priv->tx_skb);
598 if (!priv->skb_to_tx && skb_queue_empty(&priv->bc_ps_buf))
599 ieee80211_wake_queues(priv->hw);
601 queue_work(lbtf_wq, &priv->tx_work);
603 EXPORT_SYMBOL_GPL(lbtf_send_tx_feedback);
605 void lbtf_bcn_sent(struct lbtf_private *priv)
607 struct sk_buff *skb = NULL;
609 if (priv->vif->type != NL80211_IFTYPE_AP)
612 if (skb_queue_empty(&priv->bc_ps_buf)) {
615 while ((skb = ieee80211_get_buffered_bc(priv->hw, priv->vif))) {
616 skb_queue_tail(&priv->bc_ps_buf, skb);
620 ieee80211_stop_queues(priv->hw);
621 queue_work(lbtf_wq, &priv->tx_work);
625 skb = ieee80211_beacon_get(priv->hw, priv->vif);
628 lbtf_beacon_set(priv, skb);
632 EXPORT_SYMBOL_GPL(lbtf_bcn_sent);
634 static int __init lbtf_init_module(void)
636 lbtf_wq = create_workqueue("libertastf");
637 if (lbtf_wq == NULL) {
638 printk(KERN_ERR "libertastf: couldn't create workqueue\n");
644 static void __exit lbtf_exit_module(void)
646 destroy_workqueue(lbtf_wq);
649 module_init(lbtf_init_module);
650 module_exit(lbtf_exit_module);
652 MODULE_DESCRIPTION("Libertas WLAN Thinfirm Driver Library");
653 MODULE_AUTHOR("Cozybit Inc.");
654 MODULE_LICENSE("GPL");