Error Handler Config

Declares configurations for the Error Handler. More...

Files
file	error_handler_config.c
	Defines and initializes configurations for the Error Handler.

Macros
#define	NOTIFICATION_LOG_SIZE   5U
	Configures the maximum number of Error IDs allowed in the Notification Error Log.

Variables
const errCrit_t	errorIdCritLut [ERRID_MAX]
	Configures the criticality of all Error IDs for handling in EH_HandleError.
const errCallback_t	nonCriticalErrorCallback = &EH_NonCriticalErrorExampleCallback
	Configures the callback function used for 'NON_CRITICAL' Error IDs in EH_HandleError.
const errCallback_t	notificationErrorCallback = &EH_NotificationErrorExampleCallback
	Configures the callback function used for 'NOTIFICATION' Error IDs in EH_ProcessNotificationLog.
const errCrit_t	errorIdCritLut [ERRID_MAX]
	Configures the criticality of all Error IDs for handling in EH_HandleError.
const errCallback_t	nonCriticalErrorCallback
	Configures the callback function used for 'NON_CRITICAL' Error IDs in EH_HandleError.
const errCallback_t	notificationErrorCallback
	Configures the callback function used for 'NOTIFICATION' Error IDs in EH_ProcessNotificationLog.

Detailed Description

Declares configurations for the Error Handler.

Version

1.0.0-alpha.1

This file declares the external configuration constants used by the Error Handler. These constants are defined and initialized in error_handler_config.c to ensure a single instance across all translation units using the configuration.

Copyright

© 2025 Microchip Technology Inc. and its subsidiaries.

Subject to your compliance with these terms, you may use Microchip software and any derivatives exclusively with Microchip products. It is your responsibility to comply with third party license terms applicable to your use of third party software (including open source software) that may accompany Microchip software.

THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.

Macro Definition Documentation

NOTIFICATION_LOG_SIZE

#define NOTIFICATION_LOG_SIZE   5U

Configures the maximum number of Error IDs allowed in the Notification Error Log.

This macro limits the how many errId_t can be added to the Notification Error Log before being processed by EH_ProcessNotificationLog. Any Error IDs pushed to the log are discarded by EH_PushNotificationLog when the log is full. It is recommended to process the log often rather than having a large log.

Valid range is between 1 and UINT8_MAX.

Definition at line 90 of file error_handler_config.h.

Variable Documentation

errorIdCritLut [1/2]

const errCrit_t errorIdCritLut[ERRID_MAX]

Initial value:

= {
    [ERRID_NONE]              = IGNORE,
    [ERRID_ERRFLAG_VAL]       = NOTIFICATION,
    [ERRID_ERRID_VAL]         = NOTIFICATION,
    [ERRID_SAFE_IO]           = NOTIFICATION,
    [ERRID_FORCE_FLOAT]       = NOTIFICATION,
    [ERRID_SWDT_RESET_VAL]    = NOTIFICATION,
    [ERRID_WWDT_TIMEOUT_VAL]  = NOTIFICATION,
    [ERRID_GPR_VALS]          = NOTIFICATION,
    [ERRID_GPR_FLAGS]         = NOTIFICATION,
    [ERRID_INT_DISABLED]      = NOTIFICATION,
    [ERRID_BOD_VLM]           = NOTIFICATION,
    [ERRID_BAD_IRQ]           = NOTIFICATION,
    [ERRID_NMI]               = NOTIFICATION,
    [ERRID_NMI_UNKNOWN]       = NOTIFICATION,
    [ERRID_CRC_FLASH]         = NOTIFICATION,
    [ERRID_INIT_WATCHDOGS]    = NOTIFICATION,
    [ERRID_INIT_CLOCKS]       = NOTIFICATION,
    [ERRID_INIT_ERRCTRL]      = NOTIFICATION,
    [ERRID_INIT_INTERRUPTS]   = NOTIFICATION,
    [ERRID_INIT_POWER]        = NOTIFICATION,
    [ERRID_INIT_MEMORIES]     = NOTIFICATION,
    [ERRID_VREGFAIL_CH]       = NOTIFICATION,
    [ERRID_VREGFAIL_VOV]      = NOTIFICATION,
    [ERRID_VREGFAIL_VUV]      = NOTIFICATION,
    [ERRID_BUSERR_CH]         = NOTIFICATION,
    [ERRID_BUSERR_BUSERR]     = NOTIFICATION,
    [ERRID_RAM_PARITY]        = NOTIFICATION,
    [ERRID_NVM_PARITY]        = NOTIFICATION,
    [ERRID_BUSERR_PARITYD]    = NOTIFICATION,
    [ERRID_RAM2_CH]           = NOTIFICATION,
    [ERRID_RAM2_ECC2]         = NOTIFICATION,
    [ERRID_RAM2_COMP]         = NOTIFICATION,
    [ERRID_FLASH2_CH]         = NOTIFICATION,
    [ERRID_FLASH2_ECC2]       = NOTIFICATION,
    [ERRID_FLASH2_COMP]       = NOTIFICATION,
    [ERRID_OPC_CH]            = NOTIFICATION,
    [ERRID_OPC_OPC]           = NOTIFICATION,
    [ERRID_OPC_PARITYI]       = NOTIFICATION,
    [ERRID_SPLIM_CH]          = NOTIFICATION,
    [ERRID_RAM1_CH]           = NOTIFICATION,
    [ERRID_FLASH1_CH]         = NOTIFICATION,
    [ERRID_VREGWARN_CH]       = NOTIFICATION,
    [ERRID_VREGWARN_VDENTER]  = NOTIFICATION,
    [ERRID_VREGWARN_VDEXIT]   = NOTIFICATION,
    [ERRID_VREGWARN_VERR]     = NOTIFICATION,
    [ERRID_VREGWARN_VSLP]     = NOTIFICATION,
    [ERRID_VREGWARN_VDIS]     = NOTIFICATION,
    [ERRID_VREGWARN_SERR]     = NOTIFICATION,
    [ERRID_CFD0_CH]           = NOTIFICATION,
    [ERRID_CFD1_CH]           = NOTIFICATION,
    [ERRID_CFM0_CH]           = NOTIFICATION,
    [ERRID_CFM1_CH]           = NOTIFICATION,
    [ERRID_SWDT_CH]           = NOTIFICATION,
    [ERRID_SWDT_BADPC]        = NOTIFICATION,
    [ERRID_SWDT_BADC]         = NOTIFICATION,
    [ERRID_SWDT_UC]           = NOTIFICATION,
    [ERRID_SWDT_EXP]          = NOTIFICATION,
    [ERRID_EEPROM_CH]         = NOTIFICATION,
    [ERRID_EEPROM_ECC1]       = NOTIFICATION,
    [ERRID_EEPROM_ECC2]       = NOTIFICATION,
    [ERRID_EVSYS0_CH]         = NOTIFICATION,
    [ERRID_EVSYS0_CLEAR]      = NOTIFICATION,
    [ERRID_EVSYS1_CH]         = NOTIFICATION,
    [ERRID_EVSYS1_CLEAR]      = NOTIFICATION,
    [ERRID_DIAG_CPU_COMP]     = NOTIFICATION,
    [ERRID_DIAG_SWDT_EXPIRE]  = NOTIFICATION,
    [ERRID_DIAG_SWDT_COUNT]   = NOTIFICATION,
    [ERRID_DIAG_WDT_EXPIRE]   = NOTIFICATION,
    [ERRID_DIAG_WDT_COUNT]    = NOTIFICATION,
    [ERRID_DIAG_PARITY_NVM]   = NOTIFICATION,
    [ERRID_DIAG_PARITY_RAM]   = NOTIFICATION,
    [ERRID_DIAG_CFD0]         = NOTIFICATION,
    [ERRID_DIAG_CFD1]         = NOTIFICATION,
    [ERRID_DIAG_CFM0]         = NOTIFICATION,
    [ERRID_DIAG_CFM1]         = NOTIFICATION,
    [ERRID_DIAG_ECC_RAM]      = NOTIFICATION,
    [ERRID_DIAG_ECC_FLASH]    = NOTIFICATION,
    [ERRID_DIAG_ECC_EEPROM]   = NOTIFICATION,
    [ERRID_DIAG_VMON_OVER]    = NOTIFICATION,
    [ERRID_DIAG_VMON_UNDER]   = NOTIFICATION,
    [ERRID_DIAG_ERRCH_SPLIM]  = NOTIFICATION,
    [ERRID_DIAG_ERRCH_CFD0]   = NOTIFICATION,
    [ERRID_DIAG_ERRCH_CFD1]   = NOTIFICATION,
    [ERRID_DIAG_ERRCH_CFM0]   = NOTIFICATION,
    [ERRID_DIAG_ERRCH_CFM1]   = NOTIFICATION,
    [ERRID_DIAG_ERRCH_EEPROM] = NOTIFICATION,
    [ERRID_DIAG_ERRCH_EVSYS0] = NOTIFICATION,
    [ERRID_DIAG_ERRCH_EVSYS1] = NOTIFICATION,
}

Configures the criticality of all Error IDs for handling in EH_HandleError.

This array is used as a Look-Up Table (LUT) for the Error Handler to identify the criticality for all defined Error IDs. Each index in the LUT corresponds to an errId_t value. This LUT, together with the errId_t enum, facilitates a centralized error handling system, allowing for expansion by adding new Error IDs as required by the application. The array is defined and configured in error_handler_config.c.

Warning

Ensure that ERRID_MAX is set to the highest enumerator value in errId_t to prevent out-of-bounds access when indexing the array.

Note

This array serves as the single source of truth for the criticality of both hardware and software flags. See errId_t for more information.

Warning

It is assumed that each Error ID is set to a criticality suitable to meet application requirements. All Error IDs are set to NOTIFICATION by default to enhance the development and debugging experience.

Definition at line 37 of file error_handler_config.c.

errorIdCritLut [2/2]

const errCrit_t errorIdCritLut[ERRID_MAX]

extern

Configures the criticality of all Error IDs for handling in EH_HandleError.

This array is used as a Look-Up Table (LUT) for the Error Handler to identify the criticality for all defined Error IDs. Each index in the LUT corresponds to an errId_t value. This LUT, together with the errId_t enum, facilitates a centralized error handling system, allowing for expansion by adding new Error IDs as required by the application. The array is defined and configured in error_handler_config.c.

Warning

Ensure that ERRID_MAX is set to the highest enumerator value in errId_t to prevent out-of-bounds access when indexing the array.

Note

This array serves as the single source of truth for the criticality of both hardware and software flags. See errId_t for more information.

Warning

It is assumed that each Error ID is set to a criticality suitable to meet application requirements. All Error IDs are set to NOTIFICATION by default to enhance the development and debugging experience.

Definition at line 37 of file error_handler_config.c.

nonCriticalErrorCallback [1/2]

const errCallback_t nonCriticalErrorCallback = &EH_NonCriticalErrorExampleCallback

Configures the callback function used for 'NON_CRITICAL' Error IDs in EH_HandleError.

This callback setting is configured in the error_handler_config.c file and should be set to point to a function with a errCallback_t type signature in order to implement application-specific error handling for any Error ID reported with NON_CRITICAL criticality.

Definition at line 132 of file error_handler_config.c.

nonCriticalErrorCallback [2/2]

const errCallback_t nonCriticalErrorCallback

extern

Configures the callback function used for 'NON_CRITICAL' Error IDs in EH_HandleError.

This callback setting is configured in the error_handler_config.c file and should be set to point to a function with a errCallback_t type signature in order to implement application-specific error handling for any Error ID reported with NON_CRITICAL criticality.

Definition at line 132 of file error_handler_config.c.

notificationErrorCallback [1/2]

const errCallback_t notificationErrorCallback = &EH_NotificationErrorExampleCallback

Configures the callback function used for 'NOTIFICATION' Error IDs in EH_ProcessNotificationLog.

This callback setting is configured in the error_handler_config.c file and should be set to point to a function with a errCallback_t type signature in order to implement application-specific error handling for any Error ID reported with NOTIFICATION criticality.

Definition at line 138 of file error_handler_config.c.

notificationErrorCallback [2/2]

const errCallback_t notificationErrorCallback

extern

Configures the callback function used for 'NOTIFICATION' Error IDs in EH_ProcessNotificationLog.

This callback setting is configured in the error_handler_config.c file and should be set to point to a function with a errCallback_t type signature in order to implement application-specific error handling for any Error ID reported with NOTIFICATION criticality.

Definition at line 138 of file error_handler_config.c.