smartsens2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef SMARTSENS2_H
#define SMARTSENS2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define SMARTSENS2_FLASHIMG                                     0   /*< Firmware image for flash include */
#define SMARTSENS2_FLASH                                        1   /*< Boot firmware from flash */
#define SMARTSENS2_RAM                                          0   /*< Upload and boot firmware from RAM */
 
#define SMARTSENS2_REG_COMMAND_INPUT                            0x00
#define SMARTSENS2_REG_WAKE_UP_FIFO                             0x01
#define SMARTSENS2_REG_NON_WAKE_UP_FIFO                         0x02
#define SMARTSENS2_REG_STATUS_DEBUG_FIFO                        0x03
#define SMARTSENS2_REG_CHIP_CTRL                                0x05
#define SMARTSENS2_REG_HOST_INTERFACE_CTRL                      0x06
#define SMARTSENS2_REG_HOST_INTERRUPT_CTRL                      0x07
#define SMARTSENS2_REG_RESET_REQUEST                            0x14
#define SMARTSENS2_REG_TIMESTAMP_EVENT_REQUEST                  0x15
#define SMARTSENS2_REG_HOST_CTRL                                0x16
#define SMARTSENS2_REG_HOST_STATUS                              0x17
#define SMARTSENS2_REG_HOST_CRC                                 0x18191A1B
#define SMARTSENS2_REG_FUSER2_PRODUCT_ID                        0x1C
#define SMARTSENS2_REG_FUSER2_REVISION_ID                       0x1D
#define SMARTSENS2_REG_ROM_VERSION                              0x1E1F
#define SMARTSENS2_REG_KERNEL_VERSION                           0x2021
#define SMARTSENS2_REG_USER_VERSION                             0x2223
#define SMARTSENS2_REG_FEATURE_STATUS                           0x24
#define SMARTSENS2_REG_BOOT_STATUS                              0x25
#define SMARTSENS2_REG_HOST_INTERRUPT_TIMESTAMP                 0x26  // Start of interrupt state. Length 5 Bytes. [0x26..0x2A]
#define SMARTSENS2_REG_CHIP_ID                                  0x2B
#define SMARTSENS2_REG_INTERRUPT_STATUS                         0x2D
#define SMARTSENS2_REG_ERROR_VALUE                              0x2E
#define SMARTSENS2_REG_ERROR_AUX                                0x2F
#define SMARTSENS2_REG_DEBUG_VALUE                              0x30
#define SMARTSENS2_REG_DEBUG_STATE                              0x31
 
#define SMARTSENS2_CMD_DOWNLOAD_POST_MORTEM_DATA                0x0001
#define SMARTSENS2_CMD_UPLOAD_TO_RAM                            0x0002
#define SMARTSENS2_CMD_BOOT_RAM                                 0x0003
#define SMARTSENS2_CMD_ERASE_FLASH                              0x0004
#define SMARTSENS2_CMD_WRITE_FLASH                              0x0005
#define SMARTSENS2_CMD_BOOT_FLASH                               0x0006
#define SMARTSENS2_CMD_SET_SENSOR_DATA_INJECTION                0x0007
#define SMARTSENS2_CMD_INJECT_SENSOR_DATA                       0x0008
#define SMARTSENS2_CMD_FIFO_FLUSH                               0x0009
#define SMARTSENS2_CMD_SOFT_PASS_THROUGH                        0x000A
#define SMARTSENS2_CMD_REQUEST_SENSOR_SELF_TEST                 0x000B
#define SMARTSENS2_CMD_REQUEST_SENSOR_FAST_OFFSET_COMPENSATION  0x000C
#define SMARTSENS2_CMD_CONFIGURE_SENSOR                         0x000D
#define SMARTSENS2_CMD_CHANGE_SENSOR_DYNAMIC_RANGE              0x000E
#define SMARTSENS2_CMD_SET_CHANGE_SENSITIVITY                   0x000F
#define SMARTSENS2_CMD_DEBUG_TEST                               0x0010
#define SMARTSENS2_CMD_DUT_CONTINUE                             0x0011
#define SMARTSENS2_CMD_DUT_START_TEST                           0x0012
#define SMARTSENS2_CMD_CTRL_FIFO_FORMAT                         0x0015
#define SMARTSENS2_CMD_RAISE_SPEED                              0x0017
/*
 * COMMANDS WITH PARAMETERS:
 *      0x0100..0x01FF -> System Parameters
 *      0x0200..0x02FF -> BSX Algorithm Parameters
 *      0x0300..0x03FF -> Virual Sensor Information Parameters
 *      0x0500..0x05FF -> Virtual Sensor Configuration Parameters
 *      0x0800..0x0DFF -> Costumer Defined
 *      0x0E00..0x0EFF -> Physical Sensor Control Parameters
 */
// System Parameters
#define SMARTSENS2_CMD_SYSTEM_PARAMETERS_READ_MASK              0x1000
#define SMARTSENS2_CMD_META_EVENT_CTRL_NON_WAKE_UP_FIFO         0x0101
#define SMARTSENS2_CMD_META_EVENT_CTRL_WAKE_UP_FIFO             0x0102
#define SMARTSENS2_CMD_META_EVENT_CTRL_FIFO_CTRL                0x0103
#define SMARTSENS2_CMD_META_EVENT_CTRL_FIRMWARE_VERSION         0x0104
#define SMARTSENS2_CMD_META_EVENT_CTRL_TIMESTAMPS               0x0105
#define SMARTSENS2_CMD_META_EVENT_CTRL_FRAMEWORK_STATUS         0x0106
#define SMARTSENS2_CMD_META_EVENT_CTRL_VIRUAL_SENSOR_PRESENT    0x011F
#define SMARTSENS2_CMD_META_EVENT_CTRL_PHYSICAL_SENSOR_PRESENT  0x0120
#define SMARTSENS2_CMD_META_EVENT_CTRL_PHYSICAL_SENSOR_INFO     0x0121 //0x0121..0x0160
// BSX Algorithm Parameters
#define SMARTSENS2_CMD_CALIBRATION_STATE_ACCELEROMETER          0x0201
#define SMARTSENS2_CMD_CALIBRATION_STATE_GYROSCOPE              0x0203
#define SMARTSENS2_CMD_CALIBRATION_STATE_MAGNETOMETER           0x0205
#define SMARTSENS2_CMD_SIC_MATRIX                               0x027D
#define SMARTSENS2_CMD_BSX_VERSION                              0x027E
// Virual Sensor Information Parameters
#define SMARTSENS2_CMD_VIRTUAL_SENSOR_INFO                      0x0300
 
#define SMARTSENS2_START_FLASH_ADR                              0x00001F84
 
 // smartsens2_reg
 
#define SMARTSENS2_SENSOR_ID_CUSTOM_START                       160
#define SMARTSENS2_SENSOR_ID_CUSTOM_END                         191
#define SMARTSENS2_SENSOR_ID_MAX                                200
#define SMARTSENS2_SENSOR_ID_TBD                                SMARTSENS2_SENSOR_ID_MAX - 1
#define SMARTSENS2_SENSOR_ID_ACC_PASS                           1   /* Accelerometer passthrough */
#define SMARTSENS2_SENSOR_ID_ACC_RAW                            3   /* Accelerometer uncalibrated */
#define SMARTSENS2_SENSOR_ID_ACC                                4   /* Accelerometer corrected */
#define SMARTSENS2_SENSOR_ID_ACC_BIAS                           5   /* Accelerometer offset */
#define SMARTSENS2_SENSOR_ID_ACC_WU                             6   /* Accelerometer corrected wake up */
#define SMARTSENS2_SENSOR_ID_ACC_RAW_WU                         7   /* Accelerometer uncalibrated wake up */
#define SMARTSENS2_SENSOR_ID_GYRO_PASS                          10  /* Gyroscope passthrough */
#define SMARTSENS2_SENSOR_ID_GYRO_RAW                           12  /* Gyroscope uncalibrated */
#define SMARTSENS2_SENSOR_ID_GYRO                               13  /* Gyroscope corrected */
#define SMARTSENS2_SENSOR_ID_GYRO_BIAS                          14  /* Gyroscope offset */
#define SMARTSENS2_SENSOR_ID_GYRO_WU                            15  /* Gyroscope wake up */
#define SMARTSENS2_SENSOR_ID_GYRO_RAW_WU                        16  /* Gyroscope uncalibrated wake up */
#define SMARTSENS2_SENSOR_ID_MAG_PASS                           19  /* Magnetometer passthrough */
#define SMARTSENS2_SENSOR_ID_MAG_RAW                            21  /* Magnetometer uncalibrated */
#define SMARTSENS2_SENSOR_ID_MAG                                22  /* Magnetometer corrected */
#define SMARTSENS2_SENSOR_ID_MAG_BIAS                           23  /* Magnetometer offset */
#define SMARTSENS2_SENSOR_ID_MAG_WU                             24  /* Magnetometer wake up */
#define SMARTSENS2_SENSOR_ID_MAG_RAW_WU                         25  /* Magnetometer uncalibrated wake up */
#define SMARTSENS2_SENSOR_ID_GRA                                28  /* Gravity vector */
#define SMARTSENS2_SENSOR_ID_GRA_WU                             29  /* Gravity vector wake up */
#define SMARTSENS2_SENSOR_ID_LACC                               31  /* Linear acceleration */
#define SMARTSENS2_SENSOR_ID_LACC_WU                            32  /* Linear acceleration wake up */
#define SMARTSENS2_SENSOR_ID_RV                                 34  /* Rotation vector */
#define SMARTSENS2_SENSOR_ID_RV_WU                              35  /* Rotation vector wake up */
#define SMARTSENS2_SENSOR_ID_GAMERV                             37  /* Game rotation vector */
#define SMARTSENS2_SENSOR_ID_GAMERV_WU                          38  /* Game rotation vector wake up */
#define SMARTSENS2_SENSOR_ID_GEORV                              40  /* Geo-magnetic rotation vector */
#define SMARTSENS2_SENSOR_ID_GEORV_WU                           41  /* Geo-magnetic rotation vector wake up */
#define SMARTSENS2_SENSOR_ID_ORI                                43  /* Orientation */
#define SMARTSENS2_SENSOR_ID_ORI_WU                             44  /* Orientation wake up */
#define SMARTSENS2_SENSOR_ID_TILT_DETECTOR                      48  /* Tilt detector */
#define SMARTSENS2_SENSOR_ID_STD                                50  /* Step detector */
#define SMARTSENS2_SENSOR_ID_STC                                52  /* Step counter */
#define SMARTSENS2_SENSOR_ID_STC_WU                             53  /* Step counter wake up */
#define SMARTSENS2_SENSOR_ID_SIG                                55  /* Significant motion */
#define SMARTSENS2_SENSOR_ID_WAKE_GESTURE                       57  /* Wake gesture */
#define SMARTSENS2_SENSOR_ID_GLANCE_GESTURE                     59  /* Glance gesture */
#define SMARTSENS2_SENSOR_ID_PICKUP_GESTURE                     61  /* Pickup gesture */
#define SMARTSENS2_SENSOR_ID_AR                                 63  /* Activity recognition */
#define SMARTSENS2_SENSOR_ID_WRIST_TILT_GESTURE                 67  /* Wrist tilt gesture */
#define SMARTSENS2_SENSOR_ID_DEVICE_ORI                         69  /* Device orientation */
#define SMARTSENS2_SENSOR_ID_DEVICE_ORI_WU                      70  /* Device orientation wake up */
#define SMARTSENS2_SENSOR_ID_STATIONARY_DET                     75  /* Stationary detect */
#define SMARTSENS2_SENSOR_ID_MOTION_DET                         77  /* Motion detect */
#define SMARTSENS2_SENSOR_ID_ACC_BIAS_WU                        91  /* Accelerometer offset wake up */
#define SMARTSENS2_SENSOR_ID_GYRO_BIAS_WU                       92  /* Gyroscope offset wake up */
#define SMARTSENS2_SENSOR_ID_MAG_BIAS_WU                        93  /* Magnetometer offset wake up */
#define SMARTSENS2_SENSOR_ID_STD_WU                             94  /* Step detector wake up */
#define SMARTSENS2_SENSOR_ID_TEMP                               128 /* Temperature */
#define SMARTSENS2_SENSOR_ID_BARO                               129 /* Barometer */
#define SMARTSENS2_SENSOR_ID_HUM                                130 /* Humidity */
#define SMARTSENS2_SENSOR_ID_GAS                                131 /* Gas */
#define SMARTSENS2_SENSOR_ID_TEMP_WU                            132 /* Temperature wake up */
#define SMARTSENS2_SENSOR_ID_BARO_WU                            133 /* Barometer wake up */
#define SMARTSENS2_SENSOR_ID_HUM_WU                             134 /* Humidity wake up */
#define SMARTSENS2_SENSOR_ID_GAS_WU                             135 /* Gas wake up */
#define SMARTSENS2_SENSOR_ID_STC_HW                             136 /* Hardware Step counter */
#define SMARTSENS2_SENSOR_ID_STD_HW                             137 /* Hardware Step detector */
#define SMARTSENS2_SENSOR_ID_SIG_HW                             138 /* Hardware Significant motion */
#define SMARTSENS2_SENSOR_ID_STC_HW_WU                          139 /* Hardware Step counter wake up */
#define SMARTSENS2_SENSOR_ID_STD_HW_WU                          140 /* Hardware Step detector wake up */
#define SMARTSENS2_SENSOR_ID_SIG_HW_WU                          141 /* Hardware Significant motion wake up */
#define SMARTSENS2_SENSOR_ID_ANY_MOTION                         142 /* Any motion */
#define SMARTSENS2_SENSOR_ID_ANY_MOTION_WU                      143 /* Any motion wake up */
#define SMARTSENS2_SENSOR_ID_EXCAMERA                           144 /* External camera trigger */
#define SMARTSENS2_SENSOR_ID_GPS                                145 /* GPS */
#define SMARTSENS2_SENSOR_ID_LIGHT                              146 /* Light */
#define SMARTSENS2_SENSOR_ID_PROX                               147 /* Proximity */
#define SMARTSENS2_SENSOR_ID_LIGHT_WU                           148 /* Light wake up */
#define SMARTSENS2_SENSOR_ID_PROX_WU                            149 /* Proximity wake up */
#define SMARTSENS2_IS_SYS_ID( sid )                             ( ( sid ) >= 224 )
#define SMARTSENS2_SYS_ID_PADDING                               0
#define SMARTSENS2_SYS_ID_TS_SMALL_DELTA                        251
#define SMARTSENS2_SYS_ID_TS_LARGE_DELTA                        252
#define SMARTSENS2_SYS_ID_TS_FULL                               253
#define SMARTSENS2_SYS_ID_META_EVENT                            254
#define SMARTSENS2_SYS_ID_TS_SMALL_DELTA_WU                     245
#define SMARTSENS2_SYS_ID_TS_LARGE_DELTA_WU                     246
#define SMARTSENS2_SYS_ID_TS_FULL_WU                            247
#define SMARTSENS2_SYS_ID_META_EVENT_WU                         248
#define SMARTSENS2_SYS_ID_FILLER                                255
#define SMARTSENS2_SYS_ID_DEBUG_MSG                             250
#define SMARTSENS2_SYS_ID_SMARTSENS2_LOG_UPDATE_SUB             243
#define SMARTSENS2_SYS_ID_SMARTSENS2_LOG_DOSTEP                 244
#define SMARTSENS2_N_VIRTUAL_SENSOR_MAX                         256 /* Maximum no of available virtual sensor */
#define SMARTSENS2_SPECIAL_SENSOR_ID_OFFSET                     245 /* Special & debug virtual sensor id starts at 245 */
 
#define SMARTSENS2_META_EVENT_FLUSH_COMPLETE                    1
#define SMARTSENS2_META_EVENT_SAMPLE_RATE_CHANGED               2
#define SMARTSENS2_META_EVENT_POWER_MODE_CHANGED                3
#define SMARTSENS2_META_EVENT_ALGORITHM_EVENTS                  5
#define SMARTSENS2_META_EVENT_SENSOR_STATUS                     6
#define SMARTSENS2_META_EVENT_BSX_DO_STEPS_MAIN                 7
#define SMARTSENS2_META_EVENT_BSX_DO_STEPS_CALIB                8
#define SMARTSENS2_META_EVENT_BSX_GET_OUTPUT_SIGNAL             9
#define SMARTSENS2_META_EVENT_RESERVED1                         10
#define SMARTSENS2_META_EVENT_SENSOR_ERROR                      11
#define SMARTSENS2_META_EVENT_FIFO_OVERFLOW                     12
#define SMARTSENS2_META_EVENT_DYNAMIC_RANGE_CHANGED             13
#define SMARTSENS2_META_EVENT_FIFO_WATERMARK                    14
#define SMARTSENS2_META_EVENT_RESERVED2                         15
#define SMARTSENS2_META_EVENT_INITIALIZED                       16
#define SMARTSENS2_META_TRANSFER_CAUSE                          17
#define SMARTSENS2_META_EVENT_SENSOR_FRAMEWORK                  18
#define SMARTSENS2_META_EVENT_RESET                             19
#define SMARTSENS2_META_EVENT_SPACER                            20
 
#define SMARTSENS2_CHIP_ID_VALUE                                0x70
#define SMARTSENS2_FUSER2_PRODUCT_ID_VALUE                      0x89
 
#define SMARTSENS2_BOOTSTATUS_FLASH_DETECTED                    0x01
#define SMARTSENS2_BOOTSTATUS_FLASH_VERIFY_DONE                 0x02
#define SMARTSENS2_BOOTSTATUS_FLASH_VERIFY_ERROR                0x04
#define SMARTSENS2_BOOTSTATUS_NO_FLASH                          0x08
#define SMARTSENS2_BOOTSTATUS_HOST_INTERFACE_READY              0x10
#define SMARTSENS2_BOOTSTATUS_HOST_FW_VERIFY_DONE               0x20
#define SMARTSENS2_BOOTSTATUS_HOST_FW_VERIFY_ERROR              0x40
#define SMARTSENS2_BOOTSTATUS_HOST_FW_IDLE                      0x80
 
#define SMARTSENS2_HOSTSTATUS_POWER_STATE                       0x01
#define SMARTSENS2_HOSTSTATUS_HOST_PROTOCOL                     0x02
#define SMARTSENS2_HOSTSTATUS_HOST_CHANNEL_0                    0x10
#define SMARTSENS2_HOSTSTATUS_HOST_CHANNEL_1                    0x20
#define SMARTSENS2_HOSTSTATUS_HOST_CHANNEL_2                    0x40
#define SMARTSENS2_HOSTSTATUS_HOST_CHANNEL_3                    0x80
 
#define SMARTSENS2_IST_MASK_ASSERTED                            0x1
#define SMARTSENS2_IST_MASK_FIFO_W                              0x6
#define SMARTSENS2_IST_MASK_FIFO_NW                             0x18
#define SMARTSENS2_IST_MASK_STATUS                              0x20
#define SMARTSENS2_IST_MASK_DEBUG                               0x40
#define SMARTSENS2_IST_MASK_RESET_FAULT                         0x80
#define SMARTSENS2_IST_FIFO_W_DRDY                              0x2
#define SMARTSENS2_IST_FIFO_W_LTCY                              0x4
#define SMARTSENS2_IST_FIFO_W_WM                                0x6
#define SMARTSENS2_IST_FIFO_NW_DRDY                             0x8
#define SMARTSENS2_IST_FIFO_NW_LTCY                             0x10
#define SMARTSENS2_IST_FIFO_NW_WM                               0x18
#define SMARTSENS2_IS_INT_FIFO_W( status )                      ( status & SMARTSENS2_IST_MASK_FIFO_W )
#define SMARTSENS2_IS_INT_FIFO_NW( status )                     ( status & SMARTSENS2_IST_MASK_FIFO_NW )
#define SMARTSENS2_IS_INT_STATUS( status )                      ( status & SMARTSENS2_IST_MASK_STATUS )
#define SMARTSENS2_IS_INT_ASYNC_STATUS( status )                ( status & SMARTSENS2_IST_MASK_DEBUG )
#define SMARTSENS2_IS_INT_RESET( status )                       ( status & SMARTSENS2_IST_MASK_RESET_FAULT )
#define SMARTSENS2_IST_MASK_FIFO                                ( SMARTSENS2_IST_MASK_FIFO_W | SMARTSENS2_IST_MASK_FIFO_NW )
#define SMARTSENS2_IS_INT_FIFO( status )                        ( status & SMARTSENS2_IST_MASK_FIFO )
 
#define SMARTSENS2_ICTL_DISABLE_FIFO_W                          0x01
#define SMARTSENS2_ICTL_DISABLE_FIFO_NW                         0x02
#define SMARTSENS2_ICTL_DISABLE_STATUS_FIFO                     0x04
#define SMARTSENS2_ICTL_DISABLE_DEBUG                           0x08
#define SMARTSENS2_ICTL_DISABLE_FAULT                           0x10
#define SMARTSENS2_ICTL_ACTIVE_LOW                              0x20
#define SMARTSENS2_ICTL_EDGE                                    0x40
#define SMARTSENS2_ICTL_OPEN_DRAIN                              0x80
 
#define SMARTSENS2_HIF_CTRL_ABORT_TRANSFER_CHANNEL_0            0x01
#define SMARTSENS2_HIF_CTRL_ABORT_TRANSFER_CHANNEL_1            0x02
#define SMARTSENS2_HIF_CTRL_ABORT_TRANSFER_CHANNEL_2            0x04
#define SMARTSENS2_HIF_CTRL_ABORT_TRANSFER_CHANNEL_3            0x08
#define SMARTSENS2_HIF_CTRL_AP_SUSPENDED                        0x10
#define SMARTSENS2_HIF_CTRL_TIMESTAMP_EV_CTRL                   0x40
#define SMARTSENS2_HIF_CTRL_ASYNC_STATUS_CHANNEL                0x80
 
#define SMARTSENS2_LE2U16( x )                                  ( ( uint16_t )( ( x )[ 0 ] | ( x )[ 1 ] << 8 ) )
#define SMARTSENS2_LE2S16( x )                                  ( ( int16_t )SMARTSENS2_LE2U16( x ) )
#define SMARTSENS2_LE2U24( x )                                  ( ( uint32_t )( ( x )[ 0 ] | \
                                                                  ( uint32_t )( x )[ 1 ] << 8 | \
                                                                  ( uint32_t )( x )[ 2 ] << 16 ) )
#define SMARTSENS2_LE2U32( x )                                  ( ( uint32_t )( ( x )[ 0 ] | \
                                                                  ( uint32_t )( x )[ 1 ] << 8 | \
                                                                  ( uint32_t )( x )[ 2 ] << 16 | \
                                                                  ( uint32_t )( x )[ 3 ] << 24 ) )
#define SMARTSENS2_LE2S32( x )                                  ( ( int32_t )SMARTSENS2_LE2U32( x ) )
#define SMARTSENS2_LE2U40( x )                                  ( SMARTSENS2_LE2U32( x ) | ( uint32_t )( x )[ 4 ] << 32 )
#define SMARTSENS2_TIMESTAMP_TO_SEC( x )                        ( ( uint32_t ) ( x * ( 15625.0 / UINT32_C( 1000000000 ) ) ) )
 
#define SMARTSENS2_SLAVE_ADDRESS_1                              0x29
#define SMARTSENS2_SLAVE_ADDRESS_0                              0x28
 
#define SMARTSENS2_SET_DATA_SAMPLE_EDGE                         SET_SPI_DATA_SAMPLE_EDGE
#define SMARTSENS2_SET_DATA_SAMPLE_MIDDLE                       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // smartsens2_set
 
#define SMARTSENS2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // smartsens2_map
 // smartsens2
 
typedef enum
{
    SMARTSENS2_DRV_SEL_SPI,      
    SMARTSENS2_DRV_SEL_I2C       
} smartsens2_drv_t;
 
enum smartsens2_fifo_type 
{
    SMARTSENS2_FIFO_TYPE_WAKEUP,
    SMARTSENS2_FIFO_TYPE_NON_WAKEUP,
    SMARTSENS2_FIFO_TYPE_STATUS,
    SMARTSENS2_FIFO_TYPE_MAX
};
 
struct smartsens2_fifo_parse_data_info
{
    uint8_t sensor_id;
    enum smartsens2_fifo_type fifo_type;
    uint8_t data_size;
    uint8_t *data_ptr;
    uint32_t *time_stamp;
};
 
typedef err_t ( *smartsens2_master_io_t )( struct smartsens2_s*, uint8_t, uint8_t*, uint8_t ); 
typedef void ( *smartsens2_fifo_parse_callback_t )( struct smartsens2_fifo_parse_data_info *callback_info, void *private_data ); 
 
union smartsens2_u16_conv
{
    uint16_t u16_val;
    uint8_t bytes[ 2 ];
};
 
union smartsens2_u32_conv
{
    uint32_t u32_val;
    uint8_t bytes[ 4 ];
};
 
union smartsens2_float_conv
{
    float f_val;
    uint32_t u32_val;
    uint8_t bytes[ 4 ];
};
 
struct smartsens2_sensor_info
{
    uint8_t sensor_type;
    uint8_t driver_id;
    uint8_t driver_version;
    uint8_t power;
    union smartsens2_u16_conv max_range;
    union smartsens2_u16_conv resolution;
    union smartsens2_float_conv max_rate;
    union smartsens2_u32_conv fifo_reserved;
    union smartsens2_u32_conv fifo_max;
    uint8_t event_size;
    union smartsens2_float_conv min_rate;
};
 
struct smartsens2_fifo_parse_callback_table
{
    uint8_t event_size;
    smartsens2_fifo_parse_callback_t callback;
    void *callback_ref;
};
 
struct smartsens2_fifo_buffer
{
    uint32_t read_pos;
    uint32_t read_length;
    uint32_t remain_length;
    uint32_t buffer_size;
    uint8_t *buffer;
};
 
typedef struct smartsens2_s
{
    digital_out_t rst;                  
    digital_in_t  int_pin;              
    i2c_master_t  i2c;                  
    spi_master_t  spi;                  
    uint8_t     slave_address;          
    pin_name_t  chip_select;            
    smartsens2_drv_t  drv_sel;          
    smartsens2_master_io_t  write_f;    
    smartsens2_master_io_t  read_f;     
    struct smartsens2_fifo_parse_callback_table table[ SMARTSENS2_N_VIRTUAL_SENSOR_MAX ];
    uint32_t last_time_stamp[ SMARTSENS2_FIFO_TYPE_MAX ];
    
} smartsens2_t;
 
typedef struct
{
    pin_name_t  scl;                    
    pin_name_t  sda;                    
    pin_name_t  miso;                   
    pin_name_t  mosi;                   
    pin_name_t  sck;                    
    pin_name_t  cs;                     
    pin_name_t  rst;                    
    pin_name_t  int_pin;                
    uint32_t  i2c_speed;                
    uint8_t   i2c_address;              
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
    smartsens2_drv_t  drv_sel;          
} smartsens2_cfg_t;
 
typedef enum
{
    SMARTSENS2_OK = 0,
    SMARTSENS2_ERROR = -1,
    SMARTSENS_ERROR_TIMEOUT = -2
 
} smartsens2_return_value_t;
 
void smartsens2_cfg_setup ( smartsens2_cfg_t *cfg );
 
void smartsens2_drv_interface_selection ( smartsens2_cfg_t *cfg, smartsens2_drv_t drv_sel );
 
err_t smartsens2_init ( smartsens2_t *ctx, smartsens2_cfg_t *cfg );
 
err_t smartsens2_default_cfg ( smartsens2_t *ctx );
 
err_t smartsens2_generic_write ( smartsens2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t smartsens2_generic_read ( smartsens2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t smartsens2_byte_write ( smartsens2_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t smartsens2_byte_read ( smartsens2_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t smartsens2_get_interrupt ( smartsens2_t *ctx );
 
err_t smartsens2_cmd_write ( smartsens2_t *ctx, uint16_t cmd, uint8_t *cmd_buf, uint16_t cmd_len );
 
err_t smartsens2_status_read ( smartsens2_t *ctx, uint16_t *cmd, uint8_t *cmd_buf, uint16_t *cmd_len );
 
err_t smartsens2_get_parameter ( smartsens2_t *ctx, uint16_t parameter, 
                                 uint8_t *parameter_buf, uint16_t *parameter_len );
 
void smartsens2_reset ( smartsens2_t *ctx );
 
err_t smartsens2_sw_reset ( smartsens2_t *ctx );
 
err_t smartsens2_update_firmware ( smartsens2_t *ctx );
 
err_t smartsens2_boot_firmware( smartsens2_t *ctx );
 
err_t smartsens2_power_on_device( smartsens2_t *ctx );
 
err_t smartsens2_update_virtual_sensor_list ( smartsens2_t *ctx );
 
err_t smartsens2_get_virt_sensor_list ( smartsens2_t *ctx, uint8_t *sensor_list );
 
err_t smartsens2_set_virt_sensor_cfg( smartsens2_t *ctx, uint8_t sensor_id, float sample_rate, uint32_t latency );
 
err_t smartsens2_get_and_process_fifo ( smartsens2_t *ctx, uint8_t *work_buffer, uint32_t buffer_size );
 
err_t smartsens2_register_fifo_parse_callback ( smartsens2_t *ctx, uint8_t sensor_id,
                                                smartsens2_fifo_parse_callback_t callback, void *callback_ref );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTSENS2_H
 
 // smartsens2
 
// ------------------------------------------------------------------------ END