tsc2003.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** 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,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES 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 _TSC2003_H_
#define _TSC2003_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_digital_out.h"
#include "drv_i2c_master.h"
#include "drv_digital_in.h"
#include "drv_name.h"
#include "tp.h"
 
#define TSC2003_I2C_SLAVE_ADDR_FIXED   (0x48)
#define TSC2003_I2C_SLAVE_ADDR_A0      (0x1)
#define TSC2003_I2C_SLAVE_ADDR_A1      (0x2)
#define TSC2003_I2C_SLAVE_ADDR_0       (TSC2003_I2C_SLAVE_ADDR_FIXED)
#define TSC2003_I2C_SLAVE_ADDR_1       (TSC2003_I2C_SLAVE_ADDR_FIXED | \
                                        TSC2003_I2C_SLAVE_ADDR_A0)
#define TSC2003_I2C_SLAVE_ADDR_2       (TSC2003_I2C_SLAVE_ADDR_FIXED | \
                                        TSC2003_I2C_SLAVE_ADDR_A1)
#define TSC2003_I2C_SLAVE_ADDR_3       (TSC2003_I2C_SLAVE_ADDR_FIXED | \
                                        TSC2003_I2C_SLAVE_ADDR_A0 | \
                                        TSC2003_I2C_SLAVE_ADDR_A1)
#ifdef TSC2003_I2C_SLAVE_ADDR_DB
#define TSC2003_I2C_SLAVE_ADDR_DEFAULT (TSC2003_I2C_SLAVE_ADDR_DB)
#else
#define TSC2003_I2C_SLAVE_ADDR_DEFAULT (TSC2003_I2C_SLAVE_ADDR_3)
#endif
 // tsc2003_slave_addresses
 
#define configureData(c,pd,m) ((c<<4)|(pd<<2)|(m<<1))
 // tsc2003_config_data
 
#define TSC2003_MAP_PINS( cfg ) \
    cfg.i2c_cfg.scl = CTP_SCL; \
    cfg.i2c_cfg.sda = CTP_SDA; \
    cfg.int_pin     = CTP_INT
 
typedef enum {
    tsc2003_bits_cfg_measure_temp0, 
    tsc2003_bits_cfg_measure_vbat1, 
    tsc2003_bits_cfg_measure_in1, 
    tsc2003_bits_cfg_measure_temp1 = 0x4, 
    tsc2003_bits_cfg_measure_vbat2, 
    tsc2003_bits_cfg_measure_in2, 
    tsc2003_bits_cfg_measure_activate_drivers_x = 0x8, 
    tsc2003_bits_cfg_measure_activate_drivers_y, 
    tsc2003_bits_cfg_measure_activate_drivers_x_y, 
    tsc2003_bits_cfg_measure_position_x = 0xC, 
    tsc2003_bits_cfg_measure_position_y, 
    tsc2003_bits_cfg_measure_position_z1, 
    tsc2003_bits_cfg_measure_position_z2 
} tsc2003_bits_cfg;
 // tsc2003_bits_cfg
 
typedef enum {
    tsc2003_bits_pd_power_down_between_conversion, 
    tsc2003_bits_pd_int_ref_off_adc_on, 
    tsc2003_bits_pd_int_ref_on_adc_off, 
    tsc2003_bits_pd_int_ref_on_adc_on 
} tsc2003_bits_pd;
 // tsc2003_bits_pd
 
typedef enum {
    tsc2003_bits_m_12bit, 
    tsc2003_bits_m_8bit 
} tsc2003_bits_m;
 // tsc2003_bits_m
 
typedef struct {
    uint16_t min_x;
    uint16_t max_x;
    uint16_t min_y;
    uint16_t max_y;
} tsc2003_calibration_data_t;
 
typedef struct {
    uint16_t tsc2003_pressure_threshold_lower; 
    uint16_t tsc2003_pressure_threshold_upper; 
} tsc2003_pressure_threshold_t;
 
extern const tsc2003_calibration_data_t TSC2003_CALIBRATION_DATA_DEFAULT;
 
typedef struct {
    pin_name_t int_pin; 
    i2c_master_config_t i2c_cfg; 
    uint16_t width; 
    uint16_t height; 
    uint8_t addr_sel; 
    tsc2003_bits_m resolution; 
    tsc2003_bits_pd power_down; 
    tsc2003_pressure_threshold_t pressure_threshold_level;
} tsc2003_cfg_t;
 
typedef struct {
    digital_in_t int_pin; 
    i2c_master_t i2c; 
    uint16_t width; 
    uint16_t height; 
    tp_event_t press_det; 
    tp_touch_item_t touch; 
    tp_event_t gesture; 
    bool pen_down; 
    tsc2003_bits_m resolution; 
    tsc2003_bits_pd power_down; 
    tsc2003_pressure_threshold_t pressure_threshold_level;
 
    tsc2003_calibration_data_t calibration_data;
} tsc2003_t;
 
void tsc2003_cfg_setup( tsc2003_cfg_t * cfg );
 
tp_err_t tsc2003_init( tsc2003_t * ctx, tsc2003_cfg_t * cfg, tp_drv_t * drv );
 
void tsc2003_default_cfg( tsc2003_t* ctx );
 
void tsc2003_press_coordinates( tsc2003_t* ctx, tp_touch_item_t * touch_item );
 
tp_event_t tsc2003_press_detect( tsc2003_t* ctx );
 
tp_err_t tsc2003_process( tsc2003_t * ctx );
 
void tsc2003_gesture( tsc2003_t* ctx, tp_event_t * event );
 
void tsc2003_write_cmd( tsc2003_t * ctx, uint8_t reg_addr );
 
void tsc2003_generic_read( tsc2003_t * ctx, uint8_t reg_addr, uint8_t *data_buff, uint8_t len );
 
void tsc2003_calibrate( tsc2003_t* ctx );
 
void tsc2003_get_calibration_data( tsc2003_t * ctx, tsc2003_calibration_data_t * cdata );
 
void tsc2003_set_calibration_data( tsc2003_t * ctx, const tsc2003_calibration_data_t * cdata );
 
void tsc2003_set_pressure_threshold_level( tsc2003_cfg_t * cfg, tsc2003_pressure_threshold_t pressure );
 
 // middlewaregroup
 // tsc2003
 
#ifdef __cplusplus
}
#endif
 
#endif // _TSC2003_H_
 
// ------------------------------------------------------------------------ END