wlcore_i.h

Go to the documentation of this file.

/*
 * This file is part of wl1271
 *
 * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
 * Copyright (C) 2008-2009 Nokia Corporation
 *
 * Contact: Luciano Coelho <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 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 St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef __WLCORE_I_H__
#define __WLCORE_I_H__

#include <linux/mutex.h>
#include <linux/completion.h>
#include <linux/spinlock.h>
#include <linux/list.h>
#include <linux/bitops.h>
#include <net/mac80211.h>

#include "conf.h"
#include "ini.h"

/*
 * wl127x and wl128x are using the same NVS file name. However, the
 * ini parameters between them are different.  The driver validates
 * the correct NVS size in wl1271_boot_upload_nvs().
 */
#define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"

#define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
#define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
#define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff

#define WL1271_CIPHER_SUITE_GEM 0x00147201

#define WL1271_BUSY_WORD_CNT 1
#define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))

#define WL1271_ELP_HW_STATE_ASLEEP 0
#define WL1271_ELP_HW_STATE_IRQ    1

#define WL1271_DEFAULT_BEACON_INT  100
#define WL1271_DEFAULT_DTIM_PERIOD 1

#define WL12XX_MAX_ROLES           4
#define WL12XX_MAX_LINKS           12
#define WL12XX_INVALID_ROLE_ID     0xff
#define WL12XX_INVALID_LINK_ID     0xff

/* the driver supports the 2.4Ghz and 5Ghz bands */
#define WLCORE_NUM_BANDS           2

#define WL12XX_MAX_RATE_POLICIES 16
#define WLCORE_MAX_KLV_TEMPLATES 4

/* Defined by FW as 0. Will not be freed or allocated. */
#define WL12XX_SYSTEM_HLID         0

/*
 * When in AP-mode, we allow (at least) this number of packets
 * to be transmitted to FW for a STA in PS-mode. Only when packets are
 * present in the FW buffers it will wake the sleeping STA. We want to put
 * enough packets for the driver to transmit all of its buffered data before
 * the STA goes to sleep again. But we don't want to take too much memory
 * as it might hurt the throughput of active STAs.
 */
#define WL1271_PS_STA_MAX_PACKETS  2

#define WL1271_AP_BSS_INDEX        0
#define WL1271_AP_DEF_BEACON_EXP   20

enum wlcore_state {
    WLCORE_STATE_OFF,
    WLCORE_STATE_RESTARTING,
    WLCORE_STATE_ON,
};

enum wl12xx_fw_type {
    WL12XX_FW_TYPE_NONE,
    WL12XX_FW_TYPE_NORMAL,
    WL12XX_FW_TYPE_MULTI,
    WL12XX_FW_TYPE_PLT,
};

struct wl1271;

enum {
    FW_VER_CHIP,
    FW_VER_IF_TYPE,
    FW_VER_MAJOR,
    FW_VER_SUBTYPE,
    FW_VER_MINOR,

    NUM_FW_VER
};

#define FW_VER_CHIP_WL127X 6
#define FW_VER_CHIP_WL128X 7

#define FW_VER_IF_TYPE_STA 1
#define FW_VER_IF_TYPE_AP  2

#define FW_VER_MINOR_1_SPARE_STA_MIN 58
#define FW_VER_MINOR_1_SPARE_AP_MIN  47

#define FW_VER_MINOR_FWLOG_STA_MIN 70

struct wl1271_chip {
    u32 id;
    char fw_ver_str[ETHTOOL_BUSINFO_LEN];
    unsigned int fw_ver[NUM_FW_VER];
    char phy_fw_ver_str[ETHTOOL_BUSINFO_LEN];
};

#define NUM_TX_QUEUES              4

#define AP_MAX_STATIONS            8

struct wl_fw_packet_counters {
    /* Cumulative counter of released packets per AC */
    u8 tx_released_pkts[NUM_TX_QUEUES];

    /* Cumulative counter of freed packets per HLID */
    u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];

    /* Cumulative counter of released Voice memory blocks */
    u8 tx_voice_released_blks;

    u8 padding[3];
} __packed;

/* FW status registers */
struct wl_fw_status_1 {
    __le32 intr;
    u8  fw_rx_counter;
    u8  drv_rx_counter;
    u8  reserved;
    u8  tx_results_counter;
    __le32 rx_pkt_descs[0];
} __packed;

/*
 * Each HW arch has a different number of Rx descriptors.
 * The length of the status depends on it, since it holds an array
 * of descriptors.
 */
#define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
        (sizeof(struct wl_fw_status_1) + \
        (sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
        num_rx_desc)

struct wl_fw_status_2 {
    __le32 fw_localtime;

    /*
     * A bitmap (where each bit represents a single HLID)
     * to indicate if the station is in PS mode.
     */
    __le32 link_ps_bitmap;

    /*
     * A bitmap (where each bit represents a single HLID) to indicate
     * if the station is in Fast mode
     */
    __le32 link_fast_bitmap;

    /* Cumulative counter of total released mem blocks since FW-reset */
    __le32 total_released_blks;

    /* Size (in Memory Blocks) of TX pool */
    __le32 tx_total;

    struct wl_fw_packet_counters counters;

    __le32 log_start_addr;

    /* Private status to be used by the lower drivers */
    u8 priv[0];
} __packed;

#define WL1271_MAX_CHANNELS 64
struct wl1271_scan {
    struct cfg80211_scan_request *req;
    unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
    bool failed;
    u8 state;
    u8 ssid[IEEE80211_MAX_SSID_LEN+1];
    size_t ssid_len;
};

struct wl1271_if_operations {
    int __must_check (*read)(struct device *child, int addr, void *buf,
                 size_t len, bool fixed);
    int __must_check (*write)(struct device *child, int addr, void *buf,
                  size_t len, bool fixed);
    void (*reset)(struct device *child);
    void (*init)(struct device *child);
    int (*power)(struct device *child, bool enable);
    void (*set_block_size) (struct device *child, unsigned int blksz);
};

#define MAX_NUM_KEYS 14
#define MAX_KEY_SIZE 32

struct wl1271_ap_key {
    u8 id;
    u8 key_type;
    u8 key_size;
    u8 key[MAX_KEY_SIZE];
    u8 hlid;
    u32 tx_seq_32;
    u16 tx_seq_16;
};

enum wl12xx_flags {
    WL1271_FLAG_GPIO_POWER,
    WL1271_FLAG_TX_QUEUE_STOPPED,
    WL1271_FLAG_TX_PENDING,
    WL1271_FLAG_IN_ELP,
    WL1271_FLAG_ELP_REQUESTED,
    WL1271_FLAG_IRQ_RUNNING,
    WL1271_FLAG_FW_TX_BUSY,
    WL1271_FLAG_DUMMY_PACKET_PENDING,
    WL1271_FLAG_SUSPENDED,
    WL1271_FLAG_PENDING_WORK,
    WL1271_FLAG_SOFT_GEMINI,
    WL1271_FLAG_RECOVERY_IN_PROGRESS,
    WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
    WL1271_FLAG_INTENDED_FW_RECOVERY,
    WL1271_FLAG_IO_FAILED,
};

enum wl12xx_vif_flags {
    WLVIF_FLAG_INITIALIZED,
    WLVIF_FLAG_STA_ASSOCIATED,
    WLVIF_FLAG_STA_AUTHORIZED,
    WLVIF_FLAG_IBSS_JOINED,
    WLVIF_FLAG_AP_STARTED,
    WLVIF_FLAG_IN_PS,
    WLVIF_FLAG_STA_STATE_SENT,
    WLVIF_FLAG_RX_STREAMING_STARTED,
    WLVIF_FLAG_PSPOLL_FAILURE,
    WLVIF_FLAG_CS_PROGRESS,
    WLVIF_FLAG_AP_PROBE_RESP_SET,
    WLVIF_FLAG_IN_USE,
};

struct wl1271_link {
    /* AP-mode - TX queue per AC in link */
    struct sk_buff_head tx_queue[NUM_TX_QUEUES];

    /* accounting for allocated / freed packets in FW */
    u8 allocated_pkts;
    u8 prev_freed_pkts;

    u8 addr[ETH_ALEN];

    /* bitmap of TIDs where RX BA sessions are active for this link */
    u8 ba_bitmap;
};

#define WL1271_MAX_RX_FILTERS 5
#define WL1271_RX_FILTER_MAX_FIELDS 8

#define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
#define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
#define RX_FILTER_FIELD_OVERHEAD                \
    (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
#define WL1271_RX_FILTER_MAX_PATTERN_SIZE           \
    (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)

#define WL1271_RX_FILTER_FLAG_MASK                BIT(0)
#define WL1271_RX_FILTER_FLAG_IP_HEADER           0
#define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER     BIT(1)

enum rx_filter_action {
    FILTER_DROP = 0,
    FILTER_SIGNAL = 1,
    FILTER_FW_HANDLE = 2
};

enum plt_mode {
    PLT_OFF = 0,
    PLT_ON = 1,
    PLT_FEM_DETECT = 2,
};

struct wl12xx_rx_filter_field {
    __le16 offset;
    u8 len;
    u8 flags;
    u8 *pattern;
} __packed;

struct wl12xx_rx_filter {
    u8 action;
    int num_fields;
    struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
};

struct wl1271_station {
    u8 hlid;
};

struct wl12xx_vif {
    struct wl1271 *wl;
    struct list_head list;
    unsigned long flags;
    u8 bss_type;
    u8 p2p; /* we are using p2p role */
    u8 role_id;

    /* sta/ibss specific */
    u8 dev_role_id;
    u8 dev_hlid;

    union {
        struct {
            u8 hlid;
            u8 ba_rx_bitmap;

            u8 basic_rate_idx;
            u8 ap_rate_idx;
            u8 p2p_rate_idx;

            u8 klv_template_id;

            bool qos;
        } sta;
        struct {
            u8 global_hlid;
            u8 bcast_hlid;

            /* HLIDs bitmap of associated stations */
            unsigned long sta_hlid_map[BITS_TO_LONGS(
                            WL12XX_MAX_LINKS)];

            /* recoreded keys - set here before AP startup */
            struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];

            u8 mgmt_rate_idx;
            u8 bcast_rate_idx;
            u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
        } ap;
    };

    /* the hlid of the last transmitted skb */
    int last_tx_hlid;

    unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];

    u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
    u8 ssid_len;

    /* The current band */
    enum ieee80211_band band;
    int channel;
    enum nl80211_channel_type channel_type;

    u32 bitrate_masks[WLCORE_NUM_BANDS];
    u32 basic_rate_set;

    /*
     * currently configured rate set:
     *  bits  0-15 - 802.11abg rates
     *  bits 16-23 - 802.11n   MCS index mask
     * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
     */
    u32 basic_rate;
    u32 rate_set;

    /* probe-req template for the current AP */
    struct sk_buff *probereq;

    /* Beaconing interval (needed for ad-hoc) */
    u32 beacon_int;

    /* Default key (for WEP) */
    u32 default_key;

    /* Our association ID */
    u16 aid;

    /* Session counter for the chipset */
    int session_counter;

    /* retry counter for PSM entries */
    u8 psm_entry_retry;

    /* in dBm */
    int power_level;

    int rssi_thold;
    int last_rssi_event;

    /* save the current encryption type for auto-arp config */
    u8 encryption_type;
    __be32 ip_addr;

    /* RX BA constraint value */
    bool ba_support;
    bool ba_allowed;

    /* Rx Streaming */
    struct work_struct rx_streaming_enable_work;
    struct work_struct rx_streaming_disable_work;
    struct timer_list rx_streaming_timer;

    /*
     * This struct must be last!
     * data that has to be saved acrossed reconfigs (e.g. recovery)
     * should be declared in this struct.
     */
    struct {
        u8 persistent[0];
        /*
         * Security sequence number
         *     bits 0-15: lower 16 bits part of sequence number
         *     bits 16-47: higher 32 bits part of sequence number
         *     bits 48-63: not in use
         */
        u64 tx_security_seq;

        /* 8 bits of the last sequence number in use */
        u8 tx_security_last_seq_lsb;
    };
};

static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
{
    return (struct wl12xx_vif *)vif->drv_priv;
}

static inline
struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
{
    return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
}

#define wl12xx_for_each_wlvif(wl, wlvif) \
        list_for_each_entry(wlvif, &wl->wlvif_list, list)

#define wl12xx_for_each_wlvif_continue(wl, wlvif) \
        list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)

#define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)    \
        wl12xx_for_each_wlvif(wl, wlvif)        \
            if (wlvif->bss_type == _bss_type)

#define wl12xx_for_each_wlvif_sta(wl, wlvif)    \
        wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)

#define wl12xx_for_each_wlvif_ap(wl, wlvif) \
        wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)

int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
int wl1271_plt_stop(struct wl1271 *wl);
int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
void wl12xx_queue_recovery_work(struct wl1271 *wl);
size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
                    u16 offset, u8 flags,
                    u8 *pattern, u8 len);
void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
                     u8 *buf);

#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */

#define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
#define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */

#define WL1271_DEFAULT_POWER_LEVEL 0

#define WL1271_TX_QUEUE_LOW_WATERMARK  32
#define WL1271_TX_QUEUE_HIGH_WATERMARK 256

#define WL1271_DEFERRED_QUEUE_LIMIT    64

/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
   on in case is has been shut down shortly before */
#define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
#define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */

/* Macros to handle wl1271.sta_rate_set */
#define HW_BG_RATES_MASK    0xffff
#define HW_HT_RATES_OFFSET  16
#define HW_MIMO_RATES_OFFSET    24

#define WL12XX_HW_BLOCK_SIZE    256

#endif /* __WLCORE_I_H__ */