模拟数字转换器。更多...

adc 的协作图:

结构体
struct	_xf_hal_adc_config_t
	adc 配置结构体。更多...

类型定义
typedef uint32_t	xf_adc_num_t
	adc 序号。

typedef enum _xf_hal_adc_cmd_t	xf_hal_adc_cmd_t
	adc 命令枚举。

typedef struct _xf_hal_adc_config_t	xf_hal_adc_config_t
	adc 配置结构体。

枚举
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 }
	adc 命令枚举。更多...

函数
xf_err_t	xf_hal_adc_init (xf_adc_num_t adc_num)
	adc 初始化函数。

xf_err_t	xf_hal_adc_deinit (xf_adc_num_t adc_num)
	adc 反初始化函数。

xf_err_t	xf_hal_adc_enable (xf_adc_num_t adc_num)
	adc 启用函数。

xf_err_t	xf_hal_adc_disable (xf_adc_num_t adc_num)
	adc 禁用函数。

xf_err_t	xf_hal_adc_set_resolution (xf_adc_num_t adc_num, uint8_t resolution)
	adc 设置分辨率。

xf_err_t	xf_hal_adc_set_sample_rate (xf_adc_num_t adc_num, uint32_t sample_rate)
	adc 设置采样率。

uint32_t	xf_hal_adc_read_raw (xf_adc_num_t adc_num)
	adc读取的原始值,最大值为 2^resolution

详细描述

模拟数字转换器。

类型定义说明

◆ xf_adc_num_t

typedef uint32_t xf_adc_num_t

adc 序号。

在文件 xf_hal_adc.h 第 41 行定义.

◆ xf_hal_adc_cmd_t

typedef enum _xf_hal_adc_cmd_t xf_hal_adc_cmd_t

adc 命令枚举。

用于对接 adc 设置的命令。

注解: 普通用户可忽略，移植者需注意。

◆ xf_hal_adc_config_t

typedef struct _xf_hal_adc_config_t xf_hal_adc_config_t

adc 配置结构体。

用于对接 adc 设置的参数。

注解: 普通用户可忽略，移植者需注意。

枚举类型说明

◆ _xf_hal_adc_cmd_t

enum _xf_hal_adc_cmd_t

adc 命令枚举。

用于对接 adc 设置的命令。

注解: 普通用户可忽略，移植者需注意。

枚举值
XF_HAL_ADC_CMD_DEFAULT	默认参数命令，在创建设备时优先执行
XF_HAL_ADC_CMD_ENABLE	启用命令，见 xf_hal_adc_config_t::enable
XF_HAL_ADC_CMD_RESOLUTION	分辨率命令，见 xf_hal_adc_config_t::resolution
XF_HAL_ADC_CMD_SAMPLE_RATE	采样率命令，见 xf_hal_adc_config_t::sample_rate
XF_HAL_ADC_CMD_ALL	默认设置命令，在创建设备时其次执行

在文件 xf_hal_adc.h 第 50 行定义.

函数说明

◆ xf_hal_adc_init()

xf_err_t xf_hal_adc_init ( xf_adc_num_t adc_num )

adc 初始化函数。

使用 adc 之前必须要进行初始化。

参数

adc_num adc 的序号

返回

xf_err_t

XF_OK 成功初始化
other 初始化失败

在文件 xf_hal_adc.c 第 50 行定义.

◆ xf_hal_adc_deinit()

xf_err_t xf_hal_adc_deinit ( xf_adc_num_t adc_num )

adc 反初始化函数。

恢复到未初始化状态，且回收内部申请的相关资源。

参数

adc_num adc 的序号

返回

xf_err_t

XF_OK 成功反初始化
XF_ERR_UNINIT 该 adc 未初始化
other 反初始化失败

在文件 xf_hal_adc.c 第 58 行定义.

◆ xf_hal_adc_enable()

xf_err_t xf_hal_adc_enable ( xf_adc_num_t adc_num )

adc 启用函数。

ADC 配置好功能后，可以调用 adc 启用函数进行激活。

注解: 激活后，方可使用 xf_hal_adc_read_raw() 函数。激活之前的配置是静态配置。激活之后的配置属于动态配置，不一定所有的芯片都支持动态配置。

参数

adc_num adc 的序号

返回

xf_err_t

XF_OK 成功启用
XF_ERR_UNINIT 该 adc 未初始化
other 启用失败

在文件 xf_hal_adc.c 第 72 行定义.

◆ xf_hal_adc_disable()

xf_err_t xf_hal_adc_disable ( xf_adc_num_t adc_num )

adc 禁用函数。

注解: 如果 adc 正在启用状态，且不支持动态配置，则需要使用该函数禁用 adc 后在此配置并用 xf_hal_adc_enable() 启用。

参数

adc_num adc 的序号

返回

xf_err_t

XF_OK 成功禁用
XF_ERR_UNINIT 该 adc 未初始化
other 禁用失败

在文件 xf_hal_adc.c 第 97 行定义.

◆ xf_hal_adc_set_resolution()

xf_err_t xf_hal_adc_set_resolution	(	xf_adc_num_t	adc_num,
		uint8_t	resolution
	)

adc 设置分辨率。

注解: 不是所有芯片都支持分辨率设置。

参数

adc_num	adc 的序号
resolution	如果为 10，则获取到的值的范围为 0 ~ 2^10 之间

返回

xf_err_t

XF_OK 设置成功
XF_ERR_UNINIT 该 adc 未初始化
XF_ERR_NOT_SUPPORTED 不支持该功能
other 设置失败

在文件 xf_hal_adc.c 第 122 行定义.

◆ xf_hal_adc_set_sample_rate()

xf_err_t xf_hal_adc_set_sample_rate	(	xf_adc_num_t	adc_num,
		uint32_t	sample_rate
	)

adc 设置采样率。

注解: 并不是所有芯片都支持采样率设置。

参数

adc_num	adc 的序号
sample_rate	采样率，1s 中所采集 adc 的次数，单位为 hz

返回

xf_err_t

XF_OK 设置成功
XF_ERR_UNINIT 该 adc 未初始化
XF_ERR_NOT_SUPPORTED 不支持该功能
other 设置失败

在文件 xf_hal_adc.c 第 149 行定义.

◆ xf_hal_adc_read_raw()

uint32_t xf_hal_adc_read_raw ( xf_adc_num_t adc_num )

adc读取的原始值,最大值为 2^resolution

参数

adc_num adc 的序号

返回: uint32_t 获取的 adc 数值

在文件 xf_hal_adc.c 第 176 行定义.