drivers/net/wireless/libertas/main.c

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