drivers/net/wireless/libertas/main.c

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