The CHI VIP UVM User Guide is installed at:

• Synopsys CHI VIP UVM User Guide (PDF)

The CHI VIP UVM FAQ document is installed at:

• Synopsys CHI VIP UVM FAQ Guide (PDF)

The Synopsys VIP for CHI is a suite of advanced verification components and data objects based on SystemVerilog UVM-compliant technology. This on-line help contains information about the classes, functions, and member variables. It shows class hierarchy and contents and it provides links you can use to navigate to more details. Below is the summary of the components and the user interface of the Synopsys CHI VIP.

CHI VIP Components

• svt_chi_rn_agent Defines an agent for the Request Node component. The Request Node agent encapsulates sequencers, drivers, and port monitors for protocol layer and link layer. The Request Node agent can be configured to operate in active mode and passive mode.
• svt_chi_sn_agent Defines an agent for the Slave Node component. The Slave Node agent encapsulates sequencers, drivers, and port monitors for protocol layer and link layer. The Slave Node agent can be configured to operate in active mode and passive mode.
• svt_chi_system_monitor The system monitor observes transactions across the CHI ports of a single interconnect and performs checks between the transactions of these ports. For the list of system checks supported by the system monitor, please click on the "Protocol Checks" tab in this class reference documentation.
• svt_chi_interconnect_env The Interconnect Env supports configurable number of RNs, SNs and HNs. It receives transactions from RNs, generates snoops to other RNs, and writes to/reads from HN-F L3 cache or connected SNs.
• svt_chi_system_env Defines a System ENV for the CHI SVT suite. The CHI System ENV encapsulates the CHI RN agents, CHI SN agents, system monitor, system sequencer and the system configuration. The number of CHI RN agents, CHI SN agents is configured based on the system configuration provided by the user.

CHI VIP User Interface
Configuration Objects:
Configuration data objects convey the system level and port level testbench configuration. The configuration data objects contain built-in constraints, which come into effect when the configuration objects are randomized. If the configuration needs to be changed later, it can be done through reconfigure() method of the master, slave, interconnect or system components. The CHI VIP defines following configuration classes:

• svt_chi_system_configuration CHI System configuration
• svt_chi_node_configuration CHI Node configuration for RN and SN agents
• svt_chi_address_configuration Address map configuration (user doesn't need to directly use this, svt_chi_system_configuration uses this)
• svt_chi_interconnect_configuration CHI Interconnect VIP configuration (applicable only when svt_chi_system_configuration :: use_interconnect is set to 1)

Transaction Objects:
Transaction objects, which are extended from the uvm_transaction base class, define a unit of CHI protocol information that is passed across the bus. The attributes of transaction objects are public and are accessed directly for setting and getting values. Most transaction attributes can be randomized. The transaction object can represent the desired activity to be simulated on the bus, or the actual bus activity that was monitored. CHI VIP defines following transaction classes:

• svt_chi_rn_transaction (CHI RN transaction)
• svt_chi_sn_transaction (CHI SN transaction)
• svt_chi_snoop_transaction (CHI Snoop transaction)
• svt_chi_flit (CHI Flit)
• svt_chi_transaction (Base class for svt_chi_rn_transaction , svt_chi_sn_transaction )
• svt_chi_base_transaction (Base class for svt_chi_transaction , svt_chi_flit )
• svt_chi_system_transaction (CHI System transaction)
• svt_chi_common_transaction (Base class for svt_chi_base_transaction , svt_chi_snoop_transaction )

Analysis port:
The port monitor in all the agents provide an analysis port. At the end of the CHI transaction, the protocol layer monitor within the RN & SN agents provides the completed svt_chi_rn_transaction & svt_chi_sn_transaction object respectively, from its analysis port. At the end of the CHI transaction, link layer monitor within the RN & SN agents provides the completed svt_chi_flit from its analysis port.
The analysis port used by port monitor within the agents is:

• svt_monitor :: item_observed_port
• svt_chi_node_protocol_monitor :: snoop_item_observed_port
• svt_chi_node_protocol_monitor :: tlm_generic_payload_observed_port
• svt_chi_node_protocol_monitor :: tlm_generic_payload_snoop_observed_port
• svt_chi_rn_link_monitor :: tx_req_observed_port
• svt_chi_rn_link_monitor :: rx_rsp_observed_port
• svt_chi_rn_link_monitor :: rx_dat_observed_port
• svt_chi_rn_link_monitor :: rx_snp_observed_port
• svt_chi_rn_link_monitor :: tx_rsp_observed_port
• svt_chi_rn_link_monitor :: tx_dat_observed_port
• svt_chi_sn_link_monitor :: rx_req_observed_port
• svt_chi_sn_link_monitor :: tx_rsp_observed_port
• svt_chi_sn_link_monitor :: tx_dat_observed_port
• svt_chi_sn_link_monitor :: rx_dat_observed_port

Callbacks:
Callbacks are an access mechanism that enable the insertion of user-defined code and allow access to objects for scoreboarding and functional coverage. Each of the monitor component is associated with a callback class that contains a set of callback methods. CHI VIP provides following callback classes.

• Monitor callbacks:
  • System monitor callbacks:
    • Base classes: User can extend these and then register the same with the system monitor
      • svt_chi_system_monitor_callback
    • Derived classes: These are registered by the CHI system monitor automatically based on corresponding configuration attribute enabling
      • svt_chi_system_monitor_transaction_xml_callback :
        Generates PA files (XML/FSDB) with coherent and snoop transactions
        Registered when svt_chi_system_configuration :: enable_xml_gen is set to one.
      • svt_chi_system_monitor_def_cov_data_callback (base class), svt_chi_system_monitor_def_cov_callback (derived class) :
        System monitor coverage data callbacks. Not yet supported
  • Node protocol monitor callbacks: This represents RN, SN protocol layer monitor callbacks
    • Base classes: User can extend these and then register the same with the system monitor
      • svt_chi_node_protocol_monitor_callback
    • Derived classes: These are registered by the CHI RN, SN node protocol layer monitor automatically based on corresponding configuration attribute enabling
      • svt_chi_node_protocol_monitor_transaction_xml_callback :
        Generates PA files (XML/FSDB) with coherent, snoop transactions and associated flits
        Registered when svt_chi_node_configuration :: enable_xact_xml_gen is set to one. Note that snoops are applicable only for RN-F.
      • svt_chi_node_protocol_monitor_transaction_report_callback :
        Generates trace files with CHI transactions and associated flits
        Registered when svt_chi_node_configuration :: enable_pl_tracing is set to one. Also refer to svt_chi_node_configuration :: enable_pl_reporting.
      • svt_chi_node_protocol_monitor_snoop_transaction_report_callback :
        Generates trace files with snoop transactions and associated flits
        Registered when svt_chi_node_configuration :: enable_pl_tracing is set to one. Also refer to svt_chi_node_configuration :: enable_pl_reporting.
      • svt_chi_node_protocol_monitor_auto_read_callback :
        Accomodates in the generation of auto-read transactions from active RN
        Registered when svt_chi_node_configuration :: auto_read_seq_enable is set to one.
      • svt_chi_node_protocol_monitor_system_checker_callback :
        Accomodates in supporting CHI system monitor RN
        Registered when svt_chi_system_configuration :: system_monitor_enable is set to one.
      • svt_chi_node_protocol_monitor_def_cov_data_callback (base class), svt_chi_node_protocol_monitor_def_cov_callback (derived class) :
        Collects the transaction level coverage for RN, SN
        Registered when svt_chi_node_configuration :: transaction_coverage_enable is set to one.
  • RN link monitor callbacks: This represents RN link layer monitor callbacks
    • Base classes: User can extend these and then register the same with the system monitor
      • svt_chi_rn_link_monitor_callback
    • Derived classes: These are registered by the CHI RN link layer monitor automatically based on corresponding configuration attribute enabling
      • svt_chi_node_protocol_monitor_transaction_xml_callback , :
        Generates PA files (XML/FSDB) with flits
        Registered when svt_chi_node_configuration :: enable_xact_xml_gen is set to one.
      • svt_chi_rn_link_monitor_transaction_report_callback :
        Generates trace files with CHI flits
        Registered when svt_chi_node_configuration :: enable_ll_tracing is set to one. Also refer to svt_chi_node_configuration :: enable_ll_reporting.
      • svt_chi_rn_link_monitor_def_toggle_cov_data_callback (base class), svt_chi_rn_link_monitor_def_toggle_cov_callback (derived class) :
        Collects the toggle coverage for RN
        Registered when svt_chi_node_configuration :: toggle_coverage_enable is set to one.
      • svt_chi_rn_link_monitor_def_state_cov_data_callback (base class), svt_chi_rn_link_monitor_def_state_cov_callback (derived class) :
        Collects the state coverage for RN
        Registered when svt_chi_node_configuration :: state_coverage_enable is set to one.
      • svt_chi_rn_link_monitor_def_cov_data_callback (base class), svt_chi_rn_link_monitor_def_cov_callback (derived class) :
        Collects the link activation deactivation coverage for RN
        Registered when svt_chi_node_configuration :: link_coverage_enable is set to one.
  • SN link monitor callbacks: This represents SN link layer monitor callbacks
    • Base classes: User can extend these and then register the same with the system monitor
      • svt_chi_sn_link_monitor_callback
    • Derived classes: These are registered by the CHI SN link layer monitor automatically based on corresponding configuration attribute enabling
      • svt_chi_node_protocol_monitor_transaction_xml_callback , :
        Generates PA files (XML/FSDB) with flits
        Registered when svt_chi_node_configuration :: enable_xact_xml_gen is set to one.
      • svt_chi_sn_link_monitor_transaction_report_callback :
        Generates trace files with CHI flits
        Registered when svt_chi_node_configuration :: enable_ll_tracing is set to one. Also refer to svt_chi_node_configuration :: enable_ll_reporting.
      • svt_chi_sn_link_monitor_def_toggle_cov_data_callback (base class), svt_chi_sn_link_monitor_def_toggle_cov_callback (derived class) :
        Collects the toggle coverage for SN
        Registered when svt_chi_node_configuration :: toggle_coverage_enable is set to one.
      • svt_chi_sn_link_monitor_def_state_cov_data_callback (base class), svt_chi_sn_link_monitor_def_state_cov_callback (derived class) :
        Collects the state coverage for SN
        Registered when svt_chi_node_configuration :: state_coverage_enable is set to one.
      • svt_chi_sn_link_monitor_def_cov_data_callback (base class), svt_chi_sn_link_monitor_def_cov_callback (derived class) :
        Collects the link activation deactivation coverage for SN
        Registered when svt_chi_node_configuration :: link_coverage_enable is set to one.
• Driver, Sequencer callbacks
  • RN protocol driver callbacks: This represents RN protocol driver component callbacks
    • Base classes:User can extend these and then register the same with the RN driver svt_chi_rn_protocol
      • svt_chi_rn_protocol_callback
  • SN protocol driver callbacks: This represents SN protocol driver component callbacks
    • Base classes:User can extend these and then register the same with the SN driver svt_chi_sn_protocol
      • svt_chi_sn_protocol_callback
  • RN link driver callbacks: This represents RN link driver component callbacks
    • Base classes:User can extend these and then register the same with the RN driver svt_chi_rn_link
      • svt_chi_rn_link_callback
  • SN link driver callbacks: This represents SN link driver component callbacks
    • Base classes:User can extend these and then register the same with the SN driver svt_chi_sn_link
      • svt_chi_sn_link_callback
  • Interconnect driver callbacks: This represents Interconnect VIP driver component callbacks
    • Base classes:User can extend these and then register the same with the Interconnect driver svt_chi_interconnect
      • svt_chi_interconnect_callback
  • RN transaction sequencer callbacks: This represents RN transaction sequencer component callbacks
    • svt_chi_rn_transaction_sequencer_callback :
      Issued when a TLM GP transaction is converted to an CHI transaction by the sequence.
      Registered with the svt_chi_rn_transaction_sequencer when svt_chi_node_configuration :: use_tlm_generic_payload is set to one.

Interfaces and modports:
SystemVerilog models signal connections using interfaces and modports. Interfaces define the set of signals which make up a port connection. Modports define collection of signals for a given port, the direction of the signals, and the clock with respect to which these signals are driven and sampled. CHI VIP provides below interfaces:

• svt_chi_if (Top level interface, which contains an array of RN & SN port sub-interfaces.)

Protocol Checks:
For a complete list of protocol checks supported by the CHI VIP, please click on the "Protocol Checks" tab in this class reference documentation.

Sequence collection:
The CHI VIP provides a collection of CHI RN & SN sequences. These sequences can be registered with the sequencers within the respective agents, to generate different types of scenarios.

For a complete list of Sequences supported by the CHI VIP, please click on the "Sequences" tab in this class reference documentation.

Debug features:

• CHI system monitor:
  When CHI system monitor is enabled by setting svt_chi_system_configuration :: system_monitor_enable to 1, following features are applicable
  • svt_chi_system_configuration :: display_summary_report Enables displaying coherent and snoop transaction summary, SN transaction summary, AXI slave transaction summary towards end of the simulation with UVM_LOW verbosity
  • svt_chi_system_configuration :: enable_summary_reporting Enables interactive display of coherent and snoop transaction summary, SN transaction summary, AXI slave transaction summary as and when its available with UVM_HIGH verbosity
  • svt_chi_system_configuration :: enable_summary_tracing Enables interactive writing of coherent and snoop transaction summary, SN transaction summary, AXI slave transaction summary into respective seperate files as and when its available
  • svt_chi_system_configuration :: enable_xml_gen Enables dumpinig of coherent and associated snoop transactions as required by VERDI Protocol analyzer based on the settings of svt_chi_system_configuration :: pa_format_type
• CHI RN agent, CHI SN agent:
  
  • svt_chi_node_configuration :: enable_pl_reporting Enables interactive display of coherent and snoop transaction tracing summary when these transaction are complete with UVM_FULL verbosity
  • svt_chi_node_configuration :: enable_pl_tracing Enables interactive writing of coherent and snoop transaction tracing summary with corresponding flit info to seperate files when these transactions are complete
  • svt_chi_node_configuration :: enable_ll_reporting Enables interactive display of flit tracing summary when these flits are complete with UVM_FULL verbosity
  • svt_chi_node_configuration :: enable_ll_tracing Enables interactive writing of flit tracing summary to seperate files when these flits are complete
• Protocol Analyzer:
  The following attributes together can be used to control the enabling of Protocol Anlyzer
  • svt_chi_system_configuration :: pa_format_type
    Controls the format of Protocol analyzer file (XML/FSDB/BOTH)
  • svt_chi_node_configuration :: enable_xact_xml_gen
    Controls dumping of the transaction and flits related info into PA file from RN, SN
  • svt_chi_node_configuration :: enable_fsm_xml_gen
    Controls dumping of the link active state machine related info into PA file from RN, SN
  • svt_chi_system_configuration :: enable_xml_gen
    Controls dumping of the coherent and snoop transaction info into PA file from system monitor

CHI system level performance metrics:
CHI system ENV contains shared system status object (svt_chi_system_env :: shared_system_status) that contains the system level performance metrics captured by CHI system monitor. Note that the performance metric tracking can be enable through the attribute svt_chi_system_configuration :: perf_tracking_enable.
Following are the details of the shared system status object and it's related attributes:

• svt_chi_system_status : Shared system status object of the CHI system ENV that contains performance metrics of CHI system on per HN basis (through an array of svt_chi_system_hn_status objects).
• svt_chi_system_hn_status : Status object that captures the performance metrics such as latencies, L3 and Snoop filter metrics for a given HN.
• svt_chi_hn_status : Base class for svt_chi_system_hn_status class that captures the performance metrics such as retry rate, data bandwidth throughput performance metrics for a given HN.