Description

EFP (Energy Friendly PMIC) driver.

EFP (Energy Friendly PMIC) Driver Documentation

Introduction

The EFP is a flexible, highly efficient, multi-output power management IC. This driver provides an API to configure and control EFP ICs. The EFP is controlled by the host SoC using an I2C bus. The driver support systems with multiple EFP ICs.

Configuring the EFP driver

EFP component provides multiple configurations options. You can add as many instances as you have EFPs in the system (efp0, efp1, ...) and each instance have its own configurations options. EFP instance is configured through the configuration file sl_efp_{instance}_config.h (which {instance} is the instance name (efp0, efp1, ...)). This file is inside the config folder of your project.

The configurations options are used to populate the initialization structure in sl_efp_instances.c . This file is inside the autogen folder of your project. Simplicity Studio provides a graphic interface to configure EFP, and this will be reflected in the configuration file.

Here is an example of an initialization structure for instance efp0 using the configuration file.

sl_efp_init_data_t sl_efp_efp0_init = {
  .reset_to_default = SL_EFP_EFP0_RESET_TO_DEFAULT, // Reset EFP to out-of-reset defaults during initialization
  .config_size = 0,                                 // No initial config
  .config_data = NULL,                              // No config data
  .handoff_size = 0,                                // No initial DCDC handoff configuration config
  .handoff_parameters = NULL,                       // No initial DCDC handoff configuration parameters
  .is_host_efp = SL_EFP_EFP0_POWERS_HOST,           // This EFP powers host
  .em_transition_mode = SL_EFP_EFP0_EM_CTRL_MODE,   // EFP EM transition mode
  .irq_pin_mode = SL_EFP_EFP0_IRQ_MODE,             // Init EFP IRQ mode
  .irq_port = SL_EFP_EFP0_IRQ_PORT,                 // EFP IRQ port
  .irq_pin = SL_EFP_EFP0_IRQ_PIN,                   // EFP IRQ pin
  .i2c_peripheral = SL_EFP_EFP0_I2C_PERIPHERAL,     // I2C port instance
  .i2c_scl_port = SL_EFP_EFP0_I2C_SCL_PORT,         // SCL port
  .i2c_scl_pin = SL_EFP_EFP0_I2C_SCL_PIN,           // SCL pin
  .i2c_sda_port = SL_EFP_EFP0_I2C_SDA_PORT,         // SDA port
  .i2c_sda_pin = SL_EFP_EFP0_I2C_SDA_PIN,           // SDA pin
#if defined(SL_EFP_EFP0_I2C_ROUTE_LOC)
  .i2c_port_location = SL_EFP_EFP0_I2C_ROUTE_LOC,   // I2C location number
#endif
#if defined(SL_EFP_EFP0_I2C_SCL_LOC)
  .i2c_scl_port_location = SL_EFP_EFP0_I2C_SCL_LOC, // SCL port location
  .i2c_sda_port_location = SL_EFP_EFP0_I2C_SDA_LOC, // SDA port location
#endif
};

Some configurations options must be added manually in the application. From the above initialization structure, handoff_size and handoff_parameters are generated by EFP Configurator.

Here are the configuration options found in sl_efp_{instance}_config.h and used in initialization structure.

Configuration options:

Energy mode transition mode. Host SoC can use several methods for changing EFP energy mode. Methods are either direct mode or I2C mode. I2C mode changes EFP energy mode with I2C commands, direct mode uses level transitions on I2C SDA and SCL lines. This provides fast energy mode transitions. Direct mode is achieved by host SoC using GPIO bit-banging or automatically by EMU hardware on SoCs with built-In EFP support (check EMU section of reference manual for EFP support).
EFP interrupt. The EFP has an interrupt line that can be useful for a host SoC. Set this option to have the EFP driver configure a GPIO for this use.
EFP powers host SoC. Set if the EFP IC power the host SoC, there can only be one EFP with this option in a system.
Reset EFP. Set to reset EFP to default values during initialization.
I2C instance: Select which I2C peripheral to use.
GPIO definitions for I2C SDA/SCL and IRQ pins.

Here is an example configuration file for the board BRD4179B:

#ifndef SL_EFP_INST_CONFIG_H
#define SL_EFP_INST_CONFIG_H

#include "sl_efp.h"

#ifdef __cplusplus
extern "C" {
#endif

// <<< Use Configuration Wizard in Context Menu >>>

// <h>EFP driver configuration

// <o SL_EFP_EFP0_EM_CTRL_MODE> Selects method of controlling EFP Energy Mode (EM) transitions.
// <efp_em_transition_mode_gpio_bitbang=> GPIO driven direct mode EM transitions
// <efp_em_transition_mode_i2c=> I2C transfers control EM transitions
// <efp_em_transition_mode_emu=> Builtin EMU controlled direct mode EM transitions
// <i> Default: efp_em_transition_mode_i2c
#define SL_EFP_EFP0_EM_CTRL_MODE            efp_em_transition_mode_i2c

// <q SL_EFP_EFP0_ENABLE_IRQ> Enable GPIO as interrupt input line from EFP.
// <i> Default: 1
#define SL_EFP_EFP0_ENABLE_IRQ              1

// <q SL_EFP_EFP0_POWERS_HOST> This EFP powers host SoC.
// <i> Default: 1
#define SL_EFP_EFP0_POWERS_HOST             1

// <q SL_EFP_EFP0_RESET_TO_DEFAULT> Reset EFP to Default values during initialization.
// <i> Default: 0
#define SL_EFP_EFP0_RESET_TO_DEFAULT        0

// <q SL_EFP_EFP0_ADD_EFP_CALC> EFP Config parameters header is included in the project.
// <i> Set this if the header sl_efpdrv_calc.h generated by EFP Configurator is included in the project.
// <i> Default: 0
#define SL_EFP_EFP0_ADD_EFP_CALC            0

// </h> end EFP configuration

// <<< end of configuration section >>>

// <<< sl:start pin_tool >>>

// <gpio> SL_EFP_EFP0_IRQ
// $[GPIO_SL_EFP_EFP0_IRQ]
#define SL_EFP_EFP0_IRQ_PORT                     gpioPortA
#define SL_EFP_EFP0_IRQ_PIN                      0

// [GPIO_SL_EFP_EFP0_IRQ]$

// <i2c signal=SDA,SCL> SL_EFP_EFP0_I2C
// $[I2C_SL_EFP_EFP0_I2C]
#define SL_EFP_EFP0_I2C_PERIPHERAL               I2C1
#define SL_EFP_EFP0_I2C_PERIPHERAL_NO            1

// I2C1 SDA on PC01
#define SL_EFP_EFP0_I2C_SDA_PORT                 gpioPortC
#define SL_EFP_EFP0_I2C_SDA_PIN                  1

// I2C1 SCL on PC00
#define SL_EFP_EFP0_I2C_SCL_PORT                 gpioPortC
#define SL_EFP_EFP0_I2C_SCL_PIN                  0

// [I2C_SL_EFP_EFP0_I2C]$
// <<< sl:end pin_tool >>>

#ifdef __cplusplus
}
#endif

#endif // SL_EFP_INST_CONFIG_H

EFP driver example code

Note: Examples here are just code snippet for API illustration. Use Simplicity Studio to add full support for EFP component usage.

Basic example 1: Let VOA drive DVDD.

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"

int main( void )
{

  ...

  // Initialize EFP.
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  // Set voltage regulator A (VOA) output voltage and peak currents.
  // Peak currents value could be obained using EFP Configurator.
  sl_efp_set_voa_em01_ipk(sl_efp_efp0, 0x12);  // Peak Current setting for DCDC A in EM0
  sl_efp_set_voa_em23_ipk(sl_efp_efp0, 0x04);  // Peak Current setting for DCDC A in EM2

  // Set VOA output mode
  sl_efp_set_voa_mode(sl_efp_efp0, efp_voa_mode_wired_buck_ldo);

  // Set VOA voltage to 1.8V
  sl_efp_set_voa_voltage(sl_efp_efp0, 1800);

  ...

}

Basic example 2: VOB drives Decouple input.

In this example, handoff parameters must be defined by using EFP Configurator tool in Simplicity Studio.

It generates the header sl_efpdrv_calc.h . Copy this file and put it in your project.

As an example, here are handoff parameters obtained:

#define SL_EFP_DECOUPLE_HANDOFF_ARGS_SIZE  3
#define SL_DECOUPLE_HANDOFF_ARGS           {0, 7, 10} // (BK_IRI_CON, BK_TON_MAX, BK_IPK)

EFP Configurator generates also the config data to setup EFP options. Here is the config data output from EFP Configurator:

#define SL_EFP_GEN_SIZE 13

#define SL_EFP_GEN {  \
    {EFP01_VOA_V, 0x04},  \
    {EFP01_BB_IPK, 0x92}, \
    {EFP01_BB_CTRL5, 0x80}, \
    {EFP01_BB_CTRL6, 0x00}, \
    {EFP01_LDOC_BB_CTRL, 0x50}, \
    {EFP01_BB_CTRL3, 0xB5}, \
    {EFP01_VOB_EM0_V, 0x8D},  \
    {EFP01_VOB_EM2_V, 0x0D},  \
    {EFP01_BK_IPK, 0x48}, \
    {EFP01_BK_CTRL2, 0x50}, \
    {EFP01_LDOB_CTRL, 0x01},  \
    {EFP01_VOC_V, 0x05},  \
    {EFP01_LDOC_CTRL, 0x0C},  \
}

Main file:

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"

int main(void)
{

  ...

  // Set handoff parameters.
  sl_efp_efp0_init.handoff_size = SL_EFP_DECOUPLE_HANDOFF_ARGS_SIZE;
  uint8_t handoffParameters[SL_EFP_DECOUPLE_HANDOFF_ARGS_SIZE] = SL_DECOUPLE_HANDOFF_ARGS;
  sl_efp_efp0_init.handoff_parameters = handoffParameters;

  // Set config data
  // Pass array of custom settings to init function.
  sl_efp_efp0_init.config_size        = SL_EFP_GEN_SIZE;
  uint8_t efp_settings[SL_EFP_GEN_SIZE][2] = SL_EFP_GEN;
  sl_efp_efp0_init.config_data        = efp_settings[0];

  // Initialize EFP. This will disable internal LDO.
  // During initialization, a handoff happens and VOB will power decouple.
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  ...

}

EFP initialization code is generated automatically when creating a project with EFP component. In previous examples, initialization code including setting handoff parameters and config data is found in the function sl_efp_init_instances() under sl_efp_instances.c .

sl_efp_init_instances() sets handoff parameters and config data if they are defined and calls sl_efp_init() .

Code for preparing for EFP interrupts:

For series 1 and xG21 (series 2) devices:

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"
#include "em_emu.h"

int main( void )
{

  ...

  // Prepare for EFP IRQ from Coulomb counter (CC) calibration flag. Flag
  // is set when calibration is done.
  sl_efp_write_register(efp, EFP01_STATUS_GM, 0xFF);    // Unmask all G flags
  sl_efp_write_register(efp, EFP01_CC_CAL, 0x28);       // Enable CC VOA

  // Setup GPIO interrupt.
  NVIC_ClearPendingIRQ(GPIO_ODD_IRQn);
  NVIC_EnableIRQ(GPIO_ODD_IRQn);
  GPIO_IntConfig(init.irq_port, init.irq_pin, false, true, true);

  ...

  // Start CC Calibration
  // This will set CCC_ISDONE (calibration is done) flag interrupt and trigger an IRQ.
  sl_efp_write_register(efp, EFP01_CMD, 0x10);

  ...

}

void GPIO_ODD_IRQHandler(void)
{
  // Make sure any ongoing EFP I2C transfer is completed before writing to EFP.

  // Clear EFP IRQ flag.
  sl_efp_write_register(efp, EFP01_STATUS_G, 0x40);

  // Clear GPIO interrupt flag.
  GPIO_IntClear(1 << init.irq_pin);
}

xG22 and later devices have a built-in support for communications with EFP. There is a dedicated IRQ vector to use instead of using gpio interrupts. The interrupt should be enabled in EMU using EMU_EFPIntEnable() .

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"
#include "em_emu.h"

int main( void )
{

  ...

  // Prepare for EFP IRQ from Coulomb counter (CC) calibration flag. Flag
  // is set when calibration is done.
  sl_efp_write_register(efp, EFP01_STATUS_GM, 0xFF);    // Unmask all G flags
  sl_efp_write_register(efp, EFP01_CC_CAL, 0x28);       // Enable CC VOA

  // Setup GPIO interrupt.
  NVIC_ClearPendingIRQ(EMUEFP_IRQn);
  NVIC_EnableIRQ(EMUEFP_IRQn);

  // Enable EFP interrupt in EMU.
  EMU_EFPIntEnable(EMU_EFPIF_EFPIF);

  ...

  // Start CC Calibration
  // This will set CCC_ISDONE (calibration is done) flag interrupt and trigger an IRQ.
  sl_efp_write_register(efp, EFP01_CMD, 0x10);

  ...

}

void EMUEFP_IRQHandler(void)
{
  // Make sure any ongoing EFP I2C transfer is completed before writing to EFP.

  // Clear EFP IRQ flag.
  sl_efp_write_register(efp, EFP01_STATUS_G, 0x40);

  EMU_EFPIntClear(EMU_EFPIF_EFPIF);

}

Example with custom EFP configuration data. The sl_efp_init() function can perform EFP configuration by passing an array of EFP {address,value} pairs.

This array can be generated by the EFP Configurator tool in Simplicity Studio.

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"

#define SL_EFP_INSTANCE_GEN_SIZE 10

// Array of 10 {address,data} pairs.
#define SL_EFP_INSTANCE_GEN {      \
    { EFP01_VOA_V,        4   },   \
    { EFP01_BB_IPK,       146 },   \
    { EFP01_BB_CTRL6,     0   },   \
    { EFP01_LDOC_BB_CTRL, 0   },   \
    { EFP01_BB_CTRL3,     181 },   \
    { EFP01_VOB_EM0_V,    13  },   \
    { EFP01_VOB_EM2_V,    13  },   \
    { EFP01_BK_IPK,       38  },   \
    { EFP01_BK_CTRL2,     80  },   \
    { EFP01_BK_CTRL1,     24  },   \
}

uint8_t efp_settings[SL_EFP_INSTANCE_GEN_SIZE][2] = SL_EFP_INSTANCE_GEN;

int main( void )
{

  ...

  // Initialize EFP, pass array of custom settings to init function.
  sl_efp_efp0_init.config_size        = SL_EFP_INSTANCE_GEN_SIZE;
  sl_efp_efp0_init.config_data        = efp_settings[0];
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  ...

}

EFP Built-in support in xG22 and later devices

As mentioned before, beginning from xG22, devices have a built-in EFP hardware support.
A new Direct Mode interface with EFP is added for fast energy mode transitions. This Direct Mode allows to go to the lowest energy mode, EM4. When MCU pass from an energy mode to another it puts EFP in the appropriate energy mode automatically without software intervention. Use sl_efp_set_em_transition_mode() and sl_efp_enable_direct_mode() to enable direct mode.
Basic example using EFP to pass to EM2 energy mode:

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"
#include "em_emu.h"

int main( void )
{
  // Set EM2 init. This setup voltage scaling for EM2
  EMU_EM23Init_TypeDef em23Init = EMU_EM23INIT_DEFAULT;
  EMU_EM23Init(&em23Init);

  // Init EFP with handoff parameters defined. See example above to set handoff
  // parameters.
  // Init function will initialize voltage scaling in EFP according to the MCU's
  // voltage scaling.
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  // Enter to EM2.
  // This will enter the MCU into EM2 and therefore EFP pass to EM2 as well. EFP
  // will adjust voltage according to em23Init.vScaleEM23Voltage.
  EMU_EnterEM2(true);

}

Note

Voltage scaling with EFP is supported only in xG22 and later devices.
Basic example to demonstrate voltage scaling in EM0:

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"
#include "em_emu.h"

int main( void )
{
  // Init EMU. This will set EM0 voltage to 1.1V (high performance voltage)
  EMU_EM01Init_TypeDef em01_init = EMU_EM01INIT_DEFAULT;
  EMU_EM01Init(&em01_init);

  // Init EFP with handoff parameters defined. See example above to set handoff
  // parameters
  // Init function will initialize voltage scaling in EFP according to the MCU's
  // voltage scaling.
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  // Change voltage on decouple to 1.0V (low power voltage)
  EMU_VScaleEM01_TypeDef voltage = emuVScaleEM01_LowPower;

  EMU_VScaleEM01(voltage, true);

}

Warning: EFP in EM4 mode is supported only on devices that have Direct Mode hardware support integrated in EMU (EFRxG22 and later devices). So this requires init_data.em_transition_mode == efp_em_transition_mode_emu .

EMU direct mode can be set in Configuration file:

#define SL_EFP_EFP0_EM_CTRL_MODE            efp_em_transition_mode_emu

The main:

#include "sl_efp.h"
#include "sl_efp_instances.h"
#include "sl_efp_efp0_config.h"
#include "em_emu.h"

int main( void )
{
  // Set EM4 init.
  EMU_EM4Init_TypeDef em4Init = EMU_EM4INIT_DEFAULT;

  // Enable Pin Retention through EM4 and wakeup
  em4Init.pinRetentionMode = emuPinRetentionLatch;

  EMU_EM4Init(&em4Init);

  // Init function will initialize direct mode.
  sl_efp_init(sl_efp_efp0, &sl_efp_efp0_init);

  // Enter to EM4.
  // This will enter MCU and EFP into EM4.
  EMU_EnterEM4();
}

Data Structures
struct	sl_efp_init_data_t
	EFP driver initialization structure.

struct	sl_efp_handle_data_t
	An EFP driver instance handle data structure.

Functions
sl_status_t	sl_efp_deinit ( sl_efp_handle_t handle)
	Deinitialize EFP driver and underlying EFP hardware.

sl_status_t	sl_efp_enable_direct_mode ( sl_efp_handle_t handle)
	Enable direct mode in EFP and EMU.

sl_status_t	sl_efp_enter_em0 ( sl_efp_handle_t handle)
	Set EFP in EM0 energy mode.

sl_status_t	sl_efp_enter_em2 ( sl_efp_handle_t handle)
	Set EFP in EM2 energy mode.

sl_status_t	sl_efp_get_vdd_avg ( sl_efp_handle_t handle, uint16_t *voltage_mv)
	Measure average VDD.

sl_status_t	sl_efp_get_vdd_max ( sl_efp_handle_t handle, uint16_t *voltage_mv)
	Measure maximum VDD.

sl_status_t	sl_efp_get_vdd_min ( sl_efp_handle_t handle, uint16_t *voltage_mv)
	Measure minimum VDD.

sl_status_t	sl_efp_init ( sl_efp_handle_t handle, const sl_efp_init_data_t *init)
	Initialize EFP driver and configure underlying EFP hardware.

sl_status_t	sl_efp_read_otp ( sl_efp_handle_t handle, uint8_t addr, uint8_t *data)
	Read EFP OTP register.

sl_status_t	sl_efp_read_register ( sl_efp_handle_t handle, uint8_t addr, uint8_t *data)
	Read EFP control register.

sl_status_t	sl_efp_read_register_field ( sl_efp_handle_t handle, uint8_t addr, uint8_t *data, uint8_t mask, uint8_t pos)
	Read EFP control register field.

sl_status_t	sl_efp_reset ( sl_efp_handle_t handle)
	Reset EFP.

sl_status_t	sl_efp_reset_to_default ( sl_efp_handle_t handle)
	Reset EFP to default settings.

sl_status_t	sl_efp_set_em_transition_mode ( sl_efp_handle_t handle, sl_efp_em_transition_mode_t mode)
	Set EM transition mode.

sl_status_t	sl_efp_set_voa_em01_ipk ( sl_efp_handle_t handle, uint8_t ipk)
	Set regulator VOA EM01 peak output current.

sl_status_t	sl_efp_set_voa_em23_ipk ( sl_efp_handle_t handle, uint8_t ipk)
	Set regulator VOA EM23 peak output current.

sl_status_t	sl_efp_set_voa_em01_peak_current ( sl_efp_handle_t handle, unsigned int current_ma, unsigned int vddb_mv, unsigned int voa_mv, unsigned int inductor_nh)
	Set regulator VOA EM01 peak output current.

sl_status_t	sl_efp_set_voa_em23_peak_current ( sl_efp_handle_t handle, unsigned int current_ma, unsigned int vddb_mv, unsigned int voa_mv, unsigned int inductor_nh)
	Set regulator VOA EM23 peak output current.

sl_status_t	sl_efp_set_voa_mode ( sl_efp_handle_t handle, sl_efp_voa_mode_t mode)
	Set regulator VOA mode.

sl_status_t	sl_efp_set_voa_sw_mode ( sl_efp_handle_t handle, sl_efp_voa_sw_mode_t mode)
	Set VOA SW (switched output) mode.

sl_status_t	sl_efp_set_voa_voltage ( sl_efp_handle_t handle, unsigned int voltage_mv)
	Set regulator VOA output voltage.

sl_status_t	sl_efp_set_vob_em01_ipk ( sl_efp_handle_t handle, uint8_t ipk)
	Set regulator VOB EM01 peak output current.

sl_status_t	sl_efp_set_vob_em01_peak_current ( sl_efp_handle_t handle, unsigned int current_ma, unsigned int vddb_mv, unsigned int vob_mv, unsigned int inductor_nh)
	Set regulator VOB EM01 peak output current.

sl_status_t	sl_efp_set_vob_em01_voltage ( sl_efp_handle_t handle, unsigned int voltage_mv)
	Set regulator VOB EM01 output voltage.

sl_status_t	sl_efp_set_vob_em23_ipk ( sl_efp_handle_t handle, uint8_t ipk)
	Set regulator VOB EM23 peak output current.

sl_status_t	sl_efp_set_vob_em23_peak_current ( sl_efp_handle_t handle, unsigned int current_ma, unsigned int vddb_mv, unsigned int vob_mv, unsigned int inductor_nh)
	Set regulator VOB EM23 peak output current.

sl_status_t	sl_efp_set_vob_em23_voltage ( sl_efp_handle_t handle, unsigned int voltage_mv)
	Set regulator VOB EM23 output voltage.

sl_status_t	sl_efp_set_vob_mode ( sl_efp_handle_t handle, sl_efp_vob_mode_t mode)
	Set regulator VOB mode.

sl_status_t	sl_efp_set_voc_voltage ( sl_efp_handle_t handle, unsigned int voltage_mv)
	Set regulator VOC output voltage.

sl_status_t	sl_efp_emu_ldo_enable ( sl_efp_handle_t handle, bool enable)
	Turn the internal EMU LDO regulator that supplies DECOUPLE pin on or off.

sl_status_t	sl_efp_write_register ( sl_efp_handle_t handle, uint8_t addr, uint8_t data)
	Write EFP control register.

sl_status_t	sl_efp_write_register_field ( sl_efp_handle_t handle, uint8_t addr, uint8_t data, uint8_t mask, uint8_t pos)
	Write EFP control register field.

Typedefs
typedef sl_efp_handle_data_t *	sl_efp_handle_t
	An EFP driver instance handle.

Enumerations
enum	sl_efp_em_transition_mode_t { efp_em_transition_mode_gpio_bitbang , efp_em_transition_mode_i2c , efp_em_transition_mode_emu }
	Method for controlling EFP Energy Mode (EM) transitions.

enum	sl_efp_irq_mode_t { efp_irq_pin_disabled , efp_irq_pin_gpio , efp_irq_pin_emu }
	Method for supporting EFP01 interrupt.

enum	sl_efp_voa_mode_t { efp_voa_mode_disabled = _EFP01_BB_CTRL3_BB_MODE_DISABLED, efp_voa_mode_wired_buck = _EFP01_BB_CTRL3_BB_MODE_WIREDBUCK, efp_voa_mode_wired_boost = _EFP01_BB_CTRL3_BB_MODE_WIREDBOOST, efp_voa_mode_wired_buck_ldo = _EFP01_BB_CTRL3_BB_MODE_WIREDBUCKLDO, efp_voa_mode_buck_boost_autonomous = _EFP01_BB_CTRL3_BB_MODE_AUTONOMOUS, efp_voa_mode_buck_boost_forced_buck = _EFP01_BB_CTRL3_BB_MODE_FORCEBUCK, efp_voa_mode_buck_boost_forced_ntm = _EFP01_BB_CTRL3_BB_MODE_FORCENTM, efp_voa_mode_buck_boost_forced_boost = _EFP01_BB_CTRL3_BB_MODE_FORCEBOOST }
	VOA regulator modes.

enum	sl_efp_voa_sw_mode_t { efp_voa_sw_mode_off = _EFP01_BIAS_SW_VOA_SW_CON_OFF, efp_voa_sw_mode_on = _EFP01_BIAS_SW_VOA_SW_CON_ON, efp_voa_sw_mode_on_in_em0 = _EFP01_BIAS_SW_VOA_SW_CON_ONINEM0, efp_voa_sw_mode_on_in_em02 = _EFP01_BIAS_SW_VOA_SW_CON_ONINEM02 }
	VOA SW (switched output) modes.

enum	sl_efp_vob_mode_t { efp_vob_mode_disabled = _EFP01_BK_CTRL1_BK_MODE_DISABLED, efp_vob_mode_buck = _EFP01_BK_CTRL1_BK_MODE_BUCKONLY, efp_vob_mode_ldo = _EFP01_BK_CTRL1_BK_MODE_LDOONLY, efp_vob_mode_buck_ldo = _EFP01_BK_CTRL1_BK_MODE_BUCKLDO }
	VOB regulator modes.

Function Documentation

◆ sl_efp_deinit()

sl_status_t sl_efp_deinit ( sl_efp_handle_t handle )

Deinitialize EFP driver and underlying EFP hardware.

Parameters

[in] handle EFP instance handle.

Returns: SL_STATUS_OK.

◆ sl_efp_enable_direct_mode()

sl_status_t sl_efp_enable_direct_mode ( sl_efp_handle_t handle )

Enable direct mode in EFP and EMU.

And configure I2C pins for bitbang EM transfer mode.

Parameters

[in] handle EFP instance handle.

Note: This must be the last EFP driver function called prior to entering EM2/3 via EMU_EnterEMx() calls. Any EFP API call that involves an I2C transfer will leave the I2C GPIO pins in I2C mode.

Returns: SL_STATUS_OK on success. SL_STATUS_INVALID_MODE if current EM transfer mode is I2C. SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_enter_em0()

sl_status_t sl_efp_enter_em0 ( sl_efp_handle_t handle )

Set EFP in EM0 energy mode.

Note: This function enables direct mode if necessary.

Parameters

[in] handle EFP instance handle.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_enter_em2()

sl_status_t sl_efp_enter_em2 ( sl_efp_handle_t handle )

Set EFP in EM2 energy mode.

Note: This function enables direct mode if necessary.

Parameters

[in] handle EFP instance handle.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_get_vdd_avg()

sl_status_t sl_efp_get_vdd_avg	(	sl_efp_handle_t	`handle,`
		uint16_t *	`voltage_mv`
	)

Measure average VDD.

Note: This function measures VDDA or VDDB depending of the voltage on the VDDA pin after power on. If VDDA is powered this function returns a VDDA reading, otherwise a VDDB reading is returned.

Parameters

[in]	`handle`	EFP instance handle.
[out]	`voltage_mv`	Average VDD voltage expressed in millivolts.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_get_vdd_max()

sl_status_t sl_efp_get_vdd_max	(	sl_efp_handle_t	`handle,`
		uint16_t *	`voltage_mv`
	)

Measure maximum VDD.

Note: This function measures VDDA or VDDB depending of the voltage on the VDDA pin after power on. If VDDA is powered this function returns a VDDA reading, otherwise a VDDB reading is returned.

Parameters

[in]	`handle`	EFP instance handle.
[out]	`voltage_mv`	Maximum VDD voltage expressed in millivolts.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_get_vdd_min()

sl_status_t sl_efp_get_vdd_min	(	sl_efp_handle_t	`handle,`
		uint16_t *	`voltage_mv`
	)

Measure minimum VDD.

Note: This function measures VDDA or VDDB depending of the voltage on the VDDA pin after power on. If VDDA is powered this function returns a VDDA reading, otherwise a VDDB reading is returned.

Parameters

[in]	`handle`	EFP instance handle.
[out]	`voltage_mv`	Minimum VDD voltage expressed in miilivolts.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_init()

sl_status_t sl_efp_init	(	sl_efp_handle_t	`handle,`
		const sl_efp_init_data_t *	`init`
	)

Initialize EFP driver and configure underlying EFP hardware.

Note: This function must not be called from interrupt context.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`init`	Initialization data structure.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors, or SL_STATUS_FAIL on illegal initialization.

◆ sl_efp_read_otp()

sl_status_t sl_efp_read_otp	(	sl_efp_handle_t	`handle,`
		uint8_t	`addr,`
		uint8_t *	`data`
	)

Read EFP OTP register.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`addr`	Register address.
[out]	`data`	The value read from the OTP register.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_read_register()

sl_status_t sl_efp_read_register	(	sl_efp_handle_t	`handle,`
		uint8_t	`addr,`
		uint8_t *	`data`
	)

Read EFP control register.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`addr`	Register address.
[out]	`data`	The value read from the register.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_read_register_field()

sl_status_t sl_efp_read_register_field	(	sl_efp_handle_t	`handle,`
		uint8_t	`addr,`
		uint8_t *	`data,`
		uint8_t	`mask,`
		uint8_t	`pos`
	)

Read EFP control register field.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`addr`	Register address.
[out]	`data`	The value read from the register field.
[in]	`mask`	Bit mask corresponding to target bit field.
[in]	`pos`	Bit number of least significant bit of target bit field.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_reset()

sl_status_t sl_efp_reset ( sl_efp_handle_t handle )

Reset EFP.

Perform a full reset of the EFP, this is equivalent to a power on reset.

Warning: When using the CMD.RESET bit, all the EFP's internal registers will be momentarily reset to 0's before being overwritten with the OTP defaults. This means that any enabled DCDCs or LDOs will be momentarily disabled, then re-enabled. If the load current on that output is large enough during this reset, the voltage may drop and cause a brownout. Recommend use of the sl_efp_reset_to_default() function instead, which simply reloads the OTP defaults without clearning all the registers to 0 first.

Parameters

[in] handle EFP instance handle.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_reset_to_default()

sl_status_t sl_efp_reset_to_default ( sl_efp_handle_t handle )

Reset EFP to default settings.

This function is recommended over sl_efp_reset() to reset EFP.

Parameters

[in] handle EFP instance handle.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_em_transition_mode()

sl_status_t sl_efp_set_em_transition_mode	(	sl_efp_handle_t	`handle,`
		sl_efp_em_transition_mode_t	`mode`
	)

Set EM transition mode.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`mode`	New EFP Energy Mode (EM) transition mode. See sl_efp_em_transition_mode_t for valid modes.

Returns: SL_STATUS_OK.

◆ sl_efp_set_voa_em01_ipk()

sl_status_t sl_efp_set_voa_em01_ipk	(	sl_efp_handle_t	`handle,`
		uint8_t	`ipk`
	)

Set regulator VOA EM01 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`ipk`	Target peak current setting.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_em23_ipk()

sl_status_t sl_efp_set_voa_em23_ipk	(	sl_efp_handle_t	`handle,`
		uint8_t	`ipk`
	)

Set regulator VOA EM23 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`ipk`	Target peak current setting.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_em01_peak_current()

sl_status_t sl_efp_set_voa_em01_peak_current	(	sl_efp_handle_t	`handle,`
		unsigned int	`current_ma,`
		unsigned int	`vddb_mv,`
		unsigned int	`voa_mv,`
		unsigned int	`inductor_nh`
	)

Set regulator VOA EM01 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`current_ma`	Target peak current expressed in milliamperes.
[in]	`vddb_mv`	VDDB expressed in millivolt.
[in]	`voa_mv`	VOA expressed in millivolt.
[in]	`inductor_nh`	Inductor size expressed in nanohenry.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_em23_peak_current()

sl_status_t sl_efp_set_voa_em23_peak_current	(	sl_efp_handle_t	`handle,`
		unsigned int	`current_ma,`
		unsigned int	`vddb_mv,`
		unsigned int	`voa_mv,`
		unsigned int	`inductor_nh`
	)

Set regulator VOA EM23 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`current_ma`	Target peak current expressed in milliamperes.
[in]	`vddb_mv`	VDDB expressed in millivolt.
[in]	`voa_mv`	VOA expressed in millivolt.
[in]	`inductor_nh`	Inductor size expressed in nanohenry.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_mode()

sl_status_t sl_efp_set_voa_mode	(	sl_efp_handle_t	`handle,`
		sl_efp_voa_mode_t	`mode`
	)

Set regulator VOA mode.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`mode`	Regulator mode.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_sw_mode()

sl_status_t sl_efp_set_voa_sw_mode	(	sl_efp_handle_t	`handle,`
		sl_efp_voa_sw_mode_t	`mode`
	)

Set VOA SW (switched output) mode.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`mode`	VOA SW mode.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voa_voltage()

sl_status_t sl_efp_set_voa_voltage	(	sl_efp_handle_t	`handle,`
		unsigned int	`voltage_mv`
	)

Set regulator VOA output voltage.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`voltage_mv`	Voltage in millivolt.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em01_ipk()

sl_status_t sl_efp_set_vob_em01_ipk	(	sl_efp_handle_t	`handle,`
		uint8_t	`ipk`
	)

Set regulator VOB EM01 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`ipk`	Target peak current setting.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em01_peak_current()

sl_status_t sl_efp_set_vob_em01_peak_current	(	sl_efp_handle_t	`handle,`
		unsigned int	`current_ma,`
		unsigned int	`vddb_mv,`
		unsigned int	`vob_mv,`
		unsigned int	`inductor_nh`
	)

Set regulator VOB EM01 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`current_ma`	Target peak current expressed in milliamperes.
[in]	`vddb_mv`	VDDB expressed in millivolt.
[in]	`vob_mv`	VOB expressed in millivolt.
[in]	`inductor_nh`	Inductor size expressed in nanohenry.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em01_voltage()

sl_status_t sl_efp_set_vob_em01_voltage	(	sl_efp_handle_t	`handle,`
		unsigned int	`voltage_mv`
	)

Set regulator VOB EM01 output voltage.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`voltage_mv`	Voltage in millivolt.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em23_ipk()

sl_status_t sl_efp_set_vob_em23_ipk	(	sl_efp_handle_t	`handle,`
		uint8_t	`ipk`
	)

Set regulator VOB EM23 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`ipk`	Target peak current setting.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em23_peak_current()

sl_status_t sl_efp_set_vob_em23_peak_current	(	sl_efp_handle_t	`handle,`
		unsigned int	`current_ma,`
		unsigned int	`vddb_mv,`
		unsigned int	`vob_mv,`
		unsigned int	`inductor_nh`
	)

Set regulator VOB EM23 peak output current.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`current_ma`	Target peak current expressed in milliamperes.
[in]	`vddb_mv`	VDDB expressed in millivolt.
[in]	`vob_mv`	VOB expressed in millivolt.
[in]	`inductor_nh`	Inductor size expressed in nanohenry.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_em23_voltage()

sl_status_t sl_efp_set_vob_em23_voltage	(	sl_efp_handle_t	`handle,`
		unsigned int	`voltage_mv`
	)

Set regulator VOB EM23 output voltage.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`voltage_mv`	Voltage in millivolt.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_vob_mode()

sl_status_t sl_efp_set_vob_mode	(	sl_efp_handle_t	`handle,`
		sl_efp_vob_mode_t	`mode`
	)

Set regulator VOB mode.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`mode`	Regulator mode.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_set_voc_voltage()

sl_status_t sl_efp_set_voc_voltage	(	sl_efp_handle_t	`handle,`
		unsigned int	`voltage_mv`
	)

Set regulator VOC output voltage.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`voltage_mv`	Voltage in millivolt.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_emu_ldo_enable()

sl_status_t sl_efp_emu_ldo_enable	(	sl_efp_handle_t	`handle,`
		bool	`enable`
	)

Turn the internal EMU LDO regulator that supplies DECOUPLE pin on or off.

Note: Make sure that an external source supply the DECOUPLE pin turning the LDO off.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`enable`	True to turn LDO on, false to turn off.

Returns: SL_STATUS_OK or SL_STATUS_NOT_SUPPORTED, or SL_STATUS_FAIL if not a host EFP instance.

◆ sl_efp_write_register()

sl_status_t sl_efp_write_register	(	sl_efp_handle_t	`handle,`
		uint8_t	`addr,`
		uint8_t	`data`
	)

Write EFP control register.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`addr`	Register address.
[in]	`data`	The value to write to the register.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

◆ sl_efp_write_register_field()

sl_status_t sl_efp_write_register_field	(	sl_efp_handle_t	`handle,`
		uint8_t	`addr,`
		uint8_t	`data,`
		uint8_t	`mask,`
		uint8_t	`pos`
	)

Write EFP control register field.

Note: This function performs a read-modify-write of a EFP register.

Parameters

[in]	`handle`	EFP instance handle.
[in]	`addr`	Register address.
[in]	`data`	The value to write to the register field.
[in]	`mask`	Bit mask corresponding to target bit field.
[in]	`pos`	Bit number of least significant bit of target bit field.

Returns: SL_STATUS_OK or SL_STATUS_IO on I2C transfer errors.

Typedef Documentation

◆ sl_efp_handle_t

typedef sl_efp_handle_data_t * sl_efp_handle_t

An EFP driver instance handle.

Enumeration Type Documentation

◆ sl_efp_em_transition_mode_t

enum sl_efp_em_transition_mode_t

Method for controlling EFP Energy Mode (EM) transitions.

Enumerator
efp_em_transition_mode_gpio_bitbang	GPIO driven "direct mode" EM transitions.
efp_em_transition_mode_i2c	I2C transfers control EM transitions.
efp_em_transition_mode_emu	Built in EMU controlled "direct mode" EM transitions.

◆ sl_efp_irq_mode_t

enum sl_efp_irq_mode_t

Method for supporting EFP01 interrupt.

Enumerator
efp_irq_pin_disabled	Don't use interrupt.
efp_irq_pin_gpio	Normal GPIO interrupt.
efp_irq_pin_emu	Builtin EMU controlled IRQ on dedicated pin.

◆ sl_efp_voa_mode_t

enum sl_efp_voa_mode_t

VOA regulator modes.

Enumerator
efp_voa_mode_disabled	VOA disabled.
efp_voa_mode_wired_buck	VOA wired buck.
efp_voa_mode_wired_boost	VOA wired boost.
efp_voa_mode_wired_buck_ldo	VOA wired buck and LDO.
efp_voa_mode_buck_boost_autonomous	VOA buck boost autonomous.
efp_voa_mode_buck_boost_forced_buck	VOA buck boost forced buck.
efp_voa_mode_buck_boost_forced_ntm	VOA buck boost forced NTM.
efp_voa_mode_buck_boost_forced_boost	VOA buck boost forced boost.

◆ sl_efp_voa_sw_mode_t

enum sl_efp_voa_sw_mode_t

VOA SW (switched output) modes.

Enumerator
efp_voa_sw_mode_off	VOA SW off.
efp_voa_sw_mode_on	VOA SW on in EM0, EM2 and EM4.
efp_voa_sw_mode_on_in_em0	VOA SW on in EM0 only.
efp_voa_sw_mode_on_in_em02	VOA SW on in EM0 and EM2.

◆ sl_efp_vob_mode_t

enum sl_efp_vob_mode_t

VOB regulator modes.

Enumerator
efp_vob_mode_disabled	VOB disabled.
efp_vob_mode_buck	VOB buck only.
efp_vob_mode_ldo	VOB LDO only.
efp_vob_mode_buck_ldo	VOB buck and LDO.

EFP - Energy Friendly PMIC

Description

EFP (Energy Friendly PMIC) Driver Documentation

Introduction

Configuring the EFP driver

EFP driver example code

EFP Built-in support in xG22 and later devices

Data Structures

Functions

Typedefs

Enumerations

Function Documentation

◆ sl_efp_deinit()

◆ sl_efp_enable_direct_mode()

◆ sl_efp_enter_em0()

◆ sl_efp_enter_em2()

◆ sl_efp_get_vdd_avg()

◆ sl_efp_get_vdd_max()

◆ sl_efp_get_vdd_min()

◆ sl_efp_init()

◆ sl_efp_read_otp()

◆ sl_efp_read_register()

◆ sl_efp_read_register_field()

◆ sl_efp_reset()

◆ sl_efp_reset_to_default()

◆ sl_efp_set_em_transition_mode()

◆ sl_efp_set_voa_em01_ipk()

◆ sl_efp_set_voa_em23_ipk()

◆ sl_efp_set_voa_em01_peak_current()

◆ sl_efp_set_voa_em23_peak_current()

◆ sl_efp_set_voa_mode()

◆ sl_efp_set_voa_sw_mode()

◆ sl_efp_set_voa_voltage()

◆ sl_efp_set_vob_em01_ipk()

◆ sl_efp_set_vob_em01_peak_current()

◆ sl_efp_set_vob_em01_voltage()

◆ sl_efp_set_vob_em23_ipk()

◆ sl_efp_set_vob_em23_peak_current()

◆ sl_efp_set_vob_em23_voltage()

◆ sl_efp_set_vob_mode()

◆ sl_efp_set_voc_voltage()

◆ sl_efp_emu_ldo_enable()

◆ sl_efp_write_register()

◆ sl_efp_write_register_field()

Typedef Documentation

◆ sl_efp_handle_t

Enumeration Type Documentation

◆ sl_efp_em_transition_mode_t

◆ sl_efp_irq_mode_t

◆ sl_efp_voa_mode_t

◆ sl_efp_voa_sw_mode_t

◆ sl_efp_vob_mode_t