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

Abstract Gyroscope service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures

struct  cfn_sal_dev_gyroscope_int_config_t
 
struct  cfn_sal_dev_gyroscope_data_t
 
struct  cfn_sal_dev_gyroscope_config_t
 
struct  cfn_sal_dev_gyroscope_api_s
 Gyroscope Sensor Virtual Method Table (VMT). More...
 

Macros

#define CFN_SAL_DEV_TYPE_GYROSCOPE   CFN_SAL_TYPE('G', 'Y', 'R')
 

Typedefs

typedef struct cfn_sal_dev_gyroscope_s cfn_sal_dev_gyroscope_t
 
typedef struct cfn_sal_dev_gyroscope_api_s cfn_sal_dev_gyroscope_api_t
 
typedef void(* cfn_sal_dev_gyroscope_callback_t) (cfn_sal_dev_gyroscope_t *driver, uint32_t event, uint32_t error, void *user_arg)
 

Enumerations

enum  cfn_sal_dev_gyroscope_event_t { CFN_SAL_DEV_GYROSCOPE_EVENT_NONE = 0 , CFN_SAL_DEV_GYROSCOPE_EVENT_DATA_READY = CFN_HAL_BIT(0) , CFN_SAL_DEV_GYROSCOPE_EVENT_WAKEUP = CFN_HAL_BIT(1) }
 
enum  cfn_sal_dev_gyroscope_mode_t { CFN_SAL_DEV_GYROSCOPE_MODE_NORMAL , CFN_SAL_DEV_GYROSCOPE_MODE_LOW_POWER , CFN_SAL_DEV_GYROSCOPE_MODE_STANDBY , CFN_SAL_DEV_GYROSCOPE_MODE_POWER_DOWN }
 
enum  cfn_sal_dev_gyroscope_range_t {
  CFN_SAL_DEV_GYROSCOPE_RANGE_125DPS , CFN_SAL_DEV_GYROSCOPE_RANGE_250DPS , CFN_SAL_DEV_GYROSCOPE_RANGE_500DPS , CFN_SAL_DEV_GYROSCOPE_RANGE_1000DPS ,
  CFN_SAL_DEV_GYROSCOPE_RANGE_2000DPS
}
 
enum  cfn_sal_dev_gyroscope_odr_t {
  CFN_SAL_DEV_GYROSCOPE_ODR_1_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_10_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_25_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_50_HZ ,
  CFN_SAL_DEV_GYROSCOPE_ODR_100_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_200_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_400_HZ , CFN_SAL_DEV_GYROSCOPE_ODR_1000_HZ
}
 
enum  cfn_sal_dev_gyroscope_bw_t { CFN_SAL_DEV_GYROSCOPE_BW_ODR_DIV_2 , CFN_SAL_DEV_GYROSCOPE_BW_ODR_DIV_4 }
 
enum  cfn_sal_dev_gyroscope_fifo_mode_t { CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_BYPASS , CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_FIFO , CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_STREAM , CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_TRIGGER }
 
enum  cfn_sal_dev_gyroscope_int_pin_t { CFN_SAL_DEV_GYROSCOPE_INT_PIN_1 , CFN_SAL_DEV_GYROSCOPE_INT_PIN_2 }
 
enum  cfn_sal_dev_gyroscope_int_mode_t { CFN_SAL_DEV_GYROSCOPE_INT_MODE_PUSH_PULL , CFN_SAL_DEV_GYROSCOPE_INT_MODE_OPEN_DRAIN }
 
enum  cfn_sal_dev_gyroscope_int_level_t { CFN_SAL_DEV_GYROSCOPE_INT_LEVEL_ACTIVE_LOW , CFN_SAL_DEV_GYROSCOPE_INT_LEVEL_ACTIVE_HIGH }
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_sal_dev_gyroscope_api_s)
 
 CFN_SAL_CREATE_DRIVER_TYPE (sal_dev_gyroscope, cfn_sal_dev_gyroscope_config_t, cfn_sal_dev_gyroscope_api_t, cfn_sal_phy_t, cfn_sal_dev_gyroscope_callback_t)
 
CFN_HAL_INLINE void cfn_sal_dev_gyroscope_populate (cfn_sal_dev_gyroscope_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_dev_gyroscope_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_dev_gyroscope_config_t *config, cfn_sal_dev_gyroscope_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_gyroscope_construct (cfn_sal_dev_gyroscope_t *driver, const cfn_sal_dev_gyroscope_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_dev_gyroscope_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_dev_gyroscope_destruct (cfn_sal_dev_gyroscope_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_init (cfn_sal_dev_gyroscope_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_deinit (cfn_sal_dev_gyroscope_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_config_set (cfn_sal_dev_gyroscope_t *driver, const cfn_sal_dev_gyroscope_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_config_get (cfn_sal_dev_gyroscope_t *driver, cfn_sal_dev_gyroscope_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_callback_register (cfn_sal_dev_gyroscope_t *driver, cfn_sal_dev_gyroscope_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_power_state_set (cfn_sal_dev_gyroscope_t *driver, cfn_hal_power_state_t state)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_enable (cfn_sal_dev_gyroscope_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_disable (cfn_sal_dev_gyroscope_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_get (cfn_sal_dev_gyroscope_t *driver, uint32_t *event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_enable (cfn_sal_dev_gyroscope_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_disable (cfn_sal_dev_gyroscope_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_get (cfn_sal_dev_gyroscope_t *driver, uint32_t *error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_xyz_mdps (cfn_sal_dev_gyroscope_t *driver, cfn_sal_dev_gyroscope_data_t *data_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_xyz_raw (cfn_sal_dev_gyroscope_t *driver, cfn_sal_dev_gyroscope_data_t *data_out)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_fifo (cfn_sal_dev_gyroscope_t *driver, cfn_sal_dev_gyroscope_data_t *data, size_t *count)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_get_status (cfn_sal_dev_gyroscope_t *driver, uint32_t *status_flags)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_get_id (cfn_sal_dev_gyroscope_t *driver, uint32_t *id_out)
 
CFN_HAL_INLINE void cfn_sal_dev_gyroscope_handle_interrupt (cfn_sal_dev_gyroscope_t *driver)
 

Detailed Description

Abstract Gyroscope service interface.

Macro Definition Documentation

◆ CFN_SAL_DEV_TYPE_GYROSCOPE

#define CFN_SAL_DEV_TYPE_GYROSCOPE   CFN_SAL_TYPE('G', 'Y', 'R')

Typedef Documentation

◆ cfn_sal_dev_gyroscope_api_t

typedef struct cfn_sal_dev_gyroscope_api_s cfn_sal_dev_gyroscope_api_t

◆ cfn_sal_dev_gyroscope_callback_t

typedef void(* cfn_sal_dev_gyroscope_callback_t) (cfn_sal_dev_gyroscope_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_dev_gyroscope_t

typedef struct cfn_sal_dev_gyroscope_s cfn_sal_dev_gyroscope_t

Enumeration Type Documentation

◆ cfn_sal_dev_gyroscope_bw_t

enum cfn_sal_dev_gyroscope_bw_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_BW_ODR_DIV_2 
CFN_SAL_DEV_GYROSCOPE_BW_ODR_DIV_4 

◆ cfn_sal_dev_gyroscope_event_t

enum cfn_sal_dev_gyroscope_event_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_EVENT_NONE 
CFN_SAL_DEV_GYROSCOPE_EVENT_DATA_READY 
CFN_SAL_DEV_GYROSCOPE_EVENT_WAKEUP 

◆ cfn_sal_dev_gyroscope_fifo_mode_t

enum cfn_sal_dev_gyroscope_fifo_mode_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_BYPASS 
CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_FIFO 
CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_STREAM 
CFN_SAL_DEV_GYROSCOPE_FIFO_MODE_TRIGGER 

◆ cfn_sal_dev_gyroscope_int_level_t

enum cfn_sal_dev_gyroscope_int_level_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_INT_LEVEL_ACTIVE_LOW 
CFN_SAL_DEV_GYROSCOPE_INT_LEVEL_ACTIVE_HIGH 

◆ cfn_sal_dev_gyroscope_int_mode_t

enum cfn_sal_dev_gyroscope_int_mode_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_INT_MODE_PUSH_PULL 
CFN_SAL_DEV_GYROSCOPE_INT_MODE_OPEN_DRAIN 

◆ cfn_sal_dev_gyroscope_int_pin_t

enum cfn_sal_dev_gyroscope_int_pin_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_INT_PIN_1 
CFN_SAL_DEV_GYROSCOPE_INT_PIN_2 

◆ cfn_sal_dev_gyroscope_mode_t

enum cfn_sal_dev_gyroscope_mode_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_MODE_NORMAL 
CFN_SAL_DEV_GYROSCOPE_MODE_LOW_POWER 
CFN_SAL_DEV_GYROSCOPE_MODE_STANDBY 
CFN_SAL_DEV_GYROSCOPE_MODE_POWER_DOWN 

◆ cfn_sal_dev_gyroscope_odr_t

enum cfn_sal_dev_gyroscope_odr_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_ODR_1_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_10_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_25_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_50_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_100_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_200_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_400_HZ 
CFN_SAL_DEV_GYROSCOPE_ODR_1000_HZ 

◆ cfn_sal_dev_gyroscope_range_t

enum cfn_sal_dev_gyroscope_range_t
Enumerator
CFN_SAL_DEV_GYROSCOPE_RANGE_125DPS 
CFN_SAL_DEV_GYROSCOPE_RANGE_250DPS 
CFN_SAL_DEV_GYROSCOPE_RANGE_500DPS 
CFN_SAL_DEV_GYROSCOPE_RANGE_1000DPS 
CFN_SAL_DEV_GYROSCOPE_RANGE_2000DPS 

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_dev_gyroscope_api_s  )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE ( sal_dev_gyroscope  ,
cfn_sal_dev_gyroscope_config_t  ,
cfn_sal_dev_gyroscope_api_t  ,
cfn_sal_phy_t  ,
cfn_sal_dev_gyroscope_callback_t   
)

◆ cfn_sal_dev_gyroscope_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_callback_register ( cfn_sal_dev_gyroscope_t *  driver,
cfn_sal_dev_gyroscope_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_gyroscope_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_config_get ( cfn_sal_dev_gyroscope_t *  driver,
cfn_sal_dev_gyroscope_config_t *  config 
)

◆ cfn_sal_dev_gyroscope_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_config_set ( cfn_sal_dev_gyroscope_t *  driver,
const cfn_sal_dev_gyroscope_config_t *  config 
)

◆ cfn_sal_dev_gyroscope_construct()

cfn_hal_error_code_t cfn_sal_dev_gyroscope_construct ( cfn_sal_dev_gyroscope_t *  driver,
const cfn_sal_dev_gyroscope_config_t *  config,
const cfn_sal_phy_t *  phy,
void *  dependency,
cfn_sal_dev_gyroscope_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_gyroscope_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_deinit ( cfn_sal_dev_gyroscope_t *  driver)

◆ cfn_sal_dev_gyroscope_destruct()

cfn_hal_error_code_t cfn_sal_dev_gyroscope_destruct ( cfn_sal_dev_gyroscope_t *  driver)

◆ cfn_sal_dev_gyroscope_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_disable ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_gyroscope_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_enable ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_dev_gyroscope_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_error_get ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t *  error_mask 
)

◆ cfn_sal_dev_gyroscope_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_disable ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_gyroscope_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_enable ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_dev_gyroscope_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_event_get ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t *  event_mask 
)

◆ cfn_sal_dev_gyroscope_get_id()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_get_id ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t *  id_out 
)

◆ cfn_sal_dev_gyroscope_get_status()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_get_status ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t *  status_flags 
)

◆ cfn_sal_dev_gyroscope_handle_interrupt()

CFN_HAL_INLINE void cfn_sal_dev_gyroscope_handle_interrupt ( cfn_sal_dev_gyroscope_t *  driver)

◆ cfn_sal_dev_gyroscope_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_init ( cfn_sal_dev_gyroscope_t *  driver)

◆ cfn_sal_dev_gyroscope_populate()

CFN_HAL_INLINE void cfn_sal_dev_gyroscope_populate ( cfn_sal_dev_gyroscope_t *  driver,
uint32_t  peripheral_id,
void *  dependency,
const cfn_sal_dev_gyroscope_api_t *  api,
const cfn_sal_phy_t *  phy,
const cfn_sal_dev_gyroscope_config_t *  config,
cfn_sal_dev_gyroscope_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_dev_gyroscope_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_power_state_set ( cfn_sal_dev_gyroscope_t *  driver,
cfn_hal_power_state_t  state 
)

◆ cfn_sal_dev_gyroscope_read_fifo()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_fifo ( cfn_sal_dev_gyroscope_t *  driver,
cfn_sal_dev_gyroscope_data_t *  data,
size_t *  count 
)

◆ cfn_sal_dev_gyroscope_read_xyz_mdps()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_xyz_mdps ( cfn_sal_dev_gyroscope_t *  driver,
cfn_sal_dev_gyroscope_data_t *  data_out 
)

◆ cfn_sal_dev_gyroscope_read_xyz_raw()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_dev_gyroscope_read_xyz_raw ( cfn_sal_dev_gyroscope_t *  driver,
cfn_sal_dev_gyroscope_data_t *  data_out 
)
Generated by doxygen 1.9.8