drivers/net/wireless/iwlwifi/iwl-fw-error-dump.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) 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2014 Intel Mobile Communications GmbH
  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  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *****************************************************************************/
  64
  65 #ifndef __fw_error_dump_h__
  66 #define __fw_error_dump_h__
  67
  68 #include <linux/types.h>
  69
  70 #define IWL_FW_ERROR_DUMP_BARKER        0x14789632
  71
  72 /**
  73  * enum iwl_fw_error_dump_type - types of data in the dump file
  74  * @IWL_FW_ERROR_DUMP_SRAM:
  75  * @IWL_FW_ERROR_DUMP_CSR: Control Status Registers - from offset 0
  76  * @IWL_FW_ERROR_DUMP_RXF:
  77  * @IWL_FW_ERROR_DUMP_TXCMD: last TX command data, structured as
  78  *      &struct iwl_fw_error_dump_txcmd packets
  79  * @IWL_FW_ERROR_DUMP_DEV_FW_INFO:  struct %iwl_fw_error_dump_info
  80  *      info on the device / firmware.
  81  * @IWL_FW_ERROR_DUMP_FW_MONITOR: firmware monitor
  82  * @IWL_FW_ERROR_DUMP_PRPH: range of periphery registers - there can be several
  83  *      sections like this in a single file.
  84  * @IWL_FW_ERROR_DUMP_FH_REGS: range of FH registers
  85  * @IWL_FW_ERROR_DUMP_MEM: chunk of memory
  86  */
  87 enum iwl_fw_error_dump_type {
  88         IWL_FW_ERROR_DUMP_SRAM = 0,
  89         IWL_FW_ERROR_DUMP_CSR = 1,
  90         IWL_FW_ERROR_DUMP_RXF = 2,
  91         IWL_FW_ERROR_DUMP_TXCMD = 3,
  92         IWL_FW_ERROR_DUMP_DEV_FW_INFO = 4,
  93         IWL_FW_ERROR_DUMP_FW_MONITOR = 5,
  94         IWL_FW_ERROR_DUMP_PRPH = 6,
  95         IWL_FW_ERROR_DUMP_TXF = 7,
  96         IWL_FW_ERROR_DUMP_FH_REGS = 8,
  97         IWL_FW_ERROR_DUMP_MEM = 9,
  98
  99         IWL_FW_ERROR_DUMP_MAX,
 100 };
 101
 102 /**
 103  * struct iwl_fw_error_dump_data - data for one type
 104  * @type: %enum iwl_fw_error_dump_type
 105  * @len: the length starting from %data
 106  * @data: the data itself
 107  */
 108 struct iwl_fw_error_dump_data {
 109         __le32 type;
 110         __le32 len;
 111         __u8 data[];
 112 } __packed;
 113
 114 /**
 115  * struct iwl_fw_error_dump_file - the layout of the header of the file
 116  * @barker: must be %IWL_FW_ERROR_DUMP_BARKER
 117  * @file_len: the length of all the file starting from %barker
 118  * @data: array of %struct iwl_fw_error_dump_data
 119  */
 120 struct iwl_fw_error_dump_file {
 121         __le32 barker;
 122         __le32 file_len;
 123         u8 data[0];
 124 } __packed;
 125
 126 /**
 127  * struct iwl_fw_error_dump_txcmd - TX command data
 128  * @cmdlen: original length of command
 129  * @caplen: captured length of command (may be less)
 130  * @data: captured command data, @caplen bytes
 131  */
 132 struct iwl_fw_error_dump_txcmd {
 133         __le32 cmdlen;
 134         __le32 caplen;
 135         u8 data[];
 136 } __packed;
 137
 138 enum iwl_fw_error_dump_family {
 139         IWL_FW_ERROR_DUMP_FAMILY_7 = 7,
 140         IWL_FW_ERROR_DUMP_FAMILY_8 = 8,
 141 };
 142
 143 /**
 144  * struct iwl_fw_error_dump_info - info on the device / firmware
 145  * @device_family: the family of the device (7 / 8)
 146  * @hw_step: the step of the device
 147  * @fw_human_readable: human readable FW version
 148  * @dev_human_readable: name of the device
 149  * @bus_human_readable: name of the bus used
 150  */
 151 struct iwl_fw_error_dump_info {
 152         __le32 device_family;
 153         __le32 hw_step;
 154         u8 fw_human_readable[FW_VER_HUMAN_READABLE_SZ];
 155         u8 dev_human_readable[64];
 156         u8 bus_human_readable[8];
 157 } __packed;
 158
 159 /**
 160  * struct iwl_fw_error_dump_fw_mon - FW monitor data
 161  * @fw_mon_wr_ptr: the position of the write pointer in the cyclic buffer
 162  * @fw_mon_base_ptr: base pointer of the data
 163  * @fw_mon_cycle_cnt: number of wrap arounds
 164  * @reserved: for future use
 165  * @data: captured data
 166  */
 167 struct iwl_fw_error_dump_fw_mon {
 168         __le32 fw_mon_wr_ptr;
 169         __le32 fw_mon_base_ptr;
 170         __le32 fw_mon_cycle_cnt;
 171         __le32 reserved[3];
 172         u8 data[];
 173 } __packed;
 174
 175 /**
 176  * struct iwl_fw_error_dump_prph - periphery registers data
 177  * @prph_start: address of the first register in this chunk
 178  * @data: the content of the registers
 179  */
 180 struct iwl_fw_error_dump_prph {
 181         __le32 prph_start;
 182         __le32 data[];
 183 };
 184
 185 enum iwl_fw_error_dump_mem_type {
 186         IWL_FW_ERROR_DUMP_MEM_SRAM,
 187         IWL_FW_ERROR_DUMP_MEM_SMEM,
 188 };
 189
 190 /**
 191  * struct iwl_fw_error_dump_mem - chunk of memory
 192  * @type: %enum iwl_fw_error_dump_mem_type
 193  * @offset: the offset from which the memory was read
 194  * @data: the content of the memory
 195  */
 196 struct iwl_fw_error_dump_mem {
 197         __le32 type;
 198         __le32 offset;
 199         u8 data[];
 200 };
 201
 202 /**
 203  * iwl_fw_error_next_data - advance fw error dump data pointer
 204  * @data: previous data block
 205  * Returns: next data block
 206  */
 207 static inline struct iwl_fw_error_dump_data *
 208 iwl_fw_error_next_data(struct iwl_fw_error_dump_data *data)
 209 {
 210         return (void *)(data->data + le32_to_cpu(data->len));
 211 }
 212
 213 #endif /* __fw_error_dump_h__ */