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 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 Method: set_data(data_byte: byte_t): void{virtual function} Method: get_data(): byte_t{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_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_position_as_null_byte: bit): void{virtual function} Method: set_signal_null_as_position_byte(signal_position_as_reserved_byte: bit): void{virtual function} Method: set_signal_null_as_reserved_byte(signal_position_as_reserved_byte: bit): void{virtual function} Method: is_equal(b: Axi4StreamBytes): bit{virtual function} Method: copy(): Axi4StreamBytes{virtual function} Method: print_byte(): void {virtual function}
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.18. Methods in Class Axi4StreamBytesNullError

This topic describes the methods in the Axi4StreamBytesNullError class.

The following section provides the virtual function redefinitions that occur in class Axi4StreamBytesNullError. The pure virtual functions of the superclass Axi4StreamBytes are already redefined in the first level of the class hierarchy, but have new definitions in this class as well.

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

The set_data() method for this class updates the data_value in contrast with its parent class, and additionally updates the data_value_has_errors value and flags.

Method: get_data(): byte_t{virtual function}

Byte value retrieval is performed with the get_data() method for this class. The value returned is not data_value, but null_error_value that contains the bit errors to data_value when EXOR’ed with error_mask_value. The data_value can have any value, and is not held at 8’h00, unlike the parent class Axi4StreamBytesNull.

Method: get_raw_data(): byte_t{virtual function}

Error-free byte value retrieval is performed with the get_raw_data() method for this class. The value returned is data_value, not the error afflicted null_error_value that contains the bit errors to data_value when EXOR’ed with error_mask_value.

Method: get_error_mask(): byte_t {virtual function}

This is a simple get method for the error byte data member error_mask_value. The data member error_mask_value is EXOR’ed with data_value to create null_error_value, a version of data_value that has data errors in each position that error_mask_value has a 1. This errored version of the data is returned with the method get_data() with this class.

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

This is a simple set method for the error byte data member error_mask_value. This method stores the new error mask and recalculates the value for data_error_value and the summary error bit data_value_has_errors.

Method: data_has_errors(): bit{virtual function}

A functionally-named get method that returns the value of data_value_has_errors. This is a summary error detection bit that is set if there is a bit error in the byte value, or if there are any formatting errors where the data is signaled as being a data, position, or reserved byte instead of data.

Method: get_signal_null_as_data_byte(): bit{virtual function}

Returns the current value of the signal_null_as_data_byte formatting error control bit.

Method: get_signal_null_as_position_byte(): bit{virtual function}

Returns the current value of the signal_null_as_position_byte formatting error control bit.

Method: get_signal_null_as_reserved_byte(): bit{virtual function}

Returns the current value of the signal_null_as_reserved_byte formatting error control bit.

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

Assigns a value to the signal_null_as_data_byte error control bit. If this error control bit is set to a 1’b1, this method ensures that the two other possible formatting error modes, signal_null_as_position_byte and signal_null_as_reserved_byte are cleared to a zero. Only one formatting error is valid at a time.

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

Assigns a value to the signal_null_as_position_byte error control bit. If this error control bit is set to a 1’b1, this method ensures that the two other possible formatting error modes, signal_null_as_data_byte and signal_null_as_reserved_byte are cleared to a zero. Only one formatting error is valid at a time.

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

Assigns a value to the signal_null_as_reserved_byte error control bit. If this error control bit is set to a 1’b1, this method ensures that the two other possible formatting error modes, signal_null_as_data_byte and signal_null_as_position_byte are cleared to a zero. Only one formatting error is valid at a time.

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

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

In the class AxiStreamBytesNullError, all of the following data members in this must match the same field for b for is_equal() to return true, and is false otherwise:

  • data_format
  • data_value
  • error_mask_value
  • signal_null_as_data_byte
  • signal_null_as_position_byte
  • signal_null_as_reserved_byte

Method: copy(): Axi4StreamBytes{virtual function}

Performs a deep copy of the error 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.

Method: print_byte(): void {virtual function}

Prints out the contents of the byte into the console. In the Axi4StreamBytesNullError class, there are a number of object fields that may be of interest at any given time. The following values are printed out for the byte:

  • data_format
  • data_value
  • tuser_value
  • error_mask_value
  • null_error_value
  • data_value_has_errors
  • signal_null_as_data_byte
  • signal_null_as_position_byte
  • signal_null_as_reserved_byte
Level Two Title