668 lines · c
1/*2 * Atheros CARL9170 driver3 *4 * Driver specific definitions5 *6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>7 * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>8 *9 * This program is free software; you can redistribute it and/or modify10 * it under the terms of the GNU General Public License as published by11 * the Free Software Foundation; either version 2 of the License, or12 * (at your option) any later version.13 *14 * This program is distributed in the hope that it will be useful,15 * but WITHOUT ANY WARRANTY; without even the implied warranty of16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the17 * GNU General Public License for more details.18 *19 * You should have received a copy of the GNU General Public License20 * along with this program; see the file COPYING. If not, see21 * http://www.gnu.org/licenses/.22 *23 * This file incorporates work covered by the following copyright and24 * permission notice:25 * Copyright (c) 2007-2008 Atheros Communications, Inc.26 *27 * Permission to use, copy, modify, and/or distribute this software for any28 * purpose with or without fee is hereby granted, provided that the above29 * copyright notice and this permission notice appear in all copies.30 *31 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES32 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF33 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR34 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES35 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN36 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF37 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.38 */39#ifndef __CARL9170_H40#define __CARL9170_H41 42#include <linux/kernel.h>43#include <linux/firmware.h>44#include <linux/completion.h>45#include <linux/spinlock.h>46#include <linux/hw_random.h>47#include <net/cfg80211.h>48#include <net/mac80211.h>49#include <linux/usb.h>50#ifdef CONFIG_CARL9170_LEDS51#include <linux/leds.h>52#endif /* CONFIG_CARL9170_LEDS */53#ifdef CONFIG_CARL9170_WPC54#include <linux/input.h>55#endif /* CONFIG_CARL9170_WPC */56#include "eeprom.h"57#include "wlan.h"58#include "hw.h"59#include "fwdesc.h"60#include "fwcmd.h"61#include "../regd.h"62 63#ifdef CONFIG_CARL9170_DEBUGFS64#include "debug.h"65#endif /* CONFIG_CARL9170_DEBUGFS */66 67#define CARL9170FW_NAME "carl9170-1.fw"68 69#define PAYLOAD_MAX (CARL9170_MAX_CMD_LEN / 4 - 1)70 71static inline u8 ar9170_qmap(u8 idx)72{73 return 3 - idx; /* { 3, 2, 1, 0 } */74}75 76#define CARL9170_MAX_RX_BUFFER_SIZE 819277 78enum carl9170_device_state {79 CARL9170_UNKNOWN_STATE,80 CARL9170_STOPPED,81 CARL9170_IDLE,82 CARL9170_STARTED,83};84 85#define WME_BA_BMP_SIZE 6486#define CARL9170_TX_USER_RATE_TRIES 387 88#define TID_TO_WME_AC(_tid) \89 ((((_tid) == 0) || ((_tid) == 3)) ? IEEE80211_AC_BE : \90 (((_tid) == 1) || ((_tid) == 2)) ? IEEE80211_AC_BK : \91 (((_tid) == 4) || ((_tid) == 5)) ? IEEE80211_AC_VI : \92 IEEE80211_AC_VO)93 94#define SEQ_DIFF(_start, _seq) \95 (((_start) - (_seq)) & 0x0fff)96#define SEQ_PREV(_seq) \97 (((_seq) - 1) & 0x0fff)98#define SEQ_NEXT(_seq) \99 (((_seq) + 1) & 0x0fff)100#define BAW_WITHIN(_start, _bawsz, _seqno) \101 ((((_seqno) - (_start)) & 0xfff) < (_bawsz))102 103enum carl9170_tid_state {104 CARL9170_TID_STATE_INVALID,105 CARL9170_TID_STATE_KILLED,106 CARL9170_TID_STATE_SHUTDOWN,107 CARL9170_TID_STATE_SUSPEND,108 CARL9170_TID_STATE_PROGRESS,109 CARL9170_TID_STATE_IDLE,110 CARL9170_TID_STATE_XMIT,111};112 113#define CARL9170_BAW_BITS (2 * WME_BA_BMP_SIZE)114#define CARL9170_BAW_SIZE (BITS_TO_LONGS(CARL9170_BAW_BITS))115#define CARL9170_BAW_LEN (DIV_ROUND_UP(CARL9170_BAW_BITS, BITS_PER_BYTE))116 117struct carl9170_sta_tid {118 /* must be the first entry! */119 struct list_head list;120 121 /* temporary list for RCU unlink procedure */122 struct list_head tmp_list;123 124 /* lock for the following data structures */125 spinlock_t lock;126 127 unsigned int counter;128 enum carl9170_tid_state state;129 u8 tid; /* TID number ( 0 - 15 ) */130 u16 max; /* max. AMPDU size */131 132 u16 snx; /* awaiting _next_ frame */133 u16 hsn; /* highest _queued_ sequence */134 u16 bsn; /* base of the tx/agg bitmap */135 unsigned long bitmap[CARL9170_BAW_SIZE];136 137 /* Preaggregation reorder queue */138 struct sk_buff_head queue;139 140 struct ieee80211_sta *sta;141 struct ieee80211_vif *vif;142};143 144#define CARL9170_QUEUE_TIMEOUT 256145#define CARL9170_BUMP_QUEUE 1000146#define CARL9170_TX_TIMEOUT 2500147#define CARL9170_JANITOR_DELAY 128148#define CARL9170_QUEUE_STUCK_TIMEOUT 5500149#define CARL9170_STAT_WORK 30000150 151#define CARL9170_NUM_TX_AGG_MAX 30152 153/*154 * Tradeoff between stability/latency and speed.155 *156 * AR9170_TXQ_DEPTH is devised by dividing the amount of available157 * tx buffers with the size of a full ethernet frame + overhead.158 *159 * Naturally: The higher the limit, the faster the device CAN send.160 * However, even a slight over-commitment at the wrong time and the161 * hardware is doomed to send all already-queued frames at suboptimal162 * rates. This in turn leads to an enormous amount of unsuccessful163 * retries => Latency goes up, whereas the throughput goes down. CRASH!164 */165#define CARL9170_NUM_TX_LIMIT_HARD ((AR9170_TXQ_DEPTH * 3) / 2)166#define CARL9170_NUM_TX_LIMIT_SOFT (AR9170_TXQ_DEPTH)167 168struct carl9170_tx_queue_stats {169 unsigned int count;170 unsigned int limit;171 unsigned int len;172};173 174struct carl9170_vif {175 unsigned int id;176 struct ieee80211_vif __rcu *vif;177};178 179struct carl9170_vif_info {180 struct list_head list;181 bool active;182 unsigned int id;183 struct sk_buff *beacon;184 bool enable_beacon;185};186 187#define AR9170_NUM_RX_URBS 16188#define AR9170_NUM_RX_URBS_MUL 2189#define AR9170_NUM_TX_URBS 8190#define AR9170_NUM_RX_URBS_POOL (AR9170_NUM_RX_URBS_MUL * AR9170_NUM_RX_URBS)191 192enum carl9170_device_features {193 CARL9170_WPS_BUTTON = BIT(0),194 CARL9170_ONE_LED = BIT(1),195};196 197#ifdef CONFIG_CARL9170_LEDS198struct ar9170;199 200struct carl9170_led {201 struct ar9170 *ar;202 struct led_classdev l;203 char name[32];204 unsigned int toggled;205 bool last_state;206 bool registered;207};208#endif /* CONFIG_CARL9170_LEDS */209 210enum carl9170_restart_reasons {211 CARL9170_RR_NO_REASON = 0,212 CARL9170_RR_FATAL_FIRMWARE_ERROR,213 CARL9170_RR_TOO_MANY_FIRMWARE_ERRORS,214 CARL9170_RR_WATCHDOG,215 CARL9170_RR_STUCK_TX,216 CARL9170_RR_UNRESPONSIVE_DEVICE,217 CARL9170_RR_COMMAND_TIMEOUT,218 CARL9170_RR_TOO_MANY_PHY_ERRORS,219 CARL9170_RR_LOST_RSP,220 CARL9170_RR_INVALID_RSP,221 CARL9170_RR_USER_REQUEST,222 223 __CARL9170_RR_LAST,224};225 226enum carl9170_erp_modes {227 CARL9170_ERP_INVALID,228 CARL9170_ERP_AUTO,229 CARL9170_ERP_MAC80211,230 CARL9170_ERP_OFF,231 CARL9170_ERP_CTS,232 CARL9170_ERP_RTS,233 __CARL9170_ERP_NUM,234};235 236struct ar9170 {237 struct ath_common common;238 struct ieee80211_hw *hw;239 struct mutex mutex;240 enum carl9170_device_state state;241 spinlock_t state_lock;242 enum carl9170_restart_reasons last_reason;243 bool registered;244 245 /* USB */246 struct usb_device *udev;247 struct usb_interface *intf;248 struct usb_anchor rx_anch;249 struct usb_anchor rx_work;250 struct usb_anchor rx_pool;251 struct usb_anchor tx_wait;252 struct usb_anchor tx_anch;253 struct usb_anchor tx_cmd;254 struct usb_anchor tx_err;255 struct tasklet_struct usb_tasklet;256 atomic_t tx_cmd_urbs;257 atomic_t tx_anch_urbs;258 atomic_t rx_anch_urbs;259 atomic_t rx_work_urbs;260 atomic_t rx_pool_urbs;261 kernel_ulong_t features;262 bool usb_ep_cmd_is_bulk;263 264 /* firmware settings */265 struct completion fw_load_wait;266 struct completion fw_boot_wait;267 struct {268 const struct carl9170fw_desc_head *desc;269 const struct firmware *fw;270 unsigned int offset;271 unsigned int address;272 unsigned int cmd_bufs;273 unsigned int api_version;274 unsigned int vif_num;275 unsigned int err_counter;276 unsigned int bug_counter;277 u32 beacon_addr;278 unsigned int beacon_max_len;279 bool rx_stream;280 bool tx_stream;281 bool rx_filter;282 bool hw_counters;283 unsigned int mem_blocks;284 unsigned int mem_block_size;285 unsigned int rx_size;286 unsigned int tx_seq_table;287 bool ba_filter;288 bool disable_offload_fw;289 } fw;290 291 /* interface configuration combinations */292 struct ieee80211_iface_limit if_comb_limits[1];293 struct ieee80211_iface_combination if_combs[1];294 295 /* reset / stuck frames/queue detection */296 struct work_struct restart_work;297 struct work_struct ping_work;298 unsigned int restart_counter;299 unsigned long queue_stop_timeout[__AR9170_NUM_TXQ];300 unsigned long max_queue_stop_timeout[__AR9170_NUM_TXQ];301 bool needs_full_reset;302 bool force_usb_reset;303 atomic_t pending_restarts;304 305 /* interface mode settings */306 struct list_head vif_list;307 unsigned long vif_bitmap;308 unsigned int vifs;309 struct carl9170_vif vif_priv[AR9170_MAX_VIRTUAL_MAC];310 311 /* beaconing */312 spinlock_t beacon_lock;313 unsigned int global_pretbtt;314 unsigned int global_beacon_int;315 struct carl9170_vif_info __rcu *beacon_iter;316 unsigned int beacon_enabled;317 318 /* cryptographic engine */319 u64 usedkeys;320 bool rx_software_decryption;321 bool disable_offload;322 323 /* filter settings */324 u64 cur_mc_hash;325 u32 cur_filter;326 unsigned int filter_state;327 unsigned int rx_filter_caps;328 bool sniffer_enabled;329 330 /* MAC */331 enum carl9170_erp_modes erp_mode;332 333 /* PHY */334 struct ieee80211_channel *channel;335 unsigned int num_channels;336 int noise[4];337 unsigned int chan_fail;338 unsigned int total_chan_fail;339 u8 heavy_clip;340 u8 ht_settings;341 struct {342 u64 active; /* usec */343 u64 cca; /* usec */344 u64 tx_time; /* usec */345 u64 rx_total;346 u64 rx_overrun;347 } tally;348 struct delayed_work stat_work;349 struct survey_info *survey;350 351 /* power calibration data */352 u8 power_5G_leg[4];353 u8 power_2G_cck[4];354 u8 power_2G_ofdm[4];355 u8 power_5G_ht20[8];356 u8 power_5G_ht40[8];357 u8 power_2G_ht20[8];358 u8 power_2G_ht40[8];359 360#ifdef CONFIG_CARL9170_LEDS361 /* LED */362 struct delayed_work led_work;363 struct carl9170_led leds[AR9170_NUM_LEDS];364#endif /* CONFIG_CARL9170_LEDS */365 366 /* qos queue settings */367 spinlock_t tx_stats_lock;368 struct carl9170_tx_queue_stats tx_stats[__AR9170_NUM_TXQ];369 struct ieee80211_tx_queue_params edcf[5];370 struct completion tx_flush;371 372 /* CMD */373 int cmd_seq;374 int readlen;375 u8 *readbuf;376 spinlock_t cmd_lock;377 struct completion cmd_wait;378 union {379 __le32 cmd_buf[PAYLOAD_MAX + 1];380 struct carl9170_cmd cmd;381 struct carl9170_rsp rsp;382 };383 384 /* statistics */385 unsigned int tx_dropped;386 unsigned int tx_ack_failures;387 unsigned int tx_fcs_errors;388 unsigned int rx_dropped;389 390 /* EEPROM */391 struct ar9170_eeprom eeprom;392 393 /* tx queuing */394 struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];395 struct sk_buff_head tx_status[__AR9170_NUM_TXQ];396 struct delayed_work tx_janitor;397 unsigned long tx_janitor_last_run;398 bool tx_schedule;399 400 /* tx ampdu */401 struct work_struct ampdu_work;402 spinlock_t tx_ampdu_list_lock;403 struct carl9170_sta_tid __rcu *tx_ampdu_iter;404 struct list_head tx_ampdu_list;405 atomic_t tx_ampdu_upload;406 atomic_t tx_ampdu_scheduler;407 atomic_t tx_total_pending;408 atomic_t tx_total_queued;409 unsigned int tx_ampdu_list_len;410 int current_density;411 int current_factor;412 bool tx_ampdu_schedule;413 414 /* internal memory management */415 spinlock_t mem_lock;416 unsigned long *mem_bitmap;417 atomic_t mem_free_blocks;418 atomic_t mem_allocs;419 420 /* rxstream mpdu merge */421 struct ar9170_rx_head rx_plcp;422 bool rx_has_plcp;423 struct sk_buff *rx_failover;424 int rx_failover_missing;425 u32 ampdu_ref;426 427 /* FIFO for collecting outstanding BlockAckRequest */428 struct list_head bar_list[__AR9170_NUM_TXQ];429 spinlock_t bar_list_lock[__AR9170_NUM_TXQ];430 431#ifdef CONFIG_CARL9170_WPC432 struct {433 bool pbc_state;434 struct input_dev *pbc;435 char name[32];436 char phys[32];437 } wps;438#endif /* CONFIG_CARL9170_WPC */439 440#ifdef CONFIG_CARL9170_DEBUGFS441 struct carl9170_debug debug;442 struct dentry *debug_dir;443#endif /* CONFIG_CARL9170_DEBUGFS */444 445 /* PSM */446 struct work_struct ps_work;447 struct {448 unsigned int dtim_counter;449 unsigned long last_beacon;450 unsigned long last_action;451 unsigned long last_slept;452 unsigned int sleep_ms;453 unsigned int off_override;454 bool state;455 } ps;456 457#ifdef CONFIG_CARL9170_HWRNG458# define CARL9170_HWRNG_CACHE_SIZE CARL9170_MAX_CMD_PAYLOAD_LEN459 struct {460 struct hwrng rng;461 char name[30 + 1];462 u16 cache[CARL9170_HWRNG_CACHE_SIZE / sizeof(u16)];463 unsigned int cache_idx;464 } rng;465#endif /* CONFIG_CARL9170_HWRNG */466};467 468enum carl9170_ps_off_override_reasons {469 PS_OFF_VIF = BIT(0),470 PS_OFF_BCN = BIT(1),471};472 473struct carl9170_bar_list_entry {474 struct list_head list;475 struct rcu_head head;476 struct sk_buff *skb;477};478 479struct carl9170_ba_stats {480 u8 ampdu_len;481 u8 ampdu_ack_len;482 bool clear;483 bool req;484};485 486struct carl9170_sta_info {487 bool ht_sta;488 bool sleeping;489 atomic_t pending_frames;490 unsigned int ampdu_max_len;491 struct carl9170_sta_tid __rcu *agg[IEEE80211_NUM_TIDS];492 struct carl9170_ba_stats stats[IEEE80211_NUM_TIDS];493};494 495struct carl9170_tx_info {496 unsigned long timeout;497 struct ar9170 *ar;498 struct kref ref;499};500 501#define CHK_DEV_STATE(a, s) (((struct ar9170 *)a)->state >= (s))502#define IS_INITIALIZED(a) (CHK_DEV_STATE(a, CARL9170_STOPPED))503#define IS_ACCEPTING_CMD(a) (CHK_DEV_STATE(a, CARL9170_IDLE))504#define IS_STARTED(a) (CHK_DEV_STATE(a, CARL9170_STARTED))505 506static inline void __carl9170_set_state(struct ar9170 *ar,507 enum carl9170_device_state newstate)508{509 ar->state = newstate;510}511 512static inline void carl9170_set_state(struct ar9170 *ar,513 enum carl9170_device_state newstate)514{515 unsigned long flags;516 517 spin_lock_irqsave(&ar->state_lock, flags);518 __carl9170_set_state(ar, newstate);519 spin_unlock_irqrestore(&ar->state_lock, flags);520}521 522static inline void carl9170_set_state_when(struct ar9170 *ar,523 enum carl9170_device_state min, enum carl9170_device_state newstate)524{525 unsigned long flags;526 527 spin_lock_irqsave(&ar->state_lock, flags);528 if (CHK_DEV_STATE(ar, min))529 __carl9170_set_state(ar, newstate);530 spin_unlock_irqrestore(&ar->state_lock, flags);531}532 533/* exported interface */534void *carl9170_alloc(size_t priv_size);535int carl9170_register(struct ar9170 *ar);536void carl9170_unregister(struct ar9170 *ar);537void carl9170_free(struct ar9170 *ar);538void carl9170_restart(struct ar9170 *ar, const enum carl9170_restart_reasons r);539void carl9170_ps_check(struct ar9170 *ar);540 541/* USB back-end */542int carl9170_usb_open(struct ar9170 *ar);543void carl9170_usb_stop(struct ar9170 *ar);544void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb);545void carl9170_usb_handle_tx_err(struct ar9170 *ar);546int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids,547 u32 plen, void *payload, u32 rlen, void *resp);548int __carl9170_exec_cmd(struct ar9170 *ar, struct carl9170_cmd *cmd,549 const bool free_buf);550int carl9170_usb_restart(struct ar9170 *ar);551void carl9170_usb_reset(struct ar9170 *ar);552 553/* MAC */554int carl9170_init_mac(struct ar9170 *ar);555int carl9170_set_qos(struct ar9170 *ar);556int carl9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);557int carl9170_mod_virtual_mac(struct ar9170 *ar, const unsigned int id,558 const u8 *mac);559int carl9170_set_operating_mode(struct ar9170 *ar);560int carl9170_set_beacon_timers(struct ar9170 *ar);561int carl9170_set_dyn_sifs_ack(struct ar9170 *ar);562int carl9170_set_rts_cts_rate(struct ar9170 *ar);563int carl9170_set_ampdu_settings(struct ar9170 *ar);564int carl9170_set_slot_time(struct ar9170 *ar);565int carl9170_set_mac_rates(struct ar9170 *ar);566int carl9170_set_hwretry_limit(struct ar9170 *ar, const u32 max_retry);567int carl9170_upload_key(struct ar9170 *ar, const u8 id, const u8 *mac,568 const u8 ktype, const u8 keyidx, const u8 *keydata, const int keylen);569int carl9170_disable_key(struct ar9170 *ar, const u8 id);570int carl9170_set_mac_tpc(struct ar9170 *ar, struct ieee80211_channel *channel);571 572/* RX */573void carl9170_rx(struct ar9170 *ar, void *buf, unsigned int len);574void carl9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);575 576/* TX */577void carl9170_op_tx(struct ieee80211_hw *hw,578 struct ieee80211_tx_control *control,579 struct sk_buff *skb);580void carl9170_tx_janitor(struct work_struct *work);581void carl9170_tx_process_status(struct ar9170 *ar,582 const struct carl9170_rsp *cmd);583void carl9170_tx_status(struct ar9170 *ar, struct sk_buff *skb,584 const bool success);585void carl9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);586void carl9170_tx_drop(struct ar9170 *ar, struct sk_buff *skb);587void carl9170_tx_scheduler(struct ar9170 *ar);588void carl9170_tx_get_skb(struct sk_buff *skb);589int carl9170_tx_put_skb(struct sk_buff *skb);590int carl9170_update_beacon(struct ar9170 *ar, const bool submit);591 592/* LEDs */593#ifdef CONFIG_CARL9170_LEDS594int carl9170_led_register(struct ar9170 *ar);595void carl9170_led_unregister(struct ar9170 *ar);596#endif /* CONFIG_CARL9170_LEDS */597int carl9170_led_init(struct ar9170 *ar);598int carl9170_led_set_state(struct ar9170 *ar, const u32 led_state);599 600/* PHY / RF */601int carl9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,602 enum nl80211_channel_type bw);603int carl9170_get_noisefloor(struct ar9170 *ar);604 605/* FW */606int carl9170_parse_firmware(struct ar9170 *ar);607 608extern struct ieee80211_rate __carl9170_ratetable[];609extern int modparam_noht;610 611static inline struct ar9170 *carl9170_get_priv(struct carl9170_vif *carl_vif)612{613 return container_of(carl_vif, struct ar9170,614 vif_priv[carl_vif->id]);615}616 617static inline struct ieee80211_hdr *carl9170_get_hdr(struct sk_buff *skb)618{619 return (void *)((struct _carl9170_tx_superframe *)620 skb->data)->frame_data;621}622 623static inline u16 get_seq_h(struct ieee80211_hdr *hdr)624{625 return le16_to_cpu(hdr->seq_ctrl) >> 4;626}627 628static inline u16 carl9170_get_seq(struct sk_buff *skb)629{630 return get_seq_h(carl9170_get_hdr(skb));631}632 633static inline u16 carl9170_get_tid(struct sk_buff *skb)634{635 return ieee80211_get_tid(carl9170_get_hdr(skb));636}637 638static inline struct ieee80211_vif *639carl9170_get_vif(struct carl9170_vif_info *priv)640{641 return container_of((void *)priv, struct ieee80211_vif, drv_priv);642}643 644/* Protected by ar->mutex or RCU */645static inline struct ieee80211_vif *carl9170_get_main_vif(struct ar9170 *ar)646{647 struct carl9170_vif_info *cvif;648 649 list_for_each_entry_rcu(cvif, &ar->vif_list, list) {650 if (cvif->active)651 return carl9170_get_vif(cvif);652 }653 654 return NULL;655}656 657static inline bool is_main_vif(struct ar9170 *ar, struct ieee80211_vif *vif)658{659 bool ret;660 661 rcu_read_lock();662 ret = (carl9170_get_main_vif(ar) == vif);663 rcu_read_unlock();664 return ret;665}666 667#endif /* __CARL9170_H */668