[mirror_ubuntu-jammy-kernel.git] / drivers / net / wireless / ath / carl9170 / carl9170.h

/*
 * Atheros CARL9170 driver
 *
 * Driver specific definitions
 *
 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
 * Copyright 2009, 2010, Christian Lamparter <chunkeey@googlemail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING.  If not, see
 * http://www.gnu.org/licenses/.
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *    Copyright (c) 2007-2008 Atheros Communications, Inc.
 *
 *    Permission to use, copy, modify, and/or distribute this software for any
 *    purpose with or without fee is hereby granted, provided that the above
 *    copyright notice and this permission notice appear in all copies.
 *
 *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
#ifndef __CARL9170_H
#define __CARL9170_H

#include <linux/kernel.h>
#include <linux/firmware.h>
#include <linux/completion.h>
#include <linux/spinlock.h>
#include <net/cfg80211.h>
#include <net/mac80211.h>
#include <linux/usb.h>
#ifdef CONFIG_CARL9170_LEDS
#include <linux/leds.h>
#endif /* CONFIG_CARL9170_LEDS */
#ifdef CONFIG_CARL9170_WPC
#include <linux/input.h>
#endif /* CONFIG_CARL9170_WPC */
#include "eeprom.h"
#include "wlan.h"
#include "hw.h"
#include "fwdesc.h"
#include "fwcmd.h"
#include "../regd.h"

#ifdef CONFIG_CARL9170_DEBUGFS
#include "debug.h"
#endif /* CONFIG_CARL9170_DEBUGFS */

#define CARL9170FW_NAME	"carl9170-1.fw"

#define PAYLOAD_MAX	(CARL9170_MAX_CMD_LEN / 4 - 1)

enum carl9170_rf_init_mode {
	CARL9170_RFI_NONE,
	CARL9170_RFI_WARM,
	CARL9170_RFI_COLD,
};

#define CARL9170_MAX_RX_BUFFER_SIZE		8192

enum carl9170_device_state {
	CARL9170_UNKNOWN_STATE,
	CARL9170_STOPPED,
	CARL9170_IDLE,
	CARL9170_STARTED,
};

#define CARL9170_NUM_TID		16
#define WME_BA_BMP_SIZE			64
#define CARL9170_TX_USER_RATE_TRIES	3

#define WME_AC_BE   2
#define WME_AC_BK   3
#define WME_AC_VI   1
#define WME_AC_VO   0

#define TID_TO_WME_AC(_tid)				\
	((((_tid) == 0) || ((_tid) == 3)) ? WME_AC_BE :	\
	 (((_tid) == 1) || ((_tid) == 2)) ? WME_AC_BK :	\
	 (((_tid) == 4) || ((_tid) == 5)) ? WME_AC_VI :	\
	 WME_AC_VO)

#define SEQ_DIFF(_start, _seq) \
	(((_start) - (_seq)) & 0x0fff)
#define SEQ_PREV(_seq) \
	(((_seq) - 1) & 0x0fff)
#define SEQ_NEXT(_seq) \
	(((_seq) + 1) & 0x0fff)
#define BAW_WITHIN(_start, _bawsz, _seqno) \
	((((_seqno) - (_start)) & 0xfff) < (_bawsz))

enum carl9170_tid_state {
	CARL9170_TID_STATE_INVALID,
	CARL9170_TID_STATE_KILLED,
	CARL9170_TID_STATE_SHUTDOWN,
	CARL9170_TID_STATE_SUSPEND,
	CARL9170_TID_STATE_PROGRESS,
	CARL9170_TID_STATE_IDLE,
	CARL9170_TID_STATE_XMIT,
};

#define CARL9170_BAW_BITS (2 * WME_BA_BMP_SIZE)
#define CARL9170_BAW_SIZE (BITS_TO_LONGS(CARL9170_BAW_BITS))
#define CARL9170_BAW_LEN (DIV_ROUND_UP(CARL9170_BAW_BITS, BITS_PER_BYTE))

struct carl9170_sta_tid {
	/* must be the first entry! */
	struct list_head list;

	/* temporary list for RCU unlink procedure */
	struct list_head tmp_list;

	/* lock for the following data structures */
	spinlock_t lock;

	unsigned int counter;
	enum carl9170_tid_state state;
	u8 tid;		/* TID number ( 0 - 15 ) */
	u16 max;	/* max. AMPDU size */

	u16 snx;	/* awaiting _next_ frame */
	u16 hsn;	/* highest _queued_ sequence */
	u16 bsn;	/* base of the tx/agg bitmap */
	unsigned long bitmap[CARL9170_BAW_SIZE];

	/* Preaggregation reorder queue */
	struct sk_buff_head queue;
};

#define CARL9170_QUEUE_TIMEOUT		256
#define CARL9170_BUMP_QUEUE		1000
#define CARL9170_TX_TIMEOUT		2500
#define CARL9170_JANITOR_DELAY		128
#define CARL9170_QUEUE_STUCK_TIMEOUT	5500

#define CARL9170_NUM_TX_AGG_MAX		30

/*
 * Tradeoff between stability/latency and speed.
 *
 * AR9170_TXQ_DEPTH is devised by dividing the amount of available
 * tx buffers with the size of a full ethernet frame + overhead.
 *
 * Naturally: The higher the limit, the faster the device CAN send.
 * However, even a slight over-commitment at the wrong time and the
 * hardware is doomed to send all already-queued frames at suboptimal
 * rates. This in turn leads to an enourmous amount of unsuccessful
 * retries => Latency goes up, whereas the throughput goes down. CRASH!
 */
#define CARL9170_NUM_TX_LIMIT_HARD	((AR9170_TXQ_DEPTH * 3) / 2)
#define CARL9170_NUM_TX_LIMIT_SOFT	(AR9170_TXQ_DEPTH)

struct carl9170_tx_queue_stats {
	unsigned int count;
	unsigned int limit;
	unsigned int len;
};

struct carl9170_vif {
	unsigned int id;
	struct ieee80211_vif *vif;
};

struct carl9170_vif_info {
	struct list_head list;
	bool active;
	unsigned int id;
	struct sk_buff *beacon;
	bool enable_beacon;
};

#define AR9170_NUM_RX_URBS	16
#define AR9170_NUM_RX_URBS_MUL	2
#define AR9170_NUM_TX_URBS	8
#define AR9170_NUM_RX_URBS_POOL (AR9170_NUM_RX_URBS_MUL * AR9170_NUM_RX_URBS)

enum carl9170_device_features {
	CARL9170_WPS_BUTTON		= BIT(0),
	CARL9170_ONE_LED		= BIT(1),
};

#ifdef CONFIG_CARL9170_LEDS
struct ar9170;

struct carl9170_led {
	struct ar9170 *ar;
	struct led_classdev l;
	char name[32];
	unsigned int toggled;
	bool last_state;
	bool registered;
};
#endif /* CONFIG_CARL9170_LEDS */

enum carl9170_restart_reasons {
	CARL9170_RR_NO_REASON = 0,
	CARL9170_RR_FATAL_FIRMWARE_ERROR,
	CARL9170_RR_TOO_MANY_FIRMWARE_ERRORS,
	CARL9170_RR_WATCHDOG,
	CARL9170_RR_STUCK_TX,
	CARL9170_RR_UNRESPONSIVE_DEVICE,
	CARL9170_RR_COMMAND_TIMEOUT,
	CARL9170_RR_TOO_MANY_PHY_ERRORS,
	CARL9170_RR_LOST_RSP,
	CARL9170_RR_INVALID_RSP,
	CARL9170_RR_USER_REQUEST,

	__CARL9170_RR_LAST,
};

enum carl9170_erp_modes {
	CARL9170_ERP_INVALID,
	CARL9170_ERP_AUTO,
	CARL9170_ERP_MAC80211,
	CARL9170_ERP_OFF,
	CARL9170_ERP_CTS,
	CARL9170_ERP_RTS,
	__CARL9170_ERP_NUM,
};

struct ar9170 {
	struct ath_common common;
	struct ieee80211_hw *hw;
	struct mutex mutex;
	enum carl9170_device_state state;
	spinlock_t state_lock;
	enum carl9170_restart_reasons last_reason;
	bool registered;

	/* USB */
	struct usb_device *udev;
	struct usb_interface *intf;
	struct usb_anchor rx_anch;
	struct usb_anchor rx_work;
	struct usb_anchor rx_pool;
	struct usb_anchor tx_wait;
	struct usb_anchor tx_anch;
	struct usb_anchor tx_cmd;
	struct usb_anchor tx_err;
	struct tasklet_struct usb_tasklet;
	atomic_t tx_cmd_urbs;
	atomic_t tx_anch_urbs;
	atomic_t rx_anch_urbs;
	atomic_t rx_work_urbs;
	atomic_t rx_pool_urbs;
	kernel_ulong_t features;

	/* firmware settings */
	struct completion fw_load_wait;
	struct completion fw_boot_wait;
	struct {
		const struct carl9170fw_desc_head *desc;
		const struct firmware *fw;
		unsigned int offset;
		unsigned int address;
		unsigned int cmd_bufs;
		unsigned int api_version;
		unsigned int vif_num;
		unsigned int err_counter;
		unsigned int bug_counter;
		u32 beacon_addr;
		unsigned int beacon_max_len;
		bool rx_stream;
		bool tx_stream;
		bool rx_filter;
		unsigned int mem_blocks;
		unsigned int mem_block_size;
		unsigned int rx_size;
	} fw;

	/* reset / stuck frames/queue detection */
	struct work_struct restart_work;
	struct work_struct ping_work;
	unsigned int restart_counter;
	unsigned long queue_stop_timeout[__AR9170_NUM_TXQ];
	unsigned long max_queue_stop_timeout[__AR9170_NUM_TXQ];
	bool needs_full_reset;
	atomic_t pending_restarts;

	/* interface mode settings */
	struct list_head vif_list;
	unsigned long vif_bitmap;
	unsigned int vifs;
	struct carl9170_vif vif_priv[AR9170_MAX_VIRTUAL_MAC];

	/* beaconing */
	spinlock_t beacon_lock;
	unsigned int global_pretbtt;
	unsigned int global_beacon_int;
	struct carl9170_vif_info *beacon_iter;
	unsigned int beacon_enabled;

	/* cryptographic engine */
	u64 usedkeys;
	bool rx_software_decryption;
	bool disable_offload;

	/* filter settings */
	u64 cur_mc_hash;
	u32 cur_filter;
	unsigned int filter_state;
	unsigned int rx_filter_caps;
	bool sniffer_enabled;

	/* MAC */
	enum carl9170_erp_modes erp_mode;

	/* PHY */
	struct ieee80211_channel *channel;
	int noise[4];
	unsigned int chan_fail;
	unsigned int total_chan_fail;
	u8 heavy_clip;
	u8 ht_settings;

	/* power calibration data */
	u8 power_5G_leg[4];
	u8 power_2G_cck[4];
	u8 power_2G_ofdm[4];
	u8 power_5G_ht20[8];
	u8 power_5G_ht40[8];
	u8 power_2G_ht20[8];
	u8 power_2G_ht40[8];

#ifdef CONFIG_CARL9170_LEDS
	/* LED */
	struct delayed_work led_work;
	struct carl9170_led leds[AR9170_NUM_LEDS];
#endif /* CONFIG_CARL9170_LEDS */

	/* qos queue settings */
	spinlock_t tx_stats_lock;
	struct carl9170_tx_queue_stats tx_stats[__AR9170_NUM_TXQ];
	struct ieee80211_tx_queue_params edcf[5];
	struct completion tx_flush;

	/* CMD */
	int cmd_seq;
	int readlen;
	u8 *readbuf;
	spinlock_t cmd_lock;
	struct completion cmd_wait;
	union {
		__le32 cmd_buf[PAYLOAD_MAX + 1];
		struct carl9170_cmd cmd;
		struct carl9170_rsp rsp;
	};

	/* statistics */
	unsigned int tx_dropped;
	unsigned int tx_ack_failures;
	unsigned int tx_fcs_errors;
	unsigned int rx_dropped;

	/* EEPROM */
	struct ar9170_eeprom eeprom;

	/* tx queuing */
	struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
	struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
	struct delayed_work tx_janitor;
	unsigned long tx_janitor_last_run;
	bool tx_schedule;

	/* tx ampdu */
	struct work_struct ampdu_work;
	spinlock_t tx_ampdu_list_lock;
	struct carl9170_sta_tid *tx_ampdu_iter;
	struct list_head tx_ampdu_list;
	atomic_t tx_ampdu_upload;
	atomic_t tx_ampdu_scheduler;
	atomic_t tx_total_pending;
	atomic_t tx_total_queued;
	unsigned int tx_ampdu_list_len;
	int current_density;
	int current_factor;
	bool tx_ampdu_schedule;

	/* internal memory management */
	spinlock_t mem_lock;
	unsigned long *mem_bitmap;
	atomic_t mem_free_blocks;
	atomic_t mem_allocs;

	/* rxstream mpdu merge */
	struct ar9170_rx_head rx_plcp;
	bool rx_has_plcp;
	struct sk_buff *rx_failover;
	int rx_failover_missing;

#ifdef CONFIG_CARL9170_WPC
	struct {
		bool pbc_state;
		struct input_dev *pbc;
		char name[32];
		char phys[32];
	} wps;
#endif /* CONFIG_CARL9170_WPC */

#ifdef CONFIG_CARL9170_DEBUGFS
	struct carl9170_debug debug;
	struct dentry *debug_dir;
#endif /* CONFIG_CARL9170_DEBUGFS */

	/* PSM */
	struct work_struct ps_work;
	struct {
		unsigned int dtim_counter;
		unsigned long last_beacon;
		unsigned long last_action;
		unsigned long last_slept;
		unsigned int sleep_ms;
		unsigned int off_override;
		bool state;
	} ps;
};

enum carl9170_ps_off_override_reasons {
	PS_OFF_VIF	= BIT(0),
	PS_OFF_BCN	= BIT(1),
	PS_OFF_5GHZ	= BIT(2),
};

struct carl9170_ba_stats {
	u8 ampdu_len;
	u8 ampdu_ack_len;
	bool clear;
};

struct carl9170_sta_info {
	bool ht_sta;
	unsigned int ampdu_max_len;
	struct carl9170_sta_tid *agg[CARL9170_NUM_TID];
	struct carl9170_ba_stats stats[CARL9170_NUM_TID];
};

struct carl9170_tx_info {
	unsigned long timeout;
	struct ar9170 *ar;
	struct kref ref;
};

#define CHK_DEV_STATE(a, s)	(((struct ar9170 *)a)->state >= (s))
#define IS_INITIALIZED(a)	(CHK_DEV_STATE(a, CARL9170_STOPPED))
#define IS_ACCEPTING_CMD(a)	(CHK_DEV_STATE(a, CARL9170_IDLE))
#define IS_STARTED(a)		(CHK_DEV_STATE(a, CARL9170_STARTED))

static inline void __carl9170_set_state(struct ar9170 *ar,
	enum carl9170_device_state newstate)
{
	ar->state = newstate;
}

static inline void carl9170_set_state(struct ar9170 *ar,
	enum carl9170_device_state newstate)
{
	unsigned long flags;

	spin_lock_irqsave(&ar->state_lock, flags);
	__carl9170_set_state(ar, newstate);
	spin_unlock_irqrestore(&ar->state_lock, flags);
}

static inline void carl9170_set_state_when(struct ar9170 *ar,
	enum carl9170_device_state min, enum carl9170_device_state newstate)
{
	unsigned long flags;

	spin_lock_irqsave(&ar->state_lock, flags);
	if (CHK_DEV_STATE(ar, min))
		__carl9170_set_state(ar, newstate);
	spin_unlock_irqrestore(&ar->state_lock, flags);
}

/* exported interface */
void *carl9170_alloc(size_t priv_size);
int carl9170_register(struct ar9170 *ar);
void carl9170_unregister(struct ar9170 *ar);
void carl9170_free(struct ar9170 *ar);
void carl9170_restart(struct ar9170 *ar, const enum carl9170_restart_reasons r);
void carl9170_ps_check(struct ar9170 *ar);

/* USB back-end */
int carl9170_usb_open(struct ar9170 *ar);
void carl9170_usb_stop(struct ar9170 *ar);
void carl9170_usb_tx(struct ar9170 *ar, struct sk_buff *skb);
void carl9170_usb_handle_tx_err(struct ar9170 *ar);
int carl9170_exec_cmd(struct ar9170 *ar, const enum carl9170_cmd_oids,
		      u32 plen, void *payload, u32 rlen, void *resp);
int __carl9170_exec_cmd(struct ar9170 *ar, struct carl9170_cmd *cmd,
			const bool free_buf);
int carl9170_usb_restart(struct ar9170 *ar);
void carl9170_usb_reset(struct ar9170 *ar);

/* MAC */
int carl9170_init_mac(struct ar9170 *ar);
int carl9170_set_qos(struct ar9170 *ar);
int carl9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
int carl9170_mod_virtual_mac(struct ar9170 *ar, const unsigned int id,
			     const u8 *mac);
int carl9170_set_operating_mode(struct ar9170 *ar);
int carl9170_set_beacon_timers(struct ar9170 *ar);
int carl9170_set_dyn_sifs_ack(struct ar9170 *ar);
int carl9170_set_rts_cts_rate(struct ar9170 *ar);
int carl9170_set_ampdu_settings(struct ar9170 *ar);
int carl9170_set_slot_time(struct ar9170 *ar);
int carl9170_set_mac_rates(struct ar9170 *ar);
int carl9170_set_hwretry_limit(struct ar9170 *ar, const u32 max_retry);
int carl9170_update_beacon(struct ar9170 *ar, const bool submit);
int carl9170_upload_key(struct ar9170 *ar, const u8 id, const u8 *mac,
	const u8 ktype, const u8 keyidx, const u8 *keydata, const int keylen);
int carl9170_disable_key(struct ar9170 *ar, const u8 id);

/* RX */
void carl9170_rx(struct ar9170 *ar, void *buf, unsigned int len);
void carl9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);

/* TX */
int carl9170_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
void carl9170_tx_janitor(struct work_struct *work);
void carl9170_tx_process_status(struct ar9170 *ar,
				const struct carl9170_rsp *cmd);
void carl9170_tx_status(struct ar9170 *ar, struct sk_buff *skb,
			const bool success);
void carl9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);
void carl9170_tx_drop(struct ar9170 *ar, struct sk_buff *skb);
void carl9170_tx_scheduler(struct ar9170 *ar);
void carl9170_tx_get_skb(struct sk_buff *skb);
int carl9170_tx_put_skb(struct sk_buff *skb);

/* LEDs */
#ifdef CONFIG_CARL9170_LEDS
int carl9170_led_register(struct ar9170 *ar);
void carl9170_led_unregister(struct ar9170 *ar);
#endif /* CONFIG_CARL9170_LEDS */
int carl9170_led_init(struct ar9170 *ar);
int carl9170_led_set_state(struct ar9170 *ar, const u32 led_state);

/* PHY / RF */
int carl9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
	enum nl80211_channel_type bw, enum carl9170_rf_init_mode rfi);
int carl9170_get_noisefloor(struct ar9170 *ar);

/* FW */
int carl9170_parse_firmware(struct ar9170 *ar);
int carl9170_fw_fix_eeprom(struct ar9170 *ar);

extern struct ieee80211_rate __carl9170_ratetable[];
extern int modparam_noht;

static inline struct ar9170 *carl9170_get_priv(struct carl9170_vif *carl_vif)
{
	return container_of(carl_vif, struct ar9170,
			    vif_priv[carl_vif->id]);
}

static inline struct ieee80211_hdr *carl9170_get_hdr(struct sk_buff *skb)
{
	return (void *)((struct _carl9170_tx_superframe *)
		skb->data)->frame_data;
}

static inline u16 get_seq_h(struct ieee80211_hdr *hdr)
{
	return le16_to_cpu(hdr->seq_ctrl) >> 4;
}

static inline u16 carl9170_get_seq(struct sk_buff *skb)
{
	return get_seq_h(carl9170_get_hdr(skb));
}

static inline u16 get_tid_h(struct ieee80211_hdr *hdr)
{
	return (ieee80211_get_qos_ctl(hdr))[0] & IEEE80211_QOS_CTL_TID_MASK;
}

static inline u16 carl9170_get_tid(struct sk_buff *skb)
{
	return get_tid_h(carl9170_get_hdr(skb));
}

static inline struct ieee80211_vif *
carl9170_get_vif(struct carl9170_vif_info *priv)
{
	return container_of((void *)priv, struct ieee80211_vif, drv_priv);
}

/* Protected by ar->mutex or RCU */
static inline struct ieee80211_vif *carl9170_get_main_vif(struct ar9170 *ar)
{
	struct carl9170_vif_info *cvif;

	list_for_each_entry_rcu(cvif, &ar->vif_list, list) {
		if (cvif->active)
			return carl9170_get_vif(cvif);
	}

	return NULL;
}

static inline bool is_main_vif(struct ar9170 *ar, struct ieee80211_vif *vif)
{
	bool ret;

	rcu_read_lock();
	ret = (carl9170_get_main_vif(ar) == vif);
	rcu_read_unlock();
	return ret;
}

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