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