drivers/net/wireless/intel/iwlwifi/fw/runtime.h

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