cfn_sal_dev_color.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_SAL_DEV_COLOR_H
#define CAFFEINE_SAL_DEV_COLOR_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_sal.h"
 
/* Defines ----------------------------------------------------------*/
 
#define CFN_SAL_DEV_TYPE_COLOR CFN_SAL_TYPE('C', 'L', 'R')
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_SAL_DEV_COLOR_EVENT_NONE           = 0,
    CFN_SAL_DEV_COLOR_EVENT_DATA_READY     = CFN_HAL_BIT(0),
    CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_HIGH = CFN_HAL_BIT(1),
    CFN_SAL_DEV_COLOR_EVENT_THRESHOLD_LOW  = CFN_HAL_BIT(2),
} cfn_sal_dev_color_event_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    uint32_t integration_time_ms;
    bool     auto_range_enable;
    uint32_t high_threshold;
    uint32_t low_threshold;
    uint32_t sampling_rate_hz;
    void    *custom;
} cfn_sal_dev_color_config_t;
 
typedef struct cfn_sal_dev_color_s     cfn_sal_dev_color_t;
typedef struct cfn_sal_dev_color_api_s cfn_sal_dev_color_api_t;
 
typedef void (*cfn_sal_dev_color_callback_t)(cfn_sal_dev_color_t *driver,
                                             uint32_t             event,
                                             uint32_t             error,
                                             void                *user_arg);
 
struct cfn_sal_dev_color_api_s
{
    cfn_hal_api_base_t base;
 
    /* Measurement Operations */
    cfn_hal_error_code_t (*read_xyz)(cfn_sal_dev_color_t *driver, float *x, float *y, float *z);
    cfn_hal_error_code_t (*read_cct)(cfn_sal_dev_color_t *driver, float *cct_k);
    cfn_hal_error_code_t (*read_raw_channels)(
        cfn_sal_dev_color_t *driver, uint32_t *ch0, uint32_t *ch1, uint32_t *ch2, uint32_t *ch3);
 
    /* Data Retrieval */
    cfn_hal_error_code_t (*get_status)(cfn_sal_dev_color_t *driver, uint32_t *status_flags);
    cfn_hal_error_code_t (*get_id)(cfn_sal_dev_color_t *driver, uint32_t *id_out);
 
    void (*handle_interrupt)(cfn_sal_dev_color_t *driver);
};
 
CFN_HAL_VMT_CHECK(struct cfn_sal_dev_color_api_s);
 
CFN_SAL_CREATE_DRIVER_TYPE(
    sal_dev_color, cfn_sal_dev_color_config_t, cfn_sal_dev_color_api_t, cfn_sal_phy_t, cfn_sal_dev_color_callback_t);
 
/* Functions inline ------------------------------------------------- */
 
CFN_HAL_INLINE void cfn_sal_dev_color_populate(cfn_sal_dev_color_t              *driver,
                                               uint32_t                          peripheral_id,
                                               void                             *dependency,
                                               const cfn_sal_dev_color_api_t    *api,
                                               const cfn_sal_phy_t              *phy,
                                               const cfn_sal_dev_color_config_t *config,
                                               cfn_sal_dev_color_callback_t      callback,
                                               void                             *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_SAL_DEV_TYPE_COLOR, peripheral_id, NULL, dependency, api, phy, config, callback, user_arg);
}
 
cfn_hal_error_code_t cfn_sal_dev_color_construct(cfn_sal_dev_color_t              *driver,
                                                 const cfn_sal_dev_color_config_t *config,
                                                 const cfn_sal_phy_t              *phy,
                                                 void                             *dependency,
                                                 cfn_sal_dev_color_callback_t      callback,
                                                 void                             *user_arg);
cfn_hal_error_code_t cfn_sal_dev_color_destruct(cfn_sal_dev_color_t *driver);
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_init(cfn_sal_dev_color_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    driver->base.vmt = (const struct cfn_hal_api_base_s *) driver->api;
    return cfn_hal_base_init(&driver->base, CFN_SAL_DEV_TYPE_COLOR);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_deinit(cfn_sal_dev_color_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_SAL_DEV_TYPE_COLOR);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_config_set(cfn_sal_dev_color_t              *driver,
                                                                 const cfn_sal_dev_color_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    driver->config = config;
    return cfn_hal_base_config_set(&driver->base, CFN_SAL_DEV_TYPE_COLOR, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_config_get(cfn_sal_dev_color_t        *driver,
                                                                 cfn_sal_dev_color_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_sal_dev_color_callback_register(cfn_sal_dev_color_t         *driver,
                                                                        cfn_sal_dev_color_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_SAL_DEV_TYPE_COLOR, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_power_state_set(cfn_sal_dev_color_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_SAL_DEV_TYPE_COLOR, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_enable(cfn_sal_dev_color_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_enable(&driver->base, CFN_SAL_DEV_TYPE_COLOR, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_disable(cfn_sal_dev_color_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_disable(&driver->base, CFN_SAL_DEV_TYPE_COLOR, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_event_get(cfn_sal_dev_color_t *driver, uint32_t *event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_get(&driver->base, CFN_SAL_DEV_TYPE_COLOR, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_enable(cfn_sal_dev_color_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_enable(&driver->base, CFN_SAL_DEV_TYPE_COLOR, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_disable(cfn_sal_dev_color_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_disable(&driver->base, CFN_SAL_DEV_TYPE_COLOR, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_error_get(cfn_sal_dev_color_t *driver, uint32_t *error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_get(&driver->base, CFN_SAL_DEV_TYPE_COLOR, error_mask);
}
 
/* Service Specific Functions --------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_xyz(cfn_sal_dev_color_t *driver,
                                                               float               *x,
                                                               float               *y,
                                                               float               *z)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_COLOR, read_xyz, driver, error, x, y, z);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_cct(cfn_sal_dev_color_t *driver, float *cct_k)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_COLOR, read_cct, driver, error, cct_k);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_read_raw_channels(
    cfn_sal_dev_color_t *driver, uint32_t *ch0, uint32_t *ch1, uint32_t *ch2, uint32_t *ch3)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_COLOR, read_raw_channels, driver, error, ch0, ch1, ch2, ch3);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_get_status(cfn_sal_dev_color_t *driver, uint32_t *status_flags)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_COLOR, get_status, driver, error, status_flags);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_color_get_id(cfn_sal_dev_color_t *driver, uint32_t *id_out)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_COLOR, get_id, driver, error, id_out);
    return error;
}
 
CFN_HAL_INLINE void cfn_sal_dev_color_handle_interrupt(cfn_sal_dev_color_t *driver)
{
    if (driver && driver->base.type == CFN_SAL_DEV_TYPE_COLOR && driver->api)
    {
        if (driver->api->handle_interrupt)
        {
            driver->api->handle_interrupt(driver);
        }
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* CAFFEINE_SAL_DEV_COLOR_H */