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 - 2019        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 - 2019       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 
65 #define ACPI_WRDS_METHOD	"WRDS"
66 #define ACPI_EWRD_METHOD	"EWRD"
67 #define ACPI_WGDS_METHOD	"WGDS"
68 #define ACPI_WRDD_METHOD	"WRDD"
69 #define ACPI_SPLC_METHOD	"SPLC"
70 #define ACPI_ECKV_METHOD	"ECKV"
71 
72 #define ACPI_WIFI_DOMAIN	(0x07)
73 
74 #define ACPI_SAR_TABLE_SIZE		10
75 #define ACPI_SAR_PROFILE_NUM		4
76 
77 #define ACPI_GEO_TABLE_SIZE		6
78 #define ACPI_NUM_GEO_PROFILES		3
79 #define ACPI_GEO_PER_CHAIN_SIZE		3
80 
81 #define ACPI_SAR_NUM_CHAIN_LIMITS	2
82 #define ACPI_SAR_NUM_SUB_BANDS		5
83 
84 #define ACPI_WRDS_WIFI_DATA_SIZE	(ACPI_SAR_TABLE_SIZE + 2)
85 #define ACPI_EWRD_WIFI_DATA_SIZE	((ACPI_SAR_PROFILE_NUM - 1) * \
86 					 ACPI_SAR_TABLE_SIZE + 3)
87 #define ACPI_WGDS_WIFI_DATA_SIZE	19
88 #define ACPI_WRDD_WIFI_DATA_SIZE	2
89 #define ACPI_SPLC_WIFI_DATA_SIZE	2
90 #define ACPI_ECKV_WIFI_DATA_SIZE	2
91 
92 #define ACPI_WGDS_NUM_BANDS		2
93 #define ACPI_WGDS_TABLE_SIZE		3
94 
95 #ifdef CONFIG_ACPI
96 
97 void *iwl_acpi_get_object(struct device *dev, acpi_string method);
98 union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
99 					 union acpi_object *data,
100 					 int data_size, int *tbl_rev);
101 
102 /**
103  * iwl_acpi_get_mcc - read MCC from ACPI, if available
104  *
105  * @dev: the struct device
106  * @mcc: output buffer (3 bytes) that will get the MCC
107  *
108  * This function tries to read the current MCC from ACPI if available.
109  */
110 int iwl_acpi_get_mcc(struct device *dev, char *mcc);
111 
112 u64 iwl_acpi_get_pwr_limit(struct device *dev);
113 
114 /*
115  * iwl_acpi_get_eckv - read external clock validation from ACPI, if available
116  *
117  * @dev: the struct device
118  * @extl_clk: output var (2 bytes) that will get the clk indication.
119  *
120  * This function tries to read the external clock indication
121  * from ACPI if available.
122  */
123 int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk);
124 
125 #else /* CONFIG_ACPI */
126 
127 static inline void *iwl_acpi_get_object(struct device *dev, acpi_string method)
128 {
129 	return ERR_PTR(-ENOENT);
130 }
131 
132 static inline union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
133 						       union acpi_object *data,
134 						       int data_size,
135 						       int *tbl_rev)
136 {
137 	return ERR_PTR(-ENOENT);
138 }
139 
140 static inline int iwl_acpi_get_mcc(struct device *dev, char *mcc)
141 {
142 	return -ENOENT;
143 }
144 
145 static inline u64 iwl_acpi_get_pwr_limit(struct device *dev)
146 {
147 	return 0;
148 }
149 
150 static inline int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk)
151 {
152 	return -ENOENT;
153 }
154 
155 #endif /* CONFIG_ACPI */
156 #endif /* __iwl_fw_acpi__ */
157