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