[deliverable/linux.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 WATCHDOG_INTERVAL	round_jiffies_relative(HZ)
#define LINK_TUNE_INTERVAL	round_jiffies_relative(HZ)
#define AGC_INTERVAL		round_jiffies_relative(4 * 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);

/*
 * 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,
			  u32 changed);
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.
 * @entry: The entry for which the skb will be applicable.
 */
struct sk_buff *rt2x00queue_alloc_rxskb(struct queue_entry *entry);

/**
 * rt2x00queue_free_skb - free a skb
 * @entry: The entry for which the skb will be applicable.
 */
void rt2x00queue_free_skb(struct queue_entry *entry);

/**
 * 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_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. Handles locking by itself (mutex).
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @vif: Interface for which the beacon should be updated.
 */
int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
			      struct ieee80211_vif *vif);

/**
 * rt2x00queue_update_beacon_locked - Send new beacon from mac80211
 *	to hardware. Caller needs to ensure locking.
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @vif: Interface for which the beacon should be updated.
 */
int rt2x00queue_update_beacon_locked(struct rt2x00_dev *rt2x00dev,
				     struct ieee80211_vif *vif);

/**
 * rt2x00queue_clear_beacon - Clear beacon in hardware
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 * @vif: Interface for which the beacon should be updated.
 */
int rt2x00queue_clear_beacon(struct rt2x00_dev *rt2x00dev,
			     struct ieee80211_vif *vif);

/**
 * rt2x00queue_index_inc - Index incrementation function
 * @entry: Queue entry (&struct queue_entry) 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 entry's 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 queue_entry *entry, enum queue_index index);

/**
 * 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_start_watchdog - Start periodic watchdog monitoring
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * This start the watchdog periodic work, this work will
 *be executed periodically until &rt2x00link_stop_watchdog has
 * been called.
 */
void rt2x00link_start_watchdog(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_stop_watchdog - Stop periodic watchdog monitoring
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * After this function completed the watchdog monitoring will not
 * be running until &rt2x00link_start_watchdog is called.
 */
void rt2x00link_stop_watchdog(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_start_agc - Start periodic gain calibration
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 */
void rt2x00link_start_agc(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_stop_agc - Stop periodic gain calibration
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 */
void rt2x00link_stop_agc(struct rt2x00_dev *rt2x00dev);

/**
 * rt2x00link_register - Initialize link tuning & watchdog functionality
 * @rt2x00dev: Pointer to &struct rt2x00_dev.
 *
 * Initialize work structure and all link tuning and watchdog related
 * parameters. This will not start the periodic work 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 rt2x00_dev *rt2x00dev,
				       struct sk_buff *skb,
				       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 rt2x00_dev *rt2x00dev,
						     struct sk_buff *skb,
						     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 */

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

static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
{
	if (test_bit(CAPABILITY_HW_BUTTON, &rt2x00dev->cap_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	*/
c965c74b	33	#define WATCHDOG_INTERVAL round_jiffies_relative(HZ)
206eade5	34	#define LINK_TUNE_INTERVAL round_jiffies_relative(HZ)
9e33a355	35	#define AGC_INTERVAL round_jiffies_relative(4 * HZ)
95ea3627	36
70e2fed4 ID	37	/*
	38	* rt2x00_rate: Per rate device information
	39	*/
	40	struct rt2x00_rate {
	41	unsigned short flags;
31562e80 ID	42	#define DEV_RATE_CCK 0x0001
	43	#define DEV_RATE_OFDM 0x0002
	44	#define DEV_RATE_SHORT_PREAMBLE 0x0004
70e2fed4 ID	45
70e2fed4 ID	46	unsigned short bitrate; /* In 100kbit/s */
70e2fed4	47	unsigned short ratemask;
70e2fed4 ID	48
70e2fed4 ID	49	unsigned short plcp;
35f00cfc	50	unsigned short mcs;
70e2fed4 ID	51	};
	52
	53	extern const struct rt2x00_rate rt2x00_supported_rates[12];
	54
70e2fed4 ID	55	static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
	56	{
	57	return &rt2x00_supported_rates[hw_value & 0xff];
	58	}
	59
35f00cfc	60	#define RATE_MCS(__mode, __mcs) \
5f181dc1	61	((((__mode) & 0x00ff) << 8) \| ((__mcs) & 0x00ff))
35f00cfc ID	62
	63	static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
	64	{
	65	return (mcs_value & 0x00ff);
	66	}
	67
95ea3627 ID	68	/*
	69	* Radio control handlers.
	70	*/
	71	int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
	72	void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	73
	74	/*
	75	* Initialization handlers.
	76	*/
e37ea213 ID	77	int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
e37ea213 ID	78	void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
95ea3627 ID	79
	80	/*
	81	* Configuration handlers.
	82	*/
6bb40dd1 ID	83	void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
6bb40dd1 ID	84	struct rt2x00_intf *intf,
05c914fe	85	enum nl80211_iftype type,
5f936f11	86	const u8 mac, const u8 bssid);
72810379 ID	87	void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
72810379 ID	88	struct rt2x00_intf *intf,
02044643 HS	89	struct ieee80211_bss_conf *conf,
02044643 HS	90	u32 changed);
69f81a2c	91	void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
eb87eaac	92	struct antenna_setup ant);
066cb637	93	void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
e4ea1c40 ID	94	struct ieee80211_conf *conf,
e4ea1c40 ID	95	const unsigned int changed_flags);
95ea3627	96
d74f5ba4 ID	97	/**
	98	* DOC: Queue handlers
	99	*/
	100
	101	/**
	102	* rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
fa69560f	103	* @entry: The entry for which the skb will be applicable.
d74f5ba4	104	*/
fa69560f	105	struct sk_buff rt2x00queue_alloc_rxskb(struct queue_entry entry);
d74f5ba4	106
d74f5ba4 ID	107	/**
d74f5ba4 ID	108	* rt2x00queue_free_skb - free a skb
fa69560f	109	* @entry: The entry for which the skb will be applicable.
d74f5ba4	110	*/
fa69560f	111	void rt2x00queue_free_skb(struct queue_entry *entry);
d74f5ba4	112
9f166171	113	/**
daee6c09 ID	114	* rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
	115	* @skb: The skb to align
	116	*
	117	* Align the start of the 802.11 frame to a 4-byte boundary, this could
	118	* mean the payload is not aligned properly though.
	119	*/
	120	void rt2x00queue_align_frame(struct sk_buff *skb);
	121
daee6c09 ID	122	/**
	123	* rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
	124	* @skb: The skb to align
	125	* @header_length: Length of 802.11 header
	126	*
	127	* Apply L2 padding to align both header and payload to 4-byte boundary
	128	*/
	129	void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);
	130
	131	/**
	132	* rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
9f166171	133	* @skb: The skb to align
9f166171 ID	134	* @header_length: Length of 802.11 header
9f166171 ID	135	*
daee6c09 ID	136	* Remove L2 padding used to align both header and payload to 4-byte boundary,
daee6c09 ID	137	* by removing the L2 padding the header will no longer be 4-byte aligned.
9f166171	138	*/
daee6c09	139	void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
9f166171	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
7351c6bd	145	* @local: frame is not from mac80211
181d6902	146	*/
7351c6bd JB	147	int rt2x00queue_write_tx_frame(struct data_queue queue, struct sk_buff skb,
7351c6bd JB	148	bool local);
d74f5ba4	149
bd88a781	150	/**
8414ff07 HS	151	* rt2x00queue_update_beacon - Send new beacon from mac80211
8414ff07 HS	152	* to hardware. Handles locking by itself (mutex).
bd88a781 ID	153	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	154	* @vif: Interface for which the beacon should be updated.
	155	*/
	156	int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
69cf36a4 HS	157	struct ieee80211_vif *vif);
69cf36a4 HS	158
8414ff07 HS	159	/**
	160	* rt2x00queue_update_beacon_locked - Send new beacon from mac80211
	161	* to hardware. Caller needs to ensure locking.
	162	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	163	* @vif: Interface for which the beacon should be updated.
	164	*/
	165	int rt2x00queue_update_beacon_locked(struct rt2x00_dev *rt2x00dev,
	166	struct ieee80211_vif *vif);
	167
69cf36a4 HS	168	/**
	169	* rt2x00queue_clear_beacon - Clear beacon in hardware
	170	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	171	* @vif: Interface for which the beacon should be updated.
	172	*/
	173	int rt2x00queue_clear_beacon(struct rt2x00_dev *rt2x00dev,
	174	struct ieee80211_vif *vif);
bd88a781	175
d74f5ba4 ID	176	/**
d74f5ba4 ID	177	* rt2x00queue_index_inc - Index incrementation function
75256f03	178	* @entry: Queue entry (&struct queue_entry) to perform the action on.
d74f5ba4 ID	179	* @index: Index type (&enum queue_index) to perform the action on.
d74f5ba4 ID	180	*
75256f03	181	* This function will increase the requested index on the entry's queue,
d74f5ba4 ID	182	* it will grab the appropriate locks and handle queue overflow events by
	183	* resetting the index to the start of the queue.
	184	*/
75256f03	185	void rt2x00queue_index_inc(struct queue_entry *entry, enum queue_index index);
d74f5ba4	186
798b7adb ID	187	/**
	188	* rt2x00queue_init_queues - Initialize all data queues
	189	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	190	*
	191	* This function will loop through all available queues to clear all
	192	* index numbers and set the queue entry to the correct initialization
	193	* state.
	194	*/
	195	void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
	196
181d6902 ID	197	int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
	198	void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
	199	int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
	200	void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
	201
84e3196f ID	202	/**
	203	* rt2x00link_update_stats - Update link statistics from RX frame
	204	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	205	* @skb: Received frame
	206	* @rxdesc: Received frame descriptor
	207	*
	208	* Update link statistics based on the information from the
	209	* received frame descriptor.
	210	*/
	211	void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
	212	struct sk_buff *skb,
	213	struct rxdone_entry_desc *rxdesc);
	214
84e3196f ID	215	/**
	216	* rt2x00link_start_tuner - Start periodic link tuner work
	217	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	218	*
	219	* This start the link tuner periodic work, this work will
	220	* be executed periodically until &rt2x00link_stop_tuner has
	221	* been called.
	222	*/
	223	void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
	224
	225	/**
	226	* rt2x00link_stop_tuner - Stop periodic link tuner work
	227	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	228	*
	229	* After this function completed the link tuner will not
	230	* be running until &rt2x00link_start_tuner is called.
	231	*/
	232	void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
	233
	234	/**
	235	* rt2x00link_reset_tuner - Reset periodic link tuner work
	236	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	237	* @antenna: Should the antenna tuning also be reset
	238	*
	239	* The VGC limit configured in the hardware will be reset to 0
	240	* which forces the driver to rediscover the correct value for
	241	* the current association. This is needed when configuration
	242	* options have changed which could drastically change the
	243	* SNR level or link quality (i.e. changing the antenna setting).
	244	*
	245	* Resetting the link tuner will also cause the periodic work counter
	246	* to be reset. Any driver which has a fixed limit on the number
	247	* of rounds the link tuner is supposed to work will accept the
	248	* tuner actions again if this limit was previously reached.
	249	*
	250	* If @antenna is set to true a the software antenna diversity
	251	* tuning will also be reset.
	252	*/
	253	void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
	254
	255	/**
c965c74b	256	* rt2x00link_start_watchdog - Start periodic watchdog monitoring
84e3196f ID	257	* @rt2x00dev: Pointer to &struct rt2x00_dev.
84e3196f ID	258	*
c965c74b ID	259	* This start the watchdog periodic work, this work will
	260	*be executed periodically until &rt2x00link_stop_watchdog has
	261	* been called.
	262	*/
	263	void rt2x00link_start_watchdog(struct rt2x00_dev *rt2x00dev);
	264
	265	/**
	266	* rt2x00link_stop_watchdog - Stop periodic watchdog monitoring
	267	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	268	*
	269	* After this function completed the watchdog monitoring will not
	270	* be running until &rt2x00link_start_watchdog is called.
	271	*/
	272	void rt2x00link_stop_watchdog(struct rt2x00_dev *rt2x00dev);
	273
9e33a355 HS	274	/**
	275	* rt2x00link_start_agc - Start periodic gain calibration
	276	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	277	*/
	278	void rt2x00link_start_agc(struct rt2x00_dev *rt2x00dev);
	279
	280	/**
	281	* rt2x00link_stop_agc - Stop periodic gain calibration
	282	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	283	*/
	284	void rt2x00link_stop_agc(struct rt2x00_dev *rt2x00dev);
	285
c965c74b ID	286	/**
	287	* rt2x00link_register - Initialize link tuning & watchdog functionality
	288	* @rt2x00dev: Pointer to &struct rt2x00_dev.
	289	*
	290	* Initialize work structure and all link tuning and watchdog related
	291	* parameters. This will not start the periodic work itself.
84e3196f ID	292	*/
	293	void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
	294
95ea3627 ID	295	/*
	296	* Firmware handlers.
	297	*/
	298	#ifdef CONFIG_RT2X00_LIB_FIRMWARE
	299	int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
	300	void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
	301	#else
	302	static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
	303	{
	304	return 0;
	305	}
	306	static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
	307	{
	308	}
	309	#endif /* CONFIG_RT2X00_LIB_FIRMWARE */
	310
	311	/*
	312	* Debugfs handlers.
	313	*/
	314	#ifdef CONFIG_RT2X00_LIB_DEBUGFS
	315	void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
	316	void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
2bb057d0	317	void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	318	struct rxdone_entry_desc *rxdesc);
95ea3627 ID	319	#else
	320	static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
	321	{
	322	}
	323
	324	static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
	325	{
	326	}
4d8dd66c	327
2bb057d0	328	static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
84e3196f	329	struct rxdone_entry_desc *rxdesc)
2bb057d0 ID	330	{
2bb057d0 ID	331	}
95ea3627 ID	332	#endif /* CONFIG_RT2X00_LIB_DEBUGFS */
95ea3627 ID	333
2bb057d0 ID	334	/*
	335	* Crypto handlers.
	336	*/
	337	#ifdef CONFIG_RT2X00_LIB_CRYPTO
	338	enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
77b5621b GW	339	void rt2x00crypto_create_tx_descriptor(struct rt2x00_dev *rt2x00dev,
77b5621b GW	340	struct sk_buff *skb,
9c3444d3	341	struct txentry_desc *txdesc);
7b40982e ID	342	unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	343	struct sk_buff *skb);
9eb4e21e ID	344	void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
	345	struct txentry_desc *txdesc);
	346	void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
	347	struct txentry_desc *txdesc);
9f166171	348	void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
daee6c09	349	void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
2bb057d0 ID	350	unsigned int header_length,
	351	struct rxdone_entry_desc *rxdesc);
	352	#else
	353	static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
	354	{
	355	return CIPHER_NONE;
	356	}
	357
449f94ea HS	358	static inline void rt2x00crypto_create_tx_descriptor(struct rt2x00_dev *rt2x00dev,
449f94ea HS	359	struct sk_buff *skb,
9c3444d3 ID	360	struct txentry_desc *txdesc)
	361	{
	362	}
	363
7b40982e ID	364	static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
7b40982e ID	365	struct sk_buff *skb)
2bb057d0 ID	366	{
	367	return 0;
	368	}
	369
dddfb478	370	static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
9eb4e21e	371	struct txentry_desc *txdesc)
dddfb478 ID	372	{
	373	}
	374
2bb057d0	375	static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
9eb4e21e	376	struct txentry_desc *txdesc)
2bb057d0 ID	377	{
	378	}
	379
9f166171 ID	380	static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
9f166171 ID	381	unsigned int header_length)
2bb057d0 ID	382	{
	383	}
	384
fe247563	385	static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
2bb057d0 ID	386	unsigned int header_length,
	387	struct rxdone_entry_desc *rxdesc)
	388	{
	389	}
9c3444d3	390	#endif /* CONFIG_RT2X00_LIB_CRYPTO */
2bb057d0	391
95ea3627 ID	392	/*
	393	* RFkill handlers.
	394	*/
1682fe6d	395	static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
95ea3627	396	{
7dab73b3	397	if (test_bit(CAPABILITY_HW_BUTTON, &rt2x00dev->cap_flags))
e47a5cdd	398	wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
95ea3627 ID	399	}
	400
	401	static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
	402	{
7dab73b3	403	if (test_bit(CAPABILITY_HW_BUTTON, &rt2x00dev->cap_flags))
e47a5cdd	404	wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
95ea3627 ID	405	}
95ea3627 ID	406
a9450b70 ID	407	/*
	408	* LED handlers
	409	*/
	410	#ifdef CONFIG_RT2X00_LIB_LEDS
	411	void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
61c2b682	412	void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	413	void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
a2e1d52a ID	414	void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
72fa559b	415	void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
a9450b70 ID	416	void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
	417	void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
	418	void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
	419	#else
	420	static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
	421	int rssi)
	422	{
	423	}
	424
61c2b682 ID	425	static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
	426	bool enabled)
	427	{
	428	}
	429
a2e1d52a ID	430	static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
	431	bool enabled)
	432	{
	433	}
	434
	435	static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
	436	bool enabled)
	437	{
	438	}
	439
72fa559b	440	static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
a9450b70	441	{
a9450b70 ID	442	}
	443
	444	static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
	445	{
	446	}
	447
	448	static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
	449	{
	450	}
	451
	452	static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
	453	{
	454	}
	455	#endif /* CONFIG_RT2X00_LIB_LEDS */
	456
95ea3627	457	#endif /* RT2X00LIB_H */