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