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_proximity.h File Reference

Abstract Proximity Sensor service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures

struct  cfn_sal_dev_proximity_config_t
 
struct  cfn_sal_dev_proximity_api_s
 Proximity Sensor Virtual Method Table (VMT). More...
 

Macros

#define CFN_SAL_DEV_TYPE_PROXIMITY   CFN_SAL_TYPE('P', 'R', 'X')
 

Typedefs

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)
 

Enumerations

enum  cfn_sal_dev_proximity_event_t {
  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)
}
 

Functions

 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)
 
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_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)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_deinit (cfn_sal_dev_proximity_t *driver)
 
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)
 
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)
 
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)
 
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)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_enable (cfn_sal_dev_proximity_t *driver, uint32_t 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)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_get (cfn_sal_dev_proximity_t *driver, uint32_t *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)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_disable (cfn_sal_dev_proximity_t *driver, uint32_t 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)
 
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_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_read_raw (cfn_sal_dev_proximity_t *driver, uint32_t *raw_out)
 
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_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_get_id (cfn_sal_dev_proximity_t *driver, uint32_t *id_out)
 
CFN_HAL_INLINE void cfn_sal_dev_proximity_handle_interrupt (cfn_sal_dev_proximity_t *driver)
 

Detailed Description

Abstract Proximity Sensor service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_PROXIMITY

#define CFN_SAL_DEV_TYPE_PROXIMITY   CFN_SAL_TYPE('P', 'R', 'X')

Typedef Documentation

◆ cfn_sal_dev_proximity_api_t

typedef struct cfn_sal_dev_proximity_api_s cfn_sal_dev_proximity_api_t

◆ cfn_sal_dev_proximity_callback_t

typedef void(* cfn_sal_dev_proximity_callback_t) (cfn_sal_dev_proximity_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_proximity_t

typedef struct cfn_sal_dev_proximity_s cfn_sal_dev_proximity_t

Enumeration Type Documentation

◆ cfn_sal_dev_proximity_event_t

enum cfn_sal_dev_proximity_event_t
Enumerator
CFN_SAL_DEV_PROXIMITY_EVENT_NONE 
CFN_SAL_DEV_PROXIMITY_EVENT_DATA_READY 
CFN_SAL_DEV_PROXIMITY_EVENT_THRESHOLD_HIGH 
CFN_SAL_DEV_PROXIMITY_EVENT_THRESHOLD_LOW 
CFN_SAL_DEV_PROXIMITY_EVENT_AWAY 
CFN_SAL_DEV_PROXIMITY_EVENT_CLOSE 

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_proximity_api_s  )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

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   
)

◆ cfn_sal_dev_proximity_callback_register()

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 
)

◆ cfn_sal_dev_proximity_config_get()

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 
)

◆ cfn_sal_dev_proximity_config_set()

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 
)

◆ cfn_sal_dev_proximity_construct()

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_sal_dev_proximity_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_deinit ( cfn_sal_dev_proximity_t *  driver)

◆ cfn_sal_dev_proximity_destruct()

cfn_hal_error_code_t cfn_sal_dev_proximity_destruct ( cfn_sal_dev_proximity_t *  driver)

◆ cfn_sal_dev_proximity_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_disable ( cfn_sal_dev_proximity_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_proximity_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_enable ( cfn_sal_dev_proximity_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_proximity_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_error_get ( cfn_sal_dev_proximity_t *  driver,
uint32_t *  error_mask 
)

◆ cfn_sal_dev_proximity_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_disable ( cfn_sal_dev_proximity_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_proximity_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_enable ( cfn_sal_dev_proximity_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_proximity_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_event_get ( cfn_sal_dev_proximity_t *  driver,
uint32_t *  event_mask 
)

◆ cfn_sal_dev_proximity_get_id()

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_sal_dev_proximity_get_status()

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_sal_dev_proximity_handle_interrupt()

CFN_HAL_INLINE void cfn_sal_dev_proximity_handle_interrupt ( cfn_sal_dev_proximity_t *  driver)

◆ cfn_sal_dev_proximity_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_init ( cfn_sal_dev_proximity_t *  driver)

◆ cfn_sal_dev_proximity_populate()

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_sal_dev_proximity_power_state_set()

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 
)

◆ cfn_sal_dev_proximity_read_distance_mm()

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_sal_dev_proximity_read_raw()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_proximity_read_raw ( cfn_sal_dev_proximity_t *  driver,
uint32_t *  raw_out 
)
Generated by doxygen 1.9.8