/* SPDX-License-Identifier: GPL-2.0-or-later */ /* Copyright (C) 2010 Willow Garage <http://www.willowgarage.com> Copyright (C) 2004 - 2010 Ivo van Doorn <[email protected]> Copyright (C) 2004 - 2009 Gertjan van Wingerde <[email protected]> <http://rt2x00.serialmonkey.com> */ /* Module: rt2x00 Abstract: rt2x00 global information. */ #ifndef RT2X00_H #define RT2X00_H #include <linux/bitops.h> #include <linux/interrupt.h> #include <linux/skbuff.h> #include <linux/workqueue.h> #include <linux/firmware.h> #include <linux/leds.h> #include <linux/mutex.h> #include <linux/etherdevice.h> #include <linux/kfifo.h> #include <linux/hrtimer.h> #include <linux/average.h> #include <linux/usb.h> #include <linux/clk.h> #include <net/mac80211.h> #include "rt2x00debug.h" #include "rt2x00dump.h" #include "rt2x00leds.h" #include "rt2x00reg.h" #include "rt2x00queue.h" /* * Module information. */ #define DRV_VERSION … #define DRV_PROJECT … /* Debug definitions. * Debug output has to be enabled during compile time. */ #ifdef CONFIG_RT2X00_DEBUG #define DEBUG #endif /* CONFIG_RT2X00_DEBUG */ /* Utility printing macros * rt2x00_probe_err is for messages when rt2x00_dev is uninitialized */ #define rt2x00_probe_err(fmt, ...) … #define rt2x00_err(dev, fmt, ...) … #define rt2x00_warn(dev, fmt, ...) … #define rt2x00_info(dev, fmt, ...) … /* Various debug levels */ #define rt2x00_dbg(dev, fmt, ...) … #define rt2x00_eeprom_dbg(dev, fmt, ...) … /* * Duration calculations * The rate variable passed is: 100kbs. * To convert from bytes to bits we multiply size with 8, * then the size is multiplied with 10 to make the * real rate -> rate argument correction. */ #define GET_DURATION(__size, __rate) … #define GET_DURATION_RES(__size, __rate) … /* * Determine the number of L2 padding bytes required between the header and * the payload. */ #define L2PAD_SIZE(__hdrlen) … /* * Determine the alignment requirement, * to make sure the 802.11 payload is padded to a 4-byte boundrary * we must determine the address of the payload and calculate the * amount of bytes needed to move the data. */ #define ALIGN_SIZE(__skb, __header) … /* * Constants for extra TX headroom for alignment purposes. */ #define RT2X00_ALIGN_SIZE … #define RT2X00_L2PAD_SIZE … /* * Standard timing and size defines. * These values should follow the ieee80211 specifications. */ #define ACK_SIZE … #define IEEE80211_HEADER … #define PLCP … #define BEACON … #define PREAMBLE … #define SHORT_PREAMBLE … #define SLOT_TIME … #define SHORT_SLOT_TIME … #define SIFS … #define PIFS … #define SHORT_PIFS … #define DIFS … #define SHORT_DIFS … #define EIFS … #define SHORT_EIFS … enum rt2x00_chip_intf { … }; /* * Chipset identification * The chipset on the device is composed of a RT and RF chip. * The chipset combination is important for determining device capabilities. */ struct rt2x00_chip { … }; /* * RF register values that belong to a particular channel. */ struct rf_channel { … }; /* * Information structure for channel survey. */ struct rt2x00_chan_survey { … }; /* * Channel information structure */ struct channel_info { … }; /* * Antenna setup values. */ struct antenna_setup { … }; /* * Quality statistics about the currently active link. */ struct link_qual { … }; DECLARE_EWMA(rssi, 10, 8) /* * Antenna settings about the currently active link. */ struct link_ant { … }; /* * To optimize the quality of the link we need to store * the quality of received frames and periodically * optimize the link. */ struct link { … }; enum rt2x00_delayed_flags { … }; /* * Interface structure * Per interface configuration details, this structure * is allocated as the private data for ieee80211_vif. */ struct rt2x00_intf { … }; static inline struct rt2x00_intf* vif_to_intf(struct ieee80211_vif *vif) { … } /** * struct hw_mode_spec: Hardware specifications structure * * Details about the supported modes, rates and channels * of a particular chipset. This is used by rt2x00lib * to build the ieee80211_hw_mode array for mac80211. * * @supported_bands: Bitmask contained the supported bands (2.4GHz, 5.2GHz). * @supported_rates: Rate types which are supported (CCK, OFDM). * @num_channels: Number of supported channels. This is used as array size * for @tx_power_a, @tx_power_bg and @channels. * @channels: Device/chipset specific channel values (See &struct rf_channel). * @channels_info: Additional information for channels (See &struct channel_info). * @ht: Driver HT Capabilities (See &ieee80211_sta_ht_cap). */ struct hw_mode_spec { … }; /* * Configuration structure wrapper around the * mac80211 configuration structure. * When mac80211 configures the driver, rt2x00lib * can precalculate values which are equal for all * rt2x00 drivers. Those values can be stored in here. */ struct rt2x00lib_conf { … }; /* * Configuration structure for erp settings. */ struct rt2x00lib_erp { … }; /* * Configuration structure for hardware encryption. */ struct rt2x00lib_crypto { … }; /* * Configuration structure wrapper around the * rt2x00 interface configuration handler. */ struct rt2x00intf_conf { … }; /* * Private structure for storing STA details * wcid: Wireless Client ID */ struct rt2x00_sta { … }; static inline struct rt2x00_sta* sta_to_rt2x00_sta(struct ieee80211_sta *sta) { … } /* * rt2x00lib callback functions. */ struct rt2x00lib_ops { … }; /* * rt2x00 driver callback operation structure. */ struct rt2x00_ops { … }; /* * rt2x00 state flags */ enum rt2x00_state_flags { … }; /* * rt2x00 capability flags */ enum rt2x00_capability_flags { … }; /* * Interface combinations */ enum { … }; /* * rt2x00 device structure. */ struct rt2x00_dev { … }; struct rt2x00_bar_list_entry { … }; /* * Register defines. * Some registers require multiple attempts before success, * in those cases REGISTER_BUSY_COUNT attempts should be * taken with a REGISTER_BUSY_DELAY interval. Due to USB * bus delays, we do not have to loop so many times to wait * for valid register value on that bus. */ #define REGISTER_BUSY_COUNT … #define REGISTER_USB_BUSY_COUNT … #define REGISTER_BUSY_DELAY … /* * Generic RF access. * The RF is being accessed by word index. */ static inline u32 rt2x00_rf_read(struct rt2x00_dev *rt2x00dev, const unsigned int word) { … } static inline void rt2x00_rf_write(struct rt2x00_dev *rt2x00dev, const unsigned int word, u32 data) { … } /* * Generic EEPROM access. The EEPROM is being accessed by word or byte index. */ static inline void *rt2x00_eeprom_addr(struct rt2x00_dev *rt2x00dev, const unsigned int word) { … } static inline u16 rt2x00_eeprom_read(struct rt2x00_dev *rt2x00dev, const unsigned int word) { … } static inline void rt2x00_eeprom_write(struct rt2x00_dev *rt2x00dev, const unsigned int word, u16 data) { … } static inline u8 rt2x00_eeprom_byte(struct rt2x00_dev *rt2x00dev, const unsigned int byte) { … } /* * Chipset handlers */ static inline void rt2x00_set_chip(struct rt2x00_dev *rt2x00dev, const u16 rt, const u16 rf, const u16 rev) { … } static inline void rt2x00_set_rt(struct rt2x00_dev *rt2x00dev, const u16 rt, const u16 rev) { … } static inline void rt2x00_set_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) { … } static inline bool rt2x00_rt(struct rt2x00_dev *rt2x00dev, const u16 rt) { … } static inline bool rt2x00_rf(struct rt2x00_dev *rt2x00dev, const u16 rf) { … } static inline u16 rt2x00_rev(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_rt_rev(struct rt2x00_dev *rt2x00dev, const u16 rt, const u16 rev) { … } static inline bool rt2x00_rt_rev_lt(struct rt2x00_dev *rt2x00dev, const u16 rt, const u16 rev) { … } static inline bool rt2x00_rt_rev_gte(struct rt2x00_dev *rt2x00dev, const u16 rt, const u16 rev) { … } static inline void rt2x00_set_chip_intf(struct rt2x00_dev *rt2x00dev, enum rt2x00_chip_intf intf) { … } static inline bool rt2x00_intf(struct rt2x00_dev *rt2x00dev, enum rt2x00_chip_intf intf) { … } static inline bool rt2x00_is_pci(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_is_pcie(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_is_usb(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_is_soc(struct rt2x00_dev *rt2x00dev) { … } /* Helpers for capability flags */ static inline bool rt2x00_has_cap_flag(struct rt2x00_dev *rt2x00dev, enum rt2x00_capability_flags cap_flag) { … } static inline bool rt2x00_has_cap_hw_crypto(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_power_limit(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_control_filters(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_control_filter_pspoll(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_pre_tbtt_interrupt(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_link_tuning(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_frame_type(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_rf_sequence(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_external_lna_a(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_external_lna_bg(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_external_pa(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_double_antenna(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_bt_coexist(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_vco_recalibration(struct rt2x00_dev *rt2x00dev) { … } static inline bool rt2x00_has_cap_restart_hw(struct rt2x00_dev *rt2x00dev) { … } /** * rt2x00queue_map_txskb - Map a skb into DMA for TX purposes. * @entry: Pointer to &struct queue_entry * * Returns -ENOMEM if mapping fail, 0 otherwise. */ int rt2x00queue_map_txskb(struct queue_entry *entry); /** * rt2x00queue_unmap_skb - Unmap a skb from DMA. * @entry: Pointer to &struct queue_entry */ void rt2x00queue_unmap_skb(struct queue_entry *entry); /** * rt2x00queue_get_tx_queue - Convert tx queue index to queue pointer * @rt2x00dev: Pointer to &struct rt2x00_dev. * @queue: rt2x00 queue index (see &enum data_queue_qid). * * Returns NULL for non tx queues. */ static inline struct data_queue * rt2x00queue_get_tx_queue(struct rt2x00_dev *rt2x00dev, enum data_queue_qid queue) { … } /** * rt2x00queue_get_entry - Get queue entry where the given index points to. * @queue: Pointer to &struct data_queue from where we obtain the entry. * @index: Index identifier for obtaining the correct index. */ struct queue_entry *rt2x00queue_get_entry(struct data_queue *queue, enum queue_index index); /** * rt2x00queue_pause_queue - Pause a data queue * @queue: Pointer to &struct data_queue. * * This function will pause the data queue locally, preventing * new frames to be added to the queue (while the hardware is * still allowed to run). */ void rt2x00queue_pause_queue(struct data_queue *queue); /** * rt2x00queue_unpause_queue - unpause a data queue * @queue: Pointer to &struct data_queue. * * This function will unpause the data queue locally, allowing * new frames to be added to the queue again. */ void rt2x00queue_unpause_queue(struct data_queue *queue); /** * rt2x00queue_start_queue - Start a data queue * @queue: Pointer to &struct data_queue. * * This function will start handling all pending frames in the queue. */ void rt2x00queue_start_queue(struct data_queue *queue); /** * rt2x00queue_stop_queue - Halt a data queue * @queue: Pointer to &struct data_queue. * * This function will stop all pending frames in the queue. */ void rt2x00queue_stop_queue(struct data_queue *queue); /** * rt2x00queue_flush_queue - Flush a data queue * @queue: Pointer to &struct data_queue. * @drop: True to drop all pending frames. * * This function will flush the queue. After this call * the queue is guaranteed to be empty. */ void rt2x00queue_flush_queue(struct data_queue *queue, bool drop); /** * rt2x00queue_start_queues - Start all data queues * @rt2x00dev: Pointer to &struct rt2x00_dev. * * This function will loop through all available queues to start them */ void rt2x00queue_start_queues(struct rt2x00_dev *rt2x00dev); /** * 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 frames. */ void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev); /** * rt2x00queue_flush_queues - Flush all data queues * @rt2x00dev: Pointer to &struct rt2x00_dev. * @drop: True to drop all pending frames. * * This function will loop through all available queues to flush * any pending frames. */ void rt2x00queue_flush_queues(struct rt2x00_dev *rt2x00dev, bool drop); /* * Debugfs handlers. */ /** * rt2x00debug_dump_frame - Dump a frame to userspace through debugfs. * @rt2x00dev: Pointer to &struct rt2x00_dev. * @type: The type of frame that is being dumped. * @entry: The queue entry containing the frame to be dumped. */ #ifdef CONFIG_RT2X00_LIB_DEBUGFS void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, enum rt2x00_dump_type type, struct queue_entry *entry); #else static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, enum rt2x00_dump_type type, struct queue_entry *entry) { } #endif /* CONFIG_RT2X00_LIB_DEBUGFS */ /* * Utility functions. */ u32 rt2x00lib_get_bssidx(struct rt2x00_dev *rt2x00dev, struct ieee80211_vif *vif); void rt2x00lib_set_mac_address(struct rt2x00_dev *rt2x00dev, u8 *eeprom_mac_addr); /* * Interrupt context handlers. */ void rt2x00lib_beacondone(struct rt2x00_dev *rt2x00dev); void rt2x00lib_pretbtt(struct rt2x00_dev *rt2x00dev); void rt2x00lib_dmastart(struct queue_entry *entry); void rt2x00lib_dmadone(struct queue_entry *entry); void rt2x00lib_txdone(struct queue_entry *entry, struct txdone_entry_desc *txdesc); void rt2x00lib_txdone_nomatch(struct queue_entry *entry, struct txdone_entry_desc *txdesc); void rt2x00lib_txdone_noinfo(struct queue_entry *entry, u32 status); void rt2x00lib_rxdone(struct queue_entry *entry, gfp_t gfp); /* * mac80211 handlers. */ void rt2x00mac_tx(struct ieee80211_hw *hw, struct ieee80211_tx_control *control, struct sk_buff *skb); int rt2x00mac_start(struct ieee80211_hw *hw); void rt2x00mac_stop(struct ieee80211_hw *hw, bool suspend); void rt2x00mac_reconfig_complete(struct ieee80211_hw *hw, enum ieee80211_reconfig_type reconfig_type); int rt2x00mac_add_interface(struct ieee80211_hw *hw, struct ieee80211_vif *vif); void rt2x00mac_remove_interface(struct ieee80211_hw *hw, struct ieee80211_vif *vif); int rt2x00mac_config(struct ieee80211_hw *hw, u32 changed); void rt2x00mac_configure_filter(struct ieee80211_hw *hw, unsigned int changed_flags, unsigned int *total_flags, u64 multicast); int rt2x00mac_set_tim(struct ieee80211_hw *hw, struct ieee80211_sta *sta, bool set); #ifdef CONFIG_RT2X00_LIB_CRYPTO int rt2x00mac_set_key(struct ieee80211_hw *hw, enum set_key_cmd cmd, struct ieee80211_vif *vif, struct ieee80211_sta *sta, struct ieee80211_key_conf *key); #else #define rt2x00mac_set_key … #endif /* CONFIG_RT2X00_LIB_CRYPTO */ void rt2x00mac_sw_scan_start(struct ieee80211_hw *hw, struct ieee80211_vif *vif, const u8 *mac_addr); void rt2x00mac_sw_scan_complete(struct ieee80211_hw *hw, struct ieee80211_vif *vif); int rt2x00mac_get_stats(struct ieee80211_hw *hw, struct ieee80211_low_level_stats *stats); void rt2x00mac_bss_info_changed(struct ieee80211_hw *hw, struct ieee80211_vif *vif, struct ieee80211_bss_conf *bss_conf, u64 changes); int rt2x00mac_conf_tx(struct ieee80211_hw *hw, struct ieee80211_vif *vif, unsigned int link_id, u16 queue, const struct ieee80211_tx_queue_params *params); void rt2x00mac_rfkill_poll(struct ieee80211_hw *hw); void rt2x00mac_flush(struct ieee80211_hw *hw, struct ieee80211_vif *vif, u32 queues, bool drop); int rt2x00mac_set_antenna(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); int rt2x00mac_get_antenna(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); void rt2x00mac_get_ringparam(struct ieee80211_hw *hw, u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); bool rt2x00mac_tx_frames_pending(struct ieee80211_hw *hw); /* * Driver allocation handlers. */ int rt2x00lib_probe_dev(struct rt2x00_dev *rt2x00dev); void rt2x00lib_remove_dev(struct rt2x00_dev *rt2x00dev); int rt2x00lib_suspend(struct rt2x00_dev *rt2x00dev); int rt2x00lib_resume(struct rt2x00_dev *rt2x00dev); #endif /* RT2X00_H */
Codebase Browser
linux