iwlwifi: Add led support

This patch add LEDS support to 3965 and 4965 drivers. It is based on
led trigger and class. For our drivers we needed to avoid two things.
1- We receive led trigger on/off on each Rx\Tx frame. In our driver
    we can not call led command like that. In this driver once driver
    receive a start of traffic it call the led command to start blinking
    then we count all bytes of Tx and Rx frame, after two second we count the
    blink rate of last two second then id blink rate changed we call the led
     commands
2- Since we can call led command very often, we make sure we call the
    led command after we receive the statistics notification so
    we don't need to wake up the ucode id it is in sleep state.
    This patch was tested with 4965 and 3945.

Signed-off-by: Mohamed Abbas <mabbas@linux.intel.com>
Signed-off-by: Ian Schram<ischram@telenet.be>
Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
Signed-off-by: John W. Linville <linville@tuxdriver.com>

1 files changed, 446 insertions, 0 deletions

diff --git a/drivers/net/wireless/iwlwifi/iwl-led.c b/drivers/net/wireless/iwlwifi/iwl-led.c
new file mode 100644
index 000000000000..6f5424bd365b
--- /dev/null
+++ b/drivers/net/wireless/iwlwifi/iwl-led.c
@@ -0,0 +1,446 @@
+/******************************************************************************
+ *
+ * Copyright(c) 2003 - 2008 Intel Corporation. All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of version 2 of the GNU General Public License as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
+ *
+ * The full GNU General Public License is included in this distribution in the
+ * file called LICENSE.
+ *
+ * Contact Information:
+ * James P. Ketrenos <ipw2100-admin@linux.intel.com>
+ * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
+ *
+ *****************************************************************************/
+
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/version.h>
+#include <linux/init.h>
+#include <linux/pci.h>
+#include <linux/dma-mapping.h>
+#include <linux/delay.h>
+#include <linux/skbuff.h>
+#include <linux/netdevice.h>
+#include <linux/wireless.h>
+#include <net/mac80211.h>
+#include <linux/etherdevice.h>
+#include <asm/unaligned.h>
+
+#include "iwl-4965.h"
+#include "iwl-core.h"
+#include "iwl-helpers.h"
+
+#define IWL_1MB_RATE (128 * 1024)
+#define IWL_LED_THRESHOLD (16)
+#define IWL_MAX_BLINK_TBL (10)
+
+static const struct {
+        u16 tpt;
+        u8 on_time;
+        u8 of_time;
+} blink_tbl[] =
+{
+        {300, 25, 25},
+        {200, 40, 40},
+        {100, 55, 55},
+        {70, 65, 65},
+        {50, 75, 75},
+        {20, 85, 85},
+        {15, 95, 95 },
+        {10, 110, 110},
+        {5, 130, 130},
+        {0, 167, 167}
+};
+
+static int iwl_led_cmd_callback(struct iwl_priv *priv,
+                                struct iwl_cmd *cmd, struct sk_buff *skb)
+{
+        return 1;
+}
+
+
+/* Send led command */
+static int iwl_send_led_cmd(struct iwl_priv *priv,
+                            struct iwl4965_led_cmd *led_cmd)
+{
+        struct iwl_host_cmd cmd = {
+                .id = REPLY_LEDS_CMD,
+                .len = sizeof(struct iwl4965_led_cmd),
+                .data = led_cmd,
+                .meta.flags = CMD_ASYNC,
+                .meta.u.callback = iwl_led_cmd_callback
+        };
+        u32 reg;
+
+        reg = iwl4965_read32(priv, CSR_LED_REG);
+        if (reg != (reg & CSR_LED_BSM_CTRL_MSK))
+                iwl4965_write32(priv, CSR_LED_REG, reg & CSR_LED_BSM_CTRL_MSK);
+
+        return iwl_send_cmd(priv, &cmd);
+}
+
+
+/* Set led on command */
+static int iwl4965_led_on(struct iwl_priv *priv, int led_id)
+{
+        struct iwl4965_led_cmd led_cmd = {
+                .id = led_id,
+                .on = IWL_LED_SOLID,
+                .off = 0,
+                .interval = IWL_DEF_LED_INTRVL
+        };
+        return iwl_send_led_cmd(priv, &led_cmd);
+}
+
+/* Set led on command */
+static int iwl4965_led_pattern(struct iwl_priv *priv, int led_id,
+                               enum led_brightness brightness)
+{
+        struct iwl4965_led_cmd led_cmd = {
+                .id = led_id,
+                .on = brightness,
+                .off = brightness,
+                .interval = IWL_DEF_LED_INTRVL
+        };
+        if (brightness == LED_FULL) {
+                led_cmd.on = IWL_LED_SOLID;
+                led_cmd.off = 0;
+        }
+        return iwl_send_led_cmd(priv, &led_cmd);
+}
+
+/* Set led register off */
+static int iwl4965_led_on_reg(struct iwl_priv *priv, int led_id)
+{
+        IWL_DEBUG_LED("led on %d\n", led_id);
+        iwl4965_write32(priv, CSR_LED_REG, CSR_LED_REG_TRUN_ON);
+        return 0;
+}
+
+#if 0
+/* Set led off command */
+int iwl4965_led_off(struct iwl_priv *priv, int led_id)
+{
+        struct iwl4965_led_cmd led_cmd = {
+                .id = led_id,
+                .on = 0,
+                .off = 0,
+                .interval = IWL_DEF_LED_INTRVL
+        };
+        IWL_DEBUG_LED("led off %d\n", led_id);
+        return iwl_send_led_cmd(priv, &led_cmd);
+}
+#endif
+
+
+/* Set led register off */
+static int iwl4965_led_off_reg(struct iwl_priv *priv, int led_id)
+{
+        IWL_DEBUG_LED("radio off\n");
+        iwl4965_write32(priv, CSR_LED_REG, CSR_LED_REG_TRUN_OFF);
+        return 0;
+}
+
+/* Set led blink command */
+static int iwl4965_led_not_solid(struct iwl_priv *priv, int led_id,
+                               u8 brightness)
+{
+        struct iwl4965_led_cmd led_cmd = {
+                .id = led_id,
+                .on = brightness,
+                .off = brightness,
+                .interval = IWL_DEF_LED_INTRVL
+        };
+
+        return iwl_send_led_cmd(priv, &led_cmd);
+}
+
+
+/*
+ * brightness call back function for Tx/Rx LED
+ */
+static int iwl4965_led_associated(struct iwl_priv *priv, int led_id)
+{
+        if (test_bit(STATUS_EXIT_PENDING, &priv->status) ||
+            !test_bit(STATUS_READY, &priv->status))
+                return 0;
+
+
+        /* start counting Tx/Rx bytes */
+        if (!priv->last_blink_time && priv->allow_blinking)
+                priv->last_blink_time = jiffies;
+        return 0;
+}
+
+/*
+ * brightness call back for association and radio
+ */
+static void iwl4965_led_brightness_set(struct led_classdev *led_cdev,
+                                       enum led_brightness brightness)
+{
+        struct iwl4965_led *led = container_of(led_cdev,
+                                               struct iwl4965_led, led_dev);
+        struct iwl_priv *priv = led->priv;
+
+        if (test_bit(STATUS_EXIT_PENDING, &priv->status))
+                return;
+
+        switch (brightness) {
+        case LED_FULL:
+                if (led->type == IWL_LED_TRG_ASSOC)
+                        priv->allow_blinking = 1;
+
+                if (led->led_on)
+                        led->led_on(priv, IWL_LED_LINK);
+                break;
+        case LED_OFF:
+                if (led->type == IWL_LED_TRG_ASSOC)
+                        priv->allow_blinking = 0;
+
+                if (led->led_off)
+                        led->led_off(priv, IWL_LED_LINK);
+                break;
+        default:
+                if (led->led_pattern)
+                        led->led_pattern(priv, IWL_LED_LINK, brightness);
+                break;
+        }
+}
+
+
+
+/*
+ * Register led class with the system
+ */
+static int iwl_leds_register_led(struct iwl_priv *priv,
+                                   struct iwl4965_led *led,
+                                   enum led_type type, u8 set_led,
+                                   const char *name, char *trigger)
+{
+        struct device *device = wiphy_dev(priv->hw->wiphy);
+        int ret;
+
+        led->led_dev.name = name;
+        led->led_dev.brightness_set = iwl4965_led_brightness_set;
+        led->led_dev.default_trigger = trigger;
+
+        ret = led_classdev_register(device, &led->led_dev);
+        if (ret) {
+                IWL_ERROR("Error: failed to register led handler.\n");
+                return ret;
+        }
+
+        led->priv = priv;
+        led->type = type;
+        led->registered = 1;
+
+        if (set_led && led->led_on)
+                led->led_on(priv, IWL_LED_LINK);
+        return 0;
+}
+
+
+/*
+ * calculate blink rate according to last 2 sec Tx/Rx activities
+ */
+static inline u8 get_blink_rate(struct iwl_priv *priv)
+{
+        int i;
+        u8 blink_rate;
+        u64 current_tpt = priv->tx_stats[2].bytes + priv->rx_stats[2].bytes;
+        s64 tpt = current_tpt - priv->led_tpt;
+
+        if (tpt < 0) /* wrapparound */
+                tpt = -tpt;
+
+        priv->led_tpt = current_tpt;
+
+        if (tpt < IWL_LED_THRESHOLD) {
+                i = IWL_MAX_BLINK_TBL;
+        } else {
+                for (i = 0; i < IWL_MAX_BLINK_TBL; i++)
+                        if (tpt  > (blink_tbl[i].tpt * IWL_1MB_RATE))
+                                break;
+        }
+        /* if 0 frame is transfered */
+        if ((i == IWL_MAX_BLINK_TBL) || !priv->allow_blinking)
+                blink_rate = IWL_LED_SOLID;
+        else
+                blink_rate = blink_tbl[i].on_time;
+
+        return blink_rate;
+}
+
+static inline int is_rf_kill(struct iwl_priv *priv)
+{
+        return test_bit(STATUS_RF_KILL_HW, &priv->status) ||
+                test_bit(STATUS_RF_KILL_SW, &priv->status);
+}
+
+/*
+ * this function called from handler. Since setting Led command can
+ * happen very frequent we postpone led command to be called from
+ * REPLY handler so we know ucode is up
+ */
+void iwl_leds_background(struct iwl_priv *priv)
+{
+        u8 blink_rate;
+
+        if (test_bit(STATUS_EXIT_PENDING, &priv->status)) {
+                priv->last_blink_time = 0;
+                return;
+        }
+        if (is_rf_kill(priv)) {
+                priv->last_blink_time = 0;
+                return;
+        }
+
+        if (!priv->allow_blinking) {
+                priv->last_blink_time = 0;
+                if (priv->last_blink_rate != IWL_LED_SOLID) {
+                        priv->last_blink_rate = IWL_LED_SOLID;
+                        iwl4965_led_on(priv, IWL_LED_LINK);
+                }
+                return;
+        }
+        if (!priv->last_blink_time ||
+            !time_after(jiffies, priv->last_blink_time +
+                        msecs_to_jiffies(1000)))
+                return;
+
+        blink_rate = get_blink_rate(priv);
+
+        /* call only if blink rate change */
+        if (blink_rate != priv->last_blink_rate) {
+                if (blink_rate != IWL_LED_SOLID) {
+                        priv->last_blink_time = jiffies +
+                                                msecs_to_jiffies(1000);
+                        iwl4965_led_not_solid(priv, IWL_LED_LINK, blink_rate);
+                } else {
+                        priv->last_blink_time = 0;
+                        iwl4965_led_on(priv, IWL_LED_LINK);
+                }
+        }
+
+        priv->last_blink_rate = blink_rate;
+}
+EXPORT_SYMBOL(iwl_leds_background);
+
+/* Register all led handler */
+int iwl_leds_register(struct iwl_priv *priv)
+{
+        char *trigger;
+        char name[32];
+        int ret;
+
+        priv->last_blink_rate = 0;
+        priv->led_tpt = 0;
+        priv->last_blink_time = 0;
+        priv->allow_blinking = 0;
+
+        trigger = ieee80211_get_radio_led_name(priv->hw);
+        snprintf(name, sizeof(name), "iwl-%s:radio",
+                 wiphy_name(priv->hw->wiphy));
+
+        priv->led[IWL_LED_TRG_RADIO].led_on = iwl4965_led_on_reg;
+        priv->led[IWL_LED_TRG_RADIO].led_off = iwl4965_led_off_reg;
+        priv->led[IWL_LED_TRG_RADIO].led_pattern = NULL;
+
+        ret = iwl_leds_register_led(priv,
+                                   &priv->led[IWL_LED_TRG_RADIO],
+                                   IWL_LED_TRG_RADIO, 1,
+                                   name, trigger);
+        if (ret)
+                goto exit_fail;
+
+        trigger = ieee80211_get_assoc_led_name(priv->hw);
+        snprintf(name, sizeof(name), "iwl-%s:assoc",
+                 wiphy_name(priv->hw->wiphy));
+
+        ret = iwl_leds_register_led(priv,
+                                   &priv->led[IWL_LED_TRG_ASSOC],
+                                   IWL_LED_TRG_ASSOC, 0,
+                                   name, trigger);
+        /* for assoc always turn led on */
+        priv->led[IWL_LED_TRG_ASSOC].led_on = iwl4965_led_on_reg;
+        priv->led[IWL_LED_TRG_ASSOC].led_off = iwl4965_led_on_reg;
+        priv->led[IWL_LED_TRG_ASSOC].led_pattern = NULL;
+
+        if (ret)
+                goto exit_fail;
+
+        trigger = ieee80211_get_rx_led_name(priv->hw);
+        snprintf(name, sizeof(name), "iwl-%s:RX",
+                 wiphy_name(priv->hw->wiphy));
+
+
+        ret = iwl_leds_register_led(priv,
+                                   &priv->led[IWL_LED_TRG_RX],
+                                   IWL_LED_TRG_RX, 0,
+                                   name, trigger);
+
+        priv->led[IWL_LED_TRG_RX].led_on = iwl4965_led_associated;
+        priv->led[IWL_LED_TRG_RX].led_off = iwl4965_led_associated;
+        priv->led[IWL_LED_TRG_RX].led_pattern = iwl4965_led_pattern;
+
+        if (ret)
+                goto exit_fail;
+
+        trigger = ieee80211_get_tx_led_name(priv->hw);
+        snprintf(name, sizeof(name), "iwl-%s:TX",
+                 wiphy_name(priv->hw->wiphy));
+        ret = iwl_leds_register_led(priv,
+                                   &priv->led[IWL_LED_TRG_TX],
+                                   IWL_LED_TRG_TX, 0,
+                                   name, trigger);
+        priv->led[IWL_LED_TRG_TX].led_on = iwl4965_led_associated;
+        priv->led[IWL_LED_TRG_TX].led_off = iwl4965_led_associated;
+        priv->led[IWL_LED_TRG_TX].led_pattern = iwl4965_led_pattern;
+
+        if (ret)
+                goto exit_fail;
+
+        return 0;
+
+exit_fail:
+        iwl_leds_unregister(priv);
+        return ret;
+}
+EXPORT_SYMBOL(iwl_leds_register);
+
+/* unregister led class */
+static void iwl_leds_unregister_led(struct iwl4965_led *led, u8 set_led)
+{
+        if (!led->registered)
+                return;
+
+        led_classdev_unregister(&led->led_dev);
+
+        if (set_led)
+                led->led_dev.brightness_set(&led->led_dev, LED_OFF);
+        led->registered = 0;
+}
+
+/* Unregister all led handlers */
+void iwl_leds_unregister(struct iwl_priv *priv)
+{
+        iwl_leds_unregister_led(&priv->led[IWL_LED_TRG_ASSOC], 0);
+        iwl_leds_unregister_led(&priv->led[IWL_LED_TRG_RX], 0);
+        iwl_leds_unregister_led(&priv->led[IWL_LED_TRG_TX], 0);
+        iwl_leds_unregister_led(&priv->led[IWL_LED_TRG_RADIO], 1);
+}
+EXPORT_SYMBOL(iwl_leds_unregister);
+