[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
 *
 * 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
 * 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 "iwl-eeprom-parse.h"

struct iwl_fw_runtime_ops {
	int (*dump_start)(void *ctx);
	void (*dump_end)(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];
};

enum iwl_fw_runtime_status {
	IWL_FWRT_STATUS_DUMPING = 0,
};

/**
 * 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
 * @status: status flags
 * @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;

	unsigned long status;

	/* 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;
		const struct iwl_fw_dbg_trigger_tlv *trig;
		struct delayed_work wk;

		u8 conf;

		/* ts of the beginning of a non-collect fw dbg data period */
		unsigned long non_collect_ts_start[FW_DBG_TRIGGER_MAX - 1];
	} dump;
#ifdef CONFIG_IWLWIFI_DEBUGFS
	struct {
		struct delayed_work wk;
		u32 delay;
		u64 seq;
	} timestamp;
#endif /* CONFIG_IWLWIFI_DEBUGFS */
};

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);

void iwl_fw_runtime_exit(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);

void iwl_fwrt_handle_notification(struct iwl_fw_runtime *fwrt,
				  struct iwl_rx_cmd_buffer *rxb);
struct iwl_nvm_data *iwl_fw_get_nvm(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
	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"
d172a5ef JB	64	#include "fw/api/debug.h"
d172a5ef JB	65	#include "fw/api/paging.h"
c135cb56	66	#include "iwl-eeprom-parse.h"
235acb18	67
7174beb6 JB	68	struct iwl_fw_runtime_ops {
	69	int (dump_start)(void ctx);
	70	void (dump_end)(void ctx);
	71	};
	72
d0b813fc JB	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
7174beb6 JB	86	enum iwl_fw_runtime_status {
	87	IWL_FWRT_STATUS_DUMPING = 0,
	88	};
	89
235acb18 JB	90	/**
	91	* struct iwl_fw_runtime - runtime data for firmware
	92	* @fw: firmware image
	93	* @cfg: NIC configuration
	94	* @dev: device pointer
7174beb6 JB	95	* @ops: user ops
	96	* @ops_ctx: user ops context
	97	* @status: status flags
235acb18 JB	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
d0b813fc	101	* @smem_cfg: saved firmware SMEM configuration
702e975d JB	102	* @cur_fw_img: current firmware image, must be maintained by
702e975d JB	103	* the driver by calling &iwl_fw_set_current_image()
7174beb6	104	* @dump: debug dump data
235acb18 JB	105	*/
	106	struct iwl_fw_runtime {
	107	struct iwl_trans *trans;
	108	const struct iwl_fw *fw;
	109	struct device *dev;
	110
7174beb6 JB	111	const struct iwl_fw_runtime_ops *ops;
	112	void *ops_ctx;
	113
	114	unsigned long status;
	115
235acb18 JB	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;
d0b813fc	120
702e975d JB	121	enum iwl_ucode_type cur_fw_img;
702e975d JB	122
d0b813fc JB	123	/* memory configuration */
d0b813fc JB	124	struct iwl_fwrt_shared_mem_cfg smem_cfg;
7174beb6 JB	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;
93b167c1 MG	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 */
235acb18 JB	144	};
235acb18 JB	145
7174beb6	146	void iwl_fw_runtime_init(struct iwl_fw_runtime fwrt, struct iwl_trans trans,
93b167c1 MG	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);
235acb18	152
702e975d JB	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
235acb18 JB	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
d0b813fc JB	162	void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
d0b813fc JB	163
f2e66c8d MG	164	void iwl_fwrt_handle_notification(struct iwl_fw_runtime *fwrt,
f2e66c8d MG	165	struct iwl_rx_cmd_buffer *rxb);
c135cb56	166	struct iwl_nvm_data iwl_fw_get_nvm(struct iwl_fw_runtime fwrt);
f2e66c8d	167
235acb18	168	#endif /* __iwl_fw_runtime_h__ */