mirror of
https://github.com/espressif/esp-idf.git
synced 2025-12-16 04:22:22 +00:00
ana_cmpr: designed driver layer
This commit is contained in:
laokaiyao
299
components/driver/analog_comparator/ana_cmpr.c
Normal file
299
components/driver/analog_comparator/ana_cmpr.c
Normal file
@@ -0,0 +1,299 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <stdlib.h>
|
||||
#include <inttypes.h>
|
||||
#include "sdkconfig.h"
|
||||
#if CONFIG_SDM_ENABLE_DEBUG_LOG
|
||||
// The local log level must be defined before including esp_log.h
|
||||
// Set the maximum log level for this source file
|
||||
#define LOG_LOCAL_LEVEL ESP_LOG_DEBUG
|
||||
#endif
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "clk_tree.h"
|
||||
#include "esp_types.h"
|
||||
#include "esp_attr.h"
|
||||
#include "esp_check.h"
|
||||
#include "esp_pm.h"
|
||||
#include "esp_heap_caps.h"
|
||||
#include "esp_intr_alloc.h"
|
||||
#include "soc/periph_defs.h"
|
||||
#include "soc/ana_cmpr_periph.h"
|
||||
#include "hal/ana_cmpr_ll.h"
|
||||
#include "driver/ana_cmpr.h"
|
||||
#include "esp_private/io_mux.h"
|
||||
#include "esp_private/esp_clk.h"
|
||||
|
||||
struct ana_cmpr_t {
|
||||
ana_cmpr_unit_t unit; /*!< Analog comparator unit id */
|
||||
analog_cmpr_dev_t *dev; /*!< Analog comparator unit device address */
|
||||
bool is_enabled; /*!< Whether the Analog comparator unit is enabled */
|
||||
ana_cmpr_event_callbacks_t cbs; /*!< The callback group that set by user */
|
||||
intr_handle_t intr_handle; /*!< Interrupt handle */
|
||||
void *user_data; /*!< User data that passed to the callbacks */
|
||||
uint32_t src_clk_freq_hz; /*!< Source clock frequency of the Analog Comparator unit */
|
||||
esp_pm_lock_handle_t pm_lock; /*!< The Power Management lock that used to avoid unexpected power down of the clock domain */
|
||||
};
|
||||
|
||||
/* Helper macros */
|
||||
#define ANA_CMPR_NULL_POINTER_CHECK(p) ESP_RETURN_ON_FALSE((p), ESP_ERR_INVALID_ARG, TAG, "input parameter '"#p"' is NULL")
|
||||
#define ANA_CMPR_NULL_POINTER_CHECK_ISR(p) ESP_RETURN_ON_FALSE_ISR((p), ESP_ERR_INVALID_ARG, TAG, "input parameter '"#p"' is NULL")
|
||||
#define ANA_CMPR_UNIT_CHECK(unit) ESP_RETURN_ON_FALSE((unit) >= ANA_CMPR_UNIT_0 && (unit) < SOC_ANA_CMPR_NUM, \
|
||||
ESP_ERR_INVALID_ARG, TAG, "invalid uint number");
|
||||
|
||||
/* Memory allocation caps which decide the section that memory supposed to allocate */
|
||||
#if CONFIG_ANA_CMPR_ISR_IRAM_SAFE
|
||||
#define ANA_CMPR_MEM_ALLOC_CAPS (MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT)
|
||||
#else
|
||||
#define ANA_CMPR_MEM_ALLOC_CAPS MALLOC_CAP_DEFAULT
|
||||
#endif
|
||||
|
||||
/* Driver tag */
|
||||
static const char *TAG = "ana_cmpr";
|
||||
|
||||
/* Global static object of the Analog Comparator unit */
|
||||
static ana_cmpr_handle_t s_ana_cmpr[SOC_ANA_CMPR_NUM] = {
|
||||
[0 ... (SOC_ANA_CMPR_NUM - 1)] = NULL,
|
||||
};
|
||||
|
||||
/* Global spin lock */
|
||||
static portMUX_TYPE s_spinlock = portMUX_INITIALIZER_UNLOCKED;
|
||||
|
||||
static void IRAM_ATTR s_ana_cmpr_default_intr_handler(void *usr_data)
|
||||
{
|
||||
ana_cmpr_handle_t cmpr_handle = (ana_cmpr_handle_t)usr_data;
|
||||
bool need_yield = false;
|
||||
ana_cmpr_cross_event_data_t evt_data;
|
||||
/* Get and clear the interrupt status */
|
||||
uint32_t status = analog_cmpr_ll_get_intr_status(cmpr_handle->dev);
|
||||
analog_cmpr_ll_clear_intr(cmpr_handle->dev, status);
|
||||
|
||||
/* Call the user callback function if it is specified and the corresponding event triggers*/
|
||||
if (cmpr_handle->cbs.on_cross && (status & ANALOG_CMPR_LL_EVENT_CROSS)) {
|
||||
need_yield = cmpr_handle->cbs.on_cross(cmpr_handle, &evt_data, cmpr_handle->user_data);
|
||||
}
|
||||
if (need_yield) {
|
||||
portYIELD_FROM_ISR();
|
||||
}
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_new_unit(const ana_cmpr_config_t *config, ana_cmpr_handle_t *ret_cmpr)
|
||||
{
|
||||
#if CONFIG_SDM_ENABLE_DEBUG_LOG
|
||||
esp_log_level_set(TAG, ESP_LOG_DEBUG);
|
||||
#endif
|
||||
ANA_CMPR_NULL_POINTER_CHECK(config);
|
||||
ANA_CMPR_NULL_POINTER_CHECK(ret_cmpr);
|
||||
ana_cmpr_unit_t unit = config->unit;
|
||||
ANA_CMPR_UNIT_CHECK(unit);
|
||||
ESP_RETURN_ON_FALSE(!s_ana_cmpr[unit], ESP_ERR_INVALID_STATE, TAG,
|
||||
"unit has been allocated already");
|
||||
esp_err_t ret = ESP_OK;
|
||||
|
||||
/* Allocate analog comparator unit */
|
||||
s_ana_cmpr[unit] = (ana_cmpr_handle_t)heap_caps_calloc(1, sizeof(struct ana_cmpr_t), ANA_CMPR_MEM_ALLOC_CAPS);
|
||||
ESP_RETURN_ON_FALSE(s_ana_cmpr[unit], ESP_ERR_NO_MEM, TAG, "no memory for analog comparator struct");
|
||||
|
||||
/* Assign analog comparator unit */
|
||||
s_ana_cmpr[unit]->dev = ANALOG_CMPR_LL_GET_HW();
|
||||
s_ana_cmpr[unit]->is_enabled = false;
|
||||
s_ana_cmpr[unit]->pm_lock = NULL;
|
||||
|
||||
#if CONFIG_PM_ENABLE
|
||||
/* Create PM lock */
|
||||
char lock_name[10] = "ana_cmpr\0";
|
||||
lock_name[8] = '0' + unit;
|
||||
ret = esp_pm_lock_create(ESP_PM_NO_LIGHT_SLEEP, 0, lock_name, &s_ana_cmpr[unit]->pm_lock);
|
||||
ESP_GOTO_ON_ERROR(ret, err, TAG, "create NO_LIGHT_SLEEP, lock failed");
|
||||
#endif
|
||||
|
||||
/* Analog clock comes from IO MUX, but IO MUX clock might be shared with other submodules as well */
|
||||
ESP_GOTO_ON_ERROR(clk_tree_src_get_freq_hz((soc_module_clk_t)config->clk_src,
|
||||
CLK_TREE_SRC_FREQ_PRECISION_CACHED,
|
||||
&s_ana_cmpr[unit]->src_clk_freq_hz),
|
||||
err, TAG, "get source clock frequency failed");
|
||||
ESP_GOTO_ON_ERROR(io_mux_set_clock_source((soc_module_clk_t)(config->clk_src)), err, TAG, "set IO MUX clock source failed");
|
||||
|
||||
/* Configure the register */
|
||||
portENTER_CRITICAL(&s_spinlock);
|
||||
analog_cmpr_ll_ref_source(s_ana_cmpr[unit]->dev, config->ref_src);
|
||||
analog_cmpr_ll_set_cross_intr_type(s_ana_cmpr[unit]->dev, config->intr_type);
|
||||
portEXIT_CRITICAL(&s_spinlock);
|
||||
|
||||
/* Allocate the interrupt, currently the interrupt source of Analog Comparator is shared with GPIO interrupt source */
|
||||
esp_intr_alloc(ETS_GPIO_INTR_SOURCE, ESP_INTR_FLAG_LEVEL1,
|
||||
s_ana_cmpr_default_intr_handler, s_ana_cmpr[unit], &s_ana_cmpr[unit]->intr_handle);
|
||||
|
||||
if (config->ref_src == ANA_CMPR_REF_SRC_INTERNAL) {
|
||||
ESP_LOGD(TAG, "unit %d allocated, source signal: GPIO %d, reference signal: internal",
|
||||
(int)unit, ana_cmpr_io_map[unit].src_gpio);
|
||||
} else {
|
||||
ESP_LOGD(TAG, "unit %d allocated, source signal: GPIO %d, reference signal: GPIO %d",
|
||||
(int)unit, ana_cmpr_io_map[unit].src_gpio, ana_cmpr_io_map[unit].ext_ref_gpio);
|
||||
}
|
||||
|
||||
*ret_cmpr = s_ana_cmpr[unit];
|
||||
return ESP_OK;
|
||||
|
||||
err:
|
||||
/* Free the resources if allocation failed */
|
||||
free(s_ana_cmpr[unit]);
|
||||
s_ana_cmpr[unit] = NULL;
|
||||
return ret;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_del_unit(ana_cmpr_handle_t cmpr)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK(cmpr);
|
||||
/* Search the global object array to check if the input handle is valid */
|
||||
ana_cmpr_unit_t unit = -1;
|
||||
for (int i = 0; i < SOC_ANA_CMPR_NUM; i++) {
|
||||
if (s_ana_cmpr[i] == cmpr) {
|
||||
unit = i;
|
||||
break;
|
||||
}
|
||||
}
|
||||
ESP_RETURN_ON_FALSE(unit >= ANA_CMPR_UNIT_0, ESP_ERR_INVALID_ARG, TAG, "wrong analog comparator handle");
|
||||
ESP_RETURN_ON_FALSE(!cmpr->is_enabled, ESP_ERR_INVALID_STATE, TAG, "this analog comparator unit not disabled yet");
|
||||
|
||||
/* Disable the Analog Comparator interrupt */
|
||||
portENTER_CRITICAL(&s_spinlock);
|
||||
analog_cmpr_ll_enable_intr(cmpr->dev, ANALOG_CMPR_LL_EVENT_CROSS, false);
|
||||
portEXIT_CRITICAL(&s_spinlock);
|
||||
|
||||
/* Delete the pm lock if the unit has */
|
||||
if (cmpr->pm_lock) {
|
||||
ESP_RETURN_ON_ERROR(esp_pm_lock_delete(cmpr->pm_lock), TAG, "delete pm lock failed");
|
||||
}
|
||||
|
||||
/* Free interrupt and other resources */
|
||||
esp_intr_free(cmpr->intr_handle);
|
||||
free(s_ana_cmpr[unit]);
|
||||
s_ana_cmpr[unit] = NULL;
|
||||
|
||||
ESP_LOGD(TAG, "unit %d deleted", (int)unit);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_set_intl_reference(ana_cmpr_handle_t cmpr, const ana_cmpr_intl_ref_config_t *ref_cfg)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK_ISR(cmpr);
|
||||
ANA_CMPR_NULL_POINTER_CHECK_ISR(ref_cfg);
|
||||
|
||||
/* Set internal reference voltage */
|
||||
portENTER_CRITICAL_ISR(&s_spinlock);
|
||||
analog_cmpr_ll_set_internal_ref_voltage(cmpr->dev, ref_cfg->ref_volt);
|
||||
portEXIT_CRITICAL_ISR(&s_spinlock);
|
||||
|
||||
ESP_EARLY_LOGD(TAG, "unit %d internal voltage level %"PRIu32, (int)cmpr->unit, ref_cfg->ref_volt);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_set_debounce(ana_cmpr_handle_t cmpr, const ana_cmpr_debounce_config_t *dbc_cfg)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK_ISR(cmpr);
|
||||
ANA_CMPR_NULL_POINTER_CHECK_ISR(dbc_cfg);
|
||||
|
||||
/* Transfer the time to clock cycles */
|
||||
uint32_t wait_cycle = (uint32_t)(dbc_cfg->wait_us * cmpr->src_clk_freq_hz) / 1000000;
|
||||
/* Set the waiting clock cycles */
|
||||
portENTER_CRITICAL_ISR(&s_spinlock);
|
||||
analog_cmpr_ll_set_debounce_cycle(cmpr->dev, wait_cycle);
|
||||
portEXIT_CRITICAL_ISR(&s_spinlock);
|
||||
|
||||
ESP_EARLY_LOGD(TAG, "unit %d debounce wait cycle %"PRIu32, (int)cmpr->unit, wait_cycle);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_register_event_callbacks(ana_cmpr_handle_t cmpr, const ana_cmpr_event_callbacks_t *cbs, void *user_data)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK(cmpr);
|
||||
ANA_CMPR_NULL_POINTER_CHECK(cbs);
|
||||
ESP_RETURN_ON_FALSE(!cmpr->is_enabled, ESP_ERR_INVALID_STATE, TAG,
|
||||
"please disable the analog comparator before registering the callbacks");
|
||||
|
||||
/* Save the callback group */
|
||||
memcpy(&(cmpr->cbs), cbs, sizeof(ana_cmpr_event_callbacks_t));
|
||||
cmpr->user_data = user_data;
|
||||
|
||||
/* Enable the Analog Comparator interrupt */
|
||||
portENTER_CRITICAL(&s_spinlock);
|
||||
analog_cmpr_ll_enable_intr(cmpr->dev, ANALOG_CMPR_LL_EVENT_CROSS, !!(cbs->on_cross));
|
||||
portEXIT_CRITICAL(&s_spinlock);
|
||||
|
||||
ESP_LOGD(TAG, "unit %d event callback registered", (int)cmpr->unit);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_enable(ana_cmpr_handle_t cmpr)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK(cmpr);
|
||||
ESP_RETURN_ON_FALSE(!cmpr->is_enabled, ESP_ERR_INVALID_STATE, TAG,
|
||||
"the analog comparator has enabled already");
|
||||
/* Update the driver status */
|
||||
cmpr->is_enabled = true;
|
||||
|
||||
/* Acquire the pm lock if the unit has, to avoid the system start light sleep while Analog comparator still working */
|
||||
if (cmpr->pm_lock) {
|
||||
ESP_RETURN_ON_ERROR(esp_pm_lock_acquire(cmpr->pm_lock), TAG, "acquire pm_lock failed");
|
||||
}
|
||||
|
||||
/* Enable the Analog Comparator */
|
||||
portENTER_CRITICAL(&s_spinlock);
|
||||
analog_cmpr_ll_enable(cmpr->dev, true);
|
||||
portEXIT_CRITICAL(&s_spinlock);
|
||||
|
||||
ESP_LOGD(TAG, "unit %d enabled", (int)cmpr->unit);
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_disable(ana_cmpr_handle_t cmpr)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK(cmpr);
|
||||
ESP_RETURN_ON_FALSE(cmpr->is_enabled, ESP_ERR_INVALID_STATE, TAG,
|
||||
"the analog comparator not enabled yet");
|
||||
/* Disable the Analog Comparator */
|
||||
portENTER_CRITICAL(&s_spinlock);
|
||||
analog_cmpr_ll_enable(cmpr->dev, false);
|
||||
portEXIT_CRITICAL(&s_spinlock);
|
||||
|
||||
/* Release the pm lock, allow light sleep then */
|
||||
if (cmpr->pm_lock) {
|
||||
ESP_RETURN_ON_ERROR(esp_pm_lock_release(cmpr->pm_lock), TAG, "release pm_lock failed");
|
||||
}
|
||||
|
||||
/* Update the driver status */
|
||||
cmpr->is_enabled = false;
|
||||
|
||||
ESP_LOGD(TAG, "unit %d disabled", (int)cmpr->unit);
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
esp_err_t ana_cmpr_get_gpio(ana_cmpr_unit_t unit, ana_cmpr_channel_type_t chan_type, int *gpio_num)
|
||||
{
|
||||
ANA_CMPR_NULL_POINTER_CHECK(gpio_num);
|
||||
ANA_CMPR_UNIT_CHECK(unit);
|
||||
|
||||
/* Get the gpio number according to the channel type */
|
||||
switch (chan_type) {
|
||||
case ANA_CMPR_SOURCE_CHAN:
|
||||
*gpio_num = ana_cmpr_io_map[unit].src_gpio;
|
||||
break;
|
||||
case ANA_CMPR_EXT_REF_CHAN:
|
||||
*gpio_num = ana_cmpr_io_map[unit].ext_ref_gpio;
|
||||
break;
|
||||
default:
|
||||
ESP_LOGE(TAG, "invalid channel type");
|
||||
return ESP_ERR_INVALID_ARG;
|
||||
}
|
||||
|
||||
return ESP_OK;
|
||||
}
|
||||
169
components/driver/analog_comparator/include/driver/ana_cmpr.h
Normal file
169
components/driver/analog_comparator/include/driver/ana_cmpr.h
Normal file
@@ -0,0 +1,169 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
#include "esp_err.h"
|
||||
#include "driver/ana_cmpr_types.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Analog comparator unit configuration
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
ana_cmpr_unit_t unit; /*!< Analog comparator unit */
|
||||
ana_cmpr_clk_src_t clk_src; /*!< The clock source of the analog comparator,
|
||||
* which decide the resolution of the comparator
|
||||
*/
|
||||
ana_cmpr_ref_source_t ref_src; /*!< Reference signal source of the comparator,
|
||||
* select using ANA_CMPR_REF_SRC_INTERNAL or ANA_CMPR_REF_SRC_EXTERNAL.
|
||||
* For internal reference, the reference voltage should be set to `internal_ref_volt`,
|
||||
* for external reference, the reference signal should be connect to `ANA_CMPRx_EXT_REF_GPIO`
|
||||
*/
|
||||
ana_cmpr_intr_type_t intr_type; /*!< The crossing types that can trigger interrupt */
|
||||
} ana_cmpr_config_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator internal reference configuration
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
ana_cmpr_ref_voltage_t ref_volt; /*!< The internal reference voltage. It can specify several dozen percent from the VDD power supply,
|
||||
* currently supports 0%~70% VDD with step 10%
|
||||
*/
|
||||
} ana_cmpr_intl_ref_config_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator debounce filter configuration
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
float wait_us; /*!< The wait time of re-enabling the interrupt after the last triggering,
|
||||
* it is used to avoid the spurious triggering while the source signal crossing the reference signal.
|
||||
* The value should regarding how fast the source signal changes, e.g., a rapid signal requires
|
||||
* a small wait time, otherwise the next crosses may be missed.
|
||||
* (Unit: micro second, resolution = 1 / SRC_CLK_FREQ)
|
||||
*/
|
||||
} ana_cmpr_debounce_config_t;
|
||||
|
||||
/**
|
||||
* @brief Group of Analog Comparator callbacks
|
||||
* @note The callbacks are all running under ISR environment
|
||||
* @note When CONFIG_ANA_CMPR_ISR_IRAM_SAFE is enabled, the callback itself and functions called by it should be placed in IRAM.
|
||||
* The variables used in the function should be in the SRAM as well.
|
||||
*/
|
||||
typedef struct {
|
||||
ana_cmpr_cross_cb_t on_cross; /*!< The callback function on cross interrupt */
|
||||
} ana_cmpr_event_callbacks_t;
|
||||
|
||||
/**
|
||||
* @brief Allocating a new analog comparator unit handle
|
||||
*
|
||||
* @param[in] config The config of the analog comparator unit
|
||||
* @param[out] ret_cmpr The returned analog comparator unit handle
|
||||
* @return
|
||||
* - ESP_OK Allocate analog comparator unit handle success
|
||||
* - ESP_ERR_NO_MEM No memory for the analog comparator structure
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters or wrong unit number
|
||||
* - ESP_ERR_INVALID_STATE The unit has been allocated or the clock source has been occupied
|
||||
*/
|
||||
esp_err_t ana_cmpr_new_unit(const ana_cmpr_config_t *config, ana_cmpr_handle_t *ret_cmpr);
|
||||
|
||||
/**
|
||||
* @brief Delete the analog comparator unit handle
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @return
|
||||
* - ESP_OK Delete analog comparator unit handle success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters or wrong unit number
|
||||
* - ESP_ERR_INVALID_STATE The analog comparator is not disabled yet
|
||||
*/
|
||||
esp_err_t ana_cmpr_del_unit(ana_cmpr_handle_t cmpr);
|
||||
|
||||
/**
|
||||
* @brief Set internal reference configuration
|
||||
* @note This function only need to be called when `ana_cmpr_config_t::ref_src`
|
||||
* is ANA_CMPR_REF_SRC_INTERNAL.
|
||||
* @note This function is allowed to run within ISR context including intr callbacks
|
||||
* @note This function will be placed into IRAM if `CONFIG_ANA_CMPR_CTRL_FUNC_IN_IRAM` is on,
|
||||
* so that it's allowed to be executed when Cache is disabled
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @param[in] ref_cfg Internal reference configuration
|
||||
* @return
|
||||
* - ESP_OK Set denounce configuration success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters
|
||||
*/
|
||||
esp_err_t ana_cmpr_set_intl_reference(ana_cmpr_handle_t cmpr, const ana_cmpr_intl_ref_config_t *ref_cfg);
|
||||
|
||||
/**
|
||||
* @brief Set debounce configuration to the analog comparator
|
||||
* @note This function is allowed to run within ISR context including intr callbacks
|
||||
* @note This function will be placed into IRAM if `CONFIG_ANA_CMPR_CTRL_FUNC_IN_IRAM` is on,
|
||||
* so that it's allowed to be executed when Cache is disabled
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @param[in] dbc_cfg Debounce configuration
|
||||
* @return
|
||||
* - ESP_OK Set denounce configuration success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters
|
||||
*/
|
||||
esp_err_t ana_cmpr_set_debounce(ana_cmpr_handle_t cmpr, const ana_cmpr_debounce_config_t *dbc_cfg);
|
||||
|
||||
/**
|
||||
* @brief Register analog comparator interrupt event callbacks
|
||||
* @note This function can only be called before enabling the unit
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @param[in] cbs Group of callback functions
|
||||
* @param[in] user_data The user data that will be passed to callback functions directly
|
||||
* @return
|
||||
* - ESP_OK Register callbacks success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters
|
||||
* - ESP_ERR_INVALID_STATE The analog comparator has been enabled
|
||||
*/
|
||||
esp_err_t ana_cmpr_register_event_callbacks(ana_cmpr_handle_t cmpr, const ana_cmpr_event_callbacks_t *cbs, void *user_data);
|
||||
|
||||
/**
|
||||
* @brief Enable the analog comparator unit
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @return
|
||||
* - ESP_OK Enable analog comparator unit success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters
|
||||
* - ESP_ERR_INVALID_STATE The analog comparator has been enabled
|
||||
*/
|
||||
esp_err_t ana_cmpr_enable(ana_cmpr_handle_t cmpr);
|
||||
|
||||
/**
|
||||
* @brief Disable the analog comparator unit
|
||||
*
|
||||
* @param[in] cmpr The handle of analog comparator unit
|
||||
* @return
|
||||
* - ESP_OK Disable analog comparator unit success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters
|
||||
* - ESP_ERR_INVALID_STATE The analog comparator has disabled already
|
||||
*/
|
||||
esp_err_t ana_cmpr_disable(ana_cmpr_handle_t cmpr);
|
||||
|
||||
/**
|
||||
* @brief Get the specific GPIO number of the analog comparator unit
|
||||
*
|
||||
* @param[in] unit The handle of analog comparator unit
|
||||
* @param[in] chan_type The channel type of analog comparator, like source channel or reference channel
|
||||
* @param[out] gpio_num The output GPIO number of this channel
|
||||
* @return
|
||||
* - ESP_OK Get GPIO success
|
||||
* - ESP_ERR_INVALID_ARG NULL pointer of the parameters or wrong unit number or wrong channel type
|
||||
*/
|
||||
esp_err_t ana_cmpr_get_gpio(ana_cmpr_unit_t unit, ana_cmpr_channel_type_t chan_type, int *gpio_num);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,109 @@
|
||||
/*
|
||||
* SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include "soc/clk_tree_defs.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Analog comparator unit
|
||||
*
|
||||
*/
|
||||
typedef enum {
|
||||
ANA_CMPR_UNIT_0, /*!< Analog Comparator unit */
|
||||
} ana_cmpr_unit_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator reference source
|
||||
*
|
||||
*/
|
||||
typedef enum {
|
||||
ANA_CMPR_REF_SRC_INTERNAL, /*!< Analog Comparator internal reference source, related to VDD */
|
||||
ANA_CMPR_REF_SRC_EXTERNAL, /*!< Analog Comparator external reference source, from `ANA_CMPR0_EXT_REF_GPIO` */
|
||||
} ana_cmpr_ref_source_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator channel type
|
||||
*
|
||||
*/
|
||||
typedef enum {
|
||||
ANA_CMPR_SOURCE_CHAN, /*!< Analog Comparator source channel, which is used to input the signal that to be compared */
|
||||
ANA_CMPR_EXT_REF_CHAN, /*!< Analog Comparator external reference channel, which is used as the reference signal */
|
||||
} ana_cmpr_channel_type_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator interrupt type
|
||||
*
|
||||
*/
|
||||
typedef enum {
|
||||
ANA_CMPR_INTR_DISABLE, /*!< Disable the cross event interrupt */
|
||||
ANA_CMPR_INTR_POS_CROSS, /*!< Enable the positive cross event interrupt */
|
||||
ANA_CMPR_INTR_NEG_CROSS, /*!< Enable the negative cross event interrupt */
|
||||
ANA_CMPR_INTR_ANY_CROSS, /*!< Enable the both positive & negative cross event interrupt */
|
||||
} ana_cmpr_intr_type_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator internal reference voltage
|
||||
*
|
||||
*/
|
||||
typedef enum {
|
||||
ANA_CMPR_REF_VOLT_0_PCT_VDD, /*!< Internal reference voltage equals to 0% VDD */
|
||||
ANA_CMPR_REF_VOLT_10_PCT_VDD, /*!< Internal reference voltage equals to 10% VDD */
|
||||
ANA_CMPR_REF_VOLT_20_PCT_VDD, /*!< Internal reference voltage equals to 20% VDD */
|
||||
ANA_CMPR_REF_VOLT_30_PCT_VDD, /*!< Internal reference voltage equals to 30% VDD */
|
||||
ANA_CMPR_REF_VOLT_40_PCT_VDD, /*!< Internal reference voltage equals to 40% VDD */
|
||||
ANA_CMPR_REF_VOLT_50_PCT_VDD, /*!< Internal reference voltage equals to 50% VDD */
|
||||
ANA_CMPR_REF_VOLT_60_PCT_VDD, /*!< Internal reference voltage equals to 60% VDD */
|
||||
ANA_CMPR_REF_VOLT_70_PCT_VDD, /*!< Internal reference voltage equals to 70% VDD */
|
||||
} ana_cmpr_ref_voltage_t;
|
||||
|
||||
/**
|
||||
* @brief Analog comparator unit handle
|
||||
*
|
||||
*/
|
||||
typedef struct ana_cmpr_t *ana_cmpr_handle_t;
|
||||
|
||||
#if SOC_ANA_CMPR_SUPPORTED
|
||||
/**
|
||||
* @brief Analog comparator clock source
|
||||
*
|
||||
*/
|
||||
typedef soc_periph_ana_cmpr_clk_src_t ana_cmpr_clk_src_t;
|
||||
#else
|
||||
/**
|
||||
* @brief Analog comparator clock source
|
||||
*
|
||||
*/
|
||||
typedef int ana_cmpr_clk_src_t;
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Analog comparator cross event data
|
||||
*
|
||||
*/
|
||||
typedef struct {
|
||||
// Currently no data
|
||||
} ana_cmpr_cross_event_data_t;
|
||||
|
||||
/**
|
||||
* @brief Prototype of Analog comparator event callback
|
||||
* @param[in] cmpr Analog Comparator handle, created from `ana_cmpr_new_unit()`
|
||||
* @param[in] edata Point to Analog Comparator event data. The lifecycle of this pointer memory is inside this function,
|
||||
* user should copy it into static memory if used outside this function. (Currently not use)
|
||||
* @param[in] user_ctx User registered context, passed from `ana_cmpr_register_event_callbacks()`
|
||||
*
|
||||
* @return Whether a high priority task has been waken up by this callback function
|
||||
*/
|
||||
typedef bool (*ana_cmpr_cross_cb_t) (ana_cmpr_handle_t cmpr, const ana_cmpr_cross_event_data_t *edata, void *user_ctx);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
Reference in New Issue
Block a user