File userclk.h

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

Go to the source code of this file.

Functions for setting and get afu user clock.

• #include <opae/types.h>

Public Functions

Type	Name
fpga_result	fpgaGetUserClock (fpga_handle handle, uint64_t * high_clk, uint64_t * low_clk, int flags) Get afu user clock high and low.
fpga_result	fpgaSetUserClock (fpga_handle handle, uint64_t high_clk, uint64_t low_clk, int flags) set afu user clock high and low

Public Functions Documentation

function fpgaGetUserClock

Get afu user clock high and low.

fpga_result fpgaGetUserClock (
    fpga_handle handle,
    uint64_t * high_clk,
    uint64_t * low_clk,
    int flags
) 

Parameters:

• handle Handle to previously opened accelerator resource.
• high_clk AFU High user clock frequency in MHz.
• low_clk AFU Low user clock frequency in MHz.
• flags Flags Reserved.

.*

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if invalid parameters were provided, or if the parameter combination is not valid. FPGA_EXCEPTION if an internal exception occurred while trying to access the handle.

function fpgaSetUserClock

set afu user clock high and low

fpga_result fpgaSetUserClock (
    fpga_handle handle,
    uint64_t high_clk,
    uint64_t low_clk,
    int flags
) 

Parameters:

• handle Handle to previously opened accelerator resource.
• high_clk AFU High user clock frequency in MHz.
• low_clk AFU Low user clock frequency in MHz.
• flags Flags Reserved.

.*

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if invalid parameters were provided, or if the parameter combination is not valid. FPGA_EXCEPTION if an internal exception occurred while trying to access the handle.

---

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