drivers/net/wireless/libertas/main.c

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