xref: /freebsd/sys/contrib/dev/iwlwifi/fw/acpi.h (revision 2d5d2a986ce1a93b8567dbdf3f80bc2b545d6998)
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3  * Copyright (C) 2017 Intel Deutschland GmbH
4  * Copyright (C) 2018-2022 Intel Corporation
5  */
6 #ifndef __iwl_fw_acpi__
7 #define __iwl_fw_acpi__
8 
9 #include <linux/acpi.h>
10 #include "fw/api/commands.h"
11 #include "fw/api/power.h"
12 #include "fw/api/phy.h"
13 #include "fw/api/nvm-reg.h"
14 #include "fw/img.h"
15 #include "iwl-trans.h"
16 
17 
18 #define ACPI_WRDS_METHOD	"WRDS"
19 #define ACPI_EWRD_METHOD	"EWRD"
20 #define ACPI_WGDS_METHOD	"WGDS"
21 #define ACPI_WRDD_METHOD	"WRDD"
22 #define ACPI_SPLC_METHOD	"SPLC"
23 #define ACPI_ECKV_METHOD	"ECKV"
24 #define ACPI_PPAG_METHOD	"PPAG"
25 #define ACPI_WTAS_METHOD	"WTAS"
26 
27 #define ACPI_WIFI_DOMAIN	(0x07)
28 
29 #define ACPI_SAR_PROFILE_NUM		4
30 
31 #define ACPI_NUM_GEO_PROFILES		3
32 #define ACPI_NUM_GEO_PROFILES_REV3	8
33 #define ACPI_GEO_PER_CHAIN_SIZE		3
34 
35 #define ACPI_SAR_NUM_CHAINS_REV0	2
36 #define ACPI_SAR_NUM_CHAINS_REV1	2
37 #define ACPI_SAR_NUM_CHAINS_REV2	4
38 #define ACPI_SAR_NUM_SUB_BANDS_REV0	5
39 #define ACPI_SAR_NUM_SUB_BANDS_REV1	11
40 #define ACPI_SAR_NUM_SUB_BANDS_REV2	11
41 
42 #define ACPI_WRDS_WIFI_DATA_SIZE_REV0	(ACPI_SAR_NUM_CHAINS_REV0 * \
43 					 ACPI_SAR_NUM_SUB_BANDS_REV0 + 2)
44 #define ACPI_WRDS_WIFI_DATA_SIZE_REV1	(ACPI_SAR_NUM_CHAINS_REV1 * \
45 					 ACPI_SAR_NUM_SUB_BANDS_REV1 + 2)
46 #define ACPI_WRDS_WIFI_DATA_SIZE_REV2	(ACPI_SAR_NUM_CHAINS_REV2 * \
47 					 ACPI_SAR_NUM_SUB_BANDS_REV2 + 2)
48 #define ACPI_EWRD_WIFI_DATA_SIZE_REV0	((ACPI_SAR_PROFILE_NUM - 1) * \
49 					 ACPI_SAR_NUM_CHAINS_REV0 * \
50 					 ACPI_SAR_NUM_SUB_BANDS_REV0 + 3)
51 #define ACPI_EWRD_WIFI_DATA_SIZE_REV1	((ACPI_SAR_PROFILE_NUM - 1) * \
52 					 ACPI_SAR_NUM_CHAINS_REV1 * \
53 					 ACPI_SAR_NUM_SUB_BANDS_REV1 + 3)
54 #define ACPI_EWRD_WIFI_DATA_SIZE_REV2	((ACPI_SAR_PROFILE_NUM - 1) * \
55 					 ACPI_SAR_NUM_CHAINS_REV2 * \
56 					 ACPI_SAR_NUM_SUB_BANDS_REV2 + 3)
57 
58 /* revision 0 and 1 are identical, except for the semantics in the FW */
59 #define ACPI_GEO_NUM_BANDS_REV0		2
60 #define ACPI_GEO_NUM_BANDS_REV2		3
61 #define ACPI_GEO_NUM_CHAINS		2
62 
63 #define ACPI_WRDD_WIFI_DATA_SIZE	2
64 #define ACPI_SPLC_WIFI_DATA_SIZE	2
65 #define ACPI_ECKV_WIFI_DATA_SIZE	2
66 
67 /*
68  * TAS size: 1 elelment for type,
69  *	     1 element for enabled field,
70  *	     1 element for block list size,
71  *	     16 elements for block list array
72  */
73 #define APCI_WTAS_BLACK_LIST_MAX	16
74 #define ACPI_WTAS_WIFI_DATA_SIZE	(3 + APCI_WTAS_BLACK_LIST_MAX)
75 #define ACPI_WTAS_ENABLED_MSK		0x1
76 #define ACPI_WTAS_OVERRIDE_IEC_MSK	0x2
77 #define ACPI_WTAS_ENABLE_IEC_MSK	0x4
78 #define ACPI_WTAS_OVERRIDE_IEC_POS	0x1
79 #define ACPI_WTAS_ENABLE_IEC_POS	0x2
80 #define ACPI_WTAS_USA_UHB_MSK		BIT(16)
81 #define ACPI_WTAS_USA_UHB_POS		16
82 
83 
84 #define ACPI_PPAG_WIFI_DATA_SIZE_V1	((IWL_NUM_CHAIN_LIMITS * \
85 					  IWL_NUM_SUB_BANDS_V1) + 2)
86 #define ACPI_PPAG_WIFI_DATA_SIZE_V2	((IWL_NUM_CHAIN_LIMITS * \
87 					  IWL_NUM_SUB_BANDS_V2) + 2)
88 
89 /* PPAG gain value bounds in 1/8 dBm */
90 #define ACPI_PPAG_MIN_LB -16
91 #define ACPI_PPAG_MAX_LB 24
92 #define ACPI_PPAG_MIN_HB -16
93 #define ACPI_PPAG_MAX_HB 40
94 
95 /*
96  * The profile for revision 2 is a superset of revision 1, which is in
97  * turn a superset of revision 0.  So we can store all revisions
98  * inside revision 2, which is what we represent here.
99  */
100 struct iwl_sar_profile_chain {
101 	u8 subbands[ACPI_SAR_NUM_SUB_BANDS_REV2];
102 };
103 
104 struct iwl_sar_profile {
105 	bool enabled;
106 	struct iwl_sar_profile_chain chains[ACPI_SAR_NUM_CHAINS_REV2];
107 };
108 
109 /* Same thing as with SAR, all revisions fit in revision 2 */
110 struct iwl_geo_profile_band {
111 	u8 max;
112 	u8 chains[ACPI_GEO_NUM_CHAINS];
113 };
114 
115 struct iwl_geo_profile {
116 	struct iwl_geo_profile_band bands[ACPI_GEO_NUM_BANDS_REV2];
117 };
118 
119 /* Same thing as with SAR, all revisions fit in revision 2 */
120 struct iwl_ppag_chain {
121 	s8 subbands[ACPI_SAR_NUM_SUB_BANDS_REV2];
122 };
123 
124 enum iwl_dsm_funcs_rev_0 {
125 	DSM_FUNC_QUERY = 0,
126 	DSM_FUNC_DISABLE_SRD = 1,
127 	DSM_FUNC_ENABLE_INDONESIA_5G2 = 2,
128 	DSM_FUNC_ENABLE_6E = 3,
129 	DSM_FUNC_11AX_ENABLEMENT = 6,
130 	DSM_FUNC_ENABLE_UNII4_CHAN = 7,
131 	DSM_FUNC_ACTIVATE_CHANNEL = 8,
132 	DSM_FUNC_FORCE_DISABLE_CHANNELS = 9
133 };
134 
135 enum iwl_dsm_values_srd {
136 	DSM_VALUE_SRD_ACTIVE,
137 	DSM_VALUE_SRD_PASSIVE,
138 	DSM_VALUE_SRD_DISABLE,
139 	DSM_VALUE_SRD_MAX
140 };
141 
142 enum iwl_dsm_values_indonesia {
143 	DSM_VALUE_INDONESIA_DISABLE,
144 	DSM_VALUE_INDONESIA_ENABLE,
145 	DSM_VALUE_INDONESIA_RESERVED,
146 	DSM_VALUE_INDONESIA_MAX
147 };
148 
149 /* DSM RFI uses a different GUID, so need separate definitions */
150 
151 #define DSM_RFI_FUNC_ENABLE 3
152 
153 enum iwl_dsm_values_rfi {
154 	DSM_VALUE_RFI_ENABLE,
155 	DSM_VALUE_RFI_DISABLE,
156 	DSM_VALUE_RFI_MAX
157 };
158 
159 #ifdef CONFIG_ACPI
160 
161 struct iwl_fw_runtime;
162 
163 extern const guid_t iwl_guid;
164 extern const guid_t iwl_rfi_guid;
165 
166 void *iwl_acpi_get_object(struct device *dev, acpi_string method);
167 
168 int iwl_acpi_get_dsm_u8(struct device *dev, int rev, int func,
169 			const guid_t *guid, u8 *value);
170 
171 int iwl_acpi_get_dsm_u32(struct device *dev, int rev, int func,
172 			 const guid_t *guid, u32 *value);
173 
174 union acpi_object *iwl_acpi_get_wifi_pkg_range(struct device *dev,
175 					       union acpi_object *data,
176 					       int min_data_size,
177 					       int max_data_size,
178 					       int *tbl_rev);
179 /**
180  * iwl_acpi_get_mcc - read MCC from ACPI, if available
181  *
182  * @dev: the struct device
183  * @mcc: output buffer (3 bytes) that will get the MCC
184  *
185  * This function tries to read the current MCC from ACPI if available.
186  */
187 int iwl_acpi_get_mcc(struct device *dev, char *mcc);
188 
189 u64 iwl_acpi_get_pwr_limit(struct device *dev);
190 
191 /*
192  * iwl_acpi_get_eckv - read external clock validation from ACPI, if available
193  *
194  * @dev: the struct device
195  * @extl_clk: output var (2 bytes) that will get the clk indication.
196  *
197  * This function tries to read the external clock indication
198  * from ACPI if available.
199  */
200 int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk);
201 
202 int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
203 			   __le16 *per_chain, u32 n_tables, u32 n_subbands,
204 			   int prof_a, int prof_b);
205 
206 int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt);
207 
208 int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt);
209 
210 int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt);
211 
212 bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt);
213 
214 int iwl_sar_geo_init(struct iwl_fw_runtime *fwrt,
215 		     struct iwl_per_chain_offset *table,
216 		     u32 n_bands, u32 n_profiles);
217 
218 int iwl_acpi_get_tas(struct iwl_fw_runtime *fwrt,
219 		     union iwl_tas_config_cmd *cmd, int fw_ver);
220 
221 __le32 iwl_acpi_get_lari_config_bitmap(struct iwl_fw_runtime *fwrt);
222 
223 #else /* CONFIG_ACPI */
224 
225 static inline void *iwl_acpi_get_object(struct device *dev, acpi_string method)
226 {
227 	return ERR_PTR(-ENOENT);
228 }
229 
230 static inline void *iwl_acpi_get_dsm_object(struct device *dev, int rev,
231 					    int func, union acpi_object *args)
232 {
233 	return ERR_PTR(-ENOENT);
234 }
235 
236 static inline int iwl_acpi_get_dsm_u8(struct device *dev, int rev, int func,
237 				      const guid_t *guid, u8 *value)
238 {
239 	return -ENOENT;
240 }
241 
242 static inline int iwl_acpi_get_dsm_u32(struct device *dev, int rev, int func,
243 				       const guid_t *guid, u32 *value)
244 {
245 	return -ENOENT;
246 }
247 
248 static inline union acpi_object *
249 iwl_acpi_get_wifi_pkg_range(struct device *dev,
250 			    union acpi_object *data,
251 			    int min_data_size, int max_data_size,
252 			    int *tbl_rev)
253 {
254 	return ERR_PTR(-ENOENT);
255 }
256 
257 static inline int iwl_acpi_get_mcc(struct device *dev, char *mcc)
258 {
259 	return -ENOENT;
260 }
261 
262 static inline u64 iwl_acpi_get_pwr_limit(struct device *dev)
263 {
264 	return 0;
265 }
266 
267 static inline int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk)
268 {
269 	return -ENOENT;
270 }
271 
272 static inline int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
273 			   __le16 *per_chain, u32 n_tables, u32 n_subbands,
274 			   int prof_a, int prof_b)
275 {
276 	return -ENOENT;
277 }
278 
279 static inline int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt)
280 {
281 	return -ENOENT;
282 }
283 
284 static inline int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt)
285 {
286 	return -ENOENT;
287 }
288 
289 static inline int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt)
290 {
291 	return 1;
292 }
293 
294 static inline bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt)
295 {
296 	return false;
297 }
298 
299 static inline int iwl_acpi_get_tas(struct iwl_fw_runtime *fwrt,
300 				   union iwl_tas_config_cmd *cmd, int fw_ver)
301 {
302 	return -ENOENT;
303 }
304 
305 static inline __le32 iwl_acpi_get_lari_config_bitmap(struct iwl_fw_runtime *fwrt)
306 {
307 	return 0;
308 }
309 
310 #endif /* CONFIG_ACPI */
311 
312 static inline union acpi_object *
313 iwl_acpi_get_wifi_pkg(struct device *dev,
314 		      union acpi_object *data,
315 		      int data_size, int *tbl_rev)
316 {
317 	return iwl_acpi_get_wifi_pkg_range(dev, data, data_size, data_size,
318 					   tbl_rev);
319 }
320 
321 #endif /* __iwl_fw_acpi__ */
322