bhy_uc_driver_types.h

Go to the documentation of this file.

 
#ifndef BHY_UC_DRIVER_TYPES_H_
#define BHY_UC_DRIVER_TYPES_H_
 
#include "bhy_uc_driver_constants.h"
 
/****************************************************************************/
/*                                      MACRO                               */
/****************************************************************************/
/* system page */
#define BHY_PAGE_SYSTEM                                         1
#define BHY_PARAM_SYSTEM_META_EVENT_CTRL                        1
#define BHY_PARAM_SYSTEM_FIFO_CTRL                              2
#define BHY_PARAM_SYSTEM_STAUS_BANK_0                           3
#define BHY_PARAM_SYSTEM_STAUS_BANK_1                           4
#define BHY_PARAM_SYSTEM_STAUS_BANK_2                           5
#define BHY_PARAM_SYSTEM_STAUS_BANK_3                           6
#define BHY_PARAM_SYSTEM_CUSTOM_VERSION                         24
#define BHY_PARAM_SYSTEM_WAKE_UP_META_EVENT_CTRL                29
#define BHY_PARAM_SYSTEM_HOST_IRQ_TIMESTAMP                     30
#define BHY_PARAM_SYSTEM_PHYSICAL_SENSOR_STATUS                 31
#define BHY_PARAM_SYSTEM_PHYSICAL_SENSOR_PRESENT                32
#define BHY_PARAM_SYSTEM_PHYSICAL_SENSOR_DETAIL_0               32
#define BHY_PARAM_SYSTEM_PHYSICAL_SENSOR_DETAIL_ACC             33
 
#define VS_NON_WAKEUP                                           0
#define VS_WAKEUP                                               32
#define VS_FLUSH_NONE                                           0x00
#define VS_FLUSH_ALL                                            0xFF
#define VS_FLUSH_SINGLE                                         0x01
 
#define META_EVENT_1_INT_ENABLE_BIT                             (1<<0)
#define META_EVENT_1_ENABLE_BIT                                 (1<<1)
 
/****************************************************************************/
/*                                      ENUM                                */
/****************************************************************************/
/* follows section 9.4 table 14 of the BHI160 datasheet */
typedef enum {
    VS_TYPE_ACCELEROMETER               = VS_ID_ACCELEROMETER,
    VS_TYPE_GEOMAGNETIC_FIELD           = VS_ID_MAGNETOMETER,
    VS_TYPE_ORIENTATION                 = VS_ID_ORIENTATION,
    VS_TYPE_GYROSCOPE                   = VS_ID_GYROSCOPE,
    VS_TYPE_LIGHT                       = VS_ID_LIGHT,
    VS_TYPE_PRESSURE                    = VS_ID_BAROMETER,
    VS_TYPE_TEMPERATURE                 = VS_ID_TEMPERATURE,
    VS_TYPE_PROXIMITY                   = VS_ID_PROXIMITY,
    VS_TYPE_GRAVITY                     = VS_ID_GRAVITY,
    VS_TYPE_LINEAR_ACCELERATION         = VS_ID_LINEAR_ACCELERATION,
    VS_TYPE_ROTATION_VECTOR             = VS_ID_ROTATION_VECTOR,
    VS_TYPE_RELATIVE_HUMIDITY           = VS_ID_HUMIDITY,
    VS_TYPE_AMBIENT_TEMPERATURE         = VS_ID_AMBIENT_TEMPERATURE,
    VS_TYPE_MAGNETIC_FIELD_UNCALIBRATED = VS_ID_UNCALIBRATED_MAGNETOMETER,
    VS_TYPE_GAME_ROTATION_VECTOR        = VS_ID_GAME_ROTATION_VECTOR,
    VS_TYPE_GYROSCOPE_UNCALIBRATED      = VS_ID_UNCALIBRATED_GYROSCOPE,
    VS_TYPE_SIGNIFICANT_MOTION          = VS_ID_SIGNIFICANT_MOTION,
    VS_TYPE_STEP_DETECTOR               = VS_ID_STEP_DETECTOR,
    VS_TYPE_STEP_COUNTER                = VS_ID_STEP_COUNTER,
    VS_TYPE_GEOMAGNETIC_ROTATION_VECTOR = VS_ID_GEOMAGNETIC_ROTATION_VECTOR,
    VS_TYPE_HEART_RATE                  = VS_ID_HEART_RATE,
    VS_TYPE_TILT                        = VS_ID_TILT_DETECTOR,
    VS_TYPE_WAKEUP                      = VS_ID_WAKE_GESTURE,
    VS_TYPE_GLANCE                      = VS_ID_GLANCE_GESTURE,
    VS_TYPE_PICKUP                      = VS_ID_PICKUP_GESTURE,
    VS_TYPE_CUS1                        = VS_ID_CUS1,
    VS_TYPE_CUS2                        = VS_ID_CUS2,
    VS_TYPE_CUS3                        = VS_ID_CUS3,
    VS_TYPE_CUS4                        = VS_ID_CUS4,
    VS_TYPE_CUS5                        = VS_ID_CUS5,
    VS_TYPE_ACTIVITY_RECOGNITION        = VS_ID_ACTIVITY
} bhy_virtual_sensor_t;
 
typedef enum {
    BHY_META_EVENT_TYPE_NOT_USED                = 0,
    BHY_META_EVENT_TYPE_FLUSH_COMPLETE          = 1,
    BHY_META_EVENT_TYPE_SAMPLE_RATE_CHANGED     = 2,
    BHY_META_EVENT_TYPE_POWER_MODE_CHANGED      = 3,
    BHY_META_EVENT_TYPE_ERROR                   = 4,
    BHY_META_EVENT_TYPE_ALGORITHM               = 5,
    /* IDs 6-10 are reserved */
    BHY_META_EVENT_TYPE_SENSOR_ERROR            = 11,
    BHY_META_EVENT_TYPE_FIFO_OVERFLOW           = 12,
    BHY_META_EVENT_TYPE_DYNAMIC_RANGE_CHANGED   = 13,
    BHY_META_EVENT_TYPE_FIFO_WATERMARK          = 14,
    BHY_META_EVENT_TYPE_SELF_TEST_RESULTS       = 15,
    BHY_META_EVENT_TYPE_INITIALIZED             = 16,
 
} bhy_meta_event_type_t;
 
typedef enum {
    /* group 1 only read for host -s */
    BHY_GP_REG_20   = 0x4B,
    BHY_GP_REG_21   = 0x4C,
    BHY_GP_REG_22   = 0x4D,
    BHY_GP_REG_23   = 0x4E,
    BHY_GP_REG_24   = 0x4F,
    /* group 1 only read for host -e */
    /* group 2 read & write for host -s */
    BHY_GP_REG_31   = 0x56,
    BHY_GP_REG_32   = 0x57,
    BHY_GP_REG_33   = 0x58,
    BHY_GP_REG_34   = 0x59,
    BHY_GP_REG_35   = 0x5A,
    BHY_GP_REG_36   = 0x5B,
    /* group 2 read & write for host -e */
    /* group 3 read & write for host -s */
    BHY_GP_REG_46   = 0x65,
    BHY_GP_REG_47   = 0x66,
    BHY_GP_REG_48   = 0x67,
    BHY_GP_REG_49   = 0x68,
    BHY_GP_REG_50   = 0x69,
    BHY_GP_REG_51   = 0x6A,
    BHY_GP_REG_52   = 0x6B,
    /* group 3 read & write for host -e */
} bhy_gp_register_type_t;
 
/* follows section 15 of the BHI160 datasheet the order of this enumeration */
/* is important, do not change it                                           */
typedef enum {
    BHY_DATA_TYPE_PADDING               = 0,
    BHY_DATA_TYPE_QUATERNION            = 1,
    BHY_DATA_TYPE_VECTOR                = 2,
    BHY_DATA_TYPE_SCALAR_U8             = 3,
    BHY_DATA_TYPE_SCALAR_U16            = 4,
    BHY_DATA_TYPE_SCALAR_S16            = 5,
    BHY_DATA_TYPE_SCALAR_U24            = 6,
    BHY_DATA_TYPE_SENSOR_EVENT          = 7,
    BHY_DATA_TYPE_UNCALIB_VECTOR        = 8,
    BHY_DATA_TYPE_META_EVENT            = 9,
    BHY_DATA_TYPE_BSX                   = 10,
    BHY_DATA_TYPE_DEBUG                 = 11,
    BHY_DATA_TYPE_CUS1                  = 12,
    BHY_DATA_TYPE_CUS2                  = 13,
    BHY_DATA_TYPE_CUS3                  = 14,
    BHY_DATA_TYPE_CUS4                  = 15,
    BHY_DATA_TYPE_CUS5                  = 16,
} bhy_data_type_t;
 
typedef enum {
    META_EVENT_IN_NON_WAKEUP_FIFO       = 1,
    META_EVENT_IN_WAKEUP_FIFO           = 29,
} bhy_meta_event_fifo_type_t;
 
typedef enum
{
    PHYSICAL_SENSOR_INDEX_ACC = 0,
    PHYSICAL_SENSOR_INDEX_MAG,
    PHYSICAL_SENSOR_INDEX_GYRO,
    PHYSICAL_SENSOR_COUNT
} bhy_physical_sensor_index_type_t;
 
/****************************************************************************/
/*                               STRUCTRE DEFINITION                        */
/****************************************************************************/
 
/* definition of structures of all the data types */
typedef struct {
    uint8_t sensor_id;
} bhy_data_padding_t;
 
typedef struct {
    uint8_t  sensor_id;
    int16_t x;
    int16_t y;
    int16_t z;
    int16_t w;
    int16_t estimated_accuracy;
} bhy_data_quaternion_t;
 
typedef struct {
    uint8_t  sensor_id;
    int16_t x;
    int16_t y;
    int16_t z;
    uint8_t  status;
} bhy_data_vector_t;
 
typedef struct {
    uint8_t sensor_id;
    uint8_t data;
} bhy_data_scalar_u8_t;
 
typedef struct {
    uint8_t  sensor_id;
    uint16_t data;
} bhy_data_scalar_u16_t;
 
typedef struct {
    uint8_t  sensor_id;
    int16_t data;
} bhy_data_scalar_s16_t;
 
typedef struct {
    uint8_t  sensor_id;
    uint32_t data;
} bhy_data_scalar_u24_t;
 
typedef struct {
    uint8_t sensor_id;
} bhy_data_sensor_event_t;
 
typedef struct {
    uint8_t  sensor_id;
    int16_t x;
    int16_t y;
    int16_t z;
    int16_t x_bias;
    int16_t y_bias;
    int16_t z_bias;
    uint8_t  status;
} bhy_data_uncalib_vector_t;
 
typedef struct {
    uint8_t meta_event_id;
    bhy_meta_event_type_t event_number;
    uint8_t sensor_type;
    uint8_t event_specific;
} bhy_data_meta_event_t;
 
typedef struct {
    uint8_t sensor_id;
    int32_t x;
    int32_t y;
    int32_t z;
    uint32_t timestamp;
} bhy_data_bsx_t;
 
typedef struct {
    uint8_t sensor_id;
    uint8_t data[13];
} bhy_data_debug_t;
 
typedef struct {
    uint8_t  sensor_id;
    int16_t deltaX;
    int16_t deltaY;
    int16_t deltaZ;
    int16_t confidencelevel;
    uint16_t direction;
    uint16_t stepCount;
} bhy_data_pdr_t;
 
typedef struct {
    uint8_t  sensor_id;
    uint8_t  data[16];
} bhy_data_custom_t;
 
 
/* definition of a generic structure that can contain any data type it      */
/* occupies in RAM the size of the largest data structure, which is 18 bytes*/
/* as of 08/04/2015                                                         */
typedef union {
    bhy_data_padding_t          data_padding;
    bhy_data_quaternion_t       data_quaternion;
    bhy_data_vector_t           data_vector;
    bhy_data_scalar_u8_t        data_scalar_u8;
    bhy_data_scalar_u16_t       data_scalar_u16;
    bhy_data_scalar_s16_t       data_scalar_s16;
    bhy_data_scalar_u24_t       data_scalar_u24;
    bhy_data_sensor_event_t     data_sensor_event;
    bhy_data_uncalib_vector_t   data_uncalib_vector;
    bhy_data_meta_event_t       data_meta_event;
    bhy_data_bsx_t              data_bsx;
    bhy_data_debug_t            data_debug;
    bhy_data_custom_t           data_custom;
    bhy_data_pdr_t              data_pdr;
} bhy_data_generic_t;
 
#endif /* BHY_UC_DRIVER_TYPES_H_ */