2 * Copyright (c) 2017-2018 Cavium, Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 * POSSIBILITY OF SUCH DAMAGE.
32 #ifndef __ECORE_HSI_DEBUG_TOOLS__
33 #define __ECORE_HSI_DEBUG_TOOLS__
34 /****************************************/
35 /* Debug Tools HSI constants and macros */
36 /****************************************/
41 GRCBASE_GRC = 0x50000,
42 GRCBASE_MISCS = 0x9000,
43 GRCBASE_MISC = 0x8000,
45 GRCBASE_PGLUE_B = 0x2a8000,
46 GRCBASE_CNIG = 0x218000,
47 GRCBASE_CPMU = 0x30000,
48 GRCBASE_NCSI = 0x40000,
49 GRCBASE_OPTE = 0x53000,
50 GRCBASE_BMB = 0x540000,
51 GRCBASE_PCIE = 0x54000,
52 GRCBASE_MCP = 0xe00000,
53 GRCBASE_MCP2 = 0x52000,
54 GRCBASE_PSWHST = 0x2a0000,
55 GRCBASE_PSWHST2 = 0x29e000,
56 GRCBASE_PSWRD = 0x29c000,
57 GRCBASE_PSWRD2 = 0x29d000,
58 GRCBASE_PSWWR = 0x29a000,
59 GRCBASE_PSWWR2 = 0x29b000,
60 GRCBASE_PSWRQ = 0x280000,
61 GRCBASE_PSWRQ2 = 0x240000,
63 GRCBASE_DMAE = 0xc000,
64 GRCBASE_PTU = 0x560000,
65 GRCBASE_TCM = 0x1180000,
66 GRCBASE_MCM = 0x1200000,
67 GRCBASE_UCM = 0x1280000,
68 GRCBASE_XCM = 0x1000000,
69 GRCBASE_YCM = 0x1080000,
70 GRCBASE_PCM = 0x1100000,
71 GRCBASE_QM = 0x2f0000,
72 GRCBASE_TM = 0x2c0000,
73 GRCBASE_DORQ = 0x100000,
74 GRCBASE_BRB = 0x340000,
75 GRCBASE_SRC = 0x238000,
76 GRCBASE_PRS = 0x1f0000,
77 GRCBASE_TSDM = 0xfb0000,
78 GRCBASE_MSDM = 0xfc0000,
79 GRCBASE_USDM = 0xfd0000,
80 GRCBASE_XSDM = 0xf80000,
81 GRCBASE_YSDM = 0xf90000,
82 GRCBASE_PSDM = 0xfa0000,
83 GRCBASE_TSEM = 0x1700000,
84 GRCBASE_MSEM = 0x1800000,
85 GRCBASE_USEM = 0x1900000,
86 GRCBASE_XSEM = 0x1400000,
87 GRCBASE_YSEM = 0x1500000,
88 GRCBASE_PSEM = 0x1600000,
89 GRCBASE_RSS = 0x238800,
90 GRCBASE_TMLD = 0x4d0000,
91 GRCBASE_MULD = 0x4e0000,
92 GRCBASE_YULD = 0x4c8000,
93 GRCBASE_XYLD = 0x4c0000,
94 GRCBASE_PTLD = 0x590000,
95 GRCBASE_YPLD = 0x5b0000,
96 GRCBASE_PRM = 0x230000,
97 GRCBASE_PBF_PB1 = 0xda0000,
98 GRCBASE_PBF_PB2 = 0xda4000,
99 GRCBASE_RPB = 0x23c000,
100 GRCBASE_BTB = 0xdb0000,
101 GRCBASE_PBF = 0xd80000,
102 GRCBASE_RDIF = 0x300000,
103 GRCBASE_TDIF = 0x310000,
104 GRCBASE_CDU = 0x580000,
105 GRCBASE_CCFC = 0x2e0000,
106 GRCBASE_TCFC = 0x2d0000,
107 GRCBASE_IGU = 0x180000,
108 GRCBASE_CAU = 0x1c0000,
109 GRCBASE_RGFS = 0xf00000,
110 GRCBASE_RGSRC = 0x320000,
111 GRCBASE_TGFS = 0xd00000,
112 GRCBASE_TGSRC = 0x322000,
113 GRCBASE_UMAC = 0x51000,
114 GRCBASE_XMAC = 0x210000,
115 GRCBASE_DBG = 0x10000,
116 GRCBASE_NIG = 0x500000,
117 GRCBASE_WOL = 0x600000,
118 GRCBASE_BMBN = 0x610000,
119 GRCBASE_IPC = 0x20000,
120 GRCBASE_NWM = 0x800000,
121 GRCBASE_NWS = 0x700000,
122 GRCBASE_MS = 0x6a0000,
123 GRCBASE_PHY_PCIE = 0x620000,
124 GRCBASE_LED = 0x6b8000,
125 GRCBASE_AVS_WRAP = 0x6b0000,
126 GRCBASE_MISC_AEU = 0x8000,
127 GRCBASE_BAR0_MAP = 0x1c00000,
226 * binary debug buffer types
228 enum bin_dbg_buffer_type
230 BIN_BUF_DBG_MODE_TREE /* init modes tree */,
231 BIN_BUF_DBG_DUMP_REG /* GRC Dump registers */,
232 BIN_BUF_DBG_DUMP_MEM /* GRC Dump memories */,
233 BIN_BUF_DBG_IDLE_CHK_REGS /* Idle Check registers */,
234 BIN_BUF_DBG_IDLE_CHK_IMMS /* Idle Check immediates */,
235 BIN_BUF_DBG_IDLE_CHK_RULES /* Idle Check rules */,
236 BIN_BUF_DBG_IDLE_CHK_PARSING_DATA /* Idle Check parsing data */,
237 BIN_BUF_DBG_ATTN_BLOCKS /* Attention blocks */,
238 BIN_BUF_DBG_ATTN_REGS /* Attention registers */,
239 BIN_BUF_DBG_ATTN_INDEXES /* Attention indexes */,
240 BIN_BUF_DBG_ATTN_NAME_OFFSETS /* Attention name offsets */,
241 BIN_BUF_DBG_BUS_BLOCKS /* Debug Bus blocks */,
242 BIN_BUF_DBG_BUS_LINES /* Debug Bus lines */,
243 BIN_BUF_DBG_BUS_BLOCKS_USER_DATA /* Debug Bus blocks user data */,
244 BIN_BUF_DBG_BUS_LINE_NAME_OFFSETS /* Debug Bus line name offsets */,
245 BIN_BUF_DBG_PARSING_STRINGS /* Debug Tools parsing strings */,
246 MAX_BIN_DBG_BUFFER_TYPE
251 * Attention bit mapping
253 struct dbg_attn_bit_mapping
256 #define DBG_ATTN_BIT_MAPPING_VAL_MASK 0x7FFF /* The index of an attention in the blocks attentions list (if is_unused_bit_cnt=0), or a number of consecutive unused attention bits (if is_unused_bit_cnt=1) */
257 #define DBG_ATTN_BIT_MAPPING_VAL_SHIFT 0
258 #define DBG_ATTN_BIT_MAPPING_IS_UNUSED_BIT_CNT_MASK 0x1 /* if set, the val field indicates the number of consecutive unused attention bits */
259 #define DBG_ATTN_BIT_MAPPING_IS_UNUSED_BIT_CNT_SHIFT 15
264 * Attention block per-type data
266 struct dbg_attn_block_type_data
268 __le16 names_offset /* Offset of this block attention names in the debug attention name offsets array */;
270 u8 num_regs /* Number of attention registers in this block */;
272 __le16 regs_offset /* Offset of this blocks attention registers in the attention registers array (in dbg_attn_reg units) */;
278 struct dbg_attn_block
280 struct dbg_attn_block_type_data per_type_data[2] /* attention block per-type data. Count must match the number of elements in dbg_attn_type. */;
285 * Attention register result
287 struct dbg_attn_reg_result
290 #define DBG_ATTN_REG_RESULT_STS_ADDRESS_MASK 0xFFFFFF /* STS attention register GRC address (in dwords) */
291 #define DBG_ATTN_REG_RESULT_STS_ADDRESS_SHIFT 0
292 #define DBG_ATTN_REG_RESULT_NUM_REG_ATTN_MASK 0xFF /* Number of attention indexes in this register */
293 #define DBG_ATTN_REG_RESULT_NUM_REG_ATTN_SHIFT 24
294 __le16 block_attn_offset /* The offset of this registers attentions within the blocks attentions list (a value in the range 0..number of block attentions-1) */;
296 __le32 sts_val /* Value read from the STS attention register */;
297 __le32 mask_val /* Value read from the MASK attention register */;
301 * Attention block result
303 struct dbg_attn_block_result
305 u8 block_id /* Registers block ID */;
307 #define DBG_ATTN_BLOCK_RESULT_ATTN_TYPE_MASK 0x3 /* Value from dbg_attn_type enum */
308 #define DBG_ATTN_BLOCK_RESULT_ATTN_TYPE_SHIFT 0
309 #define DBG_ATTN_BLOCK_RESULT_NUM_REGS_MASK 0x3F /* Number of registers in the block in which at least one attention bit is set */
310 #define DBG_ATTN_BLOCK_RESULT_NUM_REGS_SHIFT 2
311 __le16 names_offset /* Offset of this registers block attention names in the attention name offsets array */;
312 struct dbg_attn_reg_result reg_results[15] /* result data for each register in the block in which at least one attention bit is set */;
323 #define DBG_MODE_HDR_EVAL_MODE_MASK 0x1 /* indicates if a mode expression should be evaluated (0/1) */
324 #define DBG_MODE_HDR_EVAL_MODE_SHIFT 0
325 #define DBG_MODE_HDR_MODES_BUF_OFFSET_MASK 0x7FFF /* offset (in bytes) in modes expression buffer. valid only if eval_mode is set. */
326 #define DBG_MODE_HDR_MODES_BUF_OFFSET_SHIFT 1
334 struct dbg_mode_hdr mode /* Mode header */;
335 __le16 block_attn_offset /* The offset of this registers attentions within the blocks attentions list (a value in the range 0..number of block attentions-1) */;
337 #define DBG_ATTN_REG_STS_ADDRESS_MASK 0xFFFFFF /* STS attention register GRC address (in dwords) */
338 #define DBG_ATTN_REG_STS_ADDRESS_SHIFT 0
339 #define DBG_ATTN_REG_NUM_REG_ATTN_MASK 0xFF /* Number of attention in this register */
340 #define DBG_ATTN_REG_NUM_REG_ATTN_SHIFT 24
341 __le32 sts_clr_address /* STS_CLR attention register GRC address (in dwords) */;
342 __le32 mask_address /* MASK attention register GRC address (in dwords) */;
359 * Debug Bus block data
363 u8 num_of_lines /* Number of debug lines in this block (excluding signature and latency events). */;
364 u8 has_latency_events /* Indicates if this block has a latency events debug line (0/1). */;
365 __le16 lines_offset /* Offset of this blocks lines in the Debug Bus lines array. */;
370 * Debug Bus block user data
372 struct dbg_bus_block_user_data
374 u8 num_of_lines /* Number of debug lines in this block (excluding signature and latency events). */;
375 u8 has_latency_events /* Indicates if this block has a latency events debug line (0/1). */;
376 __le16 names_offset /* Offset of this blocks lines in the debug bus line name offsets array. */;
381 * Block Debug line data
386 #define DBG_BUS_LINE_NUM_OF_GROUPS_MASK 0xF /* Number of groups in the line (0-3) */
387 #define DBG_BUS_LINE_NUM_OF_GROUPS_SHIFT 0
388 #define DBG_BUS_LINE_IS_256B_MASK 0x1 /* Indicates if this is a 128b line (0) or a 256b line (1). */
389 #define DBG_BUS_LINE_IS_256B_SHIFT 4
390 #define DBG_BUS_LINE_RESERVED_MASK 0x7
391 #define DBG_BUS_LINE_RESERVED_SHIFT 5
392 u8 group_sizes /* Four 2-bit values, indicating the size of each group minus 1 (i.e. value=0 means size=1, value=1 means size=2, etc), starting from lsb. The sizes are in dwords (if is_256b=0) or in qwords (if is_256b=1). */;
397 * condition header for registers dump
399 struct dbg_dump_cond_hdr
401 struct dbg_mode_hdr mode /* Mode header */;
402 u8 block_id /* block ID */;
403 u8 data_size /* size in dwords of the data following this header */;
408 * memory data for registers dump
413 #define DBG_DUMP_MEM_ADDRESS_MASK 0xFFFFFF /* register address (in dwords) */
414 #define DBG_DUMP_MEM_ADDRESS_SHIFT 0
415 #define DBG_DUMP_MEM_MEM_GROUP_ID_MASK 0xFF /* memory group ID */
416 #define DBG_DUMP_MEM_MEM_GROUP_ID_SHIFT 24
418 #define DBG_DUMP_MEM_LENGTH_MASK 0xFFFFFF /* register size (in dwords) */
419 #define DBG_DUMP_MEM_LENGTH_SHIFT 0
420 #define DBG_DUMP_MEM_WIDE_BUS_MASK 0x1 /* indicates if the register is wide-bus */
421 #define DBG_DUMP_MEM_WIDE_BUS_SHIFT 24
422 #define DBG_DUMP_MEM_RESERVED_MASK 0x7F
423 #define DBG_DUMP_MEM_RESERVED_SHIFT 25
428 * register data for registers dump
433 #define DBG_DUMP_REG_ADDRESS_MASK 0x7FFFFF /* register address (in dwords) */
434 #define DBG_DUMP_REG_ADDRESS_SHIFT 0
435 #define DBG_DUMP_REG_WIDE_BUS_MASK 0x1 /* indicates if the register is wide-bus */
436 #define DBG_DUMP_REG_WIDE_BUS_SHIFT 23
437 #define DBG_DUMP_REG_LENGTH_MASK 0xFF /* register size (in dwords) */
438 #define DBG_DUMP_REG_LENGTH_SHIFT 24
443 * split header for registers dump
445 struct dbg_dump_split_hdr
448 #define DBG_DUMP_SPLIT_HDR_DATA_SIZE_MASK 0xFFFFFF /* size in dwords of the data following this header */
449 #define DBG_DUMP_SPLIT_HDR_DATA_SIZE_SHIFT 0
450 #define DBG_DUMP_SPLIT_HDR_SPLIT_TYPE_ID_MASK 0xFF /* split type ID */
451 #define DBG_DUMP_SPLIT_HDR_SPLIT_TYPE_ID_SHIFT 24
456 * condition header for idle check
458 struct dbg_idle_chk_cond_hdr
460 struct dbg_mode_hdr mode /* Mode header */;
461 __le16 data_size /* size in dwords of the data following this header */;
466 * Idle Check condition register
468 struct dbg_idle_chk_cond_reg
471 #define DBG_IDLE_CHK_COND_REG_ADDRESS_MASK 0x7FFFFF /* Register GRC address (in dwords) */
472 #define DBG_IDLE_CHK_COND_REG_ADDRESS_SHIFT 0
473 #define DBG_IDLE_CHK_COND_REG_WIDE_BUS_MASK 0x1 /* indicates if the register is wide-bus */
474 #define DBG_IDLE_CHK_COND_REG_WIDE_BUS_SHIFT 23
475 #define DBG_IDLE_CHK_COND_REG_BLOCK_ID_MASK 0xFF /* value from block_id enum */
476 #define DBG_IDLE_CHK_COND_REG_BLOCK_ID_SHIFT 24
477 __le16 num_entries /* number of registers entries to check */;
478 u8 entry_size /* size of registers entry (in dwords) */;
479 u8 start_entry /* index of the first entry to check */;
484 * Idle Check info register
486 struct dbg_idle_chk_info_reg
489 #define DBG_IDLE_CHK_INFO_REG_ADDRESS_MASK 0x7FFFFF /* Register GRC address (in dwords) */
490 #define DBG_IDLE_CHK_INFO_REG_ADDRESS_SHIFT 0
491 #define DBG_IDLE_CHK_INFO_REG_WIDE_BUS_MASK 0x1 /* indicates if the register is wide-bus */
492 #define DBG_IDLE_CHK_INFO_REG_WIDE_BUS_SHIFT 23
493 #define DBG_IDLE_CHK_INFO_REG_BLOCK_ID_MASK 0xFF /* value from block_id enum */
494 #define DBG_IDLE_CHK_INFO_REG_BLOCK_ID_SHIFT 24
495 __le16 size /* register size in dwords */;
496 struct dbg_mode_hdr mode /* Mode header */;
501 * Idle Check register
503 union dbg_idle_chk_reg
505 struct dbg_idle_chk_cond_reg cond_reg /* condition register */;
506 struct dbg_idle_chk_info_reg info_reg /* info register */;
511 * Idle Check result header
513 struct dbg_idle_chk_result_hdr
515 __le16 rule_id /* Failing rule index */;
516 __le16 mem_entry_id /* Failing memory entry index */;
517 u8 num_dumped_cond_regs /* number of dumped condition registers */;
518 u8 num_dumped_info_regs /* number of dumped condition registers */;
519 u8 severity /* from dbg_idle_chk_severity_types enum */;
525 * Idle Check result register header
527 struct dbg_idle_chk_result_reg_hdr
530 #define DBG_IDLE_CHK_RESULT_REG_HDR_IS_MEM_MASK 0x1 /* indicates if this register is a memory */
531 #define DBG_IDLE_CHK_RESULT_REG_HDR_IS_MEM_SHIFT 0
532 #define DBG_IDLE_CHK_RESULT_REG_HDR_REG_ID_MASK 0x7F /* register index within the failing rule */
533 #define DBG_IDLE_CHK_RESULT_REG_HDR_REG_ID_SHIFT 1
534 u8 start_entry /* index of the first checked entry */;
535 __le16 size /* register size in dwords */;
542 struct dbg_idle_chk_rule
544 __le16 rule_id /* Idle Check rule ID */;
545 u8 severity /* value from dbg_idle_chk_severity_types enum */;
546 u8 cond_id /* Condition ID */;
547 u8 num_cond_regs /* number of condition registers */;
548 u8 num_info_regs /* number of info registers */;
549 u8 num_imms /* number of immediates in the condition */;
551 __le16 reg_offset /* offset of this rules registers in the idle check register array (in dbg_idle_chk_reg units) */;
552 __le16 imm_offset /* offset of this rules immediate values in the immediate values array (in dwords) */;
557 * Idle Check rule parsing data
559 struct dbg_idle_chk_rule_parsing_data
562 #define DBG_IDLE_CHK_RULE_PARSING_DATA_HAS_FW_MSG_MASK 0x1 /* indicates if this register has a FW message */
563 #define DBG_IDLE_CHK_RULE_PARSING_DATA_HAS_FW_MSG_SHIFT 0
564 #define DBG_IDLE_CHK_RULE_PARSING_DATA_STR_OFFSET_MASK 0x7FFFFFFF /* Offset of this rules strings in the debug strings array (in bytes) */
565 #define DBG_IDLE_CHK_RULE_PARSING_DATA_STR_OFFSET_SHIFT 1
570 * idle check severity types
572 enum dbg_idle_chk_severity_types
574 IDLE_CHK_SEVERITY_ERROR /* idle check failure should cause an error */,
575 IDLE_CHK_SEVERITY_ERROR_NO_TRAFFIC /* idle check failure should cause an error only if theres no traffic */,
576 IDLE_CHK_SEVERITY_WARNING /* idle check failure should cause a warning */,
577 MAX_DBG_IDLE_CHK_SEVERITY_TYPES
583 * Debug Bus block data
585 struct dbg_bus_block_data
588 #define DBG_BUS_BLOCK_DATA_ENABLE_MASK_MASK 0xF /* 4-bit value: bit i set -> dword/qword i is enabled. */
589 #define DBG_BUS_BLOCK_DATA_ENABLE_MASK_SHIFT 0
590 #define DBG_BUS_BLOCK_DATA_RIGHT_SHIFT_MASK 0xF /* Number of dwords/qwords to shift right the debug data (0-3) */
591 #define DBG_BUS_BLOCK_DATA_RIGHT_SHIFT_SHIFT 4
592 #define DBG_BUS_BLOCK_DATA_FORCE_VALID_MASK_MASK 0xF /* 4-bit value: bit i set -> dword/qword i is forced valid. */
593 #define DBG_BUS_BLOCK_DATA_FORCE_VALID_MASK_SHIFT 8
594 #define DBG_BUS_BLOCK_DATA_FORCE_FRAME_MASK_MASK 0xF /* 4-bit value: bit i set -> dword/qword i frame bit is forced. */
595 #define DBG_BUS_BLOCK_DATA_FORCE_FRAME_MASK_SHIFT 12
596 u8 line_num /* Debug line number to select */;
597 u8 hw_id /* HW ID associated with the block */;
616 DBG_BUS_CLIENT_OTHER_ENGINE,
617 DBG_BUS_CLIENT_TIMESTAMP,
630 * Debug Bus constraint operation types
632 enum dbg_bus_constraint_ops
634 DBG_BUS_CONSTRAINT_OP_EQ /* equal */,
635 DBG_BUS_CONSTRAINT_OP_NE /* not equal */,
636 DBG_BUS_CONSTRAINT_OP_LT /* less than */,
637 DBG_BUS_CONSTRAINT_OP_LTC /* less than (cyclic) */,
638 DBG_BUS_CONSTRAINT_OP_LE /* less than or equal */,
639 DBG_BUS_CONSTRAINT_OP_LEC /* less than or equal (cyclic) */,
640 DBG_BUS_CONSTRAINT_OP_GT /* greater than */,
641 DBG_BUS_CONSTRAINT_OP_GTC /* greater than (cyclic) */,
642 DBG_BUS_CONSTRAINT_OP_GE /* greater than or equal */,
643 DBG_BUS_CONSTRAINT_OP_GEC /* greater than or equal (cyclic) */,
644 MAX_DBG_BUS_CONSTRAINT_OPS
649 * Debug Bus trigger state data
651 struct dbg_bus_trigger_state_data
654 #define DBG_BUS_TRIGGER_STATE_DATA_BLOCK_SHIFTED_ENABLE_MASK_MASK 0xF /* 4-bit value: bit i set -> dword i of the trigger state block (after right shift) is enabled. */
655 #define DBG_BUS_TRIGGER_STATE_DATA_BLOCK_SHIFTED_ENABLE_MASK_SHIFT 0
656 #define DBG_BUS_TRIGGER_STATE_DATA_CONSTRAINT_DWORD_MASK_MASK 0xF /* 4-bit value: bit i set -> dword i is compared by a constraint */
657 #define DBG_BUS_TRIGGER_STATE_DATA_CONSTRAINT_DWORD_MASK_SHIFT 4
661 * Debug Bus memory address
663 struct dbg_bus_mem_addr
670 * Debug Bus PCI buffer data
672 struct dbg_bus_pci_buf_data
674 struct dbg_bus_mem_addr phys_addr /* PCI buffer physical address */;
675 struct dbg_bus_mem_addr virt_addr /* PCI buffer virtual address */;
676 __le32 size /* PCI buffer size in bytes */;
680 * Debug Bus Storm EID range filter params
682 struct dbg_bus_storm_eid_range_params
684 u8 min /* Minimal event ID to filter on */;
685 u8 max /* Maximal event ID to filter on */;
689 * Debug Bus Storm EID mask filter params
691 struct dbg_bus_storm_eid_mask_params
693 u8 val /* Event ID value */;
694 u8 mask /* Event ID mask. 1s in the mask = dont care bits. */;
698 * Debug Bus Storm EID filter params
700 union dbg_bus_storm_eid_params
702 struct dbg_bus_storm_eid_range_params range /* EID range filter params */;
703 struct dbg_bus_storm_eid_mask_params mask /* EID mask filter params */;
707 * Debug Bus Storm data
709 struct dbg_bus_storm_data
711 u8 enabled /* indicates if the Storm is enabled for recording */;
712 u8 mode /* Storm debug mode, valid only if the Storm is enabled */;
713 u8 hw_id /* HW ID associated with the Storm */;
714 u8 eid_filter_en /* Indicates if EID filtering is performed (0/1) */;
715 u8 eid_range_not_mask /* 1 = EID range filter, 0 = EID mask filter. Valid only if eid_filter_en is set, */;
716 u8 cid_filter_en /* Indicates if CID filtering is performed (0/1) */;
717 union dbg_bus_storm_eid_params eid_filter_params /* EID filter params to filter on. Valid only if eid_filter_en is set. */;
718 __le32 cid /* CID to filter on. Valid only if cid_filter_en is set. */;
726 __le32 app_version /* The tools version number of the application */;
727 u8 state /* The current debug bus state */;
728 u8 hw_dwords /* HW dwords per cycle */;
729 __le16 hw_id_mask /* The HW IDs of the recorded HW blocks, where bits i*3..i*3+2 contain the HW ID of dword/qword i */;
730 u8 num_enabled_blocks /* Number of blocks enabled for recording */;
731 u8 num_enabled_storms /* Number of Storms enabled for recording */;
732 u8 target /* Output target */;
733 u8 one_shot_en /* Indicates if one-shot mode is enabled (0/1) */;
734 u8 grc_input_en /* Indicates if GRC recording is enabled (0/1) */;
735 u8 timestamp_input_en /* Indicates if timestamp recording is enabled (0/1) */;
736 u8 filter_en /* Indicates if the recording filter is enabled (0/1) */;
737 u8 adding_filter /* If true, the next added constraint belong to the filter. Otherwise, it belongs to the last added trigger state. Valid only if either filter or triggers are enabled. */;
738 u8 filter_pre_trigger /* Indicates if the recording filter should be applied before the trigger. Valid only if both filter and trigger are enabled (0/1) */;
739 u8 filter_post_trigger /* Indicates if the recording filter should be applied after the trigger. Valid only if both filter and trigger are enabled (0/1) */;
741 u8 trigger_en /* Indicates if the recording trigger is enabled (0/1) */;
742 struct dbg_bus_trigger_state_data trigger_states[3] /* trigger states data */;
743 u8 next_trigger_state /* ID of next trigger state to be added */;
744 u8 next_constraint_id /* ID of next filter/trigger constraint to be added */;
745 u8 unify_inputs /* If true, all inputs are associated with HW ID 0. Otherwise, each input is assigned a different HW ID (0/1) */;
746 u8 rcv_from_other_engine /* Indicates if the other engine sends it NW recording to this engine (0/1) */;
747 struct dbg_bus_pci_buf_data pci_buf /* Debug Bus PCI buffer data. Valid only when the target is DBG_BUS_TARGET_ID_PCI. */;
748 struct dbg_bus_block_data blocks[88] /* Debug Bus data for each block */;
749 struct dbg_bus_storm_data storms[6] /* Debug Bus data for each block */;
754 * Debug bus filter types
756 enum dbg_bus_filter_types
758 DBG_BUS_FILTER_TYPE_OFF /* filter always off */,
759 DBG_BUS_FILTER_TYPE_PRE /* filter before trigger only */,
760 DBG_BUS_FILTER_TYPE_POST /* filter after trigger only */,
761 DBG_BUS_FILTER_TYPE_ON /* filter always on */,
762 MAX_DBG_BUS_FILTER_TYPES
767 * Debug bus frame modes
769 enum dbg_bus_frame_modes
771 DBG_BUS_FRAME_MODE_0HW_4ST=0 /* 0 HW dwords, 4 Storm dwords */,
772 DBG_BUS_FRAME_MODE_4HW_0ST=3 /* 4 HW dwords, 0 Storm dwords */,
773 DBG_BUS_FRAME_MODE_8HW_0ST=4 /* 8 HW dwords, 0 Storm dwords */,
774 MAX_DBG_BUS_FRAME_MODES
780 * Debug bus other engine mode
782 enum dbg_bus_other_engine_modes
784 DBG_BUS_OTHER_ENGINE_MODE_NONE,
785 DBG_BUS_OTHER_ENGINE_MODE_DOUBLE_BW_TX,
786 DBG_BUS_OTHER_ENGINE_MODE_DOUBLE_BW_RX,
787 DBG_BUS_OTHER_ENGINE_MODE_CROSS_ENGINE_TX,
788 DBG_BUS_OTHER_ENGINE_MODE_CROSS_ENGINE_RX,
789 MAX_DBG_BUS_OTHER_ENGINE_MODES
795 * Debug bus post-trigger recording types
797 enum dbg_bus_post_trigger_types
799 DBG_BUS_POST_TRIGGER_RECORD /* start recording after trigger */,
800 DBG_BUS_POST_TRIGGER_DROP /* drop data after trigger */,
801 MAX_DBG_BUS_POST_TRIGGER_TYPES
806 * Debug bus pre-trigger recording types
808 enum dbg_bus_pre_trigger_types
810 DBG_BUS_PRE_TRIGGER_START_FROM_ZERO /* start recording from time 0 */,
811 DBG_BUS_PRE_TRIGGER_NUM_CHUNKS /* start recording some chunks before trigger */,
812 DBG_BUS_PRE_TRIGGER_DROP /* drop data before trigger */,
813 MAX_DBG_BUS_PRE_TRIGGER_TYPES
818 * Debug bus SEMI frame modes
820 enum dbg_bus_semi_frame_modes
822 DBG_BUS_SEMI_FRAME_MODE_0SLOW_4FAST=0 /* 0 slow dwords, 4 fast dwords */,
823 DBG_BUS_SEMI_FRAME_MODE_4SLOW_0FAST=3 /* 4 slow dwords, 0 fast dwords */,
824 MAX_DBG_BUS_SEMI_FRAME_MODES
833 DBG_BUS_STATE_IDLE /* debug bus idle state (not recording) */,
834 DBG_BUS_STATE_READY /* debug bus is ready for configuration and recording */,
835 DBG_BUS_STATE_RECORDING /* debug bus is currently recording */,
836 DBG_BUS_STATE_STOPPED /* debug bus recording has stopped */,
846 * Debug Bus Storm modes
848 enum dbg_bus_storm_modes
850 DBG_BUS_STORM_MODE_PRINTF /* store data (fast debug) */,
851 DBG_BUS_STORM_MODE_PRAM_ADDR /* pram address (fast debug) */,
852 DBG_BUS_STORM_MODE_DRA_RW /* DRA read/write data (fast debug) */,
853 DBG_BUS_STORM_MODE_DRA_W /* DRA write data (fast debug) */,
854 DBG_BUS_STORM_MODE_LD_ST_ADDR /* load/store address (fast debug) */,
855 DBG_BUS_STORM_MODE_DRA_FSM /* DRA state machines (fast debug) */,
856 DBG_BUS_STORM_MODE_RH /* recording handlers (fast debug) */,
857 DBG_BUS_STORM_MODE_FOC /* FOC: FIN + DRA Rd (slow debug) */,
858 DBG_BUS_STORM_MODE_EXT_STORE /* FOC: External Store (slow) */,
859 MAX_DBG_BUS_STORM_MODES
864 * Debug bus target IDs
868 DBG_BUS_TARGET_ID_INT_BUF /* records debug bus to DBG block internal buffer */,
869 DBG_BUS_TARGET_ID_NIG /* records debug bus to the NW */,
870 DBG_BUS_TARGET_ID_PCI /* records debug bus to a PCI buffer */,
881 u8 params_initialized /* Indicates if the GRC parameters were initialized */;
884 __le32 param_val[48] /* Value of each GRC parameter. Array size must match the enum dbg_grc_params. */;
893 DBG_GRC_PARAM_DUMP_TSTORM /* dump Tstorm memories (0/1) */,
894 DBG_GRC_PARAM_DUMP_MSTORM /* dump Mstorm memories (0/1) */,
895 DBG_GRC_PARAM_DUMP_USTORM /* dump Ustorm memories (0/1) */,
896 DBG_GRC_PARAM_DUMP_XSTORM /* dump Xstorm memories (0/1) */,
897 DBG_GRC_PARAM_DUMP_YSTORM /* dump Ystorm memories (0/1) */,
898 DBG_GRC_PARAM_DUMP_PSTORM /* dump Pstorm memories (0/1) */,
899 DBG_GRC_PARAM_DUMP_REGS /* dump non-memory registers (0/1) */,
900 DBG_GRC_PARAM_DUMP_RAM /* dump Storm internal RAMs (0/1) */,
901 DBG_GRC_PARAM_DUMP_PBUF /* dump Storm passive buffer (0/1) */,
902 DBG_GRC_PARAM_DUMP_IOR /* dump Storm IORs (0/1) */,
903 DBG_GRC_PARAM_DUMP_VFC /* dump VFC memories (0/1) */,
904 DBG_GRC_PARAM_DUMP_CM_CTX /* dump CM contexts (0/1) */,
905 DBG_GRC_PARAM_DUMP_PXP /* dump PXP memories (0/1) */,
906 DBG_GRC_PARAM_DUMP_RSS /* dump RSS memories (0/1) */,
907 DBG_GRC_PARAM_DUMP_CAU /* dump CAU memories (0/1) */,
908 DBG_GRC_PARAM_DUMP_QM /* dump QM memories (0/1) */,
909 DBG_GRC_PARAM_DUMP_MCP /* dump MCP memories (0/1) */,
910 DBG_GRC_PARAM_RESERVED /* reserved */,
911 DBG_GRC_PARAM_DUMP_CFC /* dump CFC memories (0/1) */,
912 DBG_GRC_PARAM_DUMP_IGU /* dump IGU memories (0/1) */,
913 DBG_GRC_PARAM_DUMP_BRB /* dump BRB memories (0/1) */,
914 DBG_GRC_PARAM_DUMP_BTB /* dump BTB memories (0/1) */,
915 DBG_GRC_PARAM_DUMP_BMB /* dump BMB memories (0/1) */,
916 DBG_GRC_PARAM_DUMP_NIG /* dump NIG memories (0/1) */,
917 DBG_GRC_PARAM_DUMP_MULD /* dump MULD memories (0/1) */,
918 DBG_GRC_PARAM_DUMP_PRS /* dump PRS memories (0/1) */,
919 DBG_GRC_PARAM_DUMP_DMAE /* dump PRS memories (0/1) */,
920 DBG_GRC_PARAM_DUMP_TM /* dump TM (timers) memories (0/1) */,
921 DBG_GRC_PARAM_DUMP_SDM /* dump SDM memories (0/1) */,
922 DBG_GRC_PARAM_DUMP_DIF /* dump DIF memories (0/1) */,
923 DBG_GRC_PARAM_DUMP_STATIC /* dump static debug data (0/1) */,
924 DBG_GRC_PARAM_UNSTALL /* un-stall Storms after dump (0/1) */,
925 DBG_GRC_PARAM_NUM_LCIDS /* number of LCIDs (0..320) */,
926 DBG_GRC_PARAM_NUM_LTIDS /* number of LTIDs (0..320) */,
927 DBG_GRC_PARAM_EXCLUDE_ALL /* preset: exclude all memories from dump (1 only) */,
928 DBG_GRC_PARAM_CRASH /* preset: include memories for crash dump (1 only) */,
929 DBG_GRC_PARAM_PARITY_SAFE /* perform dump only if MFW is responding (0/1) */,
930 DBG_GRC_PARAM_DUMP_CM /* dump CM memories (0/1) */,
931 DBG_GRC_PARAM_DUMP_PHY /* dump PHY memories (0/1) */,
932 DBG_GRC_PARAM_NO_MCP /* dont perform MCP commands (0/1) */,
933 DBG_GRC_PARAM_NO_FW_VER /* dont read FW/MFW version (0/1) */,
939 * Debug reset registers
943 DBG_RESET_REG_MISCS_PL_UA,
944 DBG_RESET_REG_MISCS_PL_HV,
945 DBG_RESET_REG_MISCS_PL_HV_2,
946 DBG_RESET_REG_MISC_PL_UA,
947 DBG_RESET_REG_MISC_PL_HV,
948 DBG_RESET_REG_MISC_PL_PDA_VMAIN_1,
949 DBG_RESET_REG_MISC_PL_PDA_VMAIN_2,
950 DBG_RESET_REG_MISC_PL_PDA_VAUX,
961 DBG_STATUS_APP_VERSION_NOT_SET,
962 DBG_STATUS_UNSUPPORTED_APP_VERSION,
963 DBG_STATUS_DBG_BLOCK_NOT_RESET,
964 DBG_STATUS_INVALID_ARGS,
965 DBG_STATUS_OUTPUT_ALREADY_SET,
966 DBG_STATUS_INVALID_PCI_BUF_SIZE,
967 DBG_STATUS_PCI_BUF_ALLOC_FAILED,
968 DBG_STATUS_PCI_BUF_NOT_ALLOCATED,
969 DBG_STATUS_TOO_MANY_INPUTS,
970 DBG_STATUS_INPUT_OVERLAP,
971 DBG_STATUS_HW_ONLY_RECORDING,
972 DBG_STATUS_STORM_ALREADY_ENABLED,
973 DBG_STATUS_STORM_NOT_ENABLED,
974 DBG_STATUS_BLOCK_ALREADY_ENABLED,
975 DBG_STATUS_BLOCK_NOT_ENABLED,
976 DBG_STATUS_NO_INPUT_ENABLED,
977 DBG_STATUS_NO_FILTER_TRIGGER_64B,
978 DBG_STATUS_FILTER_ALREADY_ENABLED,
979 DBG_STATUS_TRIGGER_ALREADY_ENABLED,
980 DBG_STATUS_TRIGGER_NOT_ENABLED,
981 DBG_STATUS_CANT_ADD_CONSTRAINT,
982 DBG_STATUS_TOO_MANY_TRIGGER_STATES,
983 DBG_STATUS_TOO_MANY_CONSTRAINTS,
984 DBG_STATUS_RECORDING_NOT_STARTED,
985 DBG_STATUS_DATA_DIDNT_TRIGGER,
986 DBG_STATUS_NO_DATA_RECORDED,
987 DBG_STATUS_DUMP_BUF_TOO_SMALL,
988 DBG_STATUS_DUMP_NOT_CHUNK_ALIGNED,
989 DBG_STATUS_UNKNOWN_CHIP,
990 DBG_STATUS_VIRT_MEM_ALLOC_FAILED,
991 DBG_STATUS_BLOCK_IN_RESET,
992 DBG_STATUS_INVALID_TRACE_SIGNATURE,
993 DBG_STATUS_INVALID_NVRAM_BUNDLE,
994 DBG_STATUS_NVRAM_GET_IMAGE_FAILED,
995 DBG_STATUS_NON_ALIGNED_NVRAM_IMAGE,
996 DBG_STATUS_NVRAM_READ_FAILED,
997 DBG_STATUS_IDLE_CHK_PARSE_FAILED,
998 DBG_STATUS_MCP_TRACE_BAD_DATA,
999 DBG_STATUS_MCP_TRACE_NO_META,
1000 DBG_STATUS_MCP_COULD_NOT_HALT,
1001 DBG_STATUS_MCP_COULD_NOT_RESUME,
1002 DBG_STATUS_DMAE_FAILED,
1003 DBG_STATUS_SEMI_FIFO_NOT_EMPTY,
1004 DBG_STATUS_IGU_FIFO_BAD_DATA,
1005 DBG_STATUS_MCP_COULD_NOT_MASK_PRTY,
1006 DBG_STATUS_FW_ASSERTS_PARSE_FAILED,
1007 DBG_STATUS_REG_FIFO_BAD_DATA,
1008 DBG_STATUS_PROTECTION_OVERRIDE_BAD_DATA,
1009 DBG_STATUS_DBG_ARRAY_NOT_SET,
1010 DBG_STATUS_FILTER_BUG,
1011 DBG_STATUS_NON_MATCHING_LINES,
1012 DBG_STATUS_INVALID_TRIGGER_DWORD_OFFSET,
1013 DBG_STATUS_DBG_BUS_IN_USE,
1036 struct idle_chk_data
1038 __le32 buf_size /* Idle check buffer size in dwords */;
1039 u8 buf_size_set /* Indicates if the idle check buffer size was set (0/1) */;
1045 * Debug Tools data (per HW function)
1047 struct dbg_tools_data
1049 struct dbg_grc_data grc /* GRC Dump data */;
1050 struct dbg_bus_data bus /* Debug Bus data */;
1051 struct idle_chk_data idle_chk /* Idle Check data */;
1052 u8 mode_enable[40] /* Indicates if a mode is enabled (0/1) */;
1053 u8 block_in_reset[88] /* Indicates if a block is in reset state (0/1) */;
1054 u8 chip_id /* Chip ID (from enum chip_ids) */;
1055 u8 platform_id /* Platform ID */;
1056 u8 initialized /* Indicates if the data was initialized */;
1061 #endif /* __ECORE_HSI_DEBUG_TOOLS__ */