Contains API prototypes for the ERRCTRL (Error Controller) driver. More...

Files
file	driver_errctrl.c
	Implements APIs for the ERRCTRL (Error Controller) driver.

Functions
uint8_t	ERRCTRL_ReadControlA (void)
	Reads the CTRLA register value.
void	ERRCTRL_SetControlA (uint8_t bitmask)
	Sets specific bits in the CTRLA register.
void	ERRCTRL_ClearControlA (uint8_t bitmask)
	Clears specific bits in the CTRLA register.
void	ERRCTRL_ModifyControlA (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the CTRLA register.
uint8_t	ERRCTRL_ReadStatusA (void)
	Reads the STATUSA register value.
void	ERRCTRL_WriteTimeoutValue (uint8_t value)
	Overwrites the TIMEOUT register value.
uint8_t	ERRCTRL_ReadResetCause (void)
	Reads the CAUSE register value.
uint8_t	ERRCTRL_ReadConfigVregfail (void)
	Reads the ESCVREGFAIL register value.
void	ERRCTRL_WriteConfigVregfail (uint8_t value)
	Overwrites the ESCVREGFAIL register value.
uint8_t	ERRCTRL_ReadConfigBuserr (void)
	Reads the ESCBUSERR register value.
void	ERRCTRL_WriteConfigBuserr (uint8_t value)
	Overwrites the ESCBUSERR register value.
uint8_t	ERRCTRL_ReadConfigRam2 (void)
	Reads the ESCRAM2 register value.
void	ERRCTRL_WriteConfigRam2 (uint8_t value)
	Overwrites the ESCRAM2 register value.
uint8_t	ERRCTRL_ReadConfigFlash2 (void)
	Reads the ESCFLASH2 register value.
void	ERRCTRL_WriteConfigFlash2 (uint8_t value)
	Overwrites the ESCFLASH2 register value.
uint8_t	ERRCTRL_ReadConfigOpc (void)
	Reads the ESCOPC register value.
void	ERRCTRL_WriteConfigOpc (uint8_t value)
	Overwrites the ESCOPC register value.
uint8_t	ERRCTRL_ReadConfigSplim (void)
	Reads the ESCSPLIM register value.
void	ERRCTRL_WriteConfigSplim (uint8_t value)
	Overwrites the ESCSPLIM register value.
uint8_t	ERRCTRL_ReadConfigRam1 (void)
	Reads the ESCRAM1 register value.
void	ERRCTRL_WriteConfigRam1 (uint8_t value)
	Overwrites the ESCRAM1 register value.
uint8_t	ERRCTRL_ReadConfigFlash1 (void)
	Reads the ESCFLASH1 register value.
void	ERRCTRL_WriteConfigFlash1 (uint8_t value)
	Overwrites the ESCFLASH1 register value.
uint8_t	ERRCTRL_ReadConfigVregwarn (void)
	Reads the ESCVREGWARN register value.
void	ERRCTRL_WriteConfigVregwarn (uint8_t value)
	Overwrites the ESCVREGWARN register value.
uint8_t	ERRCTRL_ReadConfigCfd0 (void)
	Reads the ESCCFD0 register value.
void	ERRCTRL_WriteConfigCfd0 (uint8_t value)
	Overwrites the ESCCFD0 register value.
uint8_t	ERRCTRL_ReadConfigCfd1 (void)
	Reads the ESCCFD1 register value.
void	ERRCTRL_WriteConfigCfd1 (uint8_t value)
	Overwrites the ESCCFD1 register value.
uint8_t	ERRCTRL_ReadConfigCfm0 (void)
	Reads the ESCCFM0 register value.
void	ERRCTRL_WriteConfigCfm0 (uint8_t value)
	Overwrites the ESCCFM0 register value.
uint8_t	ERRCTRL_ReadConfigCfm1 (void)
	Reads the ESCCFM1 register value.
void	ERRCTRL_WriteConfigCfm1 (uint8_t value)
	Overwrites the ESCCFM1 register value.
uint8_t	ERRCTRL_ReadConfigSwdt (void)
	Reads the ESCSWDT register value.
void	ERRCTRL_WriteConfigSwdt (uint8_t value)
	Overwrites the ESCSWDT register value.
uint8_t	ERRCTRL_ReadConfigEeprom (void)
	Reads the ESCEEPROM register value.
void	ERRCTRL_WriteConfigEeprom (uint8_t value)
	Overwrites the ESCEEPROM register value.
uint8_t	ERRCTRL_ReadConfigEvsys0 (void)
	Reads the ESCEVSYS0 register value.
void	ERRCTRL_WriteConfigEvsys0 (uint8_t value)
	Overwrites the ESCEVSYS0 register value.
uint8_t	ERRCTRL_ReadConfigEvsys1 (void)
	Reads the ESCEVSYS1 register value.
void	ERRCTRL_WriteConfigEvsys1 (uint8_t value)
	Overwrites the ESCEVSYS1 register value.
uint32_t	ERRCTRL_ReadChannelStatus (void)
	Reads the ESF register value.
void	ERRCTRL_WriteChannelStatus (uint32_t value)
	Overwrites the ESF register value.
void	ERRCTRL_WriteChannelTest (uint32_t value)
	Overwrites the ESFTEST register value.

Detailed Description

Contains API prototypes for the ERRCTRL (Error Controller) driver.

Version: 1.0.0-alpha.1

These APIs provide direct register access and have no functional knowledge of the register interface. No input or output validation is performed in the drivers. It is the responsibility of the calling function to use them correctly according to the register interface specification.

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.

UML Class Diagrams

Function Documentation

◆ ERRCTRL_ClearControlA()

void ERRCTRL_ClearControlA ( uint8_t bitmask )

Clears specific bits in the CTRLA register.

Parameters

bitmask Specifies which bits to clear.

Definition at line 45 of file driver_errctrl.c.

◆ ERRCTRL_ModifyControlA()

void ERRCTRL_ModifyControlA	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the CTRLA register.

Parameters

groupMask	Specifies which bit field values to modify (clear and write).
groupConfig	Specifies the bit pattern to write to the specified bit fields.

Definition at line 52 of file driver_errctrl.c.

◆ ERRCTRL_ReadChannelStatus()

uint32_t ERRCTRL_ReadChannelStatus ( void )

Reads the ESF register value.

Returns: The read value.

Definition at line 247 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigBuserr()

uint8_t ERRCTRL_ReadConfigBuserr ( void )

Reads the ESCBUSERR register value.

Returns: The read value.

Definition at line 87 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigCfd0()

uint8_t ERRCTRL_ReadConfigCfd0 ( void )

Reads the ESCCFD0 register value.

Returns: The read value.

Definition at line 167 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigCfd1()

uint8_t ERRCTRL_ReadConfigCfd1 ( void )

Reads the ESCCFD1 register value.

Returns: The read value.

Definition at line 177 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigCfm0()

uint8_t ERRCTRL_ReadConfigCfm0 ( void )

Reads the ESCCFM0 register value.

Returns: The read value.

Definition at line 187 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigCfm1()

uint8_t ERRCTRL_ReadConfigCfm1 ( void )

Reads the ESCCFM1 register value.

Returns: The read value.

Definition at line 197 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigEeprom()

uint8_t ERRCTRL_ReadConfigEeprom ( void )

Reads the ESCEEPROM register value.

Returns: The read value.

Definition at line 217 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigEvsys0()

uint8_t ERRCTRL_ReadConfigEvsys0 ( void )

Reads the ESCEVSYS0 register value.

Returns: The read value.

Definition at line 227 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigEvsys1()

uint8_t ERRCTRL_ReadConfigEvsys1 ( void )

Reads the ESCEVSYS1 register value.

Returns: The read value.

Definition at line 237 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigFlash1()

uint8_t ERRCTRL_ReadConfigFlash1 ( void )

Reads the ESCFLASH1 register value.

Returns: The read value.

Definition at line 147 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigFlash2()

uint8_t ERRCTRL_ReadConfigFlash2 ( void )

Reads the ESCFLASH2 register value.

Returns: The read value.

Definition at line 107 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigOpc()

uint8_t ERRCTRL_ReadConfigOpc ( void )

Reads the ESCOPC register value.

Returns: The read value.

Definition at line 117 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigRam1()

uint8_t ERRCTRL_ReadConfigRam1 ( void )

Reads the ESCRAM1 register value.

Returns: The read value.

Definition at line 137 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigRam2()

uint8_t ERRCTRL_ReadConfigRam2 ( void )

Reads the ESCRAM2 register value.

Returns: The read value.

Definition at line 97 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigSplim()

uint8_t ERRCTRL_ReadConfigSplim ( void )

Reads the ESCSPLIM register value.

Returns: The read value.

Definition at line 127 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigSwdt()

uint8_t ERRCTRL_ReadConfigSwdt ( void )

Reads the ESCSWDT register value.

Returns: The read value.

Definition at line 207 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigVregfail()

uint8_t ERRCTRL_ReadConfigVregfail ( void )

Reads the ESCVREGFAIL register value.

Returns: The read value.

Definition at line 77 of file driver_errctrl.c.

◆ ERRCTRL_ReadConfigVregwarn()

uint8_t ERRCTRL_ReadConfigVregwarn ( void )

Reads the ESCVREGWARN register value.

Returns: The read value.

Definition at line 157 of file driver_errctrl.c.

◆ ERRCTRL_ReadControlA()

uint8_t ERRCTRL_ReadControlA ( void )

Reads the CTRLA register value.

Returns: The read value.

Definition at line 33 of file driver_errctrl.c.

◆ ERRCTRL_ReadResetCause()

uint8_t ERRCTRL_ReadResetCause ( void )

Reads the CAUSE register value.

Returns: The read value.

Definition at line 72 of file driver_errctrl.c.

◆ ERRCTRL_ReadStatusA()

uint8_t ERRCTRL_ReadStatusA ( void )

Reads the STATUSA register value.

Returns: The read value.

Definition at line 62 of file driver_errctrl.c.

◆ ERRCTRL_SetControlA()

void ERRCTRL_SetControlA ( uint8_t bitmask )

Sets specific bits in the CTRLA register.

Parameters

bitmask Specifies which bits to set.

Definition at line 38 of file driver_errctrl.c.