xref: /linux/drivers/net/wireless/intel/iwlwifi/fw/acpi.h (revision 7bb377107c72a40ab7505341f8626c8eb79a0cb7)
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) 2017        Intel Deutschland GmbH
9  * Copyright(c) 2018 - 2020        Intel Corporation
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of version 2 of the GNU General Public License as
13  * published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope that it will be useful, but
16  * WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * General Public License for more details.
19  *
20  * The full GNU General Public License is included in this distribution
21  * in the file called COPYING.
22  *
23  * Contact Information:
24  *  Intel Linux Wireless <linuxwifi@intel.com>
25  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26  *
27  * BSD LICENSE
28  *
29  * Copyright(c) 2017        Intel Deutschland GmbH
30  * Copyright(c) 2018 - 2020       Intel Corporation
31  * All rights reserved.
32  *
33  * Redistribution and use in source and binary forms, with or without
34  * modification, are permitted provided that the following conditions
35  * are met:
36  *
37  *  * Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  *  * Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in
41  *    the documentation and/or other materials provided with the
42  *    distribution.
43  *  * Neither the name Intel Corporation nor the names of its
44  *    contributors may be used to endorse or promote products derived
45  *    from this software without specific prior written permission.
46  *
47  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
48  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
49  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
50  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
51  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
52  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
53  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
57  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58  *
59  *****************************************************************************/
60 #ifndef __iwl_fw_acpi__
61 #define __iwl_fw_acpi__
62 
63 #include <linux/acpi.h>
64 #include "fw/api/commands.h"
65 #include "fw/api/power.h"
66 #include "fw/api/phy.h"
67 #include "fw/api/nvm-reg.h"
68 #include "fw/img.h"
69 #include "iwl-trans.h"
70 
71 
72 #define ACPI_WRDS_METHOD	"WRDS"
73 #define ACPI_EWRD_METHOD	"EWRD"
74 #define ACPI_WGDS_METHOD	"WGDS"
75 #define ACPI_WRDD_METHOD	"WRDD"
76 #define ACPI_SPLC_METHOD	"SPLC"
77 #define ACPI_ECKV_METHOD	"ECKV"
78 #define ACPI_PPAG_METHOD	"PPAG"
79 #define ACPI_WTAS_METHOD	"WTAS"
80 
81 #define ACPI_WIFI_DOMAIN	(0x07)
82 
83 #define ACPI_SAR_TABLE_SIZE		10
84 #define ACPI_SAR_PROFILE_NUM		4
85 
86 #define ACPI_GEO_TABLE_SIZE		6
87 #define ACPI_NUM_GEO_PROFILES		3
88 #define ACPI_GEO_PER_CHAIN_SIZE		3
89 
90 #define ACPI_SAR_NUM_CHAIN_LIMITS	2
91 #define ACPI_SAR_NUM_SUB_BANDS		5
92 
93 #define ACPI_WRDS_WIFI_DATA_SIZE	(ACPI_SAR_TABLE_SIZE + 2)
94 #define ACPI_EWRD_WIFI_DATA_SIZE	((ACPI_SAR_PROFILE_NUM - 1) * \
95 					 ACPI_SAR_TABLE_SIZE + 3)
96 #define ACPI_WGDS_WIFI_DATA_SIZE	19
97 #define ACPI_WRDD_WIFI_DATA_SIZE	2
98 #define ACPI_SPLC_WIFI_DATA_SIZE	2
99 #define ACPI_ECKV_WIFI_DATA_SIZE	2
100 
101 /*
102  * 1 type, 1 enabled, 1 black list size, 16 black list array
103  */
104 #define APCI_WTAS_BLACK_LIST_MAX	16
105 #define ACPI_WTAS_WIFI_DATA_SIZE	(3 + APCI_WTAS_BLACK_LIST_MAX)
106 
107 #define ACPI_WGDS_NUM_BANDS		2
108 #define ACPI_WGDS_TABLE_SIZE		3
109 
110 #define ACPI_PPAG_NUM_CHAINS		2
111 #define ACPI_PPAG_NUM_SUB_BANDS		5
112 #define ACPI_PPAG_WIFI_DATA_SIZE	((ACPI_PPAG_NUM_CHAINS * \
113 					ACPI_PPAG_NUM_SUB_BANDS) + 3)
114 
115 /* PPAG gain value bounds in 1/8 dBm */
116 #define ACPI_PPAG_MIN_LB -16
117 #define ACPI_PPAG_MAX_LB 24
118 #define ACPI_PPAG_MIN_HB -16
119 #define ACPI_PPAG_MAX_HB 40
120 
121 struct iwl_sar_profile {
122 	bool enabled;
123 	u8 table[ACPI_SAR_TABLE_SIZE];
124 };
125 
126 struct iwl_geo_profile {
127 	u8 values[ACPI_GEO_TABLE_SIZE];
128 };
129 
130 #ifdef CONFIG_ACPI
131 
132 struct iwl_fw_runtime;
133 
134 void *iwl_acpi_get_object(struct device *dev, acpi_string method);
135 
136 union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
137 					 union acpi_object *data,
138 					 int data_size, int *tbl_rev);
139 
140 /**
141  * iwl_acpi_get_mcc - read MCC from ACPI, if available
142  *
143  * @dev: the struct device
144  * @mcc: output buffer (3 bytes) that will get the MCC
145  *
146  * This function tries to read the current MCC from ACPI if available.
147  */
148 int iwl_acpi_get_mcc(struct device *dev, char *mcc);
149 
150 u64 iwl_acpi_get_pwr_limit(struct device *dev);
151 
152 /*
153  * iwl_acpi_get_eckv - read external clock validation from ACPI, if available
154  *
155  * @dev: the struct device
156  * @extl_clk: output var (2 bytes) that will get the clk indication.
157  *
158  * This function tries to read the external clock indication
159  * from ACPI if available.
160  */
161 int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk);
162 
163 int iwl_sar_set_profile(union acpi_object *table,
164 			struct iwl_sar_profile *profile,
165 			bool enabled);
166 
167 int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
168 			   __le16 per_chain_restriction[][IWL_NUM_SUB_BANDS],
169 			   int prof_a, int prof_b);
170 
171 int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt);
172 
173 int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt);
174 
175 int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt);
176 
177 bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt);
178 
179 int iwl_validate_sar_geo_profile(struct iwl_fw_runtime *fwrt,
180 				 struct iwl_host_cmd *cmd);
181 
182 int iwl_sar_geo_init(struct iwl_fw_runtime *fwrt,
183 		     struct iwl_per_chain_offset_group *table);
184 
185 int iwl_acpi_get_tas(struct iwl_fw_runtime *fwrt, __le32 *black_list_array,
186 		     int *black_list_size);
187 
188 #else /* CONFIG_ACPI */
189 
190 static inline void *iwl_acpi_get_object(struct device *dev, acpi_string method)
191 {
192 	return ERR_PTR(-ENOENT);
193 }
194 
195 static inline union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
196 						       union acpi_object *data,
197 						       int data_size,
198 						       int *tbl_rev)
199 {
200 	return ERR_PTR(-ENOENT);
201 }
202 
203 static inline int iwl_acpi_get_mcc(struct device *dev, char *mcc)
204 {
205 	return -ENOENT;
206 }
207 
208 static inline u64 iwl_acpi_get_pwr_limit(struct device *dev)
209 {
210 	return 0;
211 }
212 
213 static inline int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk)
214 {
215 	return -ENOENT;
216 }
217 
218 static inline int iwl_sar_set_profile(union acpi_object *table,
219 				      struct iwl_sar_profile *profile,
220 				      bool enabled)
221 {
222 	return -ENOENT;
223 }
224 
225 static inline int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
226 			   __le16 per_chain_restriction[][IWL_NUM_SUB_BANDS],
227 			   int prof_a, int prof_b)
228 {
229 	return -ENOENT;
230 }
231 
232 static inline int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt)
233 {
234 	return -ENOENT;
235 }
236 
237 static inline int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt)
238 {
239 	return -ENOENT;
240 }
241 
242 static inline int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt)
243 {
244 	return -ENOENT;
245 }
246 
247 static inline bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt)
248 {
249 	return false;
250 }
251 
252 static inline int iwl_validate_sar_geo_profile(struct iwl_fw_runtime *fwrt,
253 					       struct iwl_host_cmd *cmd)
254 {
255 	return -ENOENT;
256 }
257 
258 static inline int iwl_sar_geo_init(struct iwl_fw_runtime *fwrt,
259 				   struct iwl_per_chain_offset_group *table)
260 {
261 	return -ENOENT;
262 }
263 
264 static inline int iwl_acpi_get_tas(struct iwl_fw_runtime *fwrt,
265 				   __le32 *black_list_array,
266 				   int *black_list_size)
267 {
268 	return -ENOENT;
269 }
270 #endif /* CONFIG_ACPI */
271 #endif /* __iwl_fw_acpi__ */
272