mirror of
https://github.com/espressif/esp-idf.git
synced 2024-09-21 06:56:11 -04:00
83 lines
2.6 KiB
C
83 lines
2.6 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2020-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/*******************************************************************************
|
|
* NOTICE
|
|
* The hal is not public api, don't use in application code.
|
|
* See readme.md in soc/include/hal/readme.md
|
|
******************************************************************************/
|
|
|
|
// The HAL layer for ADC (esp32s2 specific part)
|
|
|
|
#pragma once
|
|
|
|
#include "hal/adc_ll.h"
|
|
#include "hal/adc_types.h"
|
|
|
|
#include_next "hal/adc_hal.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*---------------------------------------------------------------
|
|
Digital controller setting
|
|
---------------------------------------------------------------*/
|
|
/**
|
|
* Reset adc digital controller filter.
|
|
*
|
|
* @param filter_idx ADC filter unit.
|
|
*/
|
|
#define adc_hal_digi_filter_reset(filter_idx) adc_ll_digi_filter_reset(filter_idx)
|
|
|
|
/**
|
|
* Set adc digital controller filter factor.
|
|
*
|
|
* @param filter_idx ADC filter unit.
|
|
* @param filter Filter config. Expression: filter_data = (k-1)/k * last_data + new_data / k. Set values: (2, 4, 8, 16, 64).
|
|
*/
|
|
void adc_hal_digi_filter_set_factor(adc_digi_filter_idx_t filter_idx, adc_digi_filter_t *filter);
|
|
|
|
/**
|
|
* Get adc digital controller filter factor.
|
|
*
|
|
* @param filter_idx ADC filter unit.
|
|
* @param factor Expression: filter_data = (k-1)/k * last_data + new_data / k. Set values: (2, 4, 8, 16, 64).
|
|
*/
|
|
void adc_hal_digi_filter_get_factor(adc_digi_filter_idx_t filter_idx, adc_digi_filter_t *filter);
|
|
|
|
/**
|
|
* Enable/disable adc digital controller filter.
|
|
* Filtering the ADC data to obtain smooth data at higher sampling rates.
|
|
*
|
|
* @note The filter will filter all the enabled channel data of the each ADC unit at the same time.
|
|
* @param filter_idx ADC filter unit.
|
|
* @param enable True to enable the filter, otherwise disable.
|
|
*/
|
|
void adc_hal_digi_filter_enable(adc_digi_filter_idx_t filter_idx, bool enable);
|
|
|
|
/**
|
|
* Config monitor of adc digital controller.
|
|
*
|
|
* @note If the channel info is not supported, the monitor function will not be enabled.
|
|
* @param mon_idx ADC monitor index.
|
|
* @param config Refer to `adc_digi_monitor_t`.
|
|
*/
|
|
void adc_hal_digi_monitor_config(adc_digi_monitor_idx_t mon_idx, adc_digi_monitor_t *config);
|
|
|
|
/**
|
|
* Enable/disable monitor of adc digital controller.
|
|
*
|
|
* @note The monitor will monitor all the enabled channel data of the each ADC unit at the same time.
|
|
* @param mon_idx ADC monitor index.
|
|
* @param enable True to enable the monitor, otherwise disable.
|
|
*/
|
|
void adc_hal_digi_monitor_enable(adc_digi_monitor_idx_t mon_idx, bool enable);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|