Skip to main content
Header: ar_util/api/ar_util_err_detection.h

Functions

ar_err_det_init_ctxt

Initializes one error detection context. Multiple error detection contexts are useful in multi-master DSP scenarios, so that a fatal error on one master does not require the other to restart. The error detection context stores some persistent data which is used in error analysis
Parameters
uint32_t
the master proc to initialize context for
void *
data to return when this master proc needs restart
Returns AR_EOK : on success AR_E<other error> : on failure

ar_err_det_destroy_ctxt

Destroys one error detection context. Multiple error detection contexts are useful in multi-master SPF scenarios, so that a fatal error on one master does not require the other to restart
Parameters
uint32_t
the master proc to destroy context for
Returns AR_EOK : on success AR_E<other error> : on failure

ar_err_det_reset_ctxt

Reset state variables for an error detection context. After SSR or PDR we must reset state variables in a context, like time since last restart or number of timeouts logged. This API will not reset the client data stored on context init.
Parameters
uint32_t
the master proc ID to reset the context for
Returns AR_EOK : on success AR_E<other error> : on failure

ar_err_det_detect_spf_error

Determines whether SPF is in an unrecoverable state. Multiple error detection contexts are useful in multi-master DSP scenarios, so that a fatal error on one master does not require the other to restart We identify them by the proc_id. \dependencies None
Parameters
uint32_t
the master proc to use for error analysis
int32_t
the error code returned by SPF
uint32_t
the opcode for which the error code was returned
bool_t *
true when serious error requiring restart is detected. false otherwise
void **
data to return when this master proc needs restart.
Returns AR_EOK : on successful error analysis, meaning do_restart is valid AR_E<other error> : otherwise, meaning do_restart should be ignored