rt2x00lib.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452
  1. /*
  2. Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
  3. Copyright (C) 2004 - 2009 Gertjan van Wingerde <gwingerde@gmail.com>
  4. <http://rt2x00.serialmonkey.com>
  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. This program is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. GNU General Public License for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with this program; if not, write to the
  15. Free Software Foundation, Inc.,
  16. 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17. */
  18. /*
  19. Module: rt2x00lib
  20. Abstract: Data structures and definitions for the rt2x00lib module.
  21. */
  22. #ifndef RT2X00LIB_H
  23. #define RT2X00LIB_H
  24. /*
  25. * Interval defines
  26. */
  27. #define LINK_TUNE_INTERVAL round_jiffies_relative(HZ)
  28. /*
  29. * rt2x00_rate: Per rate device information
  30. */
  31. struct rt2x00_rate {
  32. unsigned short flags;
  33. #define DEV_RATE_CCK 0x0001
  34. #define DEV_RATE_OFDM 0x0002
  35. #define DEV_RATE_SHORT_PREAMBLE 0x0004
  36. unsigned short bitrate; /* In 100kbit/s */
  37. unsigned short ratemask;
  38. unsigned short plcp;
  39. unsigned short mcs;
  40. };
  41. extern const struct rt2x00_rate rt2x00_supported_rates[12];
  42. static inline const struct rt2x00_rate *rt2x00_get_rate(const u16 hw_value)
  43. {
  44. return &rt2x00_supported_rates[hw_value & 0xff];
  45. }
  46. #define RATE_MCS(__mode, __mcs) \
  47. ( (((__mode) & 0x00ff) << 8) | ((__mcs) & 0x00ff) )
  48. static inline int rt2x00_get_rate_mcs(const u16 mcs_value)
  49. {
  50. return (mcs_value & 0x00ff);
  51. }
  52. /*
  53. * Radio control handlers.
  54. */
  55. int rt2x00lib_enable_radio(struct rt2x00_dev *rt2x00dev);
  56. void rt2x00lib_disable_radio(struct rt2x00_dev *rt2x00dev);
  57. void rt2x00lib_toggle_rx(struct rt2x00_dev *rt2x00dev, enum dev_state state);
  58. /*
  59. * Initialization handlers.
  60. */
  61. int rt2x00lib_start(struct rt2x00_dev *rt2x00dev);
  62. void rt2x00lib_stop(struct rt2x00_dev *rt2x00dev);
  63. /*
  64. * Configuration handlers.
  65. */
  66. void rt2x00lib_config_intf(struct rt2x00_dev *rt2x00dev,
  67. struct rt2x00_intf *intf,
  68. enum nl80211_iftype type,
  69. const u8 *mac, const u8 *bssid);
  70. void rt2x00lib_config_erp(struct rt2x00_dev *rt2x00dev,
  71. struct rt2x00_intf *intf,
  72. struct ieee80211_bss_conf *conf);
  73. void rt2x00lib_config_antenna(struct rt2x00_dev *rt2x00dev,
  74. struct antenna_setup ant);
  75. void rt2x00lib_config(struct rt2x00_dev *rt2x00dev,
  76. struct ieee80211_conf *conf,
  77. const unsigned int changed_flags);
  78. /**
  79. * DOC: Queue handlers
  80. */
  81. /**
  82. * rt2x00queue_alloc_rxskb - allocate a skb for RX purposes.
  83. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  84. * @queue: The queue for which the skb will be applicable.
  85. */
  86. struct sk_buff *rt2x00queue_alloc_rxskb(struct rt2x00_dev *rt2x00dev,
  87. struct queue_entry *entry);
  88. /**
  89. * rt2x00queue_free_skb - free a skb
  90. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  91. * @skb: The skb to free.
  92. */
  93. void rt2x00queue_free_skb(struct rt2x00_dev *rt2x00dev, struct sk_buff *skb);
  94. /**
  95. * rt2x00queue_align_frame - Align 802.11 frame to 4-byte boundary
  96. * @skb: The skb to align
  97. *
  98. * Align the start of the 802.11 frame to a 4-byte boundary, this could
  99. * mean the payload is not aligned properly though.
  100. */
  101. void rt2x00queue_align_frame(struct sk_buff *skb);
  102. /**
  103. * rt2x00queue_align_payload - Align 802.11 payload to 4-byte boundary
  104. * @skb: The skb to align
  105. * @header_length: Length of 802.11 header
  106. *
  107. * Align the 802.11 payload to a 4-byte boundary, this could
  108. * mean the header is not aligned properly though.
  109. */
  110. void rt2x00queue_align_payload(struct sk_buff *skb, unsigned int header_length);
  111. /**
  112. * rt2x00queue_insert_l2pad - Align 802.11 header & payload to 4-byte boundary
  113. * @skb: The skb to align
  114. * @header_length: Length of 802.11 header
  115. *
  116. * Apply L2 padding to align both header and payload to 4-byte boundary
  117. */
  118. void rt2x00queue_insert_l2pad(struct sk_buff *skb, unsigned int header_length);
  119. /**
  120. * rt2x00queue_insert_l2pad - Remove L2 padding from 802.11 frame
  121. * @skb: The skb to align
  122. * @header_length: Length of 802.11 header
  123. *
  124. * Remove L2 padding used to align both header and payload to 4-byte boundary,
  125. * by removing the L2 padding the header will no longer be 4-byte aligned.
  126. */
  127. void rt2x00queue_remove_l2pad(struct sk_buff *skb, unsigned int header_length);
  128. /**
  129. * rt2x00queue_write_tx_frame - Write TX frame to hardware
  130. * @queue: Queue over which the frame should be send
  131. * @skb: The skb to send
  132. * @local: frame is not from mac80211
  133. */
  134. int rt2x00queue_write_tx_frame(struct data_queue *queue, struct sk_buff *skb,
  135. bool local);
  136. /**
  137. * rt2x00queue_update_beacon - Send new beacon from mac80211 to hardware
  138. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  139. * @vif: Interface for which the beacon should be updated.
  140. * @enable_beacon: Enable beaconing
  141. */
  142. int rt2x00queue_update_beacon(struct rt2x00_dev *rt2x00dev,
  143. struct ieee80211_vif *vif,
  144. const bool enable_beacon);
  145. /**
  146. * rt2x00queue_index_inc - Index incrementation function
  147. * @queue: Queue (&struct data_queue) to perform the action on.
  148. * @index: Index type (&enum queue_index) to perform the action on.
  149. *
  150. * This function will increase the requested index on the queue,
  151. * it will grab the appropriate locks and handle queue overflow events by
  152. * resetting the index to the start of the queue.
  153. */
  154. void rt2x00queue_index_inc(struct data_queue *queue, enum queue_index index);
  155. /**
  156. * rt2x00queue_stop_queues - Halt all data queues
  157. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  158. *
  159. * This function will loop through all available queues to stop
  160. * any pending outgoing frames.
  161. */
  162. void rt2x00queue_stop_queues(struct rt2x00_dev *rt2x00dev);
  163. /**
  164. * rt2x00queue_init_queues - Initialize all data queues
  165. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  166. *
  167. * This function will loop through all available queues to clear all
  168. * index numbers and set the queue entry to the correct initialization
  169. * state.
  170. */
  171. void rt2x00queue_init_queues(struct rt2x00_dev *rt2x00dev);
  172. int rt2x00queue_initialize(struct rt2x00_dev *rt2x00dev);
  173. void rt2x00queue_uninitialize(struct rt2x00_dev *rt2x00dev);
  174. int rt2x00queue_allocate(struct rt2x00_dev *rt2x00dev);
  175. void rt2x00queue_free(struct rt2x00_dev *rt2x00dev);
  176. /**
  177. * rt2x00link_update_stats - Update link statistics from RX frame
  178. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  179. * @skb: Received frame
  180. * @rxdesc: Received frame descriptor
  181. *
  182. * Update link statistics based on the information from the
  183. * received frame descriptor.
  184. */
  185. void rt2x00link_update_stats(struct rt2x00_dev *rt2x00dev,
  186. struct sk_buff *skb,
  187. struct rxdone_entry_desc *rxdesc);
  188. /**
  189. * rt2x00link_start_tuner - Start periodic link tuner work
  190. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  191. *
  192. * This start the link tuner periodic work, this work will
  193. * be executed periodically until &rt2x00link_stop_tuner has
  194. * been called.
  195. */
  196. void rt2x00link_start_tuner(struct rt2x00_dev *rt2x00dev);
  197. /**
  198. * rt2x00link_stop_tuner - Stop periodic link tuner work
  199. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  200. *
  201. * After this function completed the link tuner will not
  202. * be running until &rt2x00link_start_tuner is called.
  203. */
  204. void rt2x00link_stop_tuner(struct rt2x00_dev *rt2x00dev);
  205. /**
  206. * rt2x00link_reset_tuner - Reset periodic link tuner work
  207. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  208. * @antenna: Should the antenna tuning also be reset
  209. *
  210. * The VGC limit configured in the hardware will be reset to 0
  211. * which forces the driver to rediscover the correct value for
  212. * the current association. This is needed when configuration
  213. * options have changed which could drastically change the
  214. * SNR level or link quality (i.e. changing the antenna setting).
  215. *
  216. * Resetting the link tuner will also cause the periodic work counter
  217. * to be reset. Any driver which has a fixed limit on the number
  218. * of rounds the link tuner is supposed to work will accept the
  219. * tuner actions again if this limit was previously reached.
  220. *
  221. * If @antenna is set to true a the software antenna diversity
  222. * tuning will also be reset.
  223. */
  224. void rt2x00link_reset_tuner(struct rt2x00_dev *rt2x00dev, bool antenna);
  225. /**
  226. * rt2x00link_register - Initialize link tuning functionality
  227. * @rt2x00dev: Pointer to &struct rt2x00_dev.
  228. *
  229. * Initialize work structure and all link tuning related
  230. * parameters. This will not start the link tuning process itself.
  231. */
  232. void rt2x00link_register(struct rt2x00_dev *rt2x00dev);
  233. /*
  234. * Firmware handlers.
  235. */
  236. #ifdef CONFIG_RT2X00_LIB_FIRMWARE
  237. int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev);
  238. void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev);
  239. #else
  240. static inline int rt2x00lib_load_firmware(struct rt2x00_dev *rt2x00dev)
  241. {
  242. return 0;
  243. }
  244. static inline void rt2x00lib_free_firmware(struct rt2x00_dev *rt2x00dev)
  245. {
  246. }
  247. #endif /* CONFIG_RT2X00_LIB_FIRMWARE */
  248. /*
  249. * Debugfs handlers.
  250. */
  251. #ifdef CONFIG_RT2X00_LIB_DEBUGFS
  252. void rt2x00debug_register(struct rt2x00_dev *rt2x00dev);
  253. void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev);
  254. void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
  255. struct rxdone_entry_desc *rxdesc);
  256. #else
  257. static inline void rt2x00debug_register(struct rt2x00_dev *rt2x00dev)
  258. {
  259. }
  260. static inline void rt2x00debug_deregister(struct rt2x00_dev *rt2x00dev)
  261. {
  262. }
  263. static inline void rt2x00debug_update_crypto(struct rt2x00_dev *rt2x00dev,
  264. struct rxdone_entry_desc *rxdesc)
  265. {
  266. }
  267. #endif /* CONFIG_RT2X00_LIB_DEBUGFS */
  268. /*
  269. * Crypto handlers.
  270. */
  271. #ifdef CONFIG_RT2X00_LIB_CRYPTO
  272. enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key);
  273. void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
  274. struct txentry_desc *txdesc);
  275. unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
  276. struct sk_buff *skb);
  277. void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
  278. struct txentry_desc *txdesc);
  279. void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
  280. struct txentry_desc *txdesc);
  281. void rt2x00crypto_tx_insert_iv(struct sk_buff *skb, unsigned int header_length);
  282. void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
  283. unsigned int header_length,
  284. struct rxdone_entry_desc *rxdesc);
  285. #else
  286. static inline enum cipher rt2x00crypto_key_to_cipher(struct ieee80211_key_conf *key)
  287. {
  288. return CIPHER_NONE;
  289. }
  290. static inline void rt2x00crypto_create_tx_descriptor(struct queue_entry *entry,
  291. struct txentry_desc *txdesc)
  292. {
  293. }
  294. static inline unsigned int rt2x00crypto_tx_overhead(struct rt2x00_dev *rt2x00dev,
  295. struct sk_buff *skb)
  296. {
  297. return 0;
  298. }
  299. static inline void rt2x00crypto_tx_copy_iv(struct sk_buff *skb,
  300. struct txentry_desc *txdesc)
  301. {
  302. }
  303. static inline void rt2x00crypto_tx_remove_iv(struct sk_buff *skb,
  304. struct txentry_desc *txdesc)
  305. {
  306. }
  307. static inline void rt2x00crypto_tx_insert_iv(struct sk_buff *skb,
  308. unsigned int header_length)
  309. {
  310. }
  311. static inline void rt2x00crypto_rx_insert_iv(struct sk_buff *skb,
  312. unsigned int header_length,
  313. struct rxdone_entry_desc *rxdesc)
  314. {
  315. }
  316. #endif /* CONFIG_RT2X00_LIB_CRYPTO */
  317. /*
  318. * HT handlers.
  319. */
  320. #ifdef CONFIG_RT2X00_LIB_HT
  321. void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
  322. struct txentry_desc *txdesc,
  323. const struct rt2x00_rate *hwrate);
  324. u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
  325. struct ieee80211_conf *conf);
  326. #else
  327. static inline void rt2x00ht_create_tx_descriptor(struct queue_entry *entry,
  328. struct txentry_desc *txdesc,
  329. const struct rt2x00_rate *hwrate)
  330. {
  331. }
  332. static inline u16 rt2x00ht_center_channel(struct rt2x00_dev *rt2x00dev,
  333. struct ieee80211_conf *conf)
  334. {
  335. return conf->channel->hw_value;
  336. }
  337. #endif /* CONFIG_RT2X00_LIB_HT */
  338. /*
  339. * RFkill handlers.
  340. */
  341. static inline void rt2x00rfkill_register(struct rt2x00_dev *rt2x00dev)
  342. {
  343. if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
  344. wiphy_rfkill_start_polling(rt2x00dev->hw->wiphy);
  345. }
  346. static inline void rt2x00rfkill_unregister(struct rt2x00_dev *rt2x00dev)
  347. {
  348. if (test_bit(CONFIG_SUPPORT_HW_BUTTON, &rt2x00dev->flags))
  349. wiphy_rfkill_stop_polling(rt2x00dev->hw->wiphy);
  350. }
  351. /*
  352. * LED handlers
  353. */
  354. #ifdef CONFIG_RT2X00_LIB_LEDS
  355. void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev, int rssi);
  356. void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev, bool enabled);
  357. void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev, bool enabled);
  358. void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev, bool enabled);
  359. void rt2x00leds_register(struct rt2x00_dev *rt2x00dev);
  360. void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev);
  361. void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev);
  362. void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev);
  363. #else
  364. static inline void rt2x00leds_led_quality(struct rt2x00_dev *rt2x00dev,
  365. int rssi)
  366. {
  367. }
  368. static inline void rt2x00led_led_activity(struct rt2x00_dev *rt2x00dev,
  369. bool enabled)
  370. {
  371. }
  372. static inline void rt2x00leds_led_assoc(struct rt2x00_dev *rt2x00dev,
  373. bool enabled)
  374. {
  375. }
  376. static inline void rt2x00leds_led_radio(struct rt2x00_dev *rt2x00dev,
  377. bool enabled)
  378. {
  379. }
  380. static inline void rt2x00leds_register(struct rt2x00_dev *rt2x00dev)
  381. {
  382. }
  383. static inline void rt2x00leds_unregister(struct rt2x00_dev *rt2x00dev)
  384. {
  385. }
  386. static inline void rt2x00leds_suspend(struct rt2x00_dev *rt2x00dev)
  387. {
  388. }
  389. static inline void rt2x00leds_resume(struct rt2x00_dev *rt2x00dev)
  390. {
  391. }
  392. #endif /* CONFIG_RT2X00_LIB_LEDS */
  393. #endif /* RT2X00LIB_H */