proximity12.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 PROXIMITY12_H
#define PROXIMITY12_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"
 
#define PROXIMITY12_REG_AILT                        0x2E
#define PROXIMITY12_REG_AIHT                        0x31
#define PROXIMITY12_REG_PILT0                       0x34
#define PROXIMITY12_REG_PIHT0                       0x36
#define PROXIMITY12_REG_PILT1                       0x38
#define PROXIMITY12_REG_PIHT1                       0x3A
#define PROXIMITY12_REG_PILTR                       0x3C
#define PROXIMITY12_REG_PIHTR                       0x3E
#define PROXIMITY12_REG_FD_CFG0                     0x40
#define PROXIMITY12_REG_FD_CFG1                     0x41
#define PROXIMITY12_REG_FD_CFG2                     0x42
#define PROXIMITY12_REG_FD_CFG3                     0x43
#define PROXIMITY12_REG_FD_CFG4                     0x44
#define PROXIMITY12_REG_FD_CFG5                     0x45
#define PROXIMITY12_REG_FD_CFG6                     0x46
#define PROXIMITY12_REG_FD_CFG7                     0x47
#define PROXIMITY12_REG_FD_CFG8                     0x48
#define PROXIMITY12_REG_SYNC_DELAY                  0x4F
#define PROXIMITY12_REG_VSYNC_CFG0                  0x53
#define PROXIMITY12_REG_VSYNC_CFG1                  0x54
#define PROXIMITY12_REG_VSYNC_CFG2                  0x56
#define PROXIMITY12_REG_VSYNC_CFG3                  0x57
#define PROXIMITY12_REG_CALIB                       0x69
#define PROXIMITY12_REG_CALIBCFG0                   0x6A
#define PROXIMITY12_REG_CALIBCFG1                   0x6B
#define PROXIMITY12_REG_CALIBCFG2                   0x6C
#define PROXIMITY12_REG_CALIBSTAT                   0x6D
#define PROXIMITY12_REG_ENABLE                      0x80
#define PROXIMITY12_REG_MEAS_MODE0                  0x81
#define PROXIMITY12_REG_MEAS_MODE1                  0x82
#define PROXIMITY12_REG_TRIGGER_MODE                0x83
#define PROXIMITY12_REG_ATIME                       0x84
#define PROXIMITY12_REG_ASTEP                       0x85
#define PROXIMITY12_REG_PTIME                       0x87
#define PROXIMITY12_REG_WTIPE                       0x88
#define PROXIMITY12_REG_MOD_GAIN_0_1                0x89
#define PROXIMITY12_REG_MOD_GAIN_2_3                0x8A
#define PROXIMITY12_REG_MOD_GAIN_4_5                0x8B
#define PROXIMITY12_REG_MOD_GAIN_6_7                0x8C
#define PROXIMITY12_REG_AGC_ENABLE                  0x8D
#define PROXIMITY12_REG_AUXID                       0x90
#define PROXIMITY12_REG_REVID                       0x91
#define PROXIMITY12_REG_ID                          0x92
#define PROXIMITY12_REG_CFG0                        0x93
#define PROXIMITY12_REG_CFG3                        0x96
#define PROXIMITY12_REG_CFG4                        0x97
#define PROXIMITY12_REG_PERS                        0x9A
#define PROXIMITY12_REG_CFG8                        0x9B
#define PROXIMITY12_REG_CFG9                        0x9C
#define PROXIMITY12_REG_CFG10                       0x9D
#define PROXIMITY12_REG_CFG11                       0x9E
#define PROXIMITY12_REG_CFG12                       0x9F
#define PROXIMITY12_REG_AZ_CONFIG                   0xA4
#define PROXIMITY12_REG_CFG20                       0xA7
#define PROXIMITY12_REG_PCFG1                       0xAA
#define PROXIMITY12_REG_PCFG2                       0xAB
#define PROXIMITY12_REG_PCFG3                       0xAC
#define PROXIMITY12_REG_PCFG4                       0xAD
#define PROXIMITY12_REG_PCFG5                       0xAE
#define PROXIMITY12_REG_PCFG6                       0xAF
#define PROXIMITY12_REG_PCFG7                       0xB0
#define PROXIMITY12_REG_POFFSET0                    0xB1
#define PROXIMITY12_REG_PXAVG                       0xB3
#define PROXIMITY12_REG_PBSLN                       0xB5
#define PROXIMITY12_REG_STATUS                      0xB7
#define PROXIMITY12_REG_STATUS2                     0xB8
#define PROXIMITY12_REG_STATUS3                     0xB9
#define PROXIMITY12_REG_STATUS4                     0xBA
#define PROXIMITY12_REG_STATUS5                     0xBB
#define PROXIMITY12_REG_STATUS7                     0xBD
#define PROXIMITY12_REG_STATUS8                     0xBE
#define PROXIMITY12_REG_STATUS9                     0xBF
#define PROXIMITY12_REG_ASTATUS                     0xC0
#define PROXIMITY12_REG_ADATA0                      0xC1
#define PROXIMITY12_REG_ADATA1                      0xC4
#define PROXIMITY12_REG_ADATA2                      0xC7
#define PROXIMITY12_REG_ADATA3                      0xCA
#define PROXIMITY12_REG_ADATA4                      0xCD
#define PROXIMITY12_REG_ADATA5                      0xD0
#define PROXIMITY12_REG_ADATA6                      0xD3
#define PROXIMITY12_REG_ADATA7                      0xD6
#define PROXIMITY12_REG_PSTATUS                     0xD9
#define PROXIMITY12_REG_PDATA0                      0xDA
#define PROXIMITY12_REG_PDATA1                      0xDC
#define PROXIMITY12_REG_PDATAR                      0xDE
#define PROXIMITY12_REG_GPIO                        0xF2
#define PROXIMITY12_REG_AGC_GAIN_MAX                0xF4
#define PROXIMITY12_REG_INTENAB                     0xF5
#define PROXIMITY12_REG_CONTROL                     0xF6
#define PROXIMITY12_REG_POFFSET1                    0xF7
#define PROXIMITY12_REG_FIFO_MAP                    0xF9
#define PROXIMITY12_REG_FIFO_MAP2                   0xFA
#define PROXIMITY12_REG_FIFO_STATUS                 0xFB
#define PROXIMITY12_REG_FDATA                       0xFC
 
 // proximity12_reg
 
#define PROXIMITY12_ENABLE_FLICKER                  0x40
#define PROXIMITY12_ENABLE_ALS                      0x10
#define PROXIMITY12_ENABLE_PROX                     0x08
#define PROXIMITY12_ENABLE_POWER                    0x01
 
#define PROXIMITY12_MEAS_MODE0_CL_APF_VSYNC         0x40
#define PROXIMITY12_MEAS_MODE0_EN_PROX_DIODE        0x0C
#define PROXIMITY12_MEAS_MODE0_ALS_SET_A_DIODE      0x00
#define PROXIMITY12_MEAS_MODE0_ALS_SET_B_DIODE      0x02
#define PROXIMITY12_MEAS_MODE0_EN_ALS_DIODE         0x01
 
#define PROXIMITY12_AGC_DISABLE_ALL_MOD             0x00
#define PROXIMITY12_AGC_ENABLE_ALL_MOD              0xFF
#define PROXIMITY12_AGC_ENABLE_MOD_7                0x80
#define PROXIMITY12_AGC_ENABLE_MOD_6                0x40
#define PROXIMITY12_AGC_ENABLE_MOD_5                0x20
#define PROXIMITY12_AGC_ENABLE_MOD_4                0x10
#define PROXIMITY12_AGC_ENABLE_MOD_3                0x08
#define PROXIMITY12_AGC_ENABLE_MOD_2                0x04
#define PROXIMITY12_AGC_ENABLE_MOD_1                0x02
#define PROXIMITY12_AGC_ENABLE_MOD_0                0x01
#define PROXIMITY12_MOD_GAIN_2X                     0x00
#define PROXIMITY12_MOD_GAIN_4X                     0x01
#define PROXIMITY12_MOD_GAIN_8X                     0x02
#define PROXIMITY12_MOD_GAIN_16X                    0x03
#define PROXIMITY12_MOD_GAIN_32X                    0x04
#define PROXIMITY12_MOD_GAIN_64X                    0x05
#define PROXIMITY12_MOD_GAIN_128X                   0x06
#define PROXIMITY12_MOD_GAIN_256X                   0x07
#define PROXIMITY12_MOD_GAIN_512X                   0x08
#define PROXIMITY12_MOD_GAIN_1024X                  0x09
#define PROXIMITY12_MOD_GAIN_2048X                  0x0A
#define PROXIMITY12_MOD_GAIN_4096X                  0x0B
 
#define PROXIMITY12_PROX_FILTER_ENABLE              0x08
#define PROXIMITY12_PROX_FILTER_1                   0x00
#define PROXIMITY12_PROX_FILTER_2                   0x01
#define PROXIMITY12_PROX_FILTER_3                   0x02
#define PROXIMITY12_PROX_FILTER_4                   0x03
#define PROXIMITY12_PROX_FILTER_5                   0x04
#define PROXIMITY12_PROX_FILTER_6                   0x05
#define PROXIMITY12_PROX_FILTER_7                   0x06
#define PROXIMITY12_PROX_FILTER_8                   0x07
 
#define PROXIMITY12_ISINK_SCALER_0p5                0x00
#define PROXIMITY12_ISINK_SCALER_1                  0x01
#define PROXIMITY12_ISINK_SCALER_1p5                0x02
#define PROXIMITY12_ISINK_SCALER_2                  0x03
#define PROXIMITY12_ISINK_CURRENT_0mA               0x00
#define PROXIMITY12_ISINK_CURRENT_1mA               0x01
#define PROXIMITY12_ISINK_CURRENT_2mA               0x02
#define PROXIMITY12_ISINK_CURRENT_3mA               0x03
#define PROXIMITY12_ISINK_CURRENT_4mA               0x04
#define PROXIMITY12_ISINK_CURRENT_5mA               0x05
#define PROXIMITY12_ISINK_CURRENT_6mA               0x06
#define PROXIMITY12_ISINK_CURRENT_7mA               0x07
 
#define PROXIMITY12_PROX_GAIN_1X                    0x00
#define PROXIMITY12_PROX_GAIN_2X                    0x01
#define PROXIMITY12_PROX_GAIN_4X                    0x02
#define PROXIMITY12_PROX_GAIN_8X                    0x03
 
#define PROXIMITY12_AUXID                           0x03
#define PROXIMITY12_REVID                           0x13
#define PROXIMITY12_ID                              0x40
 
#define PROXIMITY12_SET_DEV_ADDR                    0x39
 
 // proximity12_set
 
#define PROXIMITY12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.syn = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.gp1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // proximity12_map
 // proximity12
 
typedef struct
{
    // Output pins
    digital_out_t  syn;       
    digital_out_t  gp1;       
    digital_out_t  gp2;       
    // Input pins
    digital_in_t  int_pin;    
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} proximity12_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  syn;        
    pin_name_t  gp1;        
    pin_name_t  gp2;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} proximity12_cfg_t;
 
typedef struct
{
    uint32_t clear;
    uint32_t red;
    uint32_t green;
    uint32_t blue;
    uint32_t leakage;
    uint32_t wideband;
    uint32_t ir1;
    uint32_t ir2;
 
} proximity12_als_data_t;
 
typedef enum
{
    PROXIMITY12_OK = 0,
    PROXIMITY12_ERROR = -1
 
} proximity12_return_value_t;
 
void proximity12_cfg_setup ( proximity12_cfg_t *cfg );
 
err_t proximity12_init ( proximity12_t *ctx, proximity12_cfg_t *cfg );
 
err_t proximity12_default_cfg ( proximity12_t *ctx );
 
err_t proximity12_generic_write ( proximity12_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t proximity12_generic_read ( proximity12_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t proximity12_check_device_id ( proximity12_t *ctx );
 
err_t proximity12_read_proximity ( proximity12_t *ctx, uint16_t *prox_data );
 
err_t proximity12_read_als ( proximity12_t *ctx, proximity12_als_data_t *als );
 
err_t proximity12_wait_atime ( proximity12_t *ctx );
 
err_t proximity12_wait_ptime ( proximity12_t *ctx );
 
err_t proximity12_enable ( proximity12_t *ctx, uint8_t en_mask );
 
err_t proximity12_enable_measurement ( proximity12_t *ctx, uint8_t en_mask );
 
err_t proximity12_proximity_calibration ( proximity12_t *ctx );
 
err_t proximity12_set_proximity_filter ( proximity12_t *ctx, uint8_t filter );
 
err_t proximity12_set_led_isink ( proximity12_t *ctx, uint8_t scaler, uint8_t current );
 
err_t proximity12_set_proximity_gain ( proximity12_t *ctx, uint8_t gain );
 
err_t proximity12_set_agc_mod_gain ( proximity12_t *ctx, uint8_t en_mask, uint8_t gain );
 
void proximity12_set_syn_pin ( proximity12_t *ctx, uint8_t state );
 
void proximity12_set_gp1_pin ( proximity12_t *ctx, uint8_t state );
 
void proximity12_set_gp2_pin ( proximity12_t *ctx, uint8_t state );
 
uint8_t proximity12_get_int_pin ( proximity12_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // PROXIMITY12_H
 
 // proximity12
 
// ------------------------------------------------------------------------ END