svt_base_mem_suite_configuration Class Reference

Inheritance diagram for class svt_base_mem_suite_configuration:

List of all members.

Detailed Description

This memory configuration class encapsulates the base configuration information required by memory VIPs. This class includes the common attributes required by top level configuration class of all memory VIPs (both DRAM & FLASH).

For DRAM based memory VIPs class svt_mem_suite_configuration is available which is extended from this class and can be used as base class by VIP suite configuration class.

For FLASH based memory VIPs this class can be used as base class by VIP suite configuration class.

The current version of this class includes :


Public Member Functions

function unsigned int  byte_size ( int kind = -1 )
function void  copy_dynamic_data ( vmm_data to )
function void  copy_static_data ( vmm_data to )
function void  create_sub_configurations ( )
function svt_pattern  do_allocate_pattern ( )
function bit  do_compare ( vmm_data to, output string diff, input int kind )
function string  get_mcd_class_name ( )
function bit  get_prop_val ( string prop_name, ref bit [1023:0] prop_val, input int array_ix, ref svt_data data_obj )
function void  new ( vmm_log log = null, string suite_name = "" )
function int  reasonable_constraint_mode ( bit on_off )
function bit  set_prop_val ( string prop_name, bit [1023:0] prop_val, int array_ix )
function int  static_rand_mode ( bit on_off )

Public Attributes

string  catalog_class = SVT_DATA_UTIL_UNSPECIFIED; 
string  catalog_package = SVT_DATA_UTIL_UNSPECIFIED; 
string  catalog_part_number = SVT_DATA_UTIL_UNSPECIFIED; 
string  catalog_vendor = SVT_DATA_UTIL_UNSPECIFIED; 
bit  enable_cfg_xml_gen = 0; 
bit  enable_fsm_xml_gen = 0; 
bit  enable_xact_xml_gen = 0; 

Member Function Documentation

  function unsigned int
 svt_base_mem_suite_configuration::byte_size
 (  int kind = -1  ) 

Returns the size (in bytes) required by the byte_pack operation. Only supports COMPLETE pack so kind must be svt_data :: COMPLETE.
 Superseded functions 
 vmm_data :: byte_size 
 svt_data :: byte_size 
 svt_configuration :: byte_size 
 svt_mem_configuration :: byte_size 
 Superseding functions 
 svt_mem_suite_configuration :: byte_size 

  function void
 svt_base_mem_suite_configuration::copy_dynamic_data
 (  vmm_data to  ) 

Used to limit a copy to the dynamic data members of the object.
 Superseded functions 
 svt_configuration :: copy_dynamic_data 
 svt_mem_configuration :: copy_dynamic_data 
 Superseding functions 
 svt_mem_suite_configuration :: copy_dynamic_data 

  function void
 svt_base_mem_suite_configuration::copy_static_data
 (  vmm_data to  ) 

Used to limit a copy to the dynamic data members of the object.
 Superseded functions 
 svt_configuration :: copy_static_data 
 svt_mem_configuration :: copy_static_data 
 Superseding functions 
 svt_mem_suite_configuration :: copy_static_data 

  function void
 svt_base_mem_suite_configuration::create_sub_configurations
 (   ) 

Constructs the sub-configuration classes.
 Superseding functions 
 svt_mem_suite_configuration :: create_sub_configurations 

  function svt_pattern
 svt_base_mem_suite_configuration::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.

Return values - An svt_pattern instance containing entries for all of the data fields.

 Superseded functions 
 svt_data :: do_allocate_pattern 
 svt_configuration :: do_allocate_pattern 
 svt_mem_configuration :: do_allocate_pattern 
 Superseding functions 
 svt_mem_suite_configuration :: do_allocate_pattern 

  function bit
 svt_base_mem_suite_configuration::do_compare
 (  vmm_data to , output string diff , input int kind  ) 

Compares the object with to. Differences are placed in diff. Only supported kind values are -1 and svt_data :: COMPLETE. Both values result in a COMPLETE compare.

to - vmm_data object to be compared against.

diff - String indicating the differences between this and to.

kind - This int indicates the type of compare to be attempted. Only supported kind value is svt_data :: COMPLETE, which results in comparisons of the non-static data members. All other kind values result in a return value of 1.

 Superseded functions 
 vmm_data :: do_compare 
 svt_data :: do_compare 
 svt_mem_configuration :: do_compare 
 Superseding functions 
 svt_mem_suite_configuration :: do_compare 

  function string
 svt_base_mem_suite_configuration::get_mcd_class_name
 (   ) 

Returns the class name for the object used for logging.
 Superseded functions 
 svt_data :: get_mcd_class_name 
 svt_mem_configuration :: get_mcd_class_name 
 Superseding functions 
 svt_mem_suite_configuration :: get_mcd_class_name 

  function bit
 svt_base_mem_suite_configuration::get_prop_val
 (  string prop_name , ref bit [1023:0] prop_val , input int array_ix , ref svt_data data_obj  ) 

HDL Support: For read access to public data members of this class.
 Superseded functions 
 svt_data :: get_prop_val 
 svt_configuration :: get_prop_val 
 svt_mem_configuration :: get_prop_val 
 Superseding functions 
 svt_mem_suite_configuration :: get_prop_val 

  function void
 svt_base_mem_suite_configuration::new
 (  vmm_log log = null, string suite_name = ""  ) 

CONSTRUCTOR: Create a new configuration instance, passing the appropriate argument values to the vmm_data parent class.

log - Sets the log file that is used for status output.

suite_name - A String that identifies the product suite to which the configuration object belongs.

 Superseded functions 
 svt_data :: new 
 svt_configuration :: new 
 svt_mem_configuration :: new 
 Superseding functions 
 svt_mem_suite_configuration :: new 

  function int
 svt_base_mem_suite_configuration::reasonable_constraint_mode
 (  bit on_off  ) 

Method to turn reasonable constraints on/off as a block.
 Superseded functions 
 svt_data :: reasonable_constraint_mode 
 svt_mem_configuration :: reasonable_constraint_mode 
 Superseding functions 
 svt_mem_suite_configuration :: reasonable_constraint_mode 

  function bit
 svt_base_mem_suite_configuration::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.
 Superseded functions 
 svt_data :: set_prop_val 
 svt_configuration :: set_prop_val 
 svt_mem_configuration :: set_prop_val 
 Superseding functions 
 svt_mem_suite_configuration :: set_prop_val 

  function int
 svt_base_mem_suite_configuration::static_rand_mode
 (  bit on_off  ) 

Method to turn static config param randomization on/off as a block.
 Superseded functions 
 svt_configuration :: static_rand_mode 
 svt_mem_configuration :: static_rand_mode 
 Superseding functions 
 svt_mem_suite_configuration :: static_rand_mode 

Member Attribute Documentation

 string  attribute
 svt_base_mem_suite_configuration::catalog_class = SVT_DATA_UTIL_UNSPECIFIED

This property reflects the memory class which is a property of the catalog infrastructure.

 string  attribute
 svt_base_mem_suite_configuration::catalog_package = SVT_DATA_UTIL_UNSPECIFIED

This property reflects the memory package which is a property of the catalog infrastructure.

 string  attribute
 svt_base_mem_suite_configuration::catalog_part_number = SVT_DATA_UTIL_UNSPECIFIED

This property reflects the memory part number which is a property of the catalog infrastructure.

 string  attribute
 svt_base_mem_suite_configuration::catalog_vendor = SVT_DATA_UTIL_UNSPECIFIED

This property reflects the memory vendor which is a property of the catalog infrastructure.

 bit  attribute
 svt_base_mem_suite_configuration::enable_cfg_xml_gen = 0

Indicates whether the configuration information is included in the generated XML. The resulting file can be loaded in Protocol Analyzer to view the configuration contents along with any other recorded information. Set the value to 1 to enable the configuration XML generation. Set the value to 0 to disable the configuration XML generation.

 bit  attribute
 svt_base_mem_suite_configuration::enable_fsm_xml_gen = 0

Indicates whether XML generation is included for state transitions. The resulting file can be loaded in Protocol Analyzer to obtain a graphical presenation of the component FSM activity. Set the value to 1 to enable the FSM XML generation. Set the value to 0 to disable the FSM XML generation.

 bit  attribute
 svt_base_mem_suite_configuration::enable_xact_xml_gen = 0

Indicates whether XML generation is included for memory transactions. The resulting file can be loaded in Protocol Analyzer to obtain a graphical presenation of the transactions on the bus. Set the value to 1 to enable the transaction XML generation. Set the value to 0 to disable the transaction XML generation.

08 August 2024, Copyright © 2024 Synopsys, Inc.