cfn_hal_clock.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_CLOCK_H
#define CAFFEINE_HAL_HAL_CLOCK_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_types.h"
 
/* Defines ----------------------------------------------------------*/
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_CLOCK_EVENT_NONE  = 0,
    CFN_HAL_CLOCK_EVENT_READY = CFN_HAL_BIT(0), 
} cfn_hal_clock_event_t;
 
typedef enum
{
    CFN_HAL_CLOCK_ERROR_NONE     = 0,
    CFN_HAL_CLOCK_ERROR_LSE_FAIL = CFN_HAL_BIT(0), 
    CFN_HAL_CLOCK_ERROR_HSE_FAIL = CFN_HAL_BIT(1), 
    CFN_HAL_CLOCK_ERROR_GENERAL  = CFN_HAL_BIT(2), 
} cfn_hal_clock_error_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    void *user_config; 
} cfn_hal_clock_config_t;
 
typedef struct
{
    void *instance; 
    void *user_arg; 
} cfn_hal_clock_phy_t;
 
typedef struct cfn_hal_clock_s     cfn_hal_clock_t;
typedef struct cfn_hal_clock_api_s cfn_hal_clock_api_t;
 
typedef void (*cfn_hal_clock_callback_t)(cfn_hal_clock_t *driver,
                                         uint32_t         event_mask,
                                         uint32_t         error_mask,
                                         void            *user_arg);
 
struct cfn_hal_clock_api_s
{
    cfn_hal_api_base_t base;
 
    /* Clock Specific Extensions */
    cfn_hal_error_code_t (*suspend_tick)(cfn_hal_clock_t *driver);
    cfn_hal_error_code_t (*resume_tick)(cfn_hal_clock_t *driver);
    cfn_hal_error_code_t (*get_system_freq)(cfn_hal_clock_t *driver, uint32_t *freq_hz);
    cfn_hal_error_code_t (*get_peripheral_freq)(cfn_hal_clock_t *driver, uint32_t peripheral_id, uint32_t *freq_hz);
    cfn_hal_error_code_t (*enable_gate)(cfn_hal_clock_t *driver, uint32_t peripheral_id);
    cfn_hal_error_code_t (*disable_gate)(cfn_hal_clock_t *driver, uint32_t peripheral_id);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_clock_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(
    clock, cfn_hal_clock_config_t, cfn_hal_clock_api_t, cfn_hal_clock_phy_t, cfn_hal_clock_callback_t);
 
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_clock_populate(cfn_hal_clock_t              *driver,
                                           uint32_t                      peripheral_id,
                                           struct cfn_hal_clock_s       *clock,
                                           void                         *dependency,
                                           const cfn_hal_clock_api_t    *api,
                                           const cfn_hal_clock_phy_t    *phy,
                                           const cfn_hal_clock_config_t *config,
                                           cfn_hal_clock_callback_t      callback,
                                           void                         *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_CLOCK, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_config_validate(const cfn_hal_clock_t        *driver,
                                                                  const cfn_hal_clock_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_CLOCK, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_init(cfn_hal_clock_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_clock_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CLOCK);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_deinit(cfn_hal_clock_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CLOCK);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_config_set(cfn_hal_clock_t              *driver,
                                                             const cfn_hal_clock_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    {
        driver->config = config;
    }
    return cfn_hal_base_config_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CLOCK, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_config_get(cfn_hal_clock_t *driver, cfn_hal_clock_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_clock_callback_register(cfn_hal_clock_t               *driver,
                                                                    const cfn_hal_clock_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_CLOCK, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_power_state_set(cfn_hal_clock_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_CLOCK, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_event_enable(cfn_hal_clock_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_CLOCK, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_event_disable(cfn_hal_clock_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_CLOCK, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_event_get(cfn_hal_clock_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_CLOCK, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_error_enable(cfn_hal_clock_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_CLOCK, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_error_disable(cfn_hal_clock_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_CLOCK, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_error_get(cfn_hal_clock_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_CLOCK, error_mask);
}
 
/* Clock Specific Functions ----------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_suspend_tick(cfn_hal_clock_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_CLOCK, suspend_tick, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_resume_tick(cfn_hal_clock_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_CLOCK, resume_tick, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_get_system_freq(cfn_hal_clock_t *driver, uint32_t *freq_hz)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CLOCK, get_system_freq, driver, error, freq_hz);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_get_peripheral_freq(cfn_hal_clock_t *driver,
                                                                      uint32_t         peripheral_id,
                                                                      uint32_t        *freq_hz)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(
        CFN_HAL_PERIPHERAL_TYPE_CLOCK, get_peripheral_freq, driver, error, peripheral_id, freq_hz);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_enable_gate(cfn_hal_clock_t *driver, uint32_t peripheral_id)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CLOCK, enable_gate, driver, error, peripheral_id);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_clock_disable_gate(cfn_hal_clock_t *driver, uint32_t peripheral_id)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CLOCK, disable_gate, driver, error, peripheral_id);
    return error;
}
cfn_hal_error_code_t cfn_hal_clock_construct(cfn_hal_clock_t              *driver,
                                             const cfn_hal_clock_config_t *config,
                                             const cfn_hal_clock_phy_t    *phy,
                                             struct cfn_hal_clock_s       *clock,
                                             void                         *dependency,
                                             cfn_hal_clock_callback_t      callback,
                                             void                         *user_arg);
cfn_hal_error_code_t cfn_hal_clock_destruct(cfn_hal_clock_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_CLOCK_H