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