2 * Copyright (c) 2016 - 2018 Cavium Inc.
6 * See LICENSE.qede_pmd for copyright and licensing details.
9 #ifndef __ECORE_HSI_DEBUG_TOOLS__
10 #define __ECORE_HSI_DEBUG_TOOLS__
11 /****************************************/
12 /* Debug Tools HSI constants and macros */
13 /****************************************/
17 GRCBASE_GRC = 0x50000,
18 GRCBASE_MISCS = 0x9000,
19 GRCBASE_MISC = 0x8000,
21 GRCBASE_PGLUE_B = 0x2a8000,
22 GRCBASE_CNIG = 0x218000,
23 GRCBASE_CPMU = 0x30000,
24 GRCBASE_NCSI = 0x40000,
25 GRCBASE_OPTE = 0x53000,
26 GRCBASE_BMB = 0x540000,
27 GRCBASE_PCIE = 0x54000,
28 GRCBASE_MCP = 0xe00000,
29 GRCBASE_MCP2 = 0x52000,
30 GRCBASE_PSWHST = 0x2a0000,
31 GRCBASE_PSWHST2 = 0x29e000,
32 GRCBASE_PSWRD = 0x29c000,
33 GRCBASE_PSWRD2 = 0x29d000,
34 GRCBASE_PSWWR = 0x29a000,
35 GRCBASE_PSWWR2 = 0x29b000,
36 GRCBASE_PSWRQ = 0x280000,
37 GRCBASE_PSWRQ2 = 0x240000,
39 GRCBASE_DMAE = 0xc000,
40 GRCBASE_PTU = 0x560000,
41 GRCBASE_TCM = 0x1180000,
42 GRCBASE_MCM = 0x1200000,
43 GRCBASE_UCM = 0x1280000,
44 GRCBASE_XCM = 0x1000000,
45 GRCBASE_YCM = 0x1080000,
46 GRCBASE_PCM = 0x1100000,
47 GRCBASE_QM = 0x2f0000,
48 GRCBASE_TM = 0x2c0000,
49 GRCBASE_DORQ = 0x100000,
50 GRCBASE_BRB = 0x340000,
51 GRCBASE_SRC = 0x238000,
52 GRCBASE_PRS = 0x1f0000,
53 GRCBASE_TSDM = 0xfb0000,
54 GRCBASE_MSDM = 0xfc0000,
55 GRCBASE_USDM = 0xfd0000,
56 GRCBASE_XSDM = 0xf80000,
57 GRCBASE_YSDM = 0xf90000,
58 GRCBASE_PSDM = 0xfa0000,
59 GRCBASE_TSEM = 0x1700000,
60 GRCBASE_MSEM = 0x1800000,
61 GRCBASE_USEM = 0x1900000,
62 GRCBASE_XSEM = 0x1400000,
63 GRCBASE_YSEM = 0x1500000,
64 GRCBASE_PSEM = 0x1600000,
65 GRCBASE_RSS = 0x238800,
66 GRCBASE_TMLD = 0x4d0000,
67 GRCBASE_MULD = 0x4e0000,
68 GRCBASE_YULD = 0x4c8000,
69 GRCBASE_XYLD = 0x4c0000,
70 GRCBASE_PTLD = 0x590000,
71 GRCBASE_YPLD = 0x5b0000,
72 GRCBASE_PRM = 0x230000,
73 GRCBASE_PBF_PB1 = 0xda0000,
74 GRCBASE_PBF_PB2 = 0xda4000,
75 GRCBASE_RPB = 0x23c000,
76 GRCBASE_BTB = 0xdb0000,
77 GRCBASE_PBF = 0xd80000,
78 GRCBASE_RDIF = 0x300000,
79 GRCBASE_TDIF = 0x310000,
80 GRCBASE_CDU = 0x580000,
81 GRCBASE_CCFC = 0x2e0000,
82 GRCBASE_TCFC = 0x2d0000,
83 GRCBASE_IGU = 0x180000,
84 GRCBASE_CAU = 0x1c0000,
85 GRCBASE_RGFS = 0xf00000,
86 GRCBASE_RGSRC = 0x320000,
87 GRCBASE_TGFS = 0xd00000,
88 GRCBASE_TGSRC = 0x322000,
89 GRCBASE_UMAC = 0x51000,
90 GRCBASE_XMAC = 0x210000,
91 GRCBASE_DBG = 0x10000,
92 GRCBASE_NIG = 0x500000,
93 GRCBASE_WOL = 0x600000,
94 GRCBASE_BMBN = 0x610000,
95 GRCBASE_IPC = 0x20000,
96 GRCBASE_NWM = 0x800000,
97 GRCBASE_NWS = 0x700000,
98 GRCBASE_MS = 0x6a0000,
99 GRCBASE_PHY_PCIE = 0x620000,
100 GRCBASE_LED = 0x6b8000,
101 GRCBASE_AVS_WRAP = 0x6b0000,
102 GRCBASE_MISC_AEU = 0x8000,
103 GRCBASE_BAR0_MAP = 0x1c00000,
201 * binary debug buffer types
203 enum bin_dbg_buffer_type {
204 BIN_BUF_DBG_MODE_TREE /* init modes tree */,
205 BIN_BUF_DBG_DUMP_REG /* GRC Dump registers */,
206 BIN_BUF_DBG_DUMP_MEM /* GRC Dump memories */,
207 BIN_BUF_DBG_IDLE_CHK_REGS /* Idle Check registers */,
208 BIN_BUF_DBG_IDLE_CHK_IMMS /* Idle Check immediates */,
209 BIN_BUF_DBG_IDLE_CHK_RULES /* Idle Check rules */,
210 BIN_BUF_DBG_IDLE_CHK_PARSING_DATA /* Idle Check parsing data */,
211 BIN_BUF_DBG_ATTN_BLOCKS /* Attention blocks */,
212 BIN_BUF_DBG_ATTN_REGS /* Attention registers */,
213 BIN_BUF_DBG_ATTN_INDEXES /* Attention indexes */,
214 BIN_BUF_DBG_ATTN_NAME_OFFSETS /* Attention name offsets */,
215 BIN_BUF_DBG_BUS_BLOCKS /* Debug Bus blocks */,
216 BIN_BUF_DBG_BUS_LINES /* Debug Bus lines */,
217 BIN_BUF_DBG_BUS_BLOCKS_USER_DATA /* Debug Bus blocks user data */,
218 BIN_BUF_DBG_BUS_LINE_NAME_OFFSETS /* Debug Bus line name offsets */,
219 BIN_BUF_DBG_PARSING_STRINGS /* Debug Tools parsing strings */,
220 MAX_BIN_DBG_BUFFER_TYPE
225 * Attention bit mapping
227 struct dbg_attn_bit_mapping {
229 /* The index of an attention in the blocks attentions list
230 * (if is_unused_bit_cnt=0), or a number of consecutive unused attention bits
231 * (if is_unused_bit_cnt=1)
233 #define DBG_ATTN_BIT_MAPPING_VAL_MASK 0x7FFF
234 #define DBG_ATTN_BIT_MAPPING_VAL_SHIFT 0
235 /* if set, the val field indicates the number of consecutive unused attention
238 #define DBG_ATTN_BIT_MAPPING_IS_UNUSED_BIT_CNT_MASK 0x1
239 #define DBG_ATTN_BIT_MAPPING_IS_UNUSED_BIT_CNT_SHIFT 15
244 * Attention block per-type data
246 struct dbg_attn_block_type_data {
247 /* Offset of this block attention names in the debug attention name offsets
252 u8 num_regs /* Number of attention registers in this block */;
254 /* Offset of this blocks attention registers in the attention registers array
255 * (in dbg_attn_reg units)
263 struct dbg_attn_block {
264 /* attention block per-type data. Count must match the number of elements in
267 struct dbg_attn_block_type_data per_type_data[2];
272 * Attention register result
274 struct dbg_attn_reg_result {
276 /* STS attention register GRC address (in dwords) */
277 #define DBG_ATTN_REG_RESULT_STS_ADDRESS_MASK 0xFFFFFF
278 #define DBG_ATTN_REG_RESULT_STS_ADDRESS_SHIFT 0
279 /* Number of attention indexes in this register */
280 #define DBG_ATTN_REG_RESULT_NUM_REG_ATTN_MASK 0xFF
281 #define DBG_ATTN_REG_RESULT_NUM_REG_ATTN_SHIFT 24
282 /* The offset of this registers attentions within the blocks attentions list
283 * (a value in the range 0..number of block attentions-1)
285 u16 block_attn_offset;
287 u32 sts_val /* Value read from the STS attention register */;
288 u32 mask_val /* Value read from the MASK attention register */;
292 * Attention block result
294 struct dbg_attn_block_result {
295 u8 block_id /* Registers block ID */;
297 /* Value from dbg_attn_type enum */
298 #define DBG_ATTN_BLOCK_RESULT_ATTN_TYPE_MASK 0x3
299 #define DBG_ATTN_BLOCK_RESULT_ATTN_TYPE_SHIFT 0
300 /* Number of registers in block in which at least one attention bit is set */
301 #define DBG_ATTN_BLOCK_RESULT_NUM_REGS_MASK 0x3F
302 #define DBG_ATTN_BLOCK_RESULT_NUM_REGS_SHIFT 2
303 /* Offset of this registers block attention names in the attention name offsets
307 /* result data for each register in the block in which at least one attention
310 struct dbg_attn_reg_result reg_results[15];
318 struct dbg_mode_hdr {
320 /* indicates if a mode expression should be evaluated (0/1) */
321 #define DBG_MODE_HDR_EVAL_MODE_MASK 0x1
322 #define DBG_MODE_HDR_EVAL_MODE_SHIFT 0
323 /* offset (in bytes) in modes expression buffer. valid only if eval_mode is
326 #define DBG_MODE_HDR_MODES_BUF_OFFSET_MASK 0x7FFF
327 #define DBG_MODE_HDR_MODES_BUF_OFFSET_SHIFT 1
333 struct dbg_attn_reg {
334 /* The offset of this registers attentions within the blocks attentions list
335 * (a value in the range 0..number of block attentions-1)
337 u16 block_attn_offset;
339 /* STS attention register GRC address (in dwords) */
340 #define DBG_ATTN_REG_STS_ADDRESS_MASK 0xFFFFFF
341 #define DBG_ATTN_REG_STS_ADDRESS_SHIFT 0
342 /* Number of attention in this register */
343 #define DBG_ATTN_REG_NUM_REG_ATTN_MASK 0xFF
344 #define DBG_ATTN_REG_NUM_REG_ATTN_SHIFT 24
345 /* STS_CLR attention register GRC address (in dwords) */
347 u32 mask_address /* MASK attention register GRC address (in dwords) */;
363 * Debug Bus block data
365 struct dbg_bus_block {
366 /* Number of debug lines in this block (excluding signature & latency events) */
368 /* Indicates if this block has a latency events debug line (0/1). */
369 u8 has_latency_events;
370 /* Offset of this blocks lines in the Debug Bus lines array. */
376 * Debug Bus block user data
378 struct dbg_bus_block_user_data {
379 /* Number of debug lines in this block (excluding signature & latency events) */
381 /* Indicates if this block has a latency events debug line (0/1). */
382 u8 has_latency_events;
383 /* Offset of this blocks lines in the debug bus line name offsets array. */
389 * Block Debug line data
391 struct dbg_bus_line {
393 /* Number of groups in the line (0-3) */
394 #define DBG_BUS_LINE_NUM_OF_GROUPS_MASK 0xF
395 #define DBG_BUS_LINE_NUM_OF_GROUPS_SHIFT 0
396 /* Indicates if this is a 128b line (0) or a 256b line (1). */
397 #define DBG_BUS_LINE_IS_256B_MASK 0x1
398 #define DBG_BUS_LINE_IS_256B_SHIFT 4
399 #define DBG_BUS_LINE_RESERVED_MASK 0x7
400 #define DBG_BUS_LINE_RESERVED_SHIFT 5
401 /* Four 2-bit values, indicating the size of each group minus 1 (i.e.
402 * value=0 means size=1, value=1 means size=2, etc), starting from lsb.
403 * The sizes are in dwords (if is_256b=0) or in qwords (if is_256b=1).
410 * condition header for registers dump
412 struct dbg_dump_cond_hdr {
413 struct dbg_mode_hdr mode /* Mode header */;
414 u8 block_id /* block ID */;
415 u8 data_size /* size in dwords of the data following this header */;
420 * memory data for registers dump
422 struct dbg_dump_mem {
424 /* register address (in dwords) */
425 #define DBG_DUMP_MEM_ADDRESS_MASK 0xFFFFFF
426 #define DBG_DUMP_MEM_ADDRESS_SHIFT 0
427 #define DBG_DUMP_MEM_MEM_GROUP_ID_MASK 0xFF /* memory group ID */
428 #define DBG_DUMP_MEM_MEM_GROUP_ID_SHIFT 24
430 /* register size (in dwords) */
431 #define DBG_DUMP_MEM_LENGTH_MASK 0xFFFFFF
432 #define DBG_DUMP_MEM_LENGTH_SHIFT 0
433 /* indicates if the register is wide-bus */
434 #define DBG_DUMP_MEM_WIDE_BUS_MASK 0x1
435 #define DBG_DUMP_MEM_WIDE_BUS_SHIFT 24
436 #define DBG_DUMP_MEM_RESERVED_MASK 0x7F
437 #define DBG_DUMP_MEM_RESERVED_SHIFT 25
442 * register data for registers dump
444 struct dbg_dump_reg {
446 /* register address (in dwords) */
447 #define DBG_DUMP_REG_ADDRESS_MASK 0x7FFFFF /* register address (in dwords) */
448 #define DBG_DUMP_REG_ADDRESS_SHIFT 0
449 /* indicates if the register is wide-bus */
450 #define DBG_DUMP_REG_WIDE_BUS_MASK 0x1
451 #define DBG_DUMP_REG_WIDE_BUS_SHIFT 23
452 #define DBG_DUMP_REG_LENGTH_MASK 0xFF /* register size (in dwords) */
453 #define DBG_DUMP_REG_LENGTH_SHIFT 24
458 * split header for registers dump
460 struct dbg_dump_split_hdr {
462 /* size in dwords of the data following this header */
463 #define DBG_DUMP_SPLIT_HDR_DATA_SIZE_MASK 0xFFFFFF
464 #define DBG_DUMP_SPLIT_HDR_DATA_SIZE_SHIFT 0
465 #define DBG_DUMP_SPLIT_HDR_SPLIT_TYPE_ID_MASK 0xFF /* split type ID */
466 #define DBG_DUMP_SPLIT_HDR_SPLIT_TYPE_ID_SHIFT 24
471 * condition header for idle check
473 struct dbg_idle_chk_cond_hdr {
474 struct dbg_mode_hdr mode /* Mode header */;
475 u16 data_size /* size in dwords of the data following this header */;
480 * Idle Check condition register
482 struct dbg_idle_chk_cond_reg {
484 /* Register GRC address (in dwords) */
485 #define DBG_IDLE_CHK_COND_REG_ADDRESS_MASK 0x7FFFFF
486 #define DBG_IDLE_CHK_COND_REG_ADDRESS_SHIFT 0
487 /* indicates if the register is wide-bus */
488 #define DBG_IDLE_CHK_COND_REG_WIDE_BUS_MASK 0x1
489 #define DBG_IDLE_CHK_COND_REG_WIDE_BUS_SHIFT 23
490 /* value from block_id enum */
491 #define DBG_IDLE_CHK_COND_REG_BLOCK_ID_MASK 0xFF
492 #define DBG_IDLE_CHK_COND_REG_BLOCK_ID_SHIFT 24
493 u16 num_entries /* number of registers entries to check */;
494 u8 entry_size /* size of registers entry (in dwords) */;
495 u8 start_entry /* index of the first entry to check */;
500 * Idle Check info register
502 struct dbg_idle_chk_info_reg {
504 /* Register GRC address (in dwords) */
505 #define DBG_IDLE_CHK_INFO_REG_ADDRESS_MASK 0x7FFFFF
506 #define DBG_IDLE_CHK_INFO_REG_ADDRESS_SHIFT 0
507 /* indicates if the register is wide-bus */
508 #define DBG_IDLE_CHK_INFO_REG_WIDE_BUS_MASK 0x1
509 #define DBG_IDLE_CHK_INFO_REG_WIDE_BUS_SHIFT 23
510 /* value from block_id enum */
511 #define DBG_IDLE_CHK_INFO_REG_BLOCK_ID_MASK 0xFF
512 #define DBG_IDLE_CHK_INFO_REG_BLOCK_ID_SHIFT 24
513 u16 size /* register size in dwords */;
514 struct dbg_mode_hdr mode /* Mode header */;
519 * Idle Check register
521 union dbg_idle_chk_reg {
522 struct dbg_idle_chk_cond_reg cond_reg /* condition register */;
523 struct dbg_idle_chk_info_reg info_reg /* info register */;
528 * Idle Check result header
530 struct dbg_idle_chk_result_hdr {
531 u16 rule_id /* Failing rule index */;
532 u16 mem_entry_id /* Failing memory entry index */;
533 u8 num_dumped_cond_regs /* number of dumped condition registers */;
534 u8 num_dumped_info_regs /* number of dumped condition registers */;
535 u8 severity /* from dbg_idle_chk_severity_types enum */;
541 * Idle Check result register header
543 struct dbg_idle_chk_result_reg_hdr {
545 /* indicates if this register is a memory */
546 #define DBG_IDLE_CHK_RESULT_REG_HDR_IS_MEM_MASK 0x1
547 #define DBG_IDLE_CHK_RESULT_REG_HDR_IS_MEM_SHIFT 0
548 /* register index within the failing rule */
549 #define DBG_IDLE_CHK_RESULT_REG_HDR_REG_ID_MASK 0x7F
550 #define DBG_IDLE_CHK_RESULT_REG_HDR_REG_ID_SHIFT 1
551 u8 start_entry /* index of the first checked entry */;
552 u16 size /* register size in dwords */;
559 struct dbg_idle_chk_rule {
560 u16 rule_id /* Idle Check rule ID */;
561 u8 severity /* value from dbg_idle_chk_severity_types enum */;
562 u8 cond_id /* Condition ID */;
563 u8 num_cond_regs /* number of condition registers */;
564 u8 num_info_regs /* number of info registers */;
565 u8 num_imms /* number of immediates in the condition */;
567 /* offset of this rules registers in the idle check register array
568 * (in dbg_idle_chk_reg units)
571 /* offset of this rules immediate values in the immediate values array
579 * Idle Check rule parsing data
581 struct dbg_idle_chk_rule_parsing_data {
583 /* indicates if this register has a FW message */
584 #define DBG_IDLE_CHK_RULE_PARSING_DATA_HAS_FW_MSG_MASK 0x1
585 #define DBG_IDLE_CHK_RULE_PARSING_DATA_HAS_FW_MSG_SHIFT 0
586 /* Offset of this rules strings in the debug strings array (in bytes) */
587 #define DBG_IDLE_CHK_RULE_PARSING_DATA_STR_OFFSET_MASK 0x7FFFFFFF
588 #define DBG_IDLE_CHK_RULE_PARSING_DATA_STR_OFFSET_SHIFT 1
593 * idle check severity types
595 enum dbg_idle_chk_severity_types {
596 /* idle check failure should cause an error */
597 IDLE_CHK_SEVERITY_ERROR,
598 /* idle check failure should cause an error only if theres no traffic */
599 IDLE_CHK_SEVERITY_ERROR_NO_TRAFFIC,
600 /* idle check failure should cause a warning */
601 IDLE_CHK_SEVERITY_WARNING,
602 MAX_DBG_IDLE_CHK_SEVERITY_TYPES
608 * Debug Bus block data
610 struct dbg_bus_block_data {
612 /* 4-bit value: bit i set -> dword/qword i is enabled. */
613 #define DBG_BUS_BLOCK_DATA_ENABLE_MASK_MASK 0xF
614 #define DBG_BUS_BLOCK_DATA_ENABLE_MASK_SHIFT 0
615 /* Number of dwords/qwords to shift right the debug data (0-3) */
616 #define DBG_BUS_BLOCK_DATA_RIGHT_SHIFT_MASK 0xF
617 #define DBG_BUS_BLOCK_DATA_RIGHT_SHIFT_SHIFT 4
618 /* 4-bit value: bit i set -> dword/qword i is forced valid. */
619 #define DBG_BUS_BLOCK_DATA_FORCE_VALID_MASK_MASK 0xF
620 #define DBG_BUS_BLOCK_DATA_FORCE_VALID_MASK_SHIFT 8
621 /* 4-bit value: bit i set -> dword/qword i frame bit is forced. */
622 #define DBG_BUS_BLOCK_DATA_FORCE_FRAME_MASK_MASK 0xF
623 #define DBG_BUS_BLOCK_DATA_FORCE_FRAME_MASK_SHIFT 12
624 u8 line_num /* Debug line number to select */;
625 u8 hw_id /* HW ID associated with the block */;
632 enum dbg_bus_clients {
643 DBG_BUS_CLIENT_OTHER_ENGINE,
644 DBG_BUS_CLIENT_TIMESTAMP,
657 * Debug Bus constraint operation types
659 enum dbg_bus_constraint_ops {
660 DBG_BUS_CONSTRAINT_OP_EQ /* equal */,
661 DBG_BUS_CONSTRAINT_OP_NE /* not equal */,
662 DBG_BUS_CONSTRAINT_OP_LT /* less than */,
663 DBG_BUS_CONSTRAINT_OP_LTC /* less than (cyclic) */,
664 DBG_BUS_CONSTRAINT_OP_LE /* less than or equal */,
665 DBG_BUS_CONSTRAINT_OP_LEC /* less than or equal (cyclic) */,
666 DBG_BUS_CONSTRAINT_OP_GT /* greater than */,
667 DBG_BUS_CONSTRAINT_OP_GTC /* greater than (cyclic) */,
668 DBG_BUS_CONSTRAINT_OP_GE /* greater than or equal */,
669 DBG_BUS_CONSTRAINT_OP_GEC /* greater than or equal (cyclic) */,
670 MAX_DBG_BUS_CONSTRAINT_OPS
675 * Debug Bus trigger state data
677 struct dbg_bus_trigger_state_data {
679 /* 4-bit value: bit i set -> dword i of the trigger state block
680 * (after right shift) is enabled.
682 #define DBG_BUS_TRIGGER_STATE_DATA_BLOCK_SHIFTED_ENABLE_MASK_MASK 0xF
683 #define DBG_BUS_TRIGGER_STATE_DATA_BLOCK_SHIFTED_ENABLE_MASK_SHIFT 0
684 /* 4-bit value: bit i set -> dword i is compared by a constraint */
685 #define DBG_BUS_TRIGGER_STATE_DATA_CONSTRAINT_DWORD_MASK_MASK 0xF
686 #define DBG_BUS_TRIGGER_STATE_DATA_CONSTRAINT_DWORD_MASK_SHIFT 4
690 * Debug Bus memory address
692 struct dbg_bus_mem_addr {
698 * Debug Bus PCI buffer data
700 struct dbg_bus_pci_buf_data {
701 struct dbg_bus_mem_addr phys_addr /* PCI buffer physical address */;
702 struct dbg_bus_mem_addr virt_addr /* PCI buffer virtual address */;
703 u32 size /* PCI buffer size in bytes */;
707 * Debug Bus Storm EID range filter params
709 struct dbg_bus_storm_eid_range_params {
710 u8 min /* Minimal event ID to filter on */;
711 u8 max /* Maximal event ID to filter on */;
715 * Debug Bus Storm EID mask filter params
717 struct dbg_bus_storm_eid_mask_params {
718 u8 val /* Event ID value */;
719 u8 mask /* Event ID mask. 1s in the mask = dont care bits. */;
723 * Debug Bus Storm EID filter params
725 union dbg_bus_storm_eid_params {
726 /* EID range filter params */
727 struct dbg_bus_storm_eid_range_params range;
728 /* EID mask filter params */
729 struct dbg_bus_storm_eid_mask_params mask;
733 * Debug Bus Storm data
735 struct dbg_bus_storm_data {
736 u8 enabled /* indicates if the Storm is enabled for recording */;
737 u8 mode /* Storm debug mode, valid only if the Storm is enabled */;
738 u8 hw_id /* HW ID associated with the Storm */;
739 u8 eid_filter_en /* Indicates if EID filtering is performed (0/1) */;
740 /* 1 = EID range filter, 0 = EID mask filter. Valid only if eid_filter_en is
743 u8 eid_range_not_mask;
744 u8 cid_filter_en /* Indicates if CID filtering is performed (0/1) */;
745 /* EID filter params to filter on. Valid only if eid_filter_en is set. */
746 union dbg_bus_storm_eid_params eid_filter_params;
747 u32 cid /* CID to filter on. Valid only if cid_filter_en is set. */;
753 struct dbg_bus_data {
754 u32 app_version /* The tools version number of the application */;
755 u8 state /* The current debug bus state */;
756 u8 hw_dwords /* HW dwords per cycle */;
757 /* The HW IDs of the recorded HW blocks, where bits i*3..i*3+2 contain the
758 * HW ID of dword/qword i
761 u8 num_enabled_blocks /* Number of blocks enabled for recording */;
762 u8 num_enabled_storms /* Number of Storms enabled for recording */;
763 u8 target /* Output target */;
764 u8 one_shot_en /* Indicates if one-shot mode is enabled (0/1) */;
765 u8 grc_input_en /* Indicates if GRC recording is enabled (0/1) */;
766 /* Indicates if timestamp recording is enabled (0/1) */
767 u8 timestamp_input_en;
768 u8 filter_en /* Indicates if the recording filter is enabled (0/1) */;
769 /* If true, the next added constraint belong to the filter. Otherwise,
770 * it belongs to the last added trigger state. Valid only if either filter or
771 * triggers are enabled.
774 /* Indicates if the recording filter should be applied before the trigger.
775 * Valid only if both filter and trigger are enabled (0/1)
777 u8 filter_pre_trigger;
778 /* Indicates if the recording filter should be applied after the trigger.
779 * Valid only if both filter and trigger are enabled (0/1)
781 u8 filter_post_trigger;
783 /* Indicates if the recording trigger is enabled (0/1) */
785 /* trigger states data */
786 struct dbg_bus_trigger_state_data trigger_states[3];
787 u8 next_trigger_state /* ID of next trigger state to be added */;
788 /* ID of next filter/trigger constraint to be added */
789 u8 next_constraint_id;
790 /* If true, all inputs are associated with HW ID 0. Otherwise, each input is
791 * assigned a different HW ID (0/1)
794 /* Indicates if the other engine sends it NW recording to this engine (0/1) */
795 u8 rcv_from_other_engine;
796 /* Debug Bus PCI buffer data. Valid only when the target is
797 * DBG_BUS_TARGET_ID_PCI.
799 struct dbg_bus_pci_buf_data pci_buf;
800 /* Debug Bus data for each block */
801 struct dbg_bus_block_data blocks[88];
802 /* Debug Bus data for each block */
803 struct dbg_bus_storm_data storms[6];
808 * Debug bus filter types
810 enum dbg_bus_filter_types {
811 DBG_BUS_FILTER_TYPE_OFF /* filter always off */,
812 DBG_BUS_FILTER_TYPE_PRE /* filter before trigger only */,
813 DBG_BUS_FILTER_TYPE_POST /* filter after trigger only */,
814 DBG_BUS_FILTER_TYPE_ON /* filter always on */,
815 MAX_DBG_BUS_FILTER_TYPES
820 * Debug bus frame modes
822 enum dbg_bus_frame_modes {
823 DBG_BUS_FRAME_MODE_0HW_4ST = 0 /* 0 HW dwords, 4 Storm dwords */,
824 DBG_BUS_FRAME_MODE_4HW_0ST = 3 /* 4 HW dwords, 0 Storm dwords */,
825 DBG_BUS_FRAME_MODE_8HW_0ST = 4 /* 8 HW dwords, 0 Storm dwords */,
826 MAX_DBG_BUS_FRAME_MODES
831 * Debug bus other engine mode
833 enum dbg_bus_other_engine_modes {
834 DBG_BUS_OTHER_ENGINE_MODE_NONE,
835 DBG_BUS_OTHER_ENGINE_MODE_DOUBLE_BW_TX,
836 DBG_BUS_OTHER_ENGINE_MODE_DOUBLE_BW_RX,
837 DBG_BUS_OTHER_ENGINE_MODE_CROSS_ENGINE_TX,
838 DBG_BUS_OTHER_ENGINE_MODE_CROSS_ENGINE_RX,
839 MAX_DBG_BUS_OTHER_ENGINE_MODES
845 * Debug bus post-trigger recording types
847 enum dbg_bus_post_trigger_types {
848 DBG_BUS_POST_TRIGGER_RECORD /* start recording after trigger */,
849 DBG_BUS_POST_TRIGGER_DROP /* drop data after trigger */,
850 MAX_DBG_BUS_POST_TRIGGER_TYPES
855 * Debug bus pre-trigger recording types
857 enum dbg_bus_pre_trigger_types {
858 DBG_BUS_PRE_TRIGGER_START_FROM_ZERO /* start recording from time 0 */,
859 /* start recording some chunks before trigger */
860 DBG_BUS_PRE_TRIGGER_NUM_CHUNKS,
861 DBG_BUS_PRE_TRIGGER_DROP /* drop data before trigger */,
862 MAX_DBG_BUS_PRE_TRIGGER_TYPES
867 * Debug bus SEMI frame modes
869 enum dbg_bus_semi_frame_modes {
870 /* 0 slow dwords, 4 fast dwords */
871 DBG_BUS_SEMI_FRAME_MODE_0SLOW_4FAST = 0,
872 /* 4 slow dwords, 0 fast dwords */
873 DBG_BUS_SEMI_FRAME_MODE_4SLOW_0FAST = 3,
874 MAX_DBG_BUS_SEMI_FRAME_MODES
881 enum dbg_bus_states {
882 DBG_BUS_STATE_IDLE /* debug bus idle state (not recording) */,
883 /* debug bus is ready for configuration and recording */
885 DBG_BUS_STATE_RECORDING /* debug bus is currently recording */,
886 DBG_BUS_STATE_STOPPED /* debug bus recording has stopped */,
896 * Debug Bus Storm modes
898 enum dbg_bus_storm_modes {
899 DBG_BUS_STORM_MODE_PRINTF /* store data (fast debug) */,
900 DBG_BUS_STORM_MODE_PRAM_ADDR /* pram address (fast debug) */,
901 DBG_BUS_STORM_MODE_DRA_RW /* DRA read/write data (fast debug) */,
902 DBG_BUS_STORM_MODE_DRA_W /* DRA write data (fast debug) */,
903 DBG_BUS_STORM_MODE_LD_ST_ADDR /* load/store address (fast debug) */,
904 DBG_BUS_STORM_MODE_DRA_FSM /* DRA state machines (fast debug) */,
905 DBG_BUS_STORM_MODE_RH /* recording handlers (fast debug) */,
906 DBG_BUS_STORM_MODE_FOC /* FOC: FIN + DRA Rd (slow debug) */,
907 DBG_BUS_STORM_MODE_EXT_STORE /* FOC: External Store (slow) */,
908 MAX_DBG_BUS_STORM_MODES
913 * Debug bus target IDs
915 enum dbg_bus_targets {
916 /* records debug bus to DBG block internal buffer */
917 DBG_BUS_TARGET_ID_INT_BUF,
918 DBG_BUS_TARGET_ID_NIG /* records debug bus to the NW */,
919 DBG_BUS_TARGET_ID_PCI /* records debug bus to a PCI buffer */,
928 struct dbg_grc_data {
929 /* Indicates if the GRC parameters were initialized */
930 u8 params_initialized;
933 /* Value of each GRC parameter. Array size must match the enum dbg_grc_params.
942 enum dbg_grc_params {
943 DBG_GRC_PARAM_DUMP_TSTORM /* dump Tstorm memories (0/1) */,
944 DBG_GRC_PARAM_DUMP_MSTORM /* dump Mstorm memories (0/1) */,
945 DBG_GRC_PARAM_DUMP_USTORM /* dump Ustorm memories (0/1) */,
946 DBG_GRC_PARAM_DUMP_XSTORM /* dump Xstorm memories (0/1) */,
947 DBG_GRC_PARAM_DUMP_YSTORM /* dump Ystorm memories (0/1) */,
948 DBG_GRC_PARAM_DUMP_PSTORM /* dump Pstorm memories (0/1) */,
949 DBG_GRC_PARAM_DUMP_REGS /* dump non-memory registers (0/1) */,
950 DBG_GRC_PARAM_DUMP_RAM /* dump Storm internal RAMs (0/1) */,
951 DBG_GRC_PARAM_DUMP_PBUF /* dump Storm passive buffer (0/1) */,
952 DBG_GRC_PARAM_DUMP_IOR /* dump Storm IORs (0/1) */,
953 DBG_GRC_PARAM_DUMP_VFC /* dump VFC memories (0/1) */,
954 DBG_GRC_PARAM_DUMP_CM_CTX /* dump CM contexts (0/1) */,
955 DBG_GRC_PARAM_DUMP_PXP /* dump PXP memories (0/1) */,
956 DBG_GRC_PARAM_DUMP_RSS /* dump RSS memories (0/1) */,
957 DBG_GRC_PARAM_DUMP_CAU /* dump CAU memories (0/1) */,
958 DBG_GRC_PARAM_DUMP_QM /* dump QM memories (0/1) */,
959 DBG_GRC_PARAM_DUMP_MCP /* dump MCP memories (0/1) */,
960 /* MCP Trace meta data size in bytes */
961 DBG_GRC_PARAM_MCP_TRACE_META_SIZE,
962 DBG_GRC_PARAM_DUMP_CFC /* dump CFC memories (0/1) */,
963 DBG_GRC_PARAM_DUMP_IGU /* dump IGU memories (0/1) */,
964 DBG_GRC_PARAM_DUMP_BRB /* dump BRB memories (0/1) */,
965 DBG_GRC_PARAM_DUMP_BTB /* dump BTB memories (0/1) */,
966 DBG_GRC_PARAM_DUMP_BMB /* dump BMB memories (0/1) */,
967 DBG_GRC_PARAM_DUMP_NIG /* dump NIG memories (0/1) */,
968 DBG_GRC_PARAM_DUMP_MULD /* dump MULD memories (0/1) */,
969 DBG_GRC_PARAM_DUMP_PRS /* dump PRS memories (0/1) */,
970 DBG_GRC_PARAM_DUMP_DMAE /* dump PRS memories (0/1) */,
971 DBG_GRC_PARAM_DUMP_TM /* dump TM (timers) memories (0/1) */,
972 DBG_GRC_PARAM_DUMP_SDM /* dump SDM memories (0/1) */,
973 DBG_GRC_PARAM_DUMP_DIF /* dump DIF memories (0/1) */,
974 DBG_GRC_PARAM_DUMP_STATIC /* dump static debug data (0/1) */,
975 DBG_GRC_PARAM_UNSTALL /* un-stall Storms after dump (0/1) */,
976 DBG_GRC_PARAM_NUM_LCIDS /* number of LCIDs (0..320) */,
977 DBG_GRC_PARAM_NUM_LTIDS /* number of LTIDs (0..320) */,
978 /* preset: exclude all memories from dump (1 only) */
979 DBG_GRC_PARAM_EXCLUDE_ALL,
980 /* preset: include memories for crash dump (1 only) */
982 /* perform dump only if MFW is responding (0/1) */
983 DBG_GRC_PARAM_PARITY_SAFE,
984 DBG_GRC_PARAM_DUMP_CM /* dump CM memories (0/1) */,
985 DBG_GRC_PARAM_DUMP_PHY /* dump PHY memories (0/1) */,
986 DBG_GRC_PARAM_NO_MCP /* dont perform MCP commands (0/1) */,
987 DBG_GRC_PARAM_NO_FW_VER /* dont read FW/MFW version (0/1) */,
993 * Debug reset registers
995 enum dbg_reset_regs {
996 DBG_RESET_REG_MISCS_PL_UA,
997 DBG_RESET_REG_MISCS_PL_HV,
998 DBG_RESET_REG_MISCS_PL_HV_2,
999 DBG_RESET_REG_MISC_PL_UA,
1000 DBG_RESET_REG_MISC_PL_HV,
1001 DBG_RESET_REG_MISC_PL_PDA_VMAIN_1,
1002 DBG_RESET_REG_MISC_PL_PDA_VMAIN_2,
1003 DBG_RESET_REG_MISC_PL_PDA_VAUX,
1009 * Debug status codes
1013 DBG_STATUS_APP_VERSION_NOT_SET,
1014 DBG_STATUS_UNSUPPORTED_APP_VERSION,
1015 DBG_STATUS_DBG_BLOCK_NOT_RESET,
1016 DBG_STATUS_INVALID_ARGS,
1017 DBG_STATUS_OUTPUT_ALREADY_SET,
1018 DBG_STATUS_INVALID_PCI_BUF_SIZE,
1019 DBG_STATUS_PCI_BUF_ALLOC_FAILED,
1020 DBG_STATUS_PCI_BUF_NOT_ALLOCATED,
1021 DBG_STATUS_TOO_MANY_INPUTS,
1022 DBG_STATUS_INPUT_OVERLAP,
1023 DBG_STATUS_HW_ONLY_RECORDING,
1024 DBG_STATUS_STORM_ALREADY_ENABLED,
1025 DBG_STATUS_STORM_NOT_ENABLED,
1026 DBG_STATUS_BLOCK_ALREADY_ENABLED,
1027 DBG_STATUS_BLOCK_NOT_ENABLED,
1028 DBG_STATUS_NO_INPUT_ENABLED,
1029 DBG_STATUS_NO_FILTER_TRIGGER_64B,
1030 DBG_STATUS_FILTER_ALREADY_ENABLED,
1031 DBG_STATUS_TRIGGER_ALREADY_ENABLED,
1032 DBG_STATUS_TRIGGER_NOT_ENABLED,
1033 DBG_STATUS_CANT_ADD_CONSTRAINT,
1034 DBG_STATUS_TOO_MANY_TRIGGER_STATES,
1035 DBG_STATUS_TOO_MANY_CONSTRAINTS,
1036 DBG_STATUS_RECORDING_NOT_STARTED,
1037 DBG_STATUS_DATA_DIDNT_TRIGGER,
1038 DBG_STATUS_NO_DATA_RECORDED,
1039 DBG_STATUS_DUMP_BUF_TOO_SMALL,
1040 DBG_STATUS_DUMP_NOT_CHUNK_ALIGNED,
1041 DBG_STATUS_UNKNOWN_CHIP,
1042 DBG_STATUS_VIRT_MEM_ALLOC_FAILED,
1043 DBG_STATUS_BLOCK_IN_RESET,
1044 DBG_STATUS_INVALID_TRACE_SIGNATURE,
1045 DBG_STATUS_INVALID_NVRAM_BUNDLE,
1046 DBG_STATUS_NVRAM_GET_IMAGE_FAILED,
1047 DBG_STATUS_NON_ALIGNED_NVRAM_IMAGE,
1048 DBG_STATUS_NVRAM_READ_FAILED,
1049 DBG_STATUS_IDLE_CHK_PARSE_FAILED,
1050 DBG_STATUS_MCP_TRACE_BAD_DATA,
1051 DBG_STATUS_MCP_TRACE_NO_META,
1052 DBG_STATUS_MCP_COULD_NOT_HALT,
1053 DBG_STATUS_MCP_COULD_NOT_RESUME,
1054 DBG_STATUS_RESERVED2,
1055 DBG_STATUS_SEMI_FIFO_NOT_EMPTY,
1056 DBG_STATUS_IGU_FIFO_BAD_DATA,
1057 DBG_STATUS_MCP_COULD_NOT_MASK_PRTY,
1058 DBG_STATUS_FW_ASSERTS_PARSE_FAILED,
1059 DBG_STATUS_REG_FIFO_BAD_DATA,
1060 DBG_STATUS_PROTECTION_OVERRIDE_BAD_DATA,
1061 DBG_STATUS_DBG_ARRAY_NOT_SET,
1062 DBG_STATUS_FILTER_BUG,
1063 DBG_STATUS_NON_MATCHING_LINES,
1064 DBG_STATUS_INVALID_TRIGGER_DWORD_OFFSET,
1065 DBG_STATUS_DBG_BUS_IN_USE,
1087 struct idle_chk_data {
1088 u32 buf_size /* Idle check buffer size in dwords */;
1089 /* Indicates if the idle check buffer size was set (0/1) */
1096 * Debug Tools data (per HW function)
1098 struct dbg_tools_data {
1099 struct dbg_grc_data grc /* GRC Dump data */;
1100 struct dbg_bus_data bus /* Debug Bus data */;
1101 struct idle_chk_data idle_chk /* Idle Check data */;
1102 u8 mode_enable[40] /* Indicates if a mode is enabled (0/1) */;
1103 /* Indicates if a block is in reset state (0/1) */
1104 u8 block_in_reset[88];
1105 u8 chip_id /* Chip ID (from enum chip_ids) */;
1106 u8 platform_id /* Platform ID */;
1107 u8 initialized /* Indicates if the data was initialized */;
1108 u8 use_dmae /* Indicates if DMAE should be used */;
1109 /* Numbers of registers that were read since last log */
1114 #endif /* __ECORE_HSI_DEBUG_TOOLS__ */