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