File error.h¶

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

Functions for reading and clearing errors in resources. More...

#include <opae/types.h>

Public Functions¶

Type	Name
fpga_result	fpgaClearAllErrors (fpga_token token) Clear all error registers of a particular resource.
fpga_result	fpgaClearError (fpga_token token, uint32_t error_num) Clear error register.
fpga_result	fpgaGetErrorInfo (fpga_token token, uint32_t error_num, struct fpga_error_info * error_info) Get information about a particular error register.
fpga_result	fpgaReadError (fpga_token token, uint32_t error_num, uint64_t * value) Read error value.

Detailed Description¶

Many FPGA resources have the ability to track the occurrence of errors. This file provides functions to retrieve information about errors within resources.

Public Functions Documentation¶

function fpgaClearAllErrors¶

Clear all error registers of a particular resource.

fpga_result fpgaClearAllErrors (
    fpga_token token
)

This function will clear all error registers of the resource referenced by token, observing the necessary order of clearing errors, if any.

Parameters:

token Token to accelerator resource to query

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if any of the supplied parameters is invalid. FPGA_EXCEPTION if an internal exception occurred while trying to access the token, and FPGA_BUSY if error could not be cleared.

function fpgaClearError¶

Clear error register.

fpga_result fpgaClearError (
    fpga_token token,
    uint32_t error_num
)

This function will clear the error register error_num of the resource referenced by token.

Parameters:

token Token to accelerator resource to query
error_num Number of error register to clear

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if any of the supplied parameters is invalid. FPGA_EXCEPTION if an internal exception occurred while trying to access the token, and FPGA_BUSY if error could not be cleared.

function fpgaGetErrorInfo¶

Get information about a particular error register.

fpga_result fpgaGetErrorInfo (
    fpga_token token,
    uint32_t error_num,
    struct fpga_error_info * error_info
)

This function will populate a fpga_error_info struct with information about error number error_num of the resource referenced by token.

Parameters:

token Token to accelerator resource to query
error_num Error register to retrieve information about
error_info Pointer to memory to store information into

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if any of the supplied parameters is invalid. FPGA_EXCEPTION if an internal exception occurred while trying to access the token.

function fpgaReadError¶

Read error value.

fpga_result fpgaReadError (
    fpga_token token,
    uint32_t error_num,
    uint64_t * value
)

This function will read the value of error register error_num of the resource referenced by token into the memory location pointed to by value.

Parameters:

token Token to accelerator resource to query
error_num Number of error register to read
value Pointer to memory to store error value into (64 bit)

Returns:

FPGA_OK on success. FPGA_INVALID_PARAM if any of the supplied parameters is invalid. FPGA_EXCEPTION if an internal exception occurred while trying to access the token.

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