ana_cmpr: designed driver layer
This commit is contained in:
laokaiyao
@@ -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