cfn_sal_dev_magnetometer.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_SAL_DEV_MAGNETOMETER_H
#define CAFFEINE_SAL_DEV_MAGNETOMETER_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_sal.h"
 
/* Defines ----------------------------------------------------------*/
 
#define CFN_SAL_DEV_TYPE_MAGNETOMETER CFN_SAL_TYPE('M', 'A', 'G')
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_SAL_DEV_MAGNETOMETER_RANGE_4G,  
    CFN_SAL_DEV_MAGNETOMETER_RANGE_8G,  
    CFN_SAL_DEV_MAGNETOMETER_RANGE_12G, 
    CFN_SAL_DEV_MAGNETOMETER_RANGE_16G, 
    CFN_SAL_DEV_MAGNETOMETER_RANGE_MAX
} cfn_sal_dev_magnetometer_range_t;
 
typedef enum
{
    CFN_SAL_DEV_MAGNETOMETER_MODE_POWER_DOWN,
    CFN_SAL_DEV_MAGNETOMETER_MODE_CONTINUOUS,
    CFN_SAL_DEV_MAGNETOMETER_MODE_ONE_SHOT,
} cfn_sal_dev_magnetometer_mode_t;
 
typedef enum
{
    CFN_SAL_DEV_MAGNETOMETER_EVENT_NONE       = 0,
    CFN_SAL_DEV_MAGNETOMETER_EVENT_DATA_READY = CFN_HAL_BIT(0),
} cfn_sal_dev_magnetometer_event_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    int32_t x_ugauss; 
    int32_t y_ugauss;
    int32_t z_ugauss;
} cfn_sal_dev_magnetometer_data_t;
 
typedef struct
{
    uint32_t sampling_rate_hz;
    void    *custom;
} cfn_sal_dev_magnetometer_config_t;
 
typedef struct cfn_sal_dev_magnetometer_s     cfn_sal_dev_magnetometer_t;
typedef struct cfn_sal_dev_magnetometer_api_s cfn_sal_dev_magnetometer_api_t;
 
typedef void (*cfn_sal_dev_magnetometer_callback_t)(cfn_sal_dev_magnetometer_t *driver,
                                                    uint32_t                    event,
                                                    uint32_t                    error,
                                                    void                       *user_arg);
 
struct cfn_sal_dev_magnetometer_api_s
{
    cfn_hal_api_base_t base;
 
    /* Measurement Operations */
    cfn_hal_error_code_t (*read_xyz_ugauss)(cfn_sal_dev_magnetometer_t      *driver,
                                            cfn_sal_dev_magnetometer_data_t *data_out);
    cfn_hal_error_code_t (*read_xyz_raw)(cfn_sal_dev_magnetometer_t *driver, int16_t *x, int16_t *y, int16_t *z);
 
    /* Configuration */
    cfn_hal_error_code_t (*set_range)(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t range);
    cfn_hal_error_code_t (*get_range)(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_range_t *range_out);
    cfn_hal_error_code_t (*set_mode)(cfn_sal_dev_magnetometer_t *driver, cfn_sal_dev_magnetometer_mode_t mode);
    cfn_hal_error_code_t (*set_datarate)(cfn_sal_dev_magnetometer_t *driver, uint32_t hz);
    cfn_hal_error_code_t (*soft_reset)(cfn_sal_dev_magnetometer_t *driver);
    cfn_hal_error_code_t (*get_status)(cfn_sal_dev_magnetometer_t *driver, uint32_t *status_flags);
};
 
CFN_HAL_VMT_CHECK(struct cfn_sal_dev_magnetometer_api_s);
 
CFN_SAL_CREATE_DRIVER_TYPE(sal_dev_magnetometer,
                           cfn_sal_dev_magnetometer_config_t,
                           cfn_sal_dev_magnetometer_api_t,
                           cfn_sal_phy_t,
                           cfn_sal_dev_magnetometer_callback_t);
 
/* Functions inline ------------------------------------------------- */
 
CFN_HAL_INLINE void cfn_sal_dev_magnetometer_populate(cfn_sal_dev_magnetometer_t              *driver,
                                                      uint32_t                                 peripheral_id,
                                                      void                                    *dependency,
                                                      const cfn_sal_dev_magnetometer_api_t    *api,
                                                      const cfn_sal_phy_t                     *phy,
                                                      const cfn_sal_dev_magnetometer_config_t *config,
                                                      cfn_sal_dev_magnetometer_callback_t      callback,
                                                      void                                    *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_SAL_DEV_TYPE_MAGNETOMETER, peripheral_id, NULL, dependency, api, phy, config, callback, user_arg);
}
 
cfn_hal_error_code_t cfn_sal_dev_magnetometer_construct(cfn_sal_dev_magnetometer_t              *driver,
                                                        const cfn_sal_dev_magnetometer_config_t *config,
                                                        const cfn_sal_phy_t                     *phy,
                                                        void                                    *dependency,
                                                        cfn_sal_dev_magnetometer_callback_t      callback,
                                                        void                                    *user_arg);
cfn_hal_error_code_t cfn_sal_dev_magnetometer_destruct(cfn_sal_dev_magnetometer_t *driver);
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_magnetometer_init(cfn_sal_dev_magnetometer_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_MAGNETOMETER);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_magnetometer_deinit(cfn_sal_dev_magnetometer_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_SAL_DEV_TYPE_MAGNETOMETER);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_magnetometer_read_xyz_ugauss(cfn_sal_dev_magnetometer_t      *driver,
                                                                             cfn_sal_dev_magnetometer_data_t *data_out)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_MAGNETOMETER, read_xyz_ugauss, driver, error, data_out);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_magnetometer_set_range(cfn_sal_dev_magnetometer_t      *driver,
                                                                       cfn_sal_dev_magnetometer_range_t range)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_MAGNETOMETER, set_range, driver, error, range);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_magnetometer_set_mode(cfn_sal_dev_magnetometer_t     *driver,
                                                                      cfn_sal_dev_magnetometer_mode_t mode)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_SAL_DEV_TYPE_MAGNETOMETER, set_mode, driver, error, mode);
    return error;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* CAFFEINE_SAL_DEV_MAGNETOMETER_H */