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
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 Method: get_pending_transfer_number_in_packet(): uint32_t {function} Method: get_completed_transfer_number_in_packet(): uint32_t {function} Method: get_pending_transfer_number_of_bytes_in_packet(): uint32_t {function} Method: packet_is_empty(): bit {function} packet_is_not_empty(): bit {function} Method: get_completed_transfer_number_of_bytes_in_packet(): uint32_t {function} Method: get_packet_id(): uint64_t {function} Method: get_creation_time(): realtime {function} Method: add_transfer_to_packet(tr: Axi4StreamTransfer): void {function} Method: create_transfer_from_data_and_add_to_packet(data_buf[]: const ref byte_t): void {function} Method: create_transfer_from_bytes_and_add_to_packet(bytes_buf[]: const ref Axi4StreamBytes): void {function} Method: get_next_transfer(): Axi4StreamTransfer {function} Method: get_transfers_done(tr_buf[]: ref Axi4StreamTransfer): void {function} Method: print_transfers_queue(): void {function} Method: print_transfers_queue_long(): void {function} Method: print_transfers_done_queue(): void {function} Method: print_transfers_done_queue_long(): void {function} Method: print_packet_short(): void {function} Method: print_packet(): void {function} Method: print_packet_long(): void {function} Method: print_packet_long_long(): void {function}
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.4.3. Methods in Class Axi4StreamPacket

The Axi4StreamPacket class includes the following data members:

Method: get_pending_transfer_number_in_packet(): uint32_t {function}

This method provides the size of the transfers[$] queue. The return value of the function is simply transfers.size() – queue size, which is the number of transfer objects that it contains.

Method: get_completed_transfer_number_in_packet(): uint32_t {function}

This method provides the number of completed transfers held in the transfers_done[$] queue. For encapsulation reasons, the transfers_done[$] queue data member is protected. This method therefore is provided to check the size of the transfers_done[$] queue safely.

The return value of the function is simply transfers_done.size() – queue size, which is the number of transfer objects it contains.

Method: get_pending_transfer_number_of_bytes_in_packet(): uint32_t {function}

This method returns the number of bytes contained in all the pending transfers in the queue transfers[$]. You can calculate the amount of AXI4 streaming bus time required to send all the packet’s pending transfers from this number. You can thus calculate bus congestion for metric purposes.

Method: packet_is_empty(): bit {function}

This is a simple status-check method that returns a value of one if the number of pending transactions is zero. Otherwise, the method returns a zero.

packet_is_not_empty(): bit {function}

This method is a simple status-check method that returns a value of one if the number of pending transactions is one or greater. Otherwise, the method returns a zero.

Method: get_completed_transfer_number_of_bytes_in_packet(): uint32_t {function}

Returns the number of bytes contained in all the completed transfers in the queue transfers_done[$]. You can calculate the amount of AXI4 streaming bus traffic sent by a packet to monitor the amount of bus congestion and throughput in the overall application.

Method: get_packet_id(): uint64_t {function}

Returns the value of the packet’s packet_id value. The packet_id is a 64-bit, unique value assigned to the packet during creation that you can use as a unique designator for the packet.

Method: get_creation_time(): realtime {function}

Returns the value of the packet’s creation_time. The creation_time is a $realtime value captured by the packet by the class’s constructor.

Method: add_transfer_to_packet(tr: Axi4StreamTransfer): void {function}

Adds transfers to the input transfer queue transfers[$]. The argument is a handle of type Axi4StreamTransfer. This method places the transfer at the back of the transfers[$] queue with: 

this.transfers.push_back(tr);

The transfers placed into the input queue remain until retrieved, in order, for use as data driving the AXI4 streaming bus.

Method: create_transfer_from_data_and_add_to_packet(data_buf[]: const ref byte_t): void {function}

This method performs the following steps to skip a possible unnecessary step of creating a transfer:

  1. Create a new transfer.
  2. Add a payload to this new transfer provided by the dynamic byte_t array data_buf[ ].
  3. Add this new transfer to the input queue transfers[$].

This method only creates transfers with data payload. That is, bytes of class Axi4StreamBytesData that do not contain position, null, or error bytes. If more complex payloads are required, use the method create_transfer_from_bytes_and_add_to_packet().

Method: create_transfer_from_bytes_and_add_to_packet(bytes_buf[]: const ref Axi4StreamBytes): void {function}

This method performs the following steps to skip a possible unnecessary step of creating a transfer:

  1. Create a new transfer.
  2. Add a payload to this new transfer provided by the dynamic Axi4StreamBytes array bytes_buf[ ].
  3. Add this new transfer to the input queue transfers[$].

This method requires you to create all the byte objects needed for the payload in advance of using this method. You must also place those objects into the dynamic array bytes_buf[ ]. This method allows the use of data, position, null and error bytes in the payload, offering the most flexibility in assembling diverse transfer payloads. If payloads are being generated with only data bytes, then you can use the create_transfer_from_data_and_add_to_packet() method instead to simplify the process by bypassing the byte object creation.

Method: get_next_transfer(): Axi4StreamTransfer {function}

Retrieves a transfer from the pending transfers queue transfers[$].. The method returns a handle for the next transfer object in the queue, and adds the transfer to the completed transfers queue transfers_done[$].

Transfers in transfers_done[$] stay in the queue until the Axi4StreamPacket object is destroyed and may be examined or printed out using other methods in this class.

Method: get_transfers_done(tr_buf[]: ref Axi4StreamTransfer): void {function}

Retrieves transfers contained in the transfers_done[$] queue. The tr_buf[ ] argument is cleared, and then all the transfers in transfers_done[$] are loaded into it. You can then examine all completed transfers.

Method: print_transfers_queue(): void {function}

Performs a print_transfer() print of each transfer in the transfers[$] queue showing the payload in data_value format.

Method: print_transfers_queue_long(): void {function}

Performs a print_transfer_long_long() print of each transfer in the transfers[$] queue, showing the payload in data_value format.

Method: print_transfers_done_queue(): void {function}

Performs a transfer queue printout in the same manner and format as print_transfers_queue(), except that the contents of the transfers_done[$] queue are printed instead of transfers[$].

Method: print_transfers_done_queue_long(): void {function}

Performs a transfer queue printout in the same long-form manner and format as print_transfers_queue_long(), except that the contents of the transfers_done[$] queue are printed instead of transfers[$].

Method: print_packet_short(): void {function}

Prints the following packet information:

  1. The packet’s 64-bit unique identifier, packet_id.
  2. The creation time of the packet.
  3. The number of pending transfers the packet has in its transfers[$] queue.

Method: print_packet(): void {function}

This method prints the following packet information:

  1. The packet’s 64-bit unique identifier, packet_id.
  2. The creation time of the packet.
  3. The number of pending transfers the packet has in its transfers[$] queue.
  4. The total number of bytes the pending transfer payloads have.
  5. The total number of completed transfers the packet has in its transfers_done[$] queue.
  6. The total number of bytes the completed transfer payloads have.

Method: print_packet_long(): void {function}

Prints the same packet information as print_packet(), along with the transfer data and data_value of the payload for each pending transfer in the transfers[$] queue.

Method: print_packet_long_long(): void {function}

Prints the same packet information as print_packet(), along with a long print of each transfer in the transfers[$] queue and the transfers_done[$] queue, showing the detailed byte data for each individual object in each transfer’s payload[i].

Level Two Title