Altera IP Compiler for PCI Express - Manual (Page 278)

15–46 Chapter 15: Testbench and Design Example
BFM Procedures and Functions
IP Compiler for PCI Express User Guide August 2014 Altera Corporation
ebfm_log_set_stop_on_msg_mask Procedure
The ebfm_log_set_stop_on_msg_mask procedure controls which message types stop
simulation. This procedure alters the default behavior of the simulation when errors
occur as described in the
Table 15–39 on page 15–44 .
ebfm_log_open Procedure
The ebfm_log_open procedure opens a log file of the specified name. All displayed
messages are called by ebfm_display and are written to this log file as simulator
standard output.
ebfm_log_close Procedure
The ebfm_log_close procedure closes the log file opened by a previous call to
ebfm_log_open
.
VHDL Formatting Functions
The following procedures and functions are available in the VHDL package file
altpcietb_bfm_log.vhd
.This section outlines formatting functions that are only used
by VHDL. They take a numeric value and return a string to display the value.
Table 15–43. ebfm_log_set_stop_on_msg_mask Procedure
Location altpcietb_bfm_log.v or altpcietb_bfm_log.vhd
Syntax ebfm_log_set_stop_on_msg_mask (msg_mask)
Argument msg_mask
In VHDL, this argument is a subtype of std_logic_vector, EBFM_MSG_MASK. This vector has
a range from EBFM_MSG_ERROR_CONTINUE downto EBFM_MSG_DEBUG.
In Verilog HDL, this argument is
reg [EBFM_MSG_ERROR_CONTINUE:EBFM_MSG_DEBUG]
.
In both languages, a 1 in a specific bit position of the msg_mask causes messages of the type
corresponding to the bit position to stop the simulation after the message is displayed.
Table 15–44. ebfm_log_open Procedure
Location altpcietb_bfm_log.v or altpcietb_bfm_log.vhd
Syntax ebfm_log_open (fn)
Argument fn This argument is type string and provides the file name of log file to be opened.
Table 15–45. ebfm_log_close Procedure
Location altpcietb_bfm_log.v or altpcietb_bfm_log.vhd
Syntax ebfm_log_close
Argument NONE