CN / EN

全部 创新产品 应用与设计 文档中心 工具与软件 开发者社区 关于汇顶
文档反馈
感谢关注汇顶文档，期待您的宝贵建议！
感谢您的反馈，祝您愉快！
无匹配项 共计114个匹配页面
文档中心 > GR551x HAL及LL驱动用户手册/ HAL驱动/ HAL COMP通用驱动/ COMP驱动API描述 Copy URL

COMP驱动API描述

COMP驱动的API主要如下：

表 511 COMP驱动的APIs
API类别 API名称 描述
初始化 hal_comp_init() 初始化COMP模块，配置输入源、参考源、参考值等参数，同时调用hal_comp_msp_init完成中断相关配置，初始化COMP状态以及错误码。
hal_comp_deinit() 重置相关COMP相关寄存器、COMP状态、错误码等参数。
hal_comp_msp_init() 初始化COMP模块所使用的NVIC中断。
hal_comp_msp_deinit() 反初始化COMP模块所使用的NVIC中断。
IO操作 hal_comp_start() 开始比较器功能。
hal_comp_stop() 停止比较器功能。
中断处理及回调函数 hal_comp_irq_handler() 中断处理函数。
hal_comp_trigger_callback() 中断回调函数。
状态及错误 hal_comp_get_state() 获取驱动运行状态。
hal_comp_get_error() 获取错误码。
睡眠相关 hal_comp_suspend_reg() 睡眠之前挂起和COMP配置相关的寄存器。
hal_comp_resume_reg() 唤醒时恢复和COMP配置相关的寄存器。

下面章节将对各API进行详细描述。

hal_comp_init

表 512 hal_comp_init接口
函数原型

hal_status_t hal_comp_init(comp_handle_t *p_comp)
功能说明

根据COMP句柄中的指定配置参数初始化COMP模块。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态
备注

hal_comp_deinit

表 513 hal_comp_deinit接口
函数原型

hal_status_t hal_comp_deinit(comp_handle_t *p_comp);
功能说明

将COMP相关寄存器初始化为它们的默认重置值，同时重置比较器的状态和错误码。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态。
备注

hal_comp_msp_init

表 514 hal_comp_msp_init接口
函数原型

void hal_comp_msp_init(comp_handle_t *p_comp)
功能说明

初始化COMP模块所使用的NVIC中断。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

无
备注

该函数为weak类型的空函数，开发者需要重写该API以完成相应的功能。

hal_comp_msp_deinit

表 515 hal_comp_msp_deinit接口
函数原型

void hal_comp_msp_deinit(comp_handle_t *p_comp)
功能说明

反初始化COMP模块所使用的NVIC中断。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

无
备注

该函数为weak类型的空函数，开发者需要重写该API以完成相应的功能。

hal_comp_start

表 516 hal_comp_start接口
函数原型

hal_status_t hal_comp_start(comp_handle_t *p_comp)
功能说明

开始比较器功能，当输入电压高于参考电压，产生COMP中断。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态。
备注

hal_comp_stop

表 517 hal_comp_stop接口
函数原型

hal_status_t hal_comp_stop(comp_handle_t *p_comp)
功能说明

停止比较器功能。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态。
备注

hal_comp_irq_handler

表 518 hal_comp_irq_handler接口
函数原型

void hal_comp_irq_handler(comp_handle_t *p_comp)
功能说明

处理COMP中断请求。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

无
备注

hal_comp_trigger_callback

表 519 hal_comp_trigger_callback接口
函数原型

void hal_comp_trigger_callback(comp_handle_t *p_comp)
功能说明

中断回调函数。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

无
备注

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

hal_comp_get_state

表 520 hal_comp_get_state接口
函数原型

hal_comp_state_t hal_comp_get_state(comp_handle_t *p_comp)
功能说明

获取比较器运行状态。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

COMP状态，值可以是下面中的任意一个：

  • HAL_COMP_STATE_RESET（未初始化）
  • HAL_COMP_STATE_READY（已初始化且空闲）
  • HAL_COMP_STATE_BUSY（忙）
  • HAL_COMP_STATE_ERROR（错误）
备注

hal_comp_get_error

表 521 hal_comp_get_error接口
函数原型

uint32_t hal_comp_get_error(comp_handle_t *p_comp)
功能说明

获取比较器错误码。
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

COMP错误码，值可以是下面中的任意一个：

  • HAL_COMP_ERROR_NONE
  • HAL_COMP_ERROR_TIMEOUT
  • HAL_COMP_ERROR_INVALID_PARAM
备注

hal_comp_suspend_reg

表 522 hal_comp_suspend_reg接口
函数原型

hal_status_t hal_comp_suspend_reg(comp_handle_t *p_comp);
功能说明

睡眠之前挂起和COMP配置相关的寄存器
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态
备注

hal_comp_resume_reg

表 523 hal_comp_resume_reg接口
函数原型

hal_status_t hal_comp_resume_reg(comp_handle_t *p_comp);
功能说明

唤醒时恢复和COMP配置相关的寄存器
输入参数

p_comp：指向comp_handle_t结构体变量的指针，该结构体变量包含指定的COMP模块的配置信息。
返回值

HAL状态
备注

扫描关注

打开微信，使用“扫一扫”即可关注。