caffeine-hal 0.6.6
A Header-Defined Interface c library, it provides the hal layer for the Caffeine framework
Loading...
Searching...
No Matches
Data Structures | Typedefs | Enumerations | Functions
cfn_hal_comp.h File Reference

Analog Comparator (COMP) HAL API. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures

struct  cfn_hal_comp_phy_t
 COMP hardware physical mapping. More...
 
struct  cfn_hal_comp_config_t
 COMP configuration structure. More...
 
struct  cfn_hal_comp_api_s
 COMP Virtual Method Table (VMT). More...
 

Typedefs

typedef struct cfn_hal_comp_s cfn_hal_comp_t
 
typedef struct cfn_hal_comp_api_s cfn_hal_comp_api_t
 
typedef void(* cfn_hal_comp_callback_t) (cfn_hal_comp_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
 COMP callback signature.
 

Enumerations

enum  cfn_hal_comp_event_t { CFN_HAL_COMP_EVENT_NONE = 0 , CFN_HAL_COMP_EVENT_TRIGGER = CFN_HAL_BIT(0) }
 COMP nominal event flags. More...
 
enum  cfn_hal_comp_error_t { CFN_HAL_COMP_ERROR_NONE = 0 , CFN_HAL_COMP_ERROR_GENERAL = CFN_HAL_BIT(0) }
 COMP exception error flags. More...
 
enum  cfn_hal_comp_level_t { CFN_HAL_COMP_LEVEL_LOW = 0 , CFN_HAL_COMP_LEVEL_HIGH }
 COMP output levels. More...
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_hal_comp_api_s)
 
 CFN_HAL_CREATE_DRIVER_TYPE (comp, cfn_hal_comp_config_t, cfn_hal_comp_api_t, cfn_hal_comp_phy_t, cfn_hal_comp_callback_t)
 
CFN_HAL_INLINE void cfn_hal_comp_populate (cfn_hal_comp_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_comp_api_t *api, const cfn_hal_comp_phy_t *phy, const cfn_hal_comp_config_t *config, cfn_hal_comp_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_validate (const cfn_hal_comp_t *driver, const cfn_hal_comp_config_t *config)
 Validates the Comparator configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_init (cfn_hal_comp_t *driver)
 Initializes the Comparator driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_deinit (cfn_hal_comp_t *driver)
 Deinitializes the Comparator driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_set (cfn_hal_comp_t *driver, const cfn_hal_comp_config_t *config)
 Sets the Comparator configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_get (cfn_hal_comp_t *driver, cfn_hal_comp_config_t *config)
 Gets the current Comparator configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_callback_register (cfn_hal_comp_t *driver, const cfn_hal_comp_callback_t callback, void *user_arg)
 Registers a callback for Comparator events and errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_power_state_set (cfn_hal_comp_t *driver, cfn_hal_power_state_t state)
 Sets the Comparator power state.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_enable (cfn_hal_comp_t *driver, uint32_t event_mask)
 Enables one or more Comparator nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_disable (cfn_hal_comp_t *driver, uint32_t event_mask)
 Disables one or more Comparator nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_get (cfn_hal_comp_t *driver, uint32_t *event_mask)
 Retrieves the current Comparator nominal event status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_enable (cfn_hal_comp_t *driver, uint32_t error_mask)
 Enables one or more Comparator exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_disable (cfn_hal_comp_t *driver, uint32_t error_mask)
 Disables one or more Comparator exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_get (cfn_hal_comp_t *driver, uint32_t *error_mask)
 Retrieves the current Comparator exception error status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_read_output (cfn_hal_comp_t *driver, cfn_hal_comp_level_t *level)
 Reads the immediate logical output of the comparator.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_set_threshold (cfn_hal_comp_t *driver, uint32_t threshold)
 Dynamically adjusts the reference threshold (if supported by hardware).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_start (cfn_hal_comp_t *driver)
 Enables/Starts the comparator operation.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_stop (cfn_hal_comp_t *driver)
 Disables/Stops the comparator operation.
 
cfn_hal_error_code_t cfn_hal_comp_construct (cfn_hal_comp_t *driver, const cfn_hal_comp_config_t *config, const cfn_hal_comp_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_comp_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_hal_comp_destruct (cfn_hal_comp_t *driver)
 

Detailed Description

Analog Comparator (COMP) HAL API.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

◆ cfn_hal_comp_api_t

◆ cfn_hal_comp_callback_t

typedef void(* cfn_hal_comp_callback_t) (cfn_hal_comp_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

COMP callback signature.

Parameters
driverPointer to the COMP driver instance.
event_maskMask of triggered nominal events.
error_maskMask of triggered exception errors.
user_argUser-defined argument passed during registration.

◆ cfn_hal_comp_t

typedef struct cfn_hal_comp_s cfn_hal_comp_t

Enumeration Type Documentation

◆ cfn_hal_comp_error_t

COMP exception error flags.

Enumerator
CFN_HAL_COMP_ERROR_NONE 
CFN_HAL_COMP_ERROR_GENERAL 

General hardware error

◆ cfn_hal_comp_event_t

COMP nominal event flags.

Enumerator
CFN_HAL_COMP_EVENT_NONE 
CFN_HAL_COMP_EVENT_TRIGGER 

Comparator output triggered (crossed threshold)

◆ cfn_hal_comp_level_t

COMP output levels.

Enumerator
CFN_HAL_COMP_LEVEL_LOW 
CFN_HAL_COMP_LEVEL_HIGH 

Function Documentation

◆ cfn_hal_comp_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_callback_register ( cfn_hal_comp_t driver,
const cfn_hal_comp_callback_t  callback,
void *  user_arg 
)

Registers a callback for Comparator events and errors.

Parameters
driverPointer to the COMP driver instance.
callbackThe callback function to register.
user_argUser-defined argument passed to the callback.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_get ( cfn_hal_comp_t driver,
cfn_hal_comp_config_t config 
)

Gets the current Comparator configuration.

Parameters
driverPointer to the COMP driver instance.
config[out] Pointer to store the configuration.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_set ( cfn_hal_comp_t driver,
const cfn_hal_comp_config_t config 
)

Sets the Comparator configuration.

Parameters
driverPointer to the COMP driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_validate ( const cfn_hal_comp_t driver,
const cfn_hal_comp_config_t config 
)

Validates the Comparator configuration.

Parameters
driverPointer to the COMP driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_construct()

cfn_hal_error_code_t cfn_hal_comp_construct ( cfn_hal_comp_t driver,
const cfn_hal_comp_config_t config,
const cfn_hal_comp_phy_t phy,
struct cfn_hal_clock_s *  clock,
void *  dependency,
cfn_hal_comp_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_comp_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_deinit ( cfn_hal_comp_t driver)

Deinitializes the Comparator driver.

Parameters
driverPointer to the COMP driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_destruct()

cfn_hal_error_code_t cfn_hal_comp_destruct ( cfn_hal_comp_t driver)

◆ cfn_hal_comp_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_disable ( cfn_hal_comp_t driver,
uint32_t  error_mask 
)

Disables one or more Comparator exception errors.

Parameters
driverPointer to the COMP driver instance.
error_maskMask of errors to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_enable ( cfn_hal_comp_t driver,
uint32_t  error_mask 
)

Enables one or more Comparator exception errors.

Parameters
driverPointer to the COMP driver instance.
error_maskMask of errors to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_get ( cfn_hal_comp_t driver,
uint32_t *  error_mask 
)

Retrieves the current Comparator exception error status.

Parameters
driverPointer to the COMP driver instance.
error_mask[out] Pointer to store the error mask.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_disable ( cfn_hal_comp_t driver,
uint32_t  event_mask 
)

Disables one or more Comparator nominal events.

Parameters
driverPointer to the COMP driver instance.
event_maskMask of events to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_enable ( cfn_hal_comp_t driver,
uint32_t  event_mask 
)

Enables one or more Comparator nominal events.

Parameters
driverPointer to the COMP driver instance.
event_maskMask of events to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_get ( cfn_hal_comp_t driver,
uint32_t *  event_mask 
)

Retrieves the current Comparator nominal event status.

Parameters
driverPointer to the COMP driver instance.
event_mask[out] Pointer to store the event mask.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_init ( cfn_hal_comp_t driver)

Initializes the Comparator driver.

Parameters
driverPointer to the COMP driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_populate()

CFN_HAL_INLINE void cfn_hal_comp_populate ( cfn_hal_comp_t driver,
uint32_t  peripheral_id,
struct cfn_hal_clock_s *  clock,
void *  dependency,
const cfn_hal_comp_api_t api,
const cfn_hal_comp_phy_t phy,
const cfn_hal_comp_config_t config,
cfn_hal_comp_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_comp_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_power_state_set ( cfn_hal_comp_t driver,
cfn_hal_power_state_t  state 
)

Sets the Comparator power state.

Parameters
driverPointer to the COMP driver instance.
stateTarget power state.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_read_output()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_read_output ( cfn_hal_comp_t driver,
cfn_hal_comp_level_t level 
)

Reads the immediate logical output of the comparator.

Parameters
driverPointer to the COMP driver instance.
level[out] Pointer to store the current output level.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_set_threshold()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_set_threshold ( cfn_hal_comp_t driver,
uint32_t  threshold 
)

Dynamically adjusts the reference threshold (if supported by hardware).

Parameters
driverPointer to the COMP driver instance.
thresholdThe new threshold value to set.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_start ( cfn_hal_comp_t driver)

Enables/Starts the comparator operation.

Parameters
driverPointer to the COMP driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_comp_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_stop ( cfn_hal_comp_t driver)

Disables/Stops the comparator operation.

Parameters
driverPointer to the COMP driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE ( comp  ,
cfn_hal_comp_config_t  ,
cfn_hal_comp_api_t  ,
cfn_hal_comp_phy_t  ,
cfn_hal_comp_callback_t   
)

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_hal_comp_api_s  )