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 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 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 }; 75 76 #define MAX_NUM_LMAC 2 77 struct iwl_fwrt_shared_mem_cfg { 78 int num_lmacs; 79 int num_txfifo_entries; 80 struct { 81 u32 txfifo_size[TX_FIFO_MAX_NUM]; 82 u32 rxfifo1_size; 83 } lmac[MAX_NUM_LMAC]; 84 u32 rxfifo2_size; 85 u32 internal_txfifo_addr; 86 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 87 }; 88 89 enum iwl_fw_runtime_status { 90 IWL_FWRT_STATUS_DUMPING = 0, 91 }; 92 93 /** 94 * struct iwl_fw_runtime - runtime data for firmware 95 * @fw: firmware image 96 * @cfg: NIC configuration 97 * @dev: device pointer 98 * @ops: user ops 99 * @ops_ctx: user ops context 100 * @status: status flags 101 * @fw_paging_db: paging database 102 * @num_of_paging_blk: number of paging blocks 103 * @num_of_pages_in_last_blk: number of pages in the last block 104 * @smem_cfg: saved firmware SMEM configuration 105 * @cur_fw_img: current firmware image, must be maintained by 106 * the driver by calling &iwl_fw_set_current_image() 107 * @dump: debug dump data 108 */ 109 struct iwl_fw_runtime { 110 struct iwl_trans *trans; 111 const struct iwl_fw *fw; 112 struct device *dev; 113 114 const struct iwl_fw_runtime_ops *ops; 115 void *ops_ctx; 116 117 unsigned long status; 118 119 /* Paging */ 120 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; 121 u16 num_of_paging_blk; 122 u16 num_of_pages_in_last_blk; 123 124 enum iwl_ucode_type cur_fw_img; 125 126 /* memory configuration */ 127 struct iwl_fwrt_shared_mem_cfg smem_cfg; 128 129 /* debug */ 130 struct { 131 const struct iwl_fw_dump_desc *desc; 132 const struct iwl_fw_dbg_trigger_tlv *trig; 133 struct delayed_work wk; 134 135 u8 conf; 136 137 /* ts of the beginning of a non-collect fw dbg data period */ 138 unsigned long non_collect_ts_start[FW_DBG_TRIGGER_MAX - 1]; 139 } dump; 140 #ifdef CONFIG_IWLWIFI_DEBUGFS 141 struct { 142 struct delayed_work wk; 143 u32 delay; 144 u64 seq; 145 } timestamp; 146 #endif /* CONFIG_IWLWIFI_DEBUGFS */ 147 }; 148 149 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, 150 const struct iwl_fw *fw, 151 const struct iwl_fw_runtime_ops *ops, void *ops_ctx, 152 struct dentry *dbgfs_dir); 153 154 void iwl_fw_runtime_exit(struct iwl_fw_runtime *fwrt); 155 156 void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt); 157 158 void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt); 159 160 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, 161 enum iwl_ucode_type cur_fw_img) 162 { 163 fwrt->cur_fw_img = cur_fw_img; 164 } 165 166 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); 167 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); 168 169 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); 170 171 void iwl_fwrt_handle_notification(struct iwl_fw_runtime *fwrt, 172 struct iwl_rx_cmd_buffer *rxb); 173 174 #endif /* __iwl_fw_runtime_h__ */ 175