kernel/drivers/net/wireless/ti/wlcore/wlcore_i.h

   1 /*
   2  * This file is part of wl1271
   3  *
   4  * Copyright (C) 1998-2009 Texas Instruments. All rights reserved.
   5  * Copyright (C) 2008-2009 Nokia Corporation
   6  *
   7  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #ifndef __WLCORE_I_H__
  26 #define __WLCORE_I_H__
  27
  28 #include <linux/mutex.h>
  29 #include <linux/completion.h>
  30 #include <linux/spinlock.h>
  31 #include <linux/list.h>
  32 #include <linux/bitops.h>
  33 #include <net/mac80211.h>
  34
  35 #include "conf.h"
  36 #include "ini.h"
  37
  38 /*
  39  * wl127x and wl128x are using the same NVS file name. However, the
  40  * ini parameters between them are different.  The driver validates
  41  * the correct NVS size in wl1271_boot_upload_nvs().
  42  */
  43 #define WL12XX_NVS_NAME "ti-connectivity/wl1271-nvs.bin"
  44
  45 #define WL1271_TX_SECURITY_LO16(s) ((u16)((s) & 0xffff))
  46 #define WL1271_TX_SECURITY_HI32(s) ((u32)(((s) >> 16) & 0xffffffff))
  47 #define WL1271_TX_SQN_POST_RECOVERY_PADDING 0xff
  48 /* Use smaller padding for GEM, as some  APs have issues when it's too big */
  49 #define WL1271_TX_SQN_POST_RECOVERY_PADDING_GEM 0x20
  50
  51
  52 #define WL1271_CIPHER_SUITE_GEM 0x00147201
  53
  54 #define WL1271_BUSY_WORD_CNT 1
  55 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
  56
  57 #define WL1271_ELP_HW_STATE_ASLEEP 0
  58 #define WL1271_ELP_HW_STATE_IRQ    1
  59
  60 #define WL1271_DEFAULT_BEACON_INT  100
  61 #define WL1271_DEFAULT_DTIM_PERIOD 1
  62
  63 #define WL12XX_MAX_ROLES           4
  64 #define WL12XX_INVALID_ROLE_ID     0xff
  65 #define WL12XX_INVALID_LINK_ID     0xff
  66
  67 /*
  68  * max number of links allowed by all HWs.
  69  * this is NOT the actual max links supported by the current hw.
  70  */
  71 #define WLCORE_MAX_LINKS 16
  72
  73 /* the driver supports the 2.4Ghz and 5Ghz bands */
  74 #define WLCORE_NUM_BANDS           2
  75
  76 #define WL12XX_MAX_RATE_POLICIES 16
  77 #define WLCORE_MAX_KLV_TEMPLATES 4
  78
  79 /* Defined by FW as 0. Will not be freed or allocated. */
  80 #define WL12XX_SYSTEM_HLID         0
  81
  82 /*
  83  * When in AP-mode, we allow (at least) this number of packets
  84  * to be transmitted to FW for a STA in PS-mode. Only when packets are
  85  * present in the FW buffers it will wake the sleeping STA. We want to put
  86  * enough packets for the driver to transmit all of its buffered data before
  87  * the STA goes to sleep again. But we don't want to take too much memory
  88  * as it might hurt the throughput of active STAs.
  89  */
  90 #define WL1271_PS_STA_MAX_PACKETS  2
  91
  92 #define WL1271_AP_BSS_INDEX        0
  93 #define WL1271_AP_DEF_BEACON_EXP   20
  94
  95 enum wlcore_state {
  96         WLCORE_STATE_OFF,
  97         WLCORE_STATE_RESTARTING,
  98         WLCORE_STATE_ON,
  99 };
 100
 101 enum wl12xx_fw_type {
 102         WL12XX_FW_TYPE_NONE,
 103         WL12XX_FW_TYPE_NORMAL,
 104         WL12XX_FW_TYPE_MULTI,
 105         WL12XX_FW_TYPE_PLT,
 106 };
 107
 108 struct wl1271;
 109
 110 enum {
 111         FW_VER_CHIP,
 112         FW_VER_IF_TYPE,
 113         FW_VER_MAJOR,
 114         FW_VER_SUBTYPE,
 115         FW_VER_MINOR,
 116
 117         NUM_FW_VER
 118 };
 119
 120 struct wl1271_chip {
 121         u32 id;
 122         char fw_ver_str[ETHTOOL_FWVERS_LEN];
 123         unsigned int fw_ver[NUM_FW_VER];
 124         char phy_fw_ver_str[ETHTOOL_FWVERS_LEN];
 125 };
 126
 127 #define NUM_TX_QUEUES              4
 128
 129 struct wl_fw_status {
 130         u32 intr;
 131         u8  fw_rx_counter;
 132         u8  drv_rx_counter;
 133         u8  tx_results_counter;
 134         __le32 *rx_pkt_descs;
 135
 136         u32 fw_localtime;
 137
 138         /*
 139          * A bitmap (where each bit represents a single HLID)
 140          * to indicate if the station is in PS mode.
 141          */
 142         u32 link_ps_bitmap;
 143
 144         /*
 145          * A bitmap (where each bit represents a single HLID) to indicate
 146          * if the station is in Fast mode
 147          */
 148         u32 link_fast_bitmap;
 149
 150         /* Cumulative counter of total released mem blocks since FW-reset */
 151         u32 total_released_blks;
 152
 153         /* Size (in Memory Blocks) of TX pool */
 154         u32 tx_total;
 155
 156         struct {
 157                 /*
 158                  * Cumulative counter of released packets per AC
 159                  * (length of the array is NUM_TX_QUEUES)
 160                  */
 161                 u8 *tx_released_pkts;
 162
 163                 /*
 164                  * Cumulative counter of freed packets per HLID
 165                  * (length of the array is wl->num_links)
 166                  */
 167                 u8 *tx_lnk_free_pkts;
 168
 169                 /* Cumulative counter of released Voice memory blocks */
 170                 u8 tx_voice_released_blks;
 171
 172                 /* Tx rate of the last transmitted packet */
 173                 u8 tx_last_rate;
 174         } counters;
 175
 176         u32 log_start_addr;
 177
 178         /* Private status to be used by the lower drivers */
 179         void *priv;
 180 };
 181
 182 #define WL1271_MAX_CHANNELS 64
 183 struct wl1271_scan {
 184         struct cfg80211_scan_request *req;
 185         unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
 186         bool failed;
 187         u8 state;
 188         u8 ssid[IEEE80211_MAX_SSID_LEN+1];
 189         size_t ssid_len;
 190 };
 191
 192 struct wl1271_if_operations {
 193         int __must_check (*read)(struct device *child, int addr, void *buf,
 194                                  size_t len, bool fixed);
 195         int __must_check (*write)(struct device *child, int addr, void *buf,
 196                                   size_t len, bool fixed);
 197         void (*reset)(struct device *child);
 198         void (*init)(struct device *child);
 199         int (*power)(struct device *child, bool enable);
 200         void (*set_block_size) (struct device *child, unsigned int blksz);
 201 };
 202
 203 struct wlcore_platdev_data {
 204         struct wl1271_if_operations *if_ops;
 205
 206         bool ref_clock_xtal;    /* specify whether the clock is XTAL or not */
 207         u32 ref_clock_freq;     /* in Hertz */
 208         u32 tcxo_clock_freq;    /* in Hertz, tcxo is always XTAL */
 209         bool pwr_in_suspend;
 210 };
 211
 212 #define MAX_NUM_KEYS 14
 213 #define MAX_KEY_SIZE 32
 214
 215 struct wl1271_ap_key {
 216         u8 id;
 217         u8 key_type;
 218         u8 key_size;
 219         u8 key[MAX_KEY_SIZE];
 220         u8 hlid;
 221         u32 tx_seq_32;
 222         u16 tx_seq_16;
 223 };
 224
 225 enum wl12xx_flags {
 226         WL1271_FLAG_GPIO_POWER,
 227         WL1271_FLAG_TX_QUEUE_STOPPED,
 228         WL1271_FLAG_TX_PENDING,
 229         WL1271_FLAG_IN_ELP,
 230         WL1271_FLAG_ELP_REQUESTED,
 231         WL1271_FLAG_IRQ_RUNNING,
 232         WL1271_FLAG_FW_TX_BUSY,
 233         WL1271_FLAG_DUMMY_PACKET_PENDING,
 234         WL1271_FLAG_SUSPENDED,
 235         WL1271_FLAG_PENDING_WORK,
 236         WL1271_FLAG_SOFT_GEMINI,
 237         WL1271_FLAG_RECOVERY_IN_PROGRESS,
 238         WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
 239         WL1271_FLAG_INTENDED_FW_RECOVERY,
 240         WL1271_FLAG_IO_FAILED,
 241         WL1271_FLAG_REINIT_TX_WDOG,
 242 };
 243
 244 enum wl12xx_vif_flags {
 245         WLVIF_FLAG_INITIALIZED,
 246         WLVIF_FLAG_STA_ASSOCIATED,
 247         WLVIF_FLAG_STA_AUTHORIZED,
 248         WLVIF_FLAG_IBSS_JOINED,
 249         WLVIF_FLAG_AP_STARTED,
 250         WLVIF_FLAG_IN_PS,
 251         WLVIF_FLAG_STA_STATE_SENT,
 252         WLVIF_FLAG_RX_STREAMING_STARTED,
 253         WLVIF_FLAG_PSPOLL_FAILURE,
 254         WLVIF_FLAG_CS_PROGRESS,
 255         WLVIF_FLAG_AP_PROBE_RESP_SET,
 256         WLVIF_FLAG_IN_USE,
 257         WLVIF_FLAG_ACTIVE,
 258         WLVIF_FLAG_BEACON_DISABLED,
 259 };
 260
 261 struct wl12xx_vif;
 262
 263 struct wl1271_link {
 264         /* AP-mode - TX queue per AC in link */
 265         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 266
 267         /* accounting for allocated / freed packets in FW */
 268         u8 allocated_pkts;
 269         u8 prev_freed_pkts;
 270
 271         u8 addr[ETH_ALEN];
 272
 273         /* bitmap of TIDs where RX BA sessions are active for this link */
 274         u8 ba_bitmap;
 275
 276         /* The wlvif this link belongs to. Might be null for global links */
 277         struct wl12xx_vif *wlvif;
 278
 279         /*
 280          * total freed FW packets on the link - used for tracking the
 281          * AES/TKIP PN across recoveries. Re-initialized each time
 282          * from the wl1271_station structure.
 283          */
 284         u64 total_freed_pkts;
 285 };
 286
 287 #define WL1271_MAX_RX_FILTERS 5
 288 #define WL1271_RX_FILTER_MAX_FIELDS 8
 289
 290 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
 291 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
 292 #define RX_FILTER_FIELD_OVERHEAD                                \
 293         (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
 294 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE                       \
 295         (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
 296
 297 #define WL1271_RX_FILTER_FLAG_MASK                BIT(0)
 298 #define WL1271_RX_FILTER_FLAG_IP_HEADER           0
 299 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER     BIT(1)
 300
 301 enum rx_filter_action {
 302         FILTER_DROP = 0,
 303         FILTER_SIGNAL = 1,
 304         FILTER_FW_HANDLE = 2
 305 };
 306
 307 enum plt_mode {
 308         PLT_OFF = 0,
 309         PLT_ON = 1,
 310         PLT_FEM_DETECT = 2,
 311         PLT_CHIP_AWAKE = 3
 312 };
 313
 314 struct wl12xx_rx_filter_field {
 315         __le16 offset;
 316         u8 len;
 317         u8 flags;
 318         u8 *pattern;
 319 } __packed;
 320
 321 struct wl12xx_rx_filter {
 322         u8 action;
 323         int num_fields;
 324         struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
 325 };
 326
 327 struct wl1271_station {
 328         u8 hlid;
 329         bool in_connection;
 330
 331         /*
 332          * total freed FW packets on the link to the STA - used for tracking the
 333          * AES/TKIP PN across recoveries. Re-initialized each time from the
 334          * wl1271_station structure.
 335          * Used in both AP and STA mode.
 336          */
 337         u64 total_freed_pkts;
 338 };
 339
 340 struct wl12xx_vif {
 341         struct wl1271 *wl;
 342         struct list_head list;
 343         unsigned long flags;
 344         u8 bss_type;
 345         u8 p2p; /* we are using p2p role */
 346         u8 role_id;
 347
 348         /* sta/ibss specific */
 349         u8 dev_role_id;
 350         u8 dev_hlid;
 351
 352         union {
 353                 struct {
 354                         u8 hlid;
 355
 356                         u8 basic_rate_idx;
 357                         u8 ap_rate_idx;
 358                         u8 p2p_rate_idx;
 359
 360                         u8 klv_template_id;
 361
 362                         bool qos;
 363                         /* channel type we started the STA role with */
 364                         enum nl80211_channel_type role_chan_type;
 365                 } sta;
 366                 struct {
 367                         u8 global_hlid;
 368                         u8 bcast_hlid;
 369
 370                         /* HLIDs bitmap of associated stations */
 371                         unsigned long sta_hlid_map[BITS_TO_LONGS(
 372                                                         WLCORE_MAX_LINKS)];
 373
 374                         /* recoreded keys - set here before AP startup */
 375                         struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
 376
 377                         u8 mgmt_rate_idx;
 378                         u8 bcast_rate_idx;
 379                         u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
 380                 } ap;
 381         };
 382
 383         /* the hlid of the last transmitted skb */
 384         int last_tx_hlid;
 385
 386         /* counters of packets per AC, across all links in the vif */
 387         int tx_queue_count[NUM_TX_QUEUES];
 388
 389         unsigned long links_map[BITS_TO_LONGS(WLCORE_MAX_LINKS)];
 390
 391         u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
 392         u8 ssid_len;
 393
 394         /* The current band */
 395         enum ieee80211_band band;
 396         int channel;
 397         enum nl80211_channel_type channel_type;
 398
 399         u32 bitrate_masks[WLCORE_NUM_BANDS];
 400         u32 basic_rate_set;
 401
 402         /*
 403          * currently configured rate set:
 404          *      bits  0-15 - 802.11abg rates
 405          *      bits 16-23 - 802.11n   MCS index mask
 406          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 407          */
 408         u32 basic_rate;
 409         u32 rate_set;
 410
 411         /* probe-req template for the current AP */
 412         struct sk_buff *probereq;
 413
 414         /* Beaconing interval (needed for ad-hoc) */
 415         u32 beacon_int;
 416
 417         /* Default key (for WEP) */
 418         u32 default_key;
 419
 420         /* Our association ID */
 421         u16 aid;
 422
 423         /* retry counter for PSM entries */
 424         u8 psm_entry_retry;
 425
 426         /* in dBm */
 427         int power_level;
 428
 429         int rssi_thold;
 430         int last_rssi_event;
 431
 432         /* save the current encryption type for auto-arp config */
 433         u8 encryption_type;
 434         __be32 ip_addr;
 435
 436         /* RX BA constraint value */
 437         bool ba_support;
 438         bool ba_allowed;
 439
 440         bool wmm_enabled;
 441
 442         bool radar_enabled;
 443
 444         /* Rx Streaming */
 445         struct work_struct rx_streaming_enable_work;
 446         struct work_struct rx_streaming_disable_work;
 447         struct timer_list rx_streaming_timer;
 448
 449         struct delayed_work channel_switch_work;
 450         struct delayed_work connection_loss_work;
 451
 452         /* number of in connection stations */
 453         int inconn_count;
 454
 455         /*
 456          * This vif's queues are mapped to mac80211 HW queues as:
 457          * VO - hw_queue_base
 458          * VI - hw_queue_base + 1
 459          * BE - hw_queue_base + 2
 460          * BK - hw_queue_base + 3
 461          */
 462         int hw_queue_base;
 463
 464         /* do we have a pending auth reply? (and ROC) */
 465         bool ap_pending_auth_reply;
 466
 467         /* time when we sent the pending auth reply */
 468         unsigned long pending_auth_reply_time;
 469
 470         /* work for canceling ROC after pending auth reply */
 471         struct delayed_work pending_auth_complete_work;
 472
 473         /* update rate conrol */
 474         enum ieee80211_sta_rx_bandwidth rc_update_bw;
 475         struct work_struct rc_update_work;
 476
 477         /*
 478          * total freed FW packets on the link.
 479          * For STA this holds the PN of the link to the AP.
 480          * For AP this holds the PN of the broadcast link.
 481          */
 482         u64 total_freed_pkts;
 483
 484         /*
 485          * This struct must be last!
 486          * data that has to be saved acrossed reconfigs (e.g. recovery)
 487          * should be declared in this struct.
 488          */
 489         struct {
 490                 u8 persistent[0];
 491         };
 492 };
 493
 494 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
 495 {
 496         WARN_ON(!vif);
 497         return (struct wl12xx_vif *)vif->drv_priv;
 498 }
 499
 500 static inline
 501 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
 502 {
 503         return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
 504 }
 505
 506 #define wl12xx_for_each_wlvif(wl, wlvif) \
 507                 list_for_each_entry(wlvif, &wl->wlvif_list, list)
 508
 509 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
 510                 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
 511
 512 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)    \
 513                 wl12xx_for_each_wlvif(wl, wlvif)                \
 514                         if (wlvif->bss_type == _bss_type)
 515
 516 #define wl12xx_for_each_wlvif_sta(wl, wlvif)    \
 517                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
 518
 519 #define wl12xx_for_each_wlvif_ap(wl, wlvif)     \
 520                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
 521
 522 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
 523 int wl1271_plt_stop(struct wl1271 *wl);
 524 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
 525 void wl12xx_queue_recovery_work(struct wl1271 *wl);
 526 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
 527 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
 528                                  u16 offset, u8 flags,
 529                                  const u8 *pattern, u8 len);
 530 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
 531 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
 532 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
 533 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
 534                                      u8 *buf);
 535
 536 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 537
 538 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
 539 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
 540
 541 #define WL1271_DEFAULT_POWER_LEVEL 0
 542
 543 #define WL1271_TX_QUEUE_LOW_WATERMARK  32
 544 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
 545
 546 #define WL1271_DEFERRED_QUEUE_LIMIT    64
 547
 548 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 549    on in case is has been shut down shortly before */
 550 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 551 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 552
 553 /* Macros to handle wl1271.sta_rate_set */
 554 #define HW_BG_RATES_MASK        0xffff
 555 #define HW_HT_RATES_OFFSET      16
 556 #define HW_MIMO_RATES_OFFSET    24
 557
 558 #endif /* __WLCORE_I_H__ */