touchpad2.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 TOUCHPAD2_H
#define TOUCHPAD2_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 TOUCHPAD2_CMD_VERSION_INFO               0x00 
#define TOUCHPAD2_CMD_XY_DATA                    0x01 
#define TOUCHPAD2_CMD_PROXIMITY_STATUS           0x02 
#define TOUCHPAD2_CMD_TOUCH_STATUS               0x03 
#define TOUCHPAD2_CMD_COUNT_VALUES               0x04 
#define TOUCHPAD2_CMD_LONG_TERM_AVERAGES         0x05 
#define TOUCHPAD2_CMD_ATI_COMPENSATION           0x06 
#define TOUCHPAD2_CMD_PORT_CONTROL               0x07 
#define TOUCHPAD2_CMD_SNAP_STATUS                0x08 
#define TOUCHPAD2_CMD_CONTROL_SETTINGS           0x10 
#define TOUCHPAD2_CMD_THRESHOLD_SETTINGS         0x11 
#define TOUCHPAD2_CMD_ATI_SETTINGS               0x12 
#define TOUCHPAD2_CMD_FILTER_SETTINGS            0x13 
#define TOUCHPAD2_CMD_TIMING_SETTINGS            0x14 
#define TOUCHPAD2_CMD_CHANNEL_SETUP              0x15 
#define TOUCHPAD2_CMD_HARDWARE_CONFIG_SETTINGS   0x16 
#define TOUCHPAD2_CMD_ACTIVE_CHANNELS            0x17 
#define TOUCHPAD2_CMD_DEBOUNCE_SETTINGS          0x18 
#define TOUCHPAD2_CMD_PM_PROXIMITY_STATUS        0x20 
#define TOUCHPAD2_CMD_PM_COUNT_VALUES            0x21 
#define TOUCHPAD2_CMD_PM_LONG_TERM_AVERAGES      0x22 
#define TOUCHPAD2_CMD_PM_ATI_COMPENSATION        0x23 
#define TOUCHPAD2_CMD_PM_ATI_SETTINGS            0x24 
#define TOUCHPAD2_CMD_BOOTLOADER                 0xFF
 
 // touchpad2_cmd
 
#define TOUCHPAD2_SET_DEV_ADDR              0x74
 
#define TOUCHPAD2_SHOW_RESET                0x80
#define TOUCHPAD2_MODE_INDICATOR            0x40
#define TOUCHPAD2_NOISE_STATUS              0x20
#define TOUCHPAD2_LP_STATUS                 0x10
#define TOUCHPAD2_SNAP_OUTPUT               0x08
#define TOUCHPAD2_NO_OF_FINGERS             0x07
 
#define TOUCHPAD2_ACK_RESET                 0x80
#define TOUCHPAD2_AUTO_MODES                0x40
#define TOUCHPAD2_SINGLE_XY                 0x20
#define TOUCHPAD2_PM_RESEED                 0x10
#define TOUCHPAD2_MODE_SELECT               0x08
#define TOUCHPAD2_AUTO_ATI                  0x04
#define TOUCHPAD2_TRACKPAD_RESEED           0x02
#define TOUCHPAD2_EVENT_MODE                0x01
#define TOUCHPAD2_DIS_PROX_EVENT            0x80
#define TOUCHPAD2_DIS_TOUCH_EVENT           0x40
#define TOUCHPAD2_DIS_SNAP_EVENT            0x20
#define TOUCHPAD2_DIS_PMPROX_EVENT          0x10
#define TOUCHPAD2_REVERSE_EN                0x08
#define TOUCHPAD2_SLEEP_EN                  0x04
#define TOUCHPAD2_LOW_POWER                 0x02
#define TOUCHPAD2_SNAP_EN                   0x01
 
#define TOUCHPAD2_DIS_NM_FILTER             0x10
#define TOUCHPAD2_DIS_PM_FILTER             0x08
#define TOUCHPAD2_SELECT_TOUCH_FILTER       0x04
#define TOUCHPAD2_DIS_HOVER_FILTER          0x02
#define TOUCHPAD2_DIS_TOUCH_FILTER          0x01
 
#define TOUCHPAD2_CHARGE_TYPE_SELF_CHARG    0x80
#define TOUCHPAD2_CHARGE_MUTUAL_SELF_CHARG  0x00
#define TOUCHPAD2_RX_GROUP_RXB              0x40
#define TOUCHPAD2_RX_GROUP_RXA              0x00
#define TOUCHPAD2_SUM_OF_TP_RX              0x10
#define TOUCHPAD2_SUM_OF_TP_TX              0x00
#define TOUCHPAD2_RX_SELECT                 0x0F
#define TOUCHPAD2_TX_CFG_DEFAULT            0x001F
 
#define TOUCHPAD2_ND_ENABLE                 0x20
#define TOUCHPAD2_RX_FLOAT                  0x04
#define TOUCHPAD2_CK_FREQ_2                 0x40
#define TOUCHPAD2_CK_FREQ_1                 0x20
#define TOUCHPAD2_CK_FREQ_0                 0x10
#define TOUCHPAD2_ANA_DEAD_TIME             0x02
#define TOUCHPAD2_INCR_PHASE                0x01
#define TOUCHPAD2_STAB_TIME_1               0x80
#define TOUCHPAD2_STAB_TIME_0               0x40
#define TOUCHPAD2_OPAMP_BIAS_1              0x20
#define TOUCHPAD2_OPAMP_BIAS_0              0x10
#define TOUCHPAD2_VTRIP_3                   0x08
#define TOUCHPAD2_VTRIP_2                   0x04
#define TOUCHPAD2_VTRIP_1                   0x02
#define TOUCHPAD2_VTRIP_0                   0x01
#define TOUCHPAD2_UPLEN_2                   0x40
#define TOUCHPAD2_UPLEN_1                   0x20
#define TOUCHPAD2_UPLEN_0                   0x10
#define TOUCHPAD2_PASSLEN_2                 0x04
#define TOUCHPAD2_PASSLEN_1                 0x02
#define TOUCHPAD2_PASSLEN_0                 0x01
 
#define TOUCHPAD2_PALM_REJECT               0x08
#define TOUCHPAD2_SWITCH_XY_AXIS            0x04
#define TOUCHPAD2_FLIP_Y                    0x02
#define TOUCHPAD2_FLIP_X                    0x01
 
#define TOUCHPAD2_PROX_EVENT                0x80
#define TOUCHPAD2_TOUCH_EVENT               0x40
#define TOUCHPAD2_SNAP_EVENT                0x20
#define TOUCHPAD2_ALP_PROX_EVENT            0x10
#define TOUCHPAD2_REATI_EVENT               0x08
#define TOUCHPAD2_TP_EVENT                  0x04
#define TOUCHPAD2_GESTURE_EVENT             0x02
#define TOUCHPAD2_EVENT_MODE                0x01
#define TOUCHPAD2_ALP_COUNT_FILTER          0x08
#define TOUCHPAD2_IIR_SELECT                0x04
#define TOUCHPAD2_MAV_FILTER                0x02
#define TOUCHPAD2_IIR_FILTER                0x01 
 
#define TOUCHPAD2_CHARGE_TYPE               0x80
#define TOUCHPAD2_RX_GROUP                  0x40
#define TOUCHPAD2_PROX_REV                  0x20
#define TOUCHPAD2_ALP_ENABLE                0x10 
 
#define TOUCHPAD2_RX7_TX2                   0x80
#define TOUCHPAD2_RX6_TX3                   0x40
#define TOUCHPAD2_RX5_TX4                   0x20
#define TOUCHPAD2_RX4_TX5                   0x10
#define TOUCHPAD2_RX3_TX6                   0x08
#define TOUCHPAD2_RX2_TX7                   0x04
#define TOUCHPAD2_RX1_TX8                   0x02
#define TOUCHPAD2_RX0_TX9                   0x01 
 
 // touchpad2_set
 
#define TOUCHPAD2_PROXIMITY_STATUS     0x00
#define TOUCHPAD2_TOUCH_STATUS         0x01
#define TOUCHPAD2_SNAP_STATUS          0x02
 
 
 // sel_status
 
#define TOUCHPAD2_ID_TAG_TOUCH_1       0x01
#define TOUCHPAD2_ID_TAG_TOUCH_2       0x02
#define TOUCHPAD2_ID_TAG_TOUCH_3       0x03
#define TOUCHPAD2_ID_TAG_TOUCH_4       0x04
#define TOUCHPAD2_ID_TAG_TOUCH_5       0x05
#define TOUCHPAD2_ID_TAG_HOVER_1       0x81
#define TOUCHPAD2_ID_TAG_HOVER_2       0x82
#define TOUCHPAD2_ID_TAG_HOVER_3       0x83
#define TOUCHPAD2_ID_TAG_HOVER_4       0x84
#define TOUCHPAD2_ID_TAG_HOVER_5       0x85
 
 
 // id_tag
 
#define TOUCHPAD2_IQS525_PRODUCT_NUMBER       0x34
 
 
 // product_num
 
#define TOUCHPAD2_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );   \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // touchpad2_map
 // touchpad2
 
typedef struct
{
    // Input pins
 
     digital_in_t  int_pin;   
    // Modules
 
    i2c_master_t i2c;         
    // I2C slave address
 
    uint8_t slave_address;    
} touchpad2_t;
 
typedef struct
{
    pin_name_t  scl;          
    pin_name_t  sda;          
    pin_name_t  int_pin;      
    uint32_t  i2c_speed;      
    uint8_t   i2c_address;    
} touchpad2_cfg_t;
 
typedef struct
{
    uint16_t  product_num;    
    uint16_t  projec_num;     
    float version;            
    uint16_t hw_id;           
    uint16_t hw_revision;     
} touchpad2_ver_info_t;
 
typedef struct
{
    uint8_t   xy_info;        
    uint8_t   no_of_fingers;  
    uint8_t   id_tag;         
    uint16_t  x_pos;          
    uint16_t  y_pos;          
    uint16_t  touch_str;      
} touchpad2_touch_t;
 
typedef struct
{
    uint8_t   total_rx;       
    uint8_t   total_tx;       
    uint8_t   track_pad_rx;   
    uint8_t   track_pad_tx;   
    uint8_t   pm_setup;       
    uint16_t  tx_config;      
} touchpad2_channel_setup_t;
 
typedef enum
{
    TOUCHPAD2_OK = 0,
    TOUCHPAD2_ERROR = -1
 
} touchpad2_return_value_t;
 
void touchpad2_cfg_setup ( touchpad2_cfg_t *cfg );
 
err_t touchpad2_init ( touchpad2_t *ctx, touchpad2_cfg_t *cfg );
 
err_t touchpad2_default_cfg ( touchpad2_t *ctx );
 
err_t touchpad2_generic_write ( touchpad2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t touchpad2_generic_read ( touchpad2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t touchpad2_check_interrupt ( touchpad2_t *ctx );
 
void touchpad2_wait_ready ( touchpad2_t *ctx );
 
err_t touchpad2_channel_setup ( touchpad2_t *ctx, touchpad2_channel_setup_t ch_setup );
 
err_t touchpad2_check_version ( touchpad2_t *ctx, touchpad2_ver_info_t *ver_info );
 
err_t touchpad2_get_touch ( touchpad2_t *ctx, touchpad2_touch_t *touch_data );
 
err_t touchpad2_get_all_data ( touchpad2_t *ctx, uint8_t *rx_data );
 
err_t touchpad2_get_status ( touchpad2_t *ctx, uint8_t sel_status, uint16_t *rx_data );
 
#ifdef __cplusplus
}
#endif
#endif // TOUCHPAD2_H
 
 // touchpad2
 
// ------------------------------------------------------------------------ END