error-dump.h (16424B)
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */ 2/* 3 * Copyright (C) 2014, 2018-2021 Intel Corporation 4 * Copyright (C) 2014-2015 Intel Mobile Communications GmbH 5 * Copyright (C) 2016-2017 Intel Deutschland GmbH 6 */ 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 0x14789632 14#define IWL_FW_INI_ERROR_DUMP_BARKER 0x14789633 15 16/** 17 * enum iwl_fw_error_dump_type - types of data in the dump file 18 * @IWL_FW_ERROR_DUMP_CSR: Control Status Registers - from offset 0 19 * @IWL_FW_ERROR_DUMP_RXF: 20 * @IWL_FW_ERROR_DUMP_TXCMD: last TX command data, structured as 21 * &struct iwl_fw_error_dump_txcmd packets 22 * @IWL_FW_ERROR_DUMP_DEV_FW_INFO: struct %iwl_fw_error_dump_info 23 * info on the device / firmware. 24 * @IWL_FW_ERROR_DUMP_FW_MONITOR: firmware monitor 25 * @IWL_FW_ERROR_DUMP_PRPH: range of periphery registers - there can be several 26 * sections like this in a single file. 27 * @IWL_FW_ERROR_DUMP_FH_REGS: range of FH registers 28 * @IWL_FW_ERROR_DUMP_MEM: chunk of memory 29 * @IWL_FW_ERROR_DUMP_ERROR_INFO: description of what triggered this dump. 30 * Structured as &struct iwl_fw_error_dump_trigger_desc. 31 * @IWL_FW_ERROR_DUMP_RB: the content of an RB structured as 32 * &struct iwl_fw_error_dump_rb 33 * @IWL_FW_ERROR_PAGING: UMAC's image memory segments which were 34 * paged to the DRAM. 35 * @IWL_FW_ERROR_DUMP_RADIO_REG: Dump the radio registers. 36 * @IWL_FW_ERROR_DUMP_EXTERNAL: used only by external code utilities, and 37 * for that reason is not in use in any other place in the Linux Wi-Fi 38 * stack. 39 * @IWL_FW_ERROR_DUMP_MEM_CFG: the addresses and sizes of fifos in the smem, 40 * which we get from the fw after ALIVE. The content is structured as 41 * &struct iwl_fw_error_dump_smem_cfg. 42 */ 43enum iwl_fw_error_dump_type { 44 /* 0 is deprecated */ 45 IWL_FW_ERROR_DUMP_CSR = 1, 46 IWL_FW_ERROR_DUMP_RXF = 2, 47 IWL_FW_ERROR_DUMP_TXCMD = 3, 48 IWL_FW_ERROR_DUMP_DEV_FW_INFO = 4, 49 IWL_FW_ERROR_DUMP_FW_MONITOR = 5, 50 IWL_FW_ERROR_DUMP_PRPH = 6, 51 IWL_FW_ERROR_DUMP_TXF = 7, 52 IWL_FW_ERROR_DUMP_FH_REGS = 8, 53 IWL_FW_ERROR_DUMP_MEM = 9, 54 IWL_FW_ERROR_DUMP_ERROR_INFO = 10, 55 IWL_FW_ERROR_DUMP_RB = 11, 56 IWL_FW_ERROR_DUMP_PAGING = 12, 57 IWL_FW_ERROR_DUMP_RADIO_REG = 13, 58 IWL_FW_ERROR_DUMP_INTERNAL_TXF = 14, 59 IWL_FW_ERROR_DUMP_EXTERNAL = 15, /* Do not move */ 60 IWL_FW_ERROR_DUMP_MEM_CFG = 16, 61 IWL_FW_ERROR_DUMP_D3_DEBUG_DATA = 17, 62 63 IWL_FW_ERROR_DUMP_MAX, 64}; 65 66/** 67 * struct iwl_fw_error_dump_data - data for one type 68 * @type: &enum iwl_fw_error_dump_type 69 * @len: the length starting from %data 70 * @data: the data itself 71 */ 72struct iwl_fw_error_dump_data { 73 __le32 type; 74 __le32 len; 75 __u8 data[]; 76} __packed; 77 78/** 79 * struct iwl_fw_error_dump_file - the layout of the header of the file 80 * @barker: must be %IWL_FW_ERROR_DUMP_BARKER 81 * @file_len: the length of all the file starting from %barker 82 * @data: array of &struct iwl_fw_error_dump_data 83 */ 84struct iwl_fw_error_dump_file { 85 __le32 barker; 86 __le32 file_len; 87 u8 data[]; 88} __packed; 89 90/** 91 * struct iwl_fw_error_dump_txcmd - TX command data 92 * @cmdlen: original length of command 93 * @caplen: captured length of command (may be less) 94 * @data: captured command data, @caplen bytes 95 */ 96struct iwl_fw_error_dump_txcmd { 97 __le32 cmdlen; 98 __le32 caplen; 99 u8 data[]; 100} __packed; 101 102/** 103 * struct iwl_fw_error_dump_fifo - RX/TX FIFO data 104 * @fifo_num: number of FIFO (starting from 0) 105 * @available_bytes: num of bytes available in FIFO (may be less than FIFO size) 106 * @wr_ptr: position of write pointer 107 * @rd_ptr: position of read pointer 108 * @fence_ptr: position of fence pointer 109 * @fence_mode: the current mode of the fence (before locking) - 110 * 0=follow RD pointer ; 1 = freeze 111 * @data: all of the FIFO's data 112 */ 113struct iwl_fw_error_dump_fifo { 114 __le32 fifo_num; 115 __le32 available_bytes; 116 __le32 wr_ptr; 117 __le32 rd_ptr; 118 __le32 fence_ptr; 119 __le32 fence_mode; 120 u8 data[]; 121} __packed; 122 123enum iwl_fw_error_dump_family { 124 IWL_FW_ERROR_DUMP_FAMILY_7 = 7, 125 IWL_FW_ERROR_DUMP_FAMILY_8 = 8, 126}; 127 128#define MAX_NUM_LMAC 2 129 130/** 131 * struct iwl_fw_error_dump_info - info on the device / firmware 132 * @hw_type: the type of the device 133 * @hw_step: the step of the device 134 * @fw_human_readable: human readable FW version 135 * @dev_human_readable: name of the device 136 * @bus_human_readable: name of the bus used 137 * @num_of_lmacs: the number of lmacs 138 * @lmac_err_id: the lmac 0/1 error_id/rt_status that triggered the latest dump 139 * if the dump collection was not initiated by an assert, the value is 0 140 * @umac_err_id: the umac error_id/rt_status that triggered the latest dump 141 * if the dump collection was not initiated by an assert, the value is 0 142 */ 143struct iwl_fw_error_dump_info { 144 __le32 hw_type; 145 __le32 hw_step; 146 u8 fw_human_readable[FW_VER_HUMAN_READABLE_SZ]; 147 u8 dev_human_readable[64]; 148 u8 bus_human_readable[8]; 149 u8 num_of_lmacs; 150 __le32 umac_err_id; 151 __le32 lmac_err_id[MAX_NUM_LMAC]; 152} __packed; 153 154/** 155 * struct iwl_fw_error_dump_fw_mon - FW monitor data 156 * @fw_mon_wr_ptr: the position of the write pointer in the cyclic buffer 157 * @fw_mon_base_ptr: base pointer of the data 158 * @fw_mon_cycle_cnt: number of wraparounds 159 * @fw_mon_base_high_ptr: used in AX210 devices, the base adderss is 64 bit 160 * so fw_mon_base_ptr holds LSB 32 bits and fw_mon_base_high_ptr hold 161 * MSB 32 bits 162 * @reserved: for future use 163 * @data: captured data 164 */ 165struct iwl_fw_error_dump_fw_mon { 166 __le32 fw_mon_wr_ptr; 167 __le32 fw_mon_base_ptr; 168 __le32 fw_mon_cycle_cnt; 169 __le32 fw_mon_base_high_ptr; 170 __le32 reserved[2]; 171 u8 data[]; 172} __packed; 173 174#define MAX_NUM_LMAC 2 175#define TX_FIFO_INTERNAL_MAX_NUM 6 176#define TX_FIFO_MAX_NUM 15 177/** 178 * struct iwl_fw_error_dump_smem_cfg - Dump SMEM configuration 179 * This must follow &struct iwl_fwrt_shared_mem_cfg. 180 * @num_lmacs: number of lmacs 181 * @num_txfifo_entries: number of tx fifos 182 * @lmac: sizes of lmacs txfifos and rxfifo1 183 * @rxfifo2_size: size of rxfifo2 184 * @internal_txfifo_addr: address of internal tx fifo 185 * @internal_txfifo_size: size of internal tx fifo 186 */ 187struct iwl_fw_error_dump_smem_cfg { 188 __le32 num_lmacs; 189 __le32 num_txfifo_entries; 190 struct { 191 __le32 txfifo_size[TX_FIFO_MAX_NUM]; 192 __le32 rxfifo1_size; 193 } lmac[MAX_NUM_LMAC]; 194 __le32 rxfifo2_size; 195 __le32 internal_txfifo_addr; 196 __le32 internal_txfifo_size[TX_FIFO_INTERNAL_MAX_NUM]; 197} __packed; 198/** 199 * struct iwl_fw_error_dump_prph - periphery registers data 200 * @prph_start: address of the first register in this chunk 201 * @data: the content of the registers 202 */ 203struct iwl_fw_error_dump_prph { 204 __le32 prph_start; 205 __le32 data[]; 206}; 207 208enum iwl_fw_error_dump_mem_type { 209 IWL_FW_ERROR_DUMP_MEM_SRAM, 210 IWL_FW_ERROR_DUMP_MEM_SMEM, 211 IWL_FW_ERROR_DUMP_MEM_NAMED_MEM = 10, 212}; 213 214/** 215 * struct iwl_fw_error_dump_mem - chunk of memory 216 * @type: &enum iwl_fw_error_dump_mem_type 217 * @offset: the offset from which the memory was read 218 * @data: the content of the memory 219 */ 220struct iwl_fw_error_dump_mem { 221 __le32 type; 222 __le32 offset; 223 u8 data[]; 224}; 225 226/* Dump version, used by the dump parser to differentiate between 227 * different dump formats 228 */ 229#define IWL_INI_DUMP_VER 1 230 231/* Use bit 31 as dump info type to avoid colliding with region types */ 232#define IWL_INI_DUMP_INFO_TYPE BIT(31) 233 234/** 235 * struct iwl_fw_error_dump_data - data for one type 236 * @type: &enum iwl_fw_ini_region_type 237 * @sub_type: sub type id 238 * @sub_type_ver: sub type version 239 * @reserved: not in use 240 * @len: the length starting from %data 241 * @data: the data itself 242 */ 243struct iwl_fw_ini_error_dump_data { 244 u8 type; 245 u8 sub_type; 246 u8 sub_type_ver; 247 u8 reserved; 248 __le32 len; 249 __u8 data[]; 250} __packed; 251 252/** 253 * struct iwl_fw_ini_dump_entry 254 * @list: list of dump entries 255 * @size: size of the data 256 * @data: entry data 257 */ 258struct iwl_fw_ini_dump_entry { 259 struct list_head list; 260 u32 size; 261 u8 data[]; 262} __packed; 263 264/** 265 * struct iwl_fw_error_dump_file - header of dump file 266 * @barker: must be %IWL_FW_INI_ERROR_DUMP_BARKER 267 * @file_len: the length of all the file including the header 268 */ 269struct iwl_fw_ini_dump_file_hdr { 270 __le32 barker; 271 __le32 file_len; 272} __packed; 273 274/** 275 * struct iwl_fw_ini_fifo_hdr - fifo range header 276 * @fifo_num: the fifo number. In case of umac rx fifo, set BIT(31) to 277 * distinguish between lmac and umac rx fifos 278 * @num_of_registers: num of registers to dump, dword size each 279 */ 280struct iwl_fw_ini_fifo_hdr { 281 __le32 fifo_num; 282 __le32 num_of_registers; 283} __packed; 284 285/** 286 * struct iwl_fw_ini_error_dump_range - range of memory 287 * @range_data_size: the size of this range, in bytes 288 * @internal_base_addr: base address of internal memory range 289 * @dram_base_addr: base address of dram monitor range 290 * @page_num: page number of memory range 291 * @fifo_hdr: fifo header of memory range 292 * @fw_pkt: FW packet header of memory range 293 * @data: the actual memory 294 */ 295struct iwl_fw_ini_error_dump_range { 296 __le32 range_data_size; 297 union { 298 __le32 internal_base_addr; 299 __le64 dram_base_addr; 300 __le32 page_num; 301 struct iwl_fw_ini_fifo_hdr fifo_hdr; 302 struct iwl_cmd_header fw_pkt_hdr; 303 }; 304 __le32 data[]; 305} __packed; 306 307/** 308 * struct iwl_fw_ini_error_dump_header - ini region dump header 309 * @version: dump version 310 * @region_id: id of the region 311 * @num_of_ranges: number of ranges in this region 312 * @name_len: number of bytes allocated to the name string of this region 313 * @name: name of the region 314 */ 315struct iwl_fw_ini_error_dump_header { 316 __le32 version; 317 __le32 region_id; 318 __le32 num_of_ranges; 319 __le32 name_len; 320 u8 name[IWL_FW_INI_MAX_NAME]; 321}; 322 323/** 324 * struct iwl_fw_ini_error_dump - ini region dump 325 * @header: the header of this region 326 * @data: data of memory ranges in this region, 327 * see &struct iwl_fw_ini_error_dump_range 328 */ 329struct iwl_fw_ini_error_dump { 330 struct iwl_fw_ini_error_dump_header header; 331 u8 data[]; 332} __packed; 333 334/* This bit is used to differentiate between lmac and umac rxf */ 335#define IWL_RXF_UMAC_BIT BIT(31) 336 337/** 338 * struct iwl_fw_ini_error_dump_register - ini register dump 339 * @addr: address of the register 340 * @data: data of the register 341 */ 342struct iwl_fw_ini_error_dump_register { 343 __le32 addr; 344 __le32 data; 345} __packed; 346 347/** 348 * struct iwl_fw_ini_dump_cfg_name - configuration name 349 * @image_type: image type the configuration is related to 350 * @cfg_name_len: length of the configuration name 351 * @cfg_name: name of the configuraiton 352 */ 353struct iwl_fw_ini_dump_cfg_name { 354 __le32 image_type; 355 __le32 cfg_name_len; 356 u8 cfg_name[IWL_FW_INI_MAX_CFG_NAME]; 357} __packed; 358 359/* AX210's HW type */ 360#define IWL_AX210_HW_TYPE 0x42 361/* How many bits to roll when adding to the HW type of AX210 HW */ 362#define IWL_AX210_HW_TYPE_ADDITION_SHIFT 12 363 364/* struct iwl_fw_ini_dump_info - ini dump information 365 * @version: dump version 366 * @time_point: time point that caused the dump collection 367 * @trigger_reason: reason of the trigger 368 * @external_cfg_state: &enum iwl_ini_cfg_state 369 * @ver_type: FW version type 370 * @ver_subtype: FW version subype 371 * @hw_step: HW step 372 * @hw_type: HW type 373 * @rf_id_flavor: HW RF id flavor 374 * @rf_id_dash: HW RF id dash 375 * @rf_id_step: HW RF id step 376 * @rf_id_type: HW RF id type 377 * @lmac_major: lmac major version 378 * @lmac_minor: lmac minor version 379 * @umac_major: umac major version 380 * @umac_minor: umac minor version 381 * @fw_mon_mode: FW monitor mode &enum iwl_fw_ini_buffer_location 382 * @regions_mask: bitmap mask of regions ids in the dump 383 * @build_tag_len: length of the build tag 384 * @build_tag: build tag string 385 * @num_of_cfg_names: number of configuration name structs 386 * @cfg_names: configuration names 387 */ 388struct iwl_fw_ini_dump_info { 389 __le32 version; 390 __le32 time_point; 391 __le32 trigger_reason; 392 __le32 external_cfg_state; 393 __le32 ver_type; 394 __le32 ver_subtype; 395 __le32 hw_step; 396 __le32 hw_type; 397 __le32 rf_id_flavor; 398 __le32 rf_id_dash; 399 __le32 rf_id_step; 400 __le32 rf_id_type; 401 __le32 lmac_major; 402 __le32 lmac_minor; 403 __le32 umac_major; 404 __le32 umac_minor; 405 __le32 fw_mon_mode; 406 __le64 regions_mask; 407 __le32 build_tag_len; 408 u8 build_tag[FW_VER_HUMAN_READABLE_SZ]; 409 __le32 num_of_cfg_names; 410 struct iwl_fw_ini_dump_cfg_name cfg_names[]; 411} __packed; 412 413/** 414 * struct iwl_fw_ini_err_table_dump - ini error table dump 415 * @header: header of the region 416 * @version: error table version 417 * @data: data of memory ranges in this region, 418 * see &struct iwl_fw_ini_error_dump_range 419 */ 420struct iwl_fw_ini_err_table_dump { 421 struct iwl_fw_ini_error_dump_header header; 422 __le32 version; 423 u8 data[]; 424} __packed; 425 426/** 427 * struct iwl_fw_error_dump_rb - content of an Receive Buffer 428 * @index: the index of the Receive Buffer in the Rx queue 429 * @rxq: the RB's Rx queue 430 * @reserved: 431 * @data: the content of the Receive Buffer 432 */ 433struct iwl_fw_error_dump_rb { 434 __le32 index; 435 __le32 rxq; 436 __le32 reserved; 437 u8 data[]; 438}; 439 440/** 441 * struct iwl_fw_ini_monitor_dump - ini monitor dump 442 * @header: header of the region 443 * @write_ptr: write pointer position in the buffer 444 * @cycle_cnt: cycles count 445 * @cur_frag: current fragment in use 446 * @data: data of memory ranges in this region, 447 * see &struct iwl_fw_ini_error_dump_range 448 */ 449struct iwl_fw_ini_monitor_dump { 450 struct iwl_fw_ini_error_dump_header header; 451 __le32 write_ptr; 452 __le32 cycle_cnt; 453 __le32 cur_frag; 454 u8 data[]; 455} __packed; 456 457/** 458 * struct iwl_fw_ini_special_device_memory - special device memory 459 * @header: header of the region 460 * @type: type of special memory 461 * @version: struct special memory version 462 * @data: data of memory ranges in this region, 463 * see &struct iwl_fw_ini_error_dump_range 464 */ 465struct iwl_fw_ini_special_device_memory { 466 struct iwl_fw_ini_error_dump_header header; 467 __le16 type; 468 __le16 version; 469 u8 data[]; 470} __packed; 471 472/** 473 * struct iwl_fw_error_dump_paging - content of the UMAC's image page 474 * block on DRAM 475 * @index: the index of the page block 476 * @reserved: 477 * @data: the content of the page block 478 */ 479struct iwl_fw_error_dump_paging { 480 __le32 index; 481 __le32 reserved; 482 u8 data[]; 483}; 484 485/** 486 * iwl_fw_error_next_data - advance fw error dump data pointer 487 * @data: previous data block 488 * Returns: next data block 489 */ 490static inline struct iwl_fw_error_dump_data * 491iwl_fw_error_next_data(struct iwl_fw_error_dump_data *data) 492{ 493 return (void *)(data->data + le32_to_cpu(data->len)); 494} 495 496/** 497 * enum iwl_fw_dbg_trigger - triggers available 498 * 499 * @FW_DBG_TRIGGER_USER: trigger log collection by user 500 * This should not be defined as a trigger to the driver, but a value the 501 * driver should set to indicate that the trigger was initiated by the 502 * user. 503 * @FW_DBG_TRIGGER_FW_ASSERT: trigger log collection when the firmware asserts 504 * @FW_DBG_TRIGGER_MISSED_BEACONS: trigger log collection when beacons are 505 * missed. 506 * @FW_DBG_TRIGGER_CHANNEL_SWITCH: trigger log collection upon channel switch. 507 * @FW_DBG_TRIGGER_FW_NOTIF: trigger log collection when the firmware sends a 508 * command response or a notification. 509 * @FW_DBG_TRIGGER_MLME: trigger log collection upon MLME event. 510 * @FW_DBG_TRIGGER_STATS: trigger log collection upon statistics threshold. 511 * @FW_DBG_TRIGGER_RSSI: trigger log collection when the rssi of the beacon 512 * goes below a threshold. 513 * @FW_DBG_TRIGGER_TXQ_TIMERS: configures the timers for the Tx queue hang 514 * detection. 515 * @FW_DBG_TRIGGER_TIME_EVENT: trigger log collection upon time events related 516 * events. 517 * @FW_DBG_TRIGGER_BA: trigger log collection upon BlockAck related events. 518 * @FW_DBG_TX_LATENCY: trigger log collection when the tx latency goes above a 519 * threshold. 520 * @FW_DBG_TDLS: trigger log collection upon TDLS related events. 521 * @FW_DBG_TRIGGER_TX_STATUS: trigger log collection upon tx status when 522 * the firmware sends a tx reply. 523 * @FW_DBG_TRIGGER_ALIVE_TIMEOUT: trigger log collection if alive flow timeouts 524 * @FW_DBG_TRIGGER_DRIVER: trigger log collection upon a flow failure 525 * in the driver. 526 */ 527enum iwl_fw_dbg_trigger { 528 FW_DBG_TRIGGER_INVALID = 0, 529 FW_DBG_TRIGGER_USER, 530 FW_DBG_TRIGGER_FW_ASSERT, 531 FW_DBG_TRIGGER_MISSED_BEACONS, 532 FW_DBG_TRIGGER_CHANNEL_SWITCH, 533 FW_DBG_TRIGGER_FW_NOTIF, 534 FW_DBG_TRIGGER_MLME, 535 FW_DBG_TRIGGER_STATS, 536 FW_DBG_TRIGGER_RSSI, 537 FW_DBG_TRIGGER_TXQ_TIMERS, 538 FW_DBG_TRIGGER_TIME_EVENT, 539 FW_DBG_TRIGGER_BA, 540 FW_DBG_TRIGGER_TX_LATENCY, 541 FW_DBG_TRIGGER_TDLS, 542 FW_DBG_TRIGGER_TX_STATUS, 543 FW_DBG_TRIGGER_ALIVE_TIMEOUT, 544 FW_DBG_TRIGGER_DRIVER, 545 546 /* must be last */ 547 FW_DBG_TRIGGER_MAX, 548}; 549 550/** 551 * struct iwl_fw_error_dump_trigger_desc - describes the trigger condition 552 * @type: &enum iwl_fw_dbg_trigger 553 * @data: raw data about what happened 554 */ 555struct iwl_fw_error_dump_trigger_desc { 556 __le32 type; 557 u8 data[]; 558}; 559 560#endif /* __fw_error_dump_h__ */