drivers/net/wireless/intel/iwlwifi/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 <[email protected]>
  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
  70 struct iwl_fw_runtime_ops {
  71         int (*dump_start)(void *ctx);
  72         void (*dump_end)(void *ctx);
  73         bool (*fw_running)(void *ctx);
  74         int (*send_hcmd)(void *ctx, struct iwl_host_cmd *host_cmd);
  75 };
  76
  77 #define MAX_NUM_LMAC 2
  78 struct iwl_fwrt_shared_mem_cfg {
  79         int num_lmacs;
  80         int num_txfifo_entries;
  81         struct {
  82                 u32 txfifo_size[TX_FIFO_MAX_NUM];
  83                 u32 rxfifo1_size;
  84         } lmac[MAX_NUM_LMAC];
  85         u32 rxfifo2_size;
  86         u32 internal_txfifo_addr;
  87         u32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];
  88 };
  89
  90 enum iwl_fw_runtime_status {
  91         IWL_FWRT_STATUS_DUMPING = 0,
  92         IWL_FWRT_STATUS_WAIT_ALIVE,
  93 };
  94
  95 /**
  96  * struct iwl_fw_runtime - runtime data for firmware
  97  * @fw: firmware image
  98  * @cfg: NIC configuration
  99  * @dev: device pointer
 100  * @ops: user ops
 101  * @ops_ctx: user ops context
 102  * @status: status flags
 103  * @fw_paging_db: paging database
 104  * @num_of_paging_blk: number of paging blocks
 105  * @num_of_pages_in_last_blk: number of pages in the last block
 106  * @smem_cfg: saved firmware SMEM configuration
 107  * @cur_fw_img: current firmware image, must be maintained by
 108  *      the driver by calling &iwl_fw_set_current_image()
 109  * @dump: debug dump data
 110  */
 111 struct iwl_fw_runtime {
 112         struct iwl_trans *trans;
 113         const struct iwl_fw *fw;
 114         struct device *dev;
 115
 116         const struct iwl_fw_runtime_ops *ops;
 117         void *ops_ctx;
 118
 119         unsigned long status;
 120
 121         /* Paging */
 122         struct iwl_fw_paging fw_paging_db[NUM_OF_FW_PAGING_BLOCKS];
 123         u16 num_of_paging_blk;
 124         u16 num_of_pages_in_last_blk;
 125
 126         enum iwl_ucode_type cur_fw_img;
 127
 128         /* memory configuration */
 129         struct iwl_fwrt_shared_mem_cfg smem_cfg;
 130
 131         /* debug */
 132         struct {
 133                 const struct iwl_fw_dump_desc *desc;
 134                 const struct iwl_fw_dbg_trigger_tlv *trig;
 135                 struct delayed_work wk;
 136
 137                 u8 conf;
 138
 139                 /* ts of the beginning of a non-collect fw dbg data period */
 140                 unsigned long non_collect_ts_start[FW_DBG_TRIGGER_MAX - 1];
 141                 u32 *d3_debug_data;
 142         } dump;
 143 #ifdef CONFIG_IWLWIFI_DEBUGFS
 144         struct {
 145                 struct delayed_work wk;
 146                 u32 delay;
 147                 u64 seq;
 148         } timestamp;
 149 #endif /* CONFIG_IWLWIFI_DEBUGFS */
 150 };
 151
 152 void iwl_fw_runtime_init(struct iwl_fw_runtime *fwrt, struct iwl_trans *trans,
 153                         const struct iwl_fw *fw,
 154                         const struct iwl_fw_runtime_ops *ops, void *ops_ctx,
 155                         struct dentry *dbgfs_dir);
 156
 157 void iwl_fw_runtime_exit(struct iwl_fw_runtime *fwrt);
 158
 159 void iwl_fw_runtime_suspend(struct iwl_fw_runtime *fwrt);
 160
 161 void iwl_fw_runtime_resume(struct iwl_fw_runtime *fwrt);
 162
 163 static inline void iwl_fw_set_current_image(struct iwl_fw_runtime *fwrt,
 164                                             enum iwl_ucode_type cur_fw_img)
 165 {
 166         fwrt->cur_fw_img = cur_fw_img;
 167 }
 168
 169 int iwl_init_paging(struct iwl_fw_runtime *fwrt, enum iwl_ucode_type type);
 170 void iwl_free_fw_paging(struct iwl_fw_runtime *fwrt);
 171
 172 void iwl_get_shared_mem_conf(struct iwl_fw_runtime *fwrt);
 173
 174 #endif /* __iwl_fw_runtime_h__ */