Loading...
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2017 Intel Deutschland GmbH
4 * Copyright (C) 2018-2023 Intel Corporation
5 */
6#ifndef __iwl_fw_runtime_h__
7#define __iwl_fw_runtime_h__
8
9#include "iwl-config.h"
10#include "iwl-trans.h"
11#include "img.h"
12#include "fw/api/debug.h"
13#include "fw/api/paging.h"
14#include "fw/api/power.h"
15#include "iwl-eeprom-parse.h"
16#include "fw/acpi.h"
17
18struct iwl_fw_runtime_ops {
19 void (*dump_start)(void *ctx);
20 void (*dump_end)(void *ctx);
21 bool (*fw_running)(void *ctx);
22 int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd);
23 bool (*d3_debug_enable)(void *ctx);
24};
25
26#define MAX_NUM_LMAC 2
27#define MAX_NUM_TCM 2
28#define MAX_NUM_RCM 2
29struct iwl_fwrt_shared_mem_cfg {
30 int num_lmacs;
31 int num_txfifo_entries;
32 struct {
33 u32 txfifo_size[TX_FIFO_MAX_NUM];
34 u32 rxfifo1_size;
35 } lmac[MAX_NUM_LMAC];
36 u32 rxfifo2_size;
37 u32 rxfifo2_control_size;
38 u32 internal_txfifo_addr;
39 u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
40};
41
42#define IWL_FW_RUNTIME_DUMP_WK_NUM 5
43
44/**
45 * struct iwl_fwrt_dump_data - dump data
46 * @trig: trigger the worker was scheduled upon
47 * @fw_pkt: packet received from FW
48 */
49struct iwl_fwrt_dump_data {
50 union {
51 struct {
52 struct iwl_fw_ini_trigger_tlv *trig;
53 struct iwl_rx_packet *fw_pkt;
54 };
55 struct {
56 const struct iwl_fw_dump_desc *desc;
57 bool monitor_only;
58 };
59 };
60};
61
62/**
63 * struct iwl_fwrt_wk_data - dump worker data struct
64 * @idx: index of the worker
65 * @wk: worker
66 */
67struct iwl_fwrt_wk_data {
68 u8 idx;
69 struct delayed_work wk;
70 struct iwl_fwrt_dump_data dump_data;
71};
72
73/**
74 * struct iwl_txf_iter_data - Tx fifo iterator data struct
75 * @fifo: fifo number
76 * @lmac: lmac number
77 * @fifo_size: fifo size
78 * @internal_txf: non zero if fifo is internal Tx fifo
79 */
80struct iwl_txf_iter_data {
81 int fifo;
82 int lmac;
83 u32 fifo_size;
84 u8 internal_txf;
85};
86
87/**
88 * struct iwl_fw_runtime - runtime data for firmware
89 * @fw: firmware image
90 * @cfg: NIC configuration
91 * @dev: device pointer
92 * @ops: user ops
93 * @ops_ctx: user ops context
94 * @fw_paging_db: paging database
95 * @num_of_paging_blk: number of paging blocks
96 * @num_of_pages_in_last_blk: number of pages in the last block
97 * @smem_cfg: saved firmware SMEM configuration
98 * @cur_fw_img: current firmware image, must be maintained by
99 * the driver by calling &iwl_fw_set_current_image()
100 * @dump: debug dump data
101 * @uats_enabled: VLP or AFC AP is enabled
102 * @uats_table: AP type table
103 */
104struct iwl_fw_runtime {
105 struct iwl_trans *trans;
106 const struct iwl_fw *fw;
107 struct device *dev;
108
109 const struct iwl_fw_runtime_ops *ops;
110 void *ops_ctx;
111
112 const struct iwl_dump_sanitize_ops *sanitize_ops;
113 void *sanitize_ctx;
114
115 /* Paging */
116 struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
117 u16 num_of_paging_blk;
118 u16 num_of_pages_in_last_blk;
119
120 enum iwl_ucode_type cur_fw_img;
121
122 /* memory configuration */
123 struct iwl_fwrt_shared_mem_cfg smem_cfg;
124
125 /* debug */
126 struct {
127 struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM];
128 unsigned long active_wks;
129
130 u8 conf;
131
132 /* ts of the beginning of a non-collect fw dbg data period */
133 unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM];
134 u32 *d3_debug_data;
135 u32 lmac_err_id[MAX_NUM_LMAC];
136 u32 tcm_err_id[MAX_NUM_TCM];
137 u32 rcm_err_id[MAX_NUM_RCM];
138 u32 umac_err_id;
139
140 struct iwl_txf_iter_data txf_iter_data;
141
142 struct {
143 u8 type;
144 u8 subtype;
145 u32 lmac_major;
146 u32 lmac_minor;
147 u32 umac_major;
148 u32 umac_minor;
149 } fw_ver;
150 } dump;
151 struct {
152#ifdef CONFIG_IWLWIFI_DEBUGFS
153 struct delayed_work wk;
154 u32 delay;
155#endif
156 u64 seq;
157 } timestamp;
158#ifdef CONFIG_IWLWIFI_DEBUGFS
159 bool tpc_enabled;
160#endif /* CONFIG_IWLWIFI_DEBUGFS */
161#ifdef CONFIG_ACPI
162 struct iwl_sar_profile sar_profiles[ACPI_SAR_PROFILE_NUM];
163 u8 sar_chain_a_profile;
164 u8 sar_chain_b_profile;
165 struct iwl_geo_profile geo_profiles[ACPI_NUM_GEO_PROFILES_REV3];
166 u32 geo_rev;
167 u32 geo_num_profiles;
168 bool geo_enabled;
169 struct iwl_ppag_chain ppag_chains[IWL_NUM_CHAIN_LIMITS];
170 u32 ppag_flags;
171 u32 ppag_ver;
172 bool ppag_table_valid;
173 struct iwl_sar_offset_mapping_cmd sgom_table;
174 bool sgom_enabled;
175 u8 reduced_power_flags;
176 bool uats_enabled;
177 struct iwl_uats_table_cmd uats_table;
178#endif
179};
180
181void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans,
182 const struct iwl_fw *fw,
183 const struct iwl_fw_runtime_ops *ops, void *ops_ctx,
184 const struct iwl_dump_sanitize_ops *sanitize_ops,
185 void *sanitize_ctx,
186 struct dentry *dbgfs_dir);
187
188static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt)
189{
190 int i;
191
192 kfree(fwrt->dump.d3_debug_data);
193 fwrt->dump.d3_debug_data = NULL;
194
195 iwl_dbg_tlv_del_timers(fwrt->trans);
196 for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++)
197 cancel_delayed_work_sync(&fwrt->dump.wks[i].wk);
198}
199
200void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);
201
202void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);
203
204static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt,
205 enum iwl_ucode_type cur_fw_img)
206{
207 fwrt->cur_fw_img = cur_fw_img;
208}
209
210int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
211void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
212
213void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
214int iwl_set_soc_latency(struct iwl_fw_runtime *fwrt);
215int iwl_configure_rxq(struct iwl_fw_runtime *fwrt);
216
217#endif /* __iwl_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 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
70struct 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
77struct 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
89enum 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 */
109struct 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
149void 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
154void iwl_fw_runtime_exit(struct iwl_fw_runtime *fwrt);
155
156void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);
157
158void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);
159
160static 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
166int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
167void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
168
169void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
170
171void iwl_fwrt_handle_notification(struct iwl_fw_runtime *fwrt,
172 struct iwl_rx_cmd_buffer *rxb);
173struct iwl_nvm_data *iwl_fw_get_nvm(struct iwl_fw_runtime *fwrt);
174
175#endif /* __iwl_fw_runtime_h__ */