[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 "api.h"

#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];
};

/**
 * struct iwl_fw_runtime - runtime data for firmware
 * @fw: firmware image
 * @cfg: NIC configuration
 * @dev: device pointer
 * @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
 */
struct iwl_fw_runtime {
	struct iwl_trans *trans;
	const struct iwl_fw *fw;
	struct device *dev;

	/* 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;

	/* memory configuration */
	struct iwl_fwrt_shared_mem_cfg smem_cfg;
};

static inline void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt,
				       struct iwl_trans *trans,
				       const struct iwl_fw *fw)
{
	memset(fwrt, 0, sizeof(*fwrt));
	fwrt->trans = trans;
	fwrt->fw = fw;
	fwrt->dev = trans->dev;
}

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
	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 "api.h"
65
d0b813fc JB	66	#define MAX_NUM_LMAC 2
	67	struct iwl_fwrt_shared_mem_cfg {
	68	int num_lmacs;
	69	int num_txfifo_entries;
	70	struct {
	71	u32 txfifo_size[TX_FIFO_MAX_NUM];
	72	u32 rxfifo1_size;
	73	} lmac[MAX_NUM_LMAC];
	74	u32 rxfifo2_size;
	75	u32 internal_txfifo_addr;
	76	u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
	77	};
	78
235acb18 JB	79	/**
	80	* struct iwl_fw_runtime - runtime data for firmware
	81	* @fw: firmware image
	82	* @cfg: NIC configuration
	83	* @dev: device pointer
	84	* @fw_paging_db: paging database
	85	* @num_of_paging_blk: number of paging blocks
	86	* @num_of_pages_in_last_blk: number of pages in the last block
d0b813fc	87	* @smem_cfg: saved firmware SMEM configuration
235acb18 JB	88	*/
	89	struct iwl_fw_runtime {
	90	struct iwl_trans *trans;
	91	const struct iwl_fw *fw;
	92	struct device *dev;
	93
	94	/* Paging */
	95	struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
	96	u16 num_of_paging_blk;
	97	u16 num_of_pages_in_last_blk;
d0b813fc JB	98
	99	/* memory configuration */
	100	struct iwl_fwrt_shared_mem_cfg smem_cfg;
235acb18 JB	101	};
	102
	103	static inline void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt,
	104	struct iwl_trans *trans,
	105	const struct iwl_fw *fw)
	106	{
	107	memset(fwrt, 0, sizeof(*fwrt));
	108	fwrt->trans = trans;
	109	fwrt->fw = fw;
	110	fwrt->dev = trans->dev;
	111	}
	112
	113	int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
	114	void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
	115
d0b813fc JB	116	void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
d0b813fc JB	117
235acb18	118	#endif /* __iwl_fw_runtime_h__ */