SmartSnippets DA1459x SDK
Data Structures | Enumerations | Functions

Power Manager header file for DA1459x. More...

#include "sdk_defs.h"

Go to the source code of this file.

Data Structures

struct  HW_PMU_1V8_RAIL_CONFIG
 1V8 power rail configuration More...
 
struct  HW_PMU_VDCDC_RAIL_CONFIG
 VDCDC power rail configuration. More...
 
struct  HW_PMU_VDD_RAIL_CONFIG
 VDD power rail configuration. More...
 

Enumerations

enum  HW_PMU_ERROR_CODE {
  HW_PMU_ERROR_NOERROR = 0, HW_PMU_ERROR_INVALID_ARGS = 1, HW_PMU_ERROR_NOT_ENOUGH_POWER = 2, HW_PMU_ERROR_XTAL32M_DBLR_ON = 3,
  HW_PMU_ERROR_XTAL32M_ON = 4, HW_PMU_ERROR_RC32M_ON = 5, HW_PMU_ERROR_RCX_ON = 6, HW_PMU_ERROR_RCX_LP = 7,
  HW_PMU_ERROR_XTAL32K_ON = 8, HW_PMU_ERROR_XTAL32K_LP = 9, HW_PMU_ERROR_FAST_WAKEUP_ON = 10, HW_PMU_ERROR_ACTION_NOT_POSSIBLE = 11,
  HW_PMU_ERROR_OTHER_LOADS_DEPENDENCY = 12, HW_PMU_ERROR_BOD_IS_ACTIVE = 13, HW_PMU_ERROR_BOD_THRESHOLD = 14, HW_PMU_ERROR_SLEEP_LDO = 15,
  HW_PMU_ERROR_EFLASH_OPS = 16
}
 PMU API Error Codes. More...
 
enum  HW_PMU_SRC_TYPE { HW_PMU_SRC_TYPE_LDO_LOW_RIPPLE = 0, HW_PMU_SRC_TYPE_DCDC_HIGH_EFFICIENCY = 1, HW_PMU_SRC_TYPE_VBAT = 2 }
 PMU API Source type. More...
 
enum  HW_PMU_POWER_RAIL_STATE { POWER_RAIL_DISABLED = 0, POWER_RAIL_ENABLED = 1 }
 Power rail state (enabled or disabled) More...
 
enum  HW_PMU_1V8_VOLTAGE { HW_PMU_1V8_VOLTAGE_1V8 = 0 }
 Voltage level options for the 1V8 power rail. More...
 
enum  HW_PMU_1V8_MAX_LOAD { HW_PMU_1V8_MAX_LDO_LOAD_2 = 0, HW_PMU_1V8_MAX_BYPASS_LOAD_2 = 1, HW_PMU_1V8_MAX_LDO_LOAD_20 = 2, HW_PMU_1V8_MAX_BYPASS_LOAD_20 = 3 }
 Maximum load current options for the 1V8 power rail. More...
 
enum  HW_PMU_VDCDC_VOLTAGE {
  HW_PMU_VDCDC_VOLTAGE_1V10 = 0, HW_PMU_VDCDC_VOLTAGE_1V15 = 1, HW_PMU_VDCDC_VOLTAGE_1V20 = 2, HW_PMU_VDCDC_VOLTAGE_1V25 = 3,
  HW_PMU_VDCDC_VOLTAGE_1V30 = 4, HW_PMU_VDCDC_VOLTAGE_1V35 = 5, HW_PMU_VDCDC_VOLTAGE_1V40 = 6, HW_PMU_VDCDC_VOLTAGE_1V45 = 7
}
 Voltage level options for VDCDC rail applicable in active state. More...
 
enum  HW_PMU_VDCDC_MAX_LOAD { HW_PMU_VDCDC_MAX_DCDC_LOAD_0_300 = 0, HW_PMU_VDCDC_MAX_LDO_LOAD_1 = 1, HW_PMU_VDCDC_MAX_DCDC_LOAD_40 = 2, HW_PMU_VDCDC_MAX_LDO_LOAD_40 = 3 }
 Maximum load current options for the VDCDC power rail. More...
 
enum  HW_PMU_VDD_VOLTAGE {
  HW_PMU_VDD_VOLTAGE_0V90 = 0, HW_PMU_VDD_VOLTAGE_0V95 = 1, HW_PMU_VDD_VOLTAGE_1V00 = 2, HW_PMU_VDD_VOLTAGE_1V05 = 3,
  HW_PMU_VDD_VOLTAGE_1V10 = 4, HW_PMU_VDD_VOLTAGE_1V15 = 5, HW_PMU_VDD_VOLTAGE_1V20 = 6, HW_PMU_VDD_VOLTAGE_1V25 = 7,
  HW_PMU_VDD_VOLTAGE_SLEEP_0V75 = 8, HW_PMU_VDD_VOLTAGE_SLEEP_0V90 = 9, HW_PMU_VDD_VOLTAGE_INVALID
}
 Voltage level options for VDD rail. More...
 
enum  HW_PMU_VDD_MAX_LOAD { HW_PMU_VDD_MAX_LOAD_20 = 0, HW_PMU_VDD_MAX_LOAD_0_400 = 1 }
 Maximum load current options for the 1V8 power rail. More...
 

Functions

HW_PMU_ERROR_CODE hw_pmu_1v8_onwakeup_enable (HW_PMU_1V8_MAX_LOAD max_load)
 Set 1V8 rail wakeup / active configuration. More...
 
HW_PMU_ERROR_CODE hw_pmu_1v8_onwakeup_disable (void)
 Disable 1V8 rail in wakeup / active state. More...
 
HW_PMU_ERROR_CODE hw_pmu_1v8_onsleep_enable (HW_PMU_1V8_MAX_LOAD max_load)
 Enable 1V8 rail in sleep state. More...
 
HW_PMU_ERROR_CODE hw_pmu_1v8_onsleep_disable (void)
 Disable 1V8 rail in sleep state. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_1v8_active_config (HW_PMU_1V8_RAIL_CONFIG *rail_config)
 Get the 1V8 rail active state configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_1v8_onwakeup_config (HW_PMU_1V8_RAIL_CONFIG *rail_config)
 Get the 1V8 rail wakeup configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_1v8_onsleep_config (HW_PMU_1V8_RAIL_CONFIG *rail_config)
 Get the 1V8 rail sleep configuration. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdcdc_set_voltage (HW_PMU_VDCDC_VOLTAGE voltage)
 Set the voltage level of VDCDC rail. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdcdc_onwakeup_enable (HW_PMU_VDCDC_MAX_LOAD max_load)
 Set VDCDC rail wakeup / active configuration. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdcdc_onwakeup_disable (void)
 Disable VDCDC rail in wakeup / active state. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdcdc_onsleep_enable (HW_PMU_VDCDC_MAX_LOAD max_load)
 Enable the VDCDC rail in sleep state. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdcdc_onsleep_disable (void)
 Disable VDCDC rail in sleep state. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdcdc_active_config (HW_PMU_VDCDC_RAIL_CONFIG *rail_config)
 Get the VDCDC rail active state configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdcdc_onwakeup_config (HW_PMU_VDCDC_RAIL_CONFIG *rail_config)
 Get the VDCDC rail wakeup configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdcdc_onsleep_config (HW_PMU_VDCDC_RAIL_CONFIG *rail_config)
 Get the VDCDC rail sleep configuration. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdd_set_voltage (HW_PMU_VDD_VOLTAGE voltage)
 Set the voltage level of VDD rail. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdd_onwakeup_enable (HW_PMU_VDD_MAX_LOAD max_load)
 Set VDD rail wakeup / active configuration. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdd_onwakeup_disable (void)
 Disable VDD rail in wakeup / active state. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdd_onsleep_enable (HW_PMU_VDD_MAX_LOAD max_load)
 Enable VDD rail in sleep state. More...
 
HW_PMU_ERROR_CODE hw_pmu_vdd_onsleep_disable (void)
 Disable VDD rail in sleep state. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdd_active_config (HW_PMU_VDD_RAIL_CONFIG *rail_config)
 Get the VDD rail active state configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdd_onwakeup_config (HW_PMU_VDD_RAIL_CONFIG *rail_config)
 Get the VDD rail wakeup configuration. More...
 
HW_PMU_POWER_RAIL_STATE hw_pmu_get_vdd_onsleep_config (HW_PMU_VDD_RAIL_CONFIG *rail_config)
 Get the VDD rail sleep configuration. More...
 

Detailed Description

Power Manager header file for DA1459x.

Copyright (C) 2019-2023 Renesas Electronics Corporation and/or its affiliates. All rights reserved. Confidential Information.

This software ("Software") is supplied by Renesas Electronics Corporation and/or its affiliates ("Renesas"). Renesas grants you a personal, non-exclusive, non-transferable, revocable, non-sub-licensable right and license to use the Software, solely if used in or together with Renesas products. You may make copies of this Software, provided this copyright notice and disclaimer ("Notice") is included in all such copies. Renesas reserves the right to change or discontinue the Software at any time without notice.

THE SOFTWARE IS PROVIDED "AS IS". RENESAS DISCLAIMS ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. TO THE MAXIMUM EXTENT PERMITTED UNDER LAW, IN NO EVENT SHALL RENESAS BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE, EVEN IF RENESAS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. USE OF THIS SOFTWARE MAY BE SUBJECT TO TERMS AND CONDITIONS CONTAINED IN AN ADDITIONAL AGREEMENT BETWEEN YOU AND RENESAS. IN CASE OF CONFLICT BETWEEN THE TERMS OF THIS NOTICE AND ANY SUCH ADDITIONAL LICENSE AGREEMENT, THE TERMS OF THE AGREEMENT SHALL TAKE PRECEDENCE. BY CONTINUING TO USE THIS SOFTWARE, YOU AGREE TO THE TERMS OF THIS NOTICE.IF YOU DO NOT AGREE TO THESE TERMS, YOU ARE NOT PERMITTED TO USE THIS SOFTWARE.