carl9170 firmware: merge CARL9170FW_PSM with the standard RF code
[carl9170fw.git] / carlfw / src / wlan.c
index 776b908171ac710f1a1867cf4b3ad7f0858d77ee..08836db4d9781afa7d9f192aa5c6a528c343b0ce 100644 (file)
@@ -6,7 +6,7 @@
  * Copyright (c) 2000-2005 ZyDAS Technology Corporation
  * Copyright (c) 2007-2009 Atheros Communications, Inc.
  * Copyright   2009    Johannes Berg <johannes@sipsolutions.net>
- * Copyright 2009, 2010 Christian Lamparter <chunkeey@googlemail.com>
+ * Copyright 2009-2011 Christian Lamparter <chunkeey@googlemail.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -31,6 +31,7 @@
 #include "printf.h"
 #include "rf.h"
 #include "linux/ieee80211.h"
+#include "rom.h"
 
 static void wlan_txunstuck(unsigned int queue)
 {
@@ -225,28 +226,50 @@ static inline bool compare_ether_address(const void *_d0, const void *_d1)
        return !((d0[0] ^ d1[0]) | (unsigned short)(d0[1] ^ d1[1]));
 }
 
-#ifdef CONFIG_CARL9170FW_TX_AMPDU
+/* This function will only work on uint32_t-aligned pointers! */
+static bool same_hdr(const void *_d0, const void *_d1)
+{
+       const uint32_t *d0 = _d0;
+       const uint32_t *d1 = _d1;
+
+       /* BUG_ON((unsigned long)d0 & 3 || (unsigned long)d1 & 3)) */
+       return !((d0[0] ^ d1[0]) |                      /* FC + DU */
+                (d0[1] ^ d1[1]) |                      /* addr1 */
+                (d0[2] ^ d1[2]) | (d0[3] ^ d1[3]) |    /* addr2 + addr3 */
+                (d0[4] ^ d1[4]));                      /* addr3 */
+}
+
+static inline bool same_aggr(struct ieee80211_hdr *a, struct ieee80211_hdr *b)
+{
+       return (get_tid(a) == get_tid(b)) || same_hdr(a, b);
+}
+
+static void wlan_tx_ampdu_end(unsigned int qidx)
+{
+       struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
+
+       fw.wlan.ampdu_prev[qidx] = NULL;
+       if (ht_prev)
+               ht_prev->f.hdr.mac.ba_end = 1;
+}
+
 static void wlan_tx_ampdu(struct carl9170_tx_superframe *super)
 {
        unsigned int qidx = super->s.queue;
        struct carl9170_tx_superframe *ht_prev = fw.wlan.ampdu_prev[qidx];
 
        if (!super->f.hdr.mac.ampdu) {
-               fw.wlan.ampdu_prev[qidx] = NULL;
-
-               if (ht_prev)
-                       ht_prev->f.hdr.mac.ba_end = 1;
+               wlan_tx_ampdu_end(qidx);
        } else {
                fw.wlan.ampdu_prev[qidx] = super;
 
-               if (ht_prev && (get_tid(&super->f.data.i3e) != get_tid(&ht_prev->f.data.i3e) ||
-                   !compare_ether_address(super->f.data.i3e.addr1, ht_prev->f.data.i3e.addr1)))
+               if (ht_prev &&
+                   !same_aggr(&super->f.data.i3e, &ht_prev->f.data.i3e))
                        ht_prev->f.hdr.mac.ba_end = 1;
                else
                        super->f.hdr.mac.ba_end = 0;
        }
 }
-#endif /* CONFIG_CARL9170FW_TX_AMPDU */
 
 /* for all tries */
 static void __wlan_tx(struct dma_desc *desc)
@@ -270,9 +293,7 @@ static void __wlan_tx(struct dma_desc *desc)
                read_tsf(tsf);
        }
 
-#ifdef CONFIG_CARL9170FW_TX_AMPDU
        wlan_tx_ampdu(super);
-#endif /* CONFIG_CARL9170FW_TX_AMPDU */
 
 #if (defined CONFIG_CARL9170FW_LOOPBACK) || (defined CONFIG_CARL9170FW_DISCARD)
        wlan_tx_complete(super, true);
@@ -286,20 +307,33 @@ static void __wlan_tx(struct dma_desc *desc)
 # endif
 #else /* CONFIG_CARL9170FW_LOOPBACK */
 
-# if ((defined CONFIG_CARL9170FW_DEBUG) && (defined CONFIG_CARL9170FW_PSM))
+# ifdef CONFIG_CARL9170FW_DEBUG
        BUG_ON(fw.phy.psm.state != CARL9170_PSM_WAKE);
-# endif /* CONFIG_CARL9170FW_DEBUG && CONFIG_CARL9170FW_PSM */
+# endif /* CONFIG_CARL9170FW_DEBUG */
 
        /* insert desc into the right queue */
        dma_put(&fw.wlan.tx_queue[super->s.queue], desc);
 #endif /* CONFIG_CARL9170FW_LOOPBACK */
 }
 
+static void wlan_assign_seq(struct ieee80211_hdr *hdr, unsigned int vif)
+{
+       hdr->seq_ctrl &= cpu_to_le16(~IEEE80211_SCTL_SEQ);
+       hdr->seq_ctrl |= cpu_to_le16(fw.wlan.sequence[vif]);
+
+       if (!(hdr->seq_ctrl & cpu_to_le16(IEEE80211_SCTL_FRAG)))
+               fw.wlan.sequence[vif] += 0x10;
+}
+
 /* prepares frame for the first transmission */
 static void _wlan_tx(struct dma_desc *desc)
 {
        struct carl9170_tx_superframe *super = get_super(desc);
 
+       if (unlikely(super->s.assign_seq)) {
+               wlan_assign_seq(&super->f.data.i3e, super->s.vif_id);
+       }
+
        if (unlikely(super->s.ampdu_commit_density)) {
                set(AR9170_MAC_REG_AMPDU_DENSITY,
                    MOD_VAL(AR9170_MAC_AMPDU_DENSITY,
@@ -383,11 +417,7 @@ static bool wlan_tx_status(struct dma_queue *queue,
                                 */
 
                                dma_unlink_head(queue);
-#ifdef CONFIG_CARL9170FW_DELAYED_TX
                                dma_put(&fw.wlan.tx_retry, desc);
-#else
-                               __wlan_tx(desc);
-#endif /* CONFIG_CARL9170FW_DELAYED_TX */
                                return true;
                        }
                } else {
@@ -433,7 +463,8 @@ static bool wlan_tx_status(struct dma_queue *queue,
 static void handle_tx_completion(void)
 {
        struct dma_desc *desc;
-       unsigned int i;
+       unsigned int map = 0;
+       int i;
 
        for (i = 0; i < __AR9170_NUM_TX_QUEUES; i++) {
                __while_desc_bits(desc, &fw.wlan.tx_queue[i], AR9170_OWN_BITS_SW) {
@@ -443,15 +474,15 @@ static void handle_tx_completion(void)
                        }
                }
 
-#ifdef CONFIG_CARL9170FW_DELAYED_TX
                for_each_desc(desc, &fw.wlan.tx_retry)
                        __wlan_tx(desc);
 
-               for_each_desc(desc, &fw.wlan.tx_delay[i])
-                       _wlan_tx(desc);
-#endif /* CONFIG_CARL9170FW_DELAYED_TX */
-               wlan_trigger(BIT(i));
+               wlan_tx_ampdu_end(i);
+               if (!queue_empty(&fw.wlan.tx_queue[i]))
+                       map |= BIT(i);
+
        }
+       wlan_trigger(map);
 }
 
 void __hot wlan_tx(struct dma_desc *desc)
@@ -471,13 +502,6 @@ void __hot wlan_tx(struct dma_desc *desc)
        }
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
-#ifdef CONFIG_CARL9170FW_DELAYED_TX
-       if (!queue_empty(&fw.wlan.tx_queue[super->s.queue])) {
-               dma_put(&fw.wlan.tx_delay[super->s.queue], desc);
-               return;
-       }
-#endif /* CONFIG_CARL9170FW_DELAYED_TX */
-
        _wlan_tx(desc);
        wlan_trigger(BIT(super->s.queue));
 }
@@ -629,6 +653,152 @@ static void wlan_check_rx_overrun(void)
        }
 }
 
+#ifdef CONFIG_CARL9170FW_WOL
+
+#ifdef CONFIG_CARL9170FW_WOL_MAGIC_PACKET
+static bool wlan_rx_wol_magic_packet(struct ieee80211_hdr *hdr, unsigned int len)
+{
+       const unsigned char *data, *end, *mac;
+       unsigned int found = 0;
+
+       /*
+        * LIMITATION:
+        * We can only scan the first AR9170_BLOCK_SIZE [=~320] bytes
+        * for MAGIC patterns!
+        */
+
+       /*
+        * TODO:
+        * Currently, the MAGIC MAC Address is fixed to the EEPROM default.
+        * It's possible to make it fully configurable, e.g:
+        *
+        * mac = (const unsigned char *) AR9170_MAC_REG_MAC_ADDR_L;
+        * But this will clash with the driver's suspend path, because it
+        * needs to reset the registers.
+        */
+       mac = rom.sys.mac_address;
+
+       data = (u8 *)((unsigned long)hdr + ieee80211_hdrlen(hdr->frame_control));
+       end = (u8 *)((unsigned long)hdr + len);
+
+       /*
+        * scan for standard WOL Magic frame
+        *
+        * "A physical WakeOnLAN (Magic Packet) will look like this:
+        * ---------------------------------------------------------------
+        * | Synchronization Stream |  Target MAC |  Password (optional) |
+        * |    6 octets            |   96 octets |   0, 4 or 6          |
+        * ---------------------------------------------------------------
+        *
+        * The Synchronization Stream is defined as 6 bytes of FFh.
+        * The Target MAC block contains 16 duplications of the IEEEaddress
+        * of the target, with no breaks or interruptions.
+        *
+        * The Password field is optional, but if present, contains either
+        * 4 bytes or 6 bytes. The WakeOnLAN dissector was implemented to
+        * dissect the password, if present, according to the command-line
+        * format that ether-wake uses, therefore, if a 4-byte password is
+        * present, it will be dissected as an IPv4 address and if a 6-byte
+        * password is present, it will be dissected as an Ethernet address.
+        *
+        * <http://wiki.wireshark.org/WakeOnLAN>
+        */
+
+       while (data < end) {
+               if (found >= 6) {
+                       if (*data == mac[found % 6])
+                               found++;
+                       else
+                               found = 0;
+               }
+
+               /* previous check might reset found counter */
+               if (found < 6) {
+                       if (*data == 0xff)
+                               found++;
+                       else
+                               found = 0;
+               }
+
+               if (found == (6 + 16 * 6)) {
+                       return true;
+               }
+
+               data++;
+       }
+
+       return false;
+}
+#endif /* CONFIG_CARL9170FW_WOL_MAGIC_PACKET */
+
+#ifdef CONFIG_CARL9170FW_WOL_PROBE_REQUEST
+
+/*
+ * Note: CONFIG_CARL9170FW_WOL_PROBE_REQUEST_SSID is not a real
+ * string. We have to be careful not to add a \0 at the end.
+ */
+static const struct {
+       u8 ssid_ie;
+       u8 ssid_len;
+       u8 ssid[sizeof(CONFIG_CARL9170FW_WOL_PROBE_REQUEST_SSID) - 1];
+} __packed probe_req = {
+       .ssid_ie = WLAN_EID_SSID,
+       .ssid_len = sizeof(CONFIG_CARL9170FW_WOL_PROBE_REQUEST_SSID) - 1,
+       .ssid = CONFIG_CARL9170FW_WOL_PROBE_REQUEST_SSID,
+};
+
+static bool wlan_rx_wol_probe_ssid(struct ieee80211_hdr *hdr, unsigned int len)
+{
+       const unsigned char *data, *end, *scan = (void *) &probe_req;
+
+       /*
+        * IEEE 802.11-2007 7.3.2.1 specifies that the SSID is no
+        * longer than 32 octets.
+        */
+       BUILD_BUG_ON((sizeof(CONFIG_CARL9170FW_WOL_PROBE_REQUEST_SSID) - 1) > 32);
+
+       if (ieee80211_is_probe_req(hdr->frame_control)) {
+               unsigned int i;
+               end = (u8 *)((unsigned long)hdr + len);
+
+               /*
+                * The position of the SSID information element inside
+                * a probe request frame is more or less "fixed".
+                */
+               data = (u8 *)((struct ieee80211_mgmt *)hdr)->u.probe_req.variable;
+               for (i = 0; i < (unsigned int)(probe_req.ssid_len + 1); i++) {
+                       if (scan[i] != data[i])
+                               return false;
+               }
+
+               return true;
+       }
+
+       return false;
+}
+#endif /* CONFIG_CARL9170FW_WOL_PROBE_REQUEST */
+
+static void wlan_rx_wol(unsigned int rx_filter __unused, struct ieee80211_hdr *hdr __unused, unsigned int len __unused)
+{
+       bool __unused wake_up = false;
+
+#ifdef CONFIG_CARL9170FW_WOL_MAGIC_PACKET
+       if (rx_filter & CARL9170_RX_FILTER_DATA)
+               wake_up |= wlan_rx_wol_magic_packet(hdr, len);
+#endif /* CONFIG_CARL9170FW_WOL_MAGIC_PACKET */
+
+#ifdef CONFIG_CARL9170FW_WOL_PROBE_REQUEST
+       if (rx_filter & CARL9170_RX_FILTER_MGMT)
+               wake_up |= wlan_rx_wol_probe_ssid(hdr, len);
+#endif /* CONFIG_CARL9170FW_WOL_PROBE_REQUEST */
+
+       if (wake_up) {
+               fw.suspend_mode = CARL9170_AWAKE_HOST;
+               set(AR9170_USB_REG_WAKE_UP, AR9170_USB_WAKE_UP_WAKE);
+       }
+}
+#endif /* CONFIG_CARL9170FW_WOL */
+
 static unsigned int wlan_rx_filter(struct dma_desc *desc)
 {
        struct ieee80211_hdr *hdr;
@@ -683,6 +853,13 @@ static unsigned int wlan_rx_filter(struct dma_desc *desc)
                rx_filter |= CARL9170_RX_FILTER_MGMT;
        }
 
+#ifdef CONFIG_CARL9170FW_WOL
+       if (unlikely(fw.suspend_mode == CARL9170_HOST_SUSPENDED)) {
+               wlan_rx_wol(rx_filter, hdr, min(data_len,
+                           (unsigned int)AR9170_BLOCK_SIZE));
+       }
+#endif /* CONFIG_CARL9170FW_WOL */
+
 #undef AR9170_RX_ERROR_BAD
 
        return rx_filter;
@@ -698,7 +875,7 @@ static void handle_rx(void)
                        up_trigger();
                } else {
                        dma_reclaim(&fw.wlan.rx_queue, desc);
-                       _wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
+                       wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
                }
        }
 }
@@ -731,6 +908,7 @@ void wlan_cab_flush_queue(const unsigned int vif)
 
                /* ready to roll! */
                _wlan_tx(desc);
+               wlan_trigger(BIT(super->s.queue));
        }
 }
 
@@ -755,7 +933,7 @@ static uint8_t *beacon_find_ie(uint8_t ie, void *addr,
        return NULL;
 }
 
-void wlan_cab_modify_dtim_beacon(const unsigned int vif,
+void wlan_modify_beacon(const unsigned int vif,
        const unsigned int addr, const unsigned int len)
 {
        uint8_t *_ie;
@@ -780,6 +958,15 @@ void wlan_cab_modify_dtim_beacon(const unsigned int vif,
                        ie->bitmap_ctrl |= 0x1;
                }
        }
+
+       /*
+        * Ideally, the sequence number should be assigned by the TX arbiter
+        * hardware. But AFAIK that's not possible, so we have to go for the
+        * next best thing and write it into the beacon fifo during the open
+        * beacon update window.
+        */
+
+       wlan_assign_seq((struct ieee80211_hdr *)addr, vif);
 }
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
@@ -790,8 +977,6 @@ static void handle_beacon_config(void)
        bcn_count = get(AR9170_MAC_REG_BCN_COUNT);
        send_cmd_to_host(4, CARL9170_RSP_BEACON_CONFIG, 0x00,
                         (uint8_t *) &bcn_count);
-
-       set(AR9170_MAC_REG_BCN_CTRL, AR9170_BCN_CTRL_READY);
 }
 
 static void handle_pretbtt(void)
@@ -800,14 +985,10 @@ static void handle_pretbtt(void)
        fw.wlan.cab_flush_time = get_clock_counter();
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
-#ifdef CONFIG_CARL9170FW_PSM
        rf_psm();
 
        send_cmd_to_host(4, CARL9170_RSP_PRETBTT, 0x00,
                         (uint8_t *) &fw.phy.psm.state);
-#else
-       send_cmd_to_host(0, CARL9170_RSP_PRETBTT, 0x00, NULL);
-#endif /* CONFIG_CARL9170FW_PSM */
 }
 
 static void handle_atim(void)
@@ -864,13 +1045,6 @@ static void wlan_janitor(void)
        }
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
-#ifdef CONFIG_CARL9170FW_DELAYED_TX
-       if (fw.wlan.tx_trigger) {
-               _wlan_trigger(fw.wlan.tx_trigger);
-               fw.wlan.tx_trigger = 0;
-       }
-#endif /* CONFIG_CARL9170FW_DELAYED_TX */
-
        wlan_send_buffered_tx_status();
 
 #ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
@@ -1075,6 +1249,7 @@ static void wlan_mac_reset(void)
         * set(AR9170_PHY_REG_CCA_THRESHOLD, 0x0);
         */
 
+       val = AR9170_DMA_TRIGGER_RXQ;
        /* Reinitialize all WLAN TX DMA queues. */
        for (i = 0; i < __AR9170_NUM_TX_QUEUES; i++) {
                struct dma_desc *iter;
@@ -1083,7 +1258,7 @@ static void wlan_mac_reset(void)
 
                set_wlan_txq_dma_addr(i, (uint32_t) iter);
                if (!is_terminator(&fw.wlan.tx_queue[i], iter))
-                       wlan_trigger(BIT(i));
+                       val |= BIT(i);
 
                DBG("Q:%d l:%d h:%p t:%p cu:%p it:%p ct:%x st:%x\n", i, queue_len(&fw.wlan.tx_queue[i]),
                     fw.wlan.tx_queue[i].head, fw.wlan.tx_queue[i].terminator,
@@ -1094,7 +1269,7 @@ static void wlan_mac_reset(void)
                            AR9170_MAC_INT_RETRY_FAIL;
 
        set(AR9170_MAC_REG_DMA_RXQ_ADDR, (uint32_t) fw.wlan.rx_queue.head);
-       wlan_trigger(AR9170_DMA_TRIGGER_RXQ);
+       wlan_trigger(val);
 }
 #else
 static void wlan_mac_reset(void)