Package: i2c_bfm_pkg

File: i2c_bfm_pkg.vhd

Description

=================================================================================================

Constants

Name	Type	Value
C_SCOPE	string	"I2C BFM"
C_READ_BIT	std_logic	'1'
C_WRITE_BIT	std_logic	'0'
C_I2C_BFM_CONFIG_DEFAULT	t_i2c_bfm_config	( enable_10_bits_addressing => false, master_sda_to_scl => 20 ns, master_scl_to_sda => 20 ns, master_stop_condition_hold_time => 20 ns, max_wait_scl_change => 10 ms, max_wait_scl_change_severity => failure, max_wait_sda_change => 10 ms, max_wait_sda_change_severity => failure, i2c_bit_time => -1 ns, i2c_bit_time_severity => failure, acknowledge_severity => failure, slave_mode_address => "0000000000", slave_mode_address_severity => failure, slave_rw_bit_severity => failure, reserved_address_severity => warning, match_strictness => MATCH_EXACT, id_for_bfm => ID_BFM, id_for_bfm_wait => ID_BFM_WAIT, id_for_bfm_poll => ID_BFM_POLL )

Types

Name	Type	Description
t_i2c_if
t_i2c_bfm_config		Configuration record to be assigned in the test harness.

Functions

init_i2c_if_signals ( constant VOID : in t_void ) return t_i2c_if

Description

BFM procedures

init_i2c_if_signals

This function returns an I2C interface with initialized signals.
All I2C signals are initialized to Z

i2c_master_transmit ( constant addr_value : in unsigned;
constant data : in t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_transmit

This procedure transmits data 'data' to an I2C slave DUT
at address 'addr_value'.

i2c_master_transmit ( constant addr_value : in unsigned;
constant data : in t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_transmit

This procedure transmits data 'data' to an I2C slave DUT
at address 'addr_value'.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_master_transmit ( constant addr_value : in unsigned;
constant data : in std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_transmit

This procedure transmits data 'data' to an I2C slave DUT
at address 'addr_value'.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_slave_transmit ( constant data : in t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_transmit

This procedure transmits data 'data' to an I2C master DUT.

i2c_slave_transmit ( constant data : in t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_transmit

This procedure transmits data 'data' to an I2C master DUT.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_slave_transmit ( constant data : in std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_transmit

This procedure transmits data 'data' to an I2C master DUT.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_master_receive ( constant addr_value : in unsigned;
variable data : out t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_master_receive

This procedure receives data 'data' from an I2C slave DUT
at address 'addr_value'.

i2c_master_receive ( constant addr_value : in unsigned;
variable data : out t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_master_receive

This procedure receives data 'data' from an I2C slave DUT
at address 'addr_value'.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_master_receive ( constant addr_value : in unsigned;
variable data : out std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_master_receive

This procedure receives data 'data' from an I2C slave DUT
at address 'addr_value'.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_slave_receive ( variable data : out t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant exp_rw_bit : in std_logic := C_WRITE_BIT;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_slave_receive

This procedure receives data 'data' from an I2C master DUT.
at address 'addr_value'.

i2c_slave_receive ( variable data : out t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_slave_receive

This procedure receives data 'data' from an I2C master DUT.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_slave_receive ( variable data : out std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT;
constant ext_proc_call : in string := "" -- External proc_call. Overwrite if called from another BFM procedure ) return ()

Description

i2c_slave_receive

This procedure receives data 'data' from an I2C master DUT.
The I2C interface in this procedure is given as a t_i2c_if signal record

i2c_master_check ( constant addr_value : in unsigned;
constant data_exp : in t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_check

This procedure receives an I2C transaction from an I2C slave DUT at address
'addr_value', and compares the read data to the expected data in 'data_exp'.
If the read data is inconsistent with the expected data, an alert with
severity 'alert_level' is triggered.
The I2C interface in this procedure is given as individual signals

i2c_master_check ( constant addr_value : in unsigned;
constant data_exp : in t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_check

i2c_master_check ( constant addr_value : in unsigned;
constant data_exp : in std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_master_check

i2c_slave_check ( constant data_exp : in t_byte_array;
constant msg : in string;
signal scl : inout std_logic;
signal sda : inout std_logic;
constant exp_rw_bit : in std_logic := C_WRITE_BIT;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_check

This procedure receives an I2C transaction from an I2C master DUT,
and compares the read data to the expected data in 'data_exp'.
If the read data is inconsistent with the expected data, an alert with
severity 'alert_level' is triggered.
The I2C interface in this procedure is given as individual signals

i2c_slave_check ( constant data_exp : in t_byte_array;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant exp_rw_bit : in std_logic := C_WRITE_BIT;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_check

i2c_slave_check ( constant data_exp : in std_logic_vector;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant exp_rw_bit : in std_logic := C_WRITE_BIT;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()

Description

i2c_slave_check

i2c_master_quick_command ( constant addr_value : in unsigned;
constant msg : in string;
signal i2c_if : inout t_i2c_if;
constant rw_bit : in std_logic := C_WRITE_BIT;
constant exp_ack : in boolean := true;
constant action_when_transfer_is_done : in t_action_when_transfer_is_done := RELEASE_LINE_AFTER_TRANSFER;
constant alert_level : in t_alert_level := error;
constant scope : in string := C_SCOPE;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
constant config : in t_i2c_bfm_config := C_I2C_BFM_CONFIG_DEFAULT ) return ()