wlcore_i.h revision f4d02007cdd56c59bdb9362c699875cb2d02c0fe
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 87enum wlcore_state { 88 WLCORE_STATE_OFF, 89 WLCORE_STATE_RESTARTING, 90 WLCORE_STATE_ON, 91}; 92 93enum 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 100struct wl1271; 101 102enum { 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 112struct wl1271_chip { 113 u32 id; 114 char fw_ver_str[ETHTOOL_BUSINFO_LEN]; 115 unsigned int fw_ver[NUM_FW_VER]; 116 char phy_fw_ver_str[ETHTOOL_BUSINFO_LEN]; 117}; 118 119#define NUM_TX_QUEUES 4 120 121#define AP_MAX_STATIONS 8 122 123struct 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 */ 140struct 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 159struct 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 189struct 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 198struct 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#define MAX_NUM_KEYS 14 210#define MAX_KEY_SIZE 32 211 212struct wl1271_ap_key { 213 u8 id; 214 u8 key_type; 215 u8 key_size; 216 u8 key[MAX_KEY_SIZE]; 217 u8 hlid; 218 u32 tx_seq_32; 219 u16 tx_seq_16; 220}; 221 222enum wl12xx_flags { 223 WL1271_FLAG_GPIO_POWER, 224 WL1271_FLAG_TX_QUEUE_STOPPED, 225 WL1271_FLAG_TX_PENDING, 226 WL1271_FLAG_IN_ELP, 227 WL1271_FLAG_ELP_REQUESTED, 228 WL1271_FLAG_IRQ_RUNNING, 229 WL1271_FLAG_FW_TX_BUSY, 230 WL1271_FLAG_DUMMY_PACKET_PENDING, 231 WL1271_FLAG_SUSPENDED, 232 WL1271_FLAG_PENDING_WORK, 233 WL1271_FLAG_SOFT_GEMINI, 234 WL1271_FLAG_RECOVERY_IN_PROGRESS, 235 WL1271_FLAG_VIF_CHANGE_IN_PROGRESS, 236 WL1271_FLAG_INTENDED_FW_RECOVERY, 237 WL1271_FLAG_IO_FAILED, 238}; 239 240enum wl12xx_vif_flags { 241 WLVIF_FLAG_INITIALIZED, 242 WLVIF_FLAG_STA_ASSOCIATED, 243 WLVIF_FLAG_STA_AUTHORIZED, 244 WLVIF_FLAG_IBSS_JOINED, 245 WLVIF_FLAG_AP_STARTED, 246 WLVIF_FLAG_IN_PS, 247 WLVIF_FLAG_STA_STATE_SENT, 248 WLVIF_FLAG_RX_STREAMING_STARTED, 249 WLVIF_FLAG_PSPOLL_FAILURE, 250 WLVIF_FLAG_CS_PROGRESS, 251 WLVIF_FLAG_AP_PROBE_RESP_SET, 252 WLVIF_FLAG_IN_USE, 253}; 254 255struct wl12xx_vif; 256 257struct wl1271_link { 258 /* AP-mode - TX queue per AC in link */ 259 struct sk_buff_head tx_queue[NUM_TX_QUEUES]; 260 261 /* accounting for allocated / freed packets in FW */ 262 u8 allocated_pkts; 263 u8 prev_freed_pkts; 264 265 u8 addr[ETH_ALEN]; 266 267 /* bitmap of TIDs where RX BA sessions are active for this link */ 268 u8 ba_bitmap; 269 270 /* The wlvif this link belongs to. Might be null for global links */ 271 struct wl12xx_vif *wlvif; 272}; 273 274#define WL1271_MAX_RX_FILTERS 5 275#define WL1271_RX_FILTER_MAX_FIELDS 8 276 277#define WL1271_RX_FILTER_ETH_HEADER_SIZE 14 278#define WL1271_RX_FILTER_MAX_FIELDS_SIZE 95 279#define RX_FILTER_FIELD_OVERHEAD \ 280 (sizeof(struct wl12xx_rx_filter_field) - sizeof(u8 *)) 281#define WL1271_RX_FILTER_MAX_PATTERN_SIZE \ 282 (WL1271_RX_FILTER_MAX_FIELDS_SIZE - RX_FILTER_FIELD_OVERHEAD) 283 284#define WL1271_RX_FILTER_FLAG_MASK BIT(0) 285#define WL1271_RX_FILTER_FLAG_IP_HEADER 0 286#define WL1271_RX_FILTER_FLAG_ETHERNET_HEADER BIT(1) 287 288enum rx_filter_action { 289 FILTER_DROP = 0, 290 FILTER_SIGNAL = 1, 291 FILTER_FW_HANDLE = 2 292}; 293 294enum plt_mode { 295 PLT_OFF = 0, 296 PLT_ON = 1, 297 PLT_FEM_DETECT = 2, 298}; 299 300struct wl12xx_rx_filter_field { 301 __le16 offset; 302 u8 len; 303 u8 flags; 304 u8 *pattern; 305} __packed; 306 307struct wl12xx_rx_filter { 308 u8 action; 309 int num_fields; 310 struct wl12xx_rx_filter_field fields[WL1271_RX_FILTER_MAX_FIELDS]; 311}; 312 313struct wl1271_station { 314 u8 hlid; 315 bool in_connection; 316}; 317 318struct wl12xx_vif { 319 struct wl1271 *wl; 320 struct list_head list; 321 unsigned long flags; 322 u8 bss_type; 323 u8 p2p; /* we are using p2p role */ 324 u8 role_id; 325 326 /* sta/ibss specific */ 327 u8 dev_role_id; 328 u8 dev_hlid; 329 330 union { 331 struct { 332 u8 hlid; 333 u8 ba_rx_bitmap; 334 335 u8 basic_rate_idx; 336 u8 ap_rate_idx; 337 u8 p2p_rate_idx; 338 339 u8 klv_template_id; 340 341 bool qos; 342 /* channel type we started the STA role with */ 343 enum nl80211_channel_type role_chan_type; 344 } sta; 345 struct { 346 u8 global_hlid; 347 u8 bcast_hlid; 348 349 /* HLIDs bitmap of associated stations */ 350 unsigned long sta_hlid_map[BITS_TO_LONGS( 351 WL12XX_MAX_LINKS)]; 352 353 /* recoreded keys - set here before AP startup */ 354 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS]; 355 356 u8 mgmt_rate_idx; 357 u8 bcast_rate_idx; 358 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT]; 359 } ap; 360 }; 361 362 /* the hlid of the last transmitted skb */ 363 int last_tx_hlid; 364 365 /* counters of packets per AC, across all links in the vif */ 366 int tx_queue_count[NUM_TX_QUEUES]; 367 368 unsigned long links_map[BITS_TO_LONGS(WL12XX_MAX_LINKS)]; 369 370 u8 ssid[IEEE80211_MAX_SSID_LEN + 1]; 371 u8 ssid_len; 372 373 /* The current band */ 374 enum ieee80211_band band; 375 int channel; 376 enum nl80211_channel_type channel_type; 377 378 u32 bitrate_masks[WLCORE_NUM_BANDS]; 379 u32 basic_rate_set; 380 381 /* 382 * currently configured rate set: 383 * bits 0-15 - 802.11abg rates 384 * bits 16-23 - 802.11n MCS index mask 385 * support only 1 stream, thus only 8 bits for the MCS rates (0-7). 386 */ 387 u32 basic_rate; 388 u32 rate_set; 389 390 /* probe-req template for the current AP */ 391 struct sk_buff *probereq; 392 393 /* Beaconing interval (needed for ad-hoc) */ 394 u32 beacon_int; 395 396 /* Default key (for WEP) */ 397 u32 default_key; 398 399 /* Our association ID */ 400 u16 aid; 401 402 /* retry counter for PSM entries */ 403 u8 psm_entry_retry; 404 405 /* in dBm */ 406 int power_level; 407 408 int rssi_thold; 409 int last_rssi_event; 410 411 /* save the current encryption type for auto-arp config */ 412 u8 encryption_type; 413 __be32 ip_addr; 414 415 /* RX BA constraint value */ 416 bool ba_support; 417 bool ba_allowed; 418 419 bool wmm_enabled; 420 421 /* Rx Streaming */ 422 struct work_struct rx_streaming_enable_work; 423 struct work_struct rx_streaming_disable_work; 424 struct timer_list rx_streaming_timer; 425 426 struct delayed_work channel_switch_work; 427 struct delayed_work connection_loss_work; 428 429 /* number of in connection stations */ 430 int inconn_count; 431 432 /* 433 * This struct must be last! 434 * data that has to be saved acrossed reconfigs (e.g. recovery) 435 * should be declared in this struct. 436 */ 437 struct { 438 u8 persistent[0]; 439 /* 440 * Security sequence number 441 * bits 0-15: lower 16 bits part of sequence number 442 * bits 16-47: higher 32 bits part of sequence number 443 * bits 48-63: not in use 444 */ 445 u64 tx_security_seq; 446 447 /* 8 bits of the last sequence number in use */ 448 u8 tx_security_last_seq_lsb; 449 }; 450}; 451 452static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif) 453{ 454 WARN_ON(!vif); 455 return (struct wl12xx_vif *)vif->drv_priv; 456} 457 458static inline 459struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif) 460{ 461 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv); 462} 463 464#define wl12xx_for_each_wlvif(wl, wlvif) \ 465 list_for_each_entry(wlvif, &wl->wlvif_list, list) 466 467#define wl12xx_for_each_wlvif_continue(wl, wlvif) \ 468 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list) 469 470#define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \ 471 wl12xx_for_each_wlvif(wl, wlvif) \ 472 if (wlvif->bss_type == _bss_type) 473 474#define wl12xx_for_each_wlvif_sta(wl, wlvif) \ 475 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS) 476 477#define wl12xx_for_each_wlvif_ap(wl, wlvif) \ 478 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS) 479 480int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode); 481int wl1271_plt_stop(struct wl1271 *wl); 482int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif); 483void wl12xx_queue_recovery_work(struct wl1271 *wl); 484size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen); 485int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter, 486 u16 offset, u8 flags, 487 u8 *pattern, u8 len); 488void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter); 489struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void); 490int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter); 491void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter, 492 u8 *buf); 493 494#define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */ 495 496#define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */ 497#define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */ 498 499#define WL1271_DEFAULT_POWER_LEVEL 0 500 501#define WL1271_TX_QUEUE_LOW_WATERMARK 32 502#define WL1271_TX_QUEUE_HIGH_WATERMARK 256 503 504#define WL1271_DEFERRED_QUEUE_LIMIT 64 505 506/* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power 507 on in case is has been shut down shortly before */ 508#define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */ 509#define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */ 510 511/* Macros to handle wl1271.sta_rate_set */ 512#define HW_BG_RATES_MASK 0xffff 513#define HW_HT_RATES_OFFSET 16 514#define HW_MIMO_RATES_OFFSET 24 515 516#define WL12XX_HW_BLOCK_SIZE 256 517 518#endif /* __WLCORE_I_H__ */ 519