xf_hal_adc.h

浏览该文件的文档.

 
#ifndef __XF_HAL_ADC_H__
#define __XF_HAL_ADC_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_ADC_IS_ENABLE
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_adc_num_t;
 
typedef enum _xf_hal_adc_cmd_t {
    XF_HAL_ADC_CMD_DEFAULT      = 0x0,          
    XF_HAL_ADC_CMD_ENABLE       = 0x1 << 0,     
    XF_HAL_ADC_CMD_RESOLUTION   = 0x1 << 1,     
    XF_HAL_ADC_CMD_SAMPLE_RATE  = 0x1 << 2,     
    XF_HAL_ADC_CMD_ALL          = 0x7FFFFFFF, 
} xf_hal_adc_cmd_t;
 
typedef struct _xf_hal_adc_config_t {
    uint32_t enable         : 1;    
    uint32_t resolution     : 5;    
    uint32_t sample_rate    : 26;   
} xf_hal_adc_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_adc_init(xf_adc_num_t adc_num);
 
xf_err_t xf_hal_adc_deinit(xf_adc_num_t adc_num);
 
xf_err_t xf_hal_adc_enable(xf_adc_num_t adc_num);
 
xf_err_t xf_hal_adc_disable(xf_adc_num_t adc_num);
 
xf_err_t xf_hal_adc_set_resolution(xf_adc_num_t adc_num, uint8_t resolution);
 
xf_err_t xf_hal_adc_set_sample_rate(xf_adc_num_t adc_num, uint32_t sample_rate);
 
uint32_t xf_hal_adc_read_raw(xf_adc_num_t adc_num);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // XF_HAL_ADC_IS_ENABLE
 
#endif // __XF_HAL_ADC_H__