xt-sdk 文档
v1.0.3
xt-sdk 嵌入式 SDK API 参考
Toggle main menu visibility
载入中...
搜索中...
未找到
xt_hal_adc.h
浏览该文件的文档.
1
12
13
#ifndef __XT_HAL_ADC_H__
14
#define __XT_HAL_ADC_H__
15
16
/* ==================== [Includes] ========================================== */
17
18
#include "
xt_hal_internal.h
"
19
20
#ifdef __cplusplus
21
extern
"C"
{
22
#endif
23
30
31
/* ==================== [Defines] =========================================== */
32
33
#define XT_HAL_ADC_INVALID_ID (0xFF)
34
35
/* ==================== [Typedefs] ========================================== */
36
40
enum
xt_hal_adc_event_id
{
41
XT_HAL_ADC_EVENT_BATCH_DONE
= 0x00,
42
XT_HAL_ADC_EVENT_ERROR
,
43
};
44
51
typedef
void (*
xt_hal_adc_cb_t
)(uint8_t adc_id, uint32_t event_id);
52
56
struct
xt_hal_adc_result
{
57
void
*
rx_buffer
;
58
size_t
size
;
59
};
60
61
/* ==================== [Global Prototypes] ================================= */
62
71
xt_err_t
xt_hal_adc_setup
(uint8_t adc_id, uint8_t res_bits, uint16_t vref_mv);
72
79
xt_err_t
xt_hal_adc_close
(uint8_t adc_id);
80
87
int32_t
xt_hal_adc_get_verf_mv
(uint8_t adc_id);
88
95
int32_t
xt_hal_adc_get_raw
(uint8_t adc_id);
96
103
int32_t
xt_hal_adc_get_mv
(uint8_t adc_id);
104
112
xt_err_t
xt_hal_adc_set_cb
(uint8_t adc_id,
xt_hal_adc_cb_t
cb);
113
125
xt_err_t
xt_hal_adc_setup_continuous
(
126
uint8_t adc_id, uint8_t res_bits, uint16_t vref_mv, uint32_t sample_freq_hz);
127
134
xt_err_t
xt_hal_adc_close_continuous
(uint8_t adc_id);
135
144
xt_err_t
xt_hal_adc_rx_continuous
(uint8_t adc_id,
void
*rx_buffer,
size_t
size);
145
152
xt_err_t
xt_hal_adc_stop_continuous
(uint8_t adc_id);
153
163
xt_err_t
xt_hal_adc_get_result
(
164
uint8_t adc_id,
struct
xt_hal_adc_result
*result);
165
166
/* ==================== [Macros] ============================================ */
167
/* xt_hal_adc */
169
170
#ifdef __cplusplus
171
}
/* extern "C" */
172
#endif
173
174
#endif
/* __XT_HAL_ADC_H__ */
xt_err_t
int32_t xt_err_t
错误码类型
定义
xt_error.h:38
xt_hal_adc_event_id
xt_hal_adc_event_id
ADC 事件 ID 枚举
定义
xt_hal_adc.h:40
xt_hal_adc_close_continuous
xt_err_t xt_hal_adc_close_continuous(uint8_t adc_id)
关闭 ADC 连续采样模式
xt_hal_adc_get_result
xt_err_t xt_hal_adc_get_result(uint8_t adc_id, struct xt_hal_adc_result *result)
获取 ADC 连续采样结果
xt_hal_adc_get_raw
int32_t xt_hal_adc_get_raw(uint8_t adc_id)
获取 ADC 原始采样值
xt_hal_adc_close
xt_err_t xt_hal_adc_close(uint8_t adc_id)
关闭 ADC(单次采样模式)
xt_hal_adc_set_cb
xt_err_t xt_hal_adc_set_cb(uint8_t adc_id, xt_hal_adc_cb_t cb)
设置 ADC 回调函数
xt_hal_adc_get_mv
int32_t xt_hal_adc_get_mv(uint8_t adc_id)
获取 ADC 转换后的电压值
xt_hal_adc_rx_continuous
xt_err_t xt_hal_adc_rx_continuous(uint8_t adc_id, void *rx_buffer, size_t size)
启动 ADC 连续接收
xt_hal_adc_get_verf_mv
int32_t xt_hal_adc_get_verf_mv(uint8_t adc_id)
获取 ADC 参考电压
xt_hal_adc_cb_t
void(* xt_hal_adc_cb_t)(uint8_t adc_id, uint32_t event_id)
ADC 回调函数类型定义
定义
xt_hal_adc.h:51
xt_hal_adc_stop_continuous
xt_err_t xt_hal_adc_stop_continuous(uint8_t adc_id)
停止 ADC 连续采样
xt_hal_adc_setup
xt_err_t xt_hal_adc_setup(uint8_t adc_id, uint8_t res_bits, uint16_t vref_mv)
初始化 ADC(单次采样模式)
xt_hal_adc_setup_continuous
xt_err_t xt_hal_adc_setup_continuous(uint8_t adc_id, uint8_t res_bits, uint16_t vref_mv, uint32_t sample_freq_hz)
初始化 ADC 连续采样模式
XT_HAL_ADC_EVENT_ERROR
@ XT_HAL_ADC_EVENT_ERROR
定义
xt_hal_adc.h:42
XT_HAL_ADC_EVENT_BATCH_DONE
@ XT_HAL_ADC_EVENT_BATCH_DONE
定义
xt_hal_adc.h:41
xt_hal_adc_result
ADC 连续传输结果结构体
定义
xt_hal_adc.h:56
xt_hal_adc_result::rx_buffer
void * rx_buffer
定义
xt_hal_adc.h:57
xt_hal_adc_result::size
size_t size
定义
xt_hal_adc.h:58
xt_hal_internal.h
XTINY HAL 内部公共头文件
platforms
components
xtiny
xt_hal
xt_hal_adc.h
生成于
, 为 xt-sdk 文档使用
1.17.0