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
  49 #define WL1271_CIPHER_SUITE_GEM 0x00147201
  50
  51 #define WL1271_BUSY_WORD_CNT 1
  52 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32))
  53
  54 #define WL1271_ELP_HW_STATE_ASLEEP 0
  55 #define WL1271_ELP_HW_STATE_IRQ    1
  56
  57 #define WL1271_DEFAULT_BEACON_INT  100
  58 #define WL1271_DEFAULT_DTIM_PERIOD 1
  59
  60 #define WL12XX_MAX_ROLES           4
  61 #define WL12XX_MAX_LINKS           12
  62 #define WL12XX_INVALID_ROLE_ID     0xff
  63 #define WL12XX_INVALID_LINK_ID     0xff
  64
  65 /* the driver supports the 2.4Ghz and 5Ghz bands */
  66 #define WLCORE_NUM_BANDS           2
  67
  68 #define WL12XX_MAX_RATE_POLICIES 16
  69 #define WLCORE_MAX_KLV_TEMPLATES 4
  70
  71 /* Defined by FW as 0. Will not be freed or allocated. */
  72 #define WL12XX_SYSTEM_HLID         0
  73
  74 /*
  75  * When in AP-mode, we allow (at least) this number of packets
  76  * to be transmitted to FW for a STA in PS-mode. Only when packets are
  77  * present in the FW buffers it will wake the sleeping STA. We want to put
  78  * enough packets for the driver to transmit all of its buffered data before
  79  * the STA goes to sleep again. But we don't want to take too much memory
  80  * as it might hurt the throughput of active STAs.
  81  */
  82 #define WL1271_PS_STA_MAX_PACKETS  2
  83
  84 #define WL1271_AP_BSS_INDEX        0
  85 #define WL1271_AP_DEF_BEACON_EXP   20
  86
  87 enum wlcore_state {
  88         WLCORE_STATE_OFF,
  89         WLCORE_STATE_RESTARTING,
  90         WLCORE_STATE_ON,
  91 };
  92
  93 enum wl12xx_fw_type {
  94         WL12XX_FW_TYPE_NONE,
  95         WL12XX_FW_TYPE_NORMAL,
  96         WL12XX_FW_TYPE_MULTI,
  97         WL12XX_FW_TYPE_PLT,
  98 };
  99
 100 struct wl1271;
 101
 102 enum {
 103         FW_VER_CHIP,
 104         FW_VER_IF_TYPE,
 105         FW_VER_MAJOR,
 106         FW_VER_SUBTYPE,
 107         FW_VER_MINOR,
 108
 109         NUM_FW_VER
 110 };
 111
 112 struct wl1271_chip {
 113         u32 id;
 114         char fw_ver_str[ETHTOOL_FWVERS_LEN];
 115         unsigned int fw_ver[NUM_FW_VER];
 116         char phy_fw_ver_str[ETHTOOL_FWVERS_LEN];
 117 };
 118
 119 #define NUM_TX_QUEUES              4
 120
 121 #define AP_MAX_STATIONS            8
 122
 123 struct wl_fw_packet_counters {
 124         /* Cumulative counter of released packets per AC */
 125         u8 tx_released_pkts[NUM_TX_QUEUES];
 126
 127         /* Cumulative counter of freed packets per HLID */
 128         u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
 129
 130         /* Cumulative counter of released Voice memory blocks */
 131         u8 tx_voice_released_blks;
 132
 133         /* Tx rate of the last transmitted packet */
 134         u8 tx_last_rate;
 135
 136         u8 padding[2];
 137 } __packed;
 138
 139 /* FW status registers */
 140 struct wl_fw_status_1 {
 141         __le32 intr;
 142         u8  fw_rx_counter;
 143         u8  drv_rx_counter;
 144         u8  reserved;
 145         u8  tx_results_counter;
 146         __le32 rx_pkt_descs[0];
 147 } __packed;
 148
 149 /*
 150  * Each HW arch has a different number of Rx descriptors.
 151  * The length of the status depends on it, since it holds an array
 152  * of descriptors.
 153  */
 154 #define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
 155                 (sizeof(struct wl_fw_status_1) + \
 156                 (sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
 157                 num_rx_desc)
 158
 159 struct wl_fw_status_2 {
 160         __le32 fw_localtime;
 161
 162         /*
 163          * A bitmap (where each bit represents a single HLID)
 164          * to indicate if the station is in PS mode.
 165          */
 166         __le32 link_ps_bitmap;
 167
 168         /*
 169          * A bitmap (where each bit represents a single HLID) to indicate
 170          * if the station is in Fast mode
 171          */
 172         __le32 link_fast_bitmap;
 173
 174         /* Cumulative counter of total released mem blocks since FW-reset */
 175         __le32 total_released_blks;
 176
 177         /* Size (in Memory Blocks) of TX pool */
 178         __le32 tx_total;
 179
 180         struct wl_fw_packet_counters counters;
 181
 182         __le32 log_start_addr;
 183
 184         /* Private status to be used by the lower drivers */
 185         u8 priv[0];
 186 } __packed;
 187
 188 #define WL1271_MAX_CHANNELS 64
 189 struct wl1271_scan {
 190         struct cfg80211_scan_request *req;
 191         unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
 192         bool failed;
 193         u8 state;
 194         u8 ssid[IEEE80211_MAX_SSID_LEN+1];
 195         size_t ssid_len;
 196 };
 197
 198 struct wl1271_if_operations {
 199         int __must_check (*read)(struct device *child, int addr, void *buf,
 200                                  size_t len, bool fixed);
 201         int __must_check (*write)(struct device *child, int addr, void *buf,
 202                                   size_t len, bool fixed);
 203         void (*reset)(struct device *child);
 204         void (*init)(struct device *child);
 205         int (*power)(struct device *child, bool enable);
 206         void (*set_block_size) (struct device *child, unsigned int blksz);
 207 };
 208
 209 struct wlcore_platdev_data {
 210         struct wl12xx_platform_data *pdata;
 211         struct wl1271_if_operations *if_ops;
 212 };
 213
 214 #define MAX_NUM_KEYS 14
 215 #define MAX_KEY_SIZE 32
 216
 217 struct wl1271_ap_key {
 218         u8 id;
 219         u8 key_type;
 220         u8 key_size;
 221         u8 key[MAX_KEY_SIZE];
 222         u8 hlid;
 223         u32 tx_seq_32;
 224         u16 tx_seq_16;
 225 };
 226
 227 enum wl12xx_flags {
 228         WL1271_FLAG_GPIO_POWER,
 229         WL1271_FLAG_TX_QUEUE_STOPPED,
 230         WL1271_FLAG_TX_PENDING,
 231         WL1271_FLAG_IN_ELP,
 232         WL1271_FLAG_ELP_REQUESTED,
 233         WL1271_FLAG_IRQ_RUNNING,
 234         WL1271_FLAG_FW_TX_BUSY,
 235         WL1271_FLAG_DUMMY_PACKET_PENDING,
 236         WL1271_FLAG_SUSPENDED,
 237         WL1271_FLAG_PENDING_WORK,
 238         WL1271_FLAG_SOFT_GEMINI,
 239         WL1271_FLAG_RECOVERY_IN_PROGRESS,
 240         WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
 241         WL1271_FLAG_INTENDED_FW_RECOVERY,
 242         WL1271_FLAG_IO_FAILED,
 243 };
 244
 245 enum wl12xx_vif_flags {
 246         WLVIF_FLAG_INITIALIZED,
 247         WLVIF_FLAG_STA_ASSOCIATED,
 248         WLVIF_FLAG_STA_AUTHORIZED,
 249         WLVIF_FLAG_IBSS_JOINED,
 250         WLVIF_FLAG_AP_STARTED,
 251         WLVIF_FLAG_IN_PS,
 252         WLVIF_FLAG_STA_STATE_SENT,
 253         WLVIF_FLAG_RX_STREAMING_STARTED,
 254         WLVIF_FLAG_PSPOLL_FAILURE,
 255         WLVIF_FLAG_CS_PROGRESS,
 256         WLVIF_FLAG_AP_PROBE_RESP_SET,
 257         WLVIF_FLAG_IN_USE,
 258         WLVIF_FLAG_ACTIVE,
 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          */
 336         u64 total_freed_pkts;
 337 };
 338
 339 struct wl12xx_vif {
 340         struct wl1271 *wl;
 341         struct list_head list;
 342         unsigned long flags;
 343         u8 bss_type;
 344         u8 p2p; /* we are using p2p role */
 345         u8 role_id;
 346
 347         /* sta/ibss specific */
 348         u8 dev_role_id;
 349         u8 dev_hlid;
 350
 351         union {
 352                 struct {
 353                         u8 hlid;
 354
 355                         u8 basic_rate_idx;
 356                         u8 ap_rate_idx;
 357                         u8 p2p_rate_idx;
 358
 359                         u8 klv_template_id;
 360
 361                         bool qos;
 362                         /* channel type we started the STA role with */
 363                         enum nl80211_channel_type role_chan_type;
 364                 } sta;
 365                 struct {
 366                         u8 global_hlid;
 367                         u8 bcast_hlid;
 368
 369                         /* HLIDs bitmap of associated stations */
 370                         unsigned long sta_hlid_map[BITS_TO_LONGS(
 371                                                         WL12XX_MAX_LINKS)];
 372
 373                         /* recoreded keys - set here before AP startup */
 374                         struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
 375
 376                         u8 mgmt_rate_idx;
 377                         u8 bcast_rate_idx;
 378                         u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
 379                 } ap;
 380         };
 381
 382         /* the hlid of the last transmitted skb */
 383         int last_tx_hlid;
 384
 385         /* counters of packets per AC, across all links in the vif */
 386         int tx_queue_count[NUM_TX_QUEUES];
 387
 388         unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
 389
 390         u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
 391         u8 ssid_len;
 392
 393         /* The current band */
 394         enum ieee80211_band band;
 395         int channel;
 396         enum nl80211_channel_type channel_type;
 397
 398         u32 bitrate_masks[WLCORE_NUM_BANDS];
 399         u32 basic_rate_set;
 400
 401         /*
 402          * currently configured rate set:
 403          *      bits  0-15 - 802.11abg rates
 404          *      bits 16-23 - 802.11n   MCS index mask
 405          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 406          */
 407         u32 basic_rate;
 408         u32 rate_set;
 409
 410         /* probe-req template for the current AP */
 411         struct sk_buff *probereq;
 412
 413         /* Beaconing interval (needed for ad-hoc) */
 414         u32 beacon_int;
 415
 416         /* Default key (for WEP) */
 417         u32 default_key;
 418
 419         /* Our association ID */
 420         u16 aid;
 421
 422         /* retry counter for PSM entries */
 423         u8 psm_entry_retry;
 424
 425         /* in dBm */
 426         int power_level;
 427
 428         int rssi_thold;
 429         int last_rssi_event;
 430
 431         /* save the current encryption type for auto-arp config */
 432         u8 encryption_type;
 433         __be32 ip_addr;
 434
 435         /* RX BA constraint value */
 436         bool ba_support;
 437         bool ba_allowed;
 438
 439         bool wmm_enabled;
 440
 441         /* Rx Streaming */
 442         struct work_struct rx_streaming_enable_work;
 443         struct work_struct rx_streaming_disable_work;
 444         struct timer_list rx_streaming_timer;
 445
 446         struct delayed_work channel_switch_work;
 447         struct delayed_work connection_loss_work;
 448
 449         /* number of in connection stations */
 450         int inconn_count;
 451
 452         /*
 453          * This vif's queues are mapped to mac80211 HW queues as:
 454          * VO - hw_queue_base
 455          * VI - hw_queue_base + 1
 456          * BE - hw_queue_base + 2
 457          * BK - hw_queue_base + 3
 458          */
 459         int hw_queue_base;
 460
 461         /* do we have a pending auth reply? (and ROC) */
 462         bool ap_pending_auth_reply;
 463
 464         /* time when we sent the pending auth reply */
 465         unsigned long pending_auth_reply_time;
 466
 467         /* work for canceling ROC after pending auth reply */
 468         struct delayed_work pending_auth_complete_work;
 469
 470         /*
 471          * This struct must be last!
 472          * data that has to be saved acrossed reconfigs (e.g. recovery)
 473          * should be declared in this struct.
 474          */
 475         struct {
 476                 u8 persistent[0];
 477
 478                 /*
 479                  * total freed FW packets on the link - used for
 480                  * storing the AES/TKIP PN during recovery, as this
 481                  * structure is not zeroed out.
 482                  * For STA this holds the PN of the link to the AP.
 483                  * For AP this holds the PN of the broadcast link.
 484                  */
 485                 u64 total_freed_pkts;
 486         };
 487 };
 488
 489 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
 490 {
 491         WARN_ON(!vif);
 492         return (struct wl12xx_vif *)vif->drv_priv;
 493 }
 494
 495 static inline
 496 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
 497 {
 498         return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
 499 }
 500
 501 #define wl12xx_for_each_wlvif(wl, wlvif) \
 502                 list_for_each_entry(wlvif, &wl->wlvif_list, list)
 503
 504 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
 505                 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
 506
 507 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)    \
 508                 wl12xx_for_each_wlvif(wl, wlvif)                \
 509                         if (wlvif->bss_type == _bss_type)
 510
 511 #define wl12xx_for_each_wlvif_sta(wl, wlvif)    \
 512                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
 513
 514 #define wl12xx_for_each_wlvif_ap(wl, wlvif)     \
 515                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
 516
 517 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
 518 int wl1271_plt_stop(struct wl1271 *wl);
 519 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
 520 void wl12xx_queue_recovery_work(struct wl1271 *wl);
 521 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
 522 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
 523                                         u16 offset, u8 flags,
 524                                         u8 *pattern, u8 len);
 525 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
 526 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
 527 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
 528 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
 529                                      u8 *buf);
 530
 531 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 532
 533 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
 534 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
 535
 536 #define WL1271_DEFAULT_POWER_LEVEL 0
 537
 538 #define WL1271_TX_QUEUE_LOW_WATERMARK  32
 539 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
 540
 541 #define WL1271_DEFERRED_QUEUE_LIMIT    64
 542
 543 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 544    on in case is has been shut down shortly before */
 545 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 546 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 547
 548 /* Macros to handle wl1271.sta_rate_set */
 549 #define HW_BG_RATES_MASK        0xffff
 550 #define HW_HT_RATES_OFFSET      16
 551 #define HW_MIMO_RATES_OFFSET    24
 552
 553 #endif /* __WLCORE_I_H__ */