drivers/net/wireless/ath/ath9k/htc.h

   1 /*
   2  * Copyright (c) 2010 Atheros Communications Inc.
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 #ifndef HTC_H
  18 #define HTC_H
  19
  20 #include <linux/module.h>
  21 #include <linux/usb.h>
  22 #include <linux/firmware.h>
  23 #include <linux/skbuff.h>
  24 #include <linux/netdevice.h>
  25 #include <linux/leds.h>
  26 #include <linux/slab.h>
  27 #include <net/mac80211.h>
  28
  29 #include "common.h"
  30 #include "htc_hst.h"
  31 #include "hif_usb.h"
  32 #include "wmi.h"
  33
  34 #define ATH_STA_SHORT_CALINTERVAL 1000    /* 1 second */
  35 #define ATH_AP_SHORT_CALINTERVAL  100     /* 100 ms */
  36 #define ATH_ANI_POLLINTERVAL      100     /* 100 ms */
  37 #define ATH_LONG_CALINTERVAL      30000   /* 30 seconds */
  38 #define ATH_RESTART_CALINTERVAL   1200000 /* 20 minutes */
  39
  40 #define ATH_DEFAULT_BMISS_LIMIT 10
  41 #define IEEE80211_MS_TO_TU(x)   (((x) * 1000) / 1024)
  42 #define TSF_TO_TU(_h, _l) \
  43         ((((u32)(_h)) << 22) | (((u32)(_l)) >> 10))
  44
  45 extern struct ieee80211_ops ath9k_htc_ops;
  46 extern int htc_modparam_nohwcrypt;
  47
  48 enum htc_phymode {
  49         HTC_MODE_AUTO           = 0,
  50         HTC_MODE_11A            = 1,
  51         HTC_MODE_11B            = 2,
  52         HTC_MODE_11G            = 3,
  53         HTC_MODE_FH             = 4,
  54         HTC_MODE_TURBO_A        = 5,
  55         HTC_MODE_TURBO_G        = 6,
  56         HTC_MODE_11NA           = 7,
  57         HTC_MODE_11NG           = 8
  58 };
  59
  60 enum htc_opmode {
  61         HTC_M_STA       = 1,
  62         HTC_M_IBSS      = 0,
  63         HTC_M_AHDEMO    = 3,
  64         HTC_M_HOSTAP    = 6,
  65         HTC_M_MONITOR   = 8,
  66         HTC_M_WDS       = 2
  67 };
  68
  69 #define ATH9K_HTC_HDRSPACE sizeof(struct htc_frame_hdr)
  70 #define ATH9K_HTC_AMPDU 1
  71 #define ATH9K_HTC_NORMAL 2
  72
  73 #define ATH9K_HTC_TX_CTSONLY      0x1
  74 #define ATH9K_HTC_TX_RTSCTS       0x2
  75 #define ATH9K_HTC_TX_USE_MIN_RATE 0x100
  76
  77 struct tx_frame_hdr {
  78         u8 data_type;
  79         u8 node_idx;
  80         u8 vif_idx;
  81         u8 tidno;
  82         __be32 flags; /* ATH9K_HTC_TX_* */
  83         u8 key_type;
  84         u8 keyix;
  85         u8 reserved[26];
  86 } __packed;
  87
  88 struct tx_mgmt_hdr {
  89         u8 node_idx;
  90         u8 vif_idx;
  91         u8 tidno;
  92         u8 flags;
  93         u8 key_type;
  94         u8 keyix;
  95         u16 reserved;
  96 } __packed;
  97
  98 struct tx_beacon_header {
  99         u8 vif_index;
 100         u8 len_changed;
 101         u16 rev;
 102 } __packed;
 103
 104 struct ath9k_htc_target_hw {
 105         u32 flags;
 106         u32 flags_ext;
 107         u32 ampdu_limit;
 108         u8 ampdu_subframes;
 109         u8 tx_chainmask;
 110         u8 tx_chainmask_legacy;
 111         u8 rtscts_ratecode;
 112         u8 protmode;
 113 } __packed;
 114
 115 struct ath9k_htc_cap_target {
 116         u32 flags;
 117         u32 flags_ext;
 118         u32 ampdu_limit;
 119         u8 ampdu_subframes;
 120         u8 tx_chainmask;
 121         u8 tx_chainmask_legacy;
 122         u8 rtscts_ratecode;
 123         u8 protmode;
 124 } __packed;
 125
 126 struct ath9k_htc_target_vif {
 127         u8 index;
 128         u8 des_bssid[ETH_ALEN];
 129         __be32 opmode;
 130         u8 myaddr[ETH_ALEN];
 131         u8 bssid[ETH_ALEN];
 132         u32 flags;
 133         u32 flags_ext;
 134         u16 ps_sta;
 135         __be16 rtsthreshold;
 136         u8 ath_cap;
 137         u8 node;
 138         s8 mcast_rate;
 139 } __packed;
 140
 141 #define ATH_HTC_STA_AUTH  0x0001
 142 #define ATH_HTC_STA_QOS   0x0002
 143 #define ATH_HTC_STA_ERP   0x0004
 144 #define ATH_HTC_STA_HT    0x0008
 145
 146 /* FIXME: UAPSD variables */
 147 struct ath9k_htc_target_sta {
 148         u16 associd;
 149         u16 txpower;
 150         u32 ucastkey;
 151         u8 macaddr[ETH_ALEN];
 152         u8 bssid[ETH_ALEN];
 153         u8 sta_index;
 154         u8 vif_index;
 155         u8 vif_sta;
 156         __be16 flags; /* ATH_HTC_STA_* */
 157         u16 htcap;
 158         u8 valid;
 159         u16 capinfo;
 160         struct ath9k_htc_target_hw *hw;
 161         struct ath9k_htc_target_vif *vif;
 162         u16 txseqmgmt;
 163         u8 is_vif_sta;
 164         u16 maxampdu;
 165         u16 iv16;
 166         u32 iv32;
 167 } __packed;
 168
 169 struct ath9k_htc_target_aggr {
 170         u8 sta_index;
 171         u8 tidno;
 172         u8 aggr_enable;
 173         u8 padding;
 174 } __packed;
 175
 176 #define ATH_HTC_RATE_MAX 30
 177
 178 #define WLAN_RC_DS_FLAG  0x01
 179 #define WLAN_RC_40_FLAG  0x02
 180 #define WLAN_RC_SGI_FLAG 0x04
 181 #define WLAN_RC_HT_FLAG  0x08
 182
 183 struct ath9k_htc_rateset {
 184         u8 rs_nrates;
 185         u8 rs_rates[ATH_HTC_RATE_MAX];
 186 };
 187
 188 struct ath9k_htc_rate {
 189         struct ath9k_htc_rateset legacy_rates;
 190         struct ath9k_htc_rateset ht_rates;
 191 } __packed;
 192
 193 struct ath9k_htc_target_rate {
 194         u8 sta_index;
 195         u8 isnew;
 196         __be32 capflags;
 197         struct ath9k_htc_rate rates;
 198 };
 199
 200 struct ath9k_htc_target_stats {
 201         __be32 tx_shortretry;
 202         __be32 tx_longretry;
 203         __be32 tx_xretries;
 204         __be32 ht_txunaggr_xretry;
 205         __be32 ht_tx_xretries;
 206 } __packed;
 207
 208 #define ATH9K_HTC_MAX_VIF 2
 209 #define ATH9K_HTC_MAX_BCN_VIF 2
 210
 211 #define INC_VIF(_priv, _type) do {              \
 212                 switch (_type) {                \
 213                 case NL80211_IFTYPE_STATION:    \
 214                         _priv->num_sta_vif++;   \
 215                         break;                  \
 216                 case NL80211_IFTYPE_ADHOC:      \
 217                         _priv->num_ibss_vif++;  \
 218                         break;                  \
 219                 case NL80211_IFTYPE_AP:         \
 220                         _priv->num_ap_vif++;    \
 221                         break;                  \
 222                 default:                        \
 223                         break;                  \
 224                 }                               \
 225         } while (0)
 226
 227 #define DEC_VIF(_priv, _type) do {              \
 228                 switch (_type) {                \
 229                 case NL80211_IFTYPE_STATION:    \
 230                         _priv->num_sta_vif--;   \
 231                         break;                  \
 232                 case NL80211_IFTYPE_ADHOC:      \
 233                         _priv->num_ibss_vif--;  \
 234                         break;                  \
 235                 case NL80211_IFTYPE_AP:         \
 236                         _priv->num_ap_vif--;    \
 237                         break;                  \
 238                 default:                        \
 239                         break;                  \
 240                 }                               \
 241         } while (0)
 242
 243 struct ath9k_htc_vif {
 244         u8 index;
 245         u16 seq_no;
 246         bool beacon_configured;
 247 };
 248
 249 struct ath9k_vif_iter_data {
 250         const u8 *hw_macaddr;
 251         u8 mask[ETH_ALEN];
 252 };
 253
 254 #define ATH9K_HTC_MAX_STA 8
 255 #define ATH9K_HTC_MAX_TID 8
 256
 257 enum tid_aggr_state {
 258         AGGR_STOP = 0,
 259         AGGR_PROGRESS,
 260         AGGR_START,
 261         AGGR_OPERATIONAL
 262 };
 263
 264 struct ath9k_htc_sta {
 265         u8 index;
 266         enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
 267 };
 268
 269 #define ATH9K_HTC_RXBUF 256
 270 #define HTC_RX_FRAME_HEADER_SIZE 40
 271
 272 struct ath9k_htc_rxbuf {
 273         bool in_process;
 274         struct sk_buff *skb;
 275         struct ath_htc_rx_status rxstatus;
 276         struct list_head list;
 277 };
 278
 279 struct ath9k_htc_rx {
 280         int last_rssi; /* FIXME: per-STA */
 281         struct list_head rxbuf;
 282         spinlock_t rxbuflock;
 283 };
 284
 285 struct ath9k_htc_tx_ctl {
 286         u8 type; /* ATH9K_HTC_* */
 287 };
 288
 289 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 290
 291 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
 292 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
 293
 294 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
 295
 296 struct ath_tx_stats {
 297         u32 buf_queued;
 298         u32 buf_completed;
 299         u32 skb_queued;
 300         u32 skb_completed;
 301         u32 skb_dropped;
 302         u32 queue_stats[WME_NUM_AC];
 303 };
 304
 305 struct ath_rx_stats {
 306         u32 skb_allocated;
 307         u32 skb_completed;
 308         u32 skb_dropped;
 309 };
 310
 311 struct ath9k_debug {
 312         struct dentry *debugfs_phy;
 313         struct dentry *debugfs_tgt_stats;
 314         struct dentry *debugfs_xmit;
 315         struct dentry *debugfs_recv;
 316         struct ath_tx_stats tx_stats;
 317         struct ath_rx_stats rx_stats;
 318         u32 txrate;
 319 };
 320
 321 #else
 322
 323 #define TX_STAT_INC(c) do { } while (0)
 324 #define RX_STAT_INC(c) do { } while (0)
 325
 326 #define TX_QSTAT_INC(c) do { } while (0)
 327
 328 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 329
 330 #define ATH_LED_PIN_DEF             1
 331 #define ATH_LED_PIN_9287            10
 332 #define ATH_LED_PIN_9271            15
 333 #define ATH_LED_PIN_7010            12
 334 #define ATH_LED_ON_DURATION_IDLE    350 /* in msecs */
 335 #define ATH_LED_OFF_DURATION_IDLE   250 /* in msecs */
 336
 337 enum ath_led_type {
 338         ATH_LED_RADIO,
 339         ATH_LED_ASSOC,
 340         ATH_LED_TX,
 341         ATH_LED_RX
 342 };
 343
 344 struct ath_led {
 345         struct ath9k_htc_priv *priv;
 346         struct led_classdev led_cdev;
 347         enum ath_led_type led_type;
 348         struct delayed_work brightness_work;
 349         char name[32];
 350         bool registered;
 351         int brightness;
 352 };
 353
 354 struct htc_beacon_config {
 355         u16 beacon_interval;
 356         u16 dtim_period;
 357         u16 bmiss_timeout;
 358 };
 359
 360 struct ath_btcoex {
 361         u32 bt_priority_cnt;
 362         unsigned long bt_priority_time;
 363         int bt_stomp_type; /* Types of BT stomping */
 364         u32 btcoex_no_stomp;
 365         u32 btcoex_period;
 366         u32 btscan_no_stomp;
 367 };
 368
 369 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
 370 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
 371 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
 372
 373 #define OP_INVALID                 BIT(0)
 374 #define OP_SCANNING                BIT(1)
 375 #define OP_LED_ASSOCIATED          BIT(2)
 376 #define OP_LED_ON                  BIT(3)
 377 #define OP_ENABLE_BEACON           BIT(4)
 378 #define OP_LED_DEINIT              BIT(5)
 379 #define OP_BT_PRIORITY_DETECTED    BIT(6)
 380 #define OP_BT_SCAN                 BIT(7)
 381 #define OP_ANI_RUNNING             BIT(8)
 382 #define OP_TSF_RESET               BIT(9)
 383
 384 struct ath9k_htc_priv {
 385         struct device *dev;
 386         struct ieee80211_hw *hw;
 387         struct ath_hw *ah;
 388         struct htc_target *htc;
 389         struct wmi *wmi;
 390
 391         u16 fw_version_major;
 392         u16 fw_version_minor;
 393
 394         enum htc_endpoint_id wmi_cmd_ep;
 395         enum htc_endpoint_id beacon_ep;
 396         enum htc_endpoint_id cab_ep;
 397         enum htc_endpoint_id uapsd_ep;
 398         enum htc_endpoint_id mgmt_ep;
 399         enum htc_endpoint_id data_be_ep;
 400         enum htc_endpoint_id data_bk_ep;
 401         enum htc_endpoint_id data_vi_ep;
 402         enum htc_endpoint_id data_vo_ep;
 403
 404         u8 vif_slot;
 405         u8 mon_vif_idx;
 406         u8 sta_slot;
 407         u8 vif_sta_pos[ATH9K_HTC_MAX_VIF];
 408         u8 num_ibss_vif;
 409         u8 num_sta_vif;
 410         u8 num_ap_vif;
 411
 412         u16 op_flags;
 413         u16 curtxpow;
 414         u16 txpowlimit;
 415         u16 nvifs;
 416         u16 nstations;
 417         u32 bmiss_cnt;
 418         bool rearm_ani;
 419         bool reconfig_beacon;
 420
 421         struct ath9k_hw_cal_data caldata;
 422
 423         spinlock_t beacon_lock;
 424
 425         bool tx_queues_stop;
 426         spinlock_t tx_lock;
 427
 428         struct ieee80211_vif *vif;
 429         struct htc_beacon_config cur_beacon_conf;
 430         unsigned int rxfilter;
 431         struct tasklet_struct swba_tasklet;
 432         struct tasklet_struct rx_tasklet;
 433         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 434         struct ath9k_htc_rx rx;
 435         struct tasklet_struct tx_tasklet;
 436         struct sk_buff_head tx_queue;
 437         struct delayed_work ani_work;
 438         struct work_struct ps_work;
 439         struct work_struct fatal_work;
 440
 441         struct mutex htc_pm_lock;
 442         unsigned long ps_usecount;
 443         bool ps_enabled;
 444         bool ps_idle;
 445
 446         struct ath_led radio_led;
 447         struct ath_led assoc_led;
 448         struct ath_led tx_led;
 449         struct ath_led rx_led;
 450         struct delayed_work ath9k_led_blink_work;
 451         int led_on_duration;
 452         int led_off_duration;
 453         int led_on_cnt;
 454         int led_off_cnt;
 455
 456         int beaconq;
 457         int cabq;
 458         int hwq_map[WME_NUM_AC];
 459
 460         struct ath_btcoex btcoex;
 461         struct delayed_work coex_period_work;
 462         struct delayed_work duty_cycle_work;
 463 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 464         struct ath9k_debug debug;
 465 #endif
 466         struct mutex mutex;
 467 };
 468
 469 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
 470 {
 471         common->bus_ops->read_cachesize(common, csz);
 472 }
 473
 474 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
 475
 476 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
 477 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
 478                              struct ieee80211_vif *vif);
 479 void ath9k_htc_beacon_reconfig(struct ath9k_htc_priv *priv);
 480 void ath9k_htc_swba(struct ath9k_htc_priv *priv, u8 beacon_pending);
 481
 482 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
 483                     enum htc_endpoint_id ep_id);
 484 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
 485                     bool txok);
 486 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
 487                         enum htc_endpoint_id ep_id, bool txok);
 488
 489 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv);
 490 void ath9k_htc_station_work(struct work_struct *work);
 491 void ath9k_htc_aggr_work(struct work_struct *work);
 492 void ath9k_htc_ani_work(struct work_struct *work);
 493 void ath9k_htc_start_ani(struct ath9k_htc_priv *priv);
 494 void ath9k_htc_stop_ani(struct ath9k_htc_priv *priv);
 495
 496 int ath9k_tx_init(struct ath9k_htc_priv *priv);
 497 void ath9k_tx_tasklet(unsigned long data);
 498 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv, struct sk_buff *skb);
 499 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
 500 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
 501 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
 502 int get_hw_qnum(u16 queue, int *hwq_map);
 503 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
 504                        struct ath9k_tx_queue_info *qinfo);
 505
 506 int ath9k_rx_init(struct ath9k_htc_priv *priv);
 507 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
 508 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
 509 void ath9k_rx_tasklet(unsigned long data);
 510 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
 511
 512 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
 513 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
 514 void ath9k_ps_work(struct work_struct *work);
 515 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
 516                         enum ath9k_power_mode mode);
 517
 518 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
 519 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
 520 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
 521 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
 522 void ath9k_led_stop_brightness(struct ath9k_htc_priv *priv);
 523 void ath9k_init_leds(struct ath9k_htc_priv *priv);
 524 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
 525
 526 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
 527                            u16 devid, char *product, u32 drv_info);
 528 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
 529 #ifdef CONFIG_PM
 530 void ath9k_htc_suspend(struct htc_target *htc_handle);
 531 int ath9k_htc_resume(struct htc_target *htc_handle);
 532 #endif
 533 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 534 int ath9k_htc_debug_create_root(void);
 535 void ath9k_htc_debug_remove_root(void);
 536 int ath9k_htc_init_debug(struct ath_hw *ah);
 537 void ath9k_htc_exit_debug(struct ath_hw *ah);
 538 #else
 539 static inline int ath9k_htc_debug_create_root(void) { return 0; };
 540 static inline void ath9k_htc_debug_remove_root(void) {};
 541 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
 542 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
 543 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 544
 545 #endif /* HTC_H */