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         int bslot;
 248         __le64 tsfadjust;
 249 };
 250
 251 struct ath9k_vif_iter_data {
 252         const u8 *hw_macaddr;
 253         u8 mask[ETH_ALEN];
 254 };
 255
 256 #define ATH9K_HTC_MAX_STA 8
 257 #define ATH9K_HTC_MAX_TID 8
 258
 259 enum tid_aggr_state {
 260         AGGR_STOP = 0,
 261         AGGR_PROGRESS,
 262         AGGR_START,
 263         AGGR_OPERATIONAL
 264 };
 265
 266 struct ath9k_htc_sta {
 267         u8 index;
 268         enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
 269 };
 270
 271 #define ATH9K_HTC_RXBUF 256
 272 #define HTC_RX_FRAME_HEADER_SIZE 40
 273
 274 struct ath9k_htc_rxbuf {
 275         bool in_process;
 276         struct sk_buff *skb;
 277         struct ath_htc_rx_status rxstatus;
 278         struct list_head list;
 279 };
 280
 281 struct ath9k_htc_rx {
 282         int last_rssi; /* FIXME: per-STA */
 283         struct list_head rxbuf;
 284         spinlock_t rxbuflock;
 285 };
 286
 287 struct ath9k_htc_tx_ctl {
 288         u8 type; /* ATH9K_HTC_* */
 289 };
 290
 291 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 292
 293 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
 294 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
 295 #define CAB_STAT_INC   priv->debug.tx_stats.cab_queued++
 296
 297 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
 298
 299 struct ath_tx_stats {
 300         u32 buf_queued;
 301         u32 buf_completed;
 302         u32 skb_queued;
 303         u32 skb_completed;
 304         u32 skb_dropped;
 305         u32 cab_queued;
 306         u32 queue_stats[WME_NUM_AC];
 307 };
 308
 309 struct ath_rx_stats {
 310         u32 skb_allocated;
 311         u32 skb_completed;
 312         u32 skb_dropped;
 313 };
 314
 315 struct ath9k_debug {
 316         struct dentry *debugfs_phy;
 317         struct dentry *debugfs_tgt_stats;
 318         struct dentry *debugfs_xmit;
 319         struct dentry *debugfs_recv;
 320         struct ath_tx_stats tx_stats;
 321         struct ath_rx_stats rx_stats;
 322         u32 txrate;
 323 };
 324
 325 #else
 326
 327 #define TX_STAT_INC(c) do { } while (0)
 328 #define RX_STAT_INC(c) do { } while (0)
 329 #define CAB_STAT_INC   do { } while (0)
 330
 331 #define TX_QSTAT_INC(c) do { } while (0)
 332
 333 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 334
 335 #define ATH_LED_PIN_DEF             1
 336 #define ATH_LED_PIN_9287            10
 337 #define ATH_LED_PIN_9271            15
 338 #define ATH_LED_PIN_7010            12
 339 #define ATH_LED_ON_DURATION_IDLE    350 /* in msecs */
 340 #define ATH_LED_OFF_DURATION_IDLE   250 /* in msecs */
 341
 342 enum ath_led_type {
 343         ATH_LED_RADIO,
 344         ATH_LED_ASSOC,
 345         ATH_LED_TX,
 346         ATH_LED_RX
 347 };
 348
 349 struct ath_led {
 350         struct ath9k_htc_priv *priv;
 351         struct led_classdev led_cdev;
 352         enum ath_led_type led_type;
 353         struct delayed_work brightness_work;
 354         char name[32];
 355         bool registered;
 356         int brightness;
 357 };
 358
 359 #define BSTUCK_THRESHOLD 10
 360
 361 /*
 362  * Adjust these when the max. no of beaconing interfaces is
 363  * increased.
 364  */
 365 #define DEFAULT_SWBA_RESPONSE 40 /* in TUs */
 366 #define MIN_SWBA_RESPONSE     10 /* in TUs */
 367
 368 struct htc_beacon_config {
 369         struct ieee80211_vif *bslot[ATH9K_HTC_MAX_BCN_VIF];
 370         u16 beacon_interval;
 371         u16 dtim_period;
 372         u16 bmiss_timeout;
 373         u32 bmiss_cnt;
 374 };
 375
 376 struct ath_btcoex {
 377         u32 bt_priority_cnt;
 378         unsigned long bt_priority_time;
 379         int bt_stomp_type; /* Types of BT stomping */
 380         u32 btcoex_no_stomp;
 381         u32 btcoex_period;
 382         u32 btscan_no_stomp;
 383 };
 384
 385 void ath_htc_init_btcoex_work(struct ath9k_htc_priv *priv);
 386 void ath_htc_resume_btcoex_work(struct ath9k_htc_priv *priv);
 387 void ath_htc_cancel_btcoex_work(struct ath9k_htc_priv *priv);
 388
 389 #define OP_INVALID                 BIT(0)
 390 #define OP_SCANNING                BIT(1)
 391 #define OP_LED_ASSOCIATED          BIT(2)
 392 #define OP_LED_ON                  BIT(3)
 393 #define OP_ENABLE_BEACON           BIT(4)
 394 #define OP_LED_DEINIT              BIT(5)
 395 #define OP_BT_PRIORITY_DETECTED    BIT(6)
 396 #define OP_BT_SCAN                 BIT(7)
 397 #define OP_ANI_RUNNING             BIT(8)
 398 #define OP_TSF_RESET               BIT(9)
 399
 400 struct ath9k_htc_priv {
 401         struct device *dev;
 402         struct ieee80211_hw *hw;
 403         struct ath_hw *ah;
 404         struct htc_target *htc;
 405         struct wmi *wmi;
 406
 407         u16 fw_version_major;
 408         u16 fw_version_minor;
 409
 410         enum htc_endpoint_id wmi_cmd_ep;
 411         enum htc_endpoint_id beacon_ep;
 412         enum htc_endpoint_id cab_ep;
 413         enum htc_endpoint_id uapsd_ep;
 414         enum htc_endpoint_id mgmt_ep;
 415         enum htc_endpoint_id data_be_ep;
 416         enum htc_endpoint_id data_bk_ep;
 417         enum htc_endpoint_id data_vi_ep;
 418         enum htc_endpoint_id data_vo_ep;
 419
 420         u8 vif_slot;
 421         u8 mon_vif_idx;
 422         u8 sta_slot;
 423         u8 vif_sta_pos[ATH9K_HTC_MAX_VIF];
 424         u8 num_ibss_vif;
 425         u8 num_sta_vif;
 426         u8 num_ap_vif;
 427
 428         u16 op_flags;
 429         u16 curtxpow;
 430         u16 txpowlimit;
 431         u16 nvifs;
 432         u16 nstations;
 433         bool rearm_ani;
 434         bool reconfig_beacon;
 435
 436         struct ath9k_hw_cal_data caldata;
 437
 438         spinlock_t beacon_lock;
 439
 440         bool tx_queues_stop;
 441         spinlock_t tx_lock;
 442
 443         struct htc_beacon_config cur_beacon_conf;
 444         unsigned int rxfilter;
 445         struct tasklet_struct swba_tasklet;
 446         struct tasklet_struct rx_tasklet;
 447         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 448         struct ath9k_htc_rx rx;
 449         struct tasklet_struct tx_tasklet;
 450         struct sk_buff_head tx_queue;
 451         struct delayed_work ani_work;
 452         struct work_struct ps_work;
 453         struct work_struct fatal_work;
 454
 455         struct mutex htc_pm_lock;
 456         unsigned long ps_usecount;
 457         bool ps_enabled;
 458         bool ps_idle;
 459
 460         struct ath_led radio_led;
 461         struct ath_led assoc_led;
 462         struct ath_led tx_led;
 463         struct ath_led rx_led;
 464         struct delayed_work ath9k_led_blink_work;
 465         int led_on_duration;
 466         int led_off_duration;
 467         int led_on_cnt;
 468         int led_off_cnt;
 469
 470         int beaconq;
 471         int cabq;
 472         int hwq_map[WME_NUM_AC];
 473
 474         struct ath_btcoex btcoex;
 475         struct delayed_work coex_period_work;
 476         struct delayed_work duty_cycle_work;
 477 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 478         struct ath9k_debug debug;
 479 #endif
 480         struct mutex mutex;
 481 };
 482
 483 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
 484 {
 485         common->bus_ops->read_cachesize(common, csz);
 486 }
 487
 488 void ath9k_htc_reset(struct ath9k_htc_priv *priv);
 489
 490 void ath9k_htc_assign_bslot(struct ath9k_htc_priv *priv,
 491                             struct ieee80211_vif *vif);
 492 void ath9k_htc_remove_bslot(struct ath9k_htc_priv *priv,
 493                             struct ieee80211_vif *vif);
 494 void ath9k_htc_set_tsfadjust(struct ath9k_htc_priv *priv,
 495                              struct ieee80211_vif *vif);
 496 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
 497 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
 498                              struct ieee80211_vif *vif);
 499 void ath9k_htc_beacon_reconfig(struct ath9k_htc_priv *priv);
 500 void ath9k_htc_swba(struct ath9k_htc_priv *priv);
 501
 502 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
 503                     enum htc_endpoint_id ep_id);
 504 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
 505                     bool txok);
 506 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
 507                         enum htc_endpoint_id ep_id, bool txok);
 508
 509 int ath9k_htc_update_cap_target(struct ath9k_htc_priv *priv);
 510 void ath9k_htc_station_work(struct work_struct *work);
 511 void ath9k_htc_aggr_work(struct work_struct *work);
 512 void ath9k_htc_ani_work(struct work_struct *work);
 513 void ath9k_htc_start_ani(struct ath9k_htc_priv *priv);
 514 void ath9k_htc_stop_ani(struct ath9k_htc_priv *priv);
 515
 516 int ath9k_tx_init(struct ath9k_htc_priv *priv);
 517 void ath9k_tx_tasklet(unsigned long data);
 518 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv,
 519                        struct sk_buff *skb, bool is_cab);
 520 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
 521 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
 522 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
 523 int get_hw_qnum(u16 queue, int *hwq_map);
 524 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
 525                        struct ath9k_tx_queue_info *qinfo);
 526
 527 int ath9k_rx_init(struct ath9k_htc_priv *priv);
 528 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
 529 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
 530 void ath9k_rx_tasklet(unsigned long data);
 531 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
 532
 533 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
 534 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
 535 void ath9k_ps_work(struct work_struct *work);
 536 bool ath9k_htc_setpower(struct ath9k_htc_priv *priv,
 537                         enum ath9k_power_mode mode);
 538
 539 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
 540 void ath9k_htc_rfkill_poll_state(struct ieee80211_hw *hw);
 541 void ath9k_htc_radio_enable(struct ieee80211_hw *hw);
 542 void ath9k_htc_radio_disable(struct ieee80211_hw *hw);
 543 void ath9k_led_stop_brightness(struct ath9k_htc_priv *priv);
 544 void ath9k_init_leds(struct ath9k_htc_priv *priv);
 545 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
 546
 547 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
 548                            u16 devid, char *product, u32 drv_info);
 549 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
 550 #ifdef CONFIG_PM
 551 void ath9k_htc_suspend(struct htc_target *htc_handle);
 552 int ath9k_htc_resume(struct htc_target *htc_handle);
 553 #endif
 554 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 555 int ath9k_htc_debug_create_root(void);
 556 void ath9k_htc_debug_remove_root(void);
 557 int ath9k_htc_init_debug(struct ath_hw *ah);
 558 void ath9k_htc_exit_debug(struct ath_hw *ah);
 559 #else
 560 static inline int ath9k_htc_debug_create_root(void) { return 0; };
 561 static inline void ath9k_htc_debug_remove_root(void) {};
 562 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
 563 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
 564 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 565
 566 #endif /* HTC_H */