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 * 10 * This program is free software; you can redistribute it and/or modify 11 * it under the terms of version 2 of the GNU General Public License as 12 * published by the Free Software Foundation. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * The full GNU General Public License is included in this distribution 20 * in the file called COPYING. 21 * 22 * Contact Information: 23 * Intel Linux Wireless <linuxwifi@intel.com> 24 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2017 Intel Deutschland GmbH 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * * Neither the name Intel Corporation nor the names of its 42 * contributors may be used to endorse or promote products derived 43 * from this software without specific prior written permission. 44 * 45 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 46 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 47 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 48 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 49 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 50 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 51 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 52 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 53 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 54 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 55 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 56 * 57 *****************************************************************************/ 58 #ifndef __iwl_fw_runtime_h__ 59 #define __iwl_fw_runtime_h__ 60 61 #include "iwl-config.h" 62 #include "iwl-trans.h" 63 #include "img.h" 64 #include "fw/api/debug.h" 65 #include "fw/api/paging.h" 66 #include "iwl-eeprom-parse.h" 67 68 struct iwl_fw_runtime_ops { 69 int (*dump_start)(void *ctx); 70 void (*dump_end)(void *ctx); 71 }; 72 73 #define MAX_NUM_LMAC 2 74 struct iwl_fwrt_shared_mem_cfg { 75 int num_lmacs; 76 int num_txfifo_entries; 77 struct { 78 u32 txfifo_size[TX_FIFO_MAX_NUM]; 79 u32 rxfifo1_size; 80 } lmac[MAX_NUM_LMAC]; 81 u32 rxfifo2_size; 82 u32 internal_txfifo_addr; 83 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 84 }; 85 86 enum iwl_fw_runtime_status { 87 IWL_FWRT_STATUS_DUMPING = 0, 88 }; 89 90 /** 91 * struct iwl_fw_runtime - runtime data for firmware 92 * @fw: firmware image 93 * @cfg: NIC configuration 94 * @dev: device pointer 95 * @ops: user ops 96 * @ops_ctx: user ops context 97 * @status: status flags 98 * @fw_paging_db: paging database 99 * @num_of_paging_blk: number of paging blocks 100 * @num_of_pages_in_last_blk: number of pages in the last block 101 * @smem_cfg: saved firmware SMEM configuration 102 * @cur_fw_img: current firmware image, must be maintained by 103 * the driver by calling &iwl_fw_set_current_image() 104 * @dump: debug dump data 105 */ 106 struct iwl_fw_runtime { 107 struct iwl_trans *trans; 108 const struct iwl_fw *fw; 109 struct device *dev; 110 111 const struct iwl_fw_runtime_ops *ops; 112 void *ops_ctx; 113 114 unsigned long status; 115 116 /* Paging */ 117 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS]; 118 u16 num_of_paging_blk; 119 u16 num_of_pages_in_last_blk; 120 121 enum iwl_ucode_type cur_fw_img; 122 123 /* memory configuration */ 124 struct iwl_fwrt_shared_mem_cfg smem_cfg; 125 126 /* debug */ 127 struct { 128 const struct iwl_fw_dump_desc *desc; 129 const struct iwl_fw_dbg_trigger_tlv *trig; 130 struct delayed_work wk; 131 132 u8 conf; 133 134 /* ts of the beginning of a non-collect fw dbg data period */ 135 unsigned long non_collect_ts_start[FW_DBG_TRIGGER_MAX - 1]; 136 } dump; 137 #ifdef CONFIG_IWLWIFI_DEBUGFS 138 struct { 139 struct delayed_work wk; 140 u32 delay; 141 u64 seq; 142 } timestamp; 143 #endif /* CONFIG_IWLWIFI_DEBUGFS */ 144 }; 145 146 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans, 147 const struct iwl_fw *fw, 148 const struct iwl_fw_runtime_ops *ops, void *ops_ctx, 149 struct dentry *dbgfs_dir); 150 151 void iwl_fw_runtime_exit(struct iwl_fw_runtime *fwrt); 152 153 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt, 154 enum iwl_ucode_type cur_fw_img) 155 { 156 fwrt->cur_fw_img = cur_fw_img; 157 } 158 159 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type); 160 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt); 161 162 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt); 163 164 void iwl_fwrt_handle_notification(struct iwl_fw_runtime *fwrt, 165 struct iwl_rx_cmd_buffer *rxb); 166 struct iwl_nvm_data *iwl_fw_get_nvm(struct iwl_fw_runtime *fwrt); 167 168 #endif /* __iwl_fw_runtime_h__ */ 169