cfn_sal_dev_proximity.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_SAL_DEV_PROXIMITY_H
#define CAFFEINE_SAL_DEV_PROXIMITY_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_sal.h"
 
/* Defines ----------------------------------------------------------*/
 
#define CFN_SAL_DEV_TYPE_PROXIMITY CFN_SAL_TYPE('P', 'R', 'X')
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_SAL_DEV_PROXIMITY_EVENT_NONE           = 0,
    CFN_SAL_DEV_PROXIMITY_EVENT_DATA_READY     = CFN_HAL_BIT(0),
    CFN_SAL_DEV_PROXIMITY_EVENT_THRESHOLD_HIGH = CFN_HAL_BIT(1),
    CFN_SAL_DEV_PROXIMITY_EVENT_THRESHOLD_LOW  = CFN_HAL_BIT(2),
    CFN_SAL_DEV_PROXIMITY_EVENT_AWAY           = CFN_HAL_BIT(3),
    CFN_SAL_DEV_PROXIMITY_EVENT_CLOSE          = CFN_HAL_BIT(4),
} cfn_sal_dev_proximity_event_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    uint32_t sampling_rate_hz;
    uint32_t led_current_ma;
    uint32_t led_duty_cycle;
    uint32_t integration_time_ms;
    uint32_t high_threshold;
    uint32_t low_threshold;
    bool     sunlight_cancellation_enable;
    void    *custom;
} cfn_sal_dev_proximity_config_t;
 
typedef struct cfn_sal_dev_proximity_s     cfn_sal_dev_proximity_t;
typedef struct cfn_sal_dev_proximity_api_s cfn_sal_dev_proximity_api_t;
 
typedef void (*cfn_sal_dev_proximity_callback_t)(cfn_sal_dev_proximity_t *driver,
                                                 uint32_t                 event,
                                                 uint32_t                 error,
                                                 void                    *user_arg);
 
struct cfn_sal_dev_proximity_api_s
{
    cfn_hal_api_base_t base;
 
    /* Measurement Operations */
    cfn_hal_error_code_t (*read_distance_mm)(cfn_sal_dev_proximity_t *driver, float *mm_out);
    cfn_hal_error_code_t (*read_raw)(cfn_sal_dev_proximity_t *driver, uint32_t *raw_out);
 
    /* Feature Data Retrieval */
    cfn_hal_error_code_t (*get_status)(cfn_sal_dev_proximity_t *driver, uint32_t *status_flags);
    cfn_hal_error_code_t (*get_id)(cfn_sal_dev_proximity_t *driver, uint32_t *id_out);
 
    void (*handle_interrupt)(cfn_sal_dev_proximity_t *driver);
};
 
CFN_HAL_VMT_CHECK(struct cfn_sal_dev_proximity_api_s);
 
CFN_SAL_CREATE_DRIVER_TYPE(sal_dev_proximity,
                           cfn_sal_dev_proximity_config_t,
                           cfn_sal_dev_proximity_api_t,
                           cfn_sal_phy_t,
                           cfn_sal_dev_proximity_callback_t);
 
/* Functions inline ------------------------------------------------- */
 
CFN_HAL_INLINE void cfn_sal_dev_proximity_populate(cfn_sal_dev_proximity_t              *driver,
                                                   uint32_t                              peripheral_id,
                                                   void                                 *dependency,
                                                   const cfn_sal_dev_proximity_api_t    *api,
                                                   const cfn_sal_phy_t                  *phy,
                                                   const cfn_sal_dev_proximity_config_t *config,
                                                   cfn_sal_dev_proximity_callback_t      callback,
                                                   void                                 *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_SAL_DEV_TYPE_PROXIMITY, peripheral_id, NULL, dependency, api, phy, config, callback, user_arg);
}
 
cfn_hal_error_code_t cfn_sal_dev_proximity_construct(cfn_sal_dev_proximity_t              *driver,
                                                     const cfn_sal_dev_proximity_config_t *config,
                                                     const cfn_sal_phy_t                  *phy,
                                                     void                                 *dependency,
                                                     cfn_sal_dev_proximity_callback_t      callback,
                                                     void                                 *user_arg);
cfn_hal_error_code_t cfn_sal_dev_proximity_destruct(cfn_sal_dev_proximity_t *driver);
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_init(cfn_sal_dev_proximity_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_PROXIMITY);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_deinit(cfn_sal_dev_proximity_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_SAL_DEV_TYPE_PROXIMITY);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_config_set(cfn_sal_dev_proximity_t              *driver,
                                                                     const cfn_sal_dev_proximity_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_PROXIMITY, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_config_get(cfn_sal_dev_proximity_t        *driver,
                                                                     cfn_sal_dev_proximity_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_proximity_callback_register(cfn_sal_dev_proximity_t         *driver,
                                                                            cfn_sal_dev_proximity_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_PROXIMITY, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_power_state_set(cfn_sal_dev_proximity_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_PROXIMITY, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_enable(cfn_sal_dev_proximity_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_PROXIMITY, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_disable(cfn_sal_dev_proximity_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_PROXIMITY, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_get(cfn_sal_dev_proximity_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_PROXIMITY, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_enable(cfn_sal_dev_proximity_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_PROXIMITY, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_disable(cfn_sal_dev_proximity_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_PROXIMITY, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_get(cfn_sal_dev_proximity_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_PROXIMITY, error_mask);
}
 
/* Service Specific Functions --------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_read_distance_mm(cfn_sal_dev_proximity_t *driver,
                                                                           float                   *mm_out)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_PROXIMITY, read_distance_mm, driver, error, mm_out);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_read_raw(cfn_sal_dev_proximity_t *driver, uint32_t *raw_out)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_PROXIMITY, read_raw, driver, error, raw_out);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_get_status(cfn_sal_dev_proximity_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_PROXIMITY, get_status, driver, error, status_flags);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_get_id(cfn_sal_dev_proximity_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_PROXIMITY, get_id, driver, error, id_out);
    return error;
}
 
CFN_HAL_INLINE void cfn_sal_dev_proximity_handle_interrupt(cfn_sal_dev_proximity_t *driver)
{
    if (driver && driver->base.type == CFN_SAL_DEV_TYPE_PROXIMITY && driver->api)
    {
        if (driver->api->handle_interrupt)
        {
            driver->api->handle_interrupt(driver);
        }
    }
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* CAFFEINE_SAL_DEV_PROXIMITY_H */