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