Package: td_vvc_entity_support_pkg

File: td_vvc_entity_support_pkg.vhd

Description

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

Types

Name	Type	Description
t_vvc_labels

Functions

assign_vvc_labels ( scope : string;
vvc_name : string;
instance_idx : integer;
channel : t_channel ) return t_vvc_labels

Description

assign_vvc_labels

This function puts common VVC labels into a record - to reduce the number of procedure parameters

vvc_constructor ( constant scope : in string;
constant instance_idx : in natural;
variable vvc_config : inout t_vvc_config;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
variable result_queue : inout work.td_result_queue_pkg.t_generic_queue;
constant bfm_config : in t_bfm_config;
constant cmd_queue_count_max : in natural;
constant cmd_queue_count_threshold : in natural;
constant cmd_queue_count_threshold_severity : in t_alert_level;
constant result_queue_count_max : in natural;
constant result_queue_count_threshold : in natural;
constant result_queue_count_threshold_severity : in t_alert_level ) return ()

Description

vvc_constructor

Procedure used as concurrent process in the VVCs

Sets up the vvc_config, command queue and result_queue
Verifies that UVVM has been initialized

initialize_interpreter ( signal terminate_current_cmd : out t_flag_record;
signal global_awaiting_completion : out std_logic_vector(C_MAX_NUM_SEQUENCERS-1 downto 0) ) return ()

Description

initialize_interpreter

Initialises the VVC interpreter

Clears terminate_current_cmd.set to '0'

get_msg_id_panel ( constant command : in t_vvc_cmd_record;
constant vvc_config : in t_vvc_config ) return t_msg_id_panel

await_cmd_from_sequencer ( constant vvc_labels : in t_vvc_labels;
constant vvc_config : in t_vvc_config;
signal VVCT : in t_vvc_target_record;
signal VVC_BROADCAST : inout std_logic;
signal global_vvc_busy : inout std_logic;
signal vvc_ack : out std_logic;
variable output_vvc_cmd : out t_vvc_cmd_record;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel --UVVM: unused,
remove in v3.0 ) return ()

Description

await_cmd_from_sequencer

Waits for a command from the central sequencer. Continues on matching VVC, Instance, Name and Channel (unless channel = NA)

Log at start using ID_CMD_INTERPRETER_WAIT and at the end using ID_CMD_INTERPRETER

await_cmd_from_sequencer ( constant vvc_labels : in t_vvc_labels;
constant vvc_config : in t_vvc_config;
signal VVCT : in t_vvc_target_record;
signal VVC_BROADCAST : inout std_logic;
signal global_vvc_busy : inout std_logic;
signal vvc_ack : out std_logic;
constant shared_vvc_cmd : in t_vvc_cmd_record;
variable output_vvc_cmd : out t_vvc_cmd_record ) return ()

Description
DEPRECATED

put_command_on_queue ( constant command : in t_vvc_cmd_record;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
variable vvc_status : inout t_vvc_status;
signal queue_is_increasing : out boolean ) return ()

Description

put_command_on_queue

Puts the received command (by Interpreter) on the VVC queue (for later retrieval by Executor)

interpreter_await_completion ( constant command : in t_vvc_cmd_record;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
constant vvc_config : in t_vvc_config;
signal executor_is_busy : in boolean;
constant vvc_labels : in t_vvc_labels;
signal last_cmd_idx_executed : in natural;
constant await_completion_pending_msg_id : in t_msg_id := ID_IMMEDIATE_CMD_WAIT;
constant await_completion_finished_msg_id : in t_msg_id := ID_IMMEDIATE_CMD ) return ()

Description

interpreter_await_completion

Immediate command: await_completion (in interpreter)

Command description in Quick reference for UVVM common methods
Will wait until given command(s) is completed by the excutor (if not already completed)
Log using ID_IMMEDIATE_CMD when await completed
Log using ID_IMMEDIATE_CMD_WAIT if waiting is actually needed

interpreter_await_any_completion ( constant command : in t_vvc_cmd_record;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
constant vvc_config : in t_vvc_config;
signal executor_is_busy : in boolean;
constant vvc_labels : in t_vvc_labels;
signal last_cmd_idx_executed : in natural;
signal global_awaiting_completion : inout std_logic_vector;
-- Handshake with other VVCs performing await_any_completion constant await_completion_pending_msg_id : in t_msg_id := ID_IMMEDIATE_CMD_WAIT;
constant await_completion_finished_msg_id : in t_msg_id := ID_IMMEDIATE_CMD ) return ()

Description

interpreter_await_any_completion

Immediate command: await_any_completion() (in interpreter)

This procedure is called by the interpreter if sequencer calls await_any_completion()
- It waits for the first of the following :
  'await_completion' of this VVC, or
  until global_awaiting_completion(idx) /= '1' (any of the other involved VVCs completed).
Refer to description in Quick reference for UVVM common methods
Log using ID_IMMEDIATE_CMD when the wait completed
Log using ID_IMMEDIATE_CMD_WAIT if waiting is actually needed

interpreter_flush_command_queue ( constant command : in t_vvc_cmd_record;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
constant vvc_config : in t_vvc_config;
variable vvc_status : inout t_vvc_status;
constant vvc_labels : in t_vvc_labels ) return ()

Description

interpreter_flush_command_queue

Immediate command: flush_command_queue (in interpreter)

Command description in Quick reference for UVVM common methods
Log using ID_IMMEDIATE_CMD

interpreter_terminate_current_command ( constant command : in t_vvc_cmd_record;
constant vvc_config : in t_vvc_config;
constant vvc_labels : in t_vvc_labels;
signal terminate_current_cmd : inout t_flag_record;
constant executor_is_busy : in boolean := true ) return ()

Description

interpreter_terminate_current_command

Immediate command: terminate_current_command (in interpreter)

Command description in Quick reference for UVVM common methods
Log using ID_IMMEDIATE_CMD

interpreter_fetch_result ( variable result_queue : inout work.td_result_queue_pkg.t_generic_queue;
constant command : in t_vvc_cmd_record;
constant vvc_config : in t_vvc_config;
constant vvc_labels : in t_vvc_labels;
constant last_cmd_idx_executed : in natural;
variable shared_vvc_response : inout work.vvc_cmd_pkg.t_vvc_response ) return ()

Description

interpreter_fetch_result

Immediate command: interpreter_fetch_result (in interpreter)

Command description in Quick reference for UVVM common methods
Log using ID_IMMEDIATE_CMD
t_vvc_response is specific to each VVC,
so the BFM can return any type which is then transported from the VVC to the sequencer via a fetch_result() call

initialize_executor ( signal terminate_current_cmd : inout t_flag_record ) return ()

Description

initialize_executor

Initialises the VVC executor

Resets terminate_current_cmd.reset flag

fetch_command_and_prepare_executor ( variable command : inout t_vvc_cmd_record;
variable command_queue : inout work.td_cmd_queue_pkg.t_generic_queue;
constant vvc_config : in t_vvc_config;
variable vvc_status : inout t_vvc_status;
signal queue_is_increasing : in boolean;
signal executor_is_busy : inout boolean;
constant vvc_labels : in t_vvc_labels;
constant msg_id_panel : in t_msg_id_panel := shared_msg_id_panel;
--UVVM: unused,
remove in v3.0 constant executor_id : in t_msg_id := ID_CMD_EXECUTOR;
constant executor_wait_id : in t_msg_id := ID_CMD_EXECUTOR_WAIT ) return ()

Description

fetch_command_and_prepare_executor

Fetches a command from the queue (waits until available if needed)

Log command using ID_CMD_EXECUTOR
Log using ID_CMD_EXECUTOR_WAIT if queue is empty
Sets relevant flags

store_result ( variable result_queue : inout work.td_result_queue_pkg.t_generic_queue;
constant cmd_idx : in natural;
constant result : in t_vvc_result ) return ()

Description

store_result

Store result from BFM in the VVC's result_queue
The result_queue is used to store a generic type that is returned from
a read/expect BFM procedure.
It can be fetched later using fetch_result() to return it from the VVC to sequencer

insert_inter_bfm_delay_if_requested ( constant vvc_config : in t_vvc_config;
constant command_is_bfm_access : in boolean;
constant timestamp_start_of_last_bfm_access : in time;
constant timestamp_end_of_last_bfm_access : in time;
constant msg_id_panel : in t_msg_id_panel;
constant scope : in string := C_SCOPE ) return ()

Description

insert_inter_bfm_delay_if_requested

Inserts delay of either START2START or FINISH2START in time, given that

vvc_config inter-bfm delay type is not set to NO_DELAY
command_is_bfm_access is set to true
Both timestamps are not set to 0 ns.
A log message with ID ID_CMD_EXECUTOR is issued when the delay begins and
when it has finished delaying.

insert_inter_bfm_delay_if_requested ( constant vvc_config : in t_vvc_config;
constant command_is_bfm_access : in boolean;
constant timestamp_start_of_last_bfm_access : in time;
constant timestamp_end_of_last_bfm_access : in time;
constant scope : in string := C_SCOPE ) return ()

broadcast_cmd_to_shared_cmd ( constant broadcast_cmd : t_broadcastable_cmd ) return t_operation

get_command_type_from_operation ( constant broadcast_cmd : t_broadcastable_cmd ) return t_immediate_or_queued

populate_shared_vvc_cmd_with_broadcast ( variable output_vvc_cmd : out t_vvc_cmd_record;
constant scope : in string := C_SCOPE ) return ()