xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/api/coex.h (revision 71dfa617ea9f18e4585fe78364217cd32b1fc382)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2023 Intel Corporation
4  * Copyright (C) 2013-2014, 2018-2019 Intel Corporation
5  * Copyright (C) 2013-2014 Intel Mobile Communications GmbH
6  * Copyright (C) 2017 Intel Deutschland GmbH
7  */
8 #ifndef __iwl_fw_api_coex_h__
9 #define __iwl_fw_api_coex_h__
10 
11 #include <linux/types.h>
12 #include <linux/bitops.h>
13 
14 #define BITS(nb) (BIT(nb) - 1)
15 
16 enum iwl_bt_coex_lut_type {
17 	BT_COEX_TIGHT_LUT = 0,
18 	BT_COEX_LOOSE_LUT,
19 	BT_COEX_TX_DIS_LUT,
20 
21 	BT_COEX_MAX_LUT,
22 	BT_COEX_INVALID_LUT = 0xff,
23 }; /* BT_COEX_DECISION_LUT_INDEX_API_E_VER_1 */
24 
25 #define BT_REDUCED_TX_POWER_BIT BIT(7)
26 
27 enum iwl_bt_coex_mode {
28 	BT_COEX_DISABLE			= 0x0,
29 	BT_COEX_NW			= 0x1,
30 	BT_COEX_BT			= 0x2,
31 	BT_COEX_WIFI			= 0x3,
32 }; /* BT_COEX_MODES_E */
33 
34 enum iwl_bt_coex_enabled_modules {
35 	BT_COEX_MPLUT_ENABLED		= BIT(0),
36 	BT_COEX_MPLUT_BOOST_ENABLED	= BIT(1),
37 	BT_COEX_SYNC2SCO_ENABLED	= BIT(2),
38 	BT_COEX_CORUN_ENABLED		= BIT(3),
39 	BT_COEX_HIGH_BAND_RET		= BIT(4),
40 }; /* BT_COEX_MODULES_ENABLE_E_VER_1 */
41 
42 /**
43  * struct iwl_bt_coex_cmd - bt coex configuration command
44  * @mode: &enum iwl_bt_coex_mode
45  * @enabled_modules: &enum iwl_bt_coex_enabled_modules
46  *
47  * The structure is used for the BT_COEX command.
48  */
49 struct iwl_bt_coex_cmd {
50 	__le32 mode;
51 	__le32 enabled_modules;
52 } __packed; /* BT_COEX_CMD_API_S_VER_6 */
53 
54 /**
55  * struct iwl_bt_coex_reduced_txp_update_cmd
56  * @reduced_txp: bit BT_REDUCED_TX_POWER_BIT to enable / disable, rest of the
57  *	bits are the sta_id (value)
58  */
59 struct iwl_bt_coex_reduced_txp_update_cmd {
60 	__le32 reduced_txp;
61 } __packed; /* BT_COEX_UPDATE_REDUCED_TX_POWER_API_S_VER_1 */
62 
63 /**
64  * struct iwl_bt_coex_ci_cmd - bt coex channel inhibition command
65  * @bt_primary_ci: primary channel inhibition bitmap
66  * @primary_ch_phy_id: primary channel PHY ID
67  * @bt_secondary_ci: secondary channel inhibition bitmap
68  * @secondary_ch_phy_id: secondary channel PHY ID
69  *
70  * Used for BT_COEX_CI command
71  */
72 struct iwl_bt_coex_ci_cmd {
73 	__le64 bt_primary_ci;
74 	__le32 primary_ch_phy_id;
75 
76 	__le64 bt_secondary_ci;
77 	__le32 secondary_ch_phy_id;
78 } __packed; /* BT_CI_MSG_API_S_VER_2 */
79 
80 #define BT_MBOX(n_dw, _msg, _pos, _nbits)	\
81 	BT_MBOX##n_dw##_##_msg##_POS = (_pos),	\
82 	BT_MBOX##n_dw##_##_msg = BITS(_nbits) << BT_MBOX##n_dw##_##_msg##_POS
83 
84 enum iwl_bt_mxbox_dw0 {
85 	BT_MBOX(0, LE_SLAVE_LAT, 0, 3),
86 	BT_MBOX(0, LE_PROF1, 3, 1),
87 	BT_MBOX(0, LE_PROF2, 4, 1),
88 	BT_MBOX(0, LE_PROF_OTHER, 5, 1),
89 	BT_MBOX(0, CHL_SEQ_N, 8, 4),
90 	BT_MBOX(0, INBAND_S, 13, 1),
91 	BT_MBOX(0, LE_MIN_RSSI, 16, 4),
92 	BT_MBOX(0, LE_SCAN, 20, 1),
93 	BT_MBOX(0, LE_ADV, 21, 1),
94 	BT_MBOX(0, LE_MAX_TX_POWER, 24, 4),
95 	BT_MBOX(0, OPEN_CON_1, 28, 2),
96 };
97 
98 enum iwl_bt_mxbox_dw1 {
99 	BT_MBOX(1, BR_MAX_TX_POWER, 0, 4),
100 	BT_MBOX(1, IP_SR, 4, 1),
101 	BT_MBOX(1, LE_MSTR, 5, 1),
102 	BT_MBOX(1, AGGR_TRFC_LD, 8, 6),
103 	BT_MBOX(1, MSG_TYPE, 16, 3),
104 	BT_MBOX(1, SSN, 19, 2),
105 };
106 
107 enum iwl_bt_mxbox_dw2 {
108 	BT_MBOX(2, SNIFF_ACT, 0, 3),
109 	BT_MBOX(2, PAG, 3, 1),
110 	BT_MBOX(2, INQUIRY, 4, 1),
111 	BT_MBOX(2, CONN, 5, 1),
112 	BT_MBOX(2, SNIFF_INTERVAL, 8, 5),
113 	BT_MBOX(2, DISC, 13, 1),
114 	BT_MBOX(2, SCO_TX_ACT, 16, 2),
115 	BT_MBOX(2, SCO_RX_ACT, 18, 2),
116 	BT_MBOX(2, ESCO_RE_TX, 20, 2),
117 	BT_MBOX(2, SCO_DURATION, 24, 6),
118 };
119 
120 enum iwl_bt_mxbox_dw3 {
121 	BT_MBOX(3, SCO_STATE, 0, 1),
122 	BT_MBOX(3, SNIFF_STATE, 1, 1),
123 	BT_MBOX(3, A2DP_STATE, 2, 1),
124 	BT_MBOX(3, ACL_STATE, 3, 1),
125 	BT_MBOX(3, MSTR_STATE, 4, 1),
126 	BT_MBOX(3, OBX_STATE, 5, 1),
127 	BT_MBOX(3, A2DP_SRC, 6, 1),
128 	BT_MBOX(3, OPEN_CON_2, 8, 2),
129 	BT_MBOX(3, TRAFFIC_LOAD, 10, 2),
130 	BT_MBOX(3, CHL_SEQN_LSB, 12, 1),
131 	BT_MBOX(3, INBAND_P, 13, 1),
132 	BT_MBOX(3, MSG_TYPE_2, 16, 3),
133 	BT_MBOX(3, SSN_2, 19, 2),
134 	BT_MBOX(3, UPDATE_REQUEST, 21, 1),
135 };
136 
137 #define BT_MBOX_MSG(_notif, _num, _field)				     \
138 	((le32_to_cpu((_notif)->mbox_msg[(_num)]) & BT_MBOX##_num##_##_field)\
139 	>> BT_MBOX##_num##_##_field##_POS)
140 
141 #define BT_MBOX_PRINT(_num, _field, _end)				    \
142 			pos += scnprintf(buf + pos, bufsz - pos,	    \
143 					 "\t%s: %d%s",			    \
144 					 #_field,			    \
145 					 BT_MBOX_MSG(notif, _num, _field),  \
146 					 true ? "\n" : ", ")
147 enum iwl_bt_activity_grading {
148 	BT_OFF			= 0,
149 	BT_ON_NO_CONNECTION	= 1,
150 	BT_LOW_TRAFFIC		= 2,
151 	BT_HIGH_TRAFFIC		= 3,
152 	BT_VERY_HIGH_TRAFFIC	= 4,
153 
154 	BT_MAX_AG,
155 }; /* BT_COEX_BT_ACTIVITY_GRADING_API_E_VER_1 */
156 
157 enum iwl_bt_ci_compliance {
158 	BT_CI_COMPLIANCE_NONE		= 0,
159 	BT_CI_COMPLIANCE_PRIMARY	= 1,
160 	BT_CI_COMPLIANCE_SECONDARY	= 2,
161 	BT_CI_COMPLIANCE_BOTH		= 3,
162 }; /* BT_COEX_CI_COMPLIENCE_E_VER_1 */
163 
164 /**
165  * struct iwl_bt_coex_profile_notif - notification about BT coex
166  * @mbox_msg: message from BT to WiFi
167  * @msg_idx: the index of the message
168  * @bt_ci_compliance: enum %iwl_bt_ci_compliance
169  * @primary_ch_lut: LUT used for primary channel &enum iwl_bt_coex_lut_type
170  * @secondary_ch_lut: LUT used for secondary channel &enum iwl_bt_coex_lut_type
171  * @bt_activity_grading: the activity of BT &enum iwl_bt_activity_grading
172  * @ttc_status: is TTC enabled - one bit per PHY
173  * @rrc_status: is RRC enabled - one bit per PHY
174  * The following fields are only for version 5, and are reserved in version 4:
175  * @wifi_loss_low_rssi: The predicted lost WiFi rate (% of air time that BT is
176  *	utilizing) when the RSSI is low (<= -65 dBm)
177  * @wifi_loss_mid_high_rssi: The predicted lost WiFi rate (% of air time that
178  *	BT is utilizing) when the RSSI is mid/high (>= -65 dBm)
179  */
180 struct iwl_bt_coex_profile_notif {
181 	__le32 mbox_msg[4];
182 	__le32 msg_idx;
183 	__le32 bt_ci_compliance;
184 
185 	__le32 primary_ch_lut;
186 	__le32 secondary_ch_lut;
187 	__le32 bt_activity_grading;
188 	u8 ttc_status;
189 	u8 rrc_status;
190 	u8 wifi_loss_low_rssi;
191 	u8 wifi_loss_mid_high_rssi;
192 } __packed; /* BT_COEX_PROFILE_NTFY_API_S_VER_4
193 	     * BT_COEX_PROFILE_NTFY_API_S_VER_5
194 	     */
195 
196 #endif /* __iwl_fw_api_coex_h__ */
197