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