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