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         /* this needs to be last */
 104         ATH6KL_FW_CAPABILITY_MAX,
 105 };
 106
 107 #define ATH6KL_CAPABILITY_LEN (ALIGN(ATH6KL_FW_CAPABILITY_MAX, 32) / 32)
 108
 109 struct ath6kl_fw_ie {
 110         __le32 id;
 111         __le32 len;
 112         u8 data[0];
 113 };
 114
 115 #define ATH6KL_FW_API2_FILE "fw-2.bin"
 116 #define ATH6KL_FW_API3_FILE "fw-3.bin"
 117
 118 /* AR6003 1.0 definitions */
 119 #define AR6003_HW_1_0_VERSION                 0x300002ba
 120
 121 /* AR6003 2.0 definitions */
 122 #define AR6003_HW_2_0_VERSION                 0x30000384
 123 #define AR6003_HW_2_0_PATCH_DOWNLOAD_ADDRESS  0x57e910
 124 #define AR6003_HW_2_0_FW_DIR                    "ath6k/AR6003/hw2.0"
 125 #define AR6003_HW_2_0_OTP_FILE                  "otp.bin.z77"
 126 #define AR6003_HW_2_0_FIRMWARE_FILE             "athwlan.bin.z77"
 127 #define AR6003_HW_2_0_TCMD_FIRMWARE_FILE        "athtcmd_ram.bin"
 128 #define AR6003_HW_2_0_PATCH_FILE                "data.patch.bin"
 129 #define AR6003_HW_2_0_BOARD_DATA_FILE "ath6k/AR6003/hw2.0/bdata.bin"
 130 #define AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE \
 131                         "ath6k/AR6003/hw2.0/bdata.SD31.bin"
 132
 133 /* AR6003 3.0 definitions */
 134 #define AR6003_HW_2_1_1_VERSION                 0x30000582
 135 #define AR6003_HW_2_1_1_FW_DIR                  "ath6k/AR6003/hw2.1.1"
 136 #define AR6003_HW_2_1_1_OTP_FILE                "otp.bin"
 137 #define AR6003_HW_2_1_1_FIRMWARE_FILE           "athwlan.bin"
 138 #define AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE      "athtcmd_ram.bin"
 139 #define AR6003_HW_2_1_1_UTF_FIRMWARE_FILE       "utf.bin"
 140 #define AR6003_HW_2_1_1_TESTSCRIPT_FILE "nullTestFlow.bin"
 141 #define AR6003_HW_2_1_1_PATCH_FILE              "data.patch.bin"
 142 #define AR6003_HW_2_1_1_BOARD_DATA_FILE "ath6k/AR6003/hw2.1.1/bdata.bin"
 143 #define AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE \
 144                         "ath6k/AR6003/hw2.1.1/bdata.SD31.bin"
 145
 146 /* AR6004 1.0 definitions */
 147 #define AR6004_HW_1_0_VERSION                 0x30000623
 148 #define AR6004_HW_1_0_FW_DIR                    "ath6k/AR6004/hw1.0"
 149 #define AR6004_HW_1_0_FIRMWARE_FILE             "fw.ram.bin"
 150 #define AR6004_HW_1_0_BOARD_DATA_FILE         "ath6k/AR6004/hw1.0/bdata.bin"
 151 #define AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE \
 152         "ath6k/AR6004/hw1.0/bdata.DB132.bin"
 153
 154 /* AR6004 1.1 definitions */
 155 #define AR6004_HW_1_1_VERSION                 0x30000001
 156 #define AR6004_HW_1_1_FW_DIR                    "ath6k/AR6004/hw1.1"
 157 #define AR6004_HW_1_1_FIRMWARE_FILE             "fw.ram.bin"
 158 #define AR6004_HW_1_1_BOARD_DATA_FILE         "ath6k/AR6004/hw1.1/bdata.bin"
 159 #define AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE \
 160         "ath6k/AR6004/hw1.1/bdata.DB132.bin"
 161
 162 /* Per STA data, used in AP mode */
 163 #define STA_PS_AWAKE            BIT(0)
 164 #define STA_PS_SLEEP            BIT(1)
 165 #define STA_PS_POLLED           BIT(2)
 166 #define STA_PS_APSD_TRIGGER     BIT(3)
 167 #define STA_PS_APSD_EOSP        BIT(4)
 168
 169 /* HTC TX packet tagging definitions */
 170 #define ATH6KL_CONTROL_PKT_TAG    HTC_TX_PACKET_TAG_USER_DEFINED
 171 #define ATH6KL_DATA_PKT_TAG       (ATH6KL_CONTROL_PKT_TAG + 1)
 172
 173 #define AR6003_CUST_DATA_SIZE 16
 174
 175 #define AGGR_WIN_IDX(x, y)          ((x) % (y))
 176 #define AGGR_INCR_IDX(x, y)         AGGR_WIN_IDX(((x) + 1), (y))
 177 #define AGGR_DCRM_IDX(x, y)         AGGR_WIN_IDX(((x) - 1), (y))
 178 #define ATH6KL_MAX_SEQ_NO               0xFFF
 179 #define ATH6KL_NEXT_SEQ_NO(x)           (((x) + 1) & ATH6KL_MAX_SEQ_NO)
 180
 181 #define NUM_OF_TIDS         8
 182 #define AGGR_SZ_DEFAULT     8
 183
 184 #define AGGR_WIN_SZ_MIN     2
 185 #define AGGR_WIN_SZ_MAX     8
 186
 187 #define TID_WINDOW_SZ(_x)   ((_x) << 1)
 188
 189 #define AGGR_NUM_OF_FREE_NETBUFS    16
 190
 191 #define AGGR_RX_TIMEOUT     400 /* in ms */
 192
 193 #define WMI_TIMEOUT (2 * HZ)
 194
 195 #define MBOX_YIELD_LIMIT 99
 196
 197 #define ATH6KL_DEFAULT_LISTEN_INTVAL    100 /* in TUs */
 198 #define ATH6KL_DEFAULT_BMISS_TIME       1500
 199 #define ATH6KL_MAX_WOW_LISTEN_INTL      300 /* in TUs */
 200 #define ATH6KL_MAX_BMISS_TIME           5000
 201
 202 /* configuration lags */
 203 /*
 204  * ATH6KL_CONF_IGNORE_ERP_BARKER: Ignore the barker premable in
 205  * ERP IE of beacon to determine the short premable support when
 206  * sending (Re)Assoc req.
 207  * ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN: Don't send the power
 208  * module state transition failure events which happen during
 209  * scan, to the host.
 210  */
 211 #define ATH6KL_CONF_IGNORE_ERP_BARKER           BIT(0)
 212 #define ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN  BIT(1)
 213 #define ATH6KL_CONF_ENABLE_11N                  BIT(2)
 214 #define ATH6KL_CONF_ENABLE_TX_BURST             BIT(3)
 215 #define ATH6KL_CONF_UART_DEBUG                  BIT(4)
 216
 217 #define P2P_WILDCARD_SSID_LEN                   7 /* DIRECT- */
 218
 219 enum wlan_low_pwr_state {
 220         WLAN_POWER_STATE_ON,
 221         WLAN_POWER_STATE_CUT_PWR,
 222         WLAN_POWER_STATE_DEEP_SLEEP,
 223         WLAN_POWER_STATE_WOW
 224 };
 225
 226 enum sme_state {
 227         SME_DISCONNECTED,
 228         SME_CONNECTING,
 229         SME_CONNECTED
 230 };
 231
 232 struct skb_hold_q {
 233         struct sk_buff *skb;
 234         bool is_amsdu;
 235         u16 seq_no;
 236 };
 237
 238 struct rxtid {
 239         bool aggr;
 240         bool progress;
 241         bool timer_mon;
 242         u16 win_sz;
 243         u16 seq_next;
 244         u32 hold_q_sz;
 245         struct skb_hold_q *hold_q;
 246         struct sk_buff_head q;
 247
 248         /*
 249          * FIXME: No clue what this should protect. Apparently it should
 250          * protect some of the fields above but they are also accessed
 251          * without taking the lock.
 252          */
 253         spinlock_t lock;
 254 };
 255
 256 struct rxtid_stats {
 257         u32 num_into_aggr;
 258         u32 num_dups;
 259         u32 num_oow;
 260         u32 num_mpdu;
 261         u32 num_amsdu;
 262         u32 num_delivered;
 263         u32 num_timeouts;
 264         u32 num_hole;
 265         u32 num_bar;
 266 };
 267
 268 struct aggr_info_conn {
 269         u8 aggr_sz;
 270         u8 timer_scheduled;
 271         struct timer_list timer;
 272         struct net_device *dev;
 273         struct rxtid rx_tid[NUM_OF_TIDS];
 274         struct rxtid_stats stat[NUM_OF_TIDS];
 275         struct aggr_info *aggr_info;
 276 };
 277
 278 struct aggr_info {
 279         struct aggr_info_conn *aggr_conn;
 280         struct sk_buff_head rx_amsdu_freeq;
 281 };
 282
 283 struct ath6kl_wep_key {
 284         u8 key_index;
 285         u8 key_len;
 286         u8 key[64];
 287 };
 288
 289 #define ATH6KL_KEY_SEQ_LEN 8
 290
 291 struct ath6kl_key {
 292         u8 key[WLAN_MAX_KEY_LEN];
 293         u8 key_len;
 294         u8 seq[ATH6KL_KEY_SEQ_LEN];
 295         u8 seq_len;
 296         u32 cipher;
 297 };
 298
 299 struct ath6kl_node_mapping {
 300         u8 mac_addr[ETH_ALEN];
 301         u8 ep_id;
 302         u8 tx_pend;
 303 };
 304
 305 struct ath6kl_cookie {
 306         struct sk_buff *skb;
 307         u32 map_no;
 308         struct htc_packet htc_pkt;
 309         struct ath6kl_cookie *arc_list_next;
 310 };
 311
 312 struct ath6kl_mgmt_buff {
 313         struct list_head list;
 314         u32 freq;
 315         u32 wait;
 316         u32 id;
 317         bool no_cck;
 318         size_t len;
 319         u8 buf[0];
 320 };
 321
 322 struct ath6kl_sta {
 323         u16 sta_flags;
 324         u8 mac[ETH_ALEN];
 325         u8 aid;
 326         u8 keymgmt;
 327         u8 ucipher;
 328         u8 auth;
 329         u8 wpa_ie[ATH6KL_MAX_IE];
 330         struct sk_buff_head psq;
 331
 332         /* protects psq, mgmt_psq, apsdq, and mgmt_psq_len fields */
 333         spinlock_t psq_lock;
 334
 335         struct list_head mgmt_psq;
 336         size_t mgmt_psq_len;
 337         u8 apsd_info;
 338         struct sk_buff_head apsdq;
 339         struct aggr_info_conn *aggr_conn;
 340 };
 341
 342 struct ath6kl_version {
 343         u32 target_ver;
 344         u32 wlan_ver;
 345         u32 abi_ver;
 346 };
 347
 348 struct ath6kl_bmi {
 349         u32 cmd_credits;
 350         bool done_sent;
 351         u8 *cmd_buf;
 352         u32 max_data_size;
 353         u32 max_cmd_size;
 354 };
 355
 356 struct target_stats {
 357         u64 tx_pkt;
 358         u64 tx_byte;
 359         u64 tx_ucast_pkt;
 360         u64 tx_ucast_byte;
 361         u64 tx_mcast_pkt;
 362         u64 tx_mcast_byte;
 363         u64 tx_bcast_pkt;
 364         u64 tx_bcast_byte;
 365         u64 tx_rts_success_cnt;
 366         u64 tx_pkt_per_ac[4];
 367
 368         u64 tx_err;
 369         u64 tx_fail_cnt;
 370         u64 tx_retry_cnt;
 371         u64 tx_mult_retry_cnt;
 372         u64 tx_rts_fail_cnt;
 373
 374         u64 rx_pkt;
 375         u64 rx_byte;
 376         u64 rx_ucast_pkt;
 377         u64 rx_ucast_byte;
 378         u64 rx_mcast_pkt;
 379         u64 rx_mcast_byte;
 380         u64 rx_bcast_pkt;
 381         u64 rx_bcast_byte;
 382         u64 rx_frgment_pkt;
 383
 384         u64 rx_err;
 385         u64 rx_crc_err;
 386         u64 rx_key_cache_miss;
 387         u64 rx_decrypt_err;
 388         u64 rx_dupl_frame;
 389
 390         u64 tkip_local_mic_fail;
 391         u64 tkip_cnter_measures_invoked;
 392         u64 tkip_replays;
 393         u64 tkip_fmt_err;
 394         u64 ccmp_fmt_err;
 395         u64 ccmp_replays;
 396
 397         u64 pwr_save_fail_cnt;
 398
 399         u64 cs_bmiss_cnt;
 400         u64 cs_low_rssi_cnt;
 401         u64 cs_connect_cnt;
 402         u64 cs_discon_cnt;
 403
 404         s32 tx_ucast_rate;
 405         s32 rx_ucast_rate;
 406
 407         u32 lq_val;
 408
 409         u32 wow_pkt_dropped;
 410         u16 wow_evt_discarded;
 411
 412         s16 noise_floor_calib;
 413         s16 cs_rssi;
 414         s16 cs_ave_beacon_rssi;
 415         u8 cs_ave_beacon_snr;
 416         u8 cs_last_roam_msec;
 417         u8 cs_snr;
 418
 419         u8 wow_host_pkt_wakeups;
 420         u8 wow_host_evt_wakeups;
 421
 422         u32 arp_received;
 423         u32 arp_matched;
 424         u32 arp_replied;
 425 };
 426
 427 struct ath6kl_mbox_info {
 428         u32 htc_addr;
 429         u32 htc_ext_addr;
 430         u32 htc_ext_sz;
 431
 432         u32 block_size;
 433
 434         u32 gmbox_addr;
 435
 436         u32 gmbox_sz;
 437 };
 438
 439 /*
 440  * 802.11i defines an extended IV for use with non-WEP ciphers.
 441  * When the EXTIV bit is set in the key id byte an additional
 442  * 4 bytes immediately follow the IV for TKIP.  For CCMP the
 443  * EXTIV bit is likewise set but the 8 bytes represent the
 444  * CCMP header rather than IV+extended-IV.
 445  */
 446
 447 #define ATH6KL_KEYBUF_SIZE 16
 448 #define ATH6KL_MICBUF_SIZE (8+8)        /* space for both tx and rx */
 449
 450 #define ATH6KL_KEY_XMIT  0x01
 451 #define ATH6KL_KEY_RECV  0x02
 452 #define ATH6KL_KEY_DEFAULT   0x80       /* default xmit key */
 453
 454 /* Initial group key for AP mode */
 455 struct ath6kl_req_key {
 456         bool valid;
 457         u8 key_index;
 458         int key_type;
 459         u8 key[WLAN_MAX_KEY_LEN];
 460         u8 key_len;
 461 };
 462
 463 enum ath6kl_hif_type {
 464         ATH6KL_HIF_TYPE_SDIO,
 465         ATH6KL_HIF_TYPE_USB,
 466 };
 467
 468 enum ath6kl_htc_type {
 469         ATH6KL_HTC_TYPE_MBOX,
 470         ATH6KL_HTC_TYPE_PIPE,
 471 };
 472
 473 /* Max number of filters that hw supports */
 474 #define ATH6K_MAX_MC_FILTERS_PER_LIST 7
 475 struct ath6kl_mc_filter {
 476         struct list_head list;
 477         char hw_addr[ATH6KL_MCAST_FILTER_MAC_ADDR_SIZE];
 478 };
 479
 480 struct ath6kl_htcap {
 481         bool ht_enable;
 482         u8 ampdu_factor;
 483         unsigned short cap_info;
 484 };
 485
 486 /*
 487  * Driver's maximum limit, note that some firmwares support only one vif
 488  * and the runtime (current) limit must be checked from ar->vif_max.
 489  */
 490 #define ATH6KL_VIF_MAX  3
 491
 492 /* vif flags info */
 493 enum ath6kl_vif_state {
 494         CONNECTED,
 495         CONNECT_PEND,
 496         WMM_ENABLED,
 497         NETQ_STOPPED,
 498         DTIM_EXPIRED,
 499         NETDEV_REGISTERED,
 500         CLEAR_BSSFILTER_ON_BEACON,
 501         DTIM_PERIOD_AVAIL,
 502         WLAN_ENABLED,
 503         STATS_UPDATE_PEND,
 504         HOST_SLEEP_MODE_CMD_PROCESSED,
 505 };
 506
 507 struct ath6kl_vif {
 508         struct list_head list;
 509         struct wireless_dev wdev;
 510         struct net_device *ndev;
 511         struct ath6kl *ar;
 512         /* Lock to protect vif specific net_stats and flags */
 513         spinlock_t if_lock;
 514         u8 fw_vif_idx;
 515         unsigned long flags;
 516         int ssid_len;
 517         u8 ssid[IEEE80211_MAX_SSID_LEN];
 518         u8 dot11_auth_mode;
 519         u8 auth_mode;
 520         u8 prwise_crypto;
 521         u8 prwise_crypto_len;
 522         u8 grp_crypto;
 523         u8 grp_crypto_len;
 524         u8 def_txkey_index;
 525         u8 next_mode;
 526         u8 nw_type;
 527         u8 bssid[ETH_ALEN];
 528         u8 req_bssid[ETH_ALEN];
 529         u16 ch_hint;
 530         u16 bss_ch;
 531         struct ath6kl_wep_key wep_key_list[WMI_MAX_KEY_INDEX + 1];
 532         struct ath6kl_key keys[WMI_MAX_KEY_INDEX + 1];
 533         struct aggr_info *aggr_cntxt;
 534         struct ath6kl_htcap htcap;
 535
 536         struct timer_list disconnect_timer;
 537         struct timer_list sched_scan_timer;
 538
 539         struct cfg80211_scan_request *scan_req;
 540         enum sme_state sme_state;
 541         int reconnect_flag;
 542         u32 last_roc_id;
 543         u32 last_cancel_roc_id;
 544         u32 send_action_id;
 545         bool probe_req_report;
 546         u16 next_chan;
 547         enum nl80211_channel_type next_ch_type;
 548         enum ieee80211_band next_ch_band;
 549         u16 assoc_bss_beacon_int;
 550         u16 listen_intvl_t;
 551         u16 bmiss_time_t;
 552         u8 assoc_bss_dtim_period;
 553         struct net_device_stats net_stats;
 554         struct target_stats target_stats;
 555
 556         struct list_head mc_filter;
 557 };
 558
 559 #define WOW_LIST_ID             0
 560 #define WOW_HOST_REQ_DELAY      500 /* ms */
 561
 562 #define ATH6KL_SCHED_SCAN_RESULT_DELAY 5000 /* ms */
 563
 564 /* Flag info */
 565 enum ath6kl_dev_state {
 566         WMI_ENABLED,
 567         WMI_READY,
 568         WMI_CTRL_EP_FULL,
 569         TESTMODE,
 570         DESTROY_IN_PROGRESS,
 571         SKIP_SCAN,
 572         ROAM_TBL_PEND,
 573         FIRST_BOOT,
 574 };
 575
 576 enum ath6kl_state {
 577         ATH6KL_STATE_OFF,
 578         ATH6KL_STATE_ON,
 579         ATH6KL_STATE_SUSPENDING,
 580         ATH6KL_STATE_RESUMING,
 581         ATH6KL_STATE_DEEPSLEEP,
 582         ATH6KL_STATE_CUTPOWER,
 583         ATH6KL_STATE_WOW,
 584         ATH6KL_STATE_SCHED_SCAN,
 585 };
 586
 587 struct ath6kl {
 588         struct device *dev;
 589         struct wiphy *wiphy;
 590
 591         enum ath6kl_state state;
 592         unsigned int testmode;
 593
 594         struct ath6kl_bmi bmi;
 595         const struct ath6kl_hif_ops *hif_ops;
 596         const struct ath6kl_htc_ops *htc_ops;
 597         struct wmi *wmi;
 598         int tx_pending[ENDPOINT_MAX];
 599         int total_tx_data_pend;
 600         struct htc_target *htc_target;
 601         enum ath6kl_hif_type hif_type;
 602         void *hif_priv;
 603         struct list_head vif_list;
 604         /* Lock to avoid race in vif_list entries among add/del/traverse */
 605         spinlock_t list_lock;
 606         u8 num_vif;
 607         unsigned int vif_max;
 608         u8 max_norm_iface;
 609         u8 avail_idx_map;
 610
 611         /*
 612          * Protects at least amsdu_rx_buffer_queue, ath6kl_alloc_cookie()
 613          * calls, tx_pending and total_tx_data_pend.
 614          */
 615         spinlock_t lock;
 616
 617         struct semaphore sem;
 618         u8 lrssi_roam_threshold;
 619         struct ath6kl_version version;
 620         u32 target_type;
 621         u8 tx_pwr;
 622         struct ath6kl_node_mapping node_map[MAX_NODE_NUM];
 623         u8 ibss_ps_enable;
 624         bool ibss_if_active;
 625         u8 node_num;
 626         u8 next_ep_id;
 627         struct ath6kl_cookie *cookie_list;
 628         u32 cookie_count;
 629         enum htc_endpoint_id ac2ep_map[WMM_NUM_AC];
 630         bool ac_stream_active[WMM_NUM_AC];
 631         u8 ac_stream_pri_map[WMM_NUM_AC];
 632         u8 hiac_stream_active_pri;
 633         u8 ep2ac_map[ENDPOINT_MAX];
 634         enum htc_endpoint_id ctrl_ep;
 635         struct ath6kl_htc_credit_info credit_state_info;
 636         u32 connect_ctrl_flags;
 637         u32 user_key_ctrl;
 638         u8 usr_bss_filter;
 639         struct ath6kl_sta sta_list[AP_MAX_NUM_STA];
 640         u8 sta_list_index;
 641         struct ath6kl_req_key ap_mode_bkey;
 642         struct sk_buff_head mcastpsq;
 643
 644         /*
 645          * FIXME: protects access to mcastpsq but is actually useless as
 646          * all skbe_queue_*() functions provide serialisation themselves
 647          */
 648         spinlock_t mcastpsq_lock;
 649
 650         u8 intra_bss;
 651         struct wmi_ap_mode_stat ap_stats;
 652         u8 ap_country_code[3];
 653         struct list_head amsdu_rx_buffer_queue;
 654         u8 rx_meta_ver;
 655         enum wlan_low_pwr_state wlan_pwr_state;
 656         u8 mac_addr[ETH_ALEN];
 657 #define AR_MCAST_FILTER_MAC_ADDR_SIZE  4
 658         struct {
 659                 void *rx_report;
 660                 size_t rx_report_len;
 661         } tm;
 662
 663         struct ath6kl_hw {
 664                 u32 id;
 665                 const char *name;
 666                 u32 dataset_patch_addr;
 667                 u32 app_load_addr;
 668                 u32 app_start_override_addr;
 669                 u32 board_ext_data_addr;
 670                 u32 reserved_ram_size;
 671                 u32 board_addr;
 672                 u32 refclk_hz;
 673                 u32 uarttx_pin;
 674                 u32 testscript_addr;
 675
 676                 struct ath6kl_hw_fw {
 677                         const char *dir;
 678                         const char *otp;
 679                         const char *fw;
 680                         const char *tcmd;
 681                         const char *patch;
 682                         const char *utf;
 683                         const char *testscript;
 684                 } fw;
 685
 686                 const char *fw_board;
 687                 const char *fw_default_board;
 688         } hw;
 689
 690         u16 conf_flags;
 691         u16 suspend_mode;
 692         u16 wow_suspend_mode;
 693         wait_queue_head_t event_wq;
 694         struct ath6kl_mbox_info mbox_info;
 695
 696         struct ath6kl_cookie cookie_mem[MAX_COOKIE_NUM];
 697         unsigned long flag;
 698
 699         u8 *fw_board;
 700         size_t fw_board_len;
 701
 702         u8 *fw_otp;
 703         size_t fw_otp_len;
 704
 705         u8 *fw;
 706         size_t fw_len;
 707
 708         u8 *fw_patch;
 709         size_t fw_patch_len;
 710
 711         u8 *fw_testscript;
 712         size_t fw_testscript_len;
 713
 714         unsigned int fw_api;
 715         unsigned long fw_capabilities[ATH6KL_CAPABILITY_LEN];
 716
 717         struct workqueue_struct *ath6kl_wq;
 718
 719         struct dentry *debugfs_phy;
 720
 721         bool p2p;
 722
 723         bool wiphy_registered;
 724
 725 #ifdef CONFIG_ATH6KL_DEBUG
 726         struct {
 727                 struct sk_buff_head fwlog_queue;
 728                 struct completion fwlog_completion;
 729                 bool fwlog_open;
 730
 731                 u32 fwlog_mask;
 732
 733                 unsigned int dbgfs_diag_reg;
 734                 u32 diag_reg_addr_wr;
 735                 u32 diag_reg_val_wr;
 736
 737                 struct {
 738                         unsigned int invalid_rate;
 739                 } war_stats;
 740
 741                 u8 *roam_tbl;
 742                 unsigned int roam_tbl_len;
 743
 744                 u8 keepalive;
 745                 u8 disc_timeout;
 746         } debug;
 747 #endif /* CONFIG_ATH6KL_DEBUG */
 748 };
 749
 750 static inline struct ath6kl *ath6kl_priv(struct net_device *dev)
 751 {
 752         return ((struct ath6kl_vif *) netdev_priv(dev))->ar;
 753 }
 754
 755 static inline u32 ath6kl_get_hi_item_addr(struct ath6kl *ar,
 756                                           u32 item_offset)
 757 {
 758         u32 addr = 0;
 759
 760         if (ar->target_type == TARGET_TYPE_AR6003)
 761                 addr = ATH6KL_AR6003_HI_START_ADDR + item_offset;
 762         else if (ar->target_type == TARGET_TYPE_AR6004)
 763                 addr = ATH6KL_AR6004_HI_START_ADDR + item_offset;
 764
 765         return addr;
 766 }
 767
 768 int ath6kl_configure_target(struct ath6kl *ar);
 769 void ath6kl_detect_error(unsigned long ptr);
 770 void disconnect_timer_handler(unsigned long ptr);
 771 void init_netdev(struct net_device *dev);
 772 void ath6kl_cookie_init(struct ath6kl *ar);
 773 void ath6kl_cookie_cleanup(struct ath6kl *ar);
 774 void ath6kl_rx(struct htc_target *target, struct htc_packet *packet);
 775 void ath6kl_tx_complete(struct htc_target *context,
 776                         struct list_head *packet_queue);
 777 enum htc_send_full_action ath6kl_tx_queue_full(struct htc_target *target,
 778                                                struct htc_packet *packet);
 779 void ath6kl_stop_txrx(struct ath6kl *ar);
 780 void ath6kl_cleanup_amsdu_rxbufs(struct ath6kl *ar);
 781 int ath6kl_diag_write32(struct ath6kl *ar, u32 address, __le32 value);
 782 int ath6kl_diag_write(struct ath6kl *ar, u32 address, void *data, u32 length);
 783 int ath6kl_diag_read32(struct ath6kl *ar, u32 address, u32 *value);
 784 int ath6kl_diag_read(struct ath6kl *ar, u32 address, void *data, u32 length);
 785 int ath6kl_read_fwlogs(struct ath6kl *ar);
 786 void ath6kl_init_profile_info(struct ath6kl_vif *vif);
 787 void ath6kl_tx_data_cleanup(struct ath6kl *ar);
 788
 789 struct ath6kl_cookie *ath6kl_alloc_cookie(struct ath6kl *ar);
 790 void ath6kl_free_cookie(struct ath6kl *ar, struct ath6kl_cookie *cookie);
 791 int ath6kl_data_tx(struct sk_buff *skb, struct net_device *dev);
 792
 793 struct aggr_info *aggr_init(struct ath6kl_vif *vif);
 794 void aggr_conn_init(struct ath6kl_vif *vif, struct aggr_info *aggr_info,
 795                     struct aggr_info_conn *aggr_conn);
 796 void ath6kl_rx_refill(struct htc_target *target,
 797                       enum htc_endpoint_id endpoint);
 798 void ath6kl_refill_amsdu_rxbufs(struct ath6kl *ar, int count);
 799 struct htc_packet *ath6kl_alloc_amsdu_rxbuf(struct htc_target *target,
 800                                             enum htc_endpoint_id endpoint,
 801                                             int len);
 802 void aggr_module_destroy(struct aggr_info *aggr_info);
 803 void aggr_reset_state(struct aggr_info_conn *aggr_conn);
 804
 805 struct ath6kl_sta *ath6kl_find_sta(struct ath6kl_vif *vif, u8 *node_addr);
 806 struct ath6kl_sta *ath6kl_find_sta_by_aid(struct ath6kl *ar, u8 aid);
 807
 808 void ath6kl_ready_event(void *devt, u8 *datap, u32 sw_ver, u32 abi_ver);
 809 int ath6kl_control_tx(void *devt, struct sk_buff *skb,
 810                       enum htc_endpoint_id eid);
 811 void ath6kl_connect_event(struct ath6kl_vif *vif, u16 channel,
 812                           u8 *bssid, u16 listen_int,
 813                           u16 beacon_int, enum network_type net_type,
 814                           u8 beacon_ie_len, u8 assoc_req_len,
 815                           u8 assoc_resp_len, u8 *assoc_info);
 816 void ath6kl_connect_ap_mode_bss(struct ath6kl_vif *vif, u16 channel);
 817 void ath6kl_connect_ap_mode_sta(struct ath6kl_vif *vif, u16 aid, u8 *mac_addr,
 818                                 u8 keymgmt, u8 ucipher, u8 auth,
 819                                 u8 assoc_req_len, u8 *assoc_info, u8 apsd_info);
 820 void ath6kl_disconnect_event(struct ath6kl_vif *vif, u8 reason,
 821                              u8 *bssid, u8 assoc_resp_len,
 822                              u8 *assoc_info, u16 prot_reason_status);
 823 void ath6kl_tkip_micerr_event(struct ath6kl_vif *vif, u8 keyid, bool ismcast);
 824 void ath6kl_txpwr_rx_evt(void *devt, u8 tx_pwr);
 825 void ath6kl_scan_complete_evt(struct ath6kl_vif *vif, int status);
 826 void ath6kl_tgt_stats_event(struct ath6kl_vif *vif, u8 *ptr, u32 len);
 827 void ath6kl_indicate_tx_activity(void *devt, u8 traffic_class, bool active);
 828 enum htc_endpoint_id ath6kl_ac2_endpoint_id(void *devt, u8 ac);
 829
 830 void ath6kl_pspoll_event(struct ath6kl_vif *vif, u8 aid);
 831
 832 void ath6kl_dtimexpiry_event(struct ath6kl_vif *vif);
 833 void ath6kl_disconnect(struct ath6kl_vif *vif);
 834 void aggr_recv_delba_req_evt(struct ath6kl_vif *vif, u8 tid);
 835 void aggr_recv_addba_req_evt(struct ath6kl_vif *vif, u8 tid, u16 seq_no,
 836                              u8 win_sz);
 837 void ath6kl_wakeup_event(void *dev);
 838
 839 void ath6kl_reset_device(struct ath6kl *ar, u32 target_type,
 840                          bool wait_fot_compltn, bool cold_reset);
 841 void ath6kl_init_control_info(struct ath6kl_vif *vif);
 842 struct ath6kl_vif *ath6kl_vif_first(struct ath6kl *ar);
 843 void ath6kl_cleanup_vif(struct ath6kl_vif *vif, bool wmi_ready);
 844 int ath6kl_init_hw_start(struct ath6kl *ar);
 845 int ath6kl_init_hw_stop(struct ath6kl *ar);
 846 int ath6kl_init_fetch_firmwares(struct ath6kl *ar);
 847 int ath6kl_init_hw_params(struct ath6kl *ar);
 848
 849 void ath6kl_check_wow_status(struct ath6kl *ar);
 850
 851 void ath6kl_core_tx_complete(struct ath6kl *ar, struct sk_buff *skb);
 852 void ath6kl_core_rx_complete(struct ath6kl *ar, struct sk_buff *skb, u8 pipe);
 853
 854 struct ath6kl *ath6kl_core_create(struct device *dev);
 855 int ath6kl_core_init(struct ath6kl *ar, enum ath6kl_htc_type htc_type);
 856 void ath6kl_core_cleanup(struct ath6kl *ar);
 857 void ath6kl_core_destroy(struct ath6kl *ar);
 858
 859 #endif /* CORE_H */