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         u32 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 struct ath9k_htc_vif {
 208         u8 index;
 209 };
 210
 211 #define ATH9K_HTC_MAX_STA 8
 212 #define ATH9K_HTC_MAX_TID 8
 213
 214 enum tid_aggr_state {
 215         AGGR_STOP = 0,
 216         AGGR_PROGRESS,
 217         AGGR_START,
 218         AGGR_OPERATIONAL
 219 };
 220
 221 struct ath9k_htc_sta {
 222         u8 index;
 223         enum tid_aggr_state tid_state[ATH9K_HTC_MAX_TID];
 224 };
 225
 226 #define ATH9K_HTC_RXBUF 256
 227 #define HTC_RX_FRAME_HEADER_SIZE 40
 228
 229 struct ath9k_htc_rxbuf {
 230         bool in_process;
 231         struct sk_buff *skb;
 232         struct ath_htc_rx_status rxstatus;
 233         struct list_head list;
 234 };
 235
 236 struct ath9k_htc_rx {
 237         int last_rssi; /* FIXME: per-STA */
 238         struct list_head rxbuf;
 239         spinlock_t rxbuflock;
 240 };
 241
 242 struct ath9k_htc_tx_ctl {
 243         u8 type; /* ATH9K_HTC_* */
 244 };
 245
 246 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 247
 248 #define TX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.tx_stats.c++)
 249 #define RX_STAT_INC(c) (hif_dev->htc_handle->drv_priv->debug.rx_stats.c++)
 250
 251 #define TX_QSTAT_INC(q) (priv->debug.tx_stats.queue_stats[q]++)
 252
 253 struct ath_tx_stats {
 254         u32 buf_queued;
 255         u32 buf_completed;
 256         u32 skb_queued;
 257         u32 skb_completed;
 258         u32 skb_dropped;
 259         u32 queue_stats[WME_NUM_AC];
 260 };
 261
 262 struct ath_rx_stats {
 263         u32 skb_allocated;
 264         u32 skb_completed;
 265         u32 skb_dropped;
 266 };
 267
 268 struct ath9k_debug {
 269         struct dentry *debugfs_phy;
 270         struct dentry *debugfs_tgt_stats;
 271         struct dentry *debugfs_xmit;
 272         struct dentry *debugfs_recv;
 273         struct ath_tx_stats tx_stats;
 274         struct ath_rx_stats rx_stats;
 275         u32 txrate;
 276 };
 277
 278 #else
 279
 280 #define TX_STAT_INC(c) do { } while (0)
 281 #define RX_STAT_INC(c) do { } while (0)
 282
 283 #define TX_QSTAT_INC(c) do { } while (0)
 284
 285 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 286
 287 #define ATH_LED_PIN_DEF             1
 288 #define ATH_LED_PIN_9287            8
 289 #define ATH_LED_PIN_9271            15
 290 #define ATH_LED_PIN_7010            12
 291 #define ATH_LED_ON_DURATION_IDLE    350 /* in msecs */
 292 #define ATH_LED_OFF_DURATION_IDLE   250 /* in msecs */
 293
 294 enum ath_led_type {
 295         ATH_LED_RADIO,
 296         ATH_LED_ASSOC,
 297         ATH_LED_TX,
 298         ATH_LED_RX
 299 };
 300
 301 struct ath_led {
 302         struct ath9k_htc_priv *priv;
 303         struct led_classdev led_cdev;
 304         enum ath_led_type led_type;
 305         struct delayed_work brightness_work;
 306         char name[32];
 307         bool registered;
 308         int brightness;
 309 };
 310
 311 struct htc_beacon_config {
 312         u16 beacon_interval;
 313         u16 listen_interval;
 314         u16 dtim_period;
 315         u16 bmiss_timeout;
 316         u8 dtim_count;
 317 };
 318
 319 #define OP_INVALID        BIT(0)
 320 #define OP_SCANNING       BIT(1)
 321 #define OP_FULL_RESET     BIT(2)
 322 #define OP_LED_ASSOCIATED BIT(3)
 323 #define OP_LED_ON         BIT(4)
 324 #define OP_PREAMBLE_SHORT BIT(5)
 325 #define OP_PROTECT_ENABLE BIT(6)
 326 #define OP_ASSOCIATED     BIT(7)
 327 #define OP_ENABLE_BEACON  BIT(8)
 328 #define OP_LED_DEINIT     BIT(9)
 329 #define OP_UNPLUGGED      BIT(10)
 330
 331 struct ath9k_htc_priv {
 332         struct device *dev;
 333         struct ieee80211_hw *hw;
 334         struct ath_hw *ah;
 335         struct htc_target *htc;
 336         struct wmi *wmi;
 337
 338         enum htc_endpoint_id wmi_cmd_ep;
 339         enum htc_endpoint_id beacon_ep;
 340         enum htc_endpoint_id cab_ep;
 341         enum htc_endpoint_id uapsd_ep;
 342         enum htc_endpoint_id mgmt_ep;
 343         enum htc_endpoint_id data_be_ep;
 344         enum htc_endpoint_id data_bk_ep;
 345         enum htc_endpoint_id data_vi_ep;
 346         enum htc_endpoint_id data_vo_ep;
 347
 348         u16 op_flags;
 349         u16 curtxpow;
 350         u16 txpowlimit;
 351         u16 nvifs;
 352         u16 nstations;
 353         u16 seq_no;
 354         u32 bmiss_cnt;
 355
 356         spinlock_t beacon_lock;
 357
 358         bool tx_queues_stop;
 359         spinlock_t tx_lock;
 360
 361         struct ieee80211_vif *vif;
 362         struct htc_beacon_config cur_beacon_conf;
 363         unsigned int rxfilter;
 364         struct tasklet_struct wmi_tasklet;
 365         struct tasklet_struct rx_tasklet;
 366         struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 367         struct ath9k_htc_rx rx;
 368         struct tasklet_struct tx_tasklet;
 369         struct sk_buff_head tx_queue;
 370         struct delayed_work ath9k_ani_work;
 371         struct work_struct ps_work;
 372
 373         struct mutex htc_pm_lock;
 374         unsigned long ps_usecount;
 375         bool ps_enabled;
 376         bool ps_idle;
 377
 378         struct ath_led radio_led;
 379         struct ath_led assoc_led;
 380         struct ath_led tx_led;
 381         struct ath_led rx_led;
 382         struct delayed_work ath9k_led_blink_work;
 383         int led_on_duration;
 384         int led_off_duration;
 385         int led_on_cnt;
 386         int led_off_cnt;
 387
 388         int beaconq;
 389         int cabq;
 390         int hwq_map[WME_NUM_AC];
 391
 392 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 393         struct ath9k_debug debug;
 394 #endif
 395         struct mutex mutex;
 396 };
 397
 398 static inline void ath_read_cachesize(struct ath_common *common, int *csz)
 399 {
 400         common->bus_ops->read_cachesize(common, csz);
 401 }
 402
 403 void ath9k_htc_beaconq_config(struct ath9k_htc_priv *priv);
 404 void ath9k_htc_beacon_config(struct ath9k_htc_priv *priv,
 405                              struct ieee80211_vif *vif);
 406 void ath9k_htc_swba(struct ath9k_htc_priv *priv, u8 beacon_pending);
 407
 408 void ath9k_htc_rxep(void *priv, struct sk_buff *skb,
 409                     enum htc_endpoint_id ep_id);
 410 void ath9k_htc_txep(void *priv, struct sk_buff *skb, enum htc_endpoint_id ep_id,
 411                     bool txok);
 412 void ath9k_htc_beaconep(void *drv_priv, struct sk_buff *skb,
 413                         enum htc_endpoint_id ep_id, bool txok);
 414
 415 void ath9k_htc_station_work(struct work_struct *work);
 416 void ath9k_htc_aggr_work(struct work_struct *work);
 417 void ath9k_ani_work(struct work_struct *work);;
 418
 419 int ath9k_tx_init(struct ath9k_htc_priv *priv);
 420 void ath9k_tx_tasklet(unsigned long data);
 421 int ath9k_htc_tx_start(struct ath9k_htc_priv *priv, struct sk_buff *skb);
 422 void ath9k_tx_cleanup(struct ath9k_htc_priv *priv);
 423 bool ath9k_htc_txq_setup(struct ath9k_htc_priv *priv, int subtype);
 424 int ath9k_htc_cabq_setup(struct ath9k_htc_priv *priv);
 425 int get_hw_qnum(u16 queue, int *hwq_map);
 426 int ath_htc_txq_update(struct ath9k_htc_priv *priv, int qnum,
 427                        struct ath9k_tx_queue_info *qinfo);
 428
 429 int ath9k_rx_init(struct ath9k_htc_priv *priv);
 430 void ath9k_rx_cleanup(struct ath9k_htc_priv *priv);
 431 void ath9k_host_rx_init(struct ath9k_htc_priv *priv);
 432 void ath9k_rx_tasklet(unsigned long data);
 433 u32 ath9k_htc_calcrxfilter(struct ath9k_htc_priv *priv);
 434
 435 void ath9k_htc_ps_wakeup(struct ath9k_htc_priv *priv);
 436 void ath9k_htc_ps_restore(struct ath9k_htc_priv *priv);
 437 void ath9k_ps_work(struct work_struct *work);
 438
 439 void ath9k_start_rfkill_poll(struct ath9k_htc_priv *priv);
 440 void ath9k_init_leds(struct ath9k_htc_priv *priv);
 441 void ath9k_deinit_leds(struct ath9k_htc_priv *priv);
 442
 443 int ath9k_htc_probe_device(struct htc_target *htc_handle, struct device *dev,
 444                            u16 devid);
 445 void ath9k_htc_disconnect_device(struct htc_target *htc_handle, bool hotunplug);
 446 #ifdef CONFIG_PM
 447 int ath9k_htc_resume(struct htc_target *htc_handle);
 448 #endif
 449 #ifdef CONFIG_ATH9K_HTC_DEBUGFS
 450 int ath9k_htc_debug_create_root(void);
 451 void ath9k_htc_debug_remove_root(void);
 452 int ath9k_htc_init_debug(struct ath_hw *ah);
 453 void ath9k_htc_exit_debug(struct ath_hw *ah);
 454 #else
 455 static inline int ath9k_htc_debug_create_root(void) { return 0; };
 456 static inline void ath9k_htc_debug_remove_root(void) {};
 457 static inline int ath9k_htc_init_debug(struct ath_hw *ah) { return 0; };
 458 static inline void ath9k_htc_exit_debug(struct ath_hw *ah) {};
 459 #endif /* CONFIG_ATH9K_HTC_DEBUGFS */
 460
 461 #endif /* HTC_H */