579 lines · c
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */2/*3 * Copyright (C) 2014, 2018-2024 Intel Corporation4 * Copyright (C) 2014-2015 Intel Mobile Communications GmbH5 * Copyright (C) 2016-2017 Intel Deutschland GmbH6 */7#ifndef __fw_error_dump_h__8#define __fw_error_dump_h__9 10#include <linux/types.h>11#include "fw/api/cmdhdr.h"12 13#define IWL_FW_ERROR_DUMP_BARKER 0x1478963214#define IWL_FW_INI_ERROR_DUMP_BARKER 0x1478963315 16/**17 * enum iwl_fw_error_dump_type - types of data in the dump file18 * @IWL_FW_ERROR_DUMP_CSR: Control Status Registers - from offset 019 * @IWL_FW_ERROR_DUMP_RXF: RX FIFO contents20 * @IWL_FW_ERROR_DUMP_TXCMD: last TX command data, structured as21 * &struct iwl_fw_error_dump_txcmd packets22 * @IWL_FW_ERROR_DUMP_DEV_FW_INFO: struct %iwl_fw_error_dump_info23 * info on the device / firmware.24 * @IWL_FW_ERROR_DUMP_FW_MONITOR: firmware monitor25 * @IWL_FW_ERROR_DUMP_PRPH: range of periphery registers - there can be several26 * sections like this in a single file.27 * @IWL_FW_ERROR_DUMP_TXF: TX FIFO contents28 * @IWL_FW_ERROR_DUMP_FH_REGS: range of FH registers29 * @IWL_FW_ERROR_DUMP_MEM: chunk of memory30 * @IWL_FW_ERROR_DUMP_ERROR_INFO: description of what triggered this dump.31 * Structured as &struct iwl_fw_error_dump_trigger_desc.32 * @IWL_FW_ERROR_DUMP_RB: the content of an RB structured as33 * &struct iwl_fw_error_dump_rb34 * @IWL_FW_ERROR_DUMP_PAGING: UMAC's image memory segments which were35 * paged to the DRAM.36 * @IWL_FW_ERROR_DUMP_RADIO_REG: Dump the radio registers.37 * @IWL_FW_ERROR_DUMP_INTERNAL_TXF: internal TX FIFO data38 * @IWL_FW_ERROR_DUMP_EXTERNAL: used only by external code utilities, and39 * for that reason is not in use in any other place in the Linux Wi-Fi40 * stack.41 * @IWL_FW_ERROR_DUMP_MEM_CFG: the addresses and sizes of fifos in the smem,42 * which we get from the fw after ALIVE. The content is structured as43 * &struct iwl_fw_error_dump_smem_cfg.44 * @IWL_FW_ERROR_DUMP_D3_DEBUG_DATA: D3 debug data45 */46enum iwl_fw_error_dump_type {47 /* 0 is deprecated */48 IWL_FW_ERROR_DUMP_CSR = 1,49 IWL_FW_ERROR_DUMP_RXF = 2,50 IWL_FW_ERROR_DUMP_TXCMD = 3,51 IWL_FW_ERROR_DUMP_DEV_FW_INFO = 4,52 IWL_FW_ERROR_DUMP_FW_MONITOR = 5,53 IWL_FW_ERROR_DUMP_PRPH = 6,54 IWL_FW_ERROR_DUMP_TXF = 7,55 IWL_FW_ERROR_DUMP_FH_REGS = 8,56 IWL_FW_ERROR_DUMP_MEM = 9,57 IWL_FW_ERROR_DUMP_ERROR_INFO = 10,58 IWL_FW_ERROR_DUMP_RB = 11,59 IWL_FW_ERROR_DUMP_PAGING = 12,60 IWL_FW_ERROR_DUMP_RADIO_REG = 13,61 IWL_FW_ERROR_DUMP_INTERNAL_TXF = 14,62 IWL_FW_ERROR_DUMP_EXTERNAL = 15, /* Do not move */63 IWL_FW_ERROR_DUMP_MEM_CFG = 16,64 IWL_FW_ERROR_DUMP_D3_DEBUG_DATA = 17,65};66 67/**68 * struct iwl_fw_error_dump_data - data for one type69 * @type: &enum iwl_fw_error_dump_type70 * @len: the length starting from %data71 * @data: the data itself72 */73struct iwl_fw_error_dump_data {74 __le32 type;75 __le32 len;76 __u8 data[];77} __packed;78 79/**80 * struct iwl_dump_file_name_info - data for dump file name addition81 * @type: region type with reserved bits82 * @len: the length of file name string to be added to dump file83 * @data: the string need to be added to dump file84 */85struct iwl_dump_file_name_info {86 __le32 type;87 __le32 len;88 __u8 data[];89} __packed;90 91/**92 * struct iwl_fw_error_dump_file - the layout of the header of the file93 * @barker: must be %IWL_FW_ERROR_DUMP_BARKER94 * @file_len: the length of all the file starting from %barker95 * @data: array of &struct iwl_fw_error_dump_data96 */97struct iwl_fw_error_dump_file {98 __le32 barker;99 __le32 file_len;100 u8 data[];101} __packed;102 103/**104 * struct iwl_fw_error_dump_txcmd - TX command data105 * @cmdlen: original length of command106 * @caplen: captured length of command (may be less)107 * @data: captured command data, @caplen bytes108 */109struct iwl_fw_error_dump_txcmd {110 __le32 cmdlen;111 __le32 caplen;112 u8 data[];113} __packed;114 115/**116 * struct iwl_fw_error_dump_fifo - RX/TX FIFO data117 * @fifo_num: number of FIFO (starting from 0)118 * @available_bytes: num of bytes available in FIFO (may be less than FIFO size)119 * @wr_ptr: position of write pointer120 * @rd_ptr: position of read pointer121 * @fence_ptr: position of fence pointer122 * @fence_mode: the current mode of the fence (before locking) -123 * 0=follow RD pointer ; 1 = freeze124 * @data: all of the FIFO's data125 */126struct iwl_fw_error_dump_fifo {127 __le32 fifo_num;128 __le32 available_bytes;129 __le32 wr_ptr;130 __le32 rd_ptr;131 __le32 fence_ptr;132 __le32 fence_mode;133 u8 data[];134} __packed;135 136enum iwl_fw_error_dump_family {137 IWL_FW_ERROR_DUMP_FAMILY_7 = 7,138 IWL_FW_ERROR_DUMP_FAMILY_8 = 8,139};140 141#define MAX_NUM_LMAC 2142 143/**144 * struct iwl_fw_error_dump_info - info on the device / firmware145 * @hw_type: the type of the device146 * @hw_step: the step of the device147 * @fw_human_readable: human readable FW version148 * @dev_human_readable: name of the device149 * @bus_human_readable: name of the bus used150 * @num_of_lmacs: the number of lmacs151 * @lmac_err_id: the lmac 0/1 error_id/rt_status that triggered the latest dump152 * if the dump collection was not initiated by an assert, the value is 0153 * @umac_err_id: the umac error_id/rt_status that triggered the latest dump154 * if the dump collection was not initiated by an assert, the value is 0155 */156struct iwl_fw_error_dump_info {157 __le32 hw_type;158 __le32 hw_step;159 u8 fw_human_readable[FW_VER_HUMAN_READABLE_SZ];160 u8 dev_human_readable[64];161 u8 bus_human_readable[8];162 u8 num_of_lmacs;163 __le32 umac_err_id;164 __le32 lmac_err_id[MAX_NUM_LMAC];165} __packed;166 167/**168 * struct iwl_fw_error_dump_fw_mon - FW monitor data169 * @fw_mon_wr_ptr: the position of the write pointer in the cyclic buffer170 * @fw_mon_base_ptr: base pointer of the data171 * @fw_mon_cycle_cnt: number of wraparounds172 * @fw_mon_base_high_ptr: used in AX210 devices, the base adderss is 64 bit173 * so fw_mon_base_ptr holds LSB 32 bits and fw_mon_base_high_ptr hold174 * MSB 32 bits175 * @reserved: for future use176 * @data: captured data177 */178struct iwl_fw_error_dump_fw_mon {179 __le32 fw_mon_wr_ptr;180 __le32 fw_mon_base_ptr;181 __le32 fw_mon_cycle_cnt;182 __le32 fw_mon_base_high_ptr;183 __le32 reserved[2];184 u8 data[];185} __packed;186 187#define MAX_NUM_LMAC 2188#define TX_FIFO_INTERNAL_MAX_NUM 6189#define TX_FIFO_MAX_NUM 15190/**191 * struct iwl_fw_error_dump_smem_cfg - Dump SMEM configuration192 * This must follow &struct iwl_fwrt_shared_mem_cfg.193 * @num_lmacs: number of lmacs194 * @num_txfifo_entries: number of tx fifos195 * @lmac: sizes of lmacs txfifos and rxfifo1196 * @rxfifo2_size: size of rxfifo2197 * @internal_txfifo_addr: address of internal tx fifo198 * @internal_txfifo_size: size of internal tx fifo199 */200struct iwl_fw_error_dump_smem_cfg {201 __le32 num_lmacs;202 __le32 num_txfifo_entries;203 struct {204 __le32 txfifo_size[TX_FIFO_MAX_NUM];205 __le32 rxfifo1_size;206 } lmac[MAX_NUM_LMAC];207 __le32 rxfifo2_size;208 __le32 internal_txfifo_addr;209 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM];210} __packed;211/**212 * struct iwl_fw_error_dump_prph - periphery registers data213 * @prph_start: address of the first register in this chunk214 * @data: the content of the registers215 */216struct iwl_fw_error_dump_prph {217 __le32 prph_start;218 __le32 data[];219};220 221enum iwl_fw_error_dump_mem_type {222 IWL_FW_ERROR_DUMP_MEM_SRAM,223 IWL_FW_ERROR_DUMP_MEM_SMEM,224 IWL_FW_ERROR_DUMP_MEM_NAMED_MEM = 10,225};226 227/**228 * struct iwl_fw_error_dump_mem - chunk of memory229 * @type: &enum iwl_fw_error_dump_mem_type230 * @offset: the offset from which the memory was read231 * @data: the content of the memory232 */233struct iwl_fw_error_dump_mem {234 __le32 type;235 __le32 offset;236 u8 data[];237};238 239/* Dump version, used by the dump parser to differentiate between240 * different dump formats241 */242#define IWL_INI_DUMP_VER 1243 244/* Use bit 31 as dump info type to avoid colliding with region types */245#define IWL_INI_DUMP_INFO_TYPE BIT(31)246 247/* Use bit 31 and bit 24 as dump name type to avoid colliding with region types */248#define IWL_INI_DUMP_NAME_TYPE (BIT(31) | BIT(24))249 250/**251 * struct iwl_fw_ini_error_dump_data - data for one type252 * @type: &enum iwl_fw_ini_region_type253 * @sub_type: sub type id254 * @sub_type_ver: sub type version255 * @reserved: not in use256 * @len: the length starting from %data257 * @data: the data itself258 */259struct iwl_fw_ini_error_dump_data {260 u8 type;261 u8 sub_type;262 u8 sub_type_ver;263 u8 reserved;264 __le32 len;265 __u8 data[];266} __packed;267 268/**269 * struct iwl_fw_ini_dump_entry270 * @list: list of dump entries271 * @size: size of the data272 * @data: entry data273 */274struct iwl_fw_ini_dump_entry {275 struct list_head list;276 u32 size;277 u8 data[];278} __packed;279 280/**281 * struct iwl_fw_ini_dump_file_hdr - header of dump file282 * @barker: must be %IWL_FW_INI_ERROR_DUMP_BARKER283 * @file_len: the length of all the file including the header284 */285struct iwl_fw_ini_dump_file_hdr {286 __le32 barker;287 __le32 file_len;288} __packed;289 290/**291 * struct iwl_fw_ini_fifo_hdr - fifo range header292 * @fifo_num: the fifo number. In case of umac rx fifo, set BIT(31) to293 * distinguish between lmac and umac rx fifos294 * @num_of_registers: num of registers to dump, dword size each295 */296struct iwl_fw_ini_fifo_hdr {297 __le32 fifo_num;298 __le32 num_of_registers;299} __packed;300 301/**302 * struct iwl_fw_ini_error_dump_range - range of memory303 * @range_data_size: the size of this range, in bytes304 * @internal_base_addr: base address of internal memory range305 * @dram_base_addr: base address of dram monitor range306 * @page_num: page number of memory range307 * @fifo_hdr: fifo header of memory range308 * @fw_pkt: FW packet header of memory range309 * @data: the actual memory310 */311struct iwl_fw_ini_error_dump_range {312 __le32 range_data_size;313 union {314 __le32 internal_base_addr __packed;315 __le64 dram_base_addr __packed;316 __le32 page_num __packed;317 struct iwl_fw_ini_fifo_hdr fifo_hdr;318 struct iwl_cmd_header fw_pkt_hdr;319 };320 __le32 data[];321} __packed;322 323/**324 * struct iwl_fw_ini_error_dump_header - ini region dump header325 * @version: dump version326 * @region_id: id of the region327 * @num_of_ranges: number of ranges in this region328 * @name_len: number of bytes allocated to the name string of this region329 * @name: name of the region330 */331struct iwl_fw_ini_error_dump_header {332 __le32 version;333 __le32 region_id;334 __le32 num_of_ranges;335 __le32 name_len;336 u8 name[IWL_FW_INI_MAX_NAME];337};338 339/**340 * struct iwl_fw_ini_error_dump - ini region dump341 * @header: the header of this region342 * @data: data of memory ranges in this region,343 * see &struct iwl_fw_ini_error_dump_range344 */345struct iwl_fw_ini_error_dump {346 struct iwl_fw_ini_error_dump_header header;347 u8 data[];348} __packed;349 350/* This bit is used to differentiate between lmac and umac rxf */351#define IWL_RXF_UMAC_BIT BIT(31)352 353/**354 * struct iwl_fw_ini_error_dump_register - ini register dump355 * @addr: address of the register356 * @data: data of the register357 */358struct iwl_fw_ini_error_dump_register {359 __le32 addr;360 __le32 data;361} __packed;362 363/**364 * struct iwl_fw_ini_dump_cfg_name - configuration name365 * @image_type: image type the configuration is related to366 * @cfg_name_len: length of the configuration name367 * @cfg_name: name of the configuraiton368 */369struct iwl_fw_ini_dump_cfg_name {370 __le32 image_type;371 __le32 cfg_name_len;372 u8 cfg_name[IWL_FW_INI_MAX_CFG_NAME];373} __packed;374 375/* AX210's HW type */376#define IWL_AX210_HW_TYPE 0x42377/* How many bits to roll when adding to the HW type of AX210 HW */378#define IWL_AX210_HW_TYPE_ADDITION_SHIFT 12379 380/* struct iwl_fw_ini_dump_info - ini dump information381 * @version: dump version382 * @time_point: time point that caused the dump collection383 * @trigger_reason: reason of the trigger384 * @external_cfg_state: &enum iwl_ini_cfg_state385 * @ver_type: FW version type386 * @ver_subtype: FW version subype387 * @hw_step: HW step388 * @hw_type: HW type389 * @rf_id_flavor: HW RF id flavor390 * @rf_id_dash: HW RF id dash391 * @rf_id_step: HW RF id step392 * @rf_id_type: HW RF id type393 * @lmac_major: lmac major version394 * @lmac_minor: lmac minor version395 * @umac_major: umac major version396 * @umac_minor: umac minor version397 * @fw_mon_mode: FW monitor mode &enum iwl_fw_ini_buffer_location398 * @regions_mask: bitmap mask of regions ids in the dump399 * @build_tag_len: length of the build tag400 * @build_tag: build tag string401 * @num_of_cfg_names: number of configuration name structs402 * @cfg_names: configuration names403 */404struct iwl_fw_ini_dump_info {405 __le32 version;406 __le32 time_point;407 __le32 trigger_reason;408 __le32 external_cfg_state;409 __le32 ver_type;410 __le32 ver_subtype;411 __le32 hw_step;412 __le32 hw_type;413 __le32 rf_id_flavor;414 __le32 rf_id_dash;415 __le32 rf_id_step;416 __le32 rf_id_type;417 __le32 lmac_major;418 __le32 lmac_minor;419 __le32 umac_major;420 __le32 umac_minor;421 __le32 fw_mon_mode;422 __le64 regions_mask;423 __le32 build_tag_len;424 u8 build_tag[FW_VER_HUMAN_READABLE_SZ];425 __le32 num_of_cfg_names;426 struct iwl_fw_ini_dump_cfg_name cfg_names[];427} __packed;428 429/**430 * struct iwl_fw_ini_err_table_dump - ini error table dump431 * @header: header of the region432 * @version: error table version433 * @data: data of memory ranges in this region,434 * see &struct iwl_fw_ini_error_dump_range435 */436struct iwl_fw_ini_err_table_dump {437 struct iwl_fw_ini_error_dump_header header;438 __le32 version;439 u8 data[];440} __packed;441 442/**443 * struct iwl_fw_error_dump_rb - content of an Receive Buffer444 * @index: the index of the Receive Buffer in the Rx queue445 * @rxq: the RB's Rx queue446 * @reserved: reserved447 * @data: the content of the Receive Buffer448 */449struct iwl_fw_error_dump_rb {450 __le32 index;451 __le32 rxq;452 __le32 reserved;453 u8 data[];454};455 456/**457 * struct iwl_fw_ini_monitor_dump - ini monitor dump458 * @header: header of the region459 * @write_ptr: write pointer position in the buffer460 * @cycle_cnt: cycles count461 * @cur_frag: current fragment in use462 * @data: data of memory ranges in this region,463 * see &struct iwl_fw_ini_error_dump_range464 */465struct iwl_fw_ini_monitor_dump {466 struct iwl_fw_ini_error_dump_header header;467 __le32 write_ptr;468 __le32 cycle_cnt;469 __le32 cur_frag;470 u8 data[];471} __packed;472 473/**474 * struct iwl_fw_ini_special_device_memory - special device memory475 * @header: header of the region476 * @type: type of special memory477 * @version: struct special memory version478 * @data: data of memory ranges in this region,479 * see &struct iwl_fw_ini_error_dump_range480 */481struct iwl_fw_ini_special_device_memory {482 struct iwl_fw_ini_error_dump_header header;483 __le16 type;484 __le16 version;485 u8 data[];486} __packed;487 488/**489 * struct iwl_fw_error_dump_paging - content of the UMAC's image page490 * block on DRAM491 * @index: the index of the page block492 * @reserved: reserved493 * @data: the content of the page block494 */495struct iwl_fw_error_dump_paging {496 __le32 index;497 __le32 reserved;498 u8 data[];499};500 501/**502 * iwl_fw_error_next_data - advance fw error dump data pointer503 * @data: previous data block504 * Returns: next data block505 */506static inline struct iwl_fw_error_dump_data *507iwl_fw_error_next_data(struct iwl_fw_error_dump_data *data)508{509 return (void *)(data->data + le32_to_cpu(data->len));510}511 512/**513 * enum iwl_fw_dbg_trigger - triggers available514 *515 * @FW_DBG_TRIGGER_INVALID: invalid trigger value516 * @FW_DBG_TRIGGER_USER: trigger log collection by user517 * This should not be defined as a trigger to the driver, but a value the518 * driver should set to indicate that the trigger was initiated by the519 * user.520 * @FW_DBG_TRIGGER_FW_ASSERT: trigger log collection when the firmware asserts521 * @FW_DBG_TRIGGER_MISSED_BEACONS: trigger log collection when beacons are522 * missed.523 * @FW_DBG_TRIGGER_CHANNEL_SWITCH: trigger log collection upon channel switch.524 * @FW_DBG_TRIGGER_FW_NOTIF: trigger log collection when the firmware sends a525 * command response or a notification.526 * @FW_DBG_TRIGGER_MLME: trigger log collection upon MLME event.527 * @FW_DBG_TRIGGER_STATS: trigger log collection upon statistics threshold.528 * @FW_DBG_TRIGGER_RSSI: trigger log collection when the rssi of the beacon529 * goes below a threshold.530 * @FW_DBG_TRIGGER_TXQ_TIMERS: configures the timers for the Tx queue hang531 * detection.532 * @FW_DBG_TRIGGER_TIME_EVENT: trigger log collection upon time events related533 * events.534 * @FW_DBG_TRIGGER_BA: trigger log collection upon BlockAck related events.535 * @FW_DBG_TRIGGER_TX_LATENCY: trigger log collection when the tx latency536 * goes above a threshold.537 * @FW_DBG_TRIGGER_TDLS: trigger log collection upon TDLS related events.538 * @FW_DBG_TRIGGER_TX_STATUS: trigger log collection upon tx status when539 * the firmware sends a tx reply.540 * @FW_DBG_TRIGGER_ALIVE_TIMEOUT: trigger log collection if alive flow timeouts541 * @FW_DBG_TRIGGER_DRIVER: trigger log collection upon a flow failure542 * in the driver.543 * @FW_DBG_TRIGGER_MAX: beyond triggers, number for sizing arrays etc.544 */545enum iwl_fw_dbg_trigger {546 FW_DBG_TRIGGER_INVALID = 0,547 FW_DBG_TRIGGER_USER,548 FW_DBG_TRIGGER_FW_ASSERT,549 FW_DBG_TRIGGER_MISSED_BEACONS,550 FW_DBG_TRIGGER_CHANNEL_SWITCH,551 FW_DBG_TRIGGER_FW_NOTIF,552 FW_DBG_TRIGGER_MLME,553 FW_DBG_TRIGGER_STATS,554 FW_DBG_TRIGGER_RSSI,555 FW_DBG_TRIGGER_TXQ_TIMERS,556 FW_DBG_TRIGGER_TIME_EVENT,557 FW_DBG_TRIGGER_BA,558 FW_DBG_TRIGGER_TX_LATENCY,559 FW_DBG_TRIGGER_TDLS,560 FW_DBG_TRIGGER_TX_STATUS,561 FW_DBG_TRIGGER_ALIVE_TIMEOUT,562 FW_DBG_TRIGGER_DRIVER,563 564 /* must be last */565 FW_DBG_TRIGGER_MAX,566};567 568/**569 * struct iwl_fw_error_dump_trigger_desc - describes the trigger condition570 * @type: &enum iwl_fw_dbg_trigger571 * @data: raw data about what happened572 */573struct iwl_fw_error_dump_trigger_desc {574 __le32 type;575 u8 data[];576};577 578#endif /* __fw_error_dump_h__ */579