svt_configuration Class Reference

This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are related to enabling coverage.

Regular expressions are used to identify checks which will be enabled. If these expressions identify properties that should not be enabled for checks, or if there are properties that are missed by these expressions then this method can be extended and the pattern can be altered.

Return values - An svt_pattern instance containing entries for all of the fields related to enabling coverage.

This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are related to enabling coverage.

Regular expressions are used to identify coverage which will be enabled. If these expressions identify properties that should not be enabled for coverage, or if there are properties that are missed by these expressions then this method can be extended and the pattern can be altered.

Return values - An svt_pattern instance containing entries for all of the fields related to enabling coverage.

This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are related to debug.

Regular expressions are used to identify debug features that will be enabled. If these expressions identify properties that should not be enabled for debug, or if there are properties that are missed by these expressions then this method can be extended and the pattern can be altered.

Return values - An svt_pattern instance containing entries for all of the fields related to debug

This method allocates the same pattern as allocate_pattern, minus the elements which do not include the "dynamic" keyword.

Return values - An svt_pattern instance containing entries for the data fields which include the "dynamic" keyword.

This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are related to PA.

Regular expressions are used to identify PA features that will be enabled. If these expressions identify properties that should not be enabled for PA, or if there are properties that are missed by these expressions then this method can be extended and the pattern can be altered.

Return values - An svt_pattern instance containing entries for all of the fields related to PA.

This method allocates the same pattern as allocate_pattern, minus the elements which include the "dynamic" keyword.

Return values - An svt_pattern instance containing entries for the data fields which do not include the "dynamic" keyword.

This method checks the packer max bytes value required by the suite. This involves checking the value provided by get_packer_max_bytes_required against `SVT_XVM_UC(MAX_PACKER_BYTES). It also includes checking `SVT_XVM_UC(MAX_PACKER_BYTES) against the `SVT_XVM(pack_bitstream_t) size to make sure that the define is consistent with the buffer storage which has been allocated.

If the user is using multi-step compilation and has failed to specify `SVT_XVM_UC(PACKER_MAX_BYTES) on the command line then it can lead to a compile time failure about an unrecognized macro. This method isprovided in unencrypted form to simplify the recognition of this situation. This situation can be resolved by adding an appropriate `SVT_XVM_UC(MAX_PACKER_BYTES) value on the appropriate command line.

Used to limit a copy to the dynamic data members of the object.

Used to limit a copy to the static data members of the object.

Provide string values for contained_cfg_opts.

prop_name - The name of the property being encoded.

prop_val_string - The string describing the value to be encoded.

prop_val - The bit vector encoding of prop_val_string.

typ - Optional field type used to help in the encode effort.

Return values - The enum value corresponding to the desc.

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.

Extend the UVM copy routine to copy via copy_static_data/copy_dynamic_data

Pack the fields in the configuration base class.

Unpack the fields in the configuration base class.

Parses the configuration object using patterns and automatically enables coverage if enable_cov set to '1' based on the svt_enable_cov plusarg.

This method is called automatically when the reconfigure method is called on any of the top level components.

Parses the configuration object using patterns and enables debug options.

This method should be called by the top level component in extended suites, immediately after the configuration is received for the first time. It is also called automatically when the reconfigure method is called.

inst - Instance name of the component that is enabled for debug

path - Optional argument to provide the hierarchical path to this object

Parses the configuration object using patterns and automatically enables PA options if enable_pa set to '1' based on the svt_enable_pa plusarg.

This method is called automatically when the reconfigure or enable_debug_opts method is called on any of the top level components.

This method scans the sub-object hierarchy looking for sub-configurations. It returns an associative array of the objects, indexed by the paths to the sub-objects.

sub_cfgs - An svt_configuration associative array with entries for all of the svt_configration sub-objects, indexed by the sub-object field names.

Parses the configuration object using patterns to see if checks has been enabled on any of the layers or protocol as a whole.

Parses the configuration object using patterns to see if coverage has been enabled on any of the layers or protocol as a whole.

This method returns the maximum packer bytes value required by the suite. This is checked against `SVT_XVM_UC(MAX_PACKER_BYTES) when the configuration class is constructed to make sure the provied value is sufficient for the extended suite.

The default implementation just returns `SVT_XVM_UC(MAX_PACKER_BYTES) value. Individual suites extend this method to indicate any specific requirements they may have.

Note: This method should only be implemented by suites that require packing/unpacking operations for normal operation, and if the default size defined in the UVM/OVM base class library is not sufficient. In this situation the VIP developer knows that the user must provide a larger value on the command line through the use of of the `SVT_XVM_UC(MAX_PACKER_BYTES) macro, and so this check should be performed in the constructor of the configuration object.

Not all suites require packing/unpacking operations for normal operation. If a VIP developer determines that packing/unpacking is not required for normal operation of the VIP then this method should not be implemented (and the check should not be performed). However, if a larger value for `SVT_XVM_UC(MAX_PACKER_BYTES) is required to complete pack/unpack operations for specific transactions then these operations will fail if the user attempts this. In this situation the VIP developer should determine what minimum `SVT_XVM_UC(MAX_PACKER_BYTES) is required and should implement the get_packer_max_bytes_required method in the extended transaction class instead. This will cause the check to only be performed if the user attempts to pack or unpack the transaction class, and so the user will only need to provide `SVT_XVM_UC(MAX_PACKER_BYTES) value on the command line if they need to perform the pack/unpack operations.

This method is used by a component's command interface, to allow command code to retrieve the value of a single named property of a data class derived from this class. If the prop_name argument does not match a property of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1', with the value of the prop_val argument assigned to the value of the specified property. However, If the property is a sub-object, a reference to it is assigned to the data_obj (ref) argument. In that case, the prop_val argument is meaningless. The component will then store the data object reference in its temporary data object array, and return a handle to its location as the prop_val argument of the get_data_prop task of the component. The command testbench code must then use that handle to access the properties of the sub-object.

prop_name - The name of a property in this class, or a derived class.

prop_val - A ref argument used to return the current value of the property, expressed as a 1024 bit quantity. When returning a string value each character requires 8 bits so returned strings must be 128 characters or less.

array_ix - If the property is an array, this argument specifies the index being accessed. If the property is not an array, it should be set to 0.

data_obj - If the property is not a sub-object, this argument is assigned to null. If the property is a sub-object, a reference to it is assigned to this (ref) argument. In that case, the prop_val argument is meaningless. The component will then store the data object reference in its temporary data object array, and return a handle to its location as the prop_val argument of the get_data_prop task of the component. The command testbench code must then use that handle to access the properties of the sub-object.

Return values - A single bit representing whether or not a valid property was retrieved.

Checks the PA related flags 'enable_xml_gen' and returns '1' if any of the 'enable_.*xml_gen' is set.

Clients can override this function if requeried to be.

CONSTRUCTOR: Creates a new instance of the svt_configuration class.

name - Instance name of this object.

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

Record the configuration information inside FSDB if writer is available, if the writer is not available at this time then register the data, when the writer is created the data can be written out into FSDB.

inst_name - Instance name of the component that is enabled for debug

This method is used by a component's command interface, to allow command code to set the value of a single named property of a data class derived from this class. This method cannot be used to set the value of a sub-object, since sub-object consruction is taken care of automatically by the command interface. If the prop_name argument does not match a property of the class, or it matches a sub-object of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1'.

prop_name - The name of a property in this class, or a derived class.

prop_val - The value to assign to the property, expressed as a 1024 bit quantity. When assigning a string value each character requires 8 bits so assigned strings must be 128 characters or less.

array_ix - If the property is an array, this argument specifies the index being accessed. If the property is not an array, it should be set to 0.

Return values - A single bit representing whether or not a valid property was set.

This method sets up the field indicating whether coverage support should be enabled automatically.

This method sets up the fields indicating whether PA support should be enabled automatically.