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