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 Data Member: master_id {type: protected static uint64_t} Data Member: transfer_id {type: protected uint64_t} Data Member: master_tid {type: protected static bit [AXI4_STREAMING_TID_WIDTH-1:0]} Data Member: tid {type: protected bit [AXI4_STREAMING_TID_WIDTH-1:0]} Data Member: master_tdest {type: protected static bit [AXI4_STREAMING_TDEST_WIDTH-1:0]} Data Member: tdest {type: protected bit [AXI4_STREAMING_TDEST_WIDTH-1:0]} Data Member: payload [] {type: Axi4StreamBytes} Data Member: creation_time {type: protected realtime} Data Member: send_time {type: protected realtime} Data Member: arrival_time {type: protected realtime} Data Member: master_delay {type: protected static uint32_t} Data Member: master_gap {type: protected static uint32_t} Data Member: data_beats {type: protected uint32_t} Data Member: delay {type: protected uint32_t} Data Member: gap {type: protected uint32_t} Data Member: transfer_sent {type: protected bit} Data Member: transfer_received {type: protected bit} Data Member: transfer_done {type: protected bit} 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.3.2. Data Members in Class Axi4StreamTransfer

The Axi4StreamTransfer class includes the following data members (variables):

Data Member: master_id {type: protected static uint64_t}

Data Member: transfer_id {type: protected uint64_t}

You can use the master_id and transfer_id data members place a unique, identifying marker on each transfer object created. The master_id is a static unsigned 64-bit integer that is used as a free-running counter for the entire class. master_id counts the number of transfer objects created. The Axi4StreamTransfer object’s constructor increments master_id each time a transfer object is created. The variable transfer_id is a copy of the master_id variable value at creation time. The copy of master_id into transfer_id occurs in the Axi4StreamTransfer object constructor, just after the master_id is incremented. You can use these two values in a variety of ways. For example, you can use these two values:

  • As a unique designator for the object.
  • As a count of how many transfer objects have been created.
  • As a method to determine the location of an object within the overall transfer traffic.

Data Member: master_tid {type: protected static bit [AXI4_STREAMING_TID_WIDTH-1:0]}

Data Member: tid {type: protected bit [AXI4_STREAMING_TID_WIDTH-1:0]}

You can use the master_tid and tid members in a similar manner as the master_id and transfer_id members, except that the static master_tid does not increment. Rather, master_tid remains as a class-wide reference variable that, once modified, keeps a persistent value for all following transfers until explicitly changed. This means that the master_tid is a set-and-forget data member for the class. The tid variable is a local, non-static copy of the master_tid value at object creation time. The tid data member directly represents the TID field on the AXI4 streaming bus. The tid data member is driven on every bus beat during a transfer by the transmitter.

Data Member: master_tdest {type: protected static bit [AXI4_STREAMING_TDEST_WIDTH-1:0]}

Data Member: tdest {type: protected bit [AXI4_STREAMING_TDEST_WIDTH-1:0]}

You can use the master_tdest and tdest members in the same manner as the master_tid and tid members, except that the static master_tdest and tdest represent the TDEST field on the AXI4 streaming bus.

The static master_tdest is kept as a class-wide reference variable that, once modified, keeps a persistent value for all following transfers until explicitly changed. This means that master_tdest is a “set-and-forget” data member for the class. The variable tdest is a local non-static copy of master_tdest’s value when the object was created. The tdest data member directly represents the field TDEST on the AXI4 streaming bus. tdest is driven on every bus beat during a transfer by the transmitter.

Data Member: payload [] {type: Axi4StreamBytes}

A dynamic array of Axi4StreamBytes that contains the data driven on the TDATA bus lanes during transfers. Axi4StreamBytes is a polymorphic class containing the compatible hierarchy of:

  • Data Bytes—Axi4StreamBytesData
  • Position Bytes—Axi4StreamBytesPosition
  • Null Bytes—Axi4StreamBytesNull
  • Data Error Bytes—Axi4StreamBytesDataError
  • Position Error Bytes—Axi4StreamBytesPositionError
  • Null Error Bytes—Axi4StreamBytesNullError

You can add any of the above byte classes to the payload. The Axi4StreamTransfer class supplies the methods set_payload_from_data() and set_payload_from_bytes() to load a transfer’s payload[ ] dynamic array with data from the application. Refer to the Methods section later in this document.

Data Member: creation_time {type: protected realtime}

Aet to the simulation time when the Axi4StreamTransfer object is created. This value is set to the value directive $realtime in the object’s constructor.

Data Member: send_time {type: protected realtime}

Set to the value directive $realtime when the transfer is sent by the BFM transmitter. You can compare the send_time data member to the arrival_time value of the received transfer to measure the transit time of the transfer for performance and latency.

Data Member: arrival_time {type: protected realtime}

Set to the value directive $realtime when the transfer is received by the BFM receiver. You can compare the arrival_time data member to the send_time value of the originally transmitted transfer to measure the transit time of the transfer for performance and latency.

Data Member: master_delay {type: protected static uint32_t}

Kept as a class-wide reference variable that, once modified, keeps a persistent value for all following transfers until it is explicitly changed. Modeling delays is an important part of making the Transmitter BFM better emulate components of a system. Like other static data members, this means that master_delay is a set-and-forget data member for the class. This allows modeling components that have a very set and specific delay or latency.

Data Member: master_gap {type: protected static uint32_t}

Kept as a class-wide reference variable that, once modified, keeps a persistent value for all following transfers until it is explicitly changed. Modeling delays may not just include the latency from the transfer issue to the beginning of the transactions on the AXI4 streaming bus, but it might also include a certain delay after a transfer before another one can begin. Like other static data members, this means that master_gap is a set-and-forget data member for the class. This allows modeling components that have a very set and specific recovery time or recharge latency before they can generate another transfer.

Data Member: data_beats {type: protected uint32_t}

Allows you to determine how many data beats are required to transmit the payload in a transfer. The initial number of beats is calculated by dividing the payload size by the TDATA bus width in bytes. Where the number of data beats required to send the transfer is not an even multiple of the TDATA bus width, the partially utilized data transfer required at the end counts as a full data beat (this is the remainder calculation) and one is added to the number of data_beats required.

Data Member: delay {type: protected uint32_t}

The value set in the variable delay is used by the Transmitter BFM to idle the bus for a number of bus beats prior to sending the payload. The variable delay is assigned the current value of the static variable master_delay when the Axi4StreamTransfer object is created via the class’s constructor. Unless there is a need to change the value of delay, the value continues to be assigned the value in the static master_delay. The delay has both get and set methods to monitor and change the value.

Data Member: gap {type: protected uint32_t}

This value is used by the Transmitter BFM to idle the bus for a number of bus beats after sending the payload. The variable gap is assigned the current value of the static variable master_gap when the Axi4StreamTransfer object is created via the class’s constructor. Unless there is a need to change the value of gap, the value continues to be assigned the value in the static master_gap. The gap has both get and set methods to monitor and change the value.

Changing the value using the set method set_gap() also updates the static variable master_gap so subsequent Axi4StreamTransfer objects created have the updated value.

Use the method get_gap() if there might be multiple blocks updating the value for gap in a simulation. You should validate the value of gap to determine if it needs to be updated for a particular transfer.

Data Member: transfer_sent {type: protected bit}

The status flag transfer_sent alerts when the payload of a transfer is sent by the transmitter. When the variable data_beats_remaining is zero during or after the execution of a data beat when the method data_beat_sent() is called, this bit is set.

Data Member: transfer_received {type: protected bit}

The status flag transfer_received alerts when a transfer has been assembled from data beats in the Receiver BFM. This action completes as part of the execution of the method set_transfer_received().

Data Member: transfer_done {type: protected bit}

The status flag transfer_done alerts when the Transmitter BFM completes sending the transfer. This action completes after sending the gap of the transfer, if it is greater than zero, or after the transmission of the payload data if the gap is equal to zero. The flag value can be read with the get method get_transfer_done().

Level Two Title