GPR Driver

Contains API prototypes for the GPR (General Purpose Registers) driver. More...

Files
file	driver_gpr.c
	Implements APIs for the GPR (General Purpose Registers) driver.

Functions
uint8_t	GPR_ReadRegister0 (void)
	Reads the GPR0 register value.
void	GPR_WriteRegister0 (uint8_t value)
	Overwrites the GPR0 register value.
uint8_t	GPR_ReadRegister1 (void)
	Reads the GPR1 register value.
void	GPR_WriteRegister1 (uint8_t value)
	Overwrites the GPR1 register value.
void	GPR_ModifyRegister1 (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the GPR1 register.
uint8_t	GPR_ReadRegister2 (void)
	Reads the GPR2 register value.
void	GPR_WriteRegister2 (uint8_t value)
	Overwrites the GPR2 register value.
void	GPR_SetRegister2 (uint8_t bitmask)
	Sets specific bits in the GPR2 register.
void	GPR_ClearRegister2 (uint8_t bitmask)
	Clears specific bits in the GPR2 register.
void	GPR_ModifyRegister2 (uint8_t groupMask, uint8_t groupConfig)
	Modifies specific bit field(s) in the GPR2 register.
uint8_t	GPR_ReadRegister3 (void)
	Reads the GPR3 register value.
void	GPR_WriteRegister3 (uint8_t value)
	Overwrites the GPR3 register value.
void	GPR_SetRegister3 (uint8_t bitmask)
	Sets specific bits in the GPR3 register.
void	GPR_ClearRegister3 (uint8_t bitmask)
	Clears specific bits in the GPR3 register.

Detailed Description

Contains API prototypes for the GPR (General Purpose Registers) 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

GPR_ClearRegister2()

void GPR_ClearRegister2

(

uint8_t

bitmask

)

Clears specific bits in the GPR2 register.

Parameters

bitmask

Specifies which bits to clear.

Definition at line 77 of file driver_gpr.c.

GPR_ClearRegister3()

void GPR_ClearRegister3

(

uint8_t

bitmask

)

Clears specific bits in the GPR3 register.

Parameters

bitmask

Specifies which bits to clear.

Definition at line 107 of file driver_gpr.c.

GPR_ModifyRegister1()

void GPR_ModifyRegister1	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the GPR1 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_gpr.c.

GPR_ModifyRegister2()

void GPR_ModifyRegister2	(	uint8_t	groupMask,
		uint8_t	groupConfig )

Modifies specific bit field(s) in the GPR2 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 82 of file driver_gpr.c.

GPR_ReadRegister0()

uint8_t GPR_ReadRegister0

(

void

)

Reads the GPR0 register value.

Returns

The read value.

Definition at line 32 of file driver_gpr.c.

GPR_ReadRegister1()

uint8_t GPR_ReadRegister1

(

void

)

Reads the GPR1 register value.

Returns

The read value.

Definition at line 42 of file driver_gpr.c.

GPR_ReadRegister2()

uint8_t GPR_ReadRegister2

(

void

)

Reads the GPR2 register value.

Returns

The read value.

Definition at line 62 of file driver_gpr.c.

GPR_ReadRegister3()

uint8_t GPR_ReadRegister3

(

void

)

Reads the GPR3 register value.

Returns

The read value.

Definition at line 92 of file driver_gpr.c.

GPR_SetRegister2()

void GPR_SetRegister2

(

uint8_t

bitmask

)

Sets specific bits in the GPR2 register.

Parameters

bitmask

Specifies which bits to set.

Definition at line 72 of file driver_gpr.c.

GPR_SetRegister3()

void GPR_SetRegister3

(

uint8_t

bitmask

)

Sets specific bits in the GPR3 register.

Parameters

bitmask

Specifies which bits to set.

Definition at line 102 of file driver_gpr.c.

GPR_WriteRegister0()

void GPR_WriteRegister0

(

uint8_t

value

)

Overwrites the GPR0 register value.

Parameters

value

Specifies the value to write.

Definition at line 37 of file driver_gpr.c.

GPR_WriteRegister1()

void GPR_WriteRegister1

(

uint8_t

value

)

Overwrites the GPR1 register value.

Parameters

value

Specifies the value to write.

Definition at line 47 of file driver_gpr.c.

GPR_WriteRegister2()

void GPR_WriteRegister2

(

uint8_t

value

)

Overwrites the GPR2 register value.

Parameters

value

Specifies the value to write.

Definition at line 67 of file driver_gpr.c.

GPR_WriteRegister3()

void GPR_WriteRegister3

(

uint8_t

value

)

Overwrites the GPR3 register value.

Parameters

value

Specifies the value to write.

Definition at line 97 of file driver_gpr.c.