[linux-2.6-block.git] / drivers / net / wireless / intel / iwlwifi / fw / runtime.h

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2017 Intel Deutschland GmbH
 * Copyright (C) 2018-2019 Intel Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * The full GNU General Public License is included in this distribution
 * in the file called COPYING.
 *
 * Contact Information:
 *  Intel Linux Wireless <linuxwifi@intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2017 Intel Deutschland GmbH
 * Copyright (C) 2018-2019 Intel Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
#ifndef __iwl_fw_runtime_h__
#define __iwl_fw_runtime_h__

#include "iwl-config.h"
#include "iwl-trans.h"
#include "img.h"
#include "fw/api/debug.h"
#include "fw/api/paging.h"
#include "fw/api/power.h"
#include "iwl-eeprom-parse.h"
#include "fw/acpi.h"

struct iwl_fw_runtime_ops {
	int (*dump_start)(void *ctx);
	void (*dump_end)(void *ctx);
	bool (*fw_running)(void *ctx);
	int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd);
	bool (*d3_debug_enable)(void *ctx);
};

#define MAX_NUM_LMAC 2
struct iwl_fwrt_shared_mem_cfg {
	int num_lmacs;
	int num_txfifo_entries;
	struct {
		u32 txfifo_size[TX_FIFO_MAX_NUM];
		u32 rxfifo1_size;
	} lmac[MAX_NUM_LMAC];
	u32 rxfifo2_size;
	u32 internal_txfifo_addr;
	u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
};

#define IWL_FW_RUNTIME_DUMP_WK_NUM 5

/**
 * struct iwl_fwrt_dump_data - dump data
 * @trig: trigger the worker was scheduled upon
 * @fw_pkt: packet received from FW
 */
struct iwl_fwrt_dump_data {
	struct iwl_fw_ini_trigger_tlv *trig;
	struct iwl_rx_packet *fw_pkt;
};

/**
 * struct iwl_fwrt_wk_data - dump worker data struct
 * @idx: index of the worker
 * @wk: worker
 */
struct iwl_fwrt_wk_data  {
	u8 idx;
	struct delayed_work wk;
	struct iwl_fwrt_dump_data dump_data;
};

/**
 * struct iwl_txf_iter_data - Tx fifo iterator data struct
 * @fifo: fifo number
 * @lmac: lmac number
 * @fifo_size: fifo size
 * @internal_txf: non zero if fifo is  internal Tx fifo
 */
struct iwl_txf_iter_data {
	int fifo;
	int lmac;
	u32 fifo_size;
	u8 internal_txf;
};

/**
 * struct iwl_fw_runtime - runtime data for firmware
 * @fw: firmware image
 * @cfg: NIC configuration
 * @dev: device pointer
 * @ops: user ops
 * @ops_ctx: user ops context
 * @fw_paging_db: paging database
 * @num_of_paging_blk: number of paging blocks
 * @num_of_pages_in_last_blk: number of pages in the last block
 * @smem_cfg: saved firmware SMEM configuration
 * @cur_fw_img: current firmware image, must be maintained by
 *	the driver by calling &iwl_fw_set_current_image()
 * @dump: debug dump data
 */
struct iwl_fw_runtime {
	struct iwl_trans *trans;
	const struct iwl_fw *fw;
	struct device *dev;

	const struct iwl_fw_runtime_ops *ops;
	void *ops_ctx;

	/* Paging */
	struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
	u16 num_of_paging_blk;
	u16 num_of_pages_in_last_blk;

	enum iwl_ucode_type cur_fw_img;

	/* memory configuration */
	struct iwl_fwrt_shared_mem_cfg smem_cfg;

	/* debug */
	struct {
		const struct iwl_fw_dump_desc *desc;
		bool monitor_only;
		struct iwl_fwrt_wk_data wks[IWL_FW_RUNTIME_DUMP_WK_NUM];
		unsigned long active_wks;

		u8 conf;

		/* ts of the beginning of a non-collect fw dbg data period */
		unsigned long non_collect_ts_start[IWL_FW_INI_TIME_POINT_NUM];
		u32 *d3_debug_data;
		u32 lmac_err_id[MAX_NUM_LMAC];
		u32 umac_err_id;

		struct iwl_txf_iter_data txf_iter_data;

		struct {
			u8 type;
			u8 subtype;
			u32 lmac_major;
			u32 lmac_minor;
			u32 umac_major;
			u32 umac_minor;
		} fw_ver;
	} dump;
#ifdef CONFIG_IWLWIFI_DEBUGFS
	struct {
		struct delayed_work wk;
		u32 delay;
		u64 seq;
	} timestamp;
	bool tpc_enabled;
#endif /* CONFIG_IWLWIFI_DEBUGFS */
#ifdef CONFIG_ACPI
	struct iwl_sar_profile sar_profiles[ACPI_SAR_PROFILE_NUM];
	u8 sar_chain_a_profile;
	u8 sar_chain_b_profile;
	struct iwl_geo_profile geo_profiles[ACPI_NUM_GEO_PROFILES];
	u32 geo_rev;
	struct iwl_ppag_table_cmd ppag_table;
#endif
};

void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans,
			const struct iwl_fw *fw,
			const struct iwl_fw_runtime_ops *ops, void *ops_ctx,
			struct dentry *dbgfs_dir);

static inline void iwl_fw_runtime_free(struct iwl_fw_runtime *fwrt)
{
	int i;

	kfree(fwrt->dump.d3_debug_data);
	fwrt->dump.d3_debug_data = NULL;

	iwl_dbg_tlv_del_timers(fwrt->trans);
	for (i = 0; i < IWL_FW_RUNTIME_DUMP_WK_NUM; i++)
		cancel_delayed_work_sync(&fwrt->dump.wks[i].wk);
}

void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);

void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);

static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt,
					    enum iwl_ucode_type cur_fw_img)
{
	fwrt->cur_fw_img = cur_fw_img;
}

int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);

void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);

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