drivers/net/wireless/intel/iwlwifi/fw/acpi.h

   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/img.h"
  68 #include "iwl-trans.h"
  69
  70
  71 #define ACPI_WRDS_METHOD        "WRDS"
  72 #define ACPI_EWRD_METHOD        "EWRD"
  73 #define ACPI_WGDS_METHOD        "WGDS"
  74 #define ACPI_WRDD_METHOD        "WRDD"
  75 #define ACPI_SPLC_METHOD        "SPLC"
  76 #define ACPI_ECKV_METHOD        "ECKV"
  77 #define ACPI_PPAG_METHOD        "PPAG"
  78
  79 #define ACPI_WIFI_DOMAIN        (0x07)
  80
  81 #define ACPI_SAR_TABLE_SIZE             10
  82 #define ACPI_SAR_PROFILE_NUM            4
  83
  84 #define ACPI_GEO_TABLE_SIZE             6
  85 #define ACPI_NUM_GEO_PROFILES           3
  86 #define ACPI_GEO_PER_CHAIN_SIZE         3
  87
  88 #define ACPI_SAR_NUM_CHAIN_LIMITS       2
  89 #define ACPI_SAR_NUM_SUB_BANDS          5
  90
  91 #define ACPI_WRDS_WIFI_DATA_SIZE        (ACPI_SAR_TABLE_SIZE + 2)
  92 #define ACPI_EWRD_WIFI_DATA_SIZE        ((ACPI_SAR_PROFILE_NUM - 1) * \
  93                                          ACPI_SAR_TABLE_SIZE + 3)
  94 #define ACPI_WGDS_WIFI_DATA_SIZE        19
  95 #define ACPI_WRDD_WIFI_DATA_SIZE        2
  96 #define ACPI_SPLC_WIFI_DATA_SIZE        2
  97 #define ACPI_ECKV_WIFI_DATA_SIZE        2
  98
  99 #define ACPI_WGDS_NUM_BANDS             2
 100 #define ACPI_WGDS_TABLE_SIZE            3
 101
 102 #define ACPI_PPAG_NUM_CHAINS            2
 103 #define ACPI_PPAG_NUM_SUB_BANDS         5
 104 #define ACPI_PPAG_WIFI_DATA_SIZE        ((ACPI_PPAG_NUM_CHAINS * \
 105                                         ACPI_PPAG_NUM_SUB_BANDS) + 3)
 106
 107 /* PPAG gain value bounds in 1/8 dBm */
 108 #define ACPI_PPAG_MIN_LB -16
 109 #define ACPI_PPAG_MAX_LB 24
 110 #define ACPI_PPAG_MIN_HB -16
 111 #define ACPI_PPAG_MAX_HB 40
 112
 113 struct iwl_sar_profile {
 114         bool enabled;
 115         u8 table[ACPI_SAR_TABLE_SIZE];
 116 };
 117
 118 struct iwl_geo_profile {
 119         u8 values[ACPI_GEO_TABLE_SIZE];
 120 };
 121
 122 #ifdef CONFIG_ACPI
 123
 124 struct iwl_fw_runtime;
 125
 126 void *iwl_acpi_get_object(struct device *dev, acpi_string method);
 127
 128 union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
 129                                          union acpi_object *data,
 130                                          int data_size, int *tbl_rev);
 131
 132 /**
 133  * iwl_acpi_get_mcc - read MCC from ACPI, if available
 134  *
 135  * @dev: the struct device
 136  * @mcc: output buffer (3 bytes) that will get the MCC
 137  *
 138  * This function tries to read the current MCC from ACPI if available.
 139  */
 140 int iwl_acpi_get_mcc(struct device *dev, char *mcc);
 141
 142 u64 iwl_acpi_get_pwr_limit(struct device *dev);
 143
 144 /*
 145  * iwl_acpi_get_eckv - read external clock validation from ACPI, if available
 146  *
 147  * @dev: the struct device
 148  * @extl_clk: output var (2 bytes) that will get the clk indication.
 149  *
 150  * This function tries to read the external clock indication
 151  * from ACPI if available.
 152  */
 153 int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk);
 154
 155 int iwl_sar_set_profile(union acpi_object *table,
 156                         struct iwl_sar_profile *profile,
 157                         bool enabled);
 158
 159 int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
 160                            __le16 per_chain_restriction[][IWL_NUM_SUB_BANDS],
 161                            int prof_a, int prof_b);
 162
 163 int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt);
 164
 165 int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt);
 166
 167 int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt);
 168
 169 bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt);
 170
 171 int iwl_validate_sar_geo_profile(struct iwl_fw_runtime *fwrt,
 172                                  struct iwl_host_cmd *cmd);
 173
 174 int iwl_sar_geo_init(struct iwl_fw_runtime *fwrt,
 175                      struct iwl_per_chain_offset_group *table);
 176
 177 #else /* CONFIG_ACPI */
 178
 179 static inline void *iwl_acpi_get_object(struct device *dev, acpi_string method)
 180 {
 181         return ERR_PTR(-ENOENT);
 182 }
 183
 184 static inline union acpi_object *iwl_acpi_get_wifi_pkg(struct device *dev,
 185                                                        union acpi_object *data,
 186                                                        int data_size,
 187                                                        int *tbl_rev)
 188 {
 189         return ERR_PTR(-ENOENT);
 190 }
 191
 192 static inline int iwl_acpi_get_mcc(struct device *dev, char *mcc)
 193 {
 194         return -ENOENT;
 195 }
 196
 197 static inline u64 iwl_acpi_get_pwr_limit(struct device *dev)
 198 {
 199         return 0;
 200 }
 201
 202 static inline int iwl_acpi_get_eckv(struct device *dev, u32 *extl_clk)
 203 {
 204         return -ENOENT;
 205 }
 206
 207 static inline int iwl_sar_set_profile(union acpi_object *table,
 208                                       struct iwl_sar_profile *profile,
 209                                       bool enabled)
 210 {
 211         return -ENOENT;
 212 }
 213
 214 static inline int iwl_sar_select_profile(struct iwl_fw_runtime *fwrt,
 215                            __le16 per_chain_restriction[][IWL_NUM_SUB_BANDS],
 216                            int prof_a, int prof_b)
 217 {
 218         return -ENOENT;
 219 }
 220
 221 static inline int iwl_sar_get_wrds_table(struct iwl_fw_runtime *fwrt)
 222 {
 223         return -ENOENT;
 224 }
 225
 226 static inline int iwl_sar_get_ewrd_table(struct iwl_fw_runtime *fwrt)
 227 {
 228         return -ENOENT;
 229 }
 230
 231 static inline int iwl_sar_get_wgds_table(struct iwl_fw_runtime *fwrt)
 232 {
 233         return -ENOENT;
 234 }
 235
 236 static inline bool iwl_sar_geo_support(struct iwl_fw_runtime *fwrt)
 237 {
 238         return false;
 239 }
 240
 241 static inline int iwl_validate_sar_geo_profile(struct iwl_fw_runtime *fwrt,
 242                                                struct iwl_host_cmd *cmd)
 243 {
 244         return -ENOENT;
 245 }
 246
 247 static inline int iwl_sar_geo_init(struct iwl_fw_runtime *fwrt,
 248                                    struct iwl_per_chain_offset_group *table)
 249 {
 250         return -ENOENT;
 251 }
 252
 253 #endif /* CONFIG_ACPI */
 254 #endif /* __iwl_fw_acpi__ */