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