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