svt_transaction Class Reference

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.

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.

Return values - An svt_pattern instance containing entries for all of the fields required for XML output of the data object.

This methods applies a byte to the CRC algorithm.

value - Value to be applied to the CRC algorithm

init - Optional argument that signifies that the CRC value should be initialied before the value is applied.

Utility method which identifies the 'off' state of the begin event independent of the underlying methodology.

Utility method which identifies the 'on' state of the begin event independent of the underlying methodology.

Returns the size (in bytes) required by the byte_pack operation.

kind - This int indicates the type of byte_size being requested. Only supported kind value is svt_data :: COMPLETE, which results in a size calculation based on the non-static fields. All other kind values result in a return value of 0.

Clears the contents of the transaction so that it can safely be reused.

This method clears the implementation [$] transaction list, as well as any causal references which may have been setup.

This method clears the trace [$] transaction list, as well as any original references which may have been setup.

Copies the object implementation queue into to.

to - vmm_data object is the destination of the copy.

Copies the object trace queue into to.

to - vmm_data object is the destination of the copy.

Decodes a ten bit data value into its eight bit representation. The function returns 0 and the output is unpredictable.

data_in - Ten bit value to be decoded

running_disparity - The value provided to this argument determines whether the ten bit value is selected from the positive or negative disparity column. The value is updated with the disparity of the new ten bit value that is selected. If the encode operation fails then the value remains unchanged.

data_k - Flag that determines when the Ten bit data represents a control character.

data_out - Eight bit decoded data.

Provide string values for exception_list_opts and protocol_xacts_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.

Packs the object into the bytes buffer, beginning at offset, based on the requested byte_pack kind.

bytes - Buffer that will contain the packed bytes at the end of the operation.

offset - Offset into bytes where the packing is to begin.

kind - This int indicates the type of byte_pack being requested. Only supported kind value is svt_data :: COMPLETE, which results in all of the non-static fields being packed and the return of an integer indicating the number of packed bytes. All other kind values result in no change to the buffer contents, and a return value of 0.

Unpacks the object from the bytes buffer, beginning at offset, based on the requested byte_unpack kind.

bytes - Buffer containing the bytes to be unpacked.

offset - Offset into bytes where the unpacking is to begin.

len - Number of bytes to be unpacked.

kind - This int indicates the type of byte_unpack being requested. Only supported kind value is svt_data :: COMPLETE, which results in all of the non-static fields being unpacked and the return of an integer indicating the number of unpacked bytes. All other kind values result in no change to the exception contents, and a return value of 0.

Compares the object with to, based on the requested compare kind. Differences are placed in diff.

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.

Copies the object into to, allocating if necessay.

to - Destination class for the copy operation

Checks to see that the data field values are valid.

silent - bit indicating whether failures should result in warning messages.

kind - This int indicates the type of is_avalid check to attempt. Only supported kind value is svt_data :: COMPLETE, which results in verification that the non-static data members are all valid. All other kind values result in a return value of 1.

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.

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.

data_in - Eight bit value to be encoded.

data_k - Flag that determines when the eight bit data represents a control character.

running_disparity - The value provided to this argument determines whether the ten bit value is selected from the positive or negative disparity column. The value is updated with the disparity of the new ten bit value that is selected. If the encode operation fails then the value remains unchanged.

data_out - Ten bit encoded data.

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.

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 - Status indicating the success/failure of the encode.

Utility method which identifies the 'off' state of the end event independent of the underlying methodology.

Utility method which identifies the 'on' state of the end event independent of the underlying methodology.

Static method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.

class_name - Used to help insure that the retrieved svt_transaction is of the desired type.

Return values - The previously used transaction, ready for reuse.

Accessor method which returns the time at which the accept event was triggered as a realtime value.

Returns a reference of the transaction object. NOTE: This operation is used to fetch details to filter psdisplay_short display fields.

Accessor method which returns the time at which the begin event was triggered as a realtime value.

This method returns the causal_xact transaction reference.

Method provided to get clean real time values to support XML, FSDB and other output.

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'.

This method returns the calculated CRC value.

Utility method for getting the CRC initial value.

Return values - The CRC initial value.

Utility method for getting the crc polynomial value.

Return values - The CRC polynomial value.

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.

Accessor method which returns the time at which the end event was triggered as a realtime value.

Get the indexed transaction out of the implementation [$] property.

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.

Method to get the is_internal value.

This method returns the original_xact transaction reference.

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.

uid - Optional string indicating the unique identification value for object. If not provided uses the 'get_uid' method to retrieve the value.

typ - Optional string indicating the 'type' of the object. If not provided uses the type name for the class.

parent_uid - Optional string indicating the UID of the object's parent. If not provided the method uses get_causal_ref to obtain a handle to the parent and obtain a parent_uid. If no causal reference found the method assumes there is no parent_uid. To cancel the causal reference lookup completely the client can provide a parent_uid value of "". If "" is provided the method assumes there is no parent_uid.

channel - Optional string indicating an object channel. If not provided or set to "" the method assumes there is no channel.

Return values - The 'svt_pa_object_data' required for PA header.

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.

Method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.

class_name - Used to help insure that the retrieved svt_transaction is of the desired type.

Return values - The previously used transaction, ready for reuse.

Method which filters out any begin time values of -1.

Method which filters out any end time values of -1.

Get the indexed transaction out of the trace [$] property.

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.

Method provided to get the transaction status for inclusion in XML and other output.

status - The overall transaction status.

Return values - Indicates whether the status was available (1) or not (0) and therefore whether the status field should be used.

This method initializes the 8b10b lookup tables.

force_load - Forces the 8b10b tables to be re-initialized.

This method initializes the CRC lookup table, saves the CRC width, and the initial CRC value.

poly - Polynomial used to initialize the CRC lookup table

width - Width of the CRC lookup table that is generated

init - The CRC value is initialized to this value

force_load - Forces the CRC algorithm to be re-initialized

This method initializes the scrambling seed.

Determines if this transaction can reasonably be expected to function correctly on the supplied cfg object.

cfg - The svt_configuration to examine for supportability.

silent - Indicates whether issues with the configuration should be reported.

Return values - Returns '1' if sequence is supported by the configuration, '0' otherwise.

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.

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.

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.

Displays the implementation list to a string. Each line of the generated output is preceded by prefix.

prefix - String which precedes each line in the display output.

max_impl_elem_display - Optional int used to control whether the method does a full or partial display of the implementation queue. A value of -1 indicates that the display rules controlled by svt_data :: max_array_elem_display should simply be applied.

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.

Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.

prefix - (Optional: default = "") The string given in this argument becomes the first item listed in the value returned. It is intended to be used to identify the component (or other source) that requested this string. This argument should be limited to 8 characters or less (to accommodate the fixed column widths in the returned string). If more than 8 characters are supplied, only the first 8 characters are used.

hdr_only - (Optional: default = 0) If this argument is supplied, and is '1', the function returns a 3-line table header string, which indicates which packet data appears in the subsequent columns. If this argument is '1', the prefix argument becomes the column label for the first header column (still subject to the 8 character limit).

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.

prefix - (Optional: default = "") The string given in this argument becomes the first item listed in the value returned. It is intended to be used to identify the component (or other source) that requested this string. This argument should be limited to 8 characters or less (to accommodate the fixed column widths in the returned string). If more than 8 characters are supplied, only the first 8 characters are used.

Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.

prefix - (Optional: default = "") The string given in this argument becomes the first item listed in the value returned. It is intended to be used to identify the component (or other source) that requested this string. This argument should be limited to 8 characters or less (to accommodate the fixed column widths in the returned string). If more than 8 characters are supplied, only the first 8 characters are used.

hdr_only - (Optional: default = 0) If this argument is supplied, and is '1', the function returns a 3-line table header string, which indicates which packet data appears in the subsequent columns. If this argument is '1', the prefix argument becomes the column label for the first header column (still subject to the 8 character limit).

Displays the trace list to a string. Each line of the generated output is preceded by prefix.

prefix - String which precedes each line in the display output.

max_trace_elem_display - Optional int used to control whether the method does a full or partial display of the trace queue. A value of -1 indicates that the display rules controlled by svt_data :: max_array_elem_display should simply be applied.

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.

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.

writer - Object which takes care of the basic write operations.

object_block_desc - String that is placed in the 'object' block created for the data object. If not specified method relies on get_xml_object_block_desc method to get default description.

prefix - String to be placed at the beginning of each line in the file.

Return values - Indicates success (1) or failure (0) of the save.

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.

array_in - An array that contains data to be scrambled.

lfsr - Sixteen bit value with which the function encodes the data. It is up to the entity calling this function to keep track of the lfsr value and to provide the correct lfsr value on the subsequent calls.

array_out - An array constaing the scrambled data.

Utility method for setting the CRC initial value.

init - The new CRC initial value.

Utility method for setting the CRC polynomial value.

poly - The new CRC polynomial value.

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.

Method to set the is_internal value.

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 updates this transaction's causal_xact reference to point to the causal transaction.

This method first sets up the causal reference for the implementation_xact and then saves the implementation_xact in the implementation [$] transaction list.

This method updates this transaction's original_xact reference to point to the original transaction.

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.

trace_xact - The transaction to be added to the trace [$] transaction list.

copy - Bit indicating whether the trace_xact or a copy should be stored.

copy_depth - If copy set to 1, indicates whether the copy should be done with a DEEP or SHALLOW copy, thereby including or excluding objects such as implementation [$].

Hook called by the VMM shorthand macro after performing the automated 'copy' routine.

to - Destination class for teh copy operation

CONSTRUCTOR: Creates a new instance of the svt_transaction class, passing the appropriate argument values to the svt_data parent class.

log - An vmm_log object reference used to replace the default internal logger. The class extension that calls super.new should pass a reference to its own static log instance.

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

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.

array_in - An array whose elements need to be unscrambled.

lfsr - Is the Sixteen bit value with which the function decodes the data. It is up to the entity calling this function to keep track of the lfsr value and to provide the correct lfsr value on the subsequent calls.

array_out - An array containing unscrambled data.

Utility method which can be used to wait for the beginning of this transaction independent of the underlying methodology.

Utility method which can be used to wait for the end of this transaction independent of the underlying methodology.

Utility method which can be used to wait for the end of the last transaction in the implementation queue.

This method waits for the transaction's causal_xact reference to point to something other than null.

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.

wait_time - The number of time units to wait before giving up.