caffeine-sal 0.1.17
Header-only polymorphic middleware services layer for the Caffeine Framework
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
cfn_sal_dev_pressure.h File Reference

Abstract Barometric Pressure Sensor service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures

struct  cfn_sal_dev_pressure_config_t
 
struct  cfn_sal_dev_pressure_api_s
 Pressure Sensor Virtual Method Table (VMT). More...
 

Macros

#define CFN_SAL_DEV_TYPE_PRESSURE   CFN_SAL_TYPE('B', 'A', 'R')
 

Typedefs

typedef struct cfn_sal_dev_pressure_s cfn_sal_dev_pressure_t
 
typedef struct cfn_sal_dev_pressure_api_s cfn_sal_dev_pressure_api_t
 
typedef void(* cfn_sal_dev_pressure_callback_t) (cfn_sal_dev_pressure_t *driver, uint32_t event, uint32_t error, void *user_arg)
 

Enumerations

enum  cfn_sal_dev_pressure_mode_t { CFN_SAL_DEV_PRESSURE_MODE_CONTINUOUS , CFN_SAL_DEV_PRESSURE_MODE_ONE_SHOT }
 
enum  cfn_sal_dev_pressure_event_t { CFN_SAL_DEV_PRESSURE_EVENT_NONE = 0 , CFN_SAL_DEV_PRESSURE_EVENT_DATA_READY = CFN_HAL_BIT(0) }
 
enum  cfn_sal_dev_pressure_oversampling_t {
  CFN_SAL_DEV_PRESSURE_OVERSAMPLING_NONE , CFN_SAL_DEV_PRESSURE_OVERSAMPLING_1X , CFN_SAL_DEV_PRESSURE_OVERSAMPLING_2X , CFN_SAL_DEV_PRESSURE_OVERSAMPLING_4X ,
  CFN_SAL_DEV_PRESSURE_OVERSAMPLING_8X , CFN_SAL_DEV_PRESSURE_OVERSAMPLING_16X
}
 
enum  cfn_sal_dev_pressure_filter_t {
  CFN_SAL_DEV_PRESSURE_FILTER_NONE , CFN_SAL_DEV_PRESSURE_FILTER_COEFF_2 , CFN_SAL_DEV_PRESSURE_FILTER_COEFF_4 , CFN_SAL_DEV_PRESSURE_FILTER_COEFF_8 ,
  CFN_SAL_DEV_PRESSURE_FILTER_COEFF_16
}
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_sal_dev_pressure_api_s)
 
 CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_pressure, cfn_sal_dev_pressure_config_t, cfn_sal_dev_pressure_api_t, cfn_sal_phy_t, cfn_sal_dev_pressure_callback_t)
 
CFN_HAL_INLINE void cfn_sal_dev_pressure_populate (cfn_sal_dev_pressure_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_dev_pressure_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_dev_pressure_config_t *config, cfn_sal_dev_pressure_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_pressure_construct (cfn_sal_dev_pressure_t *driver, const cfn_sal_dev_pressure_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_dev_pressure_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_pressure_destruct (cfn_sal_dev_pressure_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_init (cfn_sal_dev_pressure_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_deinit (cfn_sal_dev_pressure_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_config_set (cfn_sal_dev_pressure_t *driver, const cfn_sal_dev_pressure_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_config_get (cfn_sal_dev_pressure_t *driver, cfn_sal_dev_pressure_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_callback_register (cfn_sal_dev_pressure_t *driver, cfn_sal_dev_pressure_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_power_state_set (cfn_sal_dev_pressure_t *driver, cfn_hal_power_state_t state)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_enable (cfn_sal_dev_pressure_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_disable (cfn_sal_dev_pressure_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_get (cfn_sal_dev_pressure_t *driver, uint32_t *event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_enable (cfn_sal_dev_pressure_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_disable (cfn_sal_dev_pressure_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_get (cfn_sal_dev_pressure_t *driver, uint32_t *error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_read_hpa (cfn_sal_dev_pressure_t *driver, float *hpa_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_read_raw (cfn_sal_dev_pressure_t *driver, int32_t *raw_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_altitude (cfn_sal_dev_pressure_t *driver, float sea_level_hpa, float *alt_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_start_conversion (cfn_sal_dev_pressure_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_status (cfn_sal_dev_pressure_t *driver, uint32_t *status_flags)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_id (cfn_sal_dev_pressure_t *driver, uint32_t *id_out)
 
CFN_HAL_INLINE void cfn_sal_dev_pressure_handle_interrupt (cfn_sal_dev_pressure_t *driver)
 

Detailed Description

Abstract Barometric Pressure Sensor service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_PRESSURE

#define CFN_SAL_DEV_TYPE_PRESSURE   CFN_SAL_TYPE('B', 'A', 'R')

Typedef Documentation

◆ cfn_sal_dev_pressure_api_t

◆ cfn_sal_dev_pressure_callback_t

typedef void(* cfn_sal_dev_pressure_callback_t) (cfn_sal_dev_pressure_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_pressure_t

typedef struct cfn_sal_dev_pressure_s cfn_sal_dev_pressure_t

Enumeration Type Documentation

◆ cfn_sal_dev_pressure_event_t

Enumerator
CFN_SAL_DEV_PRESSURE_EVENT_NONE 
CFN_SAL_DEV_PRESSURE_EVENT_DATA_READY 

◆ cfn_sal_dev_pressure_filter_t

Enumerator
CFN_SAL_DEV_PRESSURE_FILTER_NONE 
CFN_SAL_DEV_PRESSURE_FILTER_COEFF_2 
CFN_SAL_DEV_PRESSURE_FILTER_COEFF_4 
CFN_SAL_DEV_PRESSURE_FILTER_COEFF_8 
CFN_SAL_DEV_PRESSURE_FILTER_COEFF_16 

◆ cfn_sal_dev_pressure_mode_t

Enumerator
CFN_SAL_DEV_PRESSURE_MODE_CONTINUOUS 
CFN_SAL_DEV_PRESSURE_MODE_ONE_SHOT 

◆ cfn_sal_dev_pressure_oversampling_t

Enumerator
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_NONE 
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_1X 
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_2X 
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_4X 
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_8X 
CFN_SAL_DEV_PRESSURE_OVERSAMPLING_16X 

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_pressure_api_s  )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE ( sal_dev_pressure  ,
cfn_sal_dev_pressure_config_t  ,
cfn_sal_dev_pressure_api_t  ,
cfn_sal_phy_t  ,
cfn_sal_dev_pressure_callback_t   
)

◆ cfn_sal_dev_pressure_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_callback_register ( cfn_sal_dev_pressure_t driver,
cfn_sal_dev_pressure_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_pressure_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_config_get ( cfn_sal_dev_pressure_t driver,
cfn_sal_dev_pressure_config_t config 
)

◆ cfn_sal_dev_pressure_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_config_set ( cfn_sal_dev_pressure_t driver,
const cfn_sal_dev_pressure_config_t config 
)

◆ cfn_sal_dev_pressure_construct()

cfn_hal_error_code_t cfn_sal_dev_pressure_construct ( cfn_sal_dev_pressure_t driver,
const cfn_sal_dev_pressure_config_t config,
const cfn_sal_phy_t phy,
void *  dependency,
cfn_sal_dev_pressure_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_pressure_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_deinit ( cfn_sal_dev_pressure_t driver)

◆ cfn_sal_dev_pressure_destruct()

cfn_hal_error_code_t cfn_sal_dev_pressure_destruct ( cfn_sal_dev_pressure_t driver)

◆ cfn_sal_dev_pressure_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_disable ( cfn_sal_dev_pressure_t driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_pressure_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_enable ( cfn_sal_dev_pressure_t driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_pressure_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_error_get ( cfn_sal_dev_pressure_t driver,
uint32_t *  error_mask 
)

◆ cfn_sal_dev_pressure_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_disable ( cfn_sal_dev_pressure_t driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_pressure_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_enable ( cfn_sal_dev_pressure_t driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_pressure_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_event_get ( cfn_sal_dev_pressure_t driver,
uint32_t *  event_mask 
)

◆ cfn_sal_dev_pressure_get_altitude()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_altitude ( cfn_sal_dev_pressure_t driver,
float  sea_level_hpa,
float *  alt_out 
)

◆ cfn_sal_dev_pressure_get_id()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_id ( cfn_sal_dev_pressure_t driver,
uint32_t *  id_out 
)

◆ cfn_sal_dev_pressure_get_status()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_get_status ( cfn_sal_dev_pressure_t driver,
uint32_t *  status_flags 
)

◆ cfn_sal_dev_pressure_handle_interrupt()

CFN_HAL_INLINE void cfn_sal_dev_pressure_handle_interrupt ( cfn_sal_dev_pressure_t driver)

◆ cfn_sal_dev_pressure_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_init ( cfn_sal_dev_pressure_t driver)

◆ cfn_sal_dev_pressure_populate()

CFN_HAL_INLINE void cfn_sal_dev_pressure_populate ( cfn_sal_dev_pressure_t driver,
uint32_t  peripheral_id,
void *  dependency,
const cfn_sal_dev_pressure_api_t api,
const cfn_sal_phy_t phy,
const cfn_sal_dev_pressure_config_t config,
cfn_sal_dev_pressure_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_pressure_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_power_state_set ( cfn_sal_dev_pressure_t driver,
cfn_hal_power_state_t  state 
)

◆ cfn_sal_dev_pressure_read_hpa()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_read_hpa ( cfn_sal_dev_pressure_t driver,
float *  hpa_out 
)

◆ cfn_sal_dev_pressure_read_raw()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_read_raw ( cfn_sal_dev_pressure_t driver,
int32_t *  raw_out 
)

◆ cfn_sal_dev_pressure_start_conversion()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_pressure_start_conversion ( cfn_sal_dev_pressure_t driver)