4.5 CHPMP - Charge Pump

4.5.1 Introduction

The MPLAB® Code Configurator (MCC) Melody Charge Pump (CHPMP) Peripheral Library (PLIB) drivers generates APIs to support CHPMP-specific peripheral functionality on target MCUs.

The primary use of the charge pump is to supply a constant voltage to the gates of transistor devices contained in analog peripherals, signal and reference circuitry, and to prevent degradation of transistor performance at low operating voltages.

4.5.2 Supported Device Families


PIC16F152xx	PIC16F171xx	PIC16F180xx	PIC16F181xx

4.5.3 Required Header Files

#include "mcc_generated_files/chpmp/chpmp.h"

4.5.4 Module Documentation

4.5.4.1 Chpmp

This file contains the API prototypes for the Charge Pump (CHPMP) driver.

4.5.4.1.1 Module description

This file contains the API prototypes for the Charge Pump (CHPMP) driver.

Version: CHPMP Source Code Driver Version 1.0.0

Definitions

#define myCHPMP_Initialize CHPMP_Initialize

Defines the Custom Name for the CHPMP_Initialize API.
#define myCHPMP_Enable CHPMP_Enable

Defines the Custom Name for the CHPMP_Enable API.
#define myCHPMP_Disable CHPMP_Disable

Defines the Custom Name for the CHPMP_Disable API.
#define myCHPMP_IsVDDAboveVAuto CHPMP_IsVDDAboveVAuto

Defines the Custom Name for the CHPMP_IsVDDAboveVAuto API.
#define myCHPMP_IsReady CHPMP_IsReady

Defines the Custom Name for the CHPMP_IsReady API.

Functions

void CHPMP_Initialize (void)

Initializes the CHPMP module.
void CHPMP_Enable (void)

Enables the CHPMP module.
bool CHPMP_Disable (void)

Disables the CHPMP module. If the return value is False, turn off all analog peripherals and try again.
bool CHPMP_IsVDDAboveVAuto (void)

Returns the status of the CHPMP threshold.
bool CHPMP_IsReady (void)

Returns the status of Steady state.

4.5.4.1.2 Definition Documentation

myCHPMP_Disable

#define myCHPMP_Disable CHPMP_Disable

Defines the Custom Name for the CHPMP_Disable API.

myCHPMP_Enable

#define myCHPMP_Enable CHPMP_Enable

Defines the Custom Name for the CHPMP_Enable API.

myCHPMP_Initialize

#define myCHPMP_Initialize CHPMP_Initialize

Defines the Custom Name for the CHPMP_Initialize API.

Section: Included Files

myCHPMP_IsReady

#define myCHPMP_IsReady CHPMP_IsReady

Defines the Custom Name for the CHPMP_IsReady API.

myCHPMP_IsVDDAboveVAuto

#define myCHPMP_IsVDDAboveVAuto CHPMP_IsVDDAboveVAuto

Defines the Custom Name for the CHPMP_IsVDDAboveVAuto API.

4.5.4.1.3 Function Documentation

CHPMP_Disable()

bool CHPMP_Disable (void )

Disables the CHPMP module. If the return value is False, turn off all analog peripherals and try again.

Parameters:
None.

Return values:
True	- Charge pump is disabled
False	- Charge pump has been requested by an analog peripheral

CHPMP_Enable()

void CHPMP_Enable (void )

Enables the CHPMP module.

Parameters:
None.

Returns:
None.

CHPMP_Initialize()

void CHPMP_Initialize (void )

Initializes the CHPMP module.

Parameters:
None.

Returns:
None.

Section: Included Files

CHPMP_IsReady()

bool CHPMP_IsReady (void )

Returns the status of Steady state.

Parameters:
None.

Return values:
True	- Steady state is reached
False	- Steady state is not reached

CHPMP_IsVDDAboveVAuto()

bool CHPMP_IsVDDAboveVAuto (void )

Returns the status of the CHPMP threshold.

Parameters:
None.

Return values:
True	- VDD is above the threshold voltage(VAUTO)
False	- VDD is below the threshold voltage(VAUTO)

4.5.5 File Documentation

4.5.5.1 source/source-files/chpmp.c File Reference

This file contains the API implementations for the Charge Pump (CHPMP) driver.

#include <xc.h>
#include "../chpmp.h"

4.5.5.1.1 Functions

void CHPMP_Initialize (void)

Initializes the CHPMP module.
void CHPMP_Enable (void)

Enables the CHPMP module.
bool CHPMP_Disable (void)

Disables the CHPMP module. If the return value is False, turn off all analog peripherals and try again.
bool CHPMP_IsVDDAboveVAuto (void)

Returns the status of the CHPMP threshold.
bool CHPMP_IsReady (void)

Returns the status of Steady state.

4.5.5.1.2 Detailed Description

This file contains the API implementations for the Charge Pump (CHPMP) driver.

CHPMP Generated Driver File

Version: CHPMP Source Code Driver Version 1.0.0 CHPMP Melody Peripheral Library (PLIB) version 1.0.0

4.5.5.2 source/source-files/chpmp.h File Reference

#include <stdbool.h>
#include <stdint.h>

4.5.5.2.1 Functions

void CHPMP_Initialize (void)

Initializes the CHPMP module.
void CHPMP_Enable (void)

Enables the CHPMP module.
bool CHPMP_Disable (void)

Disables the CHPMP module. If the return value is False, turn off all analog peripherals and try again.
bool CHPMP_IsVDDAboveVAuto (void)

Returns the status of the CHPMP threshold.
bool CHPMP_IsReady (void)

Returns the status of Steady state.

4.5.5.2.2 Macros

#define myCHPMP_Initialize CHPMP_Initialize

Defines the Custom Name for the CHPMP_Initialize API.
#define myCHPMP_Enable CHPMP_Enable

Defines the Custom Name for the CHPMP_Enable API.
#define myCHPMP_Disable CHPMP_Disable

Defines the Custom Name for the CHPMP_Disable API.
#define myCHPMP_IsVDDAboveVAuto CHPMP_IsVDDAboveVAuto

Defines the Custom Name for the CHPMP_IsVDDAboveVAuto API.
#define myCHPMP_IsReady CHPMP_IsReady

Defines the Custom Name for the CHPMP_IsReady API.

4.5.5.2.3 Detailed Description

CHPMP Generated Driver API Header File