drivers/net/wireless/ath/ath6kl/core.h

   1 /*
   2  * Copyright (c) 2010-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2012 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef CORE_H
  19 #define CORE_H
  20
  21 #include <linux/etherdevice.h>
  22 #include <linux/rtnetlink.h>
  23 #include <linux/firmware.h>
  24 #include <linux/sched.h>
  25 #include <linux/circ_buf.h>
  26 #include <net/cfg80211.h>
  27 #include "htc.h"
  28 #include "wmi.h"
  29 #include "bmi.h"
  30 #include "target.h"
  31
  32 #define MAX_ATH6KL                        1
  33 #define ATH6KL_MAX_RX_BUFFERS             16
  34 #define ATH6KL_BUFFER_SIZE                1664
  35 #define ATH6KL_MAX_AMSDU_RX_BUFFERS       4
  36 #define ATH6KL_AMSDU_REFILL_THRESHOLD     3
  37 #define ATH6KL_AMSDU_BUFFER_SIZE     (WMI_MAX_AMSDU_RX_DATA_FRAME_LENGTH + 128)
  38 #define MAX_MSDU_SUBFRAME_PAYLOAD_LEN   1508
  39 #define MIN_MSDU_SUBFRAME_PAYLOAD_LEN   46
  40
  41 #define USER_SAVEDKEYS_STAT_INIT     0
  42 #define USER_SAVEDKEYS_STAT_RUN      1
  43
  44 #define ATH6KL_TX_TIMEOUT      10
  45 #define ATH6KL_MAX_ENDPOINTS   4
  46 #define MAX_NODE_NUM           15
  47
  48 #define ATH6KL_APSD_ALL_FRAME           0xFFFF
  49 #define ATH6KL_APSD_NUM_OF_AC           0x4
  50 #define ATH6KL_APSD_FRAME_MASK          0xF
  51
  52 /* Extra bytes for htc header alignment */
  53 #define ATH6KL_HTC_ALIGN_BYTES 3
  54
  55 /* MAX_HI_COOKIE_NUM are reserved for high priority traffic */
  56 #define MAX_DEF_COOKIE_NUM                180
  57 #define MAX_HI_COOKIE_NUM                 18    /* 10% of MAX_COOKIE_NUM */
  58 #define MAX_COOKIE_NUM                 (MAX_DEF_COOKIE_NUM + MAX_HI_COOKIE_NUM)
  59
  60 #define MAX_DEFAULT_SEND_QUEUE_DEPTH      (MAX_DEF_COOKIE_NUM / WMM_NUM_AC)
  61
  62 #define DISCON_TIMER_INTVAL               10000  /* in msec */
  63
  64 /* Channel dwell time in fg scan */
  65 #define ATH6KL_FG_SCAN_INTERVAL         50 /* in ms */
  66
  67 /* includes also the null byte */
  68 #define ATH6KL_FIRMWARE_MAGIC               "QCA-ATH6KL"
  69
  70 enum ath6kl_fw_ie_type {
  71         ATH6KL_FW_IE_FW_VERSION = 0,
  72         ATH6KL_FW_IE_TIMESTAMP = 1,
  73         ATH6KL_FW_IE_OTP_IMAGE = 2,
  74         ATH6KL_FW_IE_FW_IMAGE = 3,
  75         ATH6KL_FW_IE_PATCH_IMAGE = 4,
  76         ATH6KL_FW_IE_RESERVED_RAM_SIZE = 5,
  77         ATH6KL_FW_IE_CAPABILITIES = 6,
  78         ATH6KL_FW_IE_PATCH_ADDR = 7,
  79         ATH6KL_FW_IE_BOARD_ADDR = 8,
  80         ATH6KL_FW_IE_VIF_MAX = 9,
  81 };
  82
  83 enum ath6kl_fw_capability {
  84         ATH6KL_FW_CAPABILITY_HOST_P2P = 0,
  85         ATH6KL_FW_CAPABILITY_SCHED_SCAN = 1,
  86
  87         /*
  88          * Firmware is capable of supporting P2P mgmt operations on a
  89          * station interface. After group formation, the station
  90          * interface will become a P2P client/GO interface as the case may be
  91          */
  92         ATH6KL_FW_CAPABILITY_STA_P2PDEV_DUPLEX,
  93
  94         /*
  95          * Firmware has support to cleanup inactive stations
  96          * in AP mode.
  97          */
  98         ATH6KL_FW_CAPABILITY_INACTIVITY_TIMEOUT,
  99
 100         /* Firmware has support to override rsn cap of rsn ie */
 101         ATH6KL_FW_CAPABILITY_RSN_CAP_OVERRIDE,
 102
 103         /*
 104          * Multicast support in WOW and host awake mode.
 105          * Allow all multicast in host awake mode.
 106          * Apply multicast filter in WOW mode.
 107          */
 108         ATH6KL_FW_CAPABILITY_WOW_MULTICAST_FILTER,
 109
 110         /* Firmware supports enhanced bmiss detection */
 111         ATH6KL_FW_CAPABILITY_BMISS_ENHANCE,
 112
 113         /*
 114          * FW supports matching of ssid in schedule scan
 115          */
 116         ATH6KL_FW_CAPABILITY_SCHED_SCAN_MATCH_LIST,
 117
 118         /* Firmware supports filtering BSS results by RSSI */
 119         ATH6KL_FW_CAPABILITY_RSSI_SCAN_THOLD,
 120
 121         /* FW sets mac_addr[4] ^= 0x80 for newly created interfaces */
 122         ATH6KL_FW_CAPABILITY_CUSTOM_MAC_ADDR,
 123
 124         /* Firmware supports TX error rate notification */
 125         ATH6KL_FW_CAPABILITY_TX_ERR_NOTIFY,
 126
 127         /* supports WMI_SET_REGDOMAIN_CMDID command */
 128         ATH6KL_FW_CAPABILITY_REGDOMAIN,
 129
 130         /* Firmware supports sched scan decoupled from host sleep */
 131         ATH6KL_FW_CAPABILITY_SCHED_SCAN_V2,
 132
 133         /*
 134          * Firmware capability for hang detection through heart beat
 135          * challenge messages.
 136          */
 137         ATH6KL_FW_CAPABILITY_HEART_BEAT_POLL,
 138
 139         /* WMI_SET_TX_SELECT_RATES_CMDID uses 64 bit size rate table */
 140         ATH6KL_FW_CAPABILITY_64BIT_RATES,
 141
 142         /* WMI_AP_CONN_INACT_CMDID uses minutes as units */
 143         ATH6KL_FW_CAPABILITY_AP_INACTIVITY_MINS,
 144
 145         /* use low priority endpoint for all data */
 146         ATH6KL_FW_CAPABILITY_MAP_LP_ENDPOINT,
 147
 148         /* this needs to be last */
 149         ATH6KL_FW_CAPABILITY_MAX,
 150 };
 151
 152 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
 153
 154 struct ath6kl_fw_ie {
 155         __le32 id;
 156         __le32 len;
 157         u8 data[0];
 158 };
 159
 160 enum ath6kl_hw_flags {
 161         ATH6KL_HW_SDIO_CRC_ERROR_WAR    = BIT(3),
 162 };
 163
 164 #define ATH6KL_FW_API2_FILE "fw-2.bin"
 165 #define ATH6KL_FW_API3_FILE "fw-3.bin"
 166 #define ATH6KL_FW_API4_FILE "fw-4.bin"
 167
 168 /* AR6003 1.0 definitions */
 169 #define AR6003_HW_1_0_VERSION                 0x300002ba
 170
 171 /* AR6003 2.0 definitions */
 172 #define AR6003_HW_2_0_VERSION                 0x30000384
 173 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS  0x57e910
 174 #define AR6003_HW_2_0_FW_DIR                    "ath6k/AR6003/hw2.0"
 175 #define AR6003_HW_2_0_OTP_FILE                  "otp.bin.z77"
 176 #define AR6003_HW_2_0_FIRMWARE_FILE             "athwlan.bin.z77"
 177 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE        "athtcmd_ram.bin"
 178 #define AR6003_HW_2_0_PATCH_FILE                "data.patch.bin"
 179 #define AR6003_HW_2_0_BOARD_DATA_FILE AR6003_HW_2_0_FW_DIR "/bdata.bin"
 180 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
 181                         AR6003_HW_2_0_FW_DIR "/bdata.SD31.bin"
 182
 183 /* AR6003 3.0 definitions */
 184 #define AR6003_HW_2_1_1_VERSION                 0x30000582
 185 #define AR6003_HW_2_1_1_FW_DIR                  "ath6k/AR6003/hw2.1.1"
 186 #define AR6003_HW_2_1_1_OTP_FILE                "otp.bin"
 187 #define AR6003_HW_2_1_1_FIRMWARE_FILE           "athwlan.bin"
 188 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE      "athtcmd_ram.bin"
 189 #define AR6003_HW_2_1_1_UTF_FIRMWARE_FILE       "utf.bin"
 190 #define AR6003_HW_2_1_1_TESTSCRIPT_FILE "nullTestFlow.bin"
 191 #define AR6003_HW_2_1_1_PATCH_FILE              "data.patch.bin"
 192 #define AR6003_HW_2_1_1_BOARD_DATA_FILE AR6003_HW_2_1_1_FW_DIR "/bdata.bin"
 193 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE \
 194                         AR6003_HW_2_1_1_FW_DIR "/bdata.SD31.bin"
 195
 196 /* AR6004 1.0 definitions */
 197 #define AR6004_HW_1_0_VERSION                 0x30000623
 198 #define AR6004_HW_1_0_FW_DIR                    "ath6k/AR6004/hw1.0"
 199 #define AR6004_HW_1_0_FIRMWARE_FILE             "fw.ram.bin"
 200 #define AR6004_HW_1_0_BOARD_DATA_FILE         AR6004_HW_1_0_FW_DIR "/bdata.bin"
 201 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
 202         AR6004_HW_1_0_FW_DIR "/bdata.DB132.bin"
 203
 204 /* AR6004 1.1 definitions */
 205 #define AR6004_HW_1_1_VERSION                 0x30000001
 206 #define AR6004_HW_1_1_FW_DIR                    "ath6k/AR6004/hw1.1"
 207 #define AR6004_HW_1_1_FIRMWARE_FILE             "fw.ram.bin"
 208 #define AR6004_HW_1_1_BOARD_DATA_FILE         AR6004_HW_1_1_FW_DIR "/bdata.bin"
 209 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
 210         AR6004_HW_1_1_FW_DIR "/bdata.DB132.bin"
 211
 212 /* AR6004 1.2 definitions */
 213 #define AR6004_HW_1_2_VERSION                 0x300007e8
 214 #define AR6004_HW_1_2_FW_DIR                    "ath6k/AR6004/hw1.2"
 215 #define AR6004_HW_1_2_FIRMWARE_FILE           "fw.ram.bin"
 216 #define AR6004_HW_1_2_BOARD_DATA_FILE         AR6004_HW_1_2_FW_DIR "/bdata.bin"
 217 #define AR6004_HW_1_2_DEFAULT_BOARD_DATA_FILE \
 218         AR6004_HW_1_2_FW_DIR "/bdata.bin"
 219
 220 /* AR6004 1.3 definitions */
 221 #define AR6004_HW_1_3_VERSION                   0x31c8088a
 222 #define AR6004_HW_1_3_FW_DIR                    "ath6k/AR6004/hw1.3"
 223 #define AR6004_HW_1_3_FIRMWARE_FILE             "fw.ram.bin"
 224 #define AR6004_HW_1_3_BOARD_DATA_FILE           "ath6k/AR6004/hw1.3/bdata.bin"
 225 #define AR6004_HW_1_3_DEFAULT_BOARD_DATA_FILE   "ath6k/AR6004/hw1.3/bdata.bin"
 226
 227 /* Per STA data, used in AP mode */
 228 #define STA_PS_AWAKE            BIT(0)
 229 #define STA_PS_SLEEP            BIT(1)
 230 #define STA_PS_POLLED           BIT(2)
 231 #define STA_PS_APSD_TRIGGER     BIT(3)
 232 #define STA_PS_APSD_EOSP        BIT(4)
 233
 234 /* HTC TX packet tagging definitions */
 235 #define ATH6KL_CONTROL_PKT_TAG    HTC_TX_PACKET_TAG_USER_DEFINED
 236 #define ATH6KL_DATA_PKT_TAG       (ATH6KL_CONTROL_PKT_TAG + 1)
 237
 238 #define AR6003_CUST_DATA_SIZE 16
 239
 240 #define AGGR_WIN_IDX(x, y)          ((x) % (y))
 241 #define AGGR_INCR_IDX(x, y)         AGGR_WIN_IDX(((x) + 1), (y))
 242 #define AGGR_DCRM_IDX(x, y)         AGGR_WIN_IDX(((x) - 1), (y))
 243 #define ATH6KL_MAX_SEQ_NO               0xFFF
 244 #define ATH6KL_NEXT_SEQ_NO(x)           (((x) + 1) & ATH6KL_MAX_SEQ_NO)
 245
 246 #define NUM_OF_TIDS         8
 247 #define AGGR_SZ_DEFAULT     8
 248
 249 #define AGGR_WIN_SZ_MIN     2
 250 #define AGGR_WIN_SZ_MAX     8
 251
 252 #define TID_WINDOW_SZ(_x)   ((_x) << 1)
 253
 254 #define AGGR_NUM_OF_FREE_NETBUFS    16
 255
 256 #define AGGR_RX_TIMEOUT     100 /* in ms */
 257
 258 #define WMI_TIMEOUT (2 * HZ)
 259
 260 #define MBOX_YIELD_LIMIT 99
 261
 262 #define ATH6KL_DEFAULT_LISTEN_INTVAL    100 /* in TUs */
 263 #define ATH6KL_DEFAULT_BMISS_TIME       1500
 264 #define ATH6KL_MAX_WOW_LISTEN_INTL      300 /* in TUs */
 265 #define ATH6KL_MAX_BMISS_TIME           5000
 266
 267 /* configuration lags */
 268 /*
 269  * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
 270  * ERP IE of beacon to determine the short premable support when
 271  * sending (Re)Assoc req.
 272  * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
 273  * module state transition failure events which happen during
 274  * scan, to the host.
 275  */
 276 #define ATH6KL_CONF_IGNORE_ERP_BARKER           BIT(0)
 277 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN  BIT(1)
 278 #define ATH6KL_CONF_ENABLE_11N                  BIT(2)
 279 #define ATH6KL_CONF_ENABLE_TX_BURST             BIT(3)
 280 #define ATH6KL_CONF_UART_DEBUG                  BIT(4)
 281
 282 #define P2P_WILDCARD_SSID_LEN                   7 /* DIRECT- */
 283
 284 enum wlan_low_pwr_state {
 285         WLAN_POWER_STATE_ON,
 286         WLAN_POWER_STATE_CUT_PWR,
 287         WLAN_POWER_STATE_DEEP_SLEEP,
 288         WLAN_POWER_STATE_WOW
 289 };
 290
 291 enum sme_state {
 292         SME_DISCONNECTED,
 293         SME_CONNECTING,
 294         SME_CONNECTED
 295 };
 296
 297 struct skb_hold_q {
 298         struct sk_buff *skb;
 299         bool is_amsdu;
 300         u16 seq_no;
 301 };
 302
 303 struct rxtid {
 304         bool aggr;
 305         bool timer_mon;
 306         u16 win_sz;
 307         u16 seq_next;
 308         u32 hold_q_sz;
 309         struct skb_hold_q *hold_q;
 310         struct sk_buff_head q;
 311
 312         /*
 313          * lock mainly protects seq_next and hold_q. Movement of seq_next
 314          * needs to be protected between aggr_timeout() and
 315          * aggr_process_recv_frm(). hold_q will be holding the pending
 316          * reorder frames and it's access should also be protected.
 317          * Some of the other fields like hold_q_sz, win_sz and aggr are
 318          * initialized/reset when receiving addba/delba req, also while
 319          * deleting aggr state all the pending buffers are flushed before
 320          * resetting these fields, so there should not be any race in accessing
 321          * these fields.
 322          */
 323         spinlock_t lock;
 324 };
 325
 326 struct rxtid_stats {
 327         u32 num_into_aggr;
 328         u32 num_dups;
 329         u32 num_oow;
 330         u32 num_mpdu;
 331         u32 num_amsdu;
 332         u32 num_delivered;
 333         u32 num_timeouts;
 334         u32 num_hole;
 335         u32 num_bar;
 336 };
 337
 338 struct aggr_info_conn {
 339         u8 aggr_sz;
 340         u8 timer_scheduled;
 341         struct timer_list timer;
 342         struct net_device *dev;
 343         struct rxtid rx_tid[NUM_OF_TIDS];
 344         struct rxtid_stats stat[NUM_OF_TIDS];
 345         struct aggr_info *aggr_info;
 346 };
 347
 348 struct aggr_info {
 349         struct aggr_info_conn *aggr_conn;
 350         struct sk_buff_head rx_amsdu_freeq;
 351 };
 352
 353 struct ath6kl_wep_key {
 354         u8 key_index;
 355         u8 key_len;
 356         u8 key[64];
 357 };
 358
 359 #define ATH6KL_KEY_SEQ_LEN 8
 360
 361 struct ath6kl_key {
 362         u8 key[WLAN_MAX_KEY_LEN];
 363         u8 key_len;
 364         u8 seq[ATH6KL_KEY_SEQ_LEN];
 365         u8 seq_len;
 366         u32 cipher;
 367 };
 368
 369 struct ath6kl_node_mapping {
 370         u8 mac_addr[ETH_ALEN];
 371         u8 ep_id;
 372         u8 tx_pend;
 373 };
 374
 375 struct ath6kl_cookie {
 376         struct sk_buff *skb;
 377         u32 map_no;
 378         struct htc_packet htc_pkt;
 379         struct ath6kl_cookie *arc_list_next;
 380 };
 381
 382 struct ath6kl_mgmt_buff {
 383         struct list_head list;
 384         u32 freq;
 385         u32 wait;
 386         u32 id;
 387         bool no_cck;
 388         size_t len;
 389         u8 buf[0];
 390 };
 391
 392 struct ath6kl_sta {
 393         u16 sta_flags;
 394         u8 mac[ETH_ALEN];
 395         u8 aid;
 396         u8 keymgmt;
 397         u8 ucipher;
 398         u8 auth;
 399         u8 wpa_ie[ATH6KL_MAX_IE];
 400         struct sk_buff_head psq;
 401
 402         /* protects psq, mgmt_psq, apsdq, and mgmt_psq_len fields */
 403         spinlock_t psq_lock;
 404
 405         struct list_head mgmt_psq;
 406         size_t mgmt_psq_len;
 407         u8 apsd_info;
 408         struct sk_buff_head apsdq;
 409         struct aggr_info_conn *aggr_conn;
 410 };
 411
 412 struct ath6kl_version {
 413         u32 target_ver;
 414         u32 wlan_ver;
 415         u32 abi_ver;
 416 };
 417
 418 struct ath6kl_bmi {
 419         u32 cmd_credits;
 420         bool done_sent;
 421         u8 *cmd_buf;
 422         u32 max_data_size;
 423         u32 max_cmd_size;
 424 };
 425
 426 struct target_stats {
 427         u64 tx_pkt;
 428         u64 tx_byte;
 429         u64 tx_ucast_pkt;
 430         u64 tx_ucast_byte;
 431         u64 tx_mcast_pkt;
 432         u64 tx_mcast_byte;
 433         u64 tx_bcast_pkt;
 434         u64 tx_bcast_byte;
 435         u64 tx_rts_success_cnt;
 436         u64 tx_pkt_per_ac[4];
 437
 438         u64 tx_err;
 439         u64 tx_fail_cnt;
 440         u64 tx_retry_cnt;
 441         u64 tx_mult_retry_cnt;
 442         u64 tx_rts_fail_cnt;
 443
 444         u64 rx_pkt;
 445         u64 rx_byte;
 446         u64 rx_ucast_pkt;
 447         u64 rx_ucast_byte;
 448         u64 rx_mcast_pkt;
 449         u64 rx_mcast_byte;
 450         u64 rx_bcast_pkt;
 451         u64 rx_bcast_byte;
 452         u64 rx_frgment_pkt;
 453
 454         u64 rx_err;
 455         u64 rx_crc_err;
 456         u64 rx_key_cache_miss;
 457         u64 rx_decrypt_err;
 458         u64 rx_dupl_frame;
 459
 460         u64 tkip_local_mic_fail;
 461         u64 tkip_cnter_measures_invoked;
 462         u64 tkip_replays;
 463         u64 tkip_fmt_err;
 464         u64 ccmp_fmt_err;
 465         u64 ccmp_replays;
 466
 467         u64 pwr_save_fail_cnt;
 468
 469         u64 cs_bmiss_cnt;
 470         u64 cs_low_rssi_cnt;
 471         u64 cs_connect_cnt;
 472         u64 cs_discon_cnt;
 473
 474         s32 tx_ucast_rate;
 475         s32 rx_ucast_rate;
 476
 477         u32 lq_val;
 478
 479         u32 wow_pkt_dropped;
 480         u16 wow_evt_discarded;
 481
 482         s16 noise_floor_calib;
 483         s16 cs_rssi;
 484         s16 cs_ave_beacon_rssi;
 485         u8 cs_ave_beacon_snr;
 486         u8 cs_last_roam_msec;
 487         u8 cs_snr;
 488
 489         u8 wow_host_pkt_wakeups;
 490         u8 wow_host_evt_wakeups;
 491
 492         u32 arp_received;
 493         u32 arp_matched;
 494         u32 arp_replied;
 495 };
 496
 497 struct ath6kl_mbox_info {
 498         u32 htc_addr;
 499         u32 htc_ext_addr;
 500         u32 htc_ext_sz;
 501
 502         u32 block_size;
 503
 504         u32 gmbox_addr;
 505
 506         u32 gmbox_sz;
 507 };
 508
 509 /*
 510  * 802.11i defines an extended IV for use with non-WEP ciphers.
 511  * When the EXTIV bit is set in the key id byte an additional
 512  * 4 bytes immediately follow the IV for TKIP.  For CCMP the
 513  * EXTIV bit is likewise set but the 8 bytes represent the
 514  * CCMP header rather than IV+extended-IV.
 515  */
 516
 517 #define ATH6KL_KEYBUF_SIZE 16
 518 #define ATH6KL_MICBUF_SIZE (8+8)        /* space for both tx and rx */
 519
 520 #define ATH6KL_KEY_XMIT  0x01
 521 #define ATH6KL_KEY_RECV  0x02
 522 #define ATH6KL_KEY_DEFAULT   0x80       /* default xmit key */
 523
 524 /* Initial group key for AP mode */
 525 struct ath6kl_req_key {
 526         bool valid;
 527         u8 key_index;
 528         int key_type;
 529         u8 key[WLAN_MAX_KEY_LEN];
 530         u8 key_len;
 531 };
 532
 533 enum ath6kl_hif_type {
 534         ATH6KL_HIF_TYPE_SDIO,
 535         ATH6KL_HIF_TYPE_USB,
 536 };
 537
 538 enum ath6kl_htc_type {
 539         ATH6KL_HTC_TYPE_MBOX,
 540         ATH6KL_HTC_TYPE_PIPE,
 541 };
 542
 543 /* Max number of filters that hw supports */
 544 #define ATH6K_MAX_MC_FILTERS_PER_LIST 7
 545 struct ath6kl_mc_filter {
 546         struct list_head list;
 547         char hw_addr[ATH6KL_MCAST_FILTER_MAC_ADDR_SIZE];
 548 };
 549
 550 struct ath6kl_htcap {
 551         bool ht_enable;
 552         u8 ampdu_factor;
 553         unsigned short cap_info;
 554 };
 555
 556 /*
 557  * Driver's maximum limit, note that some firmwares support only one vif
 558  * and the runtime (current) limit must be checked from ar->vif_max.
 559  */
 560 #define ATH6KL_VIF_MAX  3
 561
 562 /* vif flags info */
 563 enum ath6kl_vif_state {
 564         CONNECTED,
 565         CONNECT_PEND,
 566         WMM_ENABLED,
 567         NETQ_STOPPED,
 568         DTIM_EXPIRED,
 569         CLEAR_BSSFILTER_ON_BEACON,
 570         DTIM_PERIOD_AVAIL,
 571         WLAN_ENABLED,
 572         STATS_UPDATE_PEND,
 573         HOST_SLEEP_MODE_CMD_PROCESSED,
 574         NETDEV_MCAST_ALL_ON,
 575         NETDEV_MCAST_ALL_OFF,
 576         SCHED_SCANNING,
 577 };
 578
 579 struct ath6kl_vif {
 580         struct list_head list;
 581         struct wireless_dev wdev;
 582         struct net_device *ndev;
 583         struct ath6kl *ar;
 584         /* Lock to protect vif specific net_stats and flags */
 585         spinlock_t if_lock;
 586         u8 fw_vif_idx;
 587         unsigned long flags;
 588         int ssid_len;
 589         u8 ssid[IEEE80211_MAX_SSID_LEN];
 590         u8 dot11_auth_mode;
 591         u8 auth_mode;
 592         u8 prwise_crypto;
 593         u8 prwise_crypto_len;
 594         u8 grp_crypto;
 595         u8 grp_crypto_len;
 596         u8 def_txkey_index;
 597         u8 next_mode;
 598         u8 nw_type;
 599         u8 bssid[ETH_ALEN];
 600         u8 req_bssid[ETH_ALEN];
 601         u16 ch_hint;
 602         u16 bss_ch;
 603         struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
 604         struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
 605         struct aggr_info *aggr_cntxt;
 606         struct ath6kl_htcap htcap[IEEE80211_NUM_BANDS];
 607
 608         struct timer_list disconnect_timer;
 609         struct timer_list sched_scan_timer;
 610
 611         struct cfg80211_scan_request *scan_req;
 612         enum sme_state sme_state;
 613         int reconnect_flag;
 614         u32 last_roc_id;
 615         u32 last_cancel_roc_id;
 616         u32 send_action_id;
 617         bool probe_req_report;
 618         u16 assoc_bss_beacon_int;
 619         u16 listen_intvl_t;
 620         u16 bmiss_time_t;
 621         u32 txe_intvl;
 622         u16 bg_scan_period;
 623         u8 assoc_bss_dtim_period;
 624         struct net_device_stats net_stats;
 625         struct target_stats target_stats;
 626         struct wmi_connect_cmd profile;
 627         u16 rsn_capab;
 628
 629         struct list_head mc_filter;
 630 };
 631
 632 static inline struct ath6kl_vif *ath6kl_vif_from_wdev(struct wireless_dev *wdev)
 633 {
 634         return container_of(wdev, struct ath6kl_vif, wdev);
 635 }
 636
 637 #define WOW_LIST_ID             0
 638 #define WOW_HOST_REQ_DELAY      500 /* ms */
 639
 640 #define ATH6KL_SCHED_SCAN_RESULT_DELAY 5000 /* ms */
 641
 642 /* Flag info */
 643 enum ath6kl_dev_state {
 644         WMI_ENABLED,
 645         WMI_READY,
 646         WMI_CTRL_EP_FULL,
 647         TESTMODE,
 648         DESTROY_IN_PROGRESS,
 649         SKIP_SCAN,
 650         ROAM_TBL_PEND,
 651         FIRST_BOOT,
 652         RECOVERY_CLEANUP,
 653 };
 654
 655 enum ath6kl_state {
 656         ATH6KL_STATE_OFF,
 657         ATH6KL_STATE_ON,
 658         ATH6KL_STATE_SUSPENDING,
 659         ATH6KL_STATE_RESUMING,
 660         ATH6KL_STATE_DEEPSLEEP,
 661         ATH6KL_STATE_CUTPOWER,
 662         ATH6KL_STATE_WOW,
 663         ATH6KL_STATE_RECOVERY,
 664 };
 665
 666 /* Fw error recovery */
 667 #define ATH6KL_HB_RESP_MISS_THRES       5
 668
 669 enum ath6kl_fw_err {
 670         ATH6KL_FW_ASSERT,
 671         ATH6KL_FW_HB_RESP_FAILURE,
 672         ATH6KL_FW_EP_FULL,
 673 };
 674
 675 struct ath6kl {
 676         struct device *dev;
 677         struct wiphy *wiphy;
 678
 679         enum ath6kl_state state;
 680         unsigned int testmode;
 681
 682         struct ath6kl_bmi bmi;
 683         const struct ath6kl_hif_ops *hif_ops;
 684         const struct ath6kl_htc_ops *htc_ops;
 685         struct wmi *wmi;
 686         int tx_pending[ENDPOINT_MAX];
 687         int total_tx_data_pend;
 688         struct htc_target *htc_target;
 689         enum ath6kl_hif_type hif_type;
 690         void *hif_priv;
 691         struct list_head vif_list;
 692         /* Lock to avoid race in vif_list entries among add/del/traverse */
 693         spinlock_t list_lock;
 694         u8 num_vif;
 695         unsigned int vif_max;
 696         u8 max_norm_iface;
 697         u8 avail_idx_map;
 698
 699         /*
 700          * Protects at least amsdu_rx_buffer_queue, ath6kl_alloc_cookie()
 701          * calls, tx_pending and total_tx_data_pend.
 702          */
 703         spinlock_t lock;
 704
 705         struct semaphore sem;
 706         u8 lrssi_roam_threshold;
 707         struct ath6kl_version version;
 708         u32 target_type;
 709         u8 tx_pwr;
 710         struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
 711         u8 ibss_ps_enable;
 712         bool ibss_if_active;
 713         u8 node_num;
 714         u8 next_ep_id;
 715         struct ath6kl_cookie *cookie_list;
 716         u32 cookie_count;
 717         enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
 718         bool ac_stream_active[WMM_NUM_AC];
 719         u8 ac_stream_pri_map[WMM_NUM_AC];
 720         u8 hiac_stream_active_pri;
 721         u8 ep2ac_map[ENDPOINT_MAX];
 722         enum htc_endpoint_id ctrl_ep;
 723         struct ath6kl_htc_credit_info credit_state_info;
 724         u32 connect_ctrl_flags;
 725         u32 user_key_ctrl;
 726         u8 usr_bss_filter;
 727         struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
 728         u8 sta_list_index;
 729         struct ath6kl_req_key ap_mode_bkey;
 730         struct sk_buff_head mcastpsq;
 731         u32 want_ch_switch;
 732         u16 last_ch;
 733
 734         /*
 735          * FIXME: protects access to mcastpsq but is actually useless as
 736          * all skbe_queue_*() functions provide serialisation themselves
 737          */
 738         spinlock_t mcastpsq_lock;
 739
 740         u8 intra_bss;
 741         struct wmi_ap_mode_stat ap_stats;
 742         u8 ap_country_code[3];
 743         struct list_head amsdu_rx_buffer_queue;
 744         u8 rx_meta_ver;
 745         enum wlan_low_pwr_state wlan_pwr_state;
 746         u8 mac_addr[ETH_ALEN];
 747 #define AR_MCAST_FILTER_MAC_ADDR_SIZE  4
 748         struct {
 749                 void *rx_report;
 750                 size_t rx_report_len;
 751         } tm;
 752
 753         struct ath6kl_hw {
 754                 u32 id;
 755                 const char *name;
 756                 u32 dataset_patch_addr;
 757                 u32 app_load_addr;
 758                 u32 app_start_override_addr;
 759                 u32 board_ext_data_addr;
 760                 u32 reserved_ram_size;
 761                 u32 board_addr;
 762                 u32 refclk_hz;
 763                 u32 uarttx_pin;
 764                 u32 testscript_addr;
 765                 enum wmi_phy_cap cap;
 766
 767                 u32 flags;
 768
 769                 struct ath6kl_hw_fw {
 770                         const char *dir;
 771                         const char *otp;
 772                         const char *fw;
 773                         const char *tcmd;
 774                         const char *patch;
 775                         const char *utf;
 776                         const char *testscript;
 777                 } fw;
 778
 779                 const char *fw_board;
 780                 const char *fw_default_board;
 781         } hw;
 782
 783         u16 conf_flags;
 784         u16 suspend_mode;
 785         u16 wow_suspend_mode;
 786         wait_queue_head_t event_wq;
 787         struct ath6kl_mbox_info mbox_info;
 788
 789         struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
 790         unsigned long flag;
 791
 792         u8 *fw_board;
 793         size_t fw_board_len;
 794
 795         u8 *fw_otp;
 796         size_t fw_otp_len;
 797
 798         u8 *fw;
 799         size_t fw_len;
 800
 801         u8 *fw_patch;
 802         size_t fw_patch_len;
 803
 804         u8 *fw_testscript;
 805         size_t fw_testscript_len;
 806
 807         unsigned int fw_api;
 808         unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
 809
 810         struct workqueue_struct *ath6kl_wq;
 811
 812         struct dentry *debugfs_phy;
 813
 814         bool p2p;
 815
 816         bool wiphy_registered;
 817
 818         struct ath6kl_fw_recovery {
 819                 struct work_struct recovery_work;
 820                 unsigned long err_reason;
 821                 unsigned long hb_poll;
 822                 struct timer_list hb_timer;
 823                 u32 seq_num;
 824                 bool hb_pending;
 825                 u8 hb_misscnt;
 826                 bool enable;
 827         } fw_recovery;
 828
 829 #ifdef CONFIG_ATH6KL_DEBUG
 830         struct {
 831                 struct sk_buff_head fwlog_queue;
 832                 struct completion fwlog_completion;
 833                 bool fwlog_open;
 834
 835                 u32 fwlog_mask;
 836
 837                 unsigned int dbgfs_diag_reg;
 838                 u32 diag_reg_addr_wr;
 839                 u32 diag_reg_val_wr;
 840
 841                 struct {
 842                         unsigned int invalid_rate;
 843                 } war_stats;
 844
 845                 u8 *roam_tbl;
 846                 unsigned int roam_tbl_len;
 847
 848                 u8 keepalive;
 849                 u8 disc_timeout;
 850         } debug;
 851 #endif /* CONFIG_ATH6KL_DEBUG */
 852 };
 853
 854 static inline struct ath6kl *ath6kl_priv(struct net_device *dev)
 855 {
 856         return ((struct ath6kl_vif *) netdev_priv(dev))->ar;
 857 }
 858
 859 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
 860                                           u32 item_offset)
 861 {
 862         u32 addr = 0;
 863
 864         if (ar->target_type == TARGET_TYPE_AR6003)
 865                 addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
 866         else if (ar->target_type == TARGET_TYPE_AR6004)
 867                 addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
 868
 869         return addr;
 870 }
 871
 872 int ath6kl_configure_target(struct ath6kl *ar);
 873 void ath6kl_detect_error(unsigned long ptr);
 874 void disconnect_timer_handler(unsigned long ptr);
 875 void init_netdev(struct net_device *dev);
 876 void ath6kl_cookie_init(struct ath6kl *ar);
 877 void ath6kl_cookie_cleanup(struct ath6kl *ar);
 878 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
 879 void ath6kl_tx_complete(struct htc_target *context,
 880                         struct list_head *packet_queue);
 881 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
 882                                                struct htc_packet *packet);
 883 void ath6kl_stop_txrx(struct ath6kl *ar);
 884 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
 885 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
 886 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
 887 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
 888 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
 889 int ath6kl_read_fwlogs(struct ath6kl *ar);
 890 void ath6kl_init_profile_info(struct ath6kl_vif *vif);
 891 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
 892
 893 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
 894 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
 895 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
 896
 897 struct aggr_info *aggr_init(struct ath6kl_vif *vif);
 898 void aggr_conn_init(struct ath6kl_vif *vif, struct aggr_info *aggr_info,
 899                     struct aggr_info_conn *aggr_conn);
 900 void ath6kl_rx_refill(struct htc_target *target,
 901                       enum htc_endpoint_id endpoint);
 902 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
 903 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
 904                                             enum htc_endpoint_id endpoint,
 905                                             int len);
 906 void aggr_module_destroy(struct aggr_info *aggr_info);
 907 void aggr_reset_state(struct aggr_info_conn *aggr_conn);
 908
 909 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl_vif *vif, u8 *node_addr);
 910 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
 911
 912 void ath6kl_ready_event(void *devt, u8 *datap, u32 sw_ver, u32 abi_ver,
 913                         enum wmi_phy_cap cap);
 914 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
 915                       enum htc_endpoint_id eid);
 916 void ath6kl_connect_event(struct ath6kl_vif *vif, u16 channel,
 917                           u8 *bssid, u16 listen_int,
 918                           u16 beacon_int, enum network_type net_type,
 919                           u8 beacon_ie_len, u8 assoc_req_len,
 920                           u8 assoc_resp_len, u8 *assoc_info);
 921 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif *vif, u16 channel);
 922 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif *vif, u16 aid, u8 *mac_addr,
 923                                 u8 keymgmt, u8 ucipher, u8 auth,
 924                                 u8 assoc_req_len, u8 *assoc_info, u8 apsd_info);
 925 void ath6kl_disconnect_event(struct ath6kl_vif *vif, u8 reason,
 926                              u8 *bssid, u8 assoc_resp_len,
 927                              u8 *assoc_info, u16 prot_reason_status);
 928 void ath6kl_tkip_micerr_event(struct ath6kl_vif *vif, u8 keyid, bool ismcast);
 929 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
 930 void ath6kl_scan_complete_evt(struct ath6kl_vif *vif, int status);
 931 void ath6kl_tgt_stats_event(struct ath6kl_vif *vif, u8 *ptr, u32 len);
 932 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
 933 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
 934
 935 void ath6kl_pspoll_event(struct ath6kl_vif *vif, u8 aid);
 936
 937 void ath6kl_dtimexpiry_event(struct ath6kl_vif *vif);
 938 void ath6kl_disconnect(struct ath6kl_vif *vif);
 939 void aggr_recv_delba_req_evt(struct ath6kl_vif *vif, u8 tid);
 940 void aggr_recv_addba_req_evt(struct ath6kl_vif *vif, u8 tid, u16 seq_no,
 941                              u8 win_sz);
 942 void ath6kl_wakeup_event(void *dev);
 943
 944 void ath6kl_init_control_info(struct ath6kl_vif *vif);
 945 struct ath6kl_vif *ath6kl_vif_first(struct ath6kl *ar);
 946 void ath6kl_cfg80211_vif_stop(struct ath6kl_vif *vif, bool wmi_ready);
 947 int ath6kl_init_hw_start(struct ath6kl *ar);
 948 int ath6kl_init_hw_stop(struct ath6kl *ar);
 949 int ath6kl_init_fetch_firmwares(struct ath6kl *ar);
 950 int ath6kl_init_hw_params(struct ath6kl *ar);
 951
 952 void ath6kl_check_wow_status(struct ath6kl *ar);
 953
 954 void ath6kl_core_tx_complete(struct ath6kl *ar, struct sk_buff *skb);
 955 void ath6kl_core_rx_complete(struct ath6kl *ar, struct sk_buff *skb, u8 pipe);
 956
 957 struct ath6kl *ath6kl_core_create(struct device *dev);
 958 int ath6kl_core_init(struct ath6kl *ar, enum ath6kl_htc_type htc_type);
 959 void ath6kl_core_cleanup(struct ath6kl *ar);
 960 void ath6kl_core_destroy(struct ath6kl *ar);
 961
 962 /* Fw error recovery */
 963 void ath6kl_init_hw_restart(struct ath6kl *ar);
 964 void ath6kl_recovery_err_notify(struct ath6kl *ar, enum ath6kl_fw_err reason);
 965 void ath6kl_recovery_hb_event(struct ath6kl *ar, u32 cookie);
 966 void ath6kl_recovery_init(struct ath6kl *ar);
 967 void ath6kl_recovery_cleanup(struct ath6kl *ar);
 968 void ath6kl_recovery_suspend(struct ath6kl *ar);
 969 void ath6kl_recovery_resume(struct ath6kl *ar);
 970 #endif /* CORE_H */