BODCTRL Driver

Contains API prototypes for the BODCTRL (Brown-out Detector Control) driver. More...

Files
file	driver_bodctrl.c
	Implements APIs for the BODCTRL (Brown-out Detector Control) driver.

Functions
void	BODCTRL_WriteVlmControlA (uint8_t value)
	Overwrites the VLMCTRLA register value.
void	BODCTRL_SetIntControl (uint8_t bitmask)
	Sets specific bits in the INTCTRL register.
void	BODCTRL_ModifyIntControl (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the INTCTRL register.
uint8_t	BODCTRL_ReadIntFlags (void)
	Reads the INTFLAGS register value.
void	BODCTRL_WriteIntFlags (uint8_t value)
	Overwrites the INTFLAGS register value.

Detailed Description

Contains API prototypes for the BODCTRL (Brown-out Detector Control) 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

BODCTRL_ModifyIntControl()

void BODCTRL_ModifyIntControl	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the INTCTRL 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 39 of file driver_bodctrl.c.

BODCTRL_ReadIntFlags()

uint8_t BODCTRL_ReadIntFlags

(

void

)

Reads the INTFLAGS register value.

Returns

The read value.

Definition at line 49 of file driver_bodctrl.c.

BODCTRL_SetIntControl()

void BODCTRL_SetIntControl

(

uint8_t

bitmask

)

Sets specific bits in the INTCTRL register.

Parameters

bitmask

Specifies which bits to set.

Definition at line 34 of file driver_bodctrl.c.

BODCTRL_WriteIntFlags()

void BODCTRL_WriteIntFlags

(

uint8_t

value

)

Overwrites the INTFLAGS register value.

Parameters

value

Specifies the value to write.

Definition at line 54 of file driver_bodctrl.c.

BODCTRL_WriteVlmControlA()

void BODCTRL_WriteVlmControlA

(

uint8_t

value

)

Overwrites the VLMCTRLA register value.

Parameters

value

Specifies the value to write.

Definition at line 29 of file driver_bodctrl.c.