ldc2.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 LDC2_H
#define LDC2_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_spi_master.h"
#include "spi_specifics.h"
 
#define LDC2_REG_DEVICE_ID                      0x00
#define LDC2_REG_RP_MAX                         0x01
#define LDC2_REG_RP_MIN                         0x02
#define LDC2_REG_WDT_FREQ                       0x03
#define LDC2_REG_LDC_CONFIG                     0x04
#define LDC2_REG_COMPARATOR_THLD_HIGH           0x07  
#define LDC2_REG_COMPARATOR_THLD_LOW            0x09              
#define LDC2_REG_INTB_TERMINAL_CONFIG           0x0A
#define LDC2_REG_POWER_CONFIG                   0x0B
#define LDC2_REG_STATUS                         0x20
#define LDC2_REG_PROXIMITY_DATA                 0x22
#define LDC2_REG_FREQ_CNT_DATA_LSB              0x23
#define LDC2_REG_FREQ_CNT_DATA_MID_BYTE         0x24
#define LDC2_REG_FREQ_CNT_DATA_MSB              0x25
 
 // ldc2_reg
 
#define LDC2_DEVICE_ID                          0x84
 
#define LDC2_SPI_READ_MASK                      0x80
#define LDC2_SPI_WRITE_MASK                     0x7F
 
#define LDC2_COMPARATOR_THLD_MIN                0x00
#define LDC2_COMPARATOR_THLD_MAX                0xFF
 
#define LDC2_STATUS_OSC_STOPPED                 0x80
#define LDC2_STATUS_NO_NEW_DATA                 0x40
#define LDC2_STATUS_WAKE_UP_DISABLED            0x20
#define LDC2_STATUS_PROX_DATA_LESS_THAN_THLD    0x10
 
#define LDC2_MHZ_TO_HZ                          1000000.0
#define LDC2_EXTERNAL_OSC_MHZ                   1.8432
#define LDC2_PARALLEL_CAPACITANCE_uF            0.000047
#define LDC2_MIN_SENSOR_FREQ_CONST              68.94
#define LDC2_MIN_SENSOR_FREQ_DIVIDER            2500.0
#define LDC2_ROUND_TO_NEAREST_INT               0.5
#define LDC2_MATH_TWO_PI                        6.28318530717958
 
#define LDC2_SET_DATA_SAMPLE_EDGE               SET_SPI_DATA_SAMPLE_EDGE
#define LDC2_SET_DATA_SAMPLE_MIDDLE             SET_SPI_DATA_SAMPLE_MIDDLE
 
 // ldc2_set
 
#define LDC2_MAP_MIKROBUS( cfg, mikrobus ) \
    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 )
 
 // ldc2_map
 // ldc2
 
typedef struct
{
    digital_in_t  int_pin;          
    // Modules
    spi_master_t  spi;              
    pin_name_t  chip_select;        
} ldc2_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                   
    pin_name_t  mosi;                                   
    pin_name_t  sck;                                    
    pin_name_t  cs;                                     
    // Additional gpio pins
    pin_name_t  int_pin;                                
    // static variable
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} ldc2_cfg_t;
 
typedef enum
{
    LDC2_OK = 0,
    LDC2_ERROR = -1
 
} ldc2_return_value_t;
 
typedef enum
{
    LDC2_RP_3926p991 = 0,
    LDC2_RP_3141p593,
    LDC2_RP_2243p995,
    LDC2_RP_1745p329,
    LDC2_RP_1308p997,
    LDC2_RP_981p748,
    LDC2_RP_747p998,
    LDC2_RP_581p776,
    LDC2_RP_436p332,
    LDC2_RP_349p066,
    LDC2_RP_249p333,
    LDC2_RP_193p926,
    LDC2_RP_145p444,
    LDC2_RP_109p083,
    LDC2_RP_83p111,
    LDC2_RP_64p642,
    LDC2_RP_48p481,
    LDC2_RP_38p785,
    LDC2_RP_27p704,
    LDC2_RP_21p547,
    LDC2_RP_16p160,
    LDC2_RP_12p120,
    LDC2_RP_9p235,
    LDC2_RP_7p182,
    LDC2_RP_5p387,
    LDC2_RP_4p309,
    LDC2_RP_3p078,
    LDC2_RP_2p394,
    LDC2_RP_1p796,
    LDC2_RP_1p347,
    LDC2_RP_1p026,
    LDC2_RP_0p798
 
} ldc2_rp_range_t;
 
typedef enum
{
    LDC2_AMPLITUDE_1V = 0,
    LDC2_AMPLITUDE_2V,
    LDC2_AMPLITUDE_4V,
    
} ldc2_amplitude_t;
 
typedef enum
{
    LDC2_RESPONSE_TIME_192 = 2,
    LDC2_RESPONSE_TIME_384,
    LDC2_RESPONSE_TIME_768,
    LDC2_RESPONSE_TIME_1536,
    LDC2_RESPONSE_TIME_3072,
    LDC2_RESPONSE_TIME_6144,
    
} ldc2_resp_time_t;
 
typedef enum
{
    LDC2_INTB_MODE_DISABLED = 0,
    LDC2_INTB_MODE_WAKE_UP,
    LDC2_INTB_MODE_COMPARATOR_OUT,
    LDC2_INTB_MODE_DRDY = 4,
    
} ldc2_int_mode_t;
 
typedef enum
{
    LDC2_PWR_MODE_STANDBY = 0,
    LDC2_PWR_MODE_ACTIVE
    
} ldc2_pwr_mode_t;
 
void ldc2_cfg_setup ( ldc2_cfg_t *cfg );
 
err_t ldc2_init ( ldc2_t *ctx, ldc2_cfg_t *cfg );
 
err_t ldc2_default_cfg ( ldc2_t *ctx );
 
err_t ldc2_generic_write ( ldc2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ldc2_generic_read ( ldc2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ldc2_check_device_id ( ldc2_t *ctx );
 
err_t ldc2_set_rp_range ( ldc2_t *ctx, ldc2_rp_range_t rp_min, ldc2_rp_range_t rp_max );
 
err_t ldc2_set_ldc_config ( ldc2_t *ctx, ldc2_amplitude_t amplitude, ldc2_resp_time_t res_time );
 
err_t ldc2_set_comparator_threshold ( ldc2_t *ctx, uint8_t thld_low, uint8_t thld_high );
 
err_t ldc2_set_interrupt_mode ( ldc2_t *ctx, ldc2_int_mode_t mode );
 
err_t ldc2_set_power_mode ( ldc2_t *ctx, ldc2_pwr_mode_t mode );
 
err_t ldc2_get_status ( ldc2_t *ctx, uint8_t *status );
 
err_t ldc2_read_raw_data ( ldc2_t *ctx, uint8_t *prox_data, uint32_t *freq_cnt );
 
err_t ldc2_get_response_time ( ldc2_t *ctx, uint16_t *res_time );
 
err_t ldc2_get_sensor_frequency ( ldc2_t *ctx, float *freq );
 
err_t ldc2_get_rp_range ( ldc2_t *ctx, float *rp_min, float *rp_max );
 
err_t ldc2_set_wdt_frequency ( ldc2_t *ctx );
 
uint8_t ldc2_get_int_pin ( ldc2_t *ctx );
 
err_t ldc2_measure_resonance_impedance ( ldc2_t *ctx, uint8_t *prox_data, float *rp_data );
 
err_t ldc2_measure_inductance ( ldc2_t *ctx, float *freq, float *inductance );
 
#ifdef __cplusplus
}
#endif
#endif // LDC2_H
 
 // ldc2
 
// ------------------------------------------------------------------------ END