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 "/*(DEBLOBBED)*/"
  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
  70 /* Defined by FW as 0. Will not be freed or allocated. */
  71 #define WL12XX_SYSTEM_HLID         0
  72
  73 /*
  74  * When in AP-mode, we allow (at least) this number of packets
  75  * to be transmitted to FW for a STA in PS-mode. Only when packets are
  76  * present in the FW buffers it will wake the sleeping STA. We want to put
  77  * enough packets for the driver to transmit all of its buffered data before
  78  * the STA goes to sleep again. But we don't want to take too much memory
  79  * as it might hurt the throughput of active STAs.
  80  */
  81 #define WL1271_PS_STA_MAX_PACKETS  2
  82
  83 #define WL1271_AP_BSS_INDEX        0
  84 #define WL1271_AP_DEF_BEACON_EXP   20
  85
  86 #define WL1271_AGGR_BUFFER_SIZE (5 * PAGE_SIZE)
  87
  88 enum wl1271_state {
  89         WL1271_STATE_OFF,
  90         WL1271_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 #define FW_VER_CHIP_WL127X 6
 113 #define FW_VER_CHIP_WL128X 7
 114
 115 #define FW_VER_IF_TYPE_STA 1
 116 #define FW_VER_IF_TYPE_AP  2
 117
 118 #define FW_VER_MINOR_1_SPARE_STA_MIN 58
 119 #define FW_VER_MINOR_1_SPARE_AP_MIN  47
 120
 121 #define FW_VER_MINOR_FWLOG_STA_MIN 70
 122
 123 struct wl1271_chip {
 124         u32 id;
 125         char fw_ver_str[ETHTOOL_BUSINFO_LEN];
 126         unsigned int fw_ver[NUM_FW_VER];
 127 };
 128
 129 #define NUM_TX_QUEUES              4
 130
 131 #define AP_MAX_STATIONS            8
 132
 133 struct wl_fw_packet_counters {
 134         /* Cumulative counter of released packets per AC */
 135         u8 tx_released_pkts[NUM_TX_QUEUES];
 136
 137         /* Cumulative counter of freed packets per HLID */
 138         u8 tx_lnk_free_pkts[WL12XX_MAX_LINKS];
 139
 140         /* Cumulative counter of released Voice memory blocks */
 141         u8 tx_voice_released_blks;
 142
 143         u8 padding[3];
 144 } __packed;
 145
 146 /* FW status registers */
 147 struct wl_fw_status_1 {
 148         __le32 intr;
 149         u8  fw_rx_counter;
 150         u8  drv_rx_counter;
 151         u8  reserved;
 152         u8  tx_results_counter;
 153         __le32 rx_pkt_descs[0];
 154 } __packed;
 155
 156 /*
 157  * Each HW arch has a different number of Rx descriptors.
 158  * The length of the status depends on it, since it holds an array
 159  * of descriptors.
 160  */
 161 #define WLCORE_FW_STATUS_1_LEN(num_rx_desc) \
 162                 (sizeof(struct wl_fw_status_1) + \
 163                 (sizeof(((struct wl_fw_status_1 *)0)->rx_pkt_descs[0])) * \
 164                 num_rx_desc)
 165
 166 struct wl_fw_status_2 {
 167         __le32 fw_localtime;
 168
 169         /*
 170          * A bitmap (where each bit represents a single HLID)
 171          * to indicate if the station is in PS mode.
 172          */
 173         __le32 link_ps_bitmap;
 174
 175         /*
 176          * A bitmap (where each bit represents a single HLID) to indicate
 177          * if the station is in Fast mode
 178          */
 179         __le32 link_fast_bitmap;
 180
 181         /* Cumulative counter of total released mem blocks since FW-reset */
 182         __le32 total_released_blks;
 183
 184         /* Size (in Memory Blocks) of TX pool */
 185         __le32 tx_total;
 186
 187         struct wl_fw_packet_counters counters;
 188
 189         __le32 log_start_addr;
 190
 191         /* Private status to be used by the lower drivers */
 192         u8 priv[0];
 193 } __packed;
 194
 195 #define WL1271_MAX_CHANNELS 64
 196 struct wl1271_scan {
 197         struct cfg80211_scan_request *req;
 198         unsigned long scanned_ch[BITS_TO_LONGS(WL1271_MAX_CHANNELS)];
 199         bool failed;
 200         u8 state;
 201         u8 ssid[IEEE80211_MAX_SSID_LEN+1];
 202         size_t ssid_len;
 203 };
 204
 205 struct wl1271_if_operations {
 206         int __must_check (*read)(struct device *child, int addr, void *buf,
 207                                  size_t len, bool fixed);
 208         int __must_check (*write)(struct device *child, int addr, void *buf,
 209                                   size_t len, bool fixed);
 210         void (*reset)(struct device *child);
 211         void (*init)(struct device *child);
 212         int (*power)(struct device *child, bool enable);
 213         void (*set_block_size) (struct device *child, unsigned int blksz);
 214 };
 215
 216 #define MAX_NUM_KEYS 14
 217 #define MAX_KEY_SIZE 32
 218
 219 struct wl1271_ap_key {
 220         u8 id;
 221         u8 key_type;
 222         u8 key_size;
 223         u8 key[MAX_KEY_SIZE];
 224         u8 hlid;
 225         u32 tx_seq_32;
 226         u16 tx_seq_16;
 227 };
 228
 229 enum wl12xx_flags {
 230         WL1271_FLAG_GPIO_POWER,
 231         WL1271_FLAG_TX_QUEUE_STOPPED,
 232         WL1271_FLAG_TX_PENDING,
 233         WL1271_FLAG_IN_ELP,
 234         WL1271_FLAG_ELP_REQUESTED,
 235         WL1271_FLAG_IRQ_RUNNING,
 236         WL1271_FLAG_FW_TX_BUSY,
 237         WL1271_FLAG_DUMMY_PACKET_PENDING,
 238         WL1271_FLAG_SUSPENDED,
 239         WL1271_FLAG_PENDING_WORK,
 240         WL1271_FLAG_SOFT_GEMINI,
 241         WL1271_FLAG_RECOVERY_IN_PROGRESS,
 242         WL1271_FLAG_VIF_CHANGE_IN_PROGRESS,
 243         WL1271_FLAG_INTENDED_FW_RECOVERY,
 244         WL1271_FLAG_IO_FAILED,
 245 };
 246
 247 enum wl12xx_vif_flags {
 248         WLVIF_FLAG_INITIALIZED,
 249         WLVIF_FLAG_STA_ASSOCIATED,
 250         WLVIF_FLAG_STA_AUTHORIZED,
 251         WLVIF_FLAG_IBSS_JOINED,
 252         WLVIF_FLAG_AP_STARTED,
 253         WLVIF_FLAG_IN_PS,
 254         WLVIF_FLAG_STA_STATE_SENT,
 255         WLVIF_FLAG_RX_STREAMING_STARTED,
 256         WLVIF_FLAG_PSPOLL_FAILURE,
 257         WLVIF_FLAG_CS_PROGRESS,
 258         WLVIF_FLAG_AP_PROBE_RESP_SET,
 259         WLVIF_FLAG_IN_USE,
 260 };
 261
 262 struct wl1271_link {
 263         /* AP-mode - TX queue per AC in link */
 264         struct sk_buff_head tx_queue[NUM_TX_QUEUES];
 265
 266         /* accounting for allocated / freed packets in FW */
 267         u8 allocated_pkts;
 268         u8 prev_freed_pkts;
 269
 270         u8 addr[ETH_ALEN];
 271
 272         /* bitmap of TIDs where RX BA sessions are active for this link */
 273         u8 ba_bitmap;
 274 };
 275
 276 #define WL1271_MAX_RX_FILTERS 5
 277 #define WL1271_RX_FILTER_MAX_FIELDS 8
 278
 279 #define WL1271_RX_FILTER_ETH_HEADER_SIZE 14
 280 #define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95
 281 #define RX_FILTER_FIELD_OVERHEAD                                \
 282         (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *))
 283 #define WL1271_RX_FILTER_MAX_PATTERN_SIZE                       \
 284         (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD)
 285
 286 #define WL1271_RX_FILTER_FLAG_MASK                BIT(0)
 287 #define WL1271_RX_FILTER_FLAG_IP_HEADER           0
 288 #define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER     BIT(1)
 289
 290 enum rx_filter_action {
 291         FILTER_DROP = 0,
 292         FILTER_SIGNAL = 1,
 293         FILTER_FW_HANDLE = 2
 294 };
 295
 296 enum plt_mode {
 297         PLT_OFF = 0,
 298         PLT_ON = 1,
 299         PLT_FEM_DETECT = 2,
 300 };
 301
 302 struct wl12xx_rx_filter_field {
 303         __le16 offset;
 304         u8 len;
 305         u8 flags;
 306         u8 *pattern;
 307 } __packed;
 308
 309 struct wl12xx_rx_filter {
 310         u8 action;
 311         int num_fields;
 312         struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS];
 313 };
 314
 315 struct wl1271_station {
 316         u8 hlid;
 317 };
 318
 319 struct wl12xx_vif {
 320         struct wl1271 *wl;
 321         struct list_head list;
 322         unsigned long flags;
 323         u8 bss_type;
 324         u8 p2p; /* we are using p2p role */
 325         u8 role_id;
 326
 327         /* sta/ibss specific */
 328         u8 dev_role_id;
 329         u8 dev_hlid;
 330
 331         union {
 332                 struct {
 333                         u8 hlid;
 334                         u8 ba_rx_bitmap;
 335
 336                         u8 basic_rate_idx;
 337                         u8 ap_rate_idx;
 338                         u8 p2p_rate_idx;
 339
 340                         bool qos;
 341                 } sta;
 342                 struct {
 343                         u8 global_hlid;
 344                         u8 bcast_hlid;
 345
 346                         /* HLIDs bitmap of associated stations */
 347                         unsigned long sta_hlid_map[BITS_TO_LONGS(
 348                                                         WL12XX_MAX_LINKS)];
 349
 350                         /* recoreded keys - set here before AP startup */
 351                         struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS];
 352
 353                         u8 mgmt_rate_idx;
 354                         u8 bcast_rate_idx;
 355                         u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT];
 356                 } ap;
 357         };
 358
 359         /* the hlid of the last transmitted skb */
 360         int last_tx_hlid;
 361
 362         unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)];
 363
 364         u8 ssid[IEEE80211_MAX_SSID_LEN + 1];
 365         u8 ssid_len;
 366
 367         /* The current band */
 368         enum ieee80211_band band;
 369         int channel;
 370         enum nl80211_channel_type channel_type;
 371
 372         u32 bitrate_masks[WLCORE_NUM_BANDS];
 373         u32 basic_rate_set;
 374
 375         /*
 376          * currently configured rate set:
 377          *      bits  0-15 - 802.11abg rates
 378          *      bits 16-23 - 802.11n   MCS index mask
 379          * support only 1 stream, thus only 8 bits for the MCS rates (0-7).
 380          */
 381         u32 basic_rate;
 382         u32 rate_set;
 383
 384         /* probe-req template for the current AP */
 385         struct sk_buff *probereq;
 386
 387         /* Beaconing interval (needed for ad-hoc) */
 388         u32 beacon_int;
 389
 390         /* Default key (for WEP) */
 391         u32 default_key;
 392
 393         /* Our association ID */
 394         u16 aid;
 395
 396         /* Session counter for the chipset */
 397         int session_counter;
 398
 399         /* retry counter for PSM entries */
 400         u8 psm_entry_retry;
 401
 402         /* in dBm */
 403         int power_level;
 404
 405         int rssi_thold;
 406         int last_rssi_event;
 407
 408         /* save the current encryption type for auto-arp config */
 409         u8 encryption_type;
 410         __be32 ip_addr;
 411
 412         /* RX BA constraint value */
 413         bool ba_support;
 414         bool ba_allowed;
 415
 416         /* Rx Streaming */
 417         struct work_struct rx_streaming_enable_work;
 418         struct work_struct rx_streaming_disable_work;
 419         struct timer_list rx_streaming_timer;
 420
 421         /*
 422          * This struct must be last!
 423          * data that has to be saved acrossed reconfigs (e.g. recovery)
 424          * should be declared in this struct.
 425          */
 426         struct {
 427                 u8 persistent[0];
 428                 /*
 429                  * Security sequence number
 430                  *     bits 0-15: lower 16 bits part of sequence number
 431                  *     bits 16-47: higher 32 bits part of sequence number
 432                  *     bits 48-63: not in use
 433                  */
 434                 u64 tx_security_seq;
 435
 436                 /* 8 bits of the last sequence number in use */
 437                 u8 tx_security_last_seq_lsb;
 438         };
 439 };
 440
 441 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif)
 442 {
 443         return (struct wl12xx_vif *)vif->drv_priv;
 444 }
 445
 446 static inline
 447 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif)
 448 {
 449         return container_of((void *)wlvif, struct ieee80211_vif, drv_priv);
 450 }
 451
 452 #define wl12xx_for_each_wlvif(wl, wlvif) \
 453                 list_for_each_entry(wlvif, &wl->wlvif_list, list)
 454
 455 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \
 456                 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list)
 457
 458 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type)    \
 459                 wl12xx_for_each_wlvif(wl, wlvif)                \
 460                         if (wlvif->bss_type == _bss_type)
 461
 462 #define wl12xx_for_each_wlvif_sta(wl, wlvif)    \
 463                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS)
 464
 465 #define wl12xx_for_each_wlvif_ap(wl, wlvif)     \
 466                 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS)
 467
 468 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode);
 469 int wl1271_plt_stop(struct wl1271 *wl);
 470 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif);
 471 void wl12xx_queue_recovery_work(struct wl1271 *wl);
 472 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen);
 473 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter,
 474                                         u16 offset, u8 flags,
 475                                         u8 *pattern, u8 len);
 476 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter);
 477 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void);
 478 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter);
 479 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter,
 480                                      u8 *buf);
 481
 482 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */
 483
 484 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */
 485 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */
 486
 487 #define WL1271_DEFAULT_POWER_LEVEL 0
 488
 489 #define WL1271_TX_QUEUE_LOW_WATERMARK  32
 490 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256
 491
 492 #define WL1271_DEFERRED_QUEUE_LIMIT    64
 493
 494 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power
 495    on in case is has been shut down shortly before */
 496 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */
 497 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */
 498
 499 /* Macros to handle wl1271.sta_rate_set */
 500 #define HW_BG_RATES_MASK        0xffff
 501 #define HW_HT_RATES_OFFSET      16
 502 #define HW_MIMO_RATES_OFFSET    24
 503
 504 #define WL12XX_HW_BLOCK_SIZE    256
 505
 506 #endif /* __WLCORE_I_H__ */