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