fw-api-mac.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386
  1. /******************************************************************************
  2. *
  3. * This file is provided under a dual BSD/GPLv2 license. When using or
  4. * redistributing this file, you may do so under either license.
  5. *
  6. * GPL LICENSE SUMMARY
  7. *
  8. * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of version 2 of the GNU General Public License as
  12. * published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful, but
  15. * WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22. * USA
  23. *
  24. * The full GNU General Public License is included in this distribution
  25. * in the file called COPYING.
  26. *
  27. * Contact Information:
  28. * Intel Linux Wireless <ilw@linux.intel.com>
  29. * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30. *
  31. * BSD LICENSE
  32. *
  33. * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
  34. * All rights reserved.
  35. *
  36. * Redistribution and use in source and binary forms, with or without
  37. * modification, are permitted provided that the following conditions
  38. * are met:
  39. *
  40. * * Redistributions of source code must retain the above copyright
  41. * notice, this list of conditions and the following disclaimer.
  42. * * Redistributions in binary form must reproduce the above copyright
  43. * notice, this list of conditions and the following disclaimer in
  44. * the documentation and/or other materials provided with the
  45. * distribution.
  46. * * Neither the name Intel Corporation nor the names of its
  47. * contributors may be used to endorse or promote products derived
  48. * from this software without specific prior written permission.
  49. *
  50. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61. *****************************************************************************/
  62. #ifndef __fw_api_mac_h__
  63. #define __fw_api_mac_h__
  64. /*
  65. * The first MAC indices (starting from 0)
  66. * are available to the driver, AUX follows
  67. */
  68. #define MAC_INDEX_AUX 4
  69. #define MAC_INDEX_MIN_DRIVER 0
  70. #define NUM_MAC_INDEX_DRIVER MAC_INDEX_AUX
  71. enum iwl_ac {
  72. AC_BK,
  73. AC_BE,
  74. AC_VI,
  75. AC_VO,
  76. AC_NUM,
  77. };
  78. /**
  79. * enum iwl_mac_protection_flags - MAC context flags
  80. * @MAC_PROT_FLG_TGG_PROTECT: 11g protection when transmitting OFDM frames,
  81. * this will require CCK RTS/CTS2self.
  82. * RTS/CTS will protect full burst time.
  83. * @MAC_PROT_FLG_HT_PROT: enable HT protection
  84. * @MAC_PROT_FLG_FAT_PROT: protect 40 MHz transmissions
  85. * @MAC_PROT_FLG_SELF_CTS_EN: allow CTS2self
  86. */
  87. enum iwl_mac_protection_flags {
  88. MAC_PROT_FLG_TGG_PROTECT = BIT(3),
  89. MAC_PROT_FLG_HT_PROT = BIT(23),
  90. MAC_PROT_FLG_FAT_PROT = BIT(24),
  91. MAC_PROT_FLG_SELF_CTS_EN = BIT(30),
  92. };
  93. #define MAC_FLG_SHORT_SLOT BIT(4)
  94. #define MAC_FLG_SHORT_PREAMBLE BIT(5)
  95. /**
  96. * enum iwl_mac_types - Supported MAC types
  97. * @FW_MAC_TYPE_FIRST: lowest supported MAC type
  98. * @FW_MAC_TYPE_AUX: Auxiliary MAC (internal)
  99. * @FW_MAC_TYPE_LISTENER: monitor MAC type (?)
  100. * @FW_MAC_TYPE_PIBSS: Pseudo-IBSS
  101. * @FW_MAC_TYPE_IBSS: IBSS
  102. * @FW_MAC_TYPE_BSS_STA: BSS (managed) station
  103. * @FW_MAC_TYPE_P2P_DEVICE: P2P Device
  104. * @FW_MAC_TYPE_P2P_STA: P2P client
  105. * @FW_MAC_TYPE_GO: P2P GO
  106. * @FW_MAC_TYPE_TEST: ?
  107. * @FW_MAC_TYPE_MAX: highest support MAC type
  108. */
  109. enum iwl_mac_types {
  110. FW_MAC_TYPE_FIRST = 1,
  111. FW_MAC_TYPE_AUX = FW_MAC_TYPE_FIRST,
  112. FW_MAC_TYPE_LISTENER,
  113. FW_MAC_TYPE_PIBSS,
  114. FW_MAC_TYPE_IBSS,
  115. FW_MAC_TYPE_BSS_STA,
  116. FW_MAC_TYPE_P2P_DEVICE,
  117. FW_MAC_TYPE_P2P_STA,
  118. FW_MAC_TYPE_GO,
  119. FW_MAC_TYPE_TEST,
  120. FW_MAC_TYPE_MAX = FW_MAC_TYPE_TEST
  121. }; /* MAC_CONTEXT_TYPE_API_E_VER_1 */
  122. /**
  123. * enum iwl_tsf_id - TSF hw timer ID
  124. * @TSF_ID_A: use TSF A
  125. * @TSF_ID_B: use TSF B
  126. * @TSF_ID_C: use TSF C
  127. * @TSF_ID_D: use TSF D
  128. * @NUM_TSF_IDS: number of TSF timers available
  129. */
  130. enum iwl_tsf_id {
  131. TSF_ID_A = 0,
  132. TSF_ID_B = 1,
  133. TSF_ID_C = 2,
  134. TSF_ID_D = 3,
  135. NUM_TSF_IDS = 4,
  136. }; /* TSF_ID_API_E_VER_1 */
  137. /**
  138. * struct iwl_mac_data_ap - configuration data for AP MAC context
  139. * @beacon_time: beacon transmit time in system time
  140. * @beacon_tsf: beacon transmit time in TSF
  141. * @bi: beacon interval in TU
  142. * @bi_reciprocal: 2^32 / bi
  143. * @dtim_interval: dtim transmit time in TU
  144. * @dtim_reciprocal: 2^32 / dtim_interval
  145. * @mcast_qid: queue ID for multicast traffic
  146. * @beacon_template: beacon template ID
  147. */
  148. struct iwl_mac_data_ap {
  149. __le32 beacon_time;
  150. __le64 beacon_tsf;
  151. __le32 bi;
  152. __le32 bi_reciprocal;
  153. __le32 dtim_interval;
  154. __le32 dtim_reciprocal;
  155. __le32 mcast_qid;
  156. __le32 beacon_template;
  157. } __packed; /* AP_MAC_DATA_API_S_VER_1 */
  158. /**
  159. * struct iwl_mac_data_ibss - configuration data for IBSS MAC context
  160. * @beacon_time: beacon transmit time in system time
  161. * @beacon_tsf: beacon transmit time in TSF
  162. * @bi: beacon interval in TU
  163. * @bi_reciprocal: 2^32 / bi
  164. * @beacon_template: beacon template ID
  165. */
  166. struct iwl_mac_data_ibss {
  167. __le32 beacon_time;
  168. __le64 beacon_tsf;
  169. __le32 bi;
  170. __le32 bi_reciprocal;
  171. __le32 beacon_template;
  172. } __packed; /* IBSS_MAC_DATA_API_S_VER_1 */
  173. /**
  174. * struct iwl_mac_data_sta - configuration data for station MAC context
  175. * @is_assoc: 1 for associated state, 0 otherwise
  176. * @dtim_time: DTIM arrival time in system time
  177. * @dtim_tsf: DTIM arrival time in TSF
  178. * @bi: beacon interval in TU, applicable only when associated
  179. * @bi_reciprocal: 2^32 / bi , applicable only when associated
  180. * @dtim_interval: DTIM interval in TU, applicable only when associated
  181. * @dtim_reciprocal: 2^32 / dtim_interval , applicable only when associated
  182. * @listen_interval: in beacon intervals, applicable only when associated
  183. * @assoc_id: unique ID assigned by the AP during association
  184. */
  185. struct iwl_mac_data_sta {
  186. __le32 is_assoc;
  187. __le32 dtim_time;
  188. __le64 dtim_tsf;
  189. __le32 bi;
  190. __le32 bi_reciprocal;
  191. __le32 dtim_interval;
  192. __le32 dtim_reciprocal;
  193. __le32 listen_interval;
  194. __le32 assoc_id;
  195. __le32 assoc_beacon_arrive_time;
  196. } __packed; /* STA_MAC_DATA_API_S_VER_1 */
  197. /**
  198. * struct iwl_mac_data_go - configuration data for P2P GO MAC context
  199. * @ap: iwl_mac_data_ap struct with most config data
  200. * @ctwin: client traffic window in TU (period after TBTT when GO is present).
  201. * 0 indicates that there is no CT window.
  202. * @opp_ps_enabled: indicate that opportunistic PS allowed
  203. */
  204. struct iwl_mac_data_go {
  205. struct iwl_mac_data_ap ap;
  206. __le32 ctwin;
  207. __le32 opp_ps_enabled;
  208. } __packed; /* GO_MAC_DATA_API_S_VER_1 */
  209. /**
  210. * struct iwl_mac_data_p2p_sta - configuration data for P2P client MAC context
  211. * @sta: iwl_mac_data_sta struct with most config data
  212. * @ctwin: client traffic window in TU (period after TBTT when GO is present).
  213. * 0 indicates that there is no CT window.
  214. */
  215. struct iwl_mac_data_p2p_sta {
  216. struct iwl_mac_data_sta sta;
  217. __le32 ctwin;
  218. } __packed; /* P2P_STA_MAC_DATA_API_S_VER_1 */
  219. /**
  220. * struct iwl_mac_data_pibss - Pseudo IBSS config data
  221. * @stats_interval: interval in TU between statistics notifications to host.
  222. */
  223. struct iwl_mac_data_pibss {
  224. __le32 stats_interval;
  225. } __packed; /* PIBSS_MAC_DATA_API_S_VER_1 */
  226. /*
  227. * struct iwl_mac_data_p2p_dev - configuration data for the P2P Device MAC
  228. * context.
  229. * @is_disc_extended: if set to true, P2P Device discoverability is enabled on
  230. * other channels as well. This should be to true only in case that the
  231. * device is discoverable and there is an active GO. Note that setting this
  232. * field when not needed, will increase the number of interrupts and have
  233. * effect on the platform power, as this setting opens the Rx filters on
  234. * all macs.
  235. */
  236. struct iwl_mac_data_p2p_dev {
  237. __le32 is_disc_extended;
  238. } __packed; /* _P2P_DEV_MAC_DATA_API_S_VER_1 */
  239. /**
  240. * enum iwl_mac_filter_flags - MAC context filter flags
  241. * @MAC_FILTER_IN_PROMISC: accept all data frames
  242. * @MAC_FILTER_IN_CONTROL_AND_MGMT: pass all mangement and
  243. * control frames to the host
  244. * @MAC_FILTER_ACCEPT_GRP: accept multicast frames
  245. * @MAC_FILTER_DIS_DECRYPT: don't decrypt unicast frames
  246. * @MAC_FILTER_DIS_GRP_DECRYPT: don't decrypt multicast frames
  247. * @MAC_FILTER_IN_BEACON: transfer foreign BSS's beacons to host
  248. * (in station mode when associated)
  249. * @MAC_FILTER_OUT_BCAST: filter out all broadcast frames
  250. * @MAC_FILTER_IN_CRC32: extract FCS and append it to frames
  251. * @MAC_FILTER_IN_PROBE_REQUEST: pass probe requests to host
  252. */
  253. enum iwl_mac_filter_flags {
  254. MAC_FILTER_IN_PROMISC = BIT(0),
  255. MAC_FILTER_IN_CONTROL_AND_MGMT = BIT(1),
  256. MAC_FILTER_ACCEPT_GRP = BIT(2),
  257. MAC_FILTER_DIS_DECRYPT = BIT(3),
  258. MAC_FILTER_DIS_GRP_DECRYPT = BIT(4),
  259. MAC_FILTER_IN_BEACON = BIT(6),
  260. MAC_FILTER_OUT_BCAST = BIT(8),
  261. MAC_FILTER_IN_CRC32 = BIT(11),
  262. MAC_FILTER_IN_PROBE_REQUEST = BIT(12),
  263. };
  264. /**
  265. * enum iwl_mac_qos_flags - QoS flags
  266. * @MAC_QOS_FLG_UPDATE_EDCA: ?
  267. * @MAC_QOS_FLG_TGN: HT is enabled
  268. * @MAC_QOS_FLG_TXOP_TYPE: ?
  269. *
  270. */
  271. enum iwl_mac_qos_flags {
  272. MAC_QOS_FLG_UPDATE_EDCA = BIT(0),
  273. MAC_QOS_FLG_TGN = BIT(1),
  274. MAC_QOS_FLG_TXOP_TYPE = BIT(4),
  275. };
  276. /**
  277. * struct iwl_ac_qos - QOS timing params for MAC_CONTEXT_CMD
  278. * @cw_min: Contention window, start value in numbers of slots.
  279. * Should be a power-of-2, minus 1. Device's default is 0x0f.
  280. * @cw_max: Contention window, max value in numbers of slots.
  281. * Should be a power-of-2, minus 1. Device's default is 0x3f.
  282. * @aifsn: Number of slots in Arbitration Interframe Space (before
  283. * performing random backoff timing prior to Tx). Device default 1.
  284. * @fifos_mask: FIFOs used by this MAC for this AC
  285. * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
  286. *
  287. * One instance of this config struct for each of 4 EDCA access categories
  288. * in struct iwl_qosparam_cmd.
  289. *
  290. * Device will automatically increase contention window by (2*CW) + 1 for each
  291. * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
  292. * value, to cap the CW value.
  293. */
  294. struct iwl_ac_qos {
  295. __le16 cw_min;
  296. __le16 cw_max;
  297. u8 aifsn;
  298. u8 fifos_mask;
  299. __le16 edca_txop;
  300. } __packed; /* AC_QOS_API_S_VER_2 */
  301. /**
  302. * struct iwl_mac_ctx_cmd - command structure to configure MAC contexts
  303. * ( MAC_CONTEXT_CMD = 0x28 )
  304. * @id_and_color: ID and color of the MAC
  305. * @action: action to perform, one of FW_CTXT_ACTION_*
  306. * @mac_type: one of FW_MAC_TYPE_*
  307. * @tsd_id: TSF HW timer, one of TSF_ID_*
  308. * @node_addr: MAC address
  309. * @bssid_addr: BSSID
  310. * @cck_rates: basic rates available for CCK
  311. * @ofdm_rates: basic rates available for OFDM
  312. * @protection_flags: combination of MAC_PROT_FLG_FLAG_*
  313. * @cck_short_preamble: 0x20 for enabling short preamble, 0 otherwise
  314. * @short_slot: 0x10 for enabling short slots, 0 otherwise
  315. * @filter_flags: combination of MAC_FILTER_*
  316. * @qos_flags: from MAC_QOS_FLG_*
  317. * @ac: one iwl_mac_qos configuration for each AC
  318. * @mac_specific: one of struct iwl_mac_data_*, according to mac_type
  319. */
  320. struct iwl_mac_ctx_cmd {
  321. /* COMMON_INDEX_HDR_API_S_VER_1 */
  322. __le32 id_and_color;
  323. __le32 action;
  324. /* MAC_CONTEXT_COMMON_DATA_API_S_VER_1 */
  325. __le32 mac_type;
  326. __le32 tsf_id;
  327. u8 node_addr[6];
  328. __le16 reserved_for_node_addr;
  329. u8 bssid_addr[6];
  330. __le16 reserved_for_bssid_addr;
  331. __le32 cck_rates;
  332. __le32 ofdm_rates;
  333. __le32 protection_flags;
  334. __le32 cck_short_preamble;
  335. __le32 short_slot;
  336. __le32 filter_flags;
  337. /* MAC_QOS_PARAM_API_S_VER_1 */
  338. __le32 qos_flags;
  339. struct iwl_ac_qos ac[AC_NUM+1];
  340. /* MAC_CONTEXT_COMMON_DATA_API_S */
  341. union {
  342. struct iwl_mac_data_ap ap;
  343. struct iwl_mac_data_go go;
  344. struct iwl_mac_data_sta sta;
  345. struct iwl_mac_data_p2p_sta p2p_sta;
  346. struct iwl_mac_data_p2p_dev p2p_dev;
  347. struct iwl_mac_data_pibss pibss;
  348. struct iwl_mac_data_ibss ibss;
  349. };
  350. } __packed; /* MAC_CONTEXT_CMD_API_S_VER_1 */
  351. static inline u32 iwl_mvm_reciprocal(u32 v)
  352. {
  353. if (!v)
  354. return 0;
  355. return 0xFFFFFFFF / v;
  356. }
  357. #define IWL_NONQOS_SEQ_GET 0x1
  358. #define IWL_NONQOS_SEQ_SET 0x2
  359. struct iwl_nonqos_seq_query_cmd {
  360. __le32 get_set_flag;
  361. __le32 mac_id_n_color;
  362. __le16 value;
  363. __le16 reserved;
  364. } __packed; /* NON_QOS_TX_COUNTER_GET_SET_API_S_VER_1 */
  365. #endif /* __fw_api_mac_h__ */