|  | /****************************************************************************** | 
|  | * | 
|  | * 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. | 
|  | * | 
|  | * 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_context_info_file_h__ | 
|  | #define __iwl_context_info_file_h__ | 
|  |  | 
|  | /* maximmum number of DRAM map entries supported by FW */ | 
|  | #define IWL_MAX_DRAM_ENTRY	64 | 
|  | #define CSR_CTXT_INFO_BA	0x40 | 
|  |  | 
|  | /** | 
|  | * enum iwl_context_info_flags - Context information control flags | 
|  | * @IWL_CTXT_INFO_AUTO_FUNC_INIT: If set, FW will not wait before interrupting | 
|  | *	the init done for driver command that configures several system modes | 
|  | * @IWL_CTXT_INFO_EARLY_DEBUG: enable early debug | 
|  | * @IWL_CTXT_INFO_ENABLE_CDMP: enable core dump | 
|  | * @IWL_CTXT_INFO_RB_SIZE_4K: Use 4K RB size (the default is 2K) | 
|  | * @IWL_CTXT_INFO_RB_CB_SIZE_POS: position of the RBD Cyclic Buffer Size | 
|  | *	exponent, the actual size is 2**value, valid sizes are 8-2048. | 
|  | *	The value is four bits long. Maximum valid exponent is 12 | 
|  | * @IWL_CTXT_INFO_TFD_FORMAT_LONG: use long TFD Format (the | 
|  | *	default is short format - not supported by the driver) | 
|  | */ | 
|  | enum iwl_context_info_flags { | 
|  | IWL_CTXT_INFO_AUTO_FUNC_INIT	= BIT(0), | 
|  | IWL_CTXT_INFO_EARLY_DEBUG	= BIT(1), | 
|  | IWL_CTXT_INFO_ENABLE_CDMP	= BIT(2), | 
|  | IWL_CTXT_INFO_RB_SIZE_4K	= BIT(3), | 
|  | IWL_CTXT_INFO_RB_CB_SIZE_POS	= 4, | 
|  | IWL_CTXT_INFO_TFD_FORMAT_LONG	= BIT(8), | 
|  | }; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_version - version structure | 
|  | * @mac_id: SKU and revision id | 
|  | * @version: context information version id | 
|  | * @size: the size of the context information in DWs | 
|  | */ | 
|  | struct iwl_context_info_version { | 
|  | __le16 mac_id; | 
|  | __le16 version; | 
|  | __le16 size; | 
|  | __le16 reserved; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_control - version structure | 
|  | * @control_flags: context information flags see &enum iwl_context_info_flags | 
|  | */ | 
|  | struct iwl_context_info_control { | 
|  | __le32 control_flags; | 
|  | __le32 reserved; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_dram - images DRAM map | 
|  | * each entry in the map represents a DRAM chunk of up to 32 KB | 
|  | * @umac_img: UMAC image DRAM map | 
|  | * @lmac_img: LMAC image DRAM map | 
|  | * @virtual_img: paged image DRAM map | 
|  | */ | 
|  | struct iwl_context_info_dram { | 
|  | __le64 umac_img[IWL_MAX_DRAM_ENTRY]; | 
|  | __le64 lmac_img[IWL_MAX_DRAM_ENTRY]; | 
|  | __le64 virtual_img[IWL_MAX_DRAM_ENTRY]; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_rbd_cfg - RBDs configuration | 
|  | * @free_rbd_addr: default queue free RB CB base address | 
|  | * @used_rbd_addr: default queue used RB CB base address | 
|  | * @status_wr_ptr: default queue used RB status write pointer | 
|  | */ | 
|  | struct iwl_context_info_rbd_cfg { | 
|  | __le64 free_rbd_addr; | 
|  | __le64 used_rbd_addr; | 
|  | __le64 status_wr_ptr; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_hcmd_cfg  - command queue configuration | 
|  | * @cmd_queue_addr: address of command queue | 
|  | * @cmd_queue_size: number of entries | 
|  | */ | 
|  | struct iwl_context_info_hcmd_cfg { | 
|  | __le64 cmd_queue_addr; | 
|  | u8 cmd_queue_size; | 
|  | u8 reserved[7]; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_dump_cfg - Core Dump configuration | 
|  | * @core_dump_addr: core dump (debug DRAM address) start address | 
|  | * @core_dump_size: size, in DWs | 
|  | */ | 
|  | struct iwl_context_info_dump_cfg { | 
|  | __le64 core_dump_addr; | 
|  | __le32 core_dump_size; | 
|  | __le32 reserved; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_pnvm_cfg - platform NVM data configuration | 
|  | * @platform_nvm_addr: Platform NVM data start address | 
|  | * @platform_nvm_size: size in DWs | 
|  | */ | 
|  | struct iwl_context_info_pnvm_cfg { | 
|  | __le64 platform_nvm_addr; | 
|  | __le32 platform_nvm_size; | 
|  | __le32 reserved; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info_early_dbg_cfg - early debug configuration for | 
|  | *	dumping DRAM addresses | 
|  | * @early_debug_addr: early debug start address | 
|  | * @early_debug_size: size in DWs | 
|  | */ | 
|  | struct iwl_context_info_early_dbg_cfg { | 
|  | __le64 early_debug_addr; | 
|  | __le32 early_debug_size; | 
|  | __le32 reserved; | 
|  | } __packed; | 
|  |  | 
|  | /* | 
|  | * struct iwl_context_info - device INIT configuration | 
|  | * @version: version information of context info and HW | 
|  | * @control: control flags of FH configurations | 
|  | * @rbd_cfg: default RX queue configuration | 
|  | * @hcmd_cfg: command queue configuration | 
|  | * @dump_cfg: core dump data | 
|  | * @edbg_cfg: early debug configuration | 
|  | * @pnvm_cfg: platform nvm configuration | 
|  | * @dram: firmware image addresses in DRAM | 
|  | */ | 
|  | struct iwl_context_info { | 
|  | struct iwl_context_info_version version; | 
|  | struct iwl_context_info_control control; | 
|  | __le64 reserved0; | 
|  | struct iwl_context_info_rbd_cfg rbd_cfg; | 
|  | struct iwl_context_info_hcmd_cfg hcmd_cfg; | 
|  | __le32 reserved1[4]; | 
|  | struct iwl_context_info_dump_cfg dump_cfg; | 
|  | struct iwl_context_info_early_dbg_cfg edbg_cfg; | 
|  | struct iwl_context_info_pnvm_cfg pnvm_cfg; | 
|  | __le32 reserved2[16]; | 
|  | struct iwl_context_info_dram dram; | 
|  | __le32 reserved3[16]; | 
|  | } __packed; | 
|  |  | 
|  | int iwl_pcie_ctxt_info_init(struct iwl_trans *trans, const struct fw_img *fw); | 
|  | void iwl_pcie_ctxt_info_free(struct iwl_trans *trans); | 
|  | void iwl_pcie_ctxt_info_free_paging(struct iwl_trans *trans); | 
|  |  | 
|  | #endif /* __iwl_context_info_file_h__ */ |