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                         netdev_info(dev, "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                                 netdev_alert(dev,
 476                                              "ignore PS_SleepConfirm in non-connected state\n");
 477                         }
 478                 }
 479
 480                 /* The PS state is changed during processing of Sleep Request
 481                  * event above
 482                  */
 483                 if ((priv->psstate == PS_STATE_SLEEP) ||
 484                     (priv->psstate == PS_STATE_PRE_SLEEP))
 485                         continue;
 486
 487                 if (priv->is_deep_sleep)
 488                         continue;
 489
 490                 /* Execute the next command */
 491                 if (!priv->dnld_sent && !priv->cur_cmd)
 492                         lbs_execute_next_command(priv);
 493
 494                 spin_lock_irq(&priv->driver_lock);
 495                 if (!priv->dnld_sent && priv->tx_pending_len > 0) {
 496                         int ret = priv->hw_host_to_card(priv, MVMS_DAT,
 497                                                         priv->tx_pending_buf,
 498                                                         priv->tx_pending_len);
 499                         if (ret) {
 500                                 lbs_deb_tx("host_to_card failed %d\n", ret);
 501                                 priv->dnld_sent = DNLD_RES_RECEIVED;
 502                         }
 503                         priv->tx_pending_len = 0;
 504                         if (!priv->currenttxskb) {
 505                                 /* We can wake the queues immediately if we aren't
 506                                    waiting for TX feedback */
 507                                 if (priv->connect_status == LBS_CONNECTED)
 508                                         netif_wake_queue(priv->dev);
 509                                 if (priv->mesh_dev &&
 510                                     lbs_mesh_connected(priv))
 511                                         netif_wake_queue(priv->mesh_dev);
 512                         }
 513                 }
 514                 spin_unlock_irq(&priv->driver_lock);
 515         }
 516
 517         del_timer(&priv->command_timer);
 518         del_timer(&priv->auto_deepsleep_timer);
 519
 520         lbs_deb_leave(LBS_DEB_THREAD);
 521         return 0;
 522 }
 523
 524 /**
 525  * lbs_setup_firmware - gets the HW spec from the firmware and sets
 526  *        some basic parameters
 527  *
 528  *  @priv:      A pointer to &struct lbs_private structure
 529  *  returns:    0 or -1
 530  */
 531 static int lbs_setup_firmware(struct lbs_private *priv)
 532 {
 533         int ret = -1;
 534         s16 curlevel = 0, minlevel = 0, maxlevel = 0;
 535
 536         lbs_deb_enter(LBS_DEB_FW);
 537
 538         /* Read MAC address from firmware */
 539         memset(priv->current_addr, 0xff, ETH_ALEN);
 540         ret = lbs_update_hw_spec(priv);
 541         if (ret)
 542                 goto done;
 543
 544         /* Read power levels if available */
 545         ret = lbs_get_tx_power(priv, &curlevel, &minlevel, &maxlevel);
 546         if (ret == 0) {
 547                 priv->txpower_cur = curlevel;
 548                 priv->txpower_min = minlevel;
 549                 priv->txpower_max = maxlevel;
 550         }
 551
 552         /* Send cmd to FW to enable 11D function */
 553         ret = lbs_set_snmp_mib(priv, SNMP_MIB_OID_11D_ENABLE, 1);
 554
 555         lbs_set_mac_control(priv);
 556 done:
 557         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
 558         return ret;
 559 }
 560
 561 int lbs_suspend(struct lbs_private *priv)
 562 {
 563         int ret;
 564
 565         lbs_deb_enter(LBS_DEB_FW);
 566
 567         if (priv->is_deep_sleep) {
 568                 ret = lbs_set_deep_sleep(priv, 0);
 569                 if (ret) {
 570                         netdev_err(priv->dev,
 571                                    "deep sleep cancellation failed: %d\n", ret);
 572                         return ret;
 573                 }
 574                 priv->deep_sleep_required = 1;
 575         }
 576
 577         ret = lbs_set_host_sleep(priv, 1);
 578
 579         netif_device_detach(priv->dev);
 580         if (priv->mesh_dev)
 581                 netif_device_detach(priv->mesh_dev);
 582
 583         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
 584         return ret;
 585 }
 586 EXPORT_SYMBOL_GPL(lbs_suspend);
 587
 588 int lbs_resume(struct lbs_private *priv)
 589 {
 590         int ret;
 591
 592         lbs_deb_enter(LBS_DEB_FW);
 593
 594         ret = lbs_set_host_sleep(priv, 0);
 595
 596         netif_device_attach(priv->dev);
 597         if (priv->mesh_dev)
 598                 netif_device_attach(priv->mesh_dev);
 599
 600         if (priv->deep_sleep_required) {
 601                 priv->deep_sleep_required = 0;
 602                 ret = lbs_set_deep_sleep(priv, 1);
 603                 if (ret)
 604                         netdev_err(priv->dev,
 605                                    "deep sleep activation failed: %d\n", ret);
 606         }
 607
 608         if (priv->setup_fw_on_resume)
 609                 ret = lbs_setup_firmware(priv);
 610
 611         lbs_deb_leave_args(LBS_DEB_FW, "ret %d", ret);
 612         return ret;
 613 }
 614 EXPORT_SYMBOL_GPL(lbs_resume);
 615
 616 /**
 617  * lbs_cmd_timeout_handler - handles the timeout of command sending.
 618  * It will re-send the same command again.
 619  *
 620  * @data: &struct lbs_private pointer
 621  */
 622 static void lbs_cmd_timeout_handler(unsigned long data)
 623 {
 624         struct lbs_private *priv = (struct lbs_private *)data;
 625         unsigned long flags;
 626
 627         lbs_deb_enter(LBS_DEB_CMD);
 628         spin_lock_irqsave(&priv->driver_lock, flags);
 629
 630         if (!priv->cur_cmd)
 631                 goto out;
 632
 633         netdev_info(priv->dev, "command 0x%04x timed out\n",
 634                     le16_to_cpu(priv->cur_cmd->cmdbuf->command));
 635
 636         priv->cmd_timed_out = 1;
 637         wake_up_interruptible(&priv->waitq);
 638 out:
 639         spin_unlock_irqrestore(&priv->driver_lock, flags);
 640         lbs_deb_leave(LBS_DEB_CMD);
 641 }
 642
 643 /**
 644  * auto_deepsleep_timer_fn - put the device back to deep sleep mode when
 645  * timer expires and no activity (command, event, data etc.) is detected.
 646  * @data:       &struct lbs_private pointer
 647  * returns:     N/A
 648  */
 649 static void auto_deepsleep_timer_fn(unsigned long data)
 650 {
 651         struct lbs_private *priv = (struct lbs_private *)data;
 652
 653         lbs_deb_enter(LBS_DEB_CMD);
 654
 655         if (priv->is_activity_detected) {
 656                 priv->is_activity_detected = 0;
 657         } else {
 658                 if (priv->is_auto_deep_sleep_enabled &&
 659                     (!priv->wakeup_dev_required) &&
 660                     (priv->connect_status != LBS_CONNECTED)) {
 661                         struct cmd_header cmd;
 662
 663                         lbs_deb_main("Entering auto deep sleep mode...\n");
 664                         memset(&cmd, 0, sizeof(cmd));
 665                         cmd.size = cpu_to_le16(sizeof(cmd));
 666                         lbs_cmd_async(priv, CMD_802_11_DEEP_SLEEP, &cmd,
 667                                         sizeof(cmd));
 668                 }
 669         }
 670         mod_timer(&priv->auto_deepsleep_timer , jiffies +
 671                                 (priv->auto_deep_sleep_timeout * HZ)/1000);
 672         lbs_deb_leave(LBS_DEB_CMD);
 673 }
 674
 675 int lbs_enter_auto_deep_sleep(struct lbs_private *priv)
 676 {
 677         lbs_deb_enter(LBS_DEB_SDIO);
 678
 679         priv->is_auto_deep_sleep_enabled = 1;
 680         if (priv->is_deep_sleep)
 681                 priv->wakeup_dev_required = 1;
 682         mod_timer(&priv->auto_deepsleep_timer ,
 683                         jiffies + (priv->auto_deep_sleep_timeout * HZ)/1000);
 684
 685         lbs_deb_leave(LBS_DEB_SDIO);
 686         return 0;
 687 }
 688
 689 int lbs_exit_auto_deep_sleep(struct lbs_private *priv)
 690 {
 691         lbs_deb_enter(LBS_DEB_SDIO);
 692
 693         priv->is_auto_deep_sleep_enabled = 0;
 694         priv->auto_deep_sleep_timeout = 0;
 695         del_timer(&priv->auto_deepsleep_timer);
 696
 697         lbs_deb_leave(LBS_DEB_SDIO);
 698         return 0;
 699 }
 700
 701 static int lbs_init_adapter(struct lbs_private *priv)
 702 {
 703         int ret;
 704
 705         lbs_deb_enter(LBS_DEB_MAIN);
 706
 707         memset(priv->current_addr, 0xff, ETH_ALEN);
 708
 709         priv->connect_status = LBS_DISCONNECTED;
 710         priv->channel = DEFAULT_AD_HOC_CHANNEL;
 711         priv->mac_control = CMD_ACT_MAC_RX_ON | CMD_ACT_MAC_TX_ON;
 712         priv->radio_on = 1;
 713         priv->psmode = LBS802_11POWERMODECAM;
 714         priv->psstate = PS_STATE_FULL_POWER;
 715         priv->is_deep_sleep = 0;
 716         priv->is_auto_deep_sleep_enabled = 0;
 717         priv->deep_sleep_required = 0;
 718         priv->wakeup_dev_required = 0;
 719         init_waitqueue_head(&priv->ds_awake_q);
 720         init_waitqueue_head(&priv->scan_q);
 721         priv->authtype_auto = 1;
 722         priv->is_host_sleep_configured = 0;
 723         priv->is_host_sleep_activated = 0;
 724         init_waitqueue_head(&priv->host_sleep_q);
 725         mutex_init(&priv->lock);
 726
 727         setup_timer(&priv->command_timer, lbs_cmd_timeout_handler,
 728                 (unsigned long)priv);
 729         setup_timer(&priv->auto_deepsleep_timer, auto_deepsleep_timer_fn,
 730                         (unsigned long)priv);
 731
 732         INIT_LIST_HEAD(&priv->cmdfreeq);
 733         INIT_LIST_HEAD(&priv->cmdpendingq);
 734
 735         spin_lock_init(&priv->driver_lock);
 736
 737         /* Allocate the command buffers */
 738         if (lbs_allocate_cmd_buffer(priv)) {
 739                 pr_err("Out of memory allocating command buffers\n");
 740                 ret = -ENOMEM;
 741                 goto out;
 742         }
 743         priv->resp_idx = 0;
 744         priv->resp_len[0] = priv->resp_len[1] = 0;
 745
 746         /* Create the event FIFO */
 747         ret = kfifo_alloc(&priv->event_fifo, sizeof(u32) * 16, GFP_KERNEL);
 748         if (ret) {
 749                 pr_err("Out of memory allocating event FIFO buffer\n");
 750                 goto out;
 751         }
 752
 753 out:
 754         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
 755
 756         return ret;
 757 }
 758
 759 static void lbs_free_adapter(struct lbs_private *priv)
 760 {
 761         lbs_deb_enter(LBS_DEB_MAIN);
 762
 763         lbs_free_cmd_buffer(priv);
 764         kfifo_free(&priv->event_fifo);
 765         del_timer(&priv->command_timer);
 766         del_timer(&priv->auto_deepsleep_timer);
 767
 768         lbs_deb_leave(LBS_DEB_MAIN);
 769 }
 770
 771 static const struct net_device_ops lbs_netdev_ops = {
 772         .ndo_open               = lbs_dev_open,
 773         .ndo_stop               = lbs_eth_stop,
 774         .ndo_start_xmit         = lbs_hard_start_xmit,
 775         .ndo_set_mac_address    = lbs_set_mac_address,
 776         .ndo_set_multicast_list = lbs_set_multicast_list,
 777         .ndo_change_mtu         = eth_change_mtu,
 778         .ndo_validate_addr      = eth_validate_addr,
 779 };
 780
 781 /**
 782  * lbs_add_card - adds the card. It will probe the
 783  * card, allocate the lbs_priv and initialize the device.
 784  *
 785  * @card:       A pointer to card
 786  * @dmdev:      A pointer to &struct device
 787  * returns:     A pointer to &struct lbs_private structure
 788  */
 789 struct lbs_private *lbs_add_card(void *card, struct device *dmdev)
 790 {
 791         struct net_device *dev;
 792         struct wireless_dev *wdev;
 793         struct lbs_private *priv = NULL;
 794
 795         lbs_deb_enter(LBS_DEB_MAIN);
 796
 797         /* Allocate an Ethernet device and register it */
 798         wdev = lbs_cfg_alloc(dmdev);
 799         if (IS_ERR(wdev)) {
 800                 pr_err("cfg80211 init failed\n");
 801                 goto done;
 802         }
 803
 804         wdev->iftype = NL80211_IFTYPE_STATION;
 805         priv = wdev_priv(wdev);
 806         priv->wdev = wdev;
 807
 808         if (lbs_init_adapter(priv)) {
 809                 pr_err("failed to initialize adapter structure\n");
 810                 goto err_wdev;
 811         }
 812
 813         dev = alloc_netdev(0, "wlan%d", ether_setup);
 814         if (!dev) {
 815                 dev_err(dmdev, "no memory for network device instance\n");
 816                 goto err_adapter;
 817         }
 818
 819         dev->ieee80211_ptr = wdev;
 820         dev->ml_priv = priv;
 821         SET_NETDEV_DEV(dev, dmdev);
 822         wdev->netdev = dev;
 823         priv->dev = dev;
 824
 825         dev->netdev_ops = &lbs_netdev_ops;
 826         dev->watchdog_timeo = 5 * HZ;
 827         dev->ethtool_ops = &lbs_ethtool_ops;
 828         dev->flags |= IFF_BROADCAST | IFF_MULTICAST;
 829
 830         priv->card = card;
 831
 832         strcpy(dev->name, "wlan%d");
 833
 834         lbs_deb_thread("Starting main thread...\n");
 835         init_waitqueue_head(&priv->waitq);
 836         priv->main_thread = kthread_run(lbs_thread, dev, "lbs_main");
 837         if (IS_ERR(priv->main_thread)) {
 838                 lbs_deb_thread("Error creating main thread.\n");
 839                 goto err_ndev;
 840         }
 841
 842         priv->work_thread = create_singlethread_workqueue("lbs_worker");
 843         INIT_WORK(&priv->mcast_work, lbs_set_mcast_worker);
 844
 845         priv->wol_criteria = EHS_REMOVE_WAKEUP;
 846         priv->wol_gpio = 0xff;
 847         priv->wol_gap = 20;
 848         priv->ehs_remove_supported = true;
 849
 850         goto done;
 851
 852  err_ndev:
 853         free_netdev(dev);
 854
 855  err_adapter:
 856         lbs_free_adapter(priv);
 857
 858  err_wdev:
 859         lbs_cfg_free(priv);
 860
 861         priv = NULL;
 862
 863 done:
 864         lbs_deb_leave_args(LBS_DEB_MAIN, "priv %p", priv);
 865         return priv;
 866 }
 867 EXPORT_SYMBOL_GPL(lbs_add_card);
 868
 869
 870 void lbs_remove_card(struct lbs_private *priv)
 871 {
 872         struct net_device *dev = priv->dev;
 873
 874         lbs_deb_enter(LBS_DEB_MAIN);
 875
 876         lbs_remove_mesh(priv);
 877         lbs_scan_deinit(priv);
 878
 879         dev = priv->dev;
 880
 881         cancel_work_sync(&priv->mcast_work);
 882
 883         /* worker thread destruction blocks on the in-flight command which
 884          * should have been cleared already in lbs_stop_card().
 885          */
 886         lbs_deb_main("destroying worker thread\n");
 887         destroy_workqueue(priv->work_thread);
 888         lbs_deb_main("done destroying worker thread\n");
 889
 890         if (priv->psmode == LBS802_11POWERMODEMAX_PSP) {
 891                 priv->psmode = LBS802_11POWERMODECAM;
 892                 lbs_set_ps_mode(priv, PS_MODE_ACTION_EXIT_PS, true);
 893         }
 894
 895         if (priv->is_deep_sleep) {
 896                 priv->is_deep_sleep = 0;
 897                 wake_up_interruptible(&priv->ds_awake_q);
 898         }
 899
 900         priv->is_host_sleep_configured = 0;
 901         priv->is_host_sleep_activated = 0;
 902         wake_up_interruptible(&priv->host_sleep_q);
 903
 904         /* Stop the thread servicing the interrupts */
 905         priv->surpriseremoved = 1;
 906         kthread_stop(priv->main_thread);
 907
 908         lbs_free_adapter(priv);
 909         lbs_cfg_free(priv);
 910         free_netdev(dev);
 911
 912         lbs_deb_leave(LBS_DEB_MAIN);
 913 }
 914 EXPORT_SYMBOL_GPL(lbs_remove_card);
 915
 916
 917 int lbs_rtap_supported(struct lbs_private *priv)
 918 {
 919         if (MRVL_FW_MAJOR_REV(priv->fwrelease) == MRVL_FW_V5)
 920                 return 1;
 921
 922         /* newer firmware use a capability mask */
 923         return ((MRVL_FW_MAJOR_REV(priv->fwrelease) >= MRVL_FW_V10) &&
 924                 (priv->fwcapinfo & MESH_CAPINFO_ENABLE_MASK));
 925 }
 926
 927
 928 int lbs_start_card(struct lbs_private *priv)
 929 {
 930         struct net_device *dev = priv->dev;
 931         int ret = -1;
 932
 933         lbs_deb_enter(LBS_DEB_MAIN);
 934
 935         /* poke the firmware */
 936         ret = lbs_setup_firmware(priv);
 937         if (ret)
 938                 goto done;
 939
 940         if (lbs_cfg_register(priv)) {
 941                 pr_err("cannot register device\n");
 942                 goto done;
 943         }
 944
 945         lbs_update_channel(priv);
 946
 947         lbs_init_mesh(priv);
 948
 949         lbs_debugfs_init_one(priv, dev);
 950
 951         netdev_info(dev, "Marvell WLAN 802.11 adapter\n");
 952
 953         ret = 0;
 954
 955 done:
 956         lbs_deb_leave_args(LBS_DEB_MAIN, "ret %d", ret);
 957         return ret;
 958 }
 959 EXPORT_SYMBOL_GPL(lbs_start_card);
 960
 961
 962 void lbs_stop_card(struct lbs_private *priv)
 963 {
 964         struct net_device *dev;
 965         struct cmd_ctrl_node *cmdnode;
 966         unsigned long flags;
 967
 968         lbs_deb_enter(LBS_DEB_MAIN);
 969
 970         if (!priv)
 971                 goto out;
 972         dev = priv->dev;
 973
 974         netif_stop_queue(dev);
 975         netif_carrier_off(dev);
 976
 977         lbs_debugfs_remove_one(priv);
 978         lbs_deinit_mesh(priv);
 979
 980         /* Delete the timeout of the currently processing command */
 981         del_timer_sync(&priv->command_timer);
 982         del_timer_sync(&priv->auto_deepsleep_timer);
 983
 984         /* Flush pending command nodes */
 985         spin_lock_irqsave(&priv->driver_lock, flags);
 986         lbs_deb_main("clearing pending commands\n");
 987         list_for_each_entry(cmdnode, &priv->cmdpendingq, list) {
 988                 cmdnode->result = -ENOENT;
 989                 cmdnode->cmdwaitqwoken = 1;
 990                 wake_up_interruptible(&cmdnode->cmdwait_q);
 991         }
 992
 993         /* Flush the command the card is currently processing */
 994         if (priv->cur_cmd) {
 995                 lbs_deb_main("clearing current command\n");
 996                 priv->cur_cmd->result = -ENOENT;
 997                 priv->cur_cmd->cmdwaitqwoken = 1;
 998                 wake_up_interruptible(&priv->cur_cmd->cmdwait_q);
 999         }
1000         lbs_deb_main("done clearing commands\n");
1001         spin_unlock_irqrestore(&priv->driver_lock, flags);
1002
1003         unregister_netdev(dev);
1004
1005 out:
1006         lbs_deb_leave(LBS_DEB_MAIN);
1007 }
1008 EXPORT_SYMBOL_GPL(lbs_stop_card);
1009
1010
1011 void lbs_queue_event(struct lbs_private *priv, u32 event)
1012 {
1013         unsigned long flags;
1014
1015         lbs_deb_enter(LBS_DEB_THREAD);
1016         spin_lock_irqsave(&priv->driver_lock, flags);
1017
1018         if (priv->psstate == PS_STATE_SLEEP)
1019                 priv->psstate = PS_STATE_AWAKE;
1020
1021         kfifo_in(&priv->event_fifo, (unsigned char *) &event, sizeof(u32));
1022
1023         wake_up_interruptible(&priv->waitq);
1024
1025         spin_unlock_irqrestore(&priv->driver_lock, flags);
1026         lbs_deb_leave(LBS_DEB_THREAD);
1027 }
1028 EXPORT_SYMBOL_GPL(lbs_queue_event);
1029
1030 void lbs_notify_command_response(struct lbs_private *priv, u8 resp_idx)
1031 {
1032         lbs_deb_enter(LBS_DEB_THREAD);
1033
1034         if (priv->psstate == PS_STATE_SLEEP)
1035                 priv->psstate = PS_STATE_AWAKE;
1036
1037         /* Swap buffers by flipping the response index */
1038         BUG_ON(resp_idx > 1);
1039         priv->resp_idx = resp_idx;
1040
1041         wake_up_interruptible(&priv->waitq);
1042
1043         lbs_deb_leave(LBS_DEB_THREAD);
1044 }
1045 EXPORT_SYMBOL_GPL(lbs_notify_command_response);
1046
1047 /**
1048  *  lbs_get_firmware - Retrieves two-stage firmware
1049  *
1050  *  @dev:       A pointer to &device structure
1051  *  @user_helper: User-defined helper firmware file
1052  *  @user_mainfw: User-defined main firmware file
1053  *  @card_model: Bus-specific card model ID used to filter firmware table
1054  *              elements
1055  *  @fw_table:  Table of firmware file names and device model numbers
1056  *              terminated by an entry with a NULL helper name
1057  *  @helper:    On success, the helper firmware; caller must free
1058  *  @mainfw:    On success, the main firmware; caller must free
1059  *
1060  *  returns:            0 on success, non-zero on failure
1061  */
1062 int lbs_get_firmware(struct device *dev, const char *user_helper,
1063                         const char *user_mainfw, u32 card_model,
1064                         const struct lbs_fw_table *fw_table,
1065                         const struct firmware **helper,
1066                         const struct firmware **mainfw)
1067 {
1068         const struct lbs_fw_table *iter;
1069         int ret;
1070
1071         BUG_ON(helper == NULL);
1072         BUG_ON(mainfw == NULL);
1073
1074         /* Try user-specified firmware first */
1075         if (user_helper) {
1076                 ret = request_firmware(helper, user_helper, dev);
1077                 if (ret) {
1078                         dev_err(dev, "couldn't find helper firmware %s\n",
1079                                 user_helper);
1080                         goto fail;
1081                 }
1082         }
1083         if (user_mainfw) {
1084                 ret = request_firmware(mainfw, user_mainfw, dev);
1085                 if (ret) {
1086                         dev_err(dev, "couldn't find main firmware %s\n",
1087                                 user_mainfw);
1088                         goto fail;
1089                 }
1090         }
1091
1092         if (*helper && *mainfw)
1093                 return 0;
1094
1095         /* Otherwise search for firmware to use.  If neither the helper or
1096          * the main firmware were specified by the user, then we need to
1097          * make sure that found helper & main are from the same entry in
1098          * fw_table.
1099          */
1100         iter = fw_table;
1101         while (iter && iter->helper) {
1102                 if (iter->model != card_model)
1103                         goto next;
1104
1105                 if (*helper == NULL) {
1106                         ret = request_firmware(helper, iter->helper, dev);
1107                         if (ret)
1108                                 goto next;
1109
1110                         /* If the device has one-stage firmware (ie cf8305) and
1111                          * we've got it then we don't need to bother with the
1112                          * main firmware.
1113                          */
1114                         if (iter->fwname == NULL)
1115                                 return 0;
1116                 }
1117
1118                 if (*mainfw == NULL) {
1119                         ret = request_firmware(mainfw, iter->fwname, dev);
1120                         if (ret && !user_helper) {
1121                                 /* Clear the helper if it wasn't user-specified
1122                                  * and the main firmware load failed, to ensure
1123                                  * we don't have mismatched firmware pairs.
1124                                  */
1125                                 release_firmware(*helper);
1126                                 *helper = NULL;
1127                         }
1128                 }
1129
1130                 if (*helper && *mainfw)
1131                         return 0;
1132
1133   next:
1134                 iter++;
1135         }
1136
1137   fail:
1138         /* Failed */
1139         if (*helper) {
1140                 release_firmware(*helper);
1141                 *helper = NULL;
1142         }
1143         if (*mainfw) {
1144                 release_firmware(*mainfw);
1145                 *mainfw = NULL;
1146         }
1147
1148         return -ENOENT;
1149 }
1150 EXPORT_SYMBOL_GPL(lbs_get_firmware);
1151
1152 static int __init lbs_init_module(void)
1153 {
1154         lbs_deb_enter(LBS_DEB_MAIN);
1155         memset(&confirm_sleep, 0, sizeof(confirm_sleep));
1156         confirm_sleep.hdr.command = cpu_to_le16(CMD_802_11_PS_MODE);
1157         confirm_sleep.hdr.size = cpu_to_le16(sizeof(confirm_sleep));
1158         confirm_sleep.action = cpu_to_le16(PS_MODE_ACTION_SLEEP_CONFIRMED);
1159         lbs_debugfs_init();
1160         lbs_deb_leave(LBS_DEB_MAIN);
1161         return 0;
1162 }
1163
1164 static void __exit lbs_exit_module(void)
1165 {
1166         lbs_deb_enter(LBS_DEB_MAIN);
1167         lbs_debugfs_remove();
1168         lbs_deb_leave(LBS_DEB_MAIN);
1169 }
1170
1171 module_init(lbs_init_module);
1172 module_exit(lbs_exit_module);
1173
1174 MODULE_DESCRIPTION("Libertas WLAN Driver Library");
1175 MODULE_AUTHOR("Marvell International Ltd.");
1176 MODULE_LICENSE("GPL");