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_runtime_h__ 61 #define __iwl_fw_runtime_h__ 62 63 #include "iwl-config.h" 64 #include "iwl-trans.h" 65 #include "img.h" 66 #include "fw/api/debug.h" 67 #include "fw/api/paging.h" 68 #include "fw/api/power.h" 69 #include "iwl-eeprom-parse.h" 70 #include "fw/acpi.h" 71 72 #define IWL_FW_DBG_DOMAIN IWL_FW_INI_DOMAIN_ALWAYS_ON 73 74 struct iwl_fw_runtime_ops { 75 int (*dump_start)(void *ctx); 76 void (*dump_end)(void *ctx); 77 bool (*fw_running)(void *ctx); 78 int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd); 79 bool (*d3_debug_enable)(void *ctx); 80 }; 81 82 #define MAX_NUM_LMAC 2 83 struct iwl_fwrt_shared_mem_cfg { 84 int num_lmacs; 85 int num_txfifo_entries; 86 struct { 87 u32 txfifo_size[TX_FIFO_MAX_NUM]; 88 u32 rxfifo1_size; 89 } lmac[MAX_NUM_LMAC]; 90 u32 rxfifo2_size; 91 u32 internal_txfifo_addr; 92 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 93 }; 94 95 #define IWL_FW_RUNTIME_DUMP_WK_NUM 5 96 97 /** 98 * struct iwl_fwrt_dump_data - dump data 99 * @trig: trigger the worker was scheduled upon 100 * @fw_pkt: packet received from FW 101 */ 102 struct iwl_fwrt_dump_data { 103 struct iwl_fw_ini_trigger_tlv *trig; 104 struct iwl_rx_packet *fw_pkt; 105 }; 106 107 /** 108 * struct iwl_fwrt_wk_data - dump worker data struct 109 * @idx: index of the worker 110 * @wk: worker 111 */ 112 struct iwl_fwrt_wk_data { 113 u8 idx; 114 struct delayed_work wk; 115 struct iwl_fwrt_dump_data dump_data; 116 }; 117 118 /** 119 * struct iwl_txf_iter_data - Tx fifo iterator data struct 120 * @fifo: fifo number 121 * @lmac: lmac number 122 * @fifo_size: fifo size 123 * @internal_txf: non zero if fifo is internal Tx fifo 124 */ 125 struct iwl_txf_iter_data { 126 int fifo; 127 int lmac; 128 u32 fifo_size; 129 u8 internal_txf; 130 }; 131 132 /** 133 * enum iwl_fw_runtime_status - fw runtime status flags 134 * @STATUS_GEN_ACTIVE_TRIGS: generating active trigger list 135 */ 136 enum iwl_fw_runtime_status { 137 STATUS_GEN_ACTIVE_TRIGS, 138 }; 139 140 /** 141 * struct iwl_fw_runtime - runtime data for firmware 142 * @fw: firmware image 143 * @cfg: NIC configuration 144 * @dev: device pointer 145 * @ops: user ops 146 * @ops_ctx: user ops context 147 * @fw_paging_db: paging database 148 * @num_of_paging_blk: number of paging blocks 149 * @num_of_pages_in_last_blk: number of pages in the last block 150 * @smem_cfg: saved firmware SMEM configuration 151 * @cur_fw_img: current firmware image, must be maintained by 152 * the driver by calling &iwl_fw_set_current_image() 153 * @status: &enum iwl_fw_runtime_status 154 * @dump: debug dump data 155 */ 156 struct iwl_fw_runtime { 157 struct iwl_trans *trans; 158 const struct iwl_fw *fw; 159 struct device *dev; 160 161 const struct iwl_fw_runtime_ops *ops; 162 void *ops_ctx; 163 164 /* Paging */ 165 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; 166 u16 num_of_paging_blk; 167 u16 num_of_pages_in_last_blk; 168 169 enum iwl_ucode_type cur_fw_img; 170 171 /* memory configuration */ 172 struct iwl_fwrt_shared_mem_cfg smem_cfg; 173 174 unsigned long status; 175 176 /* debug */ 177 struct { 178 const struct iwl_fw_dump_desc *desc; 179 bool monitor_only; 180 struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM]; 181 unsigned long active_wks; 182 183 u8 conf; 184 185 /* ts of the beginning of a non-collect fw dbg data period */ 186 unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM]; 187 u32 *d3_debug_data; 188 u32 lmac_err_id[MAX_NUM_LMAC]; 189 u32 umac_err_id; 190 191 struct iwl_txf_iter_data txf_iter_data; 192 193 struct { 194 u8 type; 195 u8 subtype; 196 u32 lmac_major; 197 u32 lmac_minor; 198 u32 umac_major; 199 u32 umac_minor; 200 } fw_ver; 201 } dump; 202 #ifdef CONFIG_IWLWIFI_DEBUGFS 203 struct { 204 struct delayed_work wk; 205 u32 delay; 206 u64 seq; 207 } timestamp; 208 bool tpc_enabled; 209 #endif /* CONFIG_IWLWIFI_DEBUGFS */ 210 #ifdef CONFIG_ACPI 211 struct iwl_sar_profile sar_profiles[ACPI_SAR_PROFILE_NUM]; 212 u8 sar_chain_a_profile; 213 u8 sar_chain_b_profile; 214 struct iwl_geo_profile geo_profiles[ACPI_NUM_GEO_PROFILES]; 215 u32 geo_rev; 216 struct iwl_ppag_table_cmd ppag_table; 217 #endif 218 }; 219 220 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, 221 const struct iwl_fw *fw, 222 const struct iwl_fw_runtime_ops *ops, void *ops_ctx, 223 struct dentry *dbgfs_dir); 224 225 static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt) 226 { 227 int i; 228 229 kfree(fwrt->dump.d3_debug_data); 230 fwrt->dump.d3_debug_data = NULL; 231 232 iwl_dbg_tlv_del_timers(fwrt->trans); 233 for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++) 234 cancel_delayed_work_sync(&fwrt->dump.wks[i].wk); 235 } 236 237 void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt); 238 239 void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt); 240 241 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, 242 enum iwl_ucode_type cur_fw_img) 243 { 244 fwrt->cur_fw_img = cur_fw_img; 245 } 246 247 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); 248 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); 249 250 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); 251 252 #endif /* __iwl_fw_runtime_h__ */ 253