stmpe811.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 _STMPE811_H_
#define _STMPE811_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "drv_i2c_master.h"
#include "drv_digital_in.h"
#include "drv_name.h"
#include "tp.h"
 
#define STMPE811_I2C_SLAVE_ADDR_0 (0x82 >> 1)
#define STMPE811_I2C_SLAVE_ADDR_1 (0x88 >> 1)
 // stmpe811_slave_addreses
 
#define STMPE811_MAP_PINS( cfg ) \
    cfg.i2c_cfg.scl = CTP_SCL; \
    cfg.i2c_cfg.sda = CTP_SDA; \
    cfg.int_pin     = CTP_INT
 
#define STMPE811_REG_ADDR_CHIP_ID        ((uint8_t)0x00) 
#define STMPE811_REG_ADDR_ID_VER         ((uint8_t)0x02) 
#define STMPE811_REG_ADDR_SYS_CTRL1      ((uint8_t)0x03) 
#define STMPE811_REG_ADDR_SYS_CTRL2      ((uint8_t)0x04) 
#define STMPE811_REG_ADDR_SPI_CFG        ((uint8_t)0x08) 
#define STMPE811_REG_ADDR_INT_CTRL       ((uint8_t)0x09) 
#define STMPE811_REG_ADDR_INT_EN         ((uint8_t)0x0A) 
#define STMPE811_REG_ADDR_INT_STA        ((uint8_t)0x0B) 
#define STMPE811_REG_ADDR_GPIO_EN        ((uint8_t)0x0C) 
#define STMPE811_REG_ADDR_GPIO_INT_STA   ((uint8_t)0x0D) 
#define STMPE811_REG_ADDR_ADC_INT_EN     ((uint8_t)0x0E) 
#define STMPE811_REG_ADDR_ADC_INT_STA    ((uint8_t)0x0F) 
#define STMPE811_REG_ADDR_GPIO_SET_PIN   ((uint8_t)0x10) 
#define STMPE811_REG_ADDR_GPIO_CLR_PIN   ((uint8_t)0x11) 
#define STMPE811_REG_ADDR_GPIO_MP_STA    ((uint8_t)0x12) 
#define STMPE811_REG_ADDR_GPIO_DIR       ((uint8_t)0x13) 
#define STMPE811_REG_ADDR_GPIO_ED        ((uint8_t)0x14) 
#define STMPE811_REG_ADDR_GPIO_RE        ((uint8_t)0x15) 
#define STMPE811_REG_ADDR_GPIO_FE        ((uint8_t)0x16) 
#define STMPE811_REG_ADDR_GPIO_AF        ((uint8_t)0x17) 
#define STMPE811_REG_ADDR_ADC_CTRL1      ((uint8_t)0x20) 
#define STMPE811_REG_ADDR_ADC_CTRL2      ((uint8_t)0x21) 
#define STMPE811_REG_ADDR_ADC_CAPT       ((uint8_t)0x22) 
#define STMPE811_REG_ADDR_ADC_DATA_CH0   ((uint8_t)0x30) 
#define STMPE811_REG_ADDR_ADC_DATA_CH1   ((uint8_t)0x32) 
#define STMPE811_REG_ADDR_ADC_DATA_CH2   ((uint8_t)0x34) 
#define STMPE811_REG_ADDR_ADC_DATA_CH3   ((uint8_t)0x36) 
#define STMPE811_REG_ADDR_ADC_DATA_CH4   ((uint8_t)0x38) 
#define STMPE811_REG_ADDR_ADC_DATA_CH5   ((uint8_t)0x3A) 
#define STMPE811_REG_ADDR_ADC_DATA_CH6   ((uint8_t)0x3C) 
#define STMPE811_REG_ADDR_ADC_DATA_CH7   ((uint8_t)0x3E) 
#define STMPE811_REG_ADDR_TSC_CTRL       ((uint8_t)0x40) 
#define STMPE811_REG_ADDR_TSC_CFG        ((uint8_t)0x41) 
#define STMPE811_REG_ADDR_WDW_TR_X       ((uint8_t)0x42) 
#define STMPE811_REG_ADDR_WDW_TR_Y       ((uint8_t)0x44) 
#define STMPE811_REG_ADDR_WDW_BL_X       ((uint8_t)0x46) 
#define STMPE811_REG_ADDR_WDW_BL_Y       ((uint8_t)0x48) 
#define STMPE811_REG_ADDR_FIFO_TH        ((uint8_t)0x4A) 
#define STMPE811_REG_ADDR_FIFO_STA       ((uint8_t)0x4B) 
#define STMPE811_REG_ADDR_FIFO_SIZE      ((uint8_t)0x4C) 
#define STMPE811_REG_ADDR_TSC_DATA_X     ((uint8_t)0x4D) 
#define STMPE811_REG_ADDR_TSC_DATA_Y     ((uint8_t)0x4F) 
#define STMPE811_REG_ADDR_TSC_DATA_Z     ((uint8_t)0x51) 
#define STMPE811_REG_ADDR_TSC_DATA_XYZ   ((uint8_t)0x52) 
#define STMPE811_REG_ADDR_TSC_FRACTION_Z ((uint8_t)0x56) 
#define STMPE811_REG_ADDR_TSC_DATA       ((uint8_t)0x57) 
#define STMPE811_REG_ADDR_TSC_I_DRIVE    ((uint8_t)0x58) 
#define STMPE811_REG_ADDR_TSC_SHIELD     ((uint8_t)0x59) 
#define STMPE811_REG_ADDR_TEMP_CTRL      ((uint8_t)0x60) 
#define STMPE811_REG_ADDR_TEMP_DATA      ((uint8_t)0x61) 
#define STMPE811_REG_ADDR_TEMP_TH        ((uint8_t)0x62) 
#define STMPE811_FIFO_STA_START          ((uint8_t)( 0 ))
#define STMPE811_FIFO_STA_RESET          ((uint8_t)( 1 ))
#define STMPE811_FIFO_TH_TRIG_BIT        ((uint8_t)( 1 << 4 ))
#define STMPE811_FIFO_EMPTY_BIT          ((uint8_t)( 1 << 5 ))
#define STMPE811_FIFO_FULL_BIT           ((uint8_t)( 1 << 6 ))
#define STMPE811_FIFO_OFLOW_BIT          ((uint8_t)( 1 << 7 ))
 // FIFO_STA_register_bits
 
#define STMPE811_TSC_CTRL_ENABLE         ((uint8_t)( 1 ))
#define STMPE811_TSC_CTRL_OP_MOD_XYZ     ((uint8_t)( 0 ))
#define STMPE811_TSC_CTRL_OP_MOD_XY      ((uint8_t)( 1 << 1 ))
#define STMPE811_TSC_CTRL_OP_MOD_X       ((uint8_t)( 2 << 1 ))
#define STMPE811_TSC_CTRL_OP_MOD_Y       ((uint8_t)( 3 << 1 ))
#define STMPE811_TSC_CTRL_OP_MOD_Z       ((uint8_t)( 4 << 1 ))
#define STMPE811_TSC_CTRL_STA_BIT        ((uint8_t)( 1 << 7 ))
 // TSC_CTRL_register_bits
 
#define STMPE811_INT_CTRL_GLOBAL_INT_BIT    ((uint8_t)( 1 ))
#define STMPE811_INT_CTRL_INT_TYPE_BIT      ((uint8_t)( 1 << 1 ))
#define STMPE811_INT_CTRL_INT_POLARITY_BIT  ((uint8_t)( 1 << 2 ))
 // INT_CTRL_register_bits
 
#define STMPE811_SYS_CTRL2_ADC_OFF_BIT    ((uint8_t)( 1 ))
#define STMPE811_SYS_CTRL2_TSC_OFF_BIT    ((uint8_t)( 1 << 1 ))
#define STMPE811_SYS_CTRL2_GPIO_OFF_BIT   ((uint8_t)( 1 << 2 ))
#define STMPE811_SYS_CTRL2_TS_OFF_BIT     ((uint8_t)( 1 << 3 ))
 // SYS_CTRL2_register_bits
 
#define STMPE811_INT_GPIO       ((uint8_t)( 1 << 7 ))
#define STMPE811_INT_ADC        ((uint8_t)( 1 << 6 ))
#define STMPE811_INT_TEMP_SENS  ((uint8_t)( 1 << 5 ))
#define STMPE811_INT_FIFO_EMPTY ((uint8_t)( 1 << 4 ))
#define STMPE811_INT_FIFO_FULL  ((uint8_t)( 1 << 3 ))
#define STMPE811_INT_FIFO_OFLOW ((uint8_t)( 1 << 2 ))
#define STMPE811_INT_FIFO_TH    ((uint8_t)( 1 << 1 ))
#define STMPE811_INT_TOUCH_DET  ((uint8_t)( 1 ))
#define STMPE811_INT_ALL        ((uint8_t)( 0xff ))
 // INTERUPT_bits
 
#define STMPE811_ADC_CTRL2_ADC_FREQ_1_625_MHz   ((uint8_t)( 0 ))
#define STMPE811_ADC_CTRL2_ADC_FREQ_3_25_MHz    ((uint8_t)( 1 ))
#define STMPE811_ADC_CTRL2_ADC_FREQ_6_5_MHz     ((uint8_t)( 2 ))
#define STMPE811_ADC_CTRL2_ADC_FREQ_6_5_MHz_ALT ((uint8_t)( 3 ))
 // ADC_CTRL2_bits
 
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_36        ((uint8_t)( 0 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_44        ((uint8_t)( 1 << 4 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_56        ((uint8_t)( 2 << 4 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_64        ((uint8_t)( 3 << 4 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_80        ((uint8_t)( 4 << 4 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_96        ((uint8_t)( 5 << 4 ))
#define STMPE811_ADC_CTRL1_SAMPLE_TIME_124       ((uint8_t)( 6 << 4 ))
#define STMPE811_ADC_CTRL1_MOD_12B               ((uint8_t)( 1 << 3 ))
#define STMPE811_ADC_CTRL1_REF_SEL_EXTERNAL      ((uint8_t)( 1 << 1 ))
#define STMPE811_ADC_CTRL1_REF_SEL_INTERNAL      ((uint8_t)( 0 ))
 // ADC_CTRL1_bits
 
#define STMPE811_TSC_CFG_SETTLING_10us          ((uint8_t)( 0 ))
#define STMPE811_TSC_CFG_SETTLING_100us         ((uint8_t)( 1 ))
#define STMPE811_TSC_CFG_SETTLING_500us         ((uint8_t)( 2 ))
#define STMPE811_TSC_CFG_SETTLING_1ms           ((uint8_t)( 3 ))
#define STMPE811_TSC_CFG_SETTLING_5ms           ((uint8_t)( 4 ))
#define STMPE811_TSC_CFG_SETTLING_10ms          ((uint8_t)( 5 ))
#define STMPE811_TSC_CFG_SETTLING_50ms          ((uint8_t)( 6 ))
#define STMPE811_TSC_CFG_SETTLING_100ms         ((uint8_t)( 7 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_10us   ((uint8_t)( 0 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_100us  ((uint8_t)( 1 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_500us  ((uint8_t)( 2 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_1ms    ((uint8_t)( 3 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_5ms    ((uint8_t)( 4 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_10ms   ((uint8_t)( 5 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_50ms   ((uint8_t)( 6 << 3 ))
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_100ms  ((uint8_t)( 7 << 3 ))
#define STMPE811_TSC_CFG_AVE_CTRL_1_SAMPLE      ((uint8_t)( 0 ))
#define STMPE811_TSC_CFG_AVE_CTRL_2_SAMPLES     ((uint8_t)( 1 << 6 ))
#define STMPE811_TSC_CFG_AVE_CTRL_4_SAMPLES     ((uint8_t)( 2 << 6 ))
#define STMPE811_TSC_CFG_AVE_CTRL_8_SAMPLES     ((uint8_t)( 3 << 6 ))
 // TSC_CFG_register_bits
 
typedef struct {
    uint16_t min_x;
    uint16_t max_x;
    uint16_t min_y;
    uint16_t max_y;
} stmpe811_calibration_data_t;
 
extern const stmpe811_calibration_data_t STMPE811_DEFAULT_CALIBRATION_DATA;
 
typedef struct {
    pin_name_t int_pin; 
    i2c_master_config_t i2c_cfg; 
    uint16_t width; 
    uint16_t height; 
    uint8_t addr_sel; 
    uint8_t press_threshold; 
} stmpe811_cfg_t;
 
typedef struct {
    i2c_master_t i2c; 
    digital_in_t int_pin; 
    tp_event_t press_det; 
    tp_touch_item_t touch; 
    tp_event_t gesture; 
    bool pen_down; 
    uint16_t width; 
    uint16_t height; 
    uint8_t press_threshold; 
    stmpe811_calibration_data_t calibration_data;
} stmpe811_t;
 
void stmpe811_cfg_setup( stmpe811_cfg_t * cfg );
 
tp_err_t stmpe811_init( stmpe811_t * ctx, stmpe811_cfg_t * cfg, tp_drv_t * drv );
 
void stmpe811_default_cfg( stmpe811_t* ctx );
 
void stmpe811_press_coordinates( stmpe811_t* ctx, tp_touch_item_t * touch_item );
 
tp_event_t stmpe811_press_detect( stmpe811_t* ctx );
 
tp_err_t stmpe811_process( stmpe811_t * ctx );
 
void stmpe811_gesture( stmpe811_t* ctx, tp_event_t * event );
 
uint8_t stmpe811_generic_read_byte( stmpe811_t * ctx, uint8_t reg_addr );
 
void stmpe811_generic_write_byte( stmpe811_t * ctx, uint8_t reg_addr, uint8_t val );
 
void stmpe811_generic_read( stmpe811_t * ctx, uint8_t reg_addr, uint8_t * buff, uint8_t len );
 
void stmpe811_generic_write( stmpe811_t * ctx, uint8_t reg_addr, uint8_t * buff, uint8_t len );
 
void stmpe811_calibrate( stmpe811_t* ctx );
 
void stmpe811_read_xyz( stmpe811_t * ctx, uint16_t* x, uint16_t* y, uint16_t* z );
 
void stmpe811_read_xyz_raw( stmpe811_t * ctx, uint16_t* x, uint16_t* y, uint16_t* z );
 
void stmpe811_get_calibration_data( stmpe811_t * ctx, stmpe811_calibration_data_t * cdata );
 
void stmpe811_set_calibration_data( stmpe811_t * ctx, const stmpe811_calibration_data_t * cdata );
 
 // middlewaregroup
 // stmpe811
 
#ifdef __cplusplus
}
#endif
 
#endif // _STMPE811_H_
 
// ------------------------------------------------------------------------ END