rt2x00lib.h revision 206eade5a68f7a06adbe7c65e47fd88843ad0546
1/* 2 Copyright (C) 2004 - 2009 rt2x00 SourceForge Project 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 29#include "rt2x00dump.h" 30 31/* 32 * Interval defines 33 * Both the link tuner as the rfkill will be called once per second. 34 */ 35#define LINK_TUNE_INTERVAL round_jiffies_relative(HZ) 36#define RFKILL_POLL_INTERVAL 1000 37 38/* 39 * rt2x00_rate: Per rate device information 40 */ 41struct rt2x00_rate { 42 unsigned short flags; 43#define DEV_RATE_CCK 0x0001 44#define DEV_RATE_OFDM 0x0002 45#define DEV_RATE_SHORT_PREAMBLE 0x0004 46 47 unsigned short bitrate; /* In 100kbit/s */ 48 unsigned short ratemask; 49 50 unsigned short plcp; 51 unsigned short mcs; 52}; 53 54extern const struct rt2x00_rate rt2x00_supported_rates[12]; 55 56static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value) 57{ 58 return &rt2x00_supported_rates[hw_value & 0xff]; 59} 60 61#define RATE_MCS(__mode, __mcs) \ 62 ( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) ) 63 64static inline int rt2x00_get_rate_mcs(const u16 mcs_value) 65{ 66 return (mcs_value & 0x00ff); 67} 68 69/* 70 * Radio control handlers. 71 */ 72int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev); 73void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev); 74void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state); 75 76/* 77 * Initialization handlers. 78 */ 79int rt2x00lib_start(struct rt2x00_dev *rt2x00dev); 80void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev); 81 82/* 83 * Configuration handlers. 84 */ 85void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev, 86 struct rt2x00_intf *intf, 87 enum nl80211_iftype type, 88 const u8 *mac, const u8 *bssid); 89void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev, 90 struct rt2x00_intf *intf, 91 struct ieee80211_bss_conf *conf); 92void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev, 93 struct antenna_setup *ant); 94void rt2x00lib_config(struct rt2x00_dev *rt2x00dev, 95 struct ieee80211_conf *conf, 96 const unsigned int changed_flags); 97 98/** 99 * DOC: Queue handlers 100 */ 101 102/** 103 * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes. 104 * @rt2x00dev: Pointer to &struct rt2x00_dev. 105 * @queue: The queue for which the skb will be applicable. 106 */ 107struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev, 108 struct queue_entry *entry); 109 110/** 111 * rt2x00queue_unmap_skb - Unmap a skb from DMA. 112 * @rt2x00dev: Pointer to &struct rt2x00_dev. 113 * @skb: The skb to unmap. 114 */ 115void rt2x00queue_unmap_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); 116 117/** 118 * rt2x00queue_free_skb - free a skb 119 * @rt2x00dev: Pointer to &struct rt2x00_dev. 120 * @skb: The skb to free. 121 */ 122void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb); 123 124/** 125 * rt2x00queue_payload_align - Align 802.11 payload to 4-byte boundary 126 * @skb: The skb to align 127 * @l2pad: Should L2 padding be used 128 * @header_length: Length of 802.11 header 129 * 130 * This function prepares the @skb to be send to the device or mac80211. 131 * If @l2pad is set to true padding will occur between the 802.11 header 132 * and payload. Otherwise the padding will be done in front of the 802.11 133 * header. 134 * When @l2pad is set the function will check for the &SKBDESC_L2_PADDED 135 * flag in &skb_frame_desc. If that flag is set, the padding is removed 136 * and the flag cleared. Otherwise the padding is added and the flag is set. 137 */ 138void rt2x00queue_payload_align(struct sk_buff *skb, 139 bool l2pad, unsigned int header_length); 140 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 145 */ 146int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb); 147 148/** 149 * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware 150 * @rt2x00dev: Pointer to &struct rt2x00_dev. 151 * @vif: Interface for which the beacon should be updated. 152 * @enable_beacon: Enable beaconing 153 */ 154int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev, 155 struct ieee80211_vif *vif, 156 const bool enable_beacon); 157 158/** 159 * rt2x00queue_index_inc - Index incrementation function 160 * @queue: Queue (&struct data_queue) to perform the action on. 161 * @index: Index type (&enum queue_index) to perform the action on. 162 * 163 * This function will increase the requested index on the queue, 164 * it will grab the appropriate locks and handle queue overflow events by 165 * resetting the index to the start of the queue. 166 */ 167void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index); 168 169/** 170 * rt2x00queue_stop_queues - Halt all data queues 171 * @rt2x00dev: Pointer to &struct rt2x00_dev. 172 * 173 * This function will loop through all available queues to stop 174 * any pending outgoing frames. 175 */ 176void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev); 177 178/** 179 * rt2x00queue_init_queues - Initialize all data queues 180 * @rt2x00dev: Pointer to &struct rt2x00_dev. 181 * 182 * This function will loop through all available queues to clear all 183 * index numbers and set the queue entry to the correct initialization 184 * state. 185 */ 186void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev); 187 188int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev); 189void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev); 190int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev); 191void rt2x00queue_free(struct rt2x00_dev *rt2x00dev); 192 193/** 194 * rt2x00link_update_stats - Update link statistics from RX frame 195 * @rt2x00dev: Pointer to &struct rt2x00_dev. 196 * @skb: Received frame 197 * @rxdesc: Received frame descriptor 198 * 199 * Update link statistics based on the information from the 200 * received frame descriptor. 201 */ 202void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev, 203 struct sk_buff *skb, 204 struct rxdone_entry_desc *rxdesc); 205 206/** 207 * rt2x00link_calculate_signal - Calculate signal quality 208 * @rt2x00dev: Pointer to &struct rt2x00_dev. 209 * @rssi: RX Frame RSSI 210 * 211 * Calculate the signal quality of a frame based on the rssi 212 * measured during the receiving of the frame and the global 213 * link quality statistics measured since the start of the 214 * link tuning. The result is a value between 0 and 100 which 215 * is an indication of the signal quality. 216 */ 217int rt2x00link_calculate_signal(struct rt2x00_dev *rt2x00dev, int rssi); 218 219/** 220 * rt2x00link_start_tuner - Start periodic link tuner work 221 * @rt2x00dev: Pointer to &struct rt2x00_dev. 222 * 223 * This start the link tuner periodic work, this work will 224 * be executed periodically until &rt2x00link_stop_tuner has 225 * been called. 226 */ 227void 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 */ 236void 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 */ 257void 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 264 * paramters. This will not start the link tuning process itself. 265 */ 266void rt2x00link_register(struct rt2x00_dev *rt2x00dev); 267 268/* 269 * Firmware handlers. 270 */ 271#ifdef CONFIG_RT2X00_LIB_FIRMWARE 272int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev); 273void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev); 274#else 275static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev) 276{ 277 return 0; 278} 279static 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 288void rt2x00debug_register(struct rt2x00_dev *rt2x00dev); 289void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev); 290void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 291 enum rt2x00_dump_type type, struct sk_buff *skb); 292void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 293 struct rxdone_entry_desc *rxdesc); 294#else 295static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev) 296{ 297} 298 299static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev) 300{ 301} 302 303static inline void rt2x00debug_dump_frame(struct rt2x00_dev *rt2x00dev, 304 enum rt2x00_dump_type type, 305 struct sk_buff *skb) 306{ 307} 308 309static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev, 310 struct rxdone_entry_desc *rxdesc) 311{ 312} 313#endif /* CONFIG_RT2X00_LIB_DEBUGFS */ 314 315/* 316 * Crypto handlers. 317 */ 318#ifdef CONFIG_RT2X00_LIB_CRYPTO 319enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key); 320void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 321 struct txentry_desc *txdesc); 322unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, 323 struct sk_buff *skb); 324void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, 325 struct txentry_desc *txdesc); 326void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, 327 struct txentry_desc *txdesc); 328void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length); 329void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad, 330 unsigned int header_length, 331 struct rxdone_entry_desc *rxdesc); 332#else 333static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key) 334{ 335 return CIPHER_NONE; 336} 337 338static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry, 339 struct txentry_desc *txdesc) 340{ 341} 342 343static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev, 344 struct sk_buff *skb) 345{ 346 return 0; 347} 348 349static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb, 350 struct txentry_desc *txdesc) 351{ 352} 353 354static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb, 355 struct txentry_desc *txdesc) 356{ 357} 358 359static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, 360 unsigned int header_length) 361{ 362} 363 364static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb, bool l2pad, 365 unsigned int header_length, 366 struct rxdone_entry_desc *rxdesc) 367{ 368} 369#endif /* CONFIG_RT2X00_LIB_CRYPTO */ 370 371/* 372 * HT handlers. 373 */ 374#ifdef CONFIG_RT2X00_LIB_HT 375void rt2x00ht_create_tx_descriptor(struct queue_entry *entry, 376 struct txentry_desc *txdesc, 377 const struct rt2x00_rate *hwrate); 378#else 379static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry, 380 struct txentry_desc *txdesc, 381 const struct rt2x00_rate *hwrate) 382{ 383} 384#endif /* CONFIG_RT2X00_LIB_HT */ 385 386/* 387 * RFkill handlers. 388 */ 389#ifdef CONFIG_RT2X00_LIB_RFKILL 390void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev); 391void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev); 392void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev); 393void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev); 394#else 395static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev) 396{ 397} 398 399static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev) 400{ 401} 402 403static inline void rt2x00rfkill_allocate(struct rt2x00_dev *rt2x00dev) 404{ 405} 406 407static inline void rt2x00rfkill_free(struct rt2x00_dev *rt2x00dev) 408{ 409} 410#endif /* CONFIG_RT2X00_LIB_RFKILL */ 411 412/* 413 * LED handlers 414 */ 415#ifdef CONFIG_RT2X00_LIB_LEDS 416void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi); 417void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled); 418void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled); 419void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled); 420void rt2x00leds_register(struct rt2x00_dev *rt2x00dev); 421void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev); 422void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev); 423void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev); 424#else 425static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, 426 int rssi) 427{ 428} 429 430static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, 431 bool enabled) 432{ 433} 434 435static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, 436 bool enabled) 437{ 438} 439 440static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, 441 bool enabled) 442{ 443} 444 445static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev) 446{ 447} 448 449static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev) 450{ 451} 452 453static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev) 454{ 455} 456 457static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev) 458{ 459} 460#endif /* CONFIG_RT2X00_LIB_LEDS */ 461 462#endif /* RT2X00LIB_H */ 463