alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-25 01:37:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(brownout): correct names comments in the LL driver

Browse Source
This commit is contained in:
morris
2024-08-06 13:15:30 +08:00
parent e62133ad8e
commit 9716d9e5ca
27 changed files with 214 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
components/hal/esp32s3/include/hal/brownout_ll.h
View File

@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@@ -12,20 +12,24 @@
#pragma once
#include <stdbool.h>
#include "esp_bit_defs.h"
#include "soc/rtc_cntl_struct.h"
#include "hal/regi2c_ctrl.h"
#include "hal/psdet_types.h"
#include "soc/regi2c_brownout.h"
#define BROWNOUT_DETECTOR_LL_FIB_ENABLE (BIT(1))
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief power down the flash when a brown out happens.
* @brief suspend the flash when a brown out happens.
*
* @param enable true: power down flash. false: not power down
* @param enable true: suspend flash. false: not suspend
*/
static inline void brownout_ll_enable_flash_power_down(bool enable)
static inline void brownout_ll_enable_flash_suspend(bool enable)
{
RTCCNTL.brown_out.close_flash_ena = enable;
}
@@ -33,7 +37,7 @@ static inline void brownout_ll_enable_flash_power_down(bool enable)
/**
* @brief power down the RF circuits when a brown out happens
*
* @param enable true: power down. false: not power done.
* @param enable true: power down. false: not power down.
*/
static inline void brownout_ll_enable_rf_power_down(bool enable)
{
@@ -41,23 +45,24 @@ static inline void brownout_ll_enable_rf_power_down(bool enable)
}
/**
* @brief Enable this to reset brown out
* @brief Configure the brown out detector to do a hardware reset
*
* @note: If brown out interrupt is used, this should be disabled.
* @note: If brown out interrupt is also used, the hardware reset can be disabled,
* because we can call software reset in the interrupt handler.
*
* @param reset_ena true: enable reset. false: disable reset.
* @param reset_wait brown out reset wait cycles
* @param select 1: chip reset, 0: system reset
* @param reset_level reset level
*/
static inline void brownout_ll_reset_config(bool reset_ena, uint32_t reset_wait, uint8_t select)
static inline void brownout_ll_reset_config(bool reset_ena, uint32_t reset_wait, brownout_reset_level_t reset_level)
{
RTCCNTL.brown_out.rst_wait = reset_wait;
RTCCNTL.brown_out.rst_ena = reset_ena;
RTCCNTL.brown_out.rst_sel = select;
RTCCNTL.brown_out.rst_sel = reset_level;
}
/**
* @brief Set brown out threshold
* @brief Set brown out threshold voltage
*
* @param threshold brownout threshold
*/
@@ -97,12 +102,15 @@ static inline void brownout_ll_intr_enable(bool enable)
}
/**
* @brief Enable brownout hardware reset
* @brief Enable brownout hardware reset (mode1)
*
* @param enable
* @param enable true: enable, false: disable
*/
static inline void brownout_ll_ana_reset_enable(bool enable)
{
// give BOD mode1 control permission to the software
RTCCNTL.fib_sel.val &= ~BROWNOUT_DETECTOR_LL_FIB_ENABLE;
// then we can enable or disable if we want the BOD mode1 to reset the system
RTCCNTL.brown_out.ana_rst_en = enable;
}