cfn_hal_adc.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_ADC_H
#define CAFFEINE_HAL_HAL_ADC_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_ADC_EVENT_NONE = 0,
    CFN_HAL_ADC_EVENT_EOC  = CFN_HAL_BIT(0), 
} cfn_hal_adc_event_t;
 
typedef enum
{
    CFN_HAL_ADC_ERROR_NONE    = 0,
    CFN_HAL_ADC_ERROR_OVERRUN = CFN_HAL_BIT(0), 
    CFN_HAL_ADC_ERROR_GENERAL = CFN_HAL_BIT(1), 
} cfn_hal_adc_error_t;
 
typedef enum
{
    CFN_HAL_ADC_RESOLUTION_BIT_4 = 0,
    CFN_HAL_ADC_RESOLUTION_BIT_6,
    CFN_HAL_ADC_RESOLUTION_BIT_8,
    CFN_HAL_ADC_RESOLUTION_BIT_10,
    CFN_HAL_ADC_RESOLUTION_BIT_12,
    CFN_HAL_ADC_RESOLUTION_BIT_14,
    CFN_HAL_ADC_RESOLUTION_BIT_16,
    CFN_HAL_ADC_RESOLUTION_BIT_24,
 
    CFN_HAL_ADC_RESOLUTION_BIT_MAX
} cfn_hal_adc_resolution_t;
 
typedef enum
{
    CFN_HAL_ADC_ALIGN_RIGHT = 0,
    CFN_HAL_ADC_ALIGN_LEFT,
 
    CFN_HAL_ADC_ALIGN_MAX
} cfn_hal_adc_align_t;
 
typedef enum
{
    CFN_HAL_SCAN_ENABLED = 0,
    CFN_HAL_SCAN_DISABLED,
 
    CFN_HAL_SCAN_MAX
} cfn_hal_adc_scan_t;
 
typedef enum
{
    CFN_HAL_ADC_MODE_SINGLE = 0,
    CFN_HAL_ADC_MODE_CONTINUOUS,
 
    CFN_HAL_ADC_MODE_MAX
 
} cfn_hal_adc_mode_t;
 
typedef enum
{
    CFN_HAL_ADC_EOC_SINGLE   = CFN_HAL_BIT(0),
    CFN_HAL_ADC_EOC_SEQUENCE = CFN_HAL_BIT(1),
} cfn_hal_adc_eoc_t;
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    void                      *instance; 
    uint32_t                   channel;  
    cfn_hal_gpio_pin_handle_t *gpio;     
    void                      *user_arg; 
} cfn_hal_adc_phy_t;
 
typedef struct
{
    cfn_hal_adc_resolution_t resolution;
    cfn_hal_adc_align_t      alignment;
    cfn_hal_adc_scan_t       scan;
    cfn_hal_adc_mode_t       mode;
    uint32_t                 eoc;
    void                    *custom;
} cfn_hal_adc_config_t;
 
typedef struct cfn_hal_adc_s     cfn_hal_adc_t;
typedef struct cfn_hal_adc_api_s cfn_hal_adc_api_t;
 
typedef void (*cfn_hal_adc_callback_t)(
    cfn_hal_adc_t *driver, uint32_t event_mask, uint32_t error_mask, uint32_t value, void *user_arg);
 
struct cfn_hal_adc_api_s
{
    cfn_hal_api_base_t base;
 
    /* ADC Specific Extensions */
    cfn_hal_error_code_t (*read)(cfn_hal_adc_t *driver, uint32_t *value, uint32_t timeout);
    cfn_hal_error_code_t (*start)(cfn_hal_adc_t *driver);
    cfn_hal_error_code_t (*stop)(cfn_hal_adc_t *driver);
    cfn_hal_error_code_t (*read_dma)(cfn_hal_adc_t *driver, uint32_t *data, size_t nbr_of_samples);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_adc_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(adc, cfn_hal_adc_config_t, cfn_hal_adc_api_t, cfn_hal_adc_phy_t, cfn_hal_adc_callback_t);
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_adc_populate(cfn_hal_adc_t              *driver,
                                         uint32_t                    peripheral_id,
                                         struct cfn_hal_clock_s     *clock,
                                         void                       *dependency,
                                         const cfn_hal_adc_api_t    *api,
                                         const cfn_hal_adc_phy_t    *phy,
                                         const cfn_hal_adc_config_t *config,
                                         cfn_hal_adc_callback_t      callback,
                                         void                       *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_ADC, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_config_validate(const cfn_hal_adc_t        *driver,
                                                                const cfn_hal_adc_config_t *config)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    if ((config->resolution >= CFN_HAL_ADC_RESOLUTION_BIT_MAX) || (config->alignment >= CFN_HAL_ADC_ALIGN_MAX) ||
        (config->scan >= CFN_HAL_SCAN_MAX) || (config->mode >= CFN_HAL_ADC_MODE_MAX))
    {
        return CFN_HAL_ERROR_BAD_CONFIG;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_ADC, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_init(cfn_hal_adc_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_adc_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_ADC);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_deinit(cfn_hal_adc_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_ADC);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_config_set(cfn_hal_adc_t *driver, const cfn_hal_adc_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_adc_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_ADC, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_config_get(cfn_hal_adc_t *driver, cfn_hal_adc_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_adc_callback_register(cfn_hal_adc_t               *driver,
                                                                  const cfn_hal_adc_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_ADC, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_power_state_set(cfn_hal_adc_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_ADC, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_event_enable(cfn_hal_adc_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_ADC, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_event_disable(cfn_hal_adc_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_ADC, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_event_get(cfn_hal_adc_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_ADC, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_error_enable(cfn_hal_adc_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_ADC, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_error_disable(cfn_hal_adc_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_ADC, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_error_get(cfn_hal_adc_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_ADC, error_mask);
}
 
/* ADC Specific Functions ------------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_read(cfn_hal_adc_t *driver, uint32_t *value, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_ADC, read, driver, error, value, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_start(cfn_hal_adc_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_ADC, start, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_stop(cfn_hal_adc_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_ADC, stop, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_adc_read_dma(cfn_hal_adc_t *driver, uint32_t *data, size_t nbr_of_samples)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_ADC, read_dma, driver, error, data, nbr_of_samples);
    return error;
}
 
cfn_hal_error_code_t cfn_hal_adc_construct(cfn_hal_adc_t              *driver,
                                           const cfn_hal_adc_config_t *config,
                                           const cfn_hal_adc_phy_t    *phy,
                                           struct cfn_hal_clock_s     *clock,
                                           void                       *dependency,
                                           cfn_hal_adc_callback_t      callback,
                                           void                       *user_arg);
cfn_hal_error_code_t cfn_hal_adc_destruct(cfn_hal_adc_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_ADC_H