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 /* Use smaller padding for GEM, as some APs have issues when it's too big */ 49 #define WL1271_TX_SQN_POST_RECOVERY_PADDING_GEM 0x20 50 51 52 #define WL1271_CIPHER_SUITE_GEM 0x00147201 53 54 #define WL1271_BUSY_WORD_CNT 1 55 #define WL1271_BUSY_WORD_LEN (WL1271_BUSY_WORD_CNT * sizeof(u32)) 56 57 #define WL1271_ELP_HW_STATE_ASLEEP 0 58 #define WL1271_ELP_HW_STATE_IRQ 1 59 60 #define WL1271_DEFAULT_BEACON_INT 100 61 #define WL1271_DEFAULT_DTIM_PERIOD 1 62 63 #define WL12XX_MAX_ROLES 4 64 #define WL12XX_INVALID_ROLE_ID 0xff 65 #define WL12XX_INVALID_LINK_ID 0xff 66 67 /* 68 * max number of links allowed by all HWs. 69 * this is NOT the actual max links supported by the current hw. 70 */ 71 #define WLCORE_MAX_LINKS 16 72 73 /* the driver supports the 2.4Ghz and 5Ghz bands */ 74 #define WLCORE_NUM_BANDS 2 75 76 #define WL12XX_MAX_RATE_POLICIES 16 77 #define WLCORE_MAX_KLV_TEMPLATES 4 78 79 /* Defined by FW as 0. Will not be freed or allocated. */ 80 #define WL12XX_SYSTEM_HLID 0 81 82 /* 83 * When in AP-mode, we allow (at least) this number of packets 84 * to be transmitted to FW for a STA in PS-mode. Only when packets are 85 * present in the FW buffers it will wake the sleeping STA. We want to put 86 * enough packets for the driver to transmit all of its buffered data before 87 * the STA goes to sleep again. But we don't want to take too much memory 88 * as it might hurt the throughput of active STAs. 89 */ 90 #define WL1271_PS_STA_MAX_PACKETS 2 91 92 #define WL1271_AP_BSS_INDEX 0 93 #define WL1271_AP_DEF_BEACON_EXP 20 94 95 enum wlcore_state { 96 WLCORE_STATE_OFF, 97 WLCORE_STATE_RESTARTING, 98 WLCORE_STATE_ON, 99 }; 100 101 enum wl12xx_fw_type { 102 WL12XX_FW_TYPE_NONE, 103 WL12XX_FW_TYPE_NORMAL, 104 WL12XX_FW_TYPE_MULTI, 105 WL12XX_FW_TYPE_PLT, 106 }; 107 108 struct wl1271; 109 110 enum { 111 FW_VER_CHIP, 112 FW_VER_IF_TYPE, 113 FW_VER_MAJOR, 114 FW_VER_SUBTYPE, 115 FW_VER_MINOR, 116 117 NUM_FW_VER 118 }; 119 120 struct wl1271_chip { 121 u32 id; 122 char fw_ver_str[ETHTOOL_FWVERS_LEN]; 123 unsigned int fw_ver[NUM_FW_VER]; 124 char phy_fw_ver_str[ETHTOOL_FWVERS_LEN]; 125 }; 126 127 #define NUM_TX_QUEUES 4 128 129 struct wl_fw_status { 130 u32 intr; 131 u8 fw_rx_counter; 132 u8 drv_rx_counter; 133 u8 tx_results_counter; 134 __le32 *rx_pkt_descs; 135 136 u32 fw_localtime; 137 138 /* 139 * A bitmap (where each bit represents a single HLID) 140 * to indicate if the station is in PS mode. 141 */ 142 u32 link_ps_bitmap; 143 144 /* 145 * A bitmap (where each bit represents a single HLID) to indicate 146 * if the station is in Fast mode 147 */ 148 u32 link_fast_bitmap; 149 150 /* Cumulative counter of total released mem blocks since FW-reset */ 151 u32 total_released_blks; 152 153 /* Size (in Memory Blocks) of TX pool */ 154 u32 tx_total; 155 156 struct { 157 /* 158 * Cumulative counter of released packets per AC 159 * (length of the array is NUM_TX_QUEUES) 160 */ 161 u8 *tx_released_pkts; 162 163 /* 164 * Cumulative counter of freed packets per HLID 165 * (length of the array is wl->num_links) 166 */ 167 u8 *tx_lnk_free_pkts; 168 169 /* Cumulative counter of released Voice memory blocks */ 170 u8 tx_voice_released_blks; 171 172 /* Tx rate of the last transmitted packet */ 173 u8 tx_last_rate; 174 175 /* Tx rate or Tx rate estimate pre calculated by fw in mbps */ 176 u8 tx_last_rate_mbps; 177 178 /* hlid for which the rates were reported */ 179 u8 hlid; 180 } counters; 181 182 u32 log_start_addr; 183 184 /* Private status to be used by the lower drivers */ 185 void *priv; 186 }; 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 wl1271_if_operations *if_ops; 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 struct wl1271 *wl; 351 }; 352 353 struct wl12xx_vif { 354 struct wl1271 *wl; 355 struct list_head list; 356 unsigned long flags; 357 u8 bss_type; 358 u8 p2p; /* we are using p2p role */ 359 u8 role_id; 360 361 /* sta/ibss specific */ 362 u8 dev_role_id; 363 u8 dev_hlid; 364 365 union { 366 struct { 367 u8 hlid; 368 369 u8 basic_rate_idx; 370 u8 ap_rate_idx; 371 u8 p2p_rate_idx; 372 373 u8 klv_template_id; 374 375 bool qos; 376 /* channel type we started the STA role with */ 377 enum nl80211_channel_type role_chan_type; 378 } sta; 379 struct { 380 u8 global_hlid; 381 u8 bcast_hlid; 382 383 /* HLIDs bitmap of associated stations */ 384 unsigned long sta_hlid_map[BITS_TO_LONGS( 385 WLCORE_MAX_LINKS)]; 386 387 /* recoreded keys - set here before AP startup */ 388 struct wl1271_ap_key *recorded_keys[MAX_NUM_KEYS]; 389 390 u8 mgmt_rate_idx; 391 u8 bcast_rate_idx; 392 u8 ucast_rate_idx[CONF_TX_MAX_AC_COUNT]; 393 } ap; 394 }; 395 396 /* the hlid of the last transmitted skb */ 397 int last_tx_hlid; 398 399 /* counters of packets per AC, across all links in the vif */ 400 int tx_queue_count[NUM_TX_QUEUES]; 401 402 unsigned long links_map[BITS_TO_LONGS(WLCORE_MAX_LINKS)]; 403 404 u8 ssid[IEEE80211_MAX_SSID_LEN + 1]; 405 u8 ssid_len; 406 407 /* The current band */ 408 enum nl80211_band band; 409 int channel; 410 enum nl80211_channel_type channel_type; 411 412 u32 bitrate_masks[WLCORE_NUM_BANDS]; 413 u32 basic_rate_set; 414 415 /* 416 * currently configured rate set: 417 * bits 0-15 - 802.11abg rates 418 * bits 16-23 - 802.11n MCS index mask 419 * support only 1 stream, thus only 8 bits for the MCS rates (0-7). 420 */ 421 u32 basic_rate; 422 u32 rate_set; 423 424 /* probe-req template for the current AP */ 425 struct sk_buff *probereq; 426 427 /* Beaconing interval (needed for ad-hoc) */ 428 u32 beacon_int; 429 430 /* Default key (for WEP) */ 431 u32 default_key; 432 433 /* Our association ID */ 434 u16 aid; 435 436 /* retry counter for PSM entries */ 437 u8 psm_entry_retry; 438 439 /* in dBm */ 440 int power_level; 441 442 int rssi_thold; 443 int last_rssi_event; 444 445 /* save the current encryption type for auto-arp config */ 446 u8 encryption_type; 447 __be32 ip_addr; 448 449 /* RX BA constraint value */ 450 bool ba_support; 451 bool ba_allowed; 452 453 bool wmm_enabled; 454 455 bool radar_enabled; 456 457 /* Rx Streaming */ 458 struct work_struct rx_streaming_enable_work; 459 struct work_struct rx_streaming_disable_work; 460 struct timer_list rx_streaming_timer; 461 462 struct delayed_work channel_switch_work; 463 struct delayed_work connection_loss_work; 464 465 /* number of in connection stations */ 466 int inconn_count; 467 468 /* 469 * This vif's queues are mapped to mac80211 HW queues as: 470 * VO - hw_queue_base 471 * VI - hw_queue_base + 1 472 * BE - hw_queue_base + 2 473 * BK - hw_queue_base + 3 474 */ 475 int hw_queue_base; 476 477 /* do we have a pending auth reply? (and ROC) */ 478 bool ap_pending_auth_reply; 479 480 /* time when we sent the pending auth reply */ 481 unsigned long pending_auth_reply_time; 482 483 /* work for canceling ROC after pending auth reply */ 484 struct delayed_work pending_auth_complete_work; 485 486 /* update rate conrol */ 487 enum ieee80211_sta_rx_bandwidth rc_update_bw; 488 struct ieee80211_sta_ht_cap rc_ht_cap; 489 struct work_struct rc_update_work; 490 491 /* 492 * total freed FW packets on the link. 493 * For STA this holds the PN of the link to the AP. 494 * For AP this holds the PN of the broadcast link. 495 */ 496 u64 total_freed_pkts; 497 498 /* 499 * This struct must be last! 500 * data that has to be saved acrossed reconfigs (e.g. recovery) 501 * should be declared in this struct. 502 */ 503 struct { 504 u8 persistent[0]; 505 }; 506 }; 507 508 static inline struct wl12xx_vif *wl12xx_vif_to_data(struct ieee80211_vif *vif) 509 { 510 WARN_ON(!vif); 511 return (struct wl12xx_vif *)vif->drv_priv; 512 } 513 514 static inline 515 struct ieee80211_vif *wl12xx_wlvif_to_vif(struct wl12xx_vif *wlvif) 516 { 517 return container_of((void *)wlvif, struct ieee80211_vif, drv_priv); 518 } 519 520 static inline bool wlcore_is_p2p_mgmt(struct wl12xx_vif *wlvif) 521 { 522 return wl12xx_wlvif_to_vif(wlvif)->type == NL80211_IFTYPE_P2P_DEVICE; 523 } 524 525 #define wl12xx_for_each_wlvif(wl, wlvif) \ 526 list_for_each_entry(wlvif, &wl->wlvif_list, list) 527 528 #define wl12xx_for_each_wlvif_continue(wl, wlvif) \ 529 list_for_each_entry_continue(wlvif, &wl->wlvif_list, list) 530 531 #define wl12xx_for_each_wlvif_bss_type(wl, wlvif, _bss_type) \ 532 wl12xx_for_each_wlvif(wl, wlvif) \ 533 if (wlvif->bss_type == _bss_type) 534 535 #define wl12xx_for_each_wlvif_sta(wl, wlvif) \ 536 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_STA_BSS) 537 538 #define wl12xx_for_each_wlvif_ap(wl, wlvif) \ 539 wl12xx_for_each_wlvif_bss_type(wl, wlvif, BSS_TYPE_AP_BSS) 540 541 int wl1271_plt_start(struct wl1271 *wl, const enum plt_mode plt_mode); 542 int wl1271_plt_stop(struct wl1271 *wl); 543 int wl1271_recalc_rx_streaming(struct wl1271 *wl, struct wl12xx_vif *wlvif); 544 void wl12xx_queue_recovery_work(struct wl1271 *wl); 545 size_t wl12xx_copy_fwlog(struct wl1271 *wl, u8 *memblock, size_t maxlen); 546 int wl1271_rx_filter_alloc_field(struct wl12xx_rx_filter *filter, 547 u16 offset, u8 flags, 548 const u8 *pattern, u8 len); 549 void wl1271_rx_filter_free(struct wl12xx_rx_filter *filter); 550 struct wl12xx_rx_filter *wl1271_rx_filter_alloc(void); 551 int wl1271_rx_filter_get_fields_size(struct wl12xx_rx_filter *filter); 552 void wl1271_rx_filter_flatten_fields(struct wl12xx_rx_filter *filter, 553 u8 *buf); 554 555 #define JOIN_TIMEOUT 5000 /* 5000 milliseconds to join */ 556 557 #define SESSION_COUNTER_MAX 6 /* maximum value for the session counter */ 558 #define SESSION_COUNTER_INVALID 7 /* used with dummy_packet */ 559 560 #define WL1271_DEFAULT_POWER_LEVEL 0 561 562 #define WL1271_TX_QUEUE_LOW_WATERMARK 32 563 #define WL1271_TX_QUEUE_HIGH_WATERMARK 256 564 565 #define WL1271_DEFERRED_QUEUE_LIMIT 64 566 567 /* WL1271 needs a 200ms sleep after power on, and a 20ms sleep before power 568 on in case is has been shut down shortly before */ 569 #define WL1271_PRE_POWER_ON_SLEEP 20 /* in milliseconds */ 570 #define WL1271_POWER_ON_SLEEP 200 /* in milliseconds */ 571 572 /* Macros to handle wl1271.sta_rate_set */ 573 #define HW_BG_RATES_MASK 0xffff 574 #define HW_HT_RATES_OFFSET 16 575 #define HW_MIMO_RATES_OFFSET 24 576 577 #endif /* __WLCORE_I_H__ */ 578