[mirror_ubuntu-artful-kernel.git] / drivers / net / wireless / ath / ar9170 / ar9170.h

/*
 * Atheros AR9170 driver
 *
 * Driver specific definitions
 *
 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
 *
 * 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 __AR9170_H
#define __AR9170_H

#include <linux/completion.h>
#include <linux/spinlock.h>
#include <net/cfg80211.h>
#include <net/mac80211.h>
#ifdef CONFIG_AR9170_LEDS
#include <linux/leds.h>
#endif /* CONFIG_AR9170_LEDS */
#include "eeprom.h"
#include "hw.h"

#include "../regd.h"

#define PAYLOAD_MAX	(AR9170_MAX_CMD_LEN/4 - 1)

enum ar9170_bw {
	AR9170_BW_20,
	AR9170_BW_40_BELOW,
	AR9170_BW_40_ABOVE,

	__AR9170_NUM_BW,
};

static inline enum ar9170_bw nl80211_to_ar9170(enum nl80211_channel_type type)
{
	switch (type) {
	case NL80211_CHAN_NO_HT:
	case NL80211_CHAN_HT20:
		return AR9170_BW_20;
	case NL80211_CHAN_HT40MINUS:
		return AR9170_BW_40_BELOW;
	case NL80211_CHAN_HT40PLUS:
		return AR9170_BW_40_ABOVE;
	default:
		BUG();
	}
}

enum ar9170_rf_init_mode {
	AR9170_RFI_NONE,
	AR9170_RFI_WARM,
	AR9170_RFI_COLD,
};

#define AR9170_MAX_RX_BUFFER_SIZE		8192

#ifdef CONFIG_AR9170_LEDS
struct ar9170;

struct ar9170_led {
	struct ar9170 *ar;
	struct led_classdev l;
	char name[32];
	unsigned int toggled;
	bool last_state;
	bool registered;
};

#endif /* CONFIG_AR9170_LEDS */

enum ar9170_device_state {
	AR9170_UNKNOWN_STATE,
	AR9170_STOPPED,
	AR9170_IDLE,
	AR9170_STARTED,
};

struct ar9170_rxstream_mpdu_merge {
	struct ar9170_rx_head plcp;
	bool has_plcp;
};

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

#define AR9170_QUEUE_TIMEOUT		64
#define AR9170_TX_TIMEOUT		8
#define AR9170_JANITOR_DELAY		128
#define AR9170_TX_INVALID_RATE		0xffffffff

#define AR9170_NUM_TX_LIMIT_HARD	AR9170_TXQ_DEPTH
#define AR9170_NUM_TX_LIMIT_SOFT	(AR9170_TXQ_DEPTH - 10)

struct ar9170 {
	struct ieee80211_hw *hw;
	struct ath_common common;
	struct mutex mutex;
	enum ar9170_device_state state;
	bool registered;
	unsigned long bad_hw_nagger;

	int (*open)(struct ar9170 *);
	void (*stop)(struct ar9170 *);
	int (*tx)(struct ar9170 *, struct sk_buff *);
	int (*exec_cmd)(struct ar9170 *, enum ar9170_cmd, u32 ,
			void *, u32 , void *);
	void (*callback_cmd)(struct ar9170 *, u32 , void *);
	int (*flush)(struct ar9170 *);

	/* interface mode settings */
	struct ieee80211_vif *vif;

	/* beaconing */
	struct sk_buff *beacon;
	struct work_struct beacon_work;
	bool enable_beacon;

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

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

	/* PHY */
	struct ieee80211_channel *channel;
	int noise[4];

	/* 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];

	u8 phy_heavy_clip;

#ifdef CONFIG_AR9170_LEDS
	struct delayed_work led_work;
	struct ar9170_led leds[AR9170_NUM_LEDS];
#endif /* CONFIG_AR9170_LEDS */

	/* qos queue settings */
	spinlock_t tx_stats_lock;
	struct ar9170_tx_queue_stats tx_stats[5];
	struct ieee80211_tx_queue_params edcf[5];

	spinlock_t cmdlock;
	__le32 cmdbuf[PAYLOAD_MAX + 1];

	/* MAC statistics */
	struct ieee80211_low_level_stats stats;

	/* EEPROM */
	struct ar9170_eeprom eeprom;

	/* tx queues - as seen by hw - */
	struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
	struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
	struct delayed_work tx_janitor;

	/* rxstream mpdu merge */
	struct ar9170_rxstream_mpdu_merge rx_mpdu;
	struct sk_buff *rx_failover;
	int rx_failover_missing;

	/* (cached) HW A-MPDU settings */
	u8 global_ampdu_density;
	u8 global_ampdu_factor;
};

struct ar9170_tx_info {
	unsigned long timeout;
};

#define IS_STARTED(a)		(((struct ar9170 *)a)->state >= AR9170_STARTED)
#define IS_ACCEPTING_CMD(a)	(((struct ar9170 *)a)->state >= AR9170_IDLE)

/* exported interface */
void *ar9170_alloc(size_t priv_size);
int ar9170_register(struct ar9170 *ar, struct device *pdev);
void ar9170_rx(struct ar9170 *ar, struct sk_buff *skb);
void ar9170_unregister(struct ar9170 *ar);
void ar9170_tx_callback(struct ar9170 *ar, struct sk_buff *skb);
void ar9170_handle_command_response(struct ar9170 *ar, void *buf, u32 len);
int ar9170_nag_limiter(struct ar9170 *ar);

/* MAC */
int ar9170_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
int ar9170_init_mac(struct ar9170 *ar);
int ar9170_set_qos(struct ar9170 *ar);
int ar9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
int ar9170_update_frame_filter(struct ar9170 *ar, const u32 filter);
int ar9170_set_operating_mode(struct ar9170 *ar);
int ar9170_set_beacon_timers(struct ar9170 *ar);
int ar9170_set_dyn_sifs_ack(struct ar9170 *ar);
int ar9170_set_slot_time(struct ar9170 *ar);
int ar9170_set_basic_rates(struct ar9170 *ar);
int ar9170_set_hwretry_limit(struct ar9170 *ar, u32 max_retry);
int ar9170_update_beacon(struct ar9170 *ar);
void ar9170_new_beacon(struct work_struct *work);
int ar9170_upload_key(struct ar9170 *ar, u8 id, const u8 *mac, u8 ktype,
		      u8 keyidx, u8 *keydata, int keylen);
int ar9170_disable_key(struct ar9170 *ar, u8 id);

/* LEDs */
#ifdef CONFIG_AR9170_LEDS
int ar9170_register_leds(struct ar9170 *ar);
void ar9170_unregister_leds(struct ar9170 *ar);
#endif /* CONFIG_AR9170_LEDS */
int ar9170_init_leds(struct ar9170 *ar);
int ar9170_set_leds_state(struct ar9170 *ar, u32 led_state);

/* PHY / RF */
int ar9170_init_phy(struct ar9170 *ar, enum ieee80211_band band);
int ar9170_init_rf(struct ar9170 *ar);
int ar9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
		       enum ar9170_rf_init_mode rfi, enum ar9170_bw bw);

#endif /* __AR9170_H */
Commit	Line	Data
e9348cdd CL	1	/*
	2	* Atheros AR9170 driver
	3	*
	4	* Driver specific definitions
	5	*
	6	* Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; see the file COPYING. If not, see
	20	* http://www.gnu.org/licenses/.
	21	*
	22	* This file incorporates work covered by the following copyright and
	23	* permission notice:
	24	* Copyright (c) 2007-2008 Atheros Communications, Inc.
	25	*
	26	* Permission to use, copy, modify, and/or distribute this software for any
	27	* purpose with or without fee is hereby granted, provided that the above
	28	* copyright notice and this permission notice appear in all copies.
	29	*
	30	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	31	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	32	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	33	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	34	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	35	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	36	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	37	*/
	38	#ifndef __AR9170_H
	39	#define __AR9170_H
	40
	41	#include <linux/completion.h>
	42	#include <linux/spinlock.h>
d3236553	43	#include <net/cfg80211.h>
e9348cdd CL	44	#include <net/mac80211.h>
	45	#ifdef CONFIG_AR9170_LEDS
	46	#include <linux/leds.h>
	47	#endif /* CONFIG_AR9170_LEDS */
	48	#include "eeprom.h"
	49	#include "hw.h"
	50
203c4805	51	#include "../regd.h"
1878f77e	52
e9348cdd CL	53	#define PAYLOAD_MAX (AR9170_MAX_CMD_LEN/4 - 1)
	54
	55	enum ar9170_bw {
	56	AR9170_BW_20,
	57	AR9170_BW_40_BELOW,
	58	AR9170_BW_40_ABOVE,
	59
	60	__AR9170_NUM_BW,
	61	};
	62
9e52b062 JB	63	static inline enum ar9170_bw nl80211_to_ar9170(enum nl80211_channel_type type)
	64	{
	65	switch (type) {
	66	case NL80211_CHAN_NO_HT:
	67	case NL80211_CHAN_HT20:
	68	return AR9170_BW_20;
	69	case NL80211_CHAN_HT40MINUS:
	70	return AR9170_BW_40_BELOW;
	71	case NL80211_CHAN_HT40PLUS:
	72	return AR9170_BW_40_ABOVE;
	73	default:
	74	BUG();
	75	}
	76	}
	77
e9348cdd CL	78	enum ar9170_rf_init_mode {
	79	AR9170_RFI_NONE,
	80	AR9170_RFI_WARM,
	81	AR9170_RFI_COLD,
	82	};
	83
	84	#define AR9170_MAX_RX_BUFFER_SIZE 8192
	85
	86	#ifdef CONFIG_AR9170_LEDS
	87	struct ar9170;
	88
	89	struct ar9170_led {
	90	struct ar9170 *ar;
	91	struct led_classdev l;
	92	char name[32];
	93	unsigned int toggled;
2431fe9a	94	bool last_state;
e9348cdd CL	95	bool registered;
	96	};
	97
	98	#endif /* CONFIG_AR9170_LEDS */
	99
	100	enum ar9170_device_state {
	101	AR9170_UNKNOWN_STATE,
	102	AR9170_STOPPED,
	103	AR9170_IDLE,
	104	AR9170_STARTED,
e9348cdd CL	105	};
e9348cdd CL	106
cca84799 CL	107	struct ar9170_rxstream_mpdu_merge {
	108	struct ar9170_rx_head plcp;
	109	bool has_plcp;
	110	};
	111
d1ace8e5 KV	112	struct ar9170_tx_queue_stats {
	113	unsigned int len;
	114	unsigned int limit;
	115	unsigned int count;
	116	};
	117
9b9c5aae CL	118	#define AR9170_QUEUE_TIMEOUT 64
	119	#define AR9170_TX_TIMEOUT 8
	120	#define AR9170_JANITOR_DELAY 128
	121	#define AR9170_TX_INVALID_RATE 0xffffffff
	122
f3926b49 CL	123	#define AR9170_NUM_TX_LIMIT_HARD AR9170_TXQ_DEPTH
f3926b49 CL	124	#define AR9170_NUM_TX_LIMIT_SOFT (AR9170_TXQ_DEPTH - 10)
acbadf01	125
e9348cdd CL	126	struct ar9170 {
e9348cdd CL	127	struct ieee80211_hw *hw;
608b88cb	128	struct ath_common common;
e9348cdd CL	129	struct mutex mutex;
e9348cdd CL	130	enum ar9170_device_state state;
53576517	131	bool registered;
cca84799	132	unsigned long bad_hw_nagger;
e9348cdd CL	133
	134	int (open)(struct ar9170 );
	135	void (stop)(struct ar9170 );
9b9c5aae	136	int (tx)(struct ar9170 , struct sk_buff *);
e9348cdd CL	137	int (exec_cmd)(struct ar9170 , enum ar9170_cmd, u32 ,
	138	void , u32 , void );
	139	void (callback_cmd)(struct ar9170 , u32 , void *);
9b9c5aae	140	int (flush)(struct ar9170 );
e9348cdd CL	141
	142	/* interface mode settings */
	143	struct ieee80211_vif *vif;
e9348cdd CL	144
	145	/* beaconing */
	146	struct sk_buff *beacon;
	147	struct work_struct beacon_work;
ea39d1a4	148	bool enable_beacon;
e9348cdd CL	149
	150	/* cryptographic engine */
	151	u64 usedkeys;
	152	bool rx_software_decryption;
	153	bool disable_offload;
	154
	155	/* filter settings */
eeef4185 CL	156	u64 cur_mc_hash;
eeef4185 CL	157	u32 cur_filter;
cca84799	158	unsigned int filter_state;
e9348cdd CL	159	bool sniffer_enabled;
	160
	161	/* PHY */
	162	struct ieee80211_channel *channel;
	163	int noise[4];
	164
	165	/* power calibration data */
	166	u8 power_5G_leg[4];
	167	u8 power_2G_cck[4];
	168	u8 power_2G_ofdm[4];
	169	u8 power_5G_ht20[8];
	170	u8 power_5G_ht40[8];
	171	u8 power_2G_ht20[8];
	172	u8 power_2G_ht40[8];
	173
7c52c07d JA	174	u8 phy_heavy_clip;
7c52c07d JA	175
e9348cdd CL	176	#ifdef CONFIG_AR9170_LEDS
	177	struct delayed_work led_work;
	178	struct ar9170_led leds[AR9170_NUM_LEDS];
	179	#endif /* CONFIG_AR9170_LEDS */
	180
	181	/* qos queue settings */
	182	spinlock_t tx_stats_lock;
d1ace8e5	183	struct ar9170_tx_queue_stats tx_stats[5];
e9348cdd CL	184	struct ieee80211_tx_queue_params edcf[5];
	185
	186	spinlock_t cmdlock;
	187	__le32 cmdbuf[PAYLOAD_MAX + 1];
	188
	189	/* MAC statistics */
	190	struct ieee80211_low_level_stats stats;
	191
	192	/* EEPROM */
	193	struct ar9170_eeprom eeprom;
	194
9b9c5aae CL	195	/* tx queues - as seen by hw - */
	196	struct sk_buff_head tx_pending[__AR9170_NUM_TXQ];
	197	struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
	198	struct delayed_work tx_janitor;
cca84799 CL	199
	200	/* rxstream mpdu merge */
	201	struct ar9170_rxstream_mpdu_merge rx_mpdu;
	202	struct sk_buff *rx_failover;
	203	int rx_failover_missing;
acbadf01 CL	204
	205	/* (cached) HW A-MPDU settings */
	206	u8 global_ampdu_density;
	207	u8 global_ampdu_factor;
e9348cdd CL	208	};
e9348cdd CL	209
9b9c5aae CL	210	struct ar9170_tx_info {
9b9c5aae CL	211	unsigned long timeout;
9b9c5aae CL	212	};
	213
	214	#define IS_STARTED(a) (((struct ar9170 *)a)->state >= AR9170_STARTED)
	215	#define IS_ACCEPTING_CMD(a) (((struct ar9170 *)a)->state >= AR9170_IDLE)
e9348cdd	216
e9348cdd CL	217	/* exported interface */
	218	void *ar9170_alloc(size_t priv_size);
	219	int ar9170_register(struct ar9170 ar, struct device pdev);
	220	void ar9170_rx(struct ar9170 ar, struct sk_buff skb);
	221	void ar9170_unregister(struct ar9170 *ar);
9b9c5aae	222	void ar9170_tx_callback(struct ar9170 ar, struct sk_buff skb);
66d00813	223	void ar9170_handle_command_response(struct ar9170 ar, void buf, u32 len);
9b9c5aae	224	int ar9170_nag_limiter(struct ar9170 *ar);
e9348cdd CL	225
	226	/* MAC */
	227	int ar9170_op_tx(struct ieee80211_hw hw, struct sk_buff skb);
	228	int ar9170_init_mac(struct ar9170 *ar);
	229	int ar9170_set_qos(struct ar9170 *ar);
eeef4185 CL	230	int ar9170_update_multicast(struct ar9170 *ar, const u64 mc_hast);
eeef4185 CL	231	int ar9170_update_frame_filter(struct ar9170 *ar, const u32 filter);
e9348cdd CL	232	int ar9170_set_operating_mode(struct ar9170 *ar);
e9348cdd CL	233	int ar9170_set_beacon_timers(struct ar9170 *ar);
29ceff5d CL	234	int ar9170_set_dyn_sifs_ack(struct ar9170 *ar);
	235	int ar9170_set_slot_time(struct ar9170 *ar);
	236	int ar9170_set_basic_rates(struct ar9170 *ar);
e9348cdd CL	237	int ar9170_set_hwretry_limit(struct ar9170 *ar, u32 max_retry);
	238	int ar9170_update_beacon(struct ar9170 *ar);
	239	void ar9170_new_beacon(struct work_struct *work);
	240	int ar9170_upload_key(struct ar9170 ar, u8 id, const u8 mac, u8 ktype,
	241	u8 keyidx, u8 *keydata, int keylen);
	242	int ar9170_disable_key(struct ar9170 *ar, u8 id);
	243
	244	/* LEDs */
	245	#ifdef CONFIG_AR9170_LEDS
	246	int ar9170_register_leds(struct ar9170 *ar);
	247	void ar9170_unregister_leds(struct ar9170 *ar);
	248	#endif /* CONFIG_AR9170_LEDS */
	249	int ar9170_init_leds(struct ar9170 *ar);
	250	int ar9170_set_leds_state(struct ar9170 *ar, u32 led_state);
	251
	252	/* PHY / RF */
	253	int ar9170_init_phy(struct ar9170 *ar, enum ieee80211_band band);
	254	int ar9170_init_rf(struct ar9170 *ar);
	255	int ar9170_set_channel(struct ar9170 ar, struct ieee80211_channel channel,
	256	enum ar9170_rf_init_mode rfi, enum ar9170_bw bw);
	257
	258	#endif /* __AR9170_H */