ldctouch.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 LDCTOUCH_H
#define LDCTOUCH_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 LDCTOUCH_REG_STATUS                 0x00
#define LDCTOUCH_REG_OUT                    0x01
#define LDCTOUCH_REG_DATA0_LSB              0x02
#define LDCTOUCH_REG_DATA0_MSB              0x03
#define LDCTOUCH_REG_DATA1_LSB              0x04
#define LDCTOUCH_REG_DATA1_MSB              0x05
#define LDCTOUCH_REG_DATA2_LSB              0x06
#define LDCTOUCH_REG_DATA2_MSB              0x07
#define LDCTOUCH_REG_DATA3_LSB              0x08
#define LDCTOUCH_REG_DATA3_MSB              0x09
#define LDCTOUCH_REG_RESET                  0x0A
#define LDCTOUCH_REG_EN                     0x0C
#define LDCTOUCH_REG_NP_SCAN_RATE           0x0D
#define LDCTOUCH_REG_GAIN0                  0x0E
#define LDCTOUCH_REG_LP_SCAN_RATE           0x0F
#define LDCTOUCH_REG_GAIN1                  0x10
#define LDCTOUCH_REG_INTPOL                 0x11
#define LDCTOUCH_REG_GAIN2                  0x12
#define LDCTOUCH_REG_LP_BASE_INC            0x13
#define LDCTOUCH_REG_GAIN3                  0x14
#define LDCTOUCH_REG_NP_BASE_INC            0x15
#define LDCTOUCH_REG_BTPAUSE_MAXWIN         0x16
#define LDCTOUCH_REG_LC_DIVIDER             0x17
#define LDCTOUCH_REG_HYST                   0x18
#define LDCTOUCH_REG_TWIST                  0x19
#define LDCTOUCH_REG_COMMON_DEFORM          0x1A
#define LDCTOUCH_REG_OPOL_DPOL              0x1C
#define LDCTOUCH_REG_CNTSC                  0x1E
#define LDCTOUCH_REG_SENSOR0_CONFIG         0x20
#define LDCTOUCH_REG_SENSOR1_CONFIG         0x22
#define LDCTOUCH_REG_SENSOR2_CONFIG         0x24
#define LDCTOUCH_REG_FTF0                   0x25
#define LDCTOUCH_REG_SENSOR3_CONFIG         0x26
#define LDCTOUCH_REG_FTF1_2                 0x28
#define LDCTOUCH_REG_FTF3                   0x2B
#define LDCTOUCH_REG_RAW_DATA0_3            0x59
#define LDCTOUCH_REG_RAW_DATA0_2            0x5A
#define LDCTOUCH_REG_RAW_DATA0_1            0x5B
#define LDCTOUCH_REG_RAW_DATA1_3            0x5C
#define LDCTOUCH_REG_RAW_DATA1_2            0x5D
#define LDCTOUCH_REG_RAW_DATA1_1            0x5E
#define LDCTOUCH_REG_RAW_DATA2_3            0x5F
#define LDCTOUCH_REG_RAW_DATA2_2            0x60
#define LDCTOUCH_REG_RAW_DATA2_1            0x61
#define LDCTOUCH_REG_RAW_DATA3_3            0x62
#define LDCTOUCH_REG_RAW_DATA3_2            0x63
#define LDCTOUCH_REG_RAW_DATA3_1            0x64
#define LDCTOUCH_REG_MANUFACTURER_ID_LSB    0xFC
#define LDCTOUCH_REG_MANUFACTURER_ID_MSB    0xFD
#define LDCTOUCH_REG_DEVICE_ID_LSB          0xFE
#define LDCTOUCH_REG_DEVICE_ID_MSB          0xFF
 
 // ldctouch_reg
 
#define LDCTOUCH_STATUS_OUT                 0x80
#define LDCTOUCH_STATUS_CHIP_READY          0x40
#define LDCTOUCH_STATUS_READY_TO_WRITE      0x20
#define LDCTOUCH_STATUS_MAXOUT              0x10
#define LDCTOUCH_STATUS_FSM_WD              0x08
#define LDCTOUCH_STATUS_LC_WD               0x04
#define LDCTOUCH_STATUS_TIMEOUT             0x02
#define LDCTOUCH_STATUS_REGISTER_FLAG       0x01
 
#define LDCTOUCH_MODE_NORMAL                0x00
#define LDCTOUCH_MODE_CONFIG                0x01
#define LDCTOUCH_MODE_FULL_RESET            0x10
 
#define LDCTOUCH_EN_CH3_LP                  0x80
#define LDCTOUCH_EN_CH2_LP                  0x40
#define LDCTOUCH_EN_CH1_LP                  0x20
#define LDCTOUCH_EN_CH0_LP                  0x10
#define LDCTOUCH_EN_CH3_NP                  0x08
#define LDCTOUCH_EN_CH2_NP                  0x04
#define LDCTOUCH_EN_CH1_NP                  0x02
#define LDCTOUCH_EN_CH0_NP                  0x01
 
#define LDCTOUCH_OPOL3_ACTIVE_HIGH          0x80
#define LDCTOUCH_OPOL3_ACTIVE_LOW           0x00
#define LDCTOUCH_OPOL2_ACTIVE_HIGH          0x40
#define LDCTOUCH_OPOL2_ACTIVE_LOW           0x00
#define LDCTOUCH_OPOL1_ACTIVE_HIGH          0x20
#define LDCTOUCH_OPOL1_ACTIVE_LOW           0x00
#define LDCTOUCH_OPOL0_ACTIVE_HIGH          0x10
#define LDCTOUCH_OPOL0_ACTIVE_LOW           0x00
#define LDCTOUCH_DPOL3_DATA_INCREASES       0x08
#define LDCTOUCH_DPOL3_DATA_DECREASES       0x00
#define LDCTOUCH_DPOL2_DATA_INCREASES       0x04
#define LDCTOUCH_DPOL2_DATA_DECREASES       0x00
#define LDCTOUCH_DPOL1_DATA_INCREASES       0x02
#define LDCTOUCH_DPOL1_DATA_DECREASES       0x00
#define LDCTOUCH_DPOL0_DATA_INCREASES       0x01
#define LDCTOUCH_DPOL0_DATA_DECREASES       0x00
 
#define LDCTOUCH_BUTTON_MODE_FINGER         0x00
#define LDCTOUCH_BUTTON_MODE_METAL          0x01
#define LDCTOUCH_BUTTON_MODE                LDCTOUCH_BUTTON_MODE_FINGER
 
#define LDCTOUCH_MANUFACTURER_ID_LSB        0x49
#define LDCTOUCH_MANUFACTURER_ID_MSB        0x54
#define LDCTOUCH_DEVICE_ID_LSB              0x00
#define LDCTOUCH_DEVICE_ID_MSB              0x40
 
#define LDCTOUCH_DEVICE_ADDRESS             0x2A
 
 // ldctouch_set
 
#define LDCTOUCH_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.s0 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ldctouch_map
 // ldctouch
 
typedef struct
{
    // Input pins
    digital_in_t  s0;           
    digital_in_t  s1;           
    digital_in_t  s2;           
    digital_in_t  s3;           
    digital_in_t  int_pin;      
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} ldctouch_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  s0;             
    pin_name_t  s1;             
    pin_name_t  s2;             
    pin_name_t  s3;             
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} ldctouch_cfg_t;
 
typedef struct
{
    uint8_t status;
    uint8_t out_state;
    int16_t ch0_raw_button;
    int16_t ch1_raw_button;
    int16_t ch2_raw_button;
    int16_t ch3_raw_button;
 
} ldctouch_data_t;
 
typedef enum
{
    LDCTOUCH_OK = 0,
    LDCTOUCH_ERROR = -1
 
} ldctouch_return_value_t;
 
void ldctouch_cfg_setup ( ldctouch_cfg_t *cfg );
 
err_t ldctouch_init ( ldctouch_t *ctx, ldctouch_cfg_t *cfg );
 
err_t ldctouch_default_cfg ( ldctouch_t *ctx );
 
err_t ldctouch_generic_write ( ldctouch_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t ldctouch_generic_read ( ldctouch_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t ldctouch_write_register ( ldctouch_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t ldctouch_read_register ( ldctouch_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t ldctouch_get_s0_pin ( ldctouch_t *ctx );
 
uint8_t ldctouch_get_s1_pin ( ldctouch_t *ctx );
 
uint8_t ldctouch_get_s2_pin ( ldctouch_t *ctx );
 
uint8_t ldctouch_get_s3_pin ( ldctouch_t *ctx );
 
uint8_t ldctouch_get_int_pin ( ldctouch_t *ctx );
 
err_t ldctouch_check_communication ( ldctouch_t *ctx );
 
err_t ldctouch_set_operation_mode ( ldctouch_t *ctx, uint8_t mode );
 
err_t ldctouch_get_data ( ldctouch_t *ctx, ldctouch_data_t *button_data );
 
#ifdef __cplusplus
}
#endif
#endif // LDCTOUCH_H
 
 // ldctouch
 
// ------------------------------------------------------------------------ END