L- and H-tile Avalon® Streaming and Single Root I/O Virtualization (SR-IOV) Intel® FPGA IP for PCI Express* User Guide

ID 683111
Date 3/07/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

9.4.11. BFM Log and Message Procedures

The following procedures and functions are available in the Verilog HDL include file altpcietb_bfm_log.v

These procedures provide support for displaying messages in a common format, suppressing informational messages, and stopping simulation on specific message types.

The following constants define the type of message and their values determine whether a message is displayed or simulation is stopped after a specific message. Each displayed message has a specific prefix, based on the message type in the following table.

You can suppress the display of certain message types. The default values determining whether a message type is displayed are defined in the following table. To change the default message display, modify the display default value with a procedure call to ebfm_log_set_suppressed_msg_mask.

Certain message types also stop simulation after the message is displayed. The following table shows the default value determining whether a message type stops simulation. You can specify whether simulation stops for particular messages with the procedure ebfm_log_set_stop_on_msg_mask.

All of these log message constants type integer.

Table 89.  Log Messages

Constant (Message Type)

Description

Mask Bit No

Display

by Default

Simulation Stops by Default

Message

Prefix

EBFM_MSG_DEBUG

Specifies debug messages.

0

No

No

DEBUG:
EBFM_MSG_INFO

Specifies informational messages, such as configuration register values, starting and ending of tests.

1

Yes

No

INFO:
EBFM_MSG_WARNING

Specifies warning messages, such as tests being skipped due to the specific configuration.

2

Yes

No

WARNING:
EBFM_MSG_ERROR_INFO

Specifies additional information for an error. Use this message to display preliminary information before an error message that stops simulation.

3

Yes

No

ERROR:
EBFM_MSG_ERROR_CONTINUE

Specifies a recoverable error that allows simulation to continue. Use this error for data comparison failures.

4

Yes

No

ERROR:
EBFM_MSG_ERROR_FATAL

Specifies an error that stops simulation because the error leaves the testbench in a state where further simulation is not possible.

N/A

Yes

Cannot suppress

Yes

Cannot suppress

FATAL:
EBFM_MSG_ERROR_FATAL_TB_ERR

Used for BFM test driver or Root Port BFM fatal errors. Specifies an error that stops simulation because the error leaves the testbench in a state where further simulation is not possible. Use this error message for errors that occur due to a problem in the BFM test driver module or the Root Port BFM, that are not caused by the Endpoint Application Layer being tested.

N/A

Y

Cannot suppress

Y

Cannot suppress

FATAL: