iwlwifi: mvm: rs: overhaul search cycle state machine
[deliverable/linux.git] / drivers / net / wireless / iwlwifi / mvm / fw-api-bt-coex.h
CommitLineData
fb3ceb81
EG
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) 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) 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
63#ifndef __fw_api_bt_coex_h__
64#define __fw_api_bt_coex_h__
65
66#include <linux/types.h>
67#include <linux/bitops.h>
68
69#define BITS(nb) (BIT(nb) - 1)
70
71/**
72 * enum iwl_bt_coex_flags - flags for BT_COEX command
73 * @BT_CH_PRIMARY_EN:
74 * @BT_CH_SECONDARY_EN:
75 * @BT_NOTIF_COEX_OFF:
76 * @BT_COEX_MODE_POS:
77 * @BT_COEX_MODE_MSK:
78 * @BT_COEX_DISABLE:
79 * @BT_COEX_2W:
80 * @BT_COEX_3W:
81 * @BT_COEX_NW:
82 * @BT_USE_DEFAULTS:
83 * @BT_SYNC_2_BT_DISABLE:
84 * @BT_COEX_CORUNNING_TBL_EN:
7352cac0
EG
85 *
86 * The COEX_MODE must be set for each command. Even if it is not changed.
fb3ceb81
EG
87 */
88enum iwl_bt_coex_flags {
89 BT_CH_PRIMARY_EN = BIT(0),
90 BT_CH_SECONDARY_EN = BIT(1),
91 BT_NOTIF_COEX_OFF = BIT(2),
92 BT_COEX_MODE_POS = 3,
93 BT_COEX_MODE_MSK = BITS(3) << BT_COEX_MODE_POS,
94 BT_COEX_DISABLE = 0x0 << BT_COEX_MODE_POS,
95 BT_COEX_2W = 0x1 << BT_COEX_MODE_POS,
96 BT_COEX_3W = 0x2 << BT_COEX_MODE_POS,
97 BT_COEX_NW = 0x3 << BT_COEX_MODE_POS,
98 BT_USE_DEFAULTS = BIT(6),
99 BT_SYNC_2_BT_DISABLE = BIT(7),
dac94da8
EG
100 BT_COEX_CORUNNING_TBL_EN = BIT(8),
101 BT_COEX_MPLUT_TBL_EN = BIT(9),
102 /* Bit 10 is reserved */
103 BT_COEX_WF_PRIO_BOOST_CHECK_EN = BIT(11),
fb3ceb81
EG
104};
105
106/*
107 * indicates what has changed in the BT_COEX command.
7352cac0
EG
108 * BT_VALID_ENABLE must be set for each command. Commands without this bit will
109 * discarded by the firmware
fb3ceb81
EG
110 */
111enum iwl_bt_coex_valid_bit_msk {
112 BT_VALID_ENABLE = BIT(0),
113 BT_VALID_BT_PRIO_BOOST = BIT(1),
114 BT_VALID_MAX_KILL = BIT(2),
115 BT_VALID_3W_TMRS = BIT(3),
116 BT_VALID_KILL_ACK = BIT(4),
117 BT_VALID_KILL_CTS = BIT(5),
118 BT_VALID_REDUCED_TX_POWER = BIT(6),
119 BT_VALID_LUT = BIT(7),
120 BT_VALID_WIFI_RX_SW_PRIO_BOOST = BIT(8),
121 BT_VALID_WIFI_TX_SW_PRIO_BOOST = BIT(9),
122 BT_VALID_MULTI_PRIO_LUT = BIT(10),
123 BT_VALID_TRM_KICK_FILTER = BIT(11),
124 BT_VALID_CORUN_LUT_20 = BIT(12),
125 BT_VALID_CORUN_LUT_40 = BIT(13),
126 BT_VALID_ANT_ISOLATION = BIT(14),
127 BT_VALID_ANT_ISOLATION_THRS = BIT(15),
dac94da8
EG
128 BT_VALID_TXTX_DELTA_FREQ_THRS = BIT(16),
129 BT_VALID_TXRX_MAX_FREQ_0 = BIT(17),
fb3ceb81
EG
130};
131
132/**
133 * enum iwl_bt_reduced_tx_power - allows to reduce txpower for WiFi frames.
134 * @BT_REDUCED_TX_POWER_CTL: reduce Tx power for control frames
135 * @BT_REDUCED_TX_POWER_DATA: reduce Tx power for data frames
136 *
137 * This mechanism allows to have BT and WiFi run concurrently. Since WiFi
138 * reduces its Tx power, it can work along with BT, hence reducing the amount
139 * of WiFi frames being killed by BT.
140 */
141enum iwl_bt_reduced_tx_power {
142 BT_REDUCED_TX_POWER_CTL = BIT(0),
143 BT_REDUCED_TX_POWER_DATA = BIT(1),
144};
145
dac94da8
EG
146enum iwl_bt_coex_lut_type {
147 BT_COEX_TIGHT_LUT = 0,
148 BT_COEX_LOOSE_LUT,
149 BT_COEX_TX_DIS_LUT,
150
151 BT_COEX_MAX_LUT,
152};
153
fb3ceb81 154#define BT_COEX_LUT_SIZE (12)
dac94da8
EG
155#define BT_COEX_CORUN_LUT_SIZE (32)
156#define BT_COEX_MULTI_PRIO_LUT_SIZE (2)
157#define BT_COEX_BOOST_SIZE (4)
158#define BT_REDUCED_TX_POWER_BIT BIT(7)
fb3ceb81
EG
159
160/**
161 * struct iwl_bt_coex_cmd - bt coex configuration command
162 * @flags:&enum iwl_bt_coex_flags
fb3ceb81 163 * @max_kill:
fb3ceb81 164 * @bt_reduced_tx_power: enum %iwl_bt_reduced_tx_power
dac94da8
EG
165 * @bt4_antenna_isolation:
166 * @bt4_antenna_isolation_thr:
167 * @bt4_tx_tx_delta_freq_thr:
168 * @bt4_tx_rx_max_freq0:
169 * @bt_prio_boost:
fb3ceb81
EG
170 * @wifi_tx_prio_boost: SW boost of wifi tx priority
171 * @wifi_rx_prio_boost: SW boost of wifi rx priority
dac94da8
EG
172 * @kill_ack_msk:
173 * @kill_cts_msk:
174 * @decision_lut:
175 * @bt4_multiprio_lut:
176 * @bt4_corun_lut20:
177 * @bt4_corun_lut40:
178 * @valid_bit_msk: enum %iwl_bt_coex_valid_bit_msk
fb3ceb81
EG
179 *
180 * The structure is used for the BT_COEX command.
181 */
182struct iwl_bt_coex_cmd {
dac94da8 183 __le32 flags;
fb3ceb81 184 u8 max_kill;
dac94da8
EG
185 u8 bt_reduced_tx_power;
186 u8 reserved[2];
187
188 u8 bt4_antenna_isolation;
189 u8 bt4_antenna_isolation_thr;
190 u8 bt4_tx_tx_delta_freq_thr;
191 u8 bt4_tx_rx_max_freq0;
192
193 __le32 bt_prio_boost[BT_COEX_BOOST_SIZE];
194 __le32 wifi_tx_prio_boost;
195 __le32 wifi_rx_prio_boost;
fb3ceb81
EG
196 __le32 kill_ack_msk;
197 __le32 kill_cts_msk;
dac94da8
EG
198
199 __le32 decision_lut[BT_COEX_MAX_LUT][BT_COEX_LUT_SIZE];
200 __le32 bt4_multiprio_lut[BT_COEX_MULTI_PRIO_LUT_SIZE];
201 __le32 bt4_corun_lut20[BT_COEX_CORUN_LUT_SIZE];
202 __le32 bt4_corun_lut40[BT_COEX_CORUN_LUT_SIZE];
203
204 __le32 valid_bit_msk;
fb3ceb81
EG
205} __packed; /* BT_COEX_CMD_API_S_VER_3 */
206
dac94da8
EG
207/**
208 * struct iwl_bt_coex_ci_cmd - bt coex channel inhibition command
209 * @bt_primary_ci:
210 * @bt_secondary_ci:
211 * @co_run_bw_primary:
212 * @co_run_bw_secondary:
213 * @primary_ch_phy_id:
214 * @secondary_ch_phy_id:
215 *
216 * Used for BT_COEX_CI command
217 */
218struct iwl_bt_coex_ci_cmd {
219 __le64 bt_primary_ci;
220 __le64 bt_secondary_ci;
221
222 u8 co_run_bw_primary;
223 u8 co_run_bw_secondary;
224 u8 primary_ch_phy_id;
225 u8 secondary_ch_phy_id;
226} __packed; /* BT_CI_MSG_API_S_VER_1 */
227
fb3ceb81
EG
228#define BT_MBOX(n_dw, _msg, _pos, _nbits) \
229 BT_MBOX##n_dw##_##_msg##_POS = (_pos), \
230 BT_MBOX##n_dw##_##_msg = BITS(_nbits) << BT_MBOX##n_dw##_##_msg##_POS
231
232enum iwl_bt_mxbox_dw0 {
233 BT_MBOX(0, LE_SLAVE_LAT, 0, 3),
234 BT_MBOX(0, LE_PROF1, 3, 1),
235 BT_MBOX(0, LE_PROF2, 4, 1),
236 BT_MBOX(0, LE_PROF_OTHER, 5, 1),
237 BT_MBOX(0, CHL_SEQ_N, 8, 4),
238 BT_MBOX(0, INBAND_S, 13, 1),
239 BT_MBOX(0, LE_MIN_RSSI, 16, 4),
240 BT_MBOX(0, LE_SCAN, 20, 1),
241 BT_MBOX(0, LE_ADV, 21, 1),
242 BT_MBOX(0, LE_MAX_TX_POWER, 24, 4),
243 BT_MBOX(0, OPEN_CON_1, 28, 2),
244};
245
246enum iwl_bt_mxbox_dw1 {
247 BT_MBOX(1, BR_MAX_TX_POWER, 0, 4),
248 BT_MBOX(1, IP_SR, 4, 1),
249 BT_MBOX(1, LE_MSTR, 5, 1),
250 BT_MBOX(1, AGGR_TRFC_LD, 8, 6),
251 BT_MBOX(1, MSG_TYPE, 16, 3),
252 BT_MBOX(1, SSN, 19, 2),
253};
254
255enum iwl_bt_mxbox_dw2 {
256 BT_MBOX(2, SNIFF_ACT, 0, 3),
257 BT_MBOX(2, PAG, 3, 1),
258 BT_MBOX(2, INQUIRY, 4, 1),
259 BT_MBOX(2, CONN, 5, 1),
260 BT_MBOX(2, SNIFF_INTERVAL, 8, 5),
261 BT_MBOX(2, DISC, 13, 1),
262 BT_MBOX(2, SCO_TX_ACT, 16, 2),
263 BT_MBOX(2, SCO_RX_ACT, 18, 2),
264 BT_MBOX(2, ESCO_RE_TX, 20, 2),
265 BT_MBOX(2, SCO_DURATION, 24, 6),
266};
267
268enum iwl_bt_mxbox_dw3 {
269 BT_MBOX(3, SCO_STATE, 0, 1),
270 BT_MBOX(3, SNIFF_STATE, 1, 1),
271 BT_MBOX(3, A2DP_STATE, 2, 1),
272 BT_MBOX(3, ACL_STATE, 3, 1),
273 BT_MBOX(3, MSTR_STATE, 4, 1),
274 BT_MBOX(3, OBX_STATE, 5, 1),
275 BT_MBOX(3, OPEN_CON_2, 8, 2),
276 BT_MBOX(3, TRAFFIC_LOAD, 10, 2),
277 BT_MBOX(3, CHL_SEQN_LSB, 12, 1),
278 BT_MBOX(3, INBAND_P, 13, 1),
279 BT_MBOX(3, MSG_TYPE_2, 16, 3),
280 BT_MBOX(3, SSN_2, 19, 2),
281 BT_MBOX(3, UPDATE_REQUEST, 21, 1),
282};
283
284#define BT_MBOX_MSG(_notif, _num, _field) \
285 ((le32_to_cpu((_notif)->mbox_msg[(_num)]) & BT_MBOX##_num##_##_field)\
286 >> BT_MBOX##_num##_##_field##_POS)
287
dac94da8
EG
288enum iwl_bt_activity_grading {
289 BT_OFF = 0,
290 BT_ON_NO_CONNECTION = 1,
291 BT_LOW_TRAFFIC = 2,
292 BT_HIGH_TRAFFIC = 3,
293};
294
fb3ceb81
EG
295/**
296 * struct iwl_bt_coex_profile_notif - notification about BT coex
297 * @mbox_msg: message from BT to WiFi
dac94da8
EG
298 * @msg_idx: the index of the message
299 * @bt_status: 0 - off, 1 - on
300 * @bt_open_conn: number of BT connections open
301 * @bt_traffic_load: load of BT traffic
302 * @bt_agg_traffic_load: aggregated load of BT traffic
303 * @bt_ci_compliance: 0 - no CI compliance, 1 - CI compliant
304 * @primary_ch_lut: LUT used for primary channel
305 * @secondary_ch_lut: LUT used for secondary channel
306 * @bt_activity_grading: the activity of BT enum %iwl_bt_activity_grading
fb3ceb81
EG
307 */
308struct iwl_bt_coex_profile_notif {
309 __le32 mbox_msg[4];
dac94da8 310 __le32 msg_idx;
fb3ceb81
EG
311 u8 bt_status;
312 u8 bt_open_conn;
313 u8 bt_traffic_load;
314 u8 bt_agg_traffic_load;
315 u8 bt_ci_compliance;
316 u8 reserved[3];
dac94da8
EG
317
318 __le32 primary_ch_lut;
319 __le32 secondary_ch_lut;
320 __le32 bt_activity_grading;
fb3ceb81
EG
321} __packed; /* BT_COEX_PROFILE_NTFY_API_S_VER_2 */
322
323enum iwl_bt_coex_prio_table_event {
324 BT_COEX_PRIO_TBL_EVT_INIT_CALIB1 = 0,
325 BT_COEX_PRIO_TBL_EVT_INIT_CALIB2 = 1,
326 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1 = 2,
327 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2 = 3,
328 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1 = 4,
329 BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2 = 5,
330 BT_COEX_PRIO_TBL_EVT_DTIM = 6,
331 BT_COEX_PRIO_TBL_EVT_SCAN52 = 7,
332 BT_COEX_PRIO_TBL_EVT_SCAN24 = 8,
333 BT_COEX_PRIO_TBL_EVT_IDLE = 9,
334 BT_COEX_PRIO_TBL_EVT_MAX = 16,
335}; /* BT_COEX_PRIO_TABLE_EVENTS_API_E_VER_1 */
336
337enum iwl_bt_coex_prio_table_prio {
338 BT_COEX_PRIO_TBL_DISABLED = 0,
339 BT_COEX_PRIO_TBL_PRIO_LOW = 1,
340 BT_COEX_PRIO_TBL_PRIO_HIGH = 2,
341 BT_COEX_PRIO_TBL_PRIO_BYPASS = 3,
342 BT_COEX_PRIO_TBL_PRIO_COEX_OFF = 4,
343 BT_COEX_PRIO_TBL_PRIO_COEX_ON = 5,
344 BT_COEX_PRIO_TBL_PRIO_COEX_IDLE = 6,
345 BT_COEX_PRIO_TBL_MAX = 8,
346}; /* BT_COEX_PRIO_TABLE_PRIORITIES_API_E_VER_1 */
347
348#define BT_COEX_PRIO_TBL_SHRD_ANT_POS (0)
349#define BT_COEX_PRIO_TBL_PRIO_POS (1)
350#define BT_COEX_PRIO_TBL_RESERVED_POS (4)
351
352/**
353 * struct iwl_bt_coex_prio_tbl_cmd - priority table for BT coex
354 * @prio_tbl:
355 */
356struct iwl_bt_coex_prio_tbl_cmd {
357 u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
358} __packed;
359
fb3ceb81 360#endif /* __fw_api_bt_coex_h__ */
This page took 0.089025 seconds and 5 git commands to generate.