smoke2.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 SMOKE2_H
#define SMOKE2_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 SMOKE2_REG_STATUS                   0x00
#define SMOKE2_REG_INT_MASK                 0x01
#define SMOKE2_REG_GPIO_DRV                 0x02
#define SMOKE2_REG_BG_STATUS                0x04
#define SMOKE2_REG_FIFO_THR                 0x06
#define SMOKE2_REG_DEVID                    0x08
#define SMOKE2_REG_I2CS_ID                  0x09
#define SMOKE2_REG_CLK_RATIO                0x0A
#define SMOKE2_REG_GPIO_CTRL                0x0B
#define SMOKE2_REG_SLAVE_ADDR_KEY           0x0D
#define SMOKE2_REG_SW_RESET                 0x0F
#define SMOKE2_REG_MODE                     0x10
#define SMOKE2_REG_SLOT_EN                  0x11
#define SMOKE2_REG_FSAMPLE                  0x12
#define SMOKE2_REG_PD_LED_SELECT            0x14
#define SMOKE2_REG_NUM_AVG                  0x15
#define SMOKE2_REG_BIG_MEAS_A               0x16
#define SMOKE2_REG_INT_SEQ_A                0x17
#define SMOKE2_REG_SLOTA_CH1_OFFSET         0x18
#define SMOKE2_REG_SLOTA_CH2_OFFSET         0x19
#define SMOKE2_REG_SLOTA_CH3_OFFSET         0x1A
#define SMOKE2_REG_SLOTA_CH4_OFFSET         0x1B
#define SMOKE2_REG_BIG_MEAS_B               0x1C
#define SMOKE2_REG_INT_SEQ_B                0x1D
#define SMOKE2_REG_SLOTB_CH1_OFFSET         0x1E
#define SMOKE2_REG_SLOTB_CH2_OFFSET         0x1F
#define SMOKE2_REG_SLOTB_CH3_OFFSET         0x20
#define SMOKE2_REG_SLOTB_CH4_OFFSET         0x21
#define SMOKE2_REG_ILED3_COARSE             0x22
#define SMOKE2_REG_ILED1_COARSE             0x23
#define SMOKE2_REG_ILED2_COARSE             0x24
#define SMOKE2_REG_ILED_FINE                0x25
#define SMOKE2_REG_SLOTA_LED_PULSE          0x30
#define SMOKE2_REG_SLOTA_NUM_PULSES         0x31
#define SMOKE2_REG_LED_DISABLE              0x34
#define SMOKE2_REG_SLOTB_LED_PULSE          0x35
#define SMOKE2_REG_SLOTB_NUM_PULSES         0x36
#define SMOKE2_REG_ALT_PWR_DN               0x37
#define SMOKE2_REG_EXT_SYNC_STARTUP         0x38
#define SMOKE2_REG_SLOTA_AFE_WINDOW         0x39
#define SMOKE2_REG_SLOTB_AFE_WINDOW         0x3B
#define SMOKE2_REG_AFE_PWR_CFG1             0x3C
#define SMOKE2_REG_SLOTA_FLOAT_LED          0x3E
#define SMOKE2_REG_SLOTB_FLOAT_LED          0x3F
#define SMOKE2_REG_SLOTA_TIA_CFG            0x42
#define SMOKE2_REG_SLOTA_AFE_CFG            0x43
#define SMOKE2_REG_SLOTB_TIA_CFG            0x44
#define SMOKE2_REG_SLOTB_AFE_CFG            0x45
#define SMOKE2_REG_SAMPLE_CLK               0x4B
#define SMOKE2_REG_CLK32M_ADJUST            0x4D
#define SMOKE2_REG_EXT_SYNC_SEL             0x4F
#define SMOKE2_REG_CLK32M_CAL_EN            0x50
#define SMOKE2_REG_AFE_PWR_CFG2             0x54
#define SMOKE2_REG_TIA_INDEP_GAIN           0x55
#define SMOKE2_REG_MATH                     0x58
#define SMOKE2_REG_FLT_CONFIG_B             0x59
#define SMOKE2_REG_FLT_LED_FIRE             0x5A
#define SMOKE2_REG_FLT_CONFIG_A             0x5E
#define SMOKE2_REG_DATA_ACCESS_CTL          0x5F
#define SMOKE2_REG_FIFO_ACCESS              0x60
#define SMOKE2_REG_SLOTA_CH1                0x64
#define SMOKE2_REG_SLOTA_CH2                0x65
#define SMOKE2_REG_SLOTA_CH3                0x66
#define SMOKE2_REG_SLOTA_CH4                0x67
#define SMOKE2_REG_SLOTB_CH1                0x68
#define SMOKE2_REG_SLOTB_CH2                0x69
#define SMOKE2_REG_SLOTB_CH3                0x6A
#define SMOKE2_REG_SLOTB_CH4                0x6B
#define SMOKE2_REG_A_CH1_LOW                0x70
#define SMOKE2_REG_A_CH2_LOW                0x71
#define SMOKE2_REG_A_CH3_LOW                0x72
#define SMOKE2_REG_A_CH4_LOW                0x73
#define SMOKE2_REG_A_CH1_HIGH               0x74
#define SMOKE2_REG_A_CH2_HIGH               0x75
#define SMOKE2_REG_A_CH3_HIGH               0x76
#define SMOKE2_REG_A_CH4_HIGH               0x77
#define SMOKE2_REG_B_CH1_LOW                0x78
#define SMOKE2_REG_B_CH2_LOW                0x79
#define SMOKE2_REG_B_CH3_LOW                0x7A
#define SMOKE2_REG_B_CH4_LOW                0x7B
#define SMOKE2_REG_B_CH1_HIGH               0x7C
#define SMOKE2_REG_B_CH2_HIGH               0x7D
#define SMOKE2_REG_B_CH3_HIGH               0x7E
#define SMOKE2_REG_B_CH4_HIGH               0x7F
 
 // smoke2_reg
 
#define SMOKE2_SLOT_A                       0
#define SMOKE2_SLOT_B                       4
 
#define SMOKE2_CHN_1                        0
#define SMOKE2_CHN_2                        1
#define SMOKE2_CHN_3                        2
#define SMOKE2_CHN_4                        3
 
#define SMOKE2_MODE_IDLE                    0
#define SMOKE2_MODE_PROGRAM                 1
#define SMOKE2_MODE_NORMAL                  2
 
#define SMOKE2_SMOKE_DETECTED               0xCC
#define SMOKE2_SMOKE_NOT_DETECTED           0xDD
 
#define SMOKE2_READ_CMD                     0
#define SMOKE2_WRITE_CMD                    1
 
#define SMOKE2_SET_DEV_ADDR                 0x64
 
#define SMOKE2_SET_DATA_SAMPLE_EDGE         SET_SPI_DATA_SAMPLE_EDGE
#define SMOKE2_SET_DATA_SAMPLE_MIDDLE       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // smoke2_set
 
#define SMOKE2_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // smoke2_map
 // smoke2
 
typedef enum
{
    SMOKE2_DRV_SEL_SPI,      
    SMOKE2_DRV_SEL_I2C       
} smoke2_drv_t;
 
typedef err_t ( *smoke2_master_io_t )( struct smoke2_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct smoke2_s
{
    digital_in_t  int_pin;               
    i2c_master_t  i2c;                   
    spi_master_t  spi;                   
    uint8_t     slave_address;           
    pin_name_t  chip_select;             
    smoke2_drv_t  drv_sel;                
    smoke2_master_io_t  write_f;          
    smoke2_master_io_t  read_f;           
    uint16_t calibration_value;
    uint16_t threshold_value;
    uint8_t enabled_slot;
    
} smoke2_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  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;     
    smoke2_drv_t  drv_sel;                               
} smoke2_cfg_t;
 
typedef enum
{
    SMOKE2_OK = 0,
    SMOKE2_ERROR = -1
 
} smoke2_return_value_t;
 
void smoke2_cfg_setup ( smoke2_cfg_t *cfg );
 
void smoke2_drv_interface_selection ( smoke2_cfg_t *cfg, smoke2_drv_t drv_sel );
 
err_t smoke2_init ( smoke2_t *ctx, smoke2_cfg_t *cfg );
 
void smoke2_default_cfg ( smoke2_t *ctx );
 
err_t smoke2_generic_write ( smoke2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t smoke2_generic_read ( smoke2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t smoke2_get_int_pin ( smoke2_t *ctx );
 
void smoke2_write_data( smoke2_t *ctx, uint8_t reg, uint16_t tx_data );
 
uint16_t smoke2_read_data( smoke2_t *ctx, uint8_t reg );
 
void smoke2_set_bit ( smoke2_t *ctx, uint8_t reg, uint8_t bit_num , uint8_t val );
 
uint8_t smoke2_get_bit ( smoke2_t *ctx, uint8_t reg, uint8_t bit_num );
 
void smoke2_set_mode ( smoke2_t *ctx, uint8_t mode );
 
void smoke2_get_int ( smoke2_t *ctx, uint8_t *fifo, uint8_t *slot_a, uint8_t *slot_b );
 
uint16_t smoke2_read_sens_data ( smoke2_t *ctx, uint8_t slot, uint8_t chn );
 
void smoke2_soft_reset ( smoke2_t *ctx );
 
uint16_t smoke2_smoke_calibration ( smoke2_t *ctx, uint16_t threshold );
 
uint8_t smoke2_check_smoke ( smoke2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SMOKE2_H
 
 // smoke2
 
// ------------------------------------------------------------------------ END