ERROR Interface

Detailed Description

Interface for the ERROR event handling.

Defines the API and data structures for the ERROR event handling implementation of the ERROR interface.

Summary

The ERROR API provides an interface for error event handling.

Data Structures
struct	error_callback_args_t
struct	error_cfg_t
struct	error_api_t
struct	error_instance_t

Typedefs
typedef void	error_ctrl_t

Enumerations
enum	error_event_t

---

Data Structure Documentation

error_callback_args_t

struct error_callback_args_t

Callback function parameter data.

Data Fields
void const *	p_context	Placeholder for user data. Set in error_api_t::open function in error_cfg_t.
error_event_t	error_event	The event can be used to identify what error event caused the callback.
uint32_t	error_status	Error status. This value is from an error event status register that depends on each device product and error event source. A dedicated enum is defined on the instance side. Please refer to each driver implementation for details.

error_cfg_t

struct error_cfg_t

User configuration structure, used in the open function.

Data Fields
void(*	p_callback )(error_callback_args_t *p_args)
void const *	p_context
void const *	p_extend
	ERROR event hardware dependent configuration. More...

Field Documentation

p_callback

void(* error_cfg_t::p_callback) (error_callback_args_t *p_args)

Callback provided when a ERROR ISR occurs.

p_context

void const* error_cfg_t::p_context

Placeholder for user data. Passed to the user callback in error_callback_args_t.

p_extend

void const* error_cfg_t::p_extend

ERROR event hardware dependent configuration.

Pointer to ERROR peripheral specific configuration

error_api_t

struct error_api_t

ERROR API structure. ERROR functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	open )(error_ctrl_t *const p_ctrl, error_cfg_t const *const p_cfg)
fsp_err_t(*	close )(error_ctrl_t *const p_ctrl)
fsp_err_t(*	statusGet )(error_ctrl_t *const p_ctrl, uint32_t event, uint32_t *p_status)
fsp_err_t(*	statusClear )(error_ctrl_t *const p_ctrl, uint32_t event, uint32_t status)
fsp_err_t(*	callbackSet )(error_ctrl_t *const p_ctrl, void(*p_callback)(error_callback_args_t *), void const *const p_context, error_callback_args_t *const p_callback_memory)

Field Documentation

open

fsp_err_t(* error_api_t::open) (error_ctrl_t *const p_ctrl, error_cfg_t const *const p_cfg)

Initial configuration.

Parameters

[in]	p_ctrl	Pointer to control block. Must be declared by user. Elements set here.
[in]	p_cfg	Pointer to configuration structure. All elements of this structure must be set by user.

close

fsp_err_t(* error_api_t::close) (error_ctrl_t *const p_ctrl)

Disable the associated interrupts.

Parameters

[in]

p_ctrl

Control block set in error_api_t::open call.

statusGet

fsp_err_t(* error_api_t::statusGet) (error_ctrl_t *const p_ctrl, uint32_t event, uint32_t *p_status)

Get the status of error events.

Parameters

[in]	p_ctrl	Control block set in error_api_t::open call.
[in]	event	Select error event.
[out]	p_status	Collection of error status.

statusClear

fsp_err_t(* error_api_t::statusClear) (error_ctrl_t *const p_ctrl, uint32_t event, uint32_t status)

Clear the status of error events.

Parameters

[in]	p_ctrl	Control block set in error_api_t::open call.
[in]	event	Select error event.
[in]	status	Status information to be cleared.

callbackSet

fsp_err_t(* error_api_t::callbackSet) (error_ctrl_t *const p_ctrl, void(*p_callback)(error_callback_args_t *), void const *const p_context, error_callback_args_t *const p_callback_memory)

Specify callback function and optional context pointer and working memory pointer.

Parameters

[in]	p_ctrl	Control block set in error_api_t::open call.
[in]	p_callback	Callback function to register
[in]	p_context	Pointer to send to callback function
[in]	p_working_memory	Pointer to volatile memory where callback structure can be allocated. Callback arguments allocated here are only valid during the callback.

error_instance_t

struct error_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
error_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
error_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
error_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

error_ctrl_t

typedef void error_ctrl_t

ERROR control block. Allocate an instance specific control block to pass into the ERROR API calls.

Enumeration Type Documentation

error_event_t

enum error_event_t

Error event source.

Enumerator
ERROR_EVENT_CPU0	Error event from CPU0.
ERROR_EVENT_CPU1	Error event from CPU1.
ERROR_EVENT_PERIPHERAL_0	Error event from Peripheral 0.
ERROR_EVENT_PERIPHERAL_1	Error event from Peripheral 1.
ERROR_EVENT_CPU0	Error event from CR520.
ERROR_EVENT_CPU1	Error event from CR521.
ERROR_EVENT_CA55	Error event from CA55.
ERROR_EVENT_PERIPHERAL_0	Error event from Peripheral 0.
ERROR_EVENT_PERIPHERAL_1	Error event from Peripheral 1.
ERROR_EVENT_PERIPHERAL_2	Error event from Peripheral 2.
ERROR_EVENT_DSMIF_0	Error event from DSMIF 0.
ERROR_EVENT_DSMIF_1	Error event from DSMIF 1.
ERROR_EVENT_DSMIF_2	Error event from DSMIF 2.
ERROR_EVENT_DSMIF_3	Error event from DSMIF 3.
ERROR_EVENT_DSMIF_4	Error event from DSMIF 4.
ERROR_EVENT_DSMIF_5	Error event from DSMIF 5.
ERROR_EVENT_DSMIF_6	Error event from DSMIF 6.
ERROR_EVENT_DSMIF_7	Error event from DSMIF 7.
ERROR_EVENT_DSMIF_8	Error event from DSMIF 8.
ERROR_EVENT_DSMIF_9	Error event from DSMIF 9.
ERROR_EVENT_DSMIF_10	Error event from DSMIF 10.
ERROR_EVENT_DSMIF_11	Error event from DSMIF 11.
ERROR_EVENT_ENCIF_0	Error event from ENCIF 0.
ERROR_EVENT_ENCIF_1	Error event from ENCIF 1.
ERROR_EVENT_ENCIF_2	Error event from ENCIF 2.
ERROR_EVENT_ENCIF_3	Error event from ENCIF 3.
ERROR_EVENT_ENCIF_4	Error event from ENCIF 4.
ERROR_EVENT_CPU0	Error event from CPU0.
ERROR_EVENT_PERIPHERAL_0	Error event from Peripheral 0.
ERROR_EVENT_PERIPHERAL_1	Error event from Peripheral 1.
ERROR_EVENT_PERIPHERAL_2	Error event from Peripheral 2.
ERROR_EVENT_PERIPHERAL_3	Error event from Peripheral 3.