Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Regulator Parent Interface

Regulator Parent Interface . More...

Topics

 PCA9420 Utilities.
 
 

Functions

static int regulator_parent_dvs_state_set (const struct device *dev, regulator_dvs_state_t state)
 Set a DVS state.
 
static int regulator_parent_ship_mode (const struct device *dev)
 Enter ship mode.
 

Detailed Description

Regulator Parent Interface .

Function Documentation

◆ regulator_parent_dvs_state_set()

static int regulator_parent_dvs_state_set ( const struct device * dev,
regulator_dvs_state_t state )
inlinestatic

#include <zephyr/drivers/regulator.h>

Set a DVS state.

Some PMICs feature DVS (Dynamic Voltage Scaling) by allowing to program the voltage level for multiple states. Such states may be automatically changed by hardware using GPIO pins. Certain MCUs even allow to automatically configure specific output pins when entering low-power modes so that PMIC state is changed without software intervention. This API can be used when state needs to be changed by software.

Parameters
devParent regulator device instance.
stateDVS state (vendor specific identifier).
Return values
0If successful.
-ENOTSUPIf given state is not supported.
-EPERMIf state can't be changed by software.
-ENOSYSIf function is not implemented.
-errnoIn case of any other error.

◆ regulator_parent_ship_mode()

static int regulator_parent_ship_mode ( const struct device * dev)
inlinestatic

#include <zephyr/drivers/regulator.h>

Enter ship mode.

Some PMICs feature a ship mode, which allows the system to save power. Exit from low power is normally by pin transition.

This API can be used when ship mode needs to be entered.

Parameters
devParent regulator device instance.
Return values
0If successful.
-ENOSYSIf function is not implemented.
-errnoIn case of any other error.