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