stmpe.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * 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 _ULTIBO_STMPE_H
#define _ULTIBO_STMPE_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/gpio.h"
#include "ultibo/i2c.h"
#include "ultibo/spi.h"
#include "ultibo/touch.h"

#define STMPE610_GPIO_DESCRIPTION   "STMicroelectronics STMPE610 I/O Expander" 
#define STMPE801_GPIO_DESCRIPTION   "STMicroelectronics STMPE801 I/O Expander" 
#define STMPE811_GPIO_DESCRIPTION   "STMicroelectronics STMPE811 I/O Expander" 
#define STMPE1601_GPIO_DESCRIPTION  "STMicroelectronics STMPE1601 I/O Expander" 
#define STMPE1801_GPIO_DESCRIPTION  "STMicroelectronics STMPE1801 I/O Expander" 
#define STMPE2401_GPIO_DESCRIPTION  "STMicroelectronics STMPE2401 I/O Expander" 
#define STMPE2403_GPIO_DESCRIPTION  "STMicroelectronics STMPE2403 I/O Expander" 
 
#define STMPE610_TOUCH_DESCRIPTION  "STMicroelectronics STMPE610 Touch Controller" 
#define STMPE811_TOUCH_DESCRIPTION  "STMicroelectronics STMPE811 Touch Controller" 
 
#define STMPE610_GPIO_MIN_PIN   GPIO_PIN_2
#define STMPE610_GPIO_MAX_PIN   GPIO_PIN_7
#define STMPE610_GPIO_PIN_COUNT 6
 
#define STMPE801_GPIO_MIN_PIN   GPIO_PIN_0
#define STMPE801_GPIO_MAX_PIN   GPIO_PIN_7
#define STMPE801_GPIO_PIN_COUNT 8
 
#define STMPE811_GPIO_MIN_PIN   GPIO_PIN_0
#define STMPE811_GPIO_MAX_PIN   GPIO_PIN_7
#define STMPE811_GPIO_PIN_COUNT 8
 
#define STMPE1601_GPIO_MIN_PIN  GPIO_PIN_0
#define STMPE1601_GPIO_MAX_PIN  GPIO_PIN_15
#define STMPE1601_GPIO_PIN_COUNT    16
 
#define STMPE1801_GPIO_MIN_PIN  GPIO_PIN_0
#define STMPE1801_GPIO_MAX_PIN  GPIO_PIN_17
#define STMPE1801_GPIO_PIN_COUNT    18
 
#define STMPE240X_GPIO_MIN_PIN  GPIO_PIN_0
#define STMPE240X_GPIO_MAX_PIN  GPIO_PIN_23
#define STMPE240X_GPIO_PIN_COUNT    24
 
#define STMPE_GPIO_MAX_LEVEL    GPIO_LEVEL_HIGH
 
#define STMPE_GPIO_MAX_PULL GPIO_PULL_DOWN
 
#define STMPE610_GPIO_MIN_FUNCTION  GPIO_FUNCTION_IN
#define STMPE610_GPIO_MAX_FUNCTION  GPIO_FUNCTION_ALT0
#define STMPE610_GPIO_FUNCTION_COUNT    3
 
#define STMPE801_GPIO_MIN_FUNCTION  GPIO_FUNCTION_IN
#define STMPE801_GPIO_MAX_FUNCTION  GPIO_FUNCTION_OUT
#define STMPE801_GPIO_FUNCTION_COUNT    2
 
#define STMPE811_GPIO_MIN_FUNCTION  GPIO_FUNCTION_IN
#define STMPE811_GPIO_MAX_FUNCTION  GPIO_FUNCTION_ALT0
#define STMPE811_GPIO_FUNCTION_COUNT    3
 
#define STMPE1601_GPIO_MIN_FUNCTION GPIO_FUNCTION_IN
#define STMPE1601_GPIO_MAX_FUNCTION GPIO_FUNCTION_ALT1 
#define STMPE1601_GPIO_FUNCTION_COUNT   4
 
#define STMPE1801_GPIO_MIN_FUNCTION GPIO_FUNCTION_IN
#define STMPE1801_GPIO_MAX_FUNCTION GPIO_FUNCTION_ALT0
#define STMPE1801_GPIO_FUNCTION_COUNT   3
 
#define STMPE240X_GPIO_MIN_FUNCTION GPIO_FUNCTION_IN
#define STMPE240X_GPIO_MAX_FUNCTION GPIO_FUNCTION_ALT2
#define STMPE240X_GPIO_FUNCTION_COUNT   5
 
#define STMPE610_MAX_POINTS 1
#define STMPE610_MAX_X  0xFFF
#define STMPE610_MAX_Y  0xFFF
#define STMPE610_MAX_Z  0xFF
 
#define STMPE811_MAX_POINTS 1
#define STMPE811_MAX_X  0xFFF
#define STMPE811_MAX_Y  0xFFF
#define STMPE811_MAX_Z  0xFF

#define STMPE_CHIP_STMPE610 1
#define STMPE_CHIP_STMPE801 2
#define STMPE_CHIP_STMPE811 3
#define STMPE_CHIP_STMPE1601    4
#define STMPE_CHIP_STMPE1801    5
#define STMPE_CHIP_STMPE2401    6
#define STMPE_CHIP_STMPE2403    7

#define STMPE_DIR_ASCENDING 0 
#define STMPE_DIR_DESCENDING    1 

#define STMPE_I2C_RATE  400000 

#define STMPE_SPI_RATE  500000 
 
#define STMPE_SPI_READ_CMD  (1 << 7) 

#define STMPE811_REG_CHIP_ID    0x00 
#define STMPE811_REG_ID_VER 0x02 
#define STMPE811_REG_SYS_CTRL1  0x03 
#define STMPE811_REG_SYS_CTRL2  0x04 
#define STMPE811_REG_SPI_CFG    0x08 
#define STMPE811_REG_INT_CTRL   0x09 
#define STMPE811_REG_INT_EN 0x0A 
#define STMPE811_REG_INT_STA    0x0B 
 
#define STMPE811_REG_GPIO_INT_EN    0x0C 
#define STMPE811_REG_GPIO_INT_STA   0x0D 
#define STMPE811_REG_ADC_INT_EN 0x0E 
#define STMPE811_REG_ADC_INT_STA    0x0F 
#define STMPE811_REG_GPIO_SET_PIN   0x10 
#define STMPE811_REG_GPIO_CLR_PIN   0x11 
#define STMPE811_REG_GPIO_MP_STA    0x12 
#define STMPE811_REG_GPIO_SET_DIR   0x13 
#define STMPE811_REG_GPIO_ED    0x14 
#define STMPE811_REG_GPIO_RE    0x15 
#define STMPE811_REG_GPIO_FE    0x16 
#define STMPE811_REG_GPIO_AF    0x17 
 
#define STMPE811_REG_ADC_CTRL1  0x20 
#define STMPE811_REG_ADC_CTRL2  0x21 
#define STMPE811_REG_ADC_CAPT   0x22 
#define STMPE811_REG_ADC_DATA_CH0   0x30 
#define STMPE811_REG_ADC_DATA_CH1   0x32 
#define STMPE811_REG_ADC_DATA_CH2   0x34 
#define STMPE811_REG_ADC_DATA_CH3   0x36 
#define STMPE811_REG_ADC_DATA_CH4   0x38 
#define STMPE811_REG_ADC_DATA_CH5   0x3A 
#define STMPE811_REG_ADC_DATA_CH6   0x3C 
#define STMPE811_REG_ADC_DATA_CH7   0x3E 
 
#define STMPE811_REG_TSC_CTRL   0x40 
#define STMPE811_REG_TSC_CFG    0x41 
#define STMPE811_REG_WDW_TR_X   0x42 
#define STMPE811_REG_WDW_TR_Y   0x44 
#define STMPE811_REG_WDW_BL_X   0x46 
#define STMPE811_REG_WDW_BL_Y   0x48 
#define STMPE811_REG_FIFO_TH    0x4A 
#define STMPE811_REG_FIFO_STA   0x4B 
#define STMPE811_REG_FIFO_SIZE  0x4C 
#define STMPE811_REG_TSC_DATA_X 0x4D 
#define STMPE811_REG_TSC_DATA_Y 0x4F 
#define STMPE811_REG_TSC_DATA_Z 0x51 
#define STMPE811_REG_TSC_DATA_XYZ   0x52 
#define STMPE811_REG_TSC_FRACTION_Z 0x56 
#define STMPE811_REG_TSC_DATA   0x57 
#define STMPE811_REG_TSC_I_DRIVE    0x58 
#define STMPE811_REG_TSC_SHIELD 0x59 
#define STMPE811_REG_TEMP_CTRL  0x60 
#define STMPE811_REG_TEMP_DATA  0x61 
#define STMPE811_REG_TEMP_TH    0x62 
 
#define STMPE811_REG_MAX    0x62
#define STMPE811_REG_SIZE   1

#define STMPE801_REG_CHIP_ID    0x00 
#define STMPE801_REG_ID_VER 0x02 
#define STMPE801_REG_SYS_CTRL   0x04 
#define STMPE801_REG_GPIO_INT_EN    0x08 
#define STMPE801_REG_GPIO_INT_STA   0x09 
#define STMPE801_REG_GPIO_MP_STA    0x10 
#define STMPE801_REG_GPIO_SET_PIN   0x11 
#define STMPE801_REG_GPIO_SET_DIR   0x12 
 
#define STMPE801_REG_MAX    0x12
#define STMPE801_REG_SIZE   1

#define STMPE1601_REG_CHIP_ID   0x80 
#define STMPE1601_REG_ID_VER    0x81 
 
#define STMPE1601_REG_SYS_CTRL  0x02 
#define STMPE1601_REG_SYS_CTRL2 0x03 
#define STMPE1601_REG_INT_CTRL_MSB  0x10 
#define STMPE1601_REG_INT_CTRL_LSB  0x11
#define STMPE1601_REG_INT_EN_MSB    0x12 
#define STMPE1601_REG_INT_EN_LSB    0x13
#define STMPE1601_REG_INT_STA_MSB   0x14 
#define STMPE1601_REG_INT_STA_LSB   0x15
 
#define STMPE1601_REG_GPIO_INT_EN_MSB   0x16 
#define STMPE1601_REG_GPIO_INT_EN_LSB   0x17
#define STMPE1601_REG_GPIO_INT_STA_MSB  0x18 
#define STMPE1601_REG_GPIO_INT_STA_LSB  0x19
 
#define STMPE1601_REG_GPIO_SET_PIN_MSB  0x82 
#define STMPE1601_REG_GPIO_SET_PIN_LSB  0x83
#define STMPE1601_REG_GPIO_CLR_PIN_MSB  0x84 
#define STMPE1601_REG_GPIO_CLR_PIN_LSB  0x85
#define STMPE1601_REG_GPIO_MP_STA_MSB   0x86 
#define STMPE1601_REG_GPIO_MP_STA_LSB   0x87
#define STMPE1601_REG_GPIO_SET_DIR_MSB  0x88 
#define STMPE1601_REG_GPIO_SET_DIR_LSB  0x89
 
#define STMPE1601_REG_GPIO_ED_MSB   0x8A 
#define STMPE1601_REG_GPIO_ED_LSB   0x8B
#define STMPE1601_REG_GPIO_RE_MSB   0x8C 
#define STMPE1601_REG_GPIO_RE_LSB   0x8D
#define STMPE1601_REG_GPIO_FE_MSB   0x8E 
#define STMPE1601_REG_GPIO_FE_LSB   0x8F
#define STMPE1601_REG_GPIO_PU_MSB   0x90 
#define STMPE1601_REG_GPIO_PU_LSB   0x91
#define STMPE1601_REG_GPIO_AF_U_MSB 0x92 
#define STMPE1601_REG_GPIO_AF_U_LSB 0x93
#define STMPE1601_REG_GPIO_AF_L_MSB 0x94 
#define STMPE1601_REG_GPIO_AF_L_LSB 0x95
 
#define STMPE1601_REG_GPIO_LT_EN    0x96 
#define STMPE1601_REG_GPIO_LT_DIR   0x97 
 
#define STMPE1601_REG_MAX   0xBF
#define STMPE1601_REG_SIZE  2

#define STMPE1801_REG_CHIP_ID   0x00 
#define STMPE1801_REG_ID_VER    0x01 
 
#define STMPE1801_REG_SYS_CTRL  0x02 
#define STMPE1801_REG_INT_CTRL_LOW  0x04 
#define STMPE1801_REG_INT_CTRL_HIGH 0x05
#define STMPE1801_REG_INT_EN_LOW    0x06 
#define STMPE1801_REG_INT_EN_HIGH   0x07
#define STMPE1801_REG_INT_STA_LOW   0x08 
#define STMPE1801_REG_INT_STA_HIGH  0x09
 
#define STMPE1801_REG_GPIO_INT_EN_LOW   0x0A 
#define STMPE1801_REG_GPIO_INT_EN_MID   0x0B
#define STMPE1801_REG_GPIO_INT_EN_HIGH  0x0C
#define STMPE1801_REG_GPIO_INT_STA_LOW  0x0D 
#define STMPE1801_REG_GPIO_INT_STA_MID  0x0E
#define STMPE1801_REG_GPIO_INT_STA_HIGH 0x0F
#define STMPE1801_REG_GPIO_SET_PIN_LOW  0x10 
#define STMPE1801_REG_GPIO_SET_PIN_MID  0x11
#define STMPE1801_REG_GPIO_SET_PIN_HIGH 0x12
#define STMPE1801_REG_GPIO_CLR_PIN_LOW  0x13 
#define STMPE1801_REG_GPIO_CLR_PIN_MID  0x14
#define STMPE1801_REG_GPIO_CLR_PIN_HIGH 0x15
#define STMPE1801_REG_GPIO_MP_STA_LOW   0x16 
#define STMPE1801_REG_GPIO_MP_STA_MID   0x17
#define STMPE1801_REG_GPIO_MP_STA_HIGH  0x18
#define STMPE1801_REG_GPIO_SET_DIR_LOW  0x19 
#define STMPE1801_REG_GPIO_SET_DIR_MID  0x1A
#define STMPE1801_REG_GPIO_SET_DIR_HIGH 0x1B
 
#define STMPE1801_REG_GPIO_RE_LOW   0x1C 
#define STMPE1801_REG_GPIO_RE_MID   0x1D
#define STMPE1801_REG_GPIO_RE_HIGH  0x1E
#define STMPE1801_REG_GPIO_FE_LOW   0x1F 
#define STMPE1801_REG_GPIO_FE_MID   0x20
#define STMPE1801_REG_GPIO_FE_HIGH  0x21
#define STMPE1801_REG_GPIO_PULL_UP_LOW  0x22 
#define STMPE1801_REG_GPIO_PULL_UP_MID  0x23
#define STMPE1801_REG_GPIO_PULL_UP_HIGH 0x24
 
#define STMPE1801_REG_KPC_ROW   0x30 
#define STMPE1801_REG_KPC_COL_LOW   0x31 
#define STMPE1801_REG_KPC_COL_HIGH  0x32
#define STMPE1801_REG_KPC_CTRL_LOW  0x33 
#define STMPE1801_REG_KPC_CTRL_MID  0x34
#define STMPE1801_REG_KPC_CTRL_HIGH 0x35
#define STMPE1801_REG_KPC_CMD   0x36 
#define STMPE1801_REG_KPC_COMB_KEY_0    0x37 
#define STMPE1801_REG_KPC_COMB_KEY_1    0x38
#define STMPE1801_REG_KPC_COMB_KEY_2    0x39
#define STMPE1801_REG_KPC_DATA_BYTE0    0x3A 
#define STMPE1801_REG_KPC_DATA_BYTE1    0x3B
#define STMPE1801_REG_KPC_DATA_BYTE2    0x3C
#define STMPE1801_REG_KPC_DATA_BYTE3    0x3D
#define STMPE1801_REG_KPC_DATA_BYTE4    0x3E
 
#define STMPE1801_REG_MAX   0x3E
#define STMPE1801_REG_SIZE  3

#define STMPE240X_REG_CHIP_ID   0x80 
#define STMPE240X_REG_ID_VER    0x81 
 
#define STMPE240X_REG_SYS_CTRL  0x02 
#define STMPE240X_REG_INT_CTRL_MSB  0x10 
#define STMPE240X_REG_INT_CTRL_LSB  0x11
#define STMPE240X_REG_INT_EN_MSB    0x12 
#define STMPE240X_REG_INT_EN_LSB    0x13
#define STMPE240X_REG_INT_STA_MSB   0x14 
#define STMPE240X_REG_INT_STA_LSB   0x15
 
#define STMPE240X_REG_GPIO_INT_EN_MSB   0x16 
#define STMPE240X_REG_GPIO_INT_EN_MID   0x17
#define STMPE240X_REG_GPIO_INT_EN_LSB   0x18
#define STMPE240X_REG_GPIO_INT_STA_MSB  0x19 
#define STMPE240X_REG_GPIO_INT_STA_MID  0x1A
#define STMPE240X_REG_GPIO_INT_STA_LSB  0x1B
#define STMPE240X_REG_GPIO_MP_STA_MSB   0xA2 
#define STMPE240X_REG_GPIO_MP_STA_MID   0xA3
#define STMPE240X_REG_GPIO_MP_STA_LSB   0xA4
#define STMPE240X_REG_GPIO_SET_PIN_MSB  0x83 
#define STMPE240X_REG_GPIO_SET_PIN_MID  0x84
#define STMPE240X_REG_GPIO_SET_PIN_LSB  0x85
#define STMPE240X_REG_GPIO_CLR_PIN_MSB  0x86 
#define STMPE240X_REG_GPIO_CLR_PIN_MID  0x87
#define STMPE240X_REG_GPIO_CLR_PIN_LSB  0x88
#define STMPE240X_REG_GPIO_SET_DIR_MSB  0x89 
#define STMPE240X_REG_GPIO_SET_DIR_MID  0x8A
#define STMPE240X_REG_GPIO_SET_DIR_LSB  0x8B
#define STMPE240X_REG_GPIO_ED_MSB   0x8C 
#define STMPE240X_REG_GPIO_ED_MID   0x8D
#define STMPE240X_REG_GPIO_ED_LSB   0x8E
#define STMPE240X_REG_GPIO_RE_MSB   0x8F 
#define STMPE240X_REG_GPIO_RE_MID   0x90
#define STMPE240X_REG_GPIO_RE_LSB   0x91
#define STMPE240X_REG_GPIO_FE_MSB   0x92 
#define STMPE240X_REG_GPIO_FE_MID   0x93
#define STMPE240X_REG_GPIO_FE_LSB   0x94
#define STMPE240X_REG_GPIO_PULL_UP_MSB  0x95 
#define STMPE240X_REG_GPIO_PULL_UP_MID  0x96
#define STMPE240X_REG_GPIO_PULL_UP_LSB  0x97
#define STMPE240X_REG_GPIO_PULL_DN_MSB  0x98 
#define STMPE240X_REG_GPIO_PULL_DN_MID  0x99
#define STMPE240X_REG_GPIO_PULL_DN_LSB  0x9A
#define STMPE240X_REG_GPIO_AF_U_MSB 0x9B 
#define STMPE240X_REG_GPIO_AF_U_MID 0x9C
#define STMPE240X_REG_GPIO_AF_U_LSB 0x9D
#define STMPE240X_REG_GPIO_AF_L_MSB 0x9E 
#define STMPE240X_REG_GPIO_AF_L_MID 0x9F
#define STMPE240X_REG_GPIO_AF_L_LSB 0xA0
 
#define STMPE240X_REG_PWMCS 0x30 
#define STMPE240X_REG_PWMIC0    0x38 
#define STMPE240X_REG_PWMIC1    0x39
#define STMPE240X_REG_PWMIC2    0x3A
 
#define STMPE240X_REG_KPC_COL   0x60 
#define STMPE240X_REG_KPC_ROW_MSB   0x61 
#define STMPE240X_REG_KPC_ROW_LSB   0x62
#define STMPE240X_REG_KPC_CTRL_MSB  0x63 
#define STMPE240X_REG_KPC_CTRL_LSB  0x64
#define STMPE240X_REG_KPC_DATA_BYTE0    0x68 
#define STMPE240X_REG_KPC_DATA_BYTE1    0x69
#define STMPE240X_REG_KPC_DATA_BYTE2    0x6A
 
#define STMPE240X_REG_MAX   0xBF
#define STMPE240X_REG_SIZE  3
 
#define STMPE_REG_UNKNOWN   0xFF

#define STMPE811_CHIP_ID    0x0811

#define STMPE801_CHIP_ID    0x0801

#define STMPE1601_CHIP_ID   0x02

#define STMPE1801_CHIP_ID   0xC1

#define STMPE240X_CHIP_ID   0x01

#define STMPE811_SYS_CTRL2_TS_OFF   (1 << 3) 
#define STMPE811_SYS_CTRL2_GPIO_OFF (1 << 2) 
#define STMPE811_SYS_CTRL2_TSC_OFF  (1 << 1) 
#define STMPE811_SYS_CTRL2_ADC_OFF  (1 << 0) 

#define STMPE801_SYS_CTRL_RESET (1 << 7) 
#define STMPE801_SYS_CTRL_INT_EN    (1 << 2) 
#define STMPE801_SYS_CTRL_INT_HI    (1 << 0) 

#define STMPE1601_SYS_CTRL_RESET    (1 << 7) 
#define STMPE1601_SYS_CTRL_ENABLE_GPIO  (1 << 3) 
#define STMPE1601_SYS_CTRL_ENABLE_KPC   (1 << 1) 
#define STMPE1601_SYS_CTRL_ENABLE_SPWM  (1 << 0) 

#define STMPE1801_SYS_CTRL_RESET    (1 << 7) 

#define STMPE240X_SYS_CTRL_RESET    (1 << 7) 
#define STMPE240X_SYS_CTRL_ENABLE_GPIO  (1 << 3) 
#define STMPE240X_SYS_CTRL_ENABLE_PWM   (1 << 2) 
#define STMPE240X_SYS_CTRL_ENABLE_KPC   (1 << 1) 
#define STMPE240X_SYS_CTRL_ENABLE_ROT   (1 << 0) 

#define STMPE811_TSC_CTRL_TSC_STA   (1 << 7) 
#define STMPE811_TSC_CTRL_TRACK_MASK    (7 << 4) 
#define STMPE811_TSC_CTRL_OPMODE_XYZ    (0 << 1) 
#define STMPE811_TSC_CTRL_OPMODE_XY (1 << 1) 
#define STMPE811_TSC_CTRL_OPMODE_X  (2 << 1) 
#define STMPE811_TSC_CTRL_OPMODE_Y  (3 << 1) 
#define STMPE811_TSC_CTRL_OPMODE_Z  (4 << 1) 
#define STMPE811_TSC_CTRL_TSC_EN    (1 << 0) 

#define STMPE811_TSC_CFG_AVE_CTRL_1 (0 << 6) 
#define STMPE811_TSC_CFG_AVE_CTRL_2 (1 << 6) 
#define STMPE811_TSC_CFG_AVE_CTRL_4 (2 << 6) 
#define STMPE811_TSC_CFG_AVE_CTRL_8 (3 << 6) 
#define STMPE811_TSC_CFG_TOUCH_DET_DELAY_MASK   (7 << 3) 
#define STMPE811_TSC_CFG_SETTLING_MASK  (7 << 0) 

#define STMPE811_ADC_CTRL1_SAMPLE_TIME_MASK (7 << 4) 
#define STMPE811_ADC_CTRL1_MOD_12B  (1 << 3) 
#define STMPE811_ADC_CTRL1_REF_SEL  (1 << 1) 

#define STMPE811_ADC_CTRL2_ADC_FREQ_MASK    (3 << 0) 

#define STMPE811_FIFO_STA_RESET (1 << 0) 

#define STMPE811_INT_CTRL_POLARITY  (1 << 2) 
#define STMPE811_INT_CTRL_TYPE  (1 << 1) 
#define STMPE811_INT_CTRL_GLOBAL    (1 << 0) 

#define STMPE811_INT_EN_GPIO    (1 << 7) 
#define STMPE811_INT_EN_ADC (1 << 6) 
#define STMPE811_INT_EN_TEMP_SENS   (1 << 5) 
#define STMPE811_INT_EN_FIFO_EMPTY  (1 << 4) 
#define STMPE811_INT_EN_FIFO_FULL   (1 << 3) 
#define STMPE811_INT_EN_FIFO_OFLOW  (1 << 2) 
#define STMPE811_INT_EN_FIFO_TH (1 << 1) 
#define STMPE811_INT_EN_TOUCH_DET   (1 << 0) 

#define STMPE811_INT_STA_GPIO   (1 << 7) 
#define STMPE811_INT_STA_ADC    (1 << 6) 
#define STMPE811_INT_STA_TEMP_SENS  (1 << 5) 
#define STMPE811_INT_STA_FIFO_EMPTY (1 << 4) 
#define STMPE811_INT_STA_FIFO_FULL  (1 << 3) 
#define STMPE811_INT_STA_FIFO_OFLOW (1 << 2) 
#define STMPE811_INT_STA_FIFO_TH    (1 << 1) 
#define STMPE811_INT_STA_TOUCH_DET  (1 << 0) 
 
#define STMPE811_INT_STA_TOUCH_MASK STMPE811_INT_STA_FIFO_EMPTY | STMPE811_INT_STA_FIFO_FULL | STMPE811_INT_STA_FIFO_OFLOW | STMPE811_INT_STA_FIFO_TH | STMPE811_INT_STA_TOUCH_DET

typedef struct _STMPE_CONTROL STMPE_CONTROL;
struct _STMPE_CONTROL
{
    // General Properties
    uint32_t chip; 
    GPIO_INFO irq; 
    // I2C Properties
    I2C_DEVICE *i2c; 
    uint16_t address; 
    // SPI Properties
    SPI_DEVICE *spi; 
    uint16_t chipselect; 
    // Register Properties
    uint32_t regmax; 
    uint32_t regdir; 
    uint32_t regsize; 
};
 
 
typedef struct _STMPE_OFFSETS STMPE_OFFSETS;
struct _STMPE_OFFSETS
{
    // Control Register offsets
    uint8_t sysctrl;
    uint8_t intctrl;
    uint8_t intenable;
    uint8_t intstatus;
    // GPIO Registers offsets
    uint8_t gpiointenable;
    uint8_t gpiointstatus;
    uint8_t gpiopinget;
    uint8_t gpiopinset;
    uint8_t gpiopinclr;
    uint8_t gpiodirset;
    uint8_t gpiofuncset;
    uint8_t gpiopullup;
    uint8_t gpiopulldown;
    uint8_t gpioedgedetect;
    uint8_t gpiorisingedge;
    uint8_t gpiofallingedge;
    // Touchscreen Register offsets (610 and 811 Only)
    uint8_t adcctrl1;
    uint8_t adcctrl2;
    uint8_t tscctrl;
    uint8_t tsccfg;
    uint8_t fifothreshold;
    uint8_t fifostatus;
    uint8_t tscdataxyz;
    uint8_t tscfractionz;
    uint8_t tscidrive;
};
 
 
typedef struct _STMPE_GPIO STMPE_GPIO;
struct _STMPE_GPIO
{
    // GPIO Properties
    GPIO_DEVICE gpio;
    // STMPE Properties
    STMPE_CONTROL control; 
    STMPE_OFFSETS offsets; 
};
 
 
typedef struct _STMPE_TOUCH STMPE_TOUCH;
struct _STMPE_TOUCH
{
    // Touch Properties
    TOUCH_DEVICE touch;
    // General Properties
    uint16_t maxx; 
    uint16_t maxy; 
    uint16_t maxz; 
    uint16_t width; 
    uint16_t height; 
    uint32_t maxpoints; 
    // STMPE Properties
    STMPE_CONTROL control; 
    STMPE_OFFSETS offsets; 
    TIMER_HANDLE timer; 
};

static uint8_t STMPE_SAMPLE_TIME = 4;
static uint8_t STMPE_MOD_12B = 1;
static uint8_t STMPE_REF_SEL = 0;
static uint8_t STMPE_ADC_FREQ = 2;
static uint8_t STMPE_AVE_CTRL = 3;
static uint8_t STMPE_TOUCH_DET_DELAY = 4;
static uint8_t STMPE_SETTLING = 2;
static uint8_t STMPE_FRACTION_Z = 7;
static uint8_t STMPE_I_DRIVE = 0;

void STDCALL stmpe_init(void);


GPIO_DEVICE * STDCALL stmpe610_gpio_create(I2C_DEVICE *i2c, SPI_DEVICE *spi, uint16_t address, uint16_t chipselect, GPIO_INFO *irq);

GPIO_DEVICE * STDCALL stmpe801_gpio_create(I2C_DEVICE *i2c, uint16_t address, GPIO_INFO *irq);

GPIO_DEVICE * STDCALL stmpe811_gpio_create(I2C_DEVICE *i2c, SPI_DEVICE *spi, uint16_t address, uint16_t chipselect, GPIO_INFO *irq);

GPIO_DEVICE * STDCALL stmpe1601_gpio_create(I2C_DEVICE *i2c, uint16_t address, GPIO_INFO *irq);

GPIO_DEVICE * STDCALL stmpe1801_gpio_create(I2C_DEVICE *i2c, uint16_t address, GPIO_INFO *irq);

GPIO_DEVICE * STDCALL stmpe2401_gpio_create(I2C_DEVICE *i2c, uint16_t address, GPIO_INFO *irq);

uint32_t STDCALL stmpe_gpio_destroy(GPIO_DEVICE *gpio);

TOUCH_DEVICE * STDCALL stmpe610_touch_create(I2C_DEVICE *i2c, SPI_DEVICE *spi, uint16_t address, uint16_t chipselect, uint32_t width, uint32_t height, GPIO_INFO *irq);

TOUCH_DEVICE * STDCALL stmpe811_touch_create(I2C_DEVICE *i2c, SPI_DEVICE *spi, uint16_t address, uint16_t chipselect, uint32_t width, uint32_t height, GPIO_INFO *irq);

uint32_t STDCALL stmpe_touch_destroy(TOUCH_DEVICE *touch);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_STMPE_H