Analog Devices EV-COG-AD3029LZ Board Support Package Documentation
Release 3.1.0
|
Driver for the ADP5300 Voltage Regulator. More...
Macros | |
#define | ADI_VOUTOK_IRQ_GROUP (ADI_GPIO_INTA_IRQ) |
Enumerations | |
enum | ADI_ADP5300_MODE { ADI_ADP5300_MODE_HYSTERESIS, ADI_ADP5300_MODE_PWM } |
ADP5300 operational modes. More... | |
enum | ADI_ADP5300_SWITCHING { ADI_ADP5300_SWITCHING_STOP, ADI_ADP5300_SWITCHING_RESUME } |
ADP5300 switching modes. More... | |
Functions | |
ADI_GPIO_RESULT | adi_adp5300_Init () |
Initialize the ADP5300. More... | |
ADI_GPIO_RESULT | adi_adp5300_SetMode (ADI_ADP5300_MODE eMode) |
Set the mode of the ADP5300. More... | |
ADI_GPIO_RESULT | adi_adp5300_SetSwitching (ADI_ADP5300_SWITCHING bState) |
Set the switching state of the ADP5300. More... | |
ADI_GPIO_RESULT | adi_adp5300_EnableVoutokInt (uint8_t bEnable) |
Enable/disable the VOUTOK interrupt. More... | |
ADI_GPIO_RESULT | adi_adp5300_ReadVoutokState (uint8_t *const pState) |
Read VOUTOK output pin. More... | |
Driver for the ADP5300 Voltage Regulator.
#define ADI_VOUTOK_IRQ_GROUP (ADI_GPIO_INTA_IRQ) |
< GPIO Group interrupt for the VOUTOK pin. Needs to be a ADI_GPIO_IRQ enumeration.
enum ADI_ADP5300_MODE |
ADP5300 operational modes.
Buck regulator operational modes. PWM mode is a low noise mode and can be used when sampling noise sensitive peripherals. Hysteresis mode is high current but saves power. This can be used during non noise sensitive operations such as being in hibernate.
Enumerator | |
---|---|
ADI_ADP5300_MODE_HYSTERESIS | Hysteresis mode. |
ADI_ADP5300_MODE_PWM | PWM mode. |
ADP5300 switching modes.
The ADP5300 includes a STOP input pin that can temporarily stop the regulator switching in hysteresis mode. When switching has stopped, a quiet system is acheived which is ideal for noise sensitive circuitry like a data conversion or data transmission.
Enumerator | |
---|---|
ADI_ADP5300_SWITCHING_STOP | Stop switching. |
ADI_ADP5300_SWITCHING_RESUME | Resume switching. |
ADI_GPIO_RESULT adi_adp5300_EnableVoutokInt | ( | uint8_t | bEnable | ) |
Enable/disable the VOUTOK interrupt.
The ADP5300 has an output VOUTOK pin. When the regulated output voltage drops below 87% (typical) of its nominal output for a delay time greater than approximately 10 µs, the VOUTOK pin goes low. The MCU will be interrupted when this occurs to resume switching.
[in] | bEnable | : Enable/Disable VOUTOK interrupt.
|
ADI_GPIO_RESULT adi_adp5300_Init | ( | ) |
Initialize the ADP5300.
This function sets up the GPIO STOP and SYNC/MODE pins as MCU outputs and VOUTOK as a GPIO input. It also sets the mode to hysteresis and resumes regulator switching.
ADI_GPIO_RESULT adi_adp5300_ReadVoutokState | ( | uint8_t *const | pState | ) |
Read VOUTOK output pin.
The ADP5300 has an output VOUTOK pin. When the regulated output voltage drops below 87% (typical) of its nominal output for a delay time greater than approximately 10 µs, the VOUTOK pin goes low. This function reads the status of that pin.
[out] | pState | : State of the VOUTOK pin.
|
ADI_GPIO_RESULT adi_adp5300_SetMode | ( | ADI_ADP5300_MODE | eMode | ) |
Set the mode of the ADP5300.
The ADP5300 includes a SYNC/MODE pin to allow flexible mode configuration. In PWM mode, the regulator can supply lower output noise for noise sensitive applications. In hysteresis mode, the regualtor can act as a keep-alive power supply in a battery powered system, but with a relatively high output ripple.
[in] | eMode | : Mode to set the ADP5300. |
ADI_GPIO_RESULT adi_adp5300_SetSwitching | ( | ADI_ADP5300_SWITCHING | bState | ) |
Set the switching state of the ADP5300.
The ADP5300 has an input STOP pin that can temporarily stop regulator switching in hystersis mode, forcing the regulator to rely on the output capacitor to supply the load. In this period, a quiet system can be acheived which benefits noise sensitive circuitry like an rf transmission or analog sensing. Note: Swithing takes 10's of nanoseconds to fully stop.
[in] | bState | : Switching state to set the ADP5300. |