SVT svt_mem_transaction Class Member List

This is the complete list of members for class svt_mem_transaction, including all inherited members.

svt_sequence_item	enum value	ABORTED



svt_sequence_item	enum value	ACCEPT


ovm_transaction	function void	accept_tr ( time accept_time = 0 )

svt_sequence_item	enum value	ACTIVE





svt_sequence_item	realtime	active_xml_start_time = -1;	Local 'time' stores the current active start time of the object. This is used for backwards compatibility purposes. Should be removed when all clients remove the 'save_prop_vals_to_xml' implementation and move to 'save_object_begin' and 'save_object_data'.

svt_mem_transaction	rand svt_mem_addr_t	addr	The base address of the memory burst operation, using byte-level granularity. How that base address is interpreted for the remainder of the data burst depends on the component or transactor fulfilling the transaction.

svt_sequence_item_base	function void	add_compound_pattern_prop ( svt_pattern pttrn, string owner, string name, svt_pattern_data :: type_enum typ, int unsigned supported_methods_flag = 0, int unsigned field_width = 0, string enum_type = "" )	Method which can be used to add a single svt_compound_pattern_data element to the provided pattern.

svt_sequence_item_base	function void	add_pattern_prop ( svt_pattern pttrn, string owner, string name, svt_pattern_data :: type_enum typ, int unsigned supported_methods_flag = 0, int unsigned field_width = 0, string enum_type = "" )	Method which can be used to add a single svt_pattern_data element to the provided pattern.

svt_sequence_item_base	function svt_pattern	allocate_auto_op_pattern ( int allocate_pattern_filter )	This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that support automated implementations for the common data methods.

svt_sequence_item	function svt_data_converter	allocate_data_converter ( )	Method to allocate a new data converter. Extended classes with additional converter capabilities should overload this method to allocate an extended data converter supporting these additional capabilities.

svt_sequence_item_base	function svt_pattern	allocate_pattern ( )	This is a pattern allocation method which is implemented to add properties without including support for the 'automated operation' capabilities. This is provided by VIPs which have not updated to provide the automated operation support via do_allocate_pattern. VIPs should provide one or the other, but not both.


svt_sequence_item_base	function svt_pattern	allocate_xml_pattern ( )	This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are to be included in the object's XML output.


svt_sequence_item	function void	apply_byte_to_crc ( bit [7:0] value, bit init = 0 )	This methods applies a byte to the CRC algorithm.

svt_sequence_item_base	function bit	auto_compare ( svt_sequence_item_base rhs_data, ovm_comparer comparer )	Methodology independent 'compare' method for comparing fields based on pattern information.

svt_sequence_item_base	function void	auto_copy ( svt_sequence_item_base rhs_data )	Methodology independent 'copy' method for copying fields based on pattern information.

svt_sequence_item_base	function void	auto_pack ( ovm_packer packer )	Methodology independent 'pack' method for packing fields based on pattern information.

svt_sequence_item_base	function void	auto_unpack ( ovm_packer packer )	Methodology independent 'unpack' method for unpacking fields based on pattern information.

ovm_transaction	function integer	begin_child_tr ( time begin_time = 0, integer parent_handle = 0 )

svt_sequence_item	ovm_event	begin_event

svt_sequence_item	function bit	begin_is_off ( )	Utility method which identifies the 'off' state of the begin event independent of the underlying methodology.

svt_sequence_item	function bit	begin_is_on ( )	Utility method which identifies the 'on' state of the begin event independent of the underlying methodology.


ovm_transaction	function integer	begin_tr ( time begin_time = 0 )

ovm_sequence_item	virtual task	body ( )

svt_sequence_item_base	static function timeunit_enum	calc_timeunit ( )	Calculates the timeunit that the VIP has been compiled in.

svt_sequence_item	enum value	CANCELLED




svt_sequence_item	function void	clear ( )	Clears the contents of the transaction so that it can safely be reused.

svt_sequence_item	function void	clear_implementation ( )	This method clears the implementation [$] transaction list, as well as any causal references which may have been setup.

svt_sequence_item	function void	clear_trace ( )	This method clears the trace [$] transaction list, as well as any original references which may have been setup.

ovm_object	function ovm_object	clone ( )







svt_sequence_item	function bit	comp ( svt_sequence_item to )	Implementation of the comp method needed so that extensions of this class can be used with the comparator classes.


ovm_object	function bit	compare ( ovm_object rhs, ovm_comparer comparer = null )

svt_sequence_item_base	function bit	compare_pattern_data ( svt_pattern_data rhs_pd, ovm_comparer comparer, string name_override = "" )	Compare the information associated with a single pattern_data instance.

svt_sequence_item_base	function bit	compare_via_pattern ( svt_pattern pttrn )	This method takes advantage of the get_prop_val method to make a simple way to compare a property pattern with the contents of a data instance. The method simply uses each name specified in pttrn, uses get_prop_val to retrieve the corresponding value from the data instance, and compares it to the value stored in the pattern.

svt_sequence_item_base	enum value	COMPLETE

svt_sequence_item_base	static ovm_comparer	complete_comparer = null;	This static `SVT_XVM(comparer) can be used to request a COMPLETE compare. This is a shared comparer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

svt_sequence_item_base	static ovm_packer	complete_packer = null;	This static `SVT_XVM(packer) can be used to request a COMPLETE pack. This is a shared packer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

svt_sequence_item	function string	convert2string ( )	Extension of the ovm_object :: convert2string method needed so that extensions of this class can be used with the comparator classes.

ovm_object	function void	copy ( ovm_object rhs )

svt_sequence_item	function void	copy_implementation ( ovm_sequence_item to, svt_sequence_item_base :: recursive_op_enum impl_trace_op = DEEP )	Copies the object implementation queue into to.

svt_sequence_item	function void	copy_trace ( ovm_sequence_item to, svt_sequence_item_base :: recursive_op_enum impl_trace_op = DEEP )	Copies the object trace queue into to.


svt_mem_transaction	rand svt_mem_data_t	data []	Burst of data to be written or that has been read. The length of the array specifies the length of the burst. The bits that are valid in each array element is indicated by the corresponding element in the 'valid' array

svt_sequence_item	function bit	decode_8b10b_data ( input bit [9:0] data_in, ref bit running_disparity, output bit data_k, output bit [7:0] data_out )	Decodes a ten bit data value into its eight bit representation. The function returns 0 and the output is unpredictable.

svt_sequence_item_base	function bit	decode_pattern_data ( svt_pattern_data pd, ref string pd_string, input string delimiter )	Simple utility used to convert an svt_pattern_data representation into its equivalent string property value representation.

svt_sequence_item	function bit	decode_prop_val ( string prop_name, bit [1023:0] prop_val, ref string prop_val_string, input svt_pattern_data :: type_enum typ )	Provide string values for exception_list_opts and protocol_xacts_opts.

svt_sequence_item_base	enum value	DEEP

svt_sequence_item	svt_sequence_item	default_implementation_xact_factory = null;	Default factory used for creation of the implementation queue.

svt_sequence_item	enum value	DISABLED

ovm_transaction	function void	disable_recording ( )

svt_sequence_item_base	function void	display_get_prop_val_outcome ( bit success, string prop_name, bit [1023:0] prop_val, int array_ix, svt_sequence_item_base data_obj )	Method to display the outcome of a get_prop_val operation.

svt_sequence_item_base	static int	display_kind = -1;	Used by all svt_sequence_item_base derived display methods to limit the contents of the string generated by the 'psdisplay' method and put to the log by the 'display' method.

svt_sequence_item_base	function void	display_set_prop_val_outcome ( bit success, string prop_name, bit [1023:0] prop_val, int array_ix )	Method to display the outcome of a set_prop_val operation.


ovm_transaction	protected function void	do_accept_tr ( )

svt_mem_transaction	function svt_pattern	do_allocate_pattern ( )	HDL Support: This method allocates a pattern containing svt_pattern_data instances for all of the primitive data fields in the object. The svt_pattern_data :: name is set to the corresponding field name, the svt_pattern_data :: value is set to 0.

ovm_transaction	protected function void	do_begin_tr ( )

svt_mem_transaction	function bit	do_compare ( ovm_object rhs, ovm_comparer comparer )	Compares the object with rhs..


svt_sequence_item	function void	do_copy ( ovm_object rhs )	Override the 'do_copy' method to copy fields directly.

ovm_transaction	protected function void	do_end_tr ( )

svt_mem_transaction	function bit	do_is_valid ( bit silent = 1, int kind = RELEVANT )	Checks to see that the data field values are valid, focusing mainly on checking/enforcing valid_ranges constraint. Only supported kind values are -1 and svt_sequence_item_base :: COMPLETE. If protocol defines physical representation for transaction then -1 does RELEVANT is_valid. If not, -1 does COMPLETE (i.e., all fields checked) is_valid. svt_sequence_item_base :: COMPLETE always results in COMPLETE is_valid.

svt_sequence_item	function void	do_pack ( ovm_packer packer )	Pack the fields in the svt_sequence_item class.


svt_sequence_item_base	function void	do_print ( ovm_printer printer )	Override the 'do_print' method to print fields directly.

svt_sequence_item_base	function void	do_record ( ovm_recorder recorder )	Override the 'do_record' method to record fields directly.

ovm_object	function string	do_sprint ( ovm_printer printer )

svt_sequence_item	function void	do_unpack ( ovm_packer packer )	Unpack the fields in the svt_sequence_item class.



ovm_transaction	function void	enable_recording ( string stream )

svt_sequence_item	function bit	enable_trace ( )	This virtual method is used to enable/disable the trace capability. The base class implementation always returns 0, indicating that this feature is disabled. Extended classes wishing to support this feature must consider whether this feature should always be enabled, be enabled for all instances of the extended class, or enabled on a per instance basis. This method, and any supporting data fields, etc., in the extended class should be implemented in accordance with these decisions.

svt_sequence_item	function bit	encode_8b10b_data ( input bit [7:0] data_in, input bit data_k, ref bit running_disparity, output bit [9:0] data_out )	Encodes an eight bit data value into its ten bit representation. The function returns 0 and the output is unpredictable if Xs and Zs are passed in via the argument.

svt_sequence_item	function bit	encode_prop_val ( string prop_name, string prop_val_string, ref bit [1023:0] prop_val, input svt_pattern_data :: type_enum typ )	Simple utility used to convert string property value representation into its equivalent 'bit [1023:0]' property value representation. Extended to support encoding of enum values.

svt_sequence_item	ovm_event	end_event

svt_sequence_item	function bit	end_is_off ( )	Utility method which identifies the 'off' state of the end event independent of the underlying methodology.

svt_sequence_item	function bit	end_is_on ( )	Utility method which identifies the 'on' state of the end event independent of the underlying methodology.

svt_sequence_item	enum value	ENDED


ovm_transaction	function void	end_tr ( time end_time = 0, bit free_handle = 1 )

ovm_transaction	ovm_object_string_pool	events = new;

svt_sequence_item	static svt_sequence_item_base :: recursive_op_enum	exception_list_opts	Used by all svt_transaction derived 'copy' and 'compare' methods to determine whether the exception list object is not copied or compared (NULL), the reference is copied and compared (SHALLOW), or whether the object is copied and compared (DEEP). Since not owned by an individual instance, not copied, compared, etc., like other svt_transaction properties.

svt_sequence_item	enum value	EXECUTE

svt_sequence_item	static function svt_sequence_item	find_recycled_xact ( string class_name )	Static method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.

svt_sequence_item_base	function type_enum	find_type ( string prop_name )	Utility method which can be used to get the 'type' of the indicated property.

ovm_sequence_item	virtual task	finish_item ( ovm_sequence_item item, int set_priority = -1 )

svt_sequence_item	function realtime	get_accept_realtime ( )	Accessor method which returns the time at which the accept event was triggered as a realtime value.

ovm_transaction	function time	get_accept_time ( )

svt_sequence_item	function svt_configuration	get_base_cfg ( )	Returns a reference of the transaction object. NOTE: This operation is used to fetch details to filter psdisplay_short display fields.

svt_sequence_item	function realtime	get_begin_realtime ( )	Accessor method which returns the time at which the begin event was triggered as a realtime value.

ovm_transaction	function time	get_begin_time ( )

svt_sequence_item	function svt_sequence_item	get_causal_ref ( )	This method returns the causal_xact transaction reference.

svt_sequence_item_base	function string	get_class_name ( )	Returns the name of this class, or a class derived from this class.

svt_sequence_item	function void	get_clean_realtimes ( ref realtime start_time, ref realtime end_time )	Method provided to get clean real time values to support XML, FSDB and other output.

svt_sequence_item	function void	get_clean_times ( ref time start_time, ref time end_time )	Method provided to get clean time values to support XML, FSDB and other output. This method has been deprecated. Clients should override 'get_clean_realtimes' instead of 'get_clean_times'.





svt_sequence_item	function bit [31:0]	get_crc ( )	This method returns the calculated CRC value.

svt_sequence_item	function bit [31:0]	get_crc_initial_value ( )	Utility method for getting the CRC initial value.

svt_sequence_item	function bit [31:0]	get_crc_polynomial ( )	Utility method for getting the crc polynomial value.

svt_sequence_item	function svt_data_converter	get_data_converter ( )	Method to return the current data converter. Extended classes which provide data converter capabilities should overload this method to provide access to the current data converter, typically shared as a static member of the suite specific transaction object.

ovm_sequence_item	function int	get_depth ( )

svt_sequence_item_base	function bit	get_do_compare_done ( )	Utility to obtain the do_compare_done setting for the object.

svt_sequence_item_base	function bit	get_do_pack_done ( )	Utility to obtain the do_pack_done setting for the object.

svt_sequence_item	function realtime	get_end_realtime ( )	Accessor method which returns the time at which the end event was triggered as a realtime value.

ovm_transaction	function time	get_end_time ( )

svt_sequence_item_base	static function string	get_environment_variable_value ( string method_name, string env_var_name, ovm_report_object reporter, bit is_optional = 0 )	Function which can be used to get access to an environment variable.

ovm_transaction	function ovm_event_pool	get_event_pool ( )

ovm_sequence_item	function string	get_full_name ( )

svt_sequence_item	function svt_sequence_item	get_implementation ( int ix )	Get the indexed transaction out of the implementation [$] property.

svt_sequence_item	function svt_sequence_item	get_implementation_xact_factory ( )	This virtual method must be replaced by transactions that make use of the implementation [$] property. Derived transactions must return a typed factory object which can be used when generating the transaction references in the implementation [$] transaction list.

ovm_transaction	function ovm_component	get_initiator ( )

ovm_object	static function int	get_inst_count ( )

ovm_object	function int	get_inst_id ( )

svt_sequence_item	function bit	get_is_internal ( )	Method to get the is_internal value.

svt_mem_transaction	function string	get_mcd_class_name ( )	Returns the class name for the object used for logging.

ovm_object	function string	get_name ( )


svt_sequence_item	function svt_sequence_item	get_original_ref ( )	This method returns the original_xact transaction reference.

svt_sequence_item	function svt_pa_object_data	get_pa_obj_data ( string uid = "", string typ = "", string parent_uid = "", string channel = "" )	This method create/update the 'svt_pa_object_data' object data for use in the XML/FSDB which provides basic information about the object. The transaction extension adds begin and end time information to the object if provided by the base class.

ovm_sequence_item	function ovm_sequence_base	get_parent_seq ( )

ovm_sequence_item	function ovm_sequence_base	get_parent_sequence ( )

svt_mem_transaction	function void	get_phys_addr ( int burst_ix, ref int unsigned phys_addr[SVT_MEM_SA_CORE_PHYSICAL_DIMENSIONS_MAX] )	Method used to obtain the physical address for a specific beat within a burst.

svt_mem_transaction	function bit	get_prop_val ( string prop_name, ref bit [1023:0] prop_val, input int array_ix, ref svt_sequence_item_base data_obj )	HDL Support: For read access to public data members of this class.

svt_sequence_item_base	function bit	get_prop_val_via_pattern ( ref svt_pattern pttrn )	This method takes advantage of the get_prop_val method to make a simple way to extract a property pattern from a data instance. The method simply takes all of the names specified in pttrn, and uses get_prop_val to retrieve the corresponding value so it can be placed in the pattern.

svt_sequence_item	function svt_sequence_item	get_recycled_xact ( string class_name )	Method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.

ovm_sequence_item	function ovm_sequence_base	get_root_sequence ( )

ovm_sequence_item	function string	get_root_sequence_name ( )

svt_sequence_item	function time	get_safe_accept_time ( )	Method which filters out any accept time values of -1.

svt_sequence_item	function time	get_safe_begin_time ( )	Method which filters out any begin time values of -1.

svt_sequence_item	function time	get_safe_end_time ( )	Method which filters out any end time values of -1.

ovm_sequence_item	function int	get_sequence_id ( )

ovm_sequence_item	function ovm_sequencer_base	get_sequencer ( )

ovm_sequence_item	function string	get_sequence_path ( )

svt_sequence_item_base	function string	get_suite_name ( )	Returns the suite name associated with an object.


svt_sequence_item_base	static function string	get_timeunit_str ( string class_name, ovm_report_object reporter )	Returns the timeunit that the VIP has been compiled in as a string value.

svt_sequence_item	function svt_sequence_item	get_trace ( int ix )	Get the indexed transaction out of the trace [$] property.

svt_sequence_item	function svt_sequence_item	get_trace_xact_factory ( )	This virtual method must be replaced by transactions that make use of the trace [$] property. Derived transactions must return a typed factory object which can be used when generating the transaction references in the trace [$] transaction list.

ovm_transaction	function integer	get_tr_handle ( )

ovm_transaction	function integer	get_transaction_id ( )



svt_sequence_item_base	function string	get_uid ( )	This method can be used to obtain a unique identifier for a data object.

svt_sequence_item_base	function svt_pattern	get_user_fsdb_props ( )	User method for providing additional properties, consisting of name/value pairs, that are to be included in any FSDB output.

ovm_sequence_item	function bit	get_use_sequence_info ( )

svt_sequence_item	function bit	get_xact_status ( ref svt_sequence_item :: status_enum status )	Method provided to get the transaction status for inclusion in XML and other output.

svt_sequence_item_base	function string	get_xml_object_block_desc ( string obj_type = "", string obj_sub_type = "", string parent_uid = "", string channel = "" )	This method returns a string for use in the XML object block which provides basic information about the object.

svt_sequence_item	svt_sequence_item	implementation [$]	Reference to the lower level transactions that are created as a result of processing this transaction. This is assigned by calling the store_context method.

svt_sequence_item	enum value	INITIAL

svt_sequence_item	function void	initialize_8b10b ( bit force_load = 0 )	This method initializes the 8b10b lookup tables.

svt_sequence_item	function void	initialize_crc ( bit [31:0] poly, int width, bit [31:0] init, bit force_load = 0 )	This method initializes the CRC lookup table, saves the CRC width, and the initial CRC value.

svt_sequence_item	function void	initialize_scrambling ( )	This method initializes the scrambling seed.


ovm_object	static function ovm_status_container	init_status ( )

ovm_transaction	function bit	is_active ( )


ovm_sequence_item	virtual function bit	is_item ( )

svt_mem_transaction	rand bit	is_read	Indicates if the memory transaction is a READ or WRITE operation. When set, indicates a READ operation.

ovm_transaction	function bit	is_recording_enabled ( )


svt_sequence_item_base	function bit	is_safe_as_ref ( svt_xml_writer writer )	This method indicates whether it will be safe to reference this object in the output generated by the writer.

svt_sequence_item_base	function bit	is_silent ( )	Returns true if silent mode is currently enabled

svt_sequence_item	function bit	is_supported ( svt_configuration cfg, bit silent = 0 )	Determines if this transaction can reasonably be expected to function correctly on the supplied cfg object.

svt_sequence_item_base	function bit	is_valid ( bit silent = 1, int kind = -1 )	Checks to see that the data field values are valid.

ovm_sequence_item	static bit	issued1 = 0;

ovm_sequence_item	static bit	issued2 = 0;

svt_sequence_item_base	int	kind = svt_sequence_item_base::UNASSIGNED;	Used as an alternate method for the 'kind' argument to compare, is_valid, byte_size, byte_pack, and byte_unpack. If set to a value other than 10, then this value will be used rather than the 'kind' value that is passed into these methods or the policy class that is passed in. Acceptible values are RELEVANT and COMPLETE.

svt_sequence_item_base	enum	kind_enum	Kinds commonly recognized (i.e., via constants) by compare, is_valid, byte_size, byte_pack, and byte_unpack. Although specified as an enum, the constant values associated with these enum elements allow them to be used to define the integer 'kind' parameter to these methods.

svt_sequence_item_base	typedef	kind_enum

svt_sequence_item_base	function bit	load ( int file )

svt_sequence_item_base	function bit	load_from_string ( string text )

svt_sequence_item_base	function bit	load_prop_vals ( string filename = "", int file = 0 )	This method loads the property values from the indicated file assuming a basic text format. If filename specified without file then creates file handle and uses it to load the values. If file specified without filename then uses file to load the values. If both filename and file specified than no load is attempted and the failure is indicated via the return.

svt_sequence_item_base	function bit	load_prop_vals_with_checks ( string filename = "", int file = 0 )	This method calls load_prop_vals, but enables checking on the file format and content.


svt_sequence_item_base	function int	log_base_2 ( int val, bit round_up = 1 )	This method returns the log_base_2 of provided value.



svt_sequence_item_base	function void	mcd_log_object ( int mcd_log_file, string mcd_parameter )

svt_mem_transaction	constraint	mem_transaction_valid_ranges

ovm_transaction	protected function integer	m_begin_tr ( time begin_time = 0, integer parent_handle = 0, bit has_parent = 0 )

ovm_object	static protected function void	m_delete_field_array ( )

ovm_sequence_item	protected int	m_depth = -1;

ovm_object	protected function int	m_do_data ( string arg, inout ovm_bitstream_t lhs, input ovm_bitstream_t rhs, int what, int bits, int flag )

ovm_object	protected function int	m_do_data_object ( string arg, inout ovm_object lhs, input ovm_object rhs, int what, int flag )

ovm_object	protected function int	m_do_data_real ( string arg, inout real lhs, input real rhs, int what, int flag )

ovm_object	protected function int	m_do_data_string ( string arg, inout string lhs, input string rhs, int what, int flag )

ovm_object	protected function void	m_do_field_check ( string field )

ovm_object	protected function int	m_do_set ( string match, string arg, inout ovm_bitstream_t lhs, input int what, int flag )

ovm_object	protected function int	m_do_set_object ( string match, string arg, inout ovm_object lhsobj, input int what, int flag )

ovm_object	protected function int	m_do_set_string ( string match, string arg, inout string lhs, input int what, int flag )

ovm_object	static protected int	m_field_array [string]


ovm_object	protected function string	m_get_function_type ( int what )

ovm_object	protected virtual function ovm_report_object	m_get_report_object ( )

ovm_object	static function ovm_status_container	m_get_status ( )

ovm_object	static protected int	m_inst_count = 0;




ovm_sequence_item	protected ovm_sequence_base	m_parent_sequence = null;

ovm_object	protected function void	m_record_field_object ( string arg, ovm_object value, ovm_recorder recorder = null, int flag = OVM_DEFAULT )

ovm_object	static protected ovm_status_container	m_sc = init_status;


ovm_sequence_item	protected ovm_sequencer_base	m_sequencer = null;

ovm_sequence_item	virtual function void	m_set_p_sequencer ( )


svt_sequence_item_base	static int	max_array_elem_display = SVT_MAX_ARRAY_ELEM_DISPLAY_DEFAULT;	Used by all svt_data derived display methods to limit the number of array entries which are displayed whenever an array data member is displayed. If the number of array elements is less than or equal to the max_array_elem_display value or max_array_elem_display is set to -1, then all array elements are displayed. If max_array_elem_display is set to 0, then only the array size will be displayed. Otherwise max_array_elem_display array elements are displayed. Since this field is not owned by an individual instance, it is not copied, compared, etc., like the other svt_data properties. Initial value set to SVT_MAX_ARRAY_ELEM_DISPLAY_DEFAULT so it can be overridden at compile time.

ovm_sequence_item	protected bit	m_use_sequence_info = 0;

ovm_sequence_item	virtual function void	mid_do ( ovm_sequence_item this_item )




svt_mem_transaction	function void	new ( string name = "svt_mem_transaction", string suite_name = "" )	CONSTRUCTOR: Create a new transaction instance, passing the appropriate argument values to the parent class.

svt_sequence_item	enum	notifications_e	Enum used to provide compatibility layer for supporting vmm_data notify types in UVM. SHOULD ONLY BE USED IN SUITES IMPLEMENTED TO UTILIZE UVM/VMM BRIDGE TECHNOLOGIES.

svt_sequence_item	typedef	notifications_e

svt_sequence_item_base	enum value	NULL


ovm_object	function int	pack ( ref bit bitstream[], input ovm_packer packer )

ovm_object	function int	pack_bytes ( ref byte unsigned bytestream[], input ovm_packer packer )

ovm_object	function int	pack_ints ( ref int unsigned intstream[], input ovm_packer packer )

svt_sequence_item_base	function void	pack_pattern_data ( svt_pattern_data pd, ovm_packer packer )	Pack the information associated with a single pattern_data instance.

svt_sequence_item	enum value	PARTIAL_ACCEPT


svt_mem_transaction	int unsigned	phys_addr [SVT_MEM_SA_CORE_PHYSICAL_DIMENSIONS_MAX]	Values representing the base physical address for the transaction. These values must be assigned in order to enable recording of the physical address.

ovm_sequence_item	virtual function void	post_do ( ovm_sequence_item this_item )

svt_sequence_item	function void	post_randomize ( )	Override post_randomize to implement the 'post' half of a pre_randomize/post_randomize handshake, designed to insure that pre_randomize and post_randomize are not blocked by extended classes.

svt_sequence_item_base	function int	power_of_2 ( int val )	This method returns the power of 2 of provided value.

ovm_sequence_item	virtual task	pre_do ( bit is_item )


svt_sequence_item	function void	pre_randomize ( )	Override pre_randomize to implement the 'pre' half of a pre_randomize/post_randomize handshake, designed to insure that pre_randomize and post_randomize are not blocked by extended classes.

ovm_object	function void	print ( ovm_printer printer = null )

ovm_object	static function void	print_field_match ( string fnc, string match )

ovm_object	static bit	print_matches = 0;

svt_sequence_item_base	function void	print_pattern_data ( svt_pattern_data pd, ovm_printer printer, input string name_override )	Print the information associated with a single pattern_data instance.

ovm_sequence_item	bit	print_sequence_info = 0;

svt_sequence_item	task	priority_finish ( ovm_sequence_base parent_sequence = null, int set_priority = -1 )	Utility method used to finish a transaction based on the provided priority.

svt_sequence_item	task	priority_start ( ovm_sequence_base parent_sequence = null, int set_priority = -1 )	Utility method used to start a transaction based on the provided priority.

svt_sequence_item	static svt_sequence_item_base :: recursive_op_enum	protocol_xacts_opts	Used by all svt_transaction derived 'copy' and 'compare' methods to determine whether the lower level protocol references are not copied or compared (NULL), the references are copied and compared (SHALLOW), or whether the objects are copied and compared (DEEP). Since not owned by an individual instance, not copied, compared, etc., like other svt_transaction properties.

svt_sequence_item	function string	psdisplay_concise ( )	Returns a concise string (32 characters or less) that gives a concise description of the data transaction. Can be used to represent the currently processed data transaction via a signal.

svt_sequence_item	function string	psdisplay_implementation ( string prefix = "", int max_impl_elem_display = -1 )	Displays the implementation list to a string. Each line of the generated output is preceded by prefix.

svt_sequence_item	function string	psdisplay_meta_info ( string prefix = "" )	Displays the meta information to a string. Each line of the generated output is preceded by prefix. Extends class flexibility in choosing what meta information should be displayed.

svt_sequence_item	function string	psdisplay_short ( string prefix = "", bit hdr_only = 0 )	Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.

svt_sequence_item	function string	psdisplay_short_hdr_body ( string prefix = "" )	Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet. This method basically consists of two calls to psdisplay_short, with hdr_only = 1 and hdr_only = 0, to create the header and body information for the transaction.

svt_sequence_item	function string	psdisplay_short_via_pattern ( svt_pattern pttrn, string prefix = "", bit hdr_only = 0 )	Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.

svt_sequence_item	function string	psdisplay_trace ( string prefix = "", int max_trace_elem_display = -1 )	Displays the trace list to a string. Each line of the generated output is preceded by prefix.


svt_mem_transaction	function int	reasonable_constraint_mode ( bit on_off )	Method to turn reasonable constraints on/off as a block.

svt_mem_transaction	constraint	reasonable_data_size

ovm_object	function void	record ( ovm_recorder recorder = null )


svt_sequence_item_base	function void	record_pattern_data ( svt_pattern_data pd, ovm_recorder recorder, input string name_override )	Record the information associated with a single pattern_data instance.

svt_sequence_item_base	enum	recursive_op_enum	Hierachical transaction options. These are used to control how embedded objects are handled for the 'copy' and 'compare' methods.

svt_sequence_item_base	typedef	recursive_op_enum


svt_sequence_item	function void	recycle_me ( )	Method to add this transaction to recycled_xact [$], which is a queue of recycled transactions. Transactions should only be recycled if the client is sure that the transaction is no longer in use.

svt_sequence_item_base	enum value	RELEVANT

svt_sequence_item_base	static ovm_comparer	relevant_comparer = null;	This static `SVT_XVM(comparer) can be used to request a RELEVANT compare. This is a shared comparer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

svt_sequence_item_base	static ovm_packer	relevant_packer = null;	This static `SVT_XVM(packer) can be used to request a RELEVANT pack. This is a shared packer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

svt_sequence_item_base	static ovm_report_object	reporter = ovm_root;	All messages originating from data objects are routed through `SVT_XVM(top)

ovm_object	function void	reseed ( )

svt_sequence_item_base	function int	resolve_compare_kind ( int kind, ovm_comparer comparer )	Resolves the kind value used for compare operations.

svt_sequence_item_base	function int	resolve_is_valid_kind ( int kind )	Resolves the kind value used for is_valid operations.

svt_sequence_item_base	function int	resolve_pack_kind ( int kind, ovm_packer packer )	Resolves the kind value used for pack/unpack operations.

svt_sequence_item	enum value	RETRY

svt_sequence_item_base	function real	safe_atoreal ( string ascii_real )	Utility method which can be used to safely convert an ascii string to a real value, dealing with any embedded '_' characters.

svt_sequence_item_base	function void	save ( int file )

svt_sequence_item_base	function bit	save_child_refs ( svt_xml_writer writer, string prefix = "" )	This method can be used to write out Unique IDs for the children of this object using the XML format. The extended class must drive this process, but can use the save_ref method on the to individual children to output those children.

svt_sequence_item_base	function bit	save_object_begin ( svt_xml_writer writer )	This method uses the 'writer' class methods to write out the object begin data to file. This method is intoduced to resolve the Verdi call back issue where during concurrent transaction the order of the transaction has to be correct otherwise Verdi dumper APIs will have performance issue.

svt_sequence_item_base	function bit	save_object_data ( svt_xml_writer writer, string prefix = "" )	This method writes the object start to XML/FSDB file, This method is introduced to resolve the Verdi call back issue where during concurrent transaction the order of the transaction as to be correct otherwise Verdi dumper APIs will have performance issue.

svt_sequence_item_base	function bit	save_pattern_to_xml ( svt_xml_writer writer, svt_pa_object_data pa_obj_data, svt_pattern pttrn, string prefix = "" )	This method writes the property values stored in the pattern to the indicated file using the XML format.

svt_sequence_item_base	function bit	save_prop_vals ( string filename = "", int file = 0, string prefix = "" )	This method saves the property values to the indicated file using a basic text format. If filename specified without file then creates file handle and uses it to saves the values. If file specified without filename then uses file to save the values. If both filename and file specified than no save is attempted and the failure is indicated via the return.

svt_sequence_item_base	function bit	save_prop_vals_to_fsdb ( string inst_name, string parent_object_uid = "", string stream_attr_namestream_attr_name = [$], string stream_attr_valstream_attr_val = [$] )	This method writes the property values associated with this data object to an FSDB file.


svt_sequence_item_base	function bit	save_prop_vals_to_fsdb_internal ( string top_level_name, string object_channel, string parent_object_uid = "", string object_uid = "", string prefix = "" )	This is an internal method and should not be used by external components.




svt_sequence_item	function bit	save_prop_vals_to_xml ( svt_xml_writer writer, string object_block_desc = "", string prefix = "" )	This method overides the super method to set the 'active_xml_start_time' to support backward compatibility and call the super class method to save the object properties.

svt_sequence_item_base	function bit	save_ref ( svt_xml_writer writer, string prefix = "" )	This method can be used to write out the Unique IDs for an object using the XML format.

svt_sequence_item	function void	scramble ( input byte unsigned array_in[], ref bit [15:0] lfsr, output byte unsigned array_out[] )	Function is used for scrambling a byte of data. Following rules are followed while implementing this function: 1) The LFSR implements the polynomial: G(X)=X^16+X^5+X^4+X^3+1 2) All D-codes and K-codes are scrambled. 3) There is no resetting of the LFSR under any condition.

ovm_sequence_item	virtual function void	send_request ( ovm_sequence_item request, bit rerandomize = 0 )





svt_sequence_item	function void	set_comp_comparer ( ovm_comparer comp_comparer )	Method used to set comp_comparer, defining the function of the comp compare. If not provided comp uses the svt_sequence_item_base :: relevant_comparer.

svt_sequence_item	function void	set_crc_initial_value ( bit [31:0] init )	Utility method for setting the CRC initial value.

svt_sequence_item	function void	set_crc_polynomial ( bit [31:0] poly )	Utility method for setting the CRC polynomial value.

svt_sequence_item	function void	set_data_converter ( svt_data_converter new_converter )	Method to set the current data converter. Extended classes which provide data converter capabilities should overload this method to store away the current data converter, typically shared as a static member of the suite specific transaction object.

ovm_sequence_item	function void	set_depth ( int value )


ovm_sequence_item	function void	set_id_info ( ovm_sequence_item item )

ovm_transaction	function void	set_initiator ( ovm_component initiator )

svt_sequence_item_base	function void	set_int_local ( string field_name, ovm_bitstream_t value, bit recurse = 1 )	Override the 'set_int_local' method to simply set the field via set_prop_val.

svt_sequence_item	function void	set_is_internal ( bit is_internal = 1 )	Method to set the is_internal value.

ovm_object	function void	set_name ( string name )

ovm_object	function void	set_object_local ( string field_name, ovm_object value, bit clone = 1, bit recurse = 1 )

ovm_sequence_item	function void	set_parent_seq ( ovm_sequence_base parent )

ovm_sequence_item	function void	set_parent_sequence ( ovm_sequence_base parent )

svt_sequence_item_base	function bit	set_prop_object ( string prop_name, svt_sequence_item_base prop_obj, int array_ix )	This method allows clients to assign an object to a single named property supported by a class derived from this class. This base class implementation always returns a value of '0' since the svt_sequence_item_base class has no 'object' properties.

svt_mem_transaction	function bit	set_prop_val ( string prop_name, bit [1023:0] prop_val, int array_ix )	HDL Support: For write access to public data members of this class.

svt_sequence_item_base	function bit	set_prop_val_via_pattern ( svt_pattern pttrn )	This method takes advantage of the set_prop_val method to make a simple way to take a common property pattern, and apply it across multiple data instances. The method simply takes all of the name/value pairs specified in pttrn, and uses set_prop_val to apply them to the data instance.

svt_sequence_item_base	function void	set_prop_val_via_plusargs ( string plusarg_keyword )	This method takes advantage of the set_prop_val method to load up a set of property values based on a command line plusarg value.

ovm_sequence_item	function void	set_sequence_id ( int id )

ovm_sequence_item	function void	set_sequencer ( ovm_sequencer_base sequencer )

svt_sequence_item_base	function void	set_string_local ( string field_name, string value, bit recurse = 1 )	Override the 'set_string_local' method to simply set the field via set_prop_val.


ovm_transaction	function void	set_transaction_id ( integer id )

ovm_sequence_item	function void	set_use_sequence_info ( bit value )

svt_sequence_item_base	enum value	SHALLOW

svt_sequence_item_base	static ovm_comparer	silent_complete_comparer = null;	This static `SVT_XVM(comparer) can be used to request a COMPLETE compare and to hide the messages generated due to comparison failures. This is a shared comparer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

svt_sequence_item_base	function void	silent_mode ( bit mode )	Disables generation of internal messages. This can be used to turn off debug messages while executing a method that may itself be used as an argument to VMM message macros. Using this feature resolves the issue of embedded messages.


svt_sequence_item_base	static ovm_comparer	silent_relevant_comparer = null;	This static `SVT_XVM(comparer) can be used to request a RELEVANT compare and to hide the messages generated due to comparison failures. This is a shared comparer used by the VIP as well as the environment. As such any modifications will have a global impact and should be done with care.

ovm_object	function string	sprint ( ovm_printer printer = null )

svt_sequence_item	enum value	STARTED

ovm_sequence_item	virtual task	start_item ( ovm_sequence_item item, int set_priority = -1 )

svt_sequence_item	enum	status_enum	Used to indicate status for a transaction or for a data flow within a transaction. Transactions may be setup with a single status property, or they may have multiple properties corresponding to the different data flows supported by the transaction.

svt_sequence_item	typedef	status_enum

svt_sequence_item	function void	store_causal_ref ( svt_sequence_item causal )	This method updates this transaction's causal_xact reference to point to the causal transaction.

svt_sequence_item	function void	store_context ( svt_sequence_item implementation_xact )	This method first sets up the causal reference for the implementation_xact and then saves the implementation_xact in the implementation [$] transaction list.

svt_sequence_item	function void	store_original_ref ( svt_sequence_item original )	This method updates this transaction's original_xact reference to point to the original transaction.

svt_sequence_item	function void	store_trace ( svt_sequence_item trace_xact, bit copy = 1, svt_sequence_item_base :: recursive_op_enum copy_depth = SHALLOW )	This method is used to add trace_xact to the trace [$] transaction list associated with this transaction. It first sets up our transaction as the original_xact reference for the trace_xact transaction, and then saves the trace_xact transaction in the trace [$] transaction list.


svt_sequence_item_base	static function bit	strip_array_element_suffix ( ovm_report_object reporter, string prop_name, output string base_name, output int array_ix )	Utility method which accepts a property name containing an array element index, and returns the base property name and the index value.

svt_sequence_item_base	protected string	suite_name = "";	Identifies the product suite with which a derivative class is associated. Can be accessed through 'get_suite_name', but cannot be altered after object creation.


svt_sequence_item	realtime	svt_accept_realtime = 0;	Time at which this transaction was accepted recorded as a realtime value


svt_sequence_item	realtime	svt_begin_realtime = 0;	Time at which this transaction was started recorded as a realtime value



svt_sequence_item	realtime	svt_end_realtime = 0;	Time at which this transaction was ended recorded as a realtime value


svt_sequence_item	function int	svt_get_tr_handle ( )	Bridge method providing a single call to get integral recording transaction handle for this sequence.

svt_sequence_item	svt_sequence_item	trace [$]	Trace of any transactions of the same type that were created as a result of processing this transaction (e.g., due to retries, etc.). If enable_trace defined to return 0, then only contains 'last' traced transaction. If enable_trace defined to return 1, then contains all traced transactions. Elements are added to this list via calls to store_trace.




svt_sequence_item_base	enum value	UNASSIGNED


ovm_object	function int	unpack ( ref bit bitstream[], input ovm_packer packer )

ovm_object	function int	unpack_bytes ( ref byte unsigned bytestream[], input ovm_packer packer )

ovm_object	function int	unpack_ints ( ref int unsigned intstream[], input ovm_packer packer )

svt_sequence_item_base	function void	unpack_pattern_data ( svt_pattern_data pd, ovm_packer packer )	Unpack the information associated with a single pattern_data instance.

svt_sequence_item	function void	unscramble ( input byte unsigned array_in[], ref bit [15:0] lfsr, output byte unsigned array_out[] )	Function is used for unscrambling a byte of data. The function returns 0 and the output is unpredictable if Xs and Zs are passed in via the argument. Following rules are followed while implementing this function: 1) The LFSR implements the polynomial: G(X)=X^16+X^5+X^4+X^3+1 2) There is no resetting of the LFSR under any condition.

ovm_object	static bit	use_ovm_seeding = 1;

svt_mem_transaction	rand svt_mem_data_t	valid []	Indicates which bits in corresponding 'data' array element are valid. The size of this array must be either 0 or equal to the size of the 'data' array. A size of 0 implies all data bits are valid. Defaults to size == 0.

svt_sequence_item	task	wait_begin ( )	Utility method which can be used to wait for the beginning of this transaction independent of the underlying methodology.

svt_sequence_item	task	wait_end ( )	Utility method which can be used to wait for the end of this transaction independent of the underlying methodology.

svt_sequence_item	task	wait_end_last_implementation ( )	Utility method which can be used to wait for the end of the last transaction in the implementation queue.

svt_sequence_item	task	wait_for_causal_ref ( )	This method waits for the transaction's causal_xact reference to point to something other than null.

svt_sequence_item	task	wait_for_causal_ref_thru_time_unit ( int wait_time = 1 )	This method waits for the transaction's causal_xact reference to point to something other than null, but only for the indicated number of time units. It gives up if the value isn't updated within the specificied number of time units.

ovm_sequence_item	virtual task	wait_for_grant ( int item_priority = -1, bit lock_request = 0 )

ovm_sequence_item	virtual task	wait_for_item_done ( int transaction_id = -1 )