File umsg.h¶

FileList > docs > sw > include > opae > umsg.h

FPGA UMsg API.

#include <opae/types.h>

Public Functions¶

Type	Name
fpga_result	fpgaGetNumUmsg (fpga_handle handle, uint64_t * value) Get number of Umsgs.
fpga_result	fpgaGetUmsgPtr (fpga_handle handle, uint64_t ** umsg_ptr) Access UMsg memory directly.
fpga_result	fpgaSetUmsgAttributes (fpga_handle handle, uint64_t value) Sets Umsg hint.
fpga_result	fpgaTriggerUmsg (fpga_handle handle, uint64_t value) Trigger Umsg.

Public Functions Documentation¶

function fpgaGetNumUmsg¶

Get number of Umsgs.

fpga_result fpgaGetNumUmsg (
    fpga_handle handle,
    uint64_t * value
)

Retuns number of umsg supported by AFU.

Parameters:

handle Handle to previously opened accelerator resource
value Returns number of UMsgs

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if input parameter combination is not valid. FPGA_EXCEPTION if input parameter fpga handle is not valid.

function fpgaGetUmsgPtr¶

Access UMsg memory directly.

fpga_result fpgaGetUmsgPtr (
    fpga_handle handle,
    uint64_t ** umsg_ptr
)

This function will return a pointer to the memory allocated for low latency accelerator notifications (UMsgs).

Parameters:

handle Handle to previously opened accelerator resource
umsg_ptr Pointer to memory where a pointer to the virtual address space will be returned

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if input parameter combination is not valid. FPGA_EXCEPTION if input parameter fpga handle is not valid. FPGA_NO_MEMORY if memory allocation fails or system doesn't configure huge pages.

function fpgaSetUmsgAttributes¶

Sets Umsg hint.

fpga_result fpgaSetUmsgAttributes (
    fpga_handle handle,
    uint64_t value
)

Writes usmg hint bit.

Parameters:

handle Handle to previously opened accelerator resource
value Value to use for UMsg hint, Umsg hit is N wide bitvector where N = number of Umsgs.

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if input parameter combination is not valid. FPGA_EXCEPTION if input parameter fpga handle is not valid.

function fpgaTriggerUmsg¶

Trigger Umsg.

fpga_result fpgaTriggerUmsg (
    fpga_handle handle,
    uint64_t value
)

Writes a 64-bit value to trigger low-latency accelerator notification mechanism (UMsgs).

Parameters:

handle Handle to previously opened accelerator resource
value Value to use for UMsg

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if input parameter combination is not valid. FPGA_EXCEPTION if input parameter fpga handle is not valid.

The documentation for this class was generated from the following file docs/sw/include/opae/umsg.h