Altera® AXI4 Bus Functional Model User Guides

Download PDF
ID 838773
Date 5/19/2025
Public
Document Table of Contents
Document Table of Contents x
Answers to Top FAQs 1. Altera® AXI4 Memory-Mapped BFM User Guide 2. Altera® AXI4 Streaming BFM User Guide 3. Document Revision History of Altera® AXI4 Bus Functional Model User Guides A. API Translation: Mentor* VIP to Altera® AXI4 Memory-Mapped BFM
1. Altera® AXI4 Memory-Mapped BFM User Guide x
1.1. Altera® AXI4 Memory-Mapped BFM Overview 1.2. Altera® AXI4 Memory-Mapped BFM Architecture 1.3. Altera® AXI4 Memory-Mapped BFM Configuration and Interfaces 1.4. Using the Altera® AXI4 Memory-Mapped BFMs 1.5. Altera® AXI4 Memory-Mapped BFM API 1.6. Altera® AXI4 Memory-Mapped Assertions
1.1. Altera® AXI4 Memory-Mapped BFM Overview x
1.1.1. Altera® AXI4 Memory-Mapped Specification Support 1.1.2. Altera® AXI4 Memory-Mapped BFM Components 1.1.3. Altera® AXI4 Memory-Mapped Supported Features 1.1.4. Altera® AXI4 Memory-Mapped BFM SystemVerilog Packages 1.1.5. Altera® AXI4 Memory-Mapped BFM Supported Flows 1.1.6. Altera® AXI4 Memory-Mapped BFM Supported Simulators
1.2. Altera® AXI4 Memory-Mapped BFM Architecture x
1.2.1. Altera® AXI4 Memory-Mapped Manager BFM Architecture 1.2.2. Altera® AXI4 Memory-Mapped Subordinate BFM Architecture 1.2.3. Altera® AXI4 Memory-Mapped Monitor BFM Architecture 1.2.4. Altera® AXI4 Memory-Mapped BFM Transaction Class
1.2.4. Altera® AXI4 Memory-Mapped BFM Transaction Class x
1.2.4.1. Altera® AXI4 Transaction Information
1.3. Altera® AXI4 Memory-Mapped BFM Configuration and Interfaces x
1.3.1. Altera® AXI4 Memory-Mapped Manager BFM Configuration 1.3.2. Altera® AXI4 Memory-Mapped Manager BFM Interface 1.3.3. Altera® AXI4 Memory-Mapped Subordinate BFM Configuration 1.3.4. Altera® AXI4 Memory-Mapped Subordinate BFM Interface 1.3.5. Altera® AXI4-Lite Memory-Mapped Manager BFM Configuration 1.3.6. Altera® AXI4-Lite Memory-Mapped Manager BFM Interface 1.3.7. Altera® AXI4-Lite Memory-Mapped Subordinate BFM Configuration 1.3.8. Altera® AXI4-Lite Memory-Mapped Subordinate BFM Interface 1.3.9. Altera® AXI4 Memory-Mapped Inline Monitor Configuration 1.3.10. Altera® AXI4 Inline Monitor Interface
1.4. Using the Altera® AXI4 Memory-Mapped BFMs x
1.4.1. Using the Altera® AXI4 Memory-Mapped Manager BFM Flow 1.4.2. Using the Altera® AXI4 Memory-Mapped Subordinate BFM Flow 1.4.3. Using the Altera® AXI4 Memory-Mapped Monitor BFM Flow 1.4.4. Altera® AXI4 Memory-Mapped Manager RTL Implementation Example 1.4.5. Altera® AXI4 Memory-Mapped Manager Platform Designer BFM Implementation Example
1.5. Altera® AXI4 Memory-Mapped BFM API x
1.5.1. Altera® AXI4 Memory-Mapped BFM Configuration API 1.5.2. Altera® AXI4 Memory-Mapped BFM Reset API 1.5.3. Altera® AXI4 Memory-Mapped Manager Transaction Creation API 1.5.4. Altera® AXI4 Memory-Mapped Subordinate Transaction Creation API 1.5.5. Altera® AXI4 Memory-Mapped Transaction Configuration API 1.5.6. Altera® AXI4 Memory-Mapped BFM Transaction Execution API 1.5.7. Altera® AXI4 Memory-Mapped Host Memory API
2. Altera® AXI4 Streaming BFM User Guide x
2.1. Altera® AXI4 Streaming BFM Overview 2.2. Altera® AXI4 Streaming BFM Architecture 2.3. Altera® AXI4 Streaming BFM Configuration and Interfaces 2.4. Using the Altera® AXI4 Streaming BFMs 2.5. Altera® AXI4 Streaming BFM Packages, Classes, Interfaces, and Modules
2.1. Altera® AXI4 Streaming BFM Overview x
2.1.1. AXI4 Protocol Specification Support 2.1.2. Altera® AXI4 Streaming BFM Components 2.1.3. AXI4 Streaming Supported Features 2.1.4. Altera® AXI4 Streaming BFM SystemVerilog Packages 2.1.5. Altera® AXI4 Streaming BFM Supported Flows 2.1.6. Altera® AXI4 Streaming BFM Supported Simulators
2.2. Altera® AXI4 Streaming BFM Architecture x
2.2.1. Altera® AXI4 Streaming BFM Data Organization 2.2.2. AXI4 Streaming Data Transfer 2.2.3. Altera® AXI4 Streaming Transmitter BFM 2.2.4. Altera® AXI4 Streaming Receiver BFM
2.2.1. Altera® AXI4 Streaming BFM Data Organization x
2.2.1.1. Altera® AXI4 Streaming BFM Beats 2.2.1.2. Altera® AXI4 Streaming BFM Transfers 2.2.1.3. Altera® AXI4 Streaming BFM Packets
2.3. Altera® AXI4 Streaming BFM Configuration and Interfaces x
2.3.1. Altera® AXI4 Streaming Transmitter BFM Configuration 2.3.2. Altera® AXI4 Streaming Transmitter BFM Interfaces 2.3.3. Altera® AXI4 Streaming Receiver BFM Configuration 2.3.4. Altera® AXI4 Streaming Receiver BFM Interface
2.4. Using the Altera® AXI4 Streaming BFMs x
2.4.1. Using the Transmitter BFM Flow 2.4.2. Using the Receiver BFM Flow 2.4.3. Altera® AXI4 Streaming BFM Tools 2.4.4. Altera® AXI4 Streaming BFM RTL Example 2.4.5. Altera® AXI4 Streaming BFM Platform Designer Example
2.4.3. Altera® AXI4 Streaming BFM Tools x
2.4.3.1. Number Formatting 2.4.3.2. Transfer Printing 2.4.3.3. Transfer Comparison
2.5. Altera® AXI4 Streaming BFM Packages, Classes, Interfaces, and Modules x
2.5.1. Altera® AXI4 Streaming Common BFM Packages, Classes, Interfaces, and Modules 2.5.2. Altera® AXI4 Streaming Transmitter BFM Packages, Classes, and Modules 2.5.3. Altera® AXI4 Streaming Receiver BFM Packages, Classes, and Modules
2.5.1. Altera® AXI4 Streaming Common BFM Packages, Classes, Interfaces, and Modules x
2.5.1.1. Package axi4_stream_bfm_types_pkg 2.5.1.2. Package axi4_stream_bytes_class_pkg 2.5.1.3. Package axi4_stream_transfer_class_pkg 2.5.1.4. Package axi4_stream_packet_class_pkg
2.5.1.1. Package axi4_stream_bfm_types_pkg x
2.5.1.1.1. Typedefs 2.5.1.1.2. Utility Function num_formatter 2.5.1.1.3. Interface axi4_stream_if 2.5.1.1.4. AXI4 Streaming Interface Modports 2.5.1.1.5. Protocol-Checking Assertions
2.5.1.2. Package axi4_stream_bytes_class_pkg x
2.5.1.2.1. Class Axi4StreamBytes 2.5.1.2.2. Data Members in Axi4StreamBytes Class 2.5.1.2.3. Methods in Axi4StreamBytes Class Method: get_data_type(): axi4_stream_bytes_t {virtual function} Method: get_data(): byte_t{virtual function} Method: get_keep_value(): bit{virtual function} Method: get_strb_value(): bit {virtual function} Method: get_tuser_value(): bit vector{virtual function} Method: get_raw_data(): byte_t{virtual function} Method: get_error_mask(): byte_t {virtual function} Method: set_error_mask(error_mask: byte_t): void {virtual function} Method: data_has_errors(): bit{virtual function} Method: get_signal_data_as_position_byte(): bit {virtual function} Method: get_signal_data_as_null_byte(): bit{virtual function} Method: get_signal_data_as_reserved_byte(): bit{virtual function} Method: set_signal_data_as_position_byte(signal_data_as_position_byte: bit): void{virtual function} Method: set_signal_data_as_null_byte(signal_data_as_null_byte: bit): void {virtual function} Method: set_signal_data_as_reserved_byte(signal_data_as_reserved_byte: bit): void{virtual function} Method: get_signal_position_as_data_byte(): bit{virtual function} Method: get_signal_position_as_null_byte(): bit{virtual function} Method: get_signal_position_as_reserved_byte(): bit{virtual function} Method: set_signal_position_as_data_byte(signal_position_as_data_byte: bit): void{virtual function} Method: set_signal_position_as_null_byte(signal_position_as_null_byte: bit): void {virtual function} Method: set_signal_position_as_reserved_byte(signal_position_as_reserved_byte: bit): void {virtual function} Method: get_signal_null_as_data_byte(): bit {virtual function} Method: get_signal_null_as_position_byte(): bit {virtual function} Method: get_signal_null_as_reserved_byte(): bit{virtual function} Method: set_signal_null_as_data_byte(signal_null_as_data_byte: bit): void {virtual function} Method: set_signal_null_as_position_byte(signal_null_as_position_byte: bit): void {virtual function} Method: set_signal_null_as_reserved_byte(signal_null_as_reserved_byte: bit): void{virtual function} Method: print_byte(): void{virtual function} Method: set_data(data_byte: byte_t): void{pure virtual function} Method: is_equal(b: Axi4StreamBytes): bit{pure virtual function} Method: is_not_equal(b: Axi4StreamBytes): bit{virtual function} Method: copy(): Axi4StreamBytes{pure virtual function} 2.5.1.2.4. Class Axi4StreamBytesData 2.5.1.2.5. Methods in Axi4StreamBytesData Class 2.5.1.2.6. Class Axi4StreamBytesPosition 2.5.1.2.7. Methods in Axi4StreamBytesPosition Class 2.5.1.2.8. Class Axi4StreamBytesNull 2.5.1.2.9. Methods in Axi4StreamBytesNull Class 2.5.1.2.10. Class Axi4StreamBytesDataError 2.5.1.2.11. Data Members in Axi4StreamBytesDataError Class 2.5.1.2.12. Methods in Class Axi4StreamBytesDataError 2.5.1.2.13. Class Axi4StreamBytesPositionError 2.5.1.2.14. Data Members in Class Axi4StreamBytesPositionError 2.5.1.2.15. Methods in Class Axi4StreamBytesPositionError 2.5.1.2.16. Class Axi4StreamBytesNullError 2.5.1.2.17. Data Members in Class Axi4StreamBytesNullError 2.5.1.2.18. Methods in Class Axi4StreamBytesNullError
2.5.1.3. Package axi4_stream_transfer_class_pkg x
2.5.1.3.1. Class Axi4StreamTransfer 2.5.1.3.2. Data Members in Class Axi4StreamTransfer 2.5.1.3.3. Methods in Class Axi4StreamTransfer
2.5.1.4. Package axi4_stream_packet_class_pkg x
2.5.1.4.1. Class Axi4StreamPacket 2.5.1.4.2. Data Members in Class Axi4StreamPacket 2.5.1.4.3. Methods in Class Axi4StreamPacket
2.5.2. Altera® AXI4 Streaming Transmitter BFM Packages, Classes, and Modules x
2.5.2.1. Package axi4_stream_bfm_transmit_pkg.sv
2.5.2.1. Package axi4_stream_bfm_transmit_pkg.sv x
2.5.2.1.1. Class TransmitBFM 2.5.2.1.2. Module axi4_stream_bfm_transmit_top 2.5.2.1.3. Method Prototypes in Class TransmitBFM
2.5.3. Altera® AXI4 Streaming Receiver BFM Packages, Classes, and Modules x
2.5.3.1. Package axi4_stream_bfm_receive_pkg.sv
2.5.3.1. Package axi4_stream_bfm_receive_pkg.sv x
2.5.3.1.1. Class ReceiveBFM 2.5.3.1.2. Module axi4_stream_bfm_receive_top 2.5.3.1.3. Method Prototypes in Class ReceiveBFM
Answers to Top FAQs
1. Altera® AXI4 Memory-Mapped BFM User Guide
2. Altera® AXI4 Streaming BFM User Guide
3. Document Revision History of Altera® AXI4 Bus Functional Model User Guides
A. API Translation: Mentor* VIP to Altera® AXI4 Memory-Mapped BFM

2.5.1.2.3. Methods in Axi4StreamBytes Class

This topic describes the methods in the Axi4StreamBytes class.

Method: get_data_type(): axi4_stream_bytes_t {virtual function}

Returns the object’s data format value in type axi4_stream_bytes_t. The allows you to identify the byte’s type to users and other methods.

Method: get_data(): byte_t{virtual function}

Returns the Axi4StreamBytes object data value is done with this get method.

Method: get_keep_value(): bit{virtual function}

Returns the AXI4 streaming bus value of TKEEP for the byte. For TKEEP and TSTRB rules, refer to the AMBA AXI Protocol Specification.

Method: get_strb_value(): bit {virtual function}

Returns the AXI4 streaming bus value of TSTRB for the byte. For TKEEP and TSTRB Refer to the AMBA AXI Protocol Specification.

Method: get_tuser_value(): bit vector{virtual function}

Returns the TUSER data for the current byte. You specify the size and content of this field.

Method: get_raw_data(): byte_t{virtual function}

For the base class, returns the byte’s data value since no errors are applied. This method is included in the base class Axi4StreamBytes so that derived error classes can retrieve the original data value for the byte without errors being applied.

Method: get_error_mask(): byte_t {virtual function}

This method supports the derived error classes. This method returns the error mask value that is EXOR’ed with the raw data to create an errored data value.

For the base class Axi4StreamBytes, the method returns a byte of all zeros, since error creation is only done in the byte error classes.

Method: set_error_mask(error_mask: byte_t): void {virtual function}

This method is used by the byte error classes to set the value of the error mask value that is EXOR’ed with the raw data to create an errored data value.

For the base class Axi4StreamBytes, this function does nothing and is just an empty method. This function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: data_has_errors(): bit{virtual function}

Reports whether a byte has had any errors introduced by the data or the format of the byte. The byte error classes are setup to introduce data errors in the AXI4 streaming bus, but may be configured to send error-free data. Formatting errors involve showing the wrong values for TKEEP or TSTRB for the byte.

For the base class Axi4StreamBytes, the method returns a zero since error creation is only done in the byte error classes.

Method: get_signal_data_as_position_byte(): bit {virtual function}

This get method checks this error control bit to see if it is set. The data error class Axi4StreamBytesDataError can create format errors such that the Data byte is signaled as a Position byte instead.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_data_as_null_byte(): bit{virtual function}

Checks this error control bit to see if it is set. The data error class Axi4StreamBytesDataError can create format errors such that the Data byte is signaled as a Null byte instead.

For the base class Axi4StreamBytes the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_data_as_reserved_byte(): bit{virtual function}

Verifies that this error control bit is set. The data error class Axi4StreamBytesDataError can create format errors, such that the Data byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: set_signal_data_as_position_byte(signal_data_as_position_byte: bit): void{virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The data error class Axi4StreamBytesDataError can create format errors, such that the Data byte is signaled as a Position byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. This function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_data_as_null_byte(signal_data_as_null_byte: bit): void {virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The data error class Axi4StreamBytesDataError can create format errors, such that the Data byte is signaled as a Null byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_data_as_reserved_byte(signal_data_as_reserved_byte: bit): void{virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The data error class Axi4StreamBytesDataError can create format errors, such that the Data byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: get_signal_position_as_data_byte(): bit{virtual function}

Verifies that this error control bit is set. The position error class Axi4StreamBytesPositionError can create format errors such that the Position byte is signaled as a Data byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_position_as_null_byte(): bit{virtual function}

Verifies that this error control bit is set. The position error class Axi4StreamBytesPositionError can create format errors such that the Position byte is signaled as a Null byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_position_as_reserved_byte(): bit{virtual function}

Verifies this error control bit is set. The position error class Axi4StreamBytesPositionError can create format errors, such that the Data byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: set_signal_position_as_data_byte(signal_position_as_data_byte: bit): void{virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The position error class Axi4StreamBytesPositionError can create format errors, such that the Position byte is signaled as a Data byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_position_as_null_byte(signal_position_as_null_byte: bit): void {virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The position error class Axi4StreamBytesPositionError can create format errors, such that the Position byte is signaled as a Null byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_position_as_reserved_byte(signal_position_as_reserved_byte: bit): void {virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The position error class Axi4StreamBytesPositionError can create format errors, such that the Position byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: get_signal_null_as_data_byte(): bit {virtual function}

Verifies this error control bit is set. The null error class Axi4StreamBytesNullError can create format errors, such that the Null byte is signaled as a Data byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_null_as_position_byte(): bit {virtual function}

Verifies this error control bit is set. The null error class Axi4StreamBytesNullError can create format errors, such that the Null byte is signaled as a Position byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: get_signal_null_as_reserved_byte(): bit{virtual function}

Verifies this error control bit is set. The null error class Axi4StreamBytesNullError can create format errors, such that the Null byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, the method returns a zero, since error creation is only done in the byte error classes.

Method: set_signal_null_as_data_byte(signal_null_as_data_byte: bit): void {virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The null error class Axi4StreamBytesNullError can create format errors, such that the Null byte is signaled as a Data byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_null_as_position_byte(signal_null_as_position_byte: bit): void {virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The null error class Axi4StreamBytesNullError can create format errors such that the Null byte would be signaled as a Position byte instead.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: set_signal_null_as_reserved_byte(signal_null_as_reserved_byte: bit): void{virtual function}

Writes the value of this error control bit to enable or disable occurrences of this format error. The null error class Axi4StreamBytesPositionError can create format errors, such that the Null byte is signaled as a reserved byte.

For the base class Axi4StreamBytes, this function does nothing and is an empty method. The function is included in the base class Axi4StreamBytes, like the other error byte methods, for polymorphism compatibility throughout the class hierarchy.

Method: print_byte(): void{virtual function}

Prints out the contents of the byte into the console. In the base class Axi4StreamBytes, the values of the data_format, data_value, and tuser_value are printed out for the byte.

Method: set_data(data_byte: byte_t): void{pure virtual function}

A pure, abstract method specified in the base class Axi4StreamBytes. This function prototype declaration of pure forces all derived classes to include their own set_data() function definition. This is enforced because the act of setting the data might require different processes for different classes.

In the class Axi4StreamBytesDataError, for instance, setting a new data value also means reapplying the error mask to the data to create its new data_error_value. This value is the actual value provided by the method get_data().

Method: is_equal(b: Axi4StreamBytes): bit{pure virtual function}

Compares the local object to one passed in as operand and determines if the objects are equal.

This method is a pure, abstract method specified in the base class Axi4StreamBytes. This function prototype declaration of pure forces all derived classes to include their own is_equal() function definition. This is enforced because what makes different bytes “equal” might require more checking in further generations of subclasses.

For example, in the simple class of AxiStreamBytesData, the only requirements for two bytes to be equal are to have matching the following:

  • data_format
  • data_value

In the class AxiStreamBytesDataError, however, all the following must match for is_equal() to return true:

  • data_format
  • data_value
  • error_mask_value
  • signal_data_as_position_byte
  • signal_data_as_null_byte
  • signal_data_as_reserved_byte

Method: is_not_equal(b: Axi4StreamBytes): bit{virtual function}

Compares one byte to another. The is_not_equal() method is implemented as the inversion of the is_equal() method.

Method: copy(): Axi4StreamBytes{pure virtual function}

A pure, abstract method specified in the base class Axi4StreamBytes and performs a “deep copy” of the byte object and returns this copy as its return value. This is a unique duplicate copy of the object and not simply a copy of the object’s handle. A copy must also have duplicates of their data members, which is why this is an abstract method requiring redefinition in each subclass of Axi4StreamBytes.

Level Two Title