Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[linux-2.6.git] / drivers / net / wireless / libertas / main.c
1 /**
2   * This file contains the major functions in WLAN
3   * driver. It includes init, exit, open, close and main
4   * thread etc..
5   */
6
7 #include <linux/moduleparam.h>
8 #include <linux/delay.h>
9 #include <linux/etherdevice.h>
10 #include <linux/netdevice.h>
11 #include <linux/if_arp.h>
12 #include <linux/kthread.h>
13 #include <linux/kfifo.h>
14 #include <linux/slab.h>
15 #include <net/cfg80211.h>
16
17 #include "host.h"
18 #include "decl.h"
19 #include "dev.h"
20 #include "cfg.h"
21 #include "debugfs.h"
22 #include "cmd.h"
23
24 #define DRIVER_RELEASE_VERSION "323.p0"
25 const char lbs_driver_version[] = "COMM-USB8388-" DRIVER_RELEASE_VERSION
26 #ifdef  DEBUG
27     "-dbg"
28 #endif
29     "";
30
31
32 /* Module parameters */
33 unsigned int lbs_debug;
34 EXPORT_SYMBOL_GPL(lbs_debug);
35 module_param_named(libertas_debug, lbs_debug, int, 0644);
36
37
38 /* This global structure is used to send the confirm_sleep command as
39  * fast as possible down to the firmware. */
40 struct cmd_confirm_sleep confirm_sleep;
41
42
43 /**
44  * the table to keep region code
45  */
46 u16 lbs_region_code_to_index[MRVDRV_MAX_REGION_CODE] =
47     { 0x10, 0x20, 0x30, 0x31, 0x32, 0x40 };
48
49 /**
50  * FW rate table.  FW refers to rates by their index in this table, not by the
51  * rate value itself.  Values of 0x00 are
52  * reserved positions.
53  */
54 static u8 fw_data_rates[MAX_RATES] =
55     { 0x02, 0x04, 0x0B, 0x16, 0x00, 0x0C, 0x12,
56       0x18, 0x24, 0x30, 0x48, 0x60, 0x6C, 0x00
57 };
58
59 /**
60  *  @brief use index to get the data rate
61  *
62  *  @param idx                The index of data rate
63  *  @return                     data rate or 0
64  */
65 u32 lbs_fw_index_to_data_rate(u8 idx)
66 {
67         if (idx >= sizeof(fw_data_rates))
68                 idx = 0;
69         return fw_data_rates[idx];
70 }
71
72 /**
73  *  @brief use rate to get the index
74  *
75  *  @param rate                 data rate
76  *  @return                     index or 0
77  */
78 u8 lbs_data_rate_to_fw_index(u32 rate)
79 {
80         u8 i;
81
82         if (!rate)
83                 return 0;
84
85         for (i = 0; i < sizeof(fw_data_rates); i++) {
86                 if (rate == fw_data_rates[i])
87                         return i;
88         }
89         return 0;
90 }
91
92
93 /**
94  *  @brief This function opens the ethX interface
95  *
96  *  @param dev     A pointer to net_device structure
97  *  @return        0 or -EBUSY if monitor mode active
98  */
99 static int lbs_dev_open(struct net_device *dev)
100 {
101         struct lbs_private *priv = dev->ml_priv;
102         int ret = 0;
103
104         lbs_deb_enter(LBS_DEB_NET);
105
106         spin_lock_irq(&priv->driver_lock);
107         priv->stopping = false;
108
109         if (priv->connect_status == LBS_CONNECTED)
110                 netif_carrier_on(dev);
111         else
112                 netif_carrier_off(dev);
113
114         if (!priv->tx_pending_len)
115                 netif_wake_queue(dev);
116
117         spin_unlock_irq(&priv->driver_lock);
118         lbs_deb_leave_args(LBS_DEB_NET, "ret %d", ret);
119         return ret;
120 }
121
122 /**
123  *  @brief This function closes the ethX interface
124  *
125  *  @param dev     A pointer to net_device structure
126  *  @return        0
127  */
128 static int lbs_eth_stop(struct net_device *dev)
129 {
130         struct lbs_private *priv = dev->ml_priv;
131
132         lbs_deb_enter(LBS_DEB_NET);
133
134         spin_lock_irq(&priv->driver_lock);
135         priv->stopping = true;
136         netif_stop_queue(dev);
137         spin_unlock_irq(&priv->driver_lock);
138
139         schedule_work(&priv->mcast_work);
140         cancel_delayed_work_sync(&priv->scan_work);
141         if (priv->scan_req) {
142                 cfg80211_scan_done(priv->scan_req, false);
143                 priv->scan_req = NULL;
144         }
145
146         lbs_deb_leave(LBS_DEB_NET);
147         return 0;
148 }
149
150 static void lbs_tx_timeout(struct net_device *dev)
151 {
152         struct lbs_private *priv = dev->ml_priv;
153
154         lbs_deb_enter(LBS_DEB_TX);
155
156         lbs_pr_err("tx watch dog timeout\n");
157
158         dev->trans_start = jiffies; /* prevent tx timeout */
159
160         if (priv->currenttxskb)
161                 lbs_send_tx_feedback(priv, 0);
162
163         /* XX: Shouldn't we also call into the hw-specific driver
164            to kick it somehow? */
165         lbs_host_to_card_done(priv);
166
167         /* FIXME: reset the card */
168
169         lbs_deb_leave(LBS_DEB_TX);
170 }
171
172 void lbs_host_to_card_done(struct lbs_private *priv)
173 {
174         unsigned long flags;
175
176         lbs_deb_enter(LBS_DEB_THREAD);
177
178         spin_lock_irqsave(&priv->driver_lock, flags);
179
180         priv->dnld_sent = DNLD_RES_RECEIVED;
181
182         /* Wake main thread if commands are pending */
183         if (!priv->cur_cmd || priv->tx_pending_len > 0) {
184                 if (!priv->wakeup_dev_required)
185                         wake_up_interruptible(&priv->waitq);
186         }
187
188         spin_unlock_irqrestore(&priv->driver_lock, flags);
189         lbs_deb_leave(LBS_DEB_THREAD);
190 }
191 EXPORT_SYMBOL_GPL(lbs_host_to_card_done);
192
193 int lbs_set_mac_address(struct net_device *dev, void *addr)
194 {
195         int ret = 0;
196         struct lbs_private *priv = dev->ml_priv;
197         struct sockaddr *phwaddr = addr;
198         struct cmd_ds_802_11_mac_address cmd;
199
200         lbs_deb_enter(LBS_DEB_NET);
201
202         /* In case it was called from the mesh device */
203         dev = priv->dev;
204
205         cmd.hdr.size = cpu_to_le16(sizeof(cmd));
206         cmd.action = cpu_to_le16(CMD_ACT_SET);
207         memcpy(cmd.macadd, phwaddr->sa_data, ETH_ALEN);
208
209         ret = lbs_cmd_with_response(priv, CMD_802_11_MAC_ADDRESS, &cmd);
210         if (ret) {
211                 lbs_deb_net("set MAC address failed\n");
212                 goto done;
213         }
214
215         memcpy(priv->current_addr, phwaddr->sa_data, ETH_ALEN);
216         memcpy(dev->dev_addr, phwaddr->sa_data, ETH_ALEN);
217         if (priv->mesh_dev)
218                 memcpy(priv->mesh_dev->dev_addr, phwaddr->sa_data, ETH_ALEN);
219
220 done:
221         lbs_deb_leave_args(LBS_DEB_NET, "ret %d", ret);
222         return ret;
223 }
224
225
226 static inline int mac_in_list(unsigned char *list, int list_len,
227                               unsigned char *mac)
228 {
229         while (list_len) {
230                 if (!memcmp(list, mac, ETH_ALEN))
231                         return 1;
232                 list += ETH_ALEN;
233                 list_len--;
234         }
235         return 0;
236 }
237
238
239 static int lbs_add_mcast_addrs(struct cmd_ds_mac_multicast_adr *cmd,
240                                struct net_device *dev, int nr_addrs)
241 {
242         int i = nr_addrs;
243         struct netdev_hw_addr *ha;
244         int cnt;
245
246         if ((dev->flags & (IFF_UP|IFF_MULTICAST)) != (IFF_UP|IFF_MULTICAST))
247                 return nr_addrs;
248
249         netif_addr_lock_bh(dev);
250         cnt = netdev_mc_count(dev);
251         netdev_for_each_mc_addr(ha, dev) {
252                 if (mac_in_list(cmd->maclist, nr_addrs, ha->addr)) {
253                         lbs_deb_net("mcast address %s:%pM skipped\n", dev->name,
254                                     ha->addr);
255                         cnt--;
256                         continue;
257                 }
258
259                 if (i == MRVDRV_MAX_MULTICAST_LIST_SIZE)
260                         break;
261                 memcpy(&cmd->maclist[6*i], ha->addr, ETH_ALEN);
262                 lbs_deb_net("mcast address %s:%pM added to filter\n", dev->name,
263                             ha->addr);
264                 i++;
265                 cnt--;
266         }
267         netif_addr_unlock_bh(dev);
268         if (cnt)
269                 return -EOVERFLOW;
270
271         return i;
272 }
273
274 static void lbs_set_mcast_worker(struct work_struct *work)
275 {
276         struct lbs_private *priv = container_of(work, struct lbs_private, mcast_work);
277         struct cmd_ds_mac_multicast_adr mcast_cmd;
278         int dev_flags;
279         int nr_addrs;
280         int old_mac_control = priv->mac_control;
281
282         lbs_deb_enter(LBS_DEB_NET);
283
284         dev_flags = priv->dev->flags;
285         if (priv->mesh_dev)
286                 dev_flags |= priv->mesh_dev->flags;
287
288         if (dev_flags & IFF_PROMISC) {
289                 priv->mac_control |= CMD_ACT_MAC_PROMISCUOUS_ENABLE;
290                 priv->mac_control &= ~(CMD_ACT_MAC_ALL_MULTICAST_ENABLE |
291                                        CMD_ACT_MAC_MULTICAST_ENABLE);
292                 goto out_set_mac_control;
293         } else if (dev_flags & IFF_ALLMULTI) {
294         do_allmulti:
295                 priv->mac_control |= CMD_ACT_MAC_ALL_MULTICAST_ENABLE;
296                 priv->mac_control &= ~(CMD_ACT_MAC_PROMISCUOUS_ENABLE |
297                                        CMD_ACT_MAC_MULTICAST_ENABLE);
298                 goto out_set_mac_control;
299         }
300
301         /* Once for priv->dev, again for priv->mesh_dev if it exists */
302         nr_addrs = lbs_add_mcast_addrs(&mcast_cmd, priv->dev, 0);
303         if (nr_addrs >= 0 && priv->mesh_dev)
304                 nr_addrs = lbs_add_mcast_addrs(&mcast_cmd, priv->mesh_dev, nr_addrs);
305         if (nr_addrs < 0)
306                 goto do_allmulti;
307
308         if (nr_addrs) {
309                 int size = offsetof(struct cmd_ds_mac_multicast_adr,
310                                     maclist[6*nr_addrs]);
311
312                 mcast_cmd.action = cpu_to_le16(CMD_ACT_SET);
313                 mcast_cmd.hdr.size = cpu_to_le16(size);
314                 mcast_cmd.nr_of_adrs = cpu_to_le16(nr_addrs);
315
316                 lbs_cmd_async(priv, CMD_MAC_MULTICAST_ADR, &mcast_cmd.hdr, size);
317
318                 priv->mac_control |= CMD_ACT_MAC_MULTICAST_ENABLE;
319         } else
320                 priv->mac_control &= ~CMD_ACT_MAC_MULTICAST_ENABLE;
321
322         priv->mac_control &= ~(CMD_ACT_MAC_PROMISCUOUS_ENABLE |
323                                CMD_ACT_MAC_ALL_MULTICAST_ENABLE);
324  out_set_mac_control:
325         if (priv->mac_control != old_mac_control)
326                 lbs_set_mac_control(priv);
327
328         lbs_deb_leave(LBS_DEB_NET);
329 }
330
331 void lbs_set_multicast_list(struct net_device *dev)
332 {
333         struct lbs_private *priv = dev->ml_priv;
334
335         schedule_work(&priv->mcast_work);
336 }
337
338 /**
339  *  @brief This function handles the major jobs in the LBS driver.
340  *  It handles all events generated by firmware, RX data received
341  *  from firmware and TX data sent from kernel.
342  *
343  *  @param data    A pointer to lbs_thread structure
344  *  @return        0
345  */
346 static int lbs_thread(void *data)
347 {
348         struct net_device *dev = data;
349         struct lbs_private *priv = dev->ml_priv;
350         wait_queue_t wait;
351
352         lbs_deb_enter(LBS_DEB_THREAD);
353
354         init_waitqueue_entry(&wait, current);
355
356         for (;;) {
357                 int shouldsleep;
358                 u8 resp_idx;
359
360                 lbs_deb_thread("1: currenttxskb %p, dnld_sent %d\n",
361                                 priv->currenttxskb, priv->dnld_sent);
362
363                 add_wait_queue(&priv->waitq, &wait);
364                 set_current_state(TASK_INTERRUPTIBLE);
365                 spin_lock_irq(&priv->driver_lock);
366
367                 if (kthread_should_stop())
368                         shouldsleep = 0;        /* Bye */
369                 else if (priv->surpriseremoved)
370                         shouldsleep = 1;        /* We need to wait until we're _told_ to die */
371                 else if (priv->psstate == PS_STATE_SLEEP)
372                         shouldsleep = 1;        /* Sleep mode. Nothing we can do till it wakes */
373                 else if (priv->cmd_timed_out)
374                         shouldsleep = 0;        /* Command timed out. Recover */
375                 else if (!priv->fw_ready)
376                         shouldsleep = 1;        /* Firmware not ready. We're waiting for it */
377                 else if (priv->dnld_sent)
378                         shouldsleep = 1;        /* Something is en route to the device already */
379                 else if (priv->tx_pending_len > 0)
380                         shouldsleep = 0;        /* We've a packet to send */
381                 else if (priv->resp_len[priv->resp_idx])
382                         shouldsleep = 0;        /* We have a command response */
383                 else if (priv->cur_cmd)
384                         shouldsleep = 1;        /* Can't send a command; one already running */
385                 else if (!list_empty(&priv->cmdpendingq) &&
386                                         !(priv->wakeup_dev_required))
387                         shouldsleep = 0;        /* We have a command to send */
388                 else if (kfifo_len(&priv->event_fifo))
389                         shouldsleep = 0;        /* We have an event to process */
390                 else
391                         shouldsleep = 1;        /* No command */
392
393                 if (shouldsleep) {
394                         lbs_deb_thread("sleeping, connect_status %d, "
395                                 "psmode %d, psstate %d\n",
396                                 priv->connect_status,
397                                 priv->psmode, priv->psstate);
398                         spin_unlock_irq(&priv->driver_lock);
399                         schedule();
400                 } else
401                         spin_unlock_irq(&priv->driver_lock);
402
403                 lbs_deb_thread("2: currenttxskb %p, dnld_send %d\n",
404                                priv->currenttxskb, priv->dnld_sent);
405
406                 set_current_state(TASK_RUNNING);
407                 remove_wait_queue(&priv->waitq, &wait);
408
409                 lbs_deb_thread("3: currenttxskb %p, dnld_sent %d\n",
410                                priv->currenttxskb, priv->dnld_sent);
411
412                 if (kthread_should_stop()) {
413                         lbs_deb_thread("break from main thread\n");
414                         break;
415                 }
416
417                 if (priv->surpriseremoved) {
418                         lbs_deb_thread("adapter removed; waiting to die...\n");
419                         continue;
420                 }
421
422                 lbs_deb_thread("4: currenttxskb %p, dnld_sent %d\n",
423                        priv->currenttxskb, priv->dnld_sent);
424
425                 /* Process any pending command response */
426                 spin_lock_irq(&priv->driver_lock);
427                 resp_idx = priv->resp_idx;
428                 if (priv->resp_len[resp_idx]) {
429                         spin_unlock_irq(&priv->driver_lock);
430                         lbs_process_command_response(priv,
431                                 priv->resp_buf[resp_idx],
432                                 priv->resp_len[resp_idx]);
433                         spin_lock_irq(&priv->driver_lock);
434                         priv->resp_len[resp_idx] = 0;
435                 }
436                 spin_unlock_irq(&priv->driver_lock);
437
438                 /* Process hardware events, e.g. card removed, link lost */
439                 spin_lock_irq(&priv->driver_lock);
440                 while (kfifo_len(&priv->event_fifo)) {
441                         u32 event;
442
443                         if (kfifo_out(&priv->event_fifo,
444                                 (unsigned char *) &event, sizeof(event)) !=
445                                 sizeof(event))
446                                         break;
447                         spin_unlock_irq(&priv->driver_lock);
448                         lbs_process_event(priv, event);
449                         spin_lock_irq(&priv->driver_lock);
450                 }
451                 spin_unlock_irq(&priv->driver_lock);
452
453                 if (priv->wakeup_dev_required) {
454                         lbs_deb_thread("Waking up device...\n");
455                         /* Wake up device */
456                         if (priv->exit_deep_sleep(priv))
457                                 lbs_deb_thread("Wakeup device failed\n");
458                         continue;
459                 }
460
461                 /* command timeout stuff */
462                 if (priv->cmd_timed_out && priv->cur_cmd) {
463                         struct cmd_ctrl_node *cmdnode = priv->cur_cmd;
464
465                         lbs_pr_info("Timeout submitting command 0x%04x\n",
466                                 le16_to_cpu(cmdnode->cmdbuf->command));
467                         lbs_complete_command(priv, cmdnode, -ETIMEDOUT);
468                         if (priv->reset_card)
469                                 priv->reset_card(priv);
470                 }
471                 priv->cmd_timed_out = 0;
472
473                 if (!priv->fw_ready)
474                         continue;
475
476                 /* Check if we need to confirm Sleep Request received previously */
477                 if (priv->psstate == PS_STATE_PRE_SLEEP &&
478                     !priv->dnld_sent && !priv->cur_cmd) {
479                         if (priv->connect_status == LBS_CONNECTED) {
480                                 lbs_deb_thread("pre-sleep, currenttxskb %p, "
481                                         "dnld_sent %d, cur_cmd %p\n",
482                                         priv->currenttxskb, priv->dnld_sent,
483                                         priv->cur_cmd);
484
485                                 lbs_ps_confirm_sleep(priv);
486                         } else {
487                                 /* workaround for firmware sending
488                                  * deauth/linkloss event immediately
489                                  * after sleep request; remove this
490                                  * after firmware fixes it
491                                  */
492                                 priv->psstate = PS_STATE_AWAKE;
493                                 lbs_pr_alert("ignore PS_SleepConfirm in "
494                                         "non-connected state\n");
495                         }
496                 }
497
498                 /* The PS state is changed during processing of Sleep Request
499                  * event above
500                  */
501                 if ((priv->psstate == PS_STATE_SLEEP) ||
502                     (priv->psstate == PS_STATE_PRE_SLEEP))
503                         continue;
504
505                 if (priv->is_deep_sleep)
506                         continue;
507
508                 /* Execute the next command */
509                 if (!priv->dnld_sent && !priv->cur_cmd)
510                         lbs_execute_next_command(priv);
511
512                 spin_lock_irq(&priv->driver_lock);
513                 if (!priv->dnld_sent && priv->tx_pending_len > 0) {
514                         int ret = priv->hw_host_to_card(priv, MVMS_DAT,
515                                                         priv->tx_pending_buf,
516                                                         priv->tx_pending_len);
517                         if (ret) {
518                                 lbs_deb_tx("host_to_card failed %d\n", ret);
519                                 priv->dnld_sent = DNLD_RES_RECEIVED;
520                         }
521                         priv->tx_pending_len = 0;
522                         if (!priv->currenttxskb) {
523                                 /* We can wake the queues immediately if we aren't
524                                    waiting for TX feedback */
525                                 if (priv->connect_status == LBS_CONNECTED)
526                                         netif_wake_queue(priv->dev);
527                                 if (priv->mesh_dev &&
528                                     lbs_mesh_connected(priv))
529                                         netif_wake_queue(priv->mesh_dev);
530                         }
531                 }
532                 spin_unlock_irq(&priv->driver_lock);
533         }
534
535         del_timer(&priv->command_timer);
536         del_timer(&priv->auto_deepsleep_timer);
537
538         lbs_deb_leave(LBS_DEB_THREAD);
539         return 0;
540 }
541
542 int lbs_suspend(struct lbs_private *priv)
543 {
544         int ret;
545
546         lbs_deb_enter(LBS_DEB_FW);
547
548         if (priv->is_deep_sleep) {
549                 ret = lbs_set_deep_sleep(priv, 0);
550                 if (ret) {
551                         lbs_pr_err("deep sleep cancellation failed: %d\n", ret);
552                         return ret;
553                 }
554                 priv->deep_sleep_required = 1;
555         }
556
557         ret = lbs_set_host_sleep(priv, 1);
558
559         netif_device_detach(priv->dev);
560         if (priv->mesh_dev)
561                 netif_device_detach(priv->mesh_dev);
562
563         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
564         return ret;
565 }
566 EXPORT_SYMBOL_GPL(lbs_suspend);
567
568 int lbs_resume(struct lbs_private *priv)
569 {
570         int ret;
571
572         lbs_deb_enter(LBS_DEB_FW);
573
574         ret = lbs_set_host_sleep(priv, 0);
575
576         netif_device_attach(priv->dev);
577         if (priv->mesh_dev)
578                 netif_device_attach(priv->mesh_dev);
579
580         if (priv->deep_sleep_required) {
581                 priv->deep_sleep_required = 0;
582                 ret = lbs_set_deep_sleep(priv, 1);
583                 if (ret)
584                         lbs_pr_err("deep sleep activation failed: %d\n", ret);
585         }
586
587         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
588         return ret;
589 }
590 EXPORT_SYMBOL_GPL(lbs_resume);
591
592 /**
593  * @brief This function gets the HW spec from the firmware and sets
594  *        some basic parameters.
595  *
596  *  @param priv    A pointer to struct lbs_private structure
597  *  @return        0 or -1
598  */
599 static int lbs_setup_firmware(struct lbs_private *priv)
600 {
601         int ret = -1;
602         s16 curlevel = 0, minlevel = 0, maxlevel = 0;
603
604         lbs_deb_enter(LBS_DEB_FW);
605
606         /* Read MAC address from firmware */
607         memset(priv->current_addr, 0xff, ETH_ALEN);
608         ret = lbs_update_hw_spec(priv);
609         if (ret)
610                 goto done;
611
612         /* Read power levels if available */
613         ret = lbs_get_tx_power(priv, &curlevel, &minlevel, &maxlevel);
614         if (ret == 0) {
615                 priv->txpower_cur = curlevel;
616                 priv->txpower_min = minlevel;
617                 priv->txpower_max = maxlevel;
618         }
619
620         /* Send cmd to FW to enable 11D function */
621         ret = lbs_set_snmp_mib(priv, SNMP_MIB_OID_11D_ENABLE, 1);
622
623         lbs_set_mac_control(priv);
624 done:
625         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
626         return ret;
627 }
628
629 /**
630  *  This function handles the timeout of command sending.
631  *  It will re-send the same command again.
632  */
633 static void lbs_cmd_timeout_handler(unsigned long data)
634 {
635         struct lbs_private *priv = (struct lbs_private *)data;
636         unsigned long flags;
637
638         lbs_deb_enter(LBS_DEB_CMD);
639         spin_lock_irqsave(&priv->driver_lock, flags);
640
641         if (!priv->cur_cmd)
642                 goto out;
643
644         lbs_pr_info("command 0x%04x timed out\n",
645                 le16_to_cpu(priv->cur_cmd->cmdbuf->command));
646
647         priv->cmd_timed_out = 1;
648         wake_up_interruptible(&priv->waitq);
649 out:
650         spin_unlock_irqrestore(&priv->driver_lock, flags);
651         lbs_deb_leave(LBS_DEB_CMD);
652 }
653
654 /**
655  *  This function put the device back to deep sleep mode when timer expires
656  *  and no activity (command, event, data etc.) is detected.
657  */
658 static void auto_deepsleep_timer_fn(unsigned long data)
659 {
660         struct lbs_private *priv = (struct lbs_private *)data;
661
662         lbs_deb_enter(LBS_DEB_CMD);
663
664         if (priv->is_activity_detected) {
665                 priv->is_activity_detected = 0;
666         } else {
667                 if (priv->is_auto_deep_sleep_enabled &&
668                     (!priv->wakeup_dev_required) &&
669                     (priv->connect_status != LBS_CONNECTED)) {
670                         struct cmd_header cmd;
671
672                         lbs_deb_main("Entering auto deep sleep mode...\n");
673                         memset(&cmd, 0, sizeof(cmd));
674                         cmd.size = cpu_to_le16(sizeof(cmd));
675                         lbs_cmd_async(priv, CMD_802_11_DEEP_SLEEP, &cmd,
676                                         sizeof(cmd));
677                 }
678         }
679         mod_timer(&priv->auto_deepsleep_timer , jiffies +
680                                 (priv->auto_deep_sleep_timeout * HZ)/1000);
681         lbs_deb_leave(LBS_DEB_CMD);
682 }
683
684 int lbs_enter_auto_deep_sleep(struct lbs_private *priv)
685 {
686         lbs_deb_enter(LBS_DEB_SDIO);
687
688         priv->is_auto_deep_sleep_enabled = 1;
689         if (priv->is_deep_sleep)
690                 priv->wakeup_dev_required = 1;
691         mod_timer(&priv->auto_deepsleep_timer ,
692                         jiffies + (priv->auto_deep_sleep_timeout * HZ)/1000);
693
694         lbs_deb_leave(LBS_DEB_SDIO);
695         return 0;
696 }
697
698 int lbs_exit_auto_deep_sleep(struct lbs_private *priv)
699 {
700         lbs_deb_enter(LBS_DEB_SDIO);
701
702         priv->is_auto_deep_sleep_enabled = 0;
703         priv->auto_deep_sleep_timeout = 0;
704         del_timer(&priv->auto_deepsleep_timer);
705
706         lbs_deb_leave(LBS_DEB_SDIO);
707         return 0;
708 }
709
710 static int lbs_init_adapter(struct lbs_private *priv)
711 {
712         int ret;
713
714         lbs_deb_enter(LBS_DEB_MAIN);
715
716         memset(priv->current_addr, 0xff, ETH_ALEN);
717
718         priv->connect_status = LBS_DISCONNECTED;
719         priv->channel = DEFAULT_AD_HOC_CHANNEL;
720         priv->mac_control = CMD_ACT_MAC_RX_ON | CMD_ACT_MAC_TX_ON;
721         priv->radio_on = 1;
722         priv->psmode = LBS802_11POWERMODECAM;
723         priv->psstate = PS_STATE_FULL_POWER;
724         priv->is_deep_sleep = 0;
725         priv->is_auto_deep_sleep_enabled = 0;
726         priv->deep_sleep_required = 0;
727         priv->wakeup_dev_required = 0;
728         init_waitqueue_head(&priv->ds_awake_q);
729         init_waitqueue_head(&priv->scan_q);
730         priv->authtype_auto = 1;
731         priv->is_host_sleep_configured = 0;
732         priv->is_host_sleep_activated = 0;
733         init_waitqueue_head(&priv->host_sleep_q);
734         mutex_init(&priv->lock);
735
736         setup_timer(&priv->command_timer, lbs_cmd_timeout_handler,
737                 (unsigned long)priv);
738         setup_timer(&priv->auto_deepsleep_timer, auto_deepsleep_timer_fn,
739                         (unsigned long)priv);
740
741         INIT_LIST_HEAD(&priv->cmdfreeq);
742         INIT_LIST_HEAD(&priv->cmdpendingq);
743
744         spin_lock_init(&priv->driver_lock);
745
746         /* Allocate the command buffers */
747         if (lbs_allocate_cmd_buffer(priv)) {
748                 lbs_pr_err("Out of memory allocating command buffers\n");
749                 ret = -ENOMEM;
750                 goto out;
751         }
752         priv->resp_idx = 0;
753         priv->resp_len[0] = priv->resp_len[1] = 0;
754
755         /* Create the event FIFO */
756         ret = kfifo_alloc(&priv->event_fifo, sizeof(u32) * 16, GFP_KERNEL);
757         if (ret) {
758                 lbs_pr_err("Out of memory allocating event FIFO buffer\n");
759                 goto out;
760         }
761
762 out:
763         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
764
765         return ret;
766 }
767
768 static void lbs_free_adapter(struct lbs_private *priv)
769 {
770         lbs_deb_enter(LBS_DEB_MAIN);
771
772         lbs_free_cmd_buffer(priv);
773         kfifo_free(&priv->event_fifo);
774         del_timer(&priv->command_timer);
775         del_timer(&priv->auto_deepsleep_timer);
776
777         lbs_deb_leave(LBS_DEB_MAIN);
778 }
779
780 static const struct net_device_ops lbs_netdev_ops = {
781         .ndo_open               = lbs_dev_open,
782         .ndo_stop               = lbs_eth_stop,
783         .ndo_start_xmit         = lbs_hard_start_xmit,
784         .ndo_set_mac_address    = lbs_set_mac_address,
785         .ndo_tx_timeout         = lbs_tx_timeout,
786         .ndo_set_multicast_list = lbs_set_multicast_list,
787         .ndo_change_mtu         = eth_change_mtu,
788         .ndo_validate_addr      = eth_validate_addr,
789 };
790
791 /**
792  * @brief This function adds the card. it will probe the
793  * card, allocate the lbs_priv and initialize the device.
794  *
795  *  @param card    A pointer to card
796  *  @return        A pointer to struct lbs_private structure
797  */
798 struct lbs_private *lbs_add_card(void *card, struct device *dmdev)
799 {
800         struct net_device *dev;
801         struct wireless_dev *wdev;
802         struct lbs_private *priv = NULL;
803
804         lbs_deb_enter(LBS_DEB_MAIN);
805
806         /* Allocate an Ethernet device and register it */
807         wdev = lbs_cfg_alloc(dmdev);
808         if (IS_ERR(wdev)) {
809                 lbs_pr_err("cfg80211 init failed\n");
810                 goto done;
811         }
812
813         wdev->iftype = NL80211_IFTYPE_STATION;
814         priv = wdev_priv(wdev);
815         priv->wdev = wdev;
816
817         if (lbs_init_adapter(priv)) {
818                 lbs_pr_err("failed to initialize adapter structure.\n");
819                 goto err_wdev;
820         }
821
822         dev = alloc_netdev(0, "wlan%d", ether_setup);
823         if (!dev) {
824                 dev_err(dmdev, "no memory for network device instance\n");
825                 goto err_adapter;
826         }
827
828         dev->ieee80211_ptr = wdev;
829         dev->ml_priv = priv;
830         SET_NETDEV_DEV(dev, dmdev);
831         wdev->netdev = dev;
832         priv->dev = dev;
833
834         dev->netdev_ops = &lbs_netdev_ops;
835         dev->watchdog_timeo = 5 * HZ;
836         dev->ethtool_ops = &lbs_ethtool_ops;
837         dev->flags |= IFF_BROADCAST | IFF_MULTICAST;
838
839         priv->card = card;
840
841         strcpy(dev->name, "wlan%d");
842
843         lbs_deb_thread("Starting main thread...\n");
844         init_waitqueue_head(&priv->waitq);
845         priv->main_thread = kthread_run(lbs_thread, dev, "lbs_main");
846         if (IS_ERR(priv->main_thread)) {
847                 lbs_deb_thread("Error creating main thread.\n");
848                 goto err_ndev;
849         }
850
851         priv->work_thread = create_singlethread_workqueue("lbs_worker");
852         INIT_WORK(&priv->mcast_work, lbs_set_mcast_worker);
853
854         priv->wol_criteria = EHS_REMOVE_WAKEUP;
855         priv->wol_gpio = 0xff;
856         priv->wol_gap = 20;
857         priv->ehs_remove_supported = true;
858
859         goto done;
860
861  err_ndev:
862         free_netdev(dev);
863
864  err_adapter:
865         lbs_free_adapter(priv);
866
867  err_wdev:
868         lbs_cfg_free(priv);
869
870         priv = NULL;
871
872 done:
873         lbs_deb_leave_args(LBS_DEB_MAIN, "priv %p", priv);
874         return priv;
875 }
876 EXPORT_SYMBOL_GPL(lbs_add_card);
877
878
879 void lbs_remove_card(struct lbs_private *priv)
880 {
881         struct net_device *dev = priv->dev;
882
883         lbs_deb_enter(LBS_DEB_MAIN);
884
885         lbs_remove_mesh(priv);
886         lbs_scan_deinit(priv);
887
888         dev = priv->dev;
889
890         cancel_work_sync(&priv->mcast_work);
891
892         /* worker thread destruction blocks on the in-flight command which
893          * should have been cleared already in lbs_stop_card().
894          */
895         lbs_deb_main("destroying worker thread\n");
896         destroy_workqueue(priv->work_thread);
897         lbs_deb_main("done destroying worker thread\n");
898
899         if (priv->psmode == LBS802_11POWERMODEMAX_PSP) {
900                 priv->psmode = LBS802_11POWERMODECAM;
901                 lbs_set_ps_mode(priv, PS_MODE_ACTION_EXIT_PS, true);
902         }
903
904         if (priv->is_deep_sleep) {
905                 priv->is_deep_sleep = 0;
906                 wake_up_interruptible(&priv->ds_awake_q);
907         }
908
909         priv->is_host_sleep_configured = 0;
910         priv->is_host_sleep_activated = 0;
911         wake_up_interruptible(&priv->host_sleep_q);
912
913         /* Stop the thread servicing the interrupts */
914         priv->surpriseremoved = 1;
915         kthread_stop(priv->main_thread);
916
917         lbs_free_adapter(priv);
918         lbs_cfg_free(priv);
919
920         priv->dev = NULL;
921         free_netdev(dev);
922
923         lbs_deb_leave(LBS_DEB_MAIN);
924 }
925 EXPORT_SYMBOL_GPL(lbs_remove_card);
926
927
928 int lbs_rtap_supported(struct lbs_private *priv)
929 {
930         if (MRVL_FW_MAJOR_REV(priv->fwrelease) == MRVL_FW_V5)
931                 return 1;
932
933         /* newer firmware use a capability mask */
934         return ((MRVL_FW_MAJOR_REV(priv->fwrelease) >= MRVL_FW_V10) &&
935                 (priv->fwcapinfo & MESH_CAPINFO_ENABLE_MASK));
936 }
937
938
939 int lbs_start_card(struct lbs_private *priv)
940 {
941         struct net_device *dev = priv->dev;
942         int ret = -1;
943
944         lbs_deb_enter(LBS_DEB_MAIN);
945
946         /* poke the firmware */
947         ret = lbs_setup_firmware(priv);
948         if (ret)
949                 goto done;
950
951         if (lbs_cfg_register(priv)) {
952                 lbs_pr_err("cannot register device\n");
953                 goto done;
954         }
955
956         lbs_update_channel(priv);
957
958         lbs_init_mesh(priv);
959
960         lbs_debugfs_init_one(priv, dev);
961
962         lbs_pr_info("%s: Marvell WLAN 802.11 adapter\n", dev->name);
963
964         ret = 0;
965
966 done:
967         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
968         return ret;
969 }
970 EXPORT_SYMBOL_GPL(lbs_start_card);
971
972
973 void lbs_stop_card(struct lbs_private *priv)
974 {
975         struct net_device *dev;
976         struct cmd_ctrl_node *cmdnode;
977         unsigned long flags;
978
979         lbs_deb_enter(LBS_DEB_MAIN);
980
981         if (!priv)
982                 goto out;
983         dev = priv->dev;
984
985         netif_stop_queue(dev);
986         netif_carrier_off(dev);
987
988         lbs_debugfs_remove_one(priv);
989         lbs_deinit_mesh(priv);
990
991         /* Delete the timeout of the currently processing command */
992         del_timer_sync(&priv->command_timer);
993         del_timer_sync(&priv->auto_deepsleep_timer);
994
995         /* Flush pending command nodes */
996         spin_lock_irqsave(&priv->driver_lock, flags);
997         lbs_deb_main("clearing pending commands\n");
998         list_for_each_entry(cmdnode, &priv->cmdpendingq, list) {
999                 cmdnode->result = -ENOENT;
1000                 cmdnode->cmdwaitqwoken = 1;
1001                 wake_up_interruptible(&cmdnode->cmdwait_q);
1002         }
1003
1004         /* Flush the command the card is currently processing */
1005         if (priv->cur_cmd) {
1006                 lbs_deb_main("clearing current command\n");
1007                 priv->cur_cmd->result = -ENOENT;
1008                 priv->cur_cmd->cmdwaitqwoken = 1;
1009                 wake_up_interruptible(&priv->cur_cmd->cmdwait_q);
1010         }
1011         lbs_deb_main("done clearing commands\n");
1012         spin_unlock_irqrestore(&priv->driver_lock, flags);
1013
1014         unregister_netdev(dev);
1015
1016 out:
1017         lbs_deb_leave(LBS_DEB_MAIN);
1018 }
1019 EXPORT_SYMBOL_GPL(lbs_stop_card);
1020
1021
1022 void lbs_queue_event(struct lbs_private *priv, u32 event)
1023 {
1024         unsigned long flags;
1025
1026         lbs_deb_enter(LBS_DEB_THREAD);
1027         spin_lock_irqsave(&priv->driver_lock, flags);
1028
1029         if (priv->psstate == PS_STATE_SLEEP)
1030                 priv->psstate = PS_STATE_AWAKE;
1031
1032         kfifo_in(&priv->event_fifo, (unsigned char *) &event, sizeof(u32));
1033
1034         wake_up_interruptible(&priv->waitq);
1035
1036         spin_unlock_irqrestore(&priv->driver_lock, flags);
1037         lbs_deb_leave(LBS_DEB_THREAD);
1038 }
1039 EXPORT_SYMBOL_GPL(lbs_queue_event);
1040
1041 void lbs_notify_command_response(struct lbs_private *priv, u8 resp_idx)
1042 {
1043         lbs_deb_enter(LBS_DEB_THREAD);
1044
1045         if (priv->psstate == PS_STATE_SLEEP)
1046                 priv->psstate = PS_STATE_AWAKE;
1047
1048         /* Swap buffers by flipping the response index */
1049         BUG_ON(resp_idx > 1);
1050         priv->resp_idx = resp_idx;
1051
1052         wake_up_interruptible(&priv->waitq);
1053
1054         lbs_deb_leave(LBS_DEB_THREAD);
1055 }
1056 EXPORT_SYMBOL_GPL(lbs_notify_command_response);
1057
1058 /**
1059  *  @brief Retrieves two-stage firmware
1060  *
1061  *  @param dev          A pointer to device structure
1062  *  @param user_helper  User-defined helper firmware file
1063  *  @param user_mainfw  User-defined main firmware file
1064  *  @param card_model   Bus-specific card model ID used to filter firmware table
1065  *                         elements
1066  *  @param fw_table     Table of firmware file names and device model numbers
1067  *                         terminated by an entry with a NULL helper name
1068  *  @param helper       On success, the helper firmware; caller must free
1069  *  @param mainfw       On success, the main firmware; caller must free
1070  *
1071  *  @return             0 on success, non-zero on failure
1072  */
1073 int lbs_get_firmware(struct device *dev, const char *user_helper,
1074                         const char *user_mainfw, u32 card_model,
1075                         const struct lbs_fw_table *fw_table,
1076                         const struct firmware **helper,
1077                         const struct firmware **mainfw)
1078 {
1079         const struct lbs_fw_table *iter;
1080         int ret;
1081
1082         BUG_ON(helper == NULL);
1083         BUG_ON(mainfw == NULL);
1084
1085         /* Try user-specified firmware first */
1086         if (user_helper) {
1087                 ret = request_firmware(helper, user_helper, dev);
1088                 if (ret) {
1089                         lbs_pr_err("couldn't find helper firmware %s",
1090                                         user_helper);
1091                         goto fail;
1092                 }
1093         }
1094         if (user_mainfw) {
1095                 ret = request_firmware(mainfw, user_mainfw, dev);
1096                 if (ret) {
1097                         lbs_pr_err("couldn't find main firmware %s",
1098                                         user_mainfw);
1099                         goto fail;
1100                 }
1101         }
1102
1103         if (*helper && *mainfw)
1104                 return 0;
1105
1106         /* Otherwise search for firmware to use.  If neither the helper or
1107          * the main firmware were specified by the user, then we need to
1108          * make sure that found helper & main are from the same entry in
1109          * fw_table.
1110          */
1111         iter = fw_table;
1112         while (iter && iter->helper) {
1113                 if (iter->model != card_model)
1114                         goto next;
1115
1116                 if (*helper == NULL) {
1117                         ret = request_firmware(helper, iter->helper, dev);
1118                         if (ret)
1119                                 goto next;
1120
1121                         /* If the device has one-stage firmware (ie cf8305) and
1122                          * we've got it then we don't need to bother with the
1123                          * main firmware.
1124                          */
1125                         if (iter->fwname == NULL)
1126                                 return 0;
1127                 }
1128
1129                 if (*mainfw == NULL) {
1130                         ret = request_firmware(mainfw, iter->fwname, dev);
1131                         if (ret && !user_helper) {
1132                                 /* Clear the helper if it wasn't user-specified
1133                                  * and the main firmware load failed, to ensure
1134                                  * we don't have mismatched firmware pairs.
1135                                  */
1136                                 release_firmware(*helper);
1137                                 *helper = NULL;
1138                         }
1139                 }
1140
1141                 if (*helper && *mainfw)
1142                         return 0;
1143
1144   next:
1145                 iter++;
1146         }
1147
1148   fail:
1149         /* Failed */
1150         if (*helper) {
1151                 release_firmware(*helper);
1152                 *helper = NULL;
1153         }
1154         if (*mainfw) {
1155                 release_firmware(*mainfw);
1156                 *mainfw = NULL;
1157         }
1158
1159         return -ENOENT;
1160 }
1161 EXPORT_SYMBOL_GPL(lbs_get_firmware);
1162
1163 static int __init lbs_init_module(void)
1164 {
1165         lbs_deb_enter(LBS_DEB_MAIN);
1166         memset(&confirm_sleep, 0, sizeof(confirm_sleep));
1167         confirm_sleep.hdr.command = cpu_to_le16(CMD_802_11_PS_MODE);
1168         confirm_sleep.hdr.size = cpu_to_le16(sizeof(confirm_sleep));
1169         confirm_sleep.action = cpu_to_le16(PS_MODE_ACTION_SLEEP_CONFIRMED);
1170         lbs_debugfs_init();
1171         lbs_deb_leave(LBS_DEB_MAIN);
1172         return 0;
1173 }
1174
1175 static void __exit lbs_exit_module(void)
1176 {
1177         lbs_deb_enter(LBS_DEB_MAIN);
1178         lbs_debugfs_remove();
1179         lbs_deb_leave(LBS_DEB_MAIN);
1180 }
1181
1182 module_init(lbs_init_module);
1183 module_exit(lbs_exit_module);
1184
1185 MODULE_DESCRIPTION("Libertas WLAN Driver Library");
1186 MODULE_AUTHOR("Marvell International Ltd.");
1187 MODULE_LICENSE("GPL");