Altera IP Compiler for PCI Express - Manual (Page 268)

15–36 Chapter 15: Testbench and Design Example
BFM Procedures and Functions
IP Compiler for PCI Express User Guide August 2014 Altera Corporation
ebfm_barrd_wait Procedure
The ebfm_barrd_wait procedure reads a block of data from the offset of the specified
endpoint BAR and stores it in BFM shared memory. The length can be longer than the
configured maximum read request size; the procedure breaks the request up into
multiple transactions as needed. This procedure waits until all of the completion data
is returned and places it in shared memory.
ebfm_barrd_nowt Procedure
The ebfm_barrd_nowt procedure reads a block of data from the offset of the specified
endpoint BAR and stores the data in BFM shared memory. The length can be longer
than the configured maximum read request size; the procedure breaks the request up
into multiple transactions as needed. This routine returns as soon as the last read
transaction has been accepted by the VC interface module, allowing subsequent reads
to be issued immediately.
Table 15–25. ebfm_barrd_wait Procedure
Location altpcietb_bfm_rdwr.v or altpcietb_bfm_rdwr.vhd
Syntax ebfm_barrd_wait(bar_table, bar_num, pcie_offset, lcladdr, byte_len, tclass)
Arguments bar_table
Address of the endpoint bar_table structure in BFM shared memory. The
bar_table structure stores the address assigned to each BAR so that the driver code
does not need to be aware of the actual assigned addresses only the application
specific offsets from the BAR.
bar_num Number of the BAR used with pcie_offset to determine PCI Express address.
pcie_offset Address offset from the BAR base.
lcladdr BFM shared memory address where the read data is stored.
byte_len
Length, in bytes, of the data to be read. Can be 1 to the minimum of the bytes
remaining in the BAR space or BFM shared memory.
tclass Traffic class used for the PCI Express transaction.
Table 15–26. ebfm_barrd_nowt Procedure
Location altpcietb_bfm_rdwr.v or altpcietb_bfm_rdwr.vhd
Syntax ebfm_barrd_nowt(bar_table, bar_num, pcie_offset, lcladdr, byte_len, tclass)
Arguments bar_table Address of the endpoint bar_table structure in BFM shared memory.
bar_num Number of the BAR used with pcie_offset to determine PCI Express address.
pcie_offset Address offset from the BAR base.
lcladdr BFM shared memory address where the read data is stored.
byte_len
Length, in bytes, of the data to be read. Can be 1 to the minimum of the bytes
remaining in the BAR space or BFM shared memory.
tclass Traffic Class to be used for the PCI Express transaction.