[net-next-2.6.git] / drivers / net / wireless / rt2x00 / rt2x00lib.h

/*
	Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
	Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
	<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

/*
 * Interval defines
 */
#define LINK_TUNE_INTERVAL	round_jiffies_relative(HZ)

/*
 * 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_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_align_frame - Align 802.11 frame to 4-byte boundary
 * @skb: The skb to align
 *
 * Align the start of the 802.11 frame to a 4-byte boundary, this could
 * mean the payload is not aligned properly though.
 */
void rt2x00queue_align_frame(struct sk_buff *skb);

/**
 * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
 * @skb: The skb to align
 * @header_length: Length of 802.11 header
 *
 * Align the 802.11 payload to a 4-byte boundary, this could
 * mean the header is not aligned properly though.
 */
void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length);

/**
 * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
 * @skb: The skb to align
 * @header_length: Length of 802.11 header
 *
 * Apply L2 padding to align both header and payload to 4-byte boundary
 */
void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);

/**
 * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
 * @skb: The skb to align
 * @header_length: Length of 802.11 header
 *
 * Remove L2 padding used to align both header and payload to 4-byte boundary,
 * by removing the L2 padding the header will no longer be 4-byte aligned.
 */
void rt2x00queue_remove_l2pad(struct sk_buff *skb, 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
 * @local: frame is not from mac80211
 */
int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb,
			       bool local);

/**
 * 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_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_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_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,
			       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,
					     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);

u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
			    struct ieee80211_conf *conf);
#else
static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
						 struct txentry_desc *txdesc,
						 const struct rt2x00_rate *hwrate)
{
}

static inline u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
					  struct ieee80211_conf *conf)
{
	return conf->channel->hw_value;
}
#endif /* CONFIG_RT2X00_LIB_HT */

/*
 * RFkill handlers.
 */
static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
{
	if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
		wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
}

static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
{
	if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
		wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
}

/*
 * 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	/*
9c9a0d14 GW	2	Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
9c9a0d14 GW	3	Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
95ea3627 ID	4	<http://rt2x00.serialmonkey.com>
	5
	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 2 of the License, or
	9	(at your option) any later version.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the
	18	Free Software Foundation, Inc.,
	19	59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	20	*/
	21
	22	/*
	23	Module: rt2x00lib
	24	Abstract: Data structures and definitions for the rt2x00lib module.
	25	*/
	26
	27	#ifndef RT2X00LIB_H
	28	#define RT2X00LIB_H
	29
	30	/*
	31	* Interval defines
	32	*/
206eade5	33	#define LINK_TUNE_INTERVAL round_jiffies_relative(HZ)
95ea3627	34
70e2fed4 ID	35	/*
	36	* rt2x00_rate: Per rate device information
	37	*/
	38	struct rt2x00_rate {
	39	unsigned short flags;
31562e80 ID	40	#define DEV_RATE_CCK 0x0001
	41	#define DEV_RATE_OFDM 0x0002
	42	#define DEV_RATE_SHORT_PREAMBLE 0x0004
70e2fed4 ID	43
70e2fed4 ID	44	unsigned short bitrate; /* In 100kbit/s */
70e2fed4	45	unsigned short ratemask;
70e2fed4 ID	46
70e2fed4 ID	47	unsigned short plcp;
35f00cfc	48	unsigned short mcs;
70e2fed4 ID	49	};
	50
	51	extern const struct rt2x00_rate rt2x00_supported_rates[12];
	52
70e2fed4 ID	53	static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
	54	{
	55	return &rt2x00_supported_rates[hw_value & 0xff];
	56	}
	57
35f00cfc ID	58	#define RATE_MCS(__mode, __mcs) \
	59	( (((__mode) & 0x00ff) << 8) \| ((__mcs) & 0x00ff) )
	60
	61	static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
	62	{
	63	return (mcs_value & 0x00ff);
	64	}
	65
95ea3627 ID	66	/*
	67	* Radio control handlers.
	68	*/
	69	int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
	70	void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
5cbf830e	71	void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
95ea3627 ID	72
	73	/*
	74	* Initialization handlers.
	75	*/
e37ea213 ID	76	int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
e37ea213 ID	77	void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	78
	79	/*
	80	* Configuration handlers.
	81	*/
6bb40dd1 ID	82	void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
6bb40dd1 ID	83	struct rt2x00_intf *intf,
05c914fe	84	enum nl80211_iftype type,
5f936f11	85	const u8 mac, const u8 bssid);
72810379 ID	86	void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
	87	struct rt2x00_intf *intf,
	88	struct ieee80211_bss_conf *conf);
69f81a2c	89	void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
eb87eaac	90	struct antenna_setup ant);
066cb637	91	void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
e4ea1c40 ID	92	struct ieee80211_conf *conf,
e4ea1c40 ID	93	const unsigned int changed_flags);
95ea3627	94
d74f5ba4 ID	95	/**
	96	* DOC: Queue handlers
	97	*/
	98
	99	/**
	100	* rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
	101	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	102	* @queue: The queue for which the skb will be applicable.
	103	*/
	104	struct sk_buff rt2x00queue_alloc_rxskb(struct rt2x00_dev rt2x00dev,
	105	struct queue_entry *entry);
	106
d74f5ba4 ID	107	/**
	108	* rt2x00queue_free_skb - free a skb
	109	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	110	* @skb: The skb to free.
	111	*/
	112	void rt2x00queue_free_skb(struct rt2x00_dev rt2x00dev, struct sk_buff skb);
	113
9f166171	114	/**
daee6c09 ID	115	* rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
	116	* @skb: The skb to align
	117	*
	118	* Align the start of the 802.11 frame to a 4-byte boundary, this could
	119	* mean the payload is not aligned properly though.
	120	*/
	121	void rt2x00queue_align_frame(struct sk_buff *skb);
	122
	123	/**
	124	* rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
	125	* @skb: The skb to align
	126	* @header_length: Length of 802.11 header
	127	*
	128	* Align the 802.11 payload to a 4-byte boundary, this could
	129	* mean the header is not aligned properly though.
	130	*/
	131	void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length);
	132
	133	/**
	134	* rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
	135	* @skb: The skb to align
	136	* @header_length: Length of 802.11 header
	137	*
	138	* Apply L2 padding to align both header and payload to 4-byte boundary
	139	*/
	140	void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);
	141
	142	/**
	143	* rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
9f166171	144	* @skb: The skb to align
9f166171 ID	145	* @header_length: Length of 802.11 header
9f166171 ID	146	*
daee6c09 ID	147	* Remove L2 padding used to align both header and payload to 4-byte boundary,
daee6c09 ID	148	* by removing the L2 padding the header will no longer be 4-byte aligned.
9f166171	149	*/
daee6c09	150	void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
9f166171	151
d74f5ba4 ID	152	/**
	153	* rt2x00queue_write_tx_frame - Write TX frame to hardware
	154	* @queue: Queue over which the frame should be send
	155	* @skb: The skb to send
7351c6bd	156	* @local: frame is not from mac80211
181d6902	157	*/
7351c6bd JB	158	int rt2x00queue_write_tx_frame(struct data_queue queue, struct sk_buff skb,
7351c6bd JB	159	bool local);
d74f5ba4	160
bd88a781 ID	161	/**
	162	* rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
	163	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	164	* @vif: Interface for which the beacon should be updated.
a2c9b652	165	* @enable_beacon: Enable beaconing
bd88a781 ID	166	*/
bd88a781 ID	167	int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
a2c9b652 ID	168	struct ieee80211_vif *vif,
a2c9b652 ID	169	const bool enable_beacon);
bd88a781	170
d74f5ba4 ID	171	/**
	172	* rt2x00queue_index_inc - Index incrementation function
	173	* @queue: Queue (&struct data_queue) to perform the action on.
	174	* @index: Index type (&enum queue_index) to perform the action on.
	175	*
	176	* This function will increase the requested index on the queue,
	177	* it will grab the appropriate locks and handle queue overflow events by
	178	* resetting the index to the start of the queue.
	179	*/
	180	void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
	181
a2c9b652 ID	182	/**
	183	* rt2x00queue_stop_queues - Halt all data queues
	184	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	185	*
	186	* This function will loop through all available queues to stop
	187	* any pending outgoing frames.
	188	*/
	189	void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
	190
798b7adb ID	191	/**
	192	* rt2x00queue_init_queues - Initialize all data queues
	193	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	194	*
	195	* This function will loop through all available queues to clear all
	196	* index numbers and set the queue entry to the correct initialization
	197	* state.
	198	*/
	199	void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
	200
181d6902 ID	201	int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
	202	void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
	203	int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
	204	void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
	205
84e3196f ID	206	/**
	207	* rt2x00link_update_stats - Update link statistics from RX frame
	208	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	209	* @skb: Received frame
	210	* @rxdesc: Received frame descriptor
	211	*
	212	* Update link statistics based on the information from the
	213	* received frame descriptor.
	214	*/
	215	void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
	216	struct sk_buff *skb,
	217	struct rxdone_entry_desc *rxdesc);
	218
84e3196f ID	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);
2bb057d0	290	void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	291	struct rxdone_entry_desc *rxdesc);
95ea3627 ID	292	#else
	293	static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
	294	{
	295	}
	296
	297	static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
	298	{
	299	}
4d8dd66c	300
2bb057d0	301	static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	302	struct rxdone_entry_desc *rxdesc)
2bb057d0 ID	303	{
2bb057d0 ID	304	}
95ea3627 ID	305	#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
95ea3627 ID	306
2bb057d0 ID	307	/*
	308	* Crypto handlers.
	309	*/
	310	#ifdef CONFIG_RT2X00_LIB_CRYPTO
	311	enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
9c3444d3 ID	312	void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
9c3444d3 ID	313	struct txentry_desc *txdesc);
7b40982e ID	314	unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	315	struct sk_buff *skb);
9eb4e21e ID	316	void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
	317	struct txentry_desc *txdesc);
	318	void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
	319	struct txentry_desc *txdesc);
9f166171	320	void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
daee6c09	321	void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
2bb057d0 ID	322	unsigned int header_length,
	323	struct rxdone_entry_desc *rxdesc);
	324	#else
	325	static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
	326	{
	327	return CIPHER_NONE;
	328	}
	329
9c3444d3 ID	330	static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
	331	struct txentry_desc *txdesc)
	332	{
	333	}
	334
7b40982e ID	335	static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	336	struct sk_buff *skb)
2bb057d0 ID	337	{
	338	return 0;
	339	}
	340
dddfb478	341	static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
9eb4e21e	342	struct txentry_desc *txdesc)
dddfb478 ID	343	{
	344	}
	345
2bb057d0	346	static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
9eb4e21e	347	struct txentry_desc *txdesc)
2bb057d0 ID	348	{
	349	}
	350
9f166171 ID	351	static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
9f166171 ID	352	unsigned int header_length)
2bb057d0 ID	353	{
	354	}
	355
fe247563	356	static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
2bb057d0 ID	357	unsigned int header_length,
	358	struct rxdone_entry_desc *rxdesc)
	359	{
	360	}
9c3444d3	361	#endif /* CONFIG_RT2X00_LIB_CRYPTO */
2bb057d0	362
35f00cfc ID	363	/*
	364	* HT handlers.
	365	*/
	366	#ifdef CONFIG_RT2X00_LIB_HT
	367	void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
	368	struct txentry_desc *txdesc,
	369	const struct rt2x00_rate *hwrate);
06443e46 GW	370
	371	u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
	372	struct ieee80211_conf *conf);
35f00cfc ID	373	#else
	374	static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
	375	struct txentry_desc *txdesc,
	376	const struct rt2x00_rate *hwrate)
	377	{
	378	}
06443e46 GW	379
	380	static inline u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
	381	struct ieee80211_conf *conf)
	382	{
	383	return conf->channel->hw_value;
	384	}
35f00cfc ID	385	#endif /* CONFIG_RT2X00_LIB_HT */
35f00cfc ID	386
95ea3627 ID	387	/*
	388	* RFkill handlers.
	389	*/
1682fe6d	390	static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
95ea3627	391	{
e47a5cdd ID	392	if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
e47a5cdd ID	393	wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
95ea3627 ID	394	}
	395
	396	static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
	397	{
e47a5cdd ID	398	if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
e47a5cdd ID	399	wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
95ea3627 ID	400	}
95ea3627 ID	401
a9450b70 ID	402	/*
	403	* LED handlers
	404	*/
	405	#ifdef CONFIG_RT2X00_LIB_LEDS
	406	void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
61c2b682	407	void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	408	void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	409	void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
72fa559b	410	void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
a9450b70 ID	411	void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
	412	void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
	413	void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
	414	#else
	415	static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
	416	int rssi)
	417	{
	418	}
	419
61c2b682 ID	420	static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
	421	bool enabled)
	422	{
	423	}
	424
a2e1d52a ID	425	static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
	426	bool enabled)
	427	{
	428	}
	429
	430	static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
	431	bool enabled)
	432	{
	433	}
	434
72fa559b	435	static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
a9450b70	436	{
a9450b70 ID	437	}
	438
	439	static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
	440	{
	441	}
	442
	443	static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
	444	{
	445	}
	446
	447	static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
	448	{
	449	}
	450	#endif /* CONFIG_RT2X00_LIB_LEDS */
	451
95ea3627	452	#endif /* RT2X00LIB_H */