1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /*
3 * Copyright (C) 2017 Intel Deutschland GmbH
4 * Copyright (C) 2018-2023, 2025 Intel Corporation
5 */
6 #ifndef __iwl_fw_acpi__
7 #define __iwl_fw_acpi__
8
9 #include <linux/acpi.h>
10 #include "fw/regulatory.h"
11 #include "fw/api/commands.h"
12 #include "fw/api/power.h"
13 #include "fw/api/phy.h"
14 #include "fw/api/nvm-reg.h"
15 #include "fw/api/config.h"
16 #include "fw/img.h"
17 #include "iwl-trans.h"
18
19
20 #define ACPI_WRDS_METHOD "WRDS"
21 #define ACPI_EWRD_METHOD "EWRD"
22 #define ACPI_WGDS_METHOD "WGDS"
23 #define ACPI_WRDD_METHOD "WRDD"
24 #define ACPI_SPLC_METHOD "SPLC"
25 #define ACPI_ECKV_METHOD "ECKV"
26 #define ACPI_PPAG_METHOD "PPAG"
27 #define ACPI_WTAS_METHOD "WTAS"
28 #define ACPI_WPFC_METHOD "WPFC"
29 #define ACPI_GLAI_METHOD "GLAI"
30 #define ACPI_WBEM_METHOD "WBEM"
31 #define ACPI_DSBR_METHOD "DSBR"
32
33 #define ACPI_WIFI_DOMAIN (0x07)
34
35 #define ACPI_SAR_PROFILE_NUM 4
36
37 #define ACPI_NUM_GEO_PROFILES 3
38 #define ACPI_NUM_GEO_PROFILES_REV3 8
39 #define ACPI_GEO_PER_CHAIN_SIZE 3
40
41 #define ACPI_SAR_NUM_CHAINS_REV0 2
42 #define ACPI_SAR_NUM_CHAINS_REV1 2
43 #define ACPI_SAR_NUM_CHAINS_REV2 4
44 #define ACPI_SAR_NUM_SUB_BANDS_REV0 5
45 #define ACPI_SAR_NUM_SUB_BANDS_REV1 11
46 #define ACPI_SAR_NUM_SUB_BANDS_REV2 11
47
48 #define ACPI_WRDS_WIFI_DATA_SIZE_REV0 (ACPI_SAR_NUM_CHAINS_REV0 * \
49 ACPI_SAR_NUM_SUB_BANDS_REV0 + 2)
50 #define ACPI_WRDS_WIFI_DATA_SIZE_REV1 (ACPI_SAR_NUM_CHAINS_REV1 * \
51 ACPI_SAR_NUM_SUB_BANDS_REV1 + 2)
52 #define ACPI_WRDS_WIFI_DATA_SIZE_REV2 (ACPI_SAR_NUM_CHAINS_REV2 * \
53 ACPI_SAR_NUM_SUB_BANDS_REV2 + 2)
54 #define ACPI_EWRD_WIFI_DATA_SIZE_REV0 ((ACPI_SAR_PROFILE_NUM - 1) * \
55 ACPI_SAR_NUM_CHAINS_REV0 * \
56 ACPI_SAR_NUM_SUB_BANDS_REV0 + 3)
57 #define ACPI_EWRD_WIFI_DATA_SIZE_REV1 ((ACPI_SAR_PROFILE_NUM - 1) * \
58 ACPI_SAR_NUM_CHAINS_REV1 * \
59 ACPI_SAR_NUM_SUB_BANDS_REV1 + 3)
60 #define ACPI_EWRD_WIFI_DATA_SIZE_REV2 ((ACPI_SAR_PROFILE_NUM - 1) * \
61 ACPI_SAR_NUM_CHAINS_REV2 * \
62 ACPI_SAR_NUM_SUB_BANDS_REV2 + 3)
63 #define ACPI_WPFC_WIFI_DATA_SIZE 5 /* domain and 4 filter config words */
64
65 /* revision 0 and 1 are identical, except for the semantics in the FW */
66 #define ACPI_GEO_NUM_BANDS_REV0 2
67 #define ACPI_GEO_NUM_BANDS_REV2 3
68
69 #define ACPI_WRDD_WIFI_DATA_SIZE 2
70 #define ACPI_SPLC_WIFI_DATA_SIZE 2
71 #define ACPI_ECKV_WIFI_DATA_SIZE 2
72
73 /*
74 * One element for domain type,
75 * and one for enablement of Wi-Fi 320MHz per MCC
76 */
77 #define ACPI_WBEM_WIFI_DATA_SIZE 2
78 /*
79 * One element for domain type,
80 * and one for DSBR response data
81 */
82 #define ACPI_DSBR_WIFI_DATA_SIZE 2
83 #define ACPI_DSBR_WIFI_DATA_REV 1
84
85 /*
86 * One element for domain type,
87 * and one for the status
88 */
89 #define ACPI_GLAI_WIFI_DATA_SIZE 2
90 #define ACPI_GLAI_MAX_STATUS 2
91 /*
92 * TAS size: 1 elelment for type,
93 * 1 element for enabled field,
94 * 1 element for block list size,
95 * 16 elements for block list array
96 */
97 #define ACPI_WTAS_WIFI_DATA_SIZE (3 + IWL_WTAS_BLACK_LIST_MAX)
98
99 #define ACPI_PPAG_WIFI_DATA_SIZE_V1 ((IWL_NUM_CHAIN_LIMITS * \
100 IWL_NUM_SUB_BANDS_V1) + 2)
101 #define ACPI_PPAG_WIFI_DATA_SIZE_V2 ((IWL_NUM_CHAIN_LIMITS * \
102 IWL_NUM_SUB_BANDS_V2) + 2)
103
104 #define IWL_SAR_ENABLE_MSK BIT(0)
105 #define IWL_REDUCE_POWER_FLAGS_POS 1
106
107 /* The Inidcator whether UEFI WIFI GUID tables are locked is read from ACPI */
108 #define UEFI_WIFI_GUID_UNLOCKED 0
109
110 #define ACPI_DSM_REV 0
111
112 #define DSM_INTERNAL_FUNC_GET_PLAT_INFO 1
113 /* TBD: VPRO is BIT(0) in the result, but what's the result? */
114
115 #define DSM_INTERNAL_FUNC_PRODUCT_RESET 2
116
117 /* DSM_INTERNAL_FUNC_PRODUCT_RESET - product reset (aka "PLDR") */
118 enum iwl_dsm_internal_product_reset_cmds {
119 DSM_INTERNAL_PLDR_CMD_GET_MODE = 1,
120 DSM_INTERNAL_PLDR_CMD_SET_MODE = 2,
121 DSM_INTERNAL_PLDR_CMD_GET_STATUS = 3,
122 };
123
124 enum iwl_dsm_internal_product_reset_mode {
125 DSM_INTERNAL_PLDR_MODE_EN_PROD_RESET = BIT(0),
126 DSM_INTERNAL_PLDR_MODE_EN_WIFI_FLR = BIT(1),
127 DSM_INTERNAL_PLDR_MODE_EN_BT_OFF_ON = BIT(2),
128 };
129
130 struct iwl_dsm_internal_product_reset_cmd {
131 /* cmd is from enum iwl_dsm_internal_product_reset_cmds */
132 u16 cmd;
133 u16 value;
134 } __packed;
135
136 #define IWL_ACPI_WBEM_REV0_MASK (BIT(0) | BIT(1))
137 #define IWL_ACPI_WBEM_REVISION 0
138
139 #ifdef CONFIG_ACPI
140
141 struct iwl_fw_runtime;
142
143 union acpi_object *iwl_acpi_get_dsm_object(struct device *dev, int rev,
144 int func, union acpi_object *args,
145 const guid_t *guid);
146
147 /**
148 * iwl_acpi_get_mcc - read MCC from ACPI, if available
149 *
150 * @fwrt: the fw runtime struct
151 * @mcc: output buffer (3 bytes) that will get the MCC
152 *
153 * This function tries to read the current MCC from ACPI if available.
154 * Return: 0 on success, or a negative error code
155 */
156 int iwl_acpi_get_mcc(struct iwl_fw_runtime *fwrt, char *mcc);
157
158 int iwl_acpi_get_pwr_limit(struct iwl_fw_runtime *fwrt, u64 *dflt_pwr_limit);
159
160 /*
161 * iwl_acpi_get_eckv - read external clock validation from ACPI, if available
162 *
163 * @fwrt: the fw runtime struct
164 * @extl_clk: output var (2 bytes) that will get the clk indication.
165 *
166 * This function tries to read the external clock indication
167 * from ACPI if available.
168 */
169 int iwl_acpi_get_eckv(struct iwl_fw_runtime *fwrt, u32 *extl_clk);
170
171 int iwl_acpi_get_wrds_table(struct iwl_fw_runtime *fwrt);
172
173 int iwl_acpi_get_ewrd_table(struct iwl_fw_runtime *fwrt);
174
175 int iwl_acpi_get_wgds_table(struct iwl_fw_runtime *fwrt);
176
177 int iwl_acpi_get_tas_table(struct iwl_fw_runtime *fwrt,
178 struct iwl_tas_data *data);
179
180 int iwl_acpi_get_ppag_table(struct iwl_fw_runtime *fwrt);
181
182 int iwl_acpi_get_phy_filters(struct iwl_fw_runtime *fwrt);
183
184 void iwl_acpi_get_guid_lock_status(struct iwl_fw_runtime *fwrt);
185
186 int iwl_acpi_get_dsm(struct iwl_fw_runtime *fwrt,
187 enum iwl_dsm_funcs func, u32 *value);
188
189 int iwl_acpi_get_wbem(struct iwl_fw_runtime *fwrt, u32 *value);
190
191 int iwl_acpi_get_dsbr(struct iwl_fw_runtime *fwrt, u32 *value);
192
193 #else /* CONFIG_ACPI */
194
195 static inline union acpi_object *
iwl_acpi_get_dsm_object(struct device * dev,int rev,int func,union acpi_object * args,const guid_t * guid)196 iwl_acpi_get_dsm_object(struct device *dev, int rev, int func,
197 union acpi_object *args, const guid_t *guid)
198 {
199 return ERR_PTR(-ENOENT);
200 }
201
iwl_acpi_get_mcc(struct iwl_fw_runtime * fwrt,char * mcc)202 static inline int iwl_acpi_get_mcc(struct iwl_fw_runtime *fwrt, char *mcc)
203 {
204 return -ENOENT;
205 }
206
iwl_acpi_get_pwr_limit(struct iwl_fw_runtime * fwrt,u64 * dflt_pwr_limit)207 static inline int iwl_acpi_get_pwr_limit(struct iwl_fw_runtime *fwrt,
208 u64 *dflt_pwr_limit)
209 {
210 *dflt_pwr_limit = 0;
211 return 0;
212 }
213
iwl_acpi_get_eckv(struct iwl_fw_runtime * fwrt,u32 * extl_clk)214 static inline int iwl_acpi_get_eckv(struct iwl_fw_runtime *fwrt, u32 *extl_clk)
215 {
216 return -ENOENT;
217 }
218
iwl_acpi_get_wrds_table(struct iwl_fw_runtime * fwrt)219 static inline int iwl_acpi_get_wrds_table(struct iwl_fw_runtime *fwrt)
220 {
221 return -ENOENT;
222 }
223
iwl_acpi_get_ewrd_table(struct iwl_fw_runtime * fwrt)224 static inline int iwl_acpi_get_ewrd_table(struct iwl_fw_runtime *fwrt)
225 {
226 return -ENOENT;
227 }
228
iwl_acpi_get_wgds_table(struct iwl_fw_runtime * fwrt)229 static inline int iwl_acpi_get_wgds_table(struct iwl_fw_runtime *fwrt)
230 {
231 return 1;
232 }
233
iwl_acpi_get_tas_table(struct iwl_fw_runtime * fwrt,struct iwl_tas_data * data)234 static inline int iwl_acpi_get_tas_table(struct iwl_fw_runtime *fwrt,
235 struct iwl_tas_data *data)
236 {
237 return -ENOENT;
238 }
239
iwl_acpi_get_ppag_table(struct iwl_fw_runtime * fwrt)240 static inline int iwl_acpi_get_ppag_table(struct iwl_fw_runtime *fwrt)
241 {
242 return -ENOENT;
243 }
244
iwl_acpi_get_phy_filters(struct iwl_fw_runtime * fwrt)245 static inline int iwl_acpi_get_phy_filters(struct iwl_fw_runtime *fwrt)
246 {
247 return -ENOENT;
248 }
249
iwl_acpi_get_guid_lock_status(struct iwl_fw_runtime * fwrt)250 static inline void iwl_acpi_get_guid_lock_status(struct iwl_fw_runtime *fwrt)
251 {
252 }
253
iwl_acpi_get_dsm(struct iwl_fw_runtime * fwrt,enum iwl_dsm_funcs func,u32 * value)254 static inline int iwl_acpi_get_dsm(struct iwl_fw_runtime *fwrt,
255 enum iwl_dsm_funcs func, u32 *value)
256 {
257 return -ENOENT;
258 }
259
iwl_acpi_get_wbem(struct iwl_fw_runtime * fwrt,u32 * value)260 static inline int iwl_acpi_get_wbem(struct iwl_fw_runtime *fwrt, u32 *value)
261 {
262 return -ENOENT;
263 }
264
iwl_acpi_get_dsbr(struct iwl_fw_runtime * fwrt,u32 * value)265 static inline int iwl_acpi_get_dsbr(struct iwl_fw_runtime *fwrt, u32 *value)
266 {
267 return -ENOENT;
268 }
269 #endif /* CONFIG_ACPI */
270
271 #endif /* __iwl_fw_acpi__ */
272