cfn_hal_comp.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_COMP_H
#define CAFFEINE_HAL_HAL_COMP_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"
 
/* Defines ----------------------------------------------------------*/
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_COMP_EVENT_NONE    = 0,
    CFN_HAL_COMP_EVENT_TRIGGER = CFN_HAL_BIT(0), 
} cfn_hal_comp_event_t;
 
typedef enum
{
    CFN_HAL_COMP_ERROR_NONE    = 0,
    CFN_HAL_COMP_ERROR_GENERAL = CFN_HAL_BIT(0), 
} cfn_hal_comp_error_t;
 
typedef enum
{
    CFN_HAL_COMP_LEVEL_LOW = 0,
    CFN_HAL_COMP_LEVEL_HIGH
} cfn_hal_comp_level_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    void                      *instance;    
    cfn_hal_gpio_pin_handle_t *input_plus;  
    cfn_hal_gpio_pin_handle_t *input_minus; 
    cfn_hal_gpio_pin_handle_t *output;      
    void                      *user_arg;    
} cfn_hal_comp_phy_t;
 
typedef struct
{
    void *user_config; 
} cfn_hal_comp_config_t;
 
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);
 
struct cfn_hal_comp_api_s
{
    cfn_hal_api_base_t base;
 
    /* COMP Specific Extensions */
    cfn_hal_error_code_t (*read_output)(cfn_hal_comp_t *driver, cfn_hal_comp_level_t *level);
    cfn_hal_error_code_t (*set_threshold)(cfn_hal_comp_t *driver, uint32_t threshold);
    cfn_hal_error_code_t (*start)(cfn_hal_comp_t *driver);
    cfn_hal_error_code_t (*stop)(cfn_hal_comp_t *driver);
};
 
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);
 
/* Functions inline ------------------------------------------------- */
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_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_COMP, peripheral_id, clock, dependency, api, phy, config, callback, 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)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_init(cfn_hal_comp_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    driver->base.vmt           = (const struct cfn_hal_api_base_s *) driver->api;
    cfn_hal_error_code_t error = cfn_hal_comp_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_deinit(cfn_hal_comp_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP);
}
 
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)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_comp_config_validate(driver, config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    {
        driver->config = config;
    }
    return cfn_hal_base_config_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_config_get(cfn_hal_comp_t *driver, cfn_hal_comp_config_t *config)
{
    if (!driver || !config || !driver->config)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    *config = *(driver->config);
    return CFN_HAL_ERROR_OK;
}
 
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)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    {
        driver->cb          = callback;
        driver->cb_user_arg = user_arg;
    }
    return cfn_hal_base_callback_register(
        &driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, (cfn_hal_callback_t) callback, user_arg);
}
 
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)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_power_state_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_enable(cfn_hal_comp_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_disable(cfn_hal_comp_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_event_get(cfn_hal_comp_t *driver, uint32_t *event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_enable(cfn_hal_comp_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_disable(cfn_hal_comp_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_error_get(cfn_hal_comp_t *driver, uint32_t *error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_COMP, error_mask);
}
 
/* COMP Specific Functions ------------------------------------------ */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_read_output(cfn_hal_comp_t *driver, cfn_hal_comp_level_t *level)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_COMP, read_output, driver, error, level);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_set_threshold(cfn_hal_comp_t *driver, uint32_t threshold)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_COMP, set_threshold, driver, error, threshold);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_start(cfn_hal_comp_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_COMP, start, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_comp_stop(cfn_hal_comp_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_COMP, stop, driver, error);
    return error;
}
 
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);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_COMP_H