carl9170 firmware: double check if unlinked desc matches head desc
[carl9170fw.git] / carlfw / src / wlan.c
index b680822e5e054dcccb16a6a18c71cedec217ee4c..a7c805b588908267541bd994f6c878a0abea16c2 100644 (file)
@@ -31,7 +31,7 @@
 #include "printf.h"
 #include "rf.h"
 #include "linux/ieee80211.h"
-#include "rom.h"
+#include "wol.h"
 
 static void wlan_txunstuck(unsigned int queue)
 {
@@ -214,17 +214,7 @@ static bool wlan_tx_consume_retry(struct carl9170_tx_superframe *super)
 
 static inline u16 get_tid(struct ieee80211_hdr *hdr)
 {
-        return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
-}
-
-/* This function will only work on uint32_t-aligned pointers! */
-static inline bool compare_ether_address(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]) | (unsigned short)(d0[1] ^ d1[1]));
+       return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
 }
 
 /* This function will only work on uint32_t-aligned pointers! */
@@ -245,13 +235,19 @@ 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_reset(unsigned int qidx)
+{
+       fw.wlan.ampdu_prev[qidx] = NULL;
+}
+
 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;
+
+       wlan_tx_ampdu_reset(qidx);
 }
 
 static void wlan_tx_ampdu(struct carl9170_tx_superframe *super)
@@ -259,16 +255,16 @@ 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) {
-               wlan_tx_ampdu_end(qidx);
-       } else {
-               fw.wlan.ampdu_prev[qidx] = super;
-
+       if (super->f.hdr.mac.ampdu) {
                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;
+
+               fw.wlan.ampdu_prev[qidx] = super;
+       } else {
+               wlan_tx_ampdu_end(qidx);
        }
 }
 
@@ -331,9 +327,8 @@ static void _wlan_tx(struct dma_desc *desc)
 {
        struct carl9170_tx_superframe *super = get_super(desc);
 
-       if (unlikely(super->s.assign_seq)) {
+       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,
@@ -348,8 +343,6 @@ static void _wlan_tx(struct dma_desc *desc)
                            get(AR9170_MAC_REG_AMPDU_FACTOR),
                            8 << super->s.ampdu_factor));
        }
-
-       __wlan_tx(desc);
 }
 
 /* propagate transmission status back to the driver */
@@ -358,7 +351,7 @@ static bool wlan_tx_status(struct dma_queue *queue,
 {
        struct carl9170_tx_superframe *super = get_super(desc);
        unsigned int qidx = super->s.queue;
-       bool txfail, success;
+       bool txfail = false, success;
 
        success = true;
 
@@ -415,7 +408,11 @@ static bool wlan_tx_status(struct dma_queue *queue,
                                 * be aware of this so the frames don't get lost.
                                 */
 
+#ifndef CONFIG_CARL9170FW_DEBUG
                                dma_unlink_head(queue);
+#else /* CONFIG_CARL9170FW_DEBUG */
+                               BUG_ON(dma_unlink_head(queue) != desc);
+#endif /* CONFIG_CARL9170FW_DEBUG */
                                dma_put(&fw.wlan.tx_retry, desc);
                                return true;
                        }
@@ -425,7 +422,11 @@ static bool wlan_tx_status(struct dma_queue *queue,
                }
        }
 
+#ifndef CONFIG_CARL9170FW_DEBUG
        dma_unlink_head(queue);
+#else /* CONFIG_CARL9170FW_DEBUG */
+       BUG_ON(dma_unlink_head(queue) != desc);
+#endif /* CONFIG_CARL9170FW_DEBUG */
        if (txfail) {
                /*
                 * Issue the queue bump,
@@ -438,21 +439,23 @@ static bool wlan_tx_status(struct dma_queue *queue,
 
        unhide_super(desc);
 
-#ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
-       if (unlikely(super == (void *) &dma_mem.reserved.ba)) {
-               fw.wlan.ba_desc = desc;
-               fw.wlan.ba_desc_available = 1;
+       if (unlikely(super == fw.wlan.fw_desc_data)) {
+               fw.wlan.fw_desc = desc;
+               fw.wlan.fw_desc_available = 1;
+
+               if (fw.wlan.fw_desc_callback)
+                       fw.wlan.fw_desc_callback(super, success);
+
                return true;
        }
-#endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
-
-       wlan_tx_complete(super, success);
 
 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
        if (unlikely(super->s.cab))
                fw.wlan.cab_queue_len[super->s.vif_id]--;
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
+       wlan_tx_complete(super, success);
+
        /* recycle freed descriptors */
        dma_reclaim(&fw.pta.down_queue, desc);
        down_trigger();
@@ -472,13 +475,14 @@ static void handle_tx_completion(void)
                        }
                }
 
+               wlan_tx_ampdu_reset(i);
+
                for_each_desc(desc, &fw.wlan.tx_retry)
                        __wlan_tx(desc);
 
                wlan_tx_ampdu_end(i);
                if (!queue_empty(&fw.wlan.tx_queue[i]))
                        wlan_trigger(BIT(i));
-
        }
 }
 
@@ -500,10 +504,29 @@ void __hot wlan_tx(struct dma_desc *desc)
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
        _wlan_tx(desc);
+       __wlan_tx(desc);
        wlan_trigger(BIT(super->s.queue));
 }
 
-#ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
+void wlan_tx_fw(struct carl9170_tx_superdesc *super, fw_desc_callback_t cb)
+{
+       if (!fw.wlan.fw_desc_available)
+               return;
+
+       fw.wlan.fw_desc_available = 0;
+
+       /* Format BlockAck */
+       fw.wlan.fw_desc->ctrl = AR9170_CTRL_FS_BIT | AR9170_CTRL_LS_BIT;
+       fw.wlan.fw_desc->status = AR9170_OWN_BITS_SW;
+
+       fw.wlan.fw_desc->totalLen = fw.wlan.fw_desc->dataSize = super->len;
+       fw.wlan.fw_desc_data = fw.wlan.fw_desc->dataAddr = super;
+       fw.wlan.fw_desc->nextAddr = fw.wlan.fw_desc->lastAddr =
+               fw.wlan.fw_desc;
+       fw.wlan.fw_desc_callback = cb;
+       wlan_tx(fw.wlan.fw_desc);
+}
+
 static void wlan_send_buffered_ba(void)
 {
        struct carl9170_tx_ba_superframe *baf = &dma_mem.reserved.ba.ba;
@@ -514,26 +537,18 @@ static void wlan_send_buffered_ba(void)
                return;
 
        /* there's no point to continue when the ba_desc is not available. */
-       if (!fw.wlan.ba_desc_available)
+       if (!fw.wlan.fw_desc_available)
                return;
 
        ctx = &fw.wlan.ba_cache[fw.wlan.ba_head_idx];
        fw.wlan.ba_head_idx++;
        fw.wlan.ba_head_idx %= CONFIG_CARL9170FW_BACK_REQS_NUM;
 
-       /* Format BlockAck */
-       fw.wlan.ba_desc->status = 0;
-       fw.wlan.ba_desc->ctrl = AR9170_CTRL_FS_BIT | AR9170_CTRL_LS_BIT;
-       fw.wlan.ba_desc_available = 0;
-       fw.wlan.ba_desc->nextAddr = fw.wlan.ba_desc->lastAddr =
-               fw.wlan.ba_desc;
-
-       baf->s.len = fw.wlan.ba_desc->totalLen = fw.wlan.ba_desc->dataSize =
-               sizeof(struct carl9170_tx_superdesc) +
-               sizeof(struct ar9170_tx_hwdesc) +
-               sizeof(struct ieee80211_ba);
-
+       baf->s.len = sizeof(struct carl9170_tx_superdesc) +
+                    sizeof(struct ar9170_tx_hwdesc) +
+                    sizeof(struct ieee80211_ba);
        baf->s.ri[0].tries = 1;
+       baf->s.cookie = 0;
        baf->s.queue = AR9170_TXQ_VO;
        baf->f.hdr.length = sizeof(struct ieee80211_ba) + FCS_LEN;
 
@@ -546,7 +561,7 @@ static void wlan_send_buffered_ba(void)
        baf->f.hdr.phy.tx_power = 29; /* 14.5 dBm */
 
        /* format outgoing BA */
-       ba->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_BACK);
+       ba->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL | IEEE80211_STYPE_NULLFUNC);
        ba->duration = cpu_to_le16(0);
        memcpy(ba->ta, ctx->ta, 6);
        memcpy(ba->ra, ctx->ra, 6);
@@ -564,8 +579,7 @@ static void wlan_send_buffered_ba(void)
         */
        ba->control = ctx->control | cpu_to_le16(1);
        ba->start_seq_num = ctx->start_seq_num;
-
-       wlan_tx(fw.wlan.ba_desc);
+       wlan_tx_fw(&baf->s, NULL);
 }
 
 static struct carl9170_bar_ctx *wlan_get_bar_cache_buffer(void)
@@ -630,14 +644,13 @@ static void handle_bar(struct dma_desc *desc, struct ieee80211_hdr *hdr,
                ctx->phy = cpu_to_le32(0x2cc301);
        }
 }
-#endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
 
 static void wlan_check_rx_overrun(void)
 {
        uint32_t overruns, total;
 
-       fw.wlan.rx_total += total = get(AR9170_MAC_REG_RX_TOTAL);
-       fw.wlan.rx_overruns += overruns = get(AR9170_MAC_REG_RX_OVERRUN);
+       fw.tally.rx_total += total = get(AR9170_MAC_REG_RX_TOTAL);
+       fw.tally.rx_overrun += overruns = get(AR9170_MAC_REG_RX_OVERRUN);
        if (unlikely(overruns)) {
                if (overruns == total) {
                        DBG("RX Overrun");
@@ -648,152 +661,6 @@ 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;
@@ -830,9 +697,7 @@ static unsigned int wlan_rx_filter(struct dma_desc *desc)
        } else if (ieee80211_is_ctl(hdr->frame_control)) {
                switch (le16_to_cpu(hdr->frame_control) & IEEE80211_FCTL_STYPE) {
                case IEEE80211_STYPE_BACK_REQ:
-#ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
                        handle_bar(desc, hdr, data_len, mac_err);
-#endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
                        /* fallthrough */
                        rx_filter |= CARL9170_RX_FILTER_CTL_BACKR;
                        break;
@@ -848,12 +713,10 @@ 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));
+               wol_rx(rx_filter, hdr, min(data_len,
+                       (unsigned int)AR9170_BLOCK_SIZE));
        }
-#endif /* CONFIG_CARL9170FW_WOL */
 
 #undef AR9170_RX_ERROR_BAD
 
@@ -903,6 +766,7 @@ void wlan_cab_flush_queue(const unsigned int vif)
 
                /* ready to roll! */
                _wlan_tx(desc);
+               __wlan_tx(desc);
                wlan_trigger(BIT(super->s.queue));
        }
 }
@@ -963,6 +827,38 @@ void wlan_modify_beacon(const unsigned int vif,
 
        wlan_assign_seq((struct ieee80211_hdr *)addr, vif);
 }
+
+static void wlan_send_buffered_cab(void)
+{
+       unsigned int i;
+
+       for (i = 0; i < CARL9170_INTF_NUM; i++) {
+               if (unlikely(fw.wlan.cab_flush_trigger[i] == CARL9170_CAB_TRIGGER_ARMED)) {
+                       /*
+                        * This is hardcoded into carl9170usb driver.
+                        *
+                        * The driver must set the PRETBTT event to beacon_interval -
+                        * CARL9170_PRETBTT_KUS (usually 6) Kus.
+                        *
+                        * But still, we can only do so much about 802.11-2007 9.3.2.1 &
+                        * 11.2.1.6. Let's hope the current solution is adequate enough.
+                        */
+
+                       if (is_after_msecs(fw.wlan.cab_flush_time, (CARL9170_TBTT_DELTA))) {
+                               wlan_cab_flush_queue(i);
+
+                               /*
+                                * This prevents the code from sending new BC/MC frames
+                                * which were queued after the previous buffered traffic
+                                * has been sent out... They will have to wait until the
+                                * next DTIM beacon comes along.
+                                */
+                               fw.wlan.cab_flush_trigger[i] = CARL9170_CAB_TRIGGER_DEFER;
+                       }
+               }
+
+       }
+}
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
 static void handle_beacon_config(void)
@@ -980,10 +876,12 @@ static void handle_pretbtt(void)
        fw.wlan.cab_flush_time = get_clock_counter();
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
+#ifdef CONFIG_CARL9170FW_RADIO_FUNCTIONS
        rf_psm();
 
        send_cmd_to_host(4, CARL9170_RSP_PRETBTT, 0x00,
                         (uint8_t *) &fw.phy.psm.state);
+#endif /* CONFIG_CARL9170FW_RADIO_FUNCTIONS */
 }
 
 static void handle_atim(void)
@@ -1010,41 +908,14 @@ static void handle_radar(void)
 static void wlan_janitor(void)
 {
 #ifdef CONFIG_CARL9170FW_CAB_QUEUE
-       unsigned int i;
-
-       for (i = 0; i < CARL9170_INTF_NUM; i++) {
-               if (unlikely(fw.wlan.cab_flush_trigger[i] == CARL9170_CAB_TRIGGER_ARMED)) {
-                       /*
-                        * This is hardcoded into carl9170usb driver.
-                        *
-                        * The driver must set the PRETBTT event to beacon_interval -
-                        * CARL9170_PRETBTT_KUS (usually 6) Kus.
-                        *
-                        * But still, we can only do so much about 802.11-2007 9.3.2.1 &
-                        * 11.2.1.6. Let's hope the current solution is adequate enough.
-                        */
-
-                       if (is_after_msecs(fw.wlan.cab_flush_time, (CARL9170_TBTT_DELTA))) {
-                               wlan_cab_flush_queue(i);
-
-                               /*
-                                * This prevents the code from sending new BC/MC frames
-                                * which were queued after the previous buffered traffic
-                                * has been sent out... They will have to wait until the
-                                * next DTIM beacon comes along.
-                                */
-                               fw.wlan.cab_flush_trigger[i] = CARL9170_CAB_TRIGGER_DEFER;
-                       }
-               }
-
-       }
+       wlan_send_buffered_cab();
 #endif /* CONFIG_CARL9170FW_CAB_QUEUE */
 
        wlan_send_buffered_tx_status();
 
-#ifdef CONFIG_CARL9170FW_HANDLE_BACK_REQ
        wlan_send_buffered_ba();
-#endif /* CONFIG_CARL9170FW_HANDLE_BACK_REQ */
+
+       wol_janitor();
 }
 
 void handle_wlan(void)
@@ -1108,7 +979,7 @@ static void wlan_check_hang(void)
                }
 
                /* fetch the current DMA queue position */
-               desc = get_wlan_txq_addr(i);
+               desc = (struct dma_desc *)get_wlan_txq_addr(i);
 
                /* Stuck frame detection */
                if (unlikely(DESC_PAYLOAD(desc) == fw.wlan.last_super[i])) {