COMP Handle Management

Macros
#define	__HAL_COMP_RESET_HANDLE_STATE(__HANDLE__)
	Reset COMP handle state.
#define	COMP_CLEAR_ERRORCODE(__HANDLE__)
	Clear COMP error code (set it to no error code "HAL_COMP_ERROR_NONE").
#define	__HAL_COMP_ENABLE(__HANDLE__)
	Enable the specified comparator.
#define	__HAL_COMP_DISABLE(__HANDLE__)
	Disable the specified comparator.
#define	__HAL_COMP_LOCK(__HANDLE__)
	Lock the specified comparator configuration.
#define	__HAL_COMP_IS_LOCKED(__HANDLE__)
	Check whether the specified comparator is locked.

Detailed Description

Macro Definition Documentation

__HAL_COMP_DISABLE

#define __HAL_COMP_DISABLE

(

__HANDLE__

)

Value:

CLEAR_BIT((__HANDLE__)->Instance->CFGR, COMP_CFGRx_EN)

Disable the specified comparator.

Parameters

__HANDLE__

COMP handle

Return values

None

__HAL_COMP_ENABLE

#define __HAL_COMP_ENABLE

(

__HANDLE__

)

Value:

SET_BIT((__HANDLE__)->Instance->CFGR, COMP_CFGRx_EN)

Enable the specified comparator.

Parameters

__HANDLE__

COMP handle

Return values

None

__HAL_COMP_IS_LOCKED

#define __HAL_COMP_IS_LOCKED

(

__HANDLE__

)

Value:

(READ_BIT((__HANDLE__)->Instance->CFGR, COMP_CFGRx_LOCK) == COMP_CFGRx_LOCK)

Check whether the specified comparator is locked.

Parameters

__HANDLE__

COMP handle

Return values

Value

0 if COMP instance is not locked, value 1 if COMP instance is locked

__HAL_COMP_LOCK

#define __HAL_COMP_LOCK

(

__HANDLE__

)

Value:

SET_BIT((__HANDLE__)->Instance->CFGR, COMP_CFGRx_LOCK)

Lock the specified comparator configuration.

Note

Using this macro induce HAL COMP handle state machine being no more in line with COMP instance state. To keep HAL COMP handle state machine updated, it is recommended to use function "HAL_COMP_Lock')".

Parameters

__HANDLE__

COMP handle

Return values

None

__HAL_COMP_RESET_HANDLE_STATE

#define __HAL_COMP_RESET_HANDLE_STATE

(

__HANDLE__

)

Value:

((__HANDLE__)->State = HAL_COMP_STATE_RESET)

Reset COMP handle state.

Parameters

__HANDLE__

COMP handle

Return values

None

COMP_CLEAR_ERRORCODE

#define COMP_CLEAR_ERRORCODE

(

__HANDLE__

)

Value:

((__HANDLE__)->ErrorCode = HAL_COMP_ERROR_NONE)

Clear COMP error code (set it to no error code "HAL_COMP_ERROR_NONE").

Parameters

__HANDLE__

COMP handle

Return values

None