[deliverable/linux.git] / drivers / net / wireless / rt2x00 / rt2x00lib.h

/*
	Copyright (C) 2004 - 2009 rt2x00 SourceForge Project
	<http://rt2x00.serialmonkey.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; if not, write to the
	Free Software Foundation, Inc.,
	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/*
	Module: rt2x00lib
	Abstract: Data structures and definitions for the rt2x00lib module.
 */

#ifndef RT2X00LIB_H
#define RT2X00LIB_H

#include "rt2x00dump.h"

/*
 * Interval defines
 * Both the link tuner as the rfkill will be called once per second.
 */
#define LINK_TUNE_INTERVAL	round_jiffies_relative(HZ)
#define RFKILL_POLL_INTERVAL	1000

/*
 * rt2x00_rate: Per rate device information
 */
struct rt2x00_rate {
	unsigned short flags;
#define DEV_RATE_CCK			0x0001
#define DEV_RATE_OFDM			0x0002
#define DEV_RATE_SHORT_PREAMBLE		0x0004

	unsigned short bitrate; /* In 100kbit/s */
	unsigned short ratemask;

	unsigned short plcp;
	unsigned short mcs;
};

extern const struct rt2x00_rate rt2x00_supported_rates[12];

static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
{
	return &rt2x00_supported_rates[hw_value & 0xff];
}

#define RATE_MCS(__mode, __mcs) \
	( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) )

static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
{
	return (mcs_value & 0x00ff);
}

/*
 * Radio control handlers.
 */
int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);

/*
 * Initialization handlers.
 */
int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);

/*
 * Configuration handlers.
 */
void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
			   struct rt2x00_intf *intf,
			   enum nl80211_iftype type,
			   const u8 *mac, const u8 *bssid);
void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
			  struct rt2x00_intf *intf,
			  struct ieee80211_bss_conf *conf);
void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
			      struct antenna_setup *ant);
void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
		      struct ieee80211_conf *conf,
		      const unsigned int changed_flags);

/**
 * DOC: Queue handlers
 */

/**
 * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @queue: The queue for which the skb will be applicable.
 */
struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
					struct queue_entry *entry);

/**
 * rt2x00queue_unmap_skb - Unmap a skb from DMA.
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @skb: The skb to unmap.
 */
void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);

/**
 * rt2x00queue_free_skb - free a skb
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @skb: The skb to free.
 */
void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);

/**
 * rt2x00queue_payload_align - Align 802.11 payload to 4-byte boundary
 * @skb: The skb to align
 * @l2pad: Should L2 padding be used
 * @header_length: Length of 802.11 header
 *
 * This function prepares the @skb to be send to the device or mac80211.
 * If @l2pad is set to true padding will occur between the 802.11 header
 * and payload. Otherwise the padding will be done in front of the 802.11
 * header.
 * When @l2pad is set the function will check for the &SKBDESC_L2_PADDED
 * flag in &skb_frame_desc. If that flag is set, the padding is removed
 * and the flag cleared. Otherwise the padding is added and the flag is set.
 */
void rt2x00queue_payload_align(struct sk_buff *skb,
			       bool l2pad, unsigned int header_length);

/**
 * rt2x00queue_write_tx_frame - Write TX frame to hardware
 * @queue: Queue over which the frame should be send
 * @skb: The skb to send
 */
int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb);

/**
 * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @vif: Interface for which the beacon should be updated.
 * @enable_beacon: Enable beaconing
 */
int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
			      struct ieee80211_vif *vif,
			      const bool enable_beacon);

/**
 * rt2x00queue_index_inc - Index incrementation function
 * @queue: Queue (&struct data_queue) to perform the action on.
 * @index: Index type (&enum queue_index) to perform the action on.
 *
 * This function will increase the requested index on the queue,
 * it will grab the appropriate locks and handle queue overflow events by
 * resetting the index to the start of the queue.
 */
void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);

/**
 * rt2x00queue_stop_queues - Halt all data queues
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * This function will loop through all available queues to stop
 * any pending outgoing frames.
 */
void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00queue_init_queues - Initialize all data queues
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * This function will loop through all available queues to clear all
 * index numbers and set the queue entry to the correct initialization
 * state.
 */
void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);

int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_update_stats - Update link statistics from RX frame
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @skb: Received frame
 * @rxdesc: Received frame descriptor
 *
 * Update link statistics based on the information from the
 * received frame descriptor.
 */
void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
			     struct sk_buff *skb,
			     struct rxdone_entry_desc *rxdesc);

/**
 * rt2x00link_calculate_signal - Calculate signal quality
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @rssi: RX Frame RSSI
 *
 * Calculate the signal quality of a frame based on the rssi
 * measured during the receiving of the frame and the global
 * link quality statistics measured since the start of the
 * link tuning. The result is a value between 0 and 100 which
 * is an indication of the signal quality.
 */
int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi);

/**
 * rt2x00link_start_tuner - Start periodic link tuner work
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * This start the link tuner periodic work, this work will
 * be executed periodically until &rt2x00link_stop_tuner has
 * been called.
 */
void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_stop_tuner - Stop periodic link tuner work
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * After this function completed the link tuner will not
 * be running until &rt2x00link_start_tuner is called.
 */
void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_reset_tuner - Reset periodic link tuner work
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @antenna: Should the antenna tuning also be reset
 *
 * The VGC limit configured in the hardware will be reset to 0
 * which forces the driver to rediscover the correct value for
 * the current association. This is needed when configuration
 * options have changed which could drastically change the
 * SNR level or link quality (i.e. changing the antenna setting).
 *
 * Resetting the link tuner will also cause the periodic work counter
 * to be reset. Any driver which has a fixed limit on the number
 * of rounds the link tuner is supposed to work will accept the
 * tuner actions again if this limit was previously reached.
 *
 * If @antenna is set to true a the software antenna diversity
 * tuning will also be reset.
 */
void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);

/**
 * rt2x00link_register - Initialize link tuning functionality
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * Initialize work structure and all link tuning related
 * parameters. This will not start the link tuning process itself.
 */
void rt2x00link_register(struct rt2x00_dev *rt2x00dev);

/*
 * Firmware handlers.
 */
#ifdef CONFIG_RT2X00_LIB_FIRMWARE
int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
#else
static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
{
	return 0;
}
static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
{
}
#endif /* CONFIG_RT2X00_LIB_FIRMWARE */

/*
 * Debugfs handlers.
 */
#ifdef CONFIG_RT2X00_LIB_DEBUGFS
void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
			    enum rt2x00_dump_type type, struct sk_buff *skb);
void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
			       struct rxdone_entry_desc *rxdesc);
#else
static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
					  enum rt2x00_dump_type type,
					  struct sk_buff *skb)
{
}

static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
					     struct rxdone_entry_desc *rxdesc)
{
}
#endif /* CONFIG_RT2X00_LIB_DEBUGFS */

/*
 * Crypto handlers.
 */
#ifdef CONFIG_RT2X00_LIB_CRYPTO
enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
				       struct txentry_desc *txdesc);
unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
				      struct sk_buff *skb);
void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
			     struct txentry_desc *txdesc);
void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
			       struct txentry_desc *txdesc);
void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad,
			       unsigned int header_length,
			       struct rxdone_entry_desc *rxdesc);
#else
static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
{
	return CIPHER_NONE;
}

static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
						     struct txentry_desc *txdesc)
{
}

static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
						    struct sk_buff *skb)
{
	return 0;
}

static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
					   struct txentry_desc *txdesc)
{
}

static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
					     struct txentry_desc *txdesc)
{
}

static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
					     unsigned int header_length)
{
}

static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad,
					     unsigned int header_length,
					     struct rxdone_entry_desc *rxdesc)
{
}
#endif /* CONFIG_RT2X00_LIB_CRYPTO */

/*
 * HT handlers.
 */
#ifdef CONFIG_RT2X00_LIB_HT
void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
				   struct txentry_desc *txdesc,
				   const struct rt2x00_rate *hwrate);
#else
static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
						 struct txentry_desc *txdesc,
						 const struct rt2x00_rate *hwrate)
{
}
#endif /* CONFIG_RT2X00_LIB_HT */

/*
 * RFkill handlers.
 */
#ifdef CONFIG_RT2X00_LIB_RFKILL
void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
#else
static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
{
}
#endif /* CONFIG_RT2X00_LIB_RFKILL */

/*
 * LED handlers
 */
#ifdef CONFIG_RT2X00_LIB_LEDS
void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
#else
static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
					  int rssi)
{
}

static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
					  bool enabled)
{
}

static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
					bool enabled)
{
}

static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
					bool enabled)
{
}

static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
{
}

static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
{
}
#endif /* CONFIG_RT2X00_LIB_LEDS */

#endif /* RT2X00LIB_H */
Commit	Line	Data
95ea3627	1	/*
4e54c711	2	Copyright (C) 2004 - 2009 rt2x00 SourceForge Project
95ea3627 ID	3	<http://rt2x00.serialmonkey.com>
	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
	7	the Free Software Foundation; either version 2 of the License, or
	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
	16	along with this program; if not, write to the
	17	Free Software Foundation, Inc.,
	18	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*/
	20
	21	/*
	22	Module: rt2x00lib
	23	Abstract: Data structures and definitions for the rt2x00lib module.
	24	*/
	25
	26	#ifndef RT2X00LIB_H
	27	#define RT2X00LIB_H
	28
5a6e5999 ID	29	#include "rt2x00dump.h"
5a6e5999 ID	30
95ea3627 ID	31	/*
95ea3627 ID	32	* Interval defines
81873e9c	33	* Both the link tuner as the rfkill will be called once per second.
95ea3627	34	*/
206eade5 AB	35	#define LINK_TUNE_INTERVAL round_jiffies_relative(HZ)
206eade5 AB	36	#define RFKILL_POLL_INTERVAL 1000
95ea3627	37
70e2fed4 ID	38	/*
	39	* rt2x00_rate: Per rate device information
	40	*/
	41	struct rt2x00_rate {
	42	unsigned short flags;
31562e80 ID	43	#define DEV_RATE_CCK 0x0001
	44	#define DEV_RATE_OFDM 0x0002
	45	#define DEV_RATE_SHORT_PREAMBLE 0x0004
70e2fed4 ID	46
70e2fed4 ID	47	unsigned short bitrate; /* In 100kbit/s */
70e2fed4	48	unsigned short ratemask;
70e2fed4 ID	49
70e2fed4 ID	50	unsigned short plcp;
35f00cfc	51	unsigned short mcs;
70e2fed4 ID	52	};
	53
	54	extern const struct rt2x00_rate rt2x00_supported_rates[12];
	55
70e2fed4 ID	56	static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
	57	{
	58	return &rt2x00_supported_rates[hw_value & 0xff];
	59	}
	60
35f00cfc ID	61	#define RATE_MCS(__mode, __mcs) \
	62	( (((__mode) & 0x00ff) << 8) \| ((__mcs) & 0x00ff) )
	63
	64	static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
	65	{
	66	return (mcs_value & 0x00ff);
	67	}
	68
95ea3627 ID	69	/*
	70	* Radio control handlers.
	71	*/
	72	int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
	73	void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
5cbf830e	74	void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
95ea3627 ID	75
	76	/*
	77	* Initialization handlers.
	78	*/
e37ea213 ID	79	int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
e37ea213 ID	80	void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	81
	82	/*
	83	* Configuration handlers.
	84	*/
6bb40dd1 ID	85	void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
6bb40dd1 ID	86	struct rt2x00_intf *intf,
05c914fe	87	enum nl80211_iftype type,
5f936f11	88	const u8 mac, const u8 bssid);
72810379 ID	89	void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
	90	struct rt2x00_intf *intf,
	91	struct ieee80211_bss_conf *conf);
69f81a2c	92	void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
6d64360a	93	struct antenna_setup *ant);
066cb637	94	void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
e4ea1c40 ID	95	struct ieee80211_conf *conf,
e4ea1c40 ID	96	const unsigned int changed_flags);
95ea3627	97
d74f5ba4 ID	98	/**
	99	* DOC: Queue handlers
	100	*/
	101
	102	/**
	103	* rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
	104	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	105	* @queue: The queue for which the skb will be applicable.
	106	*/
	107	struct sk_buff rt2x00queue_alloc_rxskb(struct rt2x00_dev rt2x00dev,
	108	struct queue_entry *entry);
	109
	110	/**
	111	* rt2x00queue_unmap_skb - Unmap a skb from DMA.
	112	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	113	* @skb: The skb to unmap.
	114	*/
	115	void rt2x00queue_unmap_skb(struct rt2x00_dev rt2x00dev, struct sk_buff skb);
	116
	117	/**
	118	* rt2x00queue_free_skb - free a skb
	119	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	120	* @skb: The skb to free.
	121	*/
	122	void rt2x00queue_free_skb(struct rt2x00_dev rt2x00dev, struct sk_buff skb);
	123
9f166171 ID	124	/**
	125	* rt2x00queue_payload_align - Align 802.11 payload to 4-byte boundary
	126	* @skb: The skb to align
	127	* @l2pad: Should L2 padding be used
	128	* @header_length: Length of 802.11 header
	129	*
	130	* This function prepares the @skb to be send to the device or mac80211.
	131	* If @l2pad is set to true padding will occur between the 802.11 header
	132	* and payload. Otherwise the padding will be done in front of the 802.11
	133	* header.
	134	* When @l2pad is set the function will check for the &SKBDESC_L2_PADDED
	135	* flag in &skb_frame_desc. If that flag is set, the padding is removed
	136	* and the flag cleared. Otherwise the padding is added and the flag is set.
	137	*/
	138	void rt2x00queue_payload_align(struct sk_buff *skb,
	139	bool l2pad, unsigned int header_length);
	140
d74f5ba4 ID	141	/**
	142	* rt2x00queue_write_tx_frame - Write TX frame to hardware
	143	* @queue: Queue over which the frame should be send
	144	* @skb: The skb to send
181d6902	145	*/
6db3786a	146	int rt2x00queue_write_tx_frame(struct data_queue queue, struct sk_buff skb);
d74f5ba4	147
bd88a781 ID	148	/**
	149	* rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
	150	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	151	* @vif: Interface for which the beacon should be updated.
a2c9b652	152	* @enable_beacon: Enable beaconing
bd88a781 ID	153	*/
bd88a781 ID	154	int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
a2c9b652 ID	155	struct ieee80211_vif *vif,
a2c9b652 ID	156	const bool enable_beacon);
bd88a781	157
d74f5ba4 ID	158	/**
	159	* rt2x00queue_index_inc - Index incrementation function
	160	* @queue: Queue (&struct data_queue) to perform the action on.
	161	* @index: Index type (&enum queue_index) to perform the action on.
	162	*
	163	* This function will increase the requested index on the queue,
	164	* it will grab the appropriate locks and handle queue overflow events by
	165	* resetting the index to the start of the queue.
	166	*/
	167	void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
	168
a2c9b652 ID	169	/**
	170	* rt2x00queue_stop_queues - Halt all data queues
	171	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	172	*
	173	* This function will loop through all available queues to stop
	174	* any pending outgoing frames.
	175	*/
	176	void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
	177
798b7adb ID	178	/**
	179	* rt2x00queue_init_queues - Initialize all data queues
	180	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	181	*
	182	* This function will loop through all available queues to clear all
	183	* index numbers and set the queue entry to the correct initialization
	184	* state.
	185	*/
	186	void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
	187
181d6902 ID	188	int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
	189	void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
	190	int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
	191	void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
	192
84e3196f ID	193	/**
	194	* rt2x00link_update_stats - Update link statistics from RX frame
	195	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	196	* @skb: Received frame
	197	* @rxdesc: Received frame descriptor
	198	*
	199	* Update link statistics based on the information from the
	200	* received frame descriptor.
	201	*/
	202	void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
	203	struct sk_buff *skb,
	204	struct rxdone_entry_desc *rxdesc);
	205
	206	/**
	207	* rt2x00link_calculate_signal - Calculate signal quality
	208	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	209	* @rssi: RX Frame RSSI
	210	*
	211	* Calculate the signal quality of a frame based on the rssi
	212	* measured during the receiving of the frame and the global
	213	* link quality statistics measured since the start of the
	214	* link tuning. The result is a value between 0 and 100 which
	215	* is an indication of the signal quality.
	216	*/
	217	int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi);
	218
	219	/**
	220	* rt2x00link_start_tuner - Start periodic link tuner work
	221	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	222	*
	223	* This start the link tuner periodic work, this work will
	224	* be executed periodically until &rt2x00link_stop_tuner has
	225	* been called.
	226	*/
	227	void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
	228
	229	/**
	230	* rt2x00link_stop_tuner - Stop periodic link tuner work
	231	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	232	*
	233	* After this function completed the link tuner will not
	234	* be running until &rt2x00link_start_tuner is called.
	235	*/
	236	void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
	237
	238	/**
	239	* rt2x00link_reset_tuner - Reset periodic link tuner work
	240	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	241	* @antenna: Should the antenna tuning also be reset
	242	*
	243	* The VGC limit configured in the hardware will be reset to 0
	244	* which forces the driver to rediscover the correct value for
	245	* the current association. This is needed when configuration
	246	* options have changed which could drastically change the
	247	* SNR level or link quality (i.e. changing the antenna setting).
	248	*
	249	* Resetting the link tuner will also cause the periodic work counter
	250	* to be reset. Any driver which has a fixed limit on the number
	251	* of rounds the link tuner is supposed to work will accept the
	252	* tuner actions again if this limit was previously reached.
	253	*
	254	* If @antenna is set to true a the software antenna diversity
	255	* tuning will also be reset.
	256	*/
257	void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
258
259	/**
260	* rt2x00link_register - Initialize link tuning functionality
261	* @rt2x00dev: Pointer to &struct rt2x00_dev.
262	*
263	* Initialize work structure and all link tuning related
98a1708d	264	* parameters. This will not start the link tuning process itself.
84e3196f ID	265	*/
	266	void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
	267
95ea3627 ID	268	/*
	269	* Firmware handlers.
	270	*/
	271	#ifdef CONFIG_RT2X00_LIB_FIRMWARE
	272	int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
	273	void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
	274	#else
	275	static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
	276	{
	277	return 0;
	278	}
	279	static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
	280	{
	281	}
	282	#endif /* CONFIG_RT2X00_LIB_FIRMWARE */
	283
	284	/*
	285	* Debugfs handlers.
	286	*/
	287	#ifdef CONFIG_RT2X00_LIB_DEBUGFS
	288	void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
	289	void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
5a6e5999 ID	290	void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
5a6e5999 ID	291	enum rt2x00_dump_type type, struct sk_buff *skb);
2bb057d0	292	void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	293	struct rxdone_entry_desc *rxdesc);
95ea3627 ID	294	#else
	295	static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
	296	{
	297	}
	298
	299	static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
	300	{
	301	}
4d8dd66c ID	302
4d8dd66c ID	303	static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev,
5a6e5999	304	enum rt2x00_dump_type type,
2b1ea591	305	struct sk_buff *skb)
4d8dd66c ID	306	{
4d8dd66c ID	307	}
2bb057d0 ID	308
2bb057d0 ID	309	static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	310	struct rxdone_entry_desc *rxdesc)
2bb057d0 ID	311	{
2bb057d0 ID	312	}
95ea3627 ID	313	#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
95ea3627 ID	314
2bb057d0 ID	315	/*
	316	* Crypto handlers.
	317	*/
	318	#ifdef CONFIG_RT2X00_LIB_CRYPTO
	319	enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
9c3444d3 ID	320	void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
9c3444d3 ID	321	struct txentry_desc *txdesc);
7b40982e ID	322	unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	323	struct sk_buff *skb);
9eb4e21e ID	324	void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
	325	struct txentry_desc *txdesc);
	326	void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
	327	struct txentry_desc *txdesc);
9f166171 ID	328	void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
9f166171 ID	329	void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad,
2bb057d0 ID	330	unsigned int header_length,
	331	struct rxdone_entry_desc *rxdesc);
	332	#else
	333	static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
	334	{
	335	return CIPHER_NONE;
	336	}
	337
9c3444d3 ID	338	static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
	339	struct txentry_desc *txdesc)
	340	{
	341	}
	342
7b40982e ID	343	static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	344	struct sk_buff *skb)
2bb057d0 ID	345	{
	346	return 0;
	347	}
	348
dddfb478	349	static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
9eb4e21e	350	struct txentry_desc *txdesc)
dddfb478 ID	351	{
	352	}
	353
2bb057d0	354	static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
9eb4e21e	355	struct txentry_desc *txdesc)
2bb057d0 ID	356	{
	357	}
	358
9f166171 ID	359	static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
9f166171 ID	360	unsigned int header_length)
2bb057d0 ID	361	{
	362	}
	363
9f166171	364	static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad,
2bb057d0 ID	365	unsigned int header_length,
	366	struct rxdone_entry_desc *rxdesc)
	367	{
	368	}
9c3444d3	369	#endif /* CONFIG_RT2X00_LIB_CRYPTO */
2bb057d0	370
35f00cfc ID	371	/*
	372	* HT handlers.
	373	*/
	374	#ifdef CONFIG_RT2X00_LIB_HT
	375	void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
	376	struct txentry_desc *txdesc,
	377	const struct rt2x00_rate *hwrate);
	378	#else
	379	static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
	380	struct txentry_desc *txdesc,
	381	const struct rt2x00_rate *hwrate)
	382	{
	383	}
	384	#endif /* CONFIG_RT2X00_LIB_HT */
	385
95ea3627 ID	386	/*
	387	* RFkill handlers.
	388	*/
	389	#ifdef CONFIG_RT2X00_LIB_RFKILL
1682fe6d	390	void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev);
95ea3627	391	void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev);
1682fe6d	392	void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	393	void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	394	#else
1682fe6d	395	static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
95ea3627	396	{
95ea3627 ID	397	}
	398
	399	static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
	400	{
	401	}
	402
1682fe6d	403	static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev)
95ea3627	404	{
95ea3627 ID	405	}
	406
	407	static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev)
	408	{
	409	}
	410	#endif /* CONFIG_RT2X00_LIB_RFKILL */
	411
a9450b70 ID	412	/*
	413	* LED handlers
	414	*/
	415	#ifdef CONFIG_RT2X00_LIB_LEDS
	416	void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
61c2b682	417	void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	418	void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	419	void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
72fa559b	420	void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
a9450b70 ID	421	void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
	422	void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
	423	void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
	424	#else
	425	static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
	426	int rssi)
	427	{
	428	}
	429
61c2b682 ID	430	static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
	431	bool enabled)
	432	{
	433	}
	434
a2e1d52a ID	435	static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
	436	bool enabled)
	437	{
	438	}
	439
	440	static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
	441	bool enabled)
	442	{
	443	}
	444
72fa559b	445	static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
a9450b70	446	{
a9450b70 ID	447	}
	448
	449	static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
	450	{
	451	}
	452
	453	static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
	454	{
	455	}
	456
	457	static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
	458	{
	459	}
	460	#endif /* CONFIG_RT2X00_LIB_LEDS */
	461
95ea3627	462	#endif /* RT2X00LIB_H */