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