ft5x06touch.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_FT5X06TOUCH_H
#define _ULTIBO_FT5X06TOUCH_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/gpio.h"
#include "ultibo/i2c.h"
#include "ultibo/touch.h"

#define FT5X06_TOUCH_DESCRIPTION    "EDT FocalTech FT5x06 Touch Controller" 

#define FT5X06_I2C_RATE 400000 

#define FT5X06_WORK_REGISTER_THRESHOLD  0x00
#define FT5X06_WORK_REGISTER_REPORT_RATE    0x08
#define FT5X06_WORK_REGISTER_GAIN   0x30
#define FT5X06_WORK_REGISTER_OFFSET 0x31
#define FT5X06_WORK_REGISTER_NUM_X  0x33
#define FT5X06_WORK_REGISTER_NUM_Y  0x34
 
#define FT5X06_PMOD_REGISTER_ACTIVE 0x00
#define FT5X06_PMOD_REGISTER_HIBERNATE  0x03
 
#define FT5X06_M09_REGISTER_THRESHOLD   0x80
#define FT5X06_M09_REGISTER_GAIN    0x92
#define FT5X06_M09_REGISTER_OFFSET  0x93
#define FT5X06_M09_REGISTER_NUM_X   0x94
#define FT5X06_M09_REGISTER_NUM_Y   0x95
 
#define FT5X06_EV_REGISTER_THRESHOLD    0x40
#define FT5X06_EV_REGISTER_GAIN 0x41
#define FT5X06_EV_REGISTER_OFFSET_Y 0x45
#define FT5X06_EV_REGISTER_OFFSET_X 0x46
 
#define FT5X06_NO_REGISTER  0xff
 
#define FT5X06_WORK_REGISTER_OPMODE 0x3c
#define FT5X06_FACTORY_REGISTER_OPMODE  0x01
#define FT5X06_PMOD_REGISTER_OPMODE 0xa5
 
#define FT5X06_TOUCH_EVENT_DOWN 0x00
#define FT5X06_TOUCH_EVENT_UP   0x01
#define FT5X06_TOUCH_EVENT_ON   0x02
#define FT5X06_TOUCH_EVENT_RESERVED 0x03
 
#define FT5X06_EDT_NAME_LEN 23
#define FT5X06_EDT_SWITCH_MODE_RETRIES  10
#define FT5X06_EDT_SWITCH_MODE_DELAY    5 
#define FT5X06_EDT_RAW_DATA_RETRIES 100
#define FT5X06_EDT_RAW_DATA_DELAY   1000 
 
#define FT5X06_POLL_INTERVAL_MS 17 

#define FT5X06_EDT_M06  0
#define FT5X06_EDT_M09  1
#define FT5X06_EDT_M12  2
#define FT5X06_EV_FT    3
#define FT5X06_GENERIC_FT   4

typedef struct _FT5X06_REGISTERS FT5X06_REGISTERS;
struct _FT5X06_REGISTERS
{
    uint8_t threshold;
    uint8_t reportrate;
    uint8_t gain;
    uint8_t offset;
    uint8_t offsetx;
    uint8_t offsety;
    uint8_t numx;
    uint8_t numy;
};
 
 
typedef struct _FT5X06_PARAMETERS FT5X06_PARAMETERS;
struct _FT5X06_PARAMETERS
{
    uint8_t threshold;
    uint8_t reportrate;
    uint8_t gain;
    uint8_t offset;
    uint8_t offsetx;
    uint8_t offsety;
    uint8_t numx;
    uint8_t numy;
};
 
 
typedef struct _FT5X06_TOUCH FT5X06_TOUCH;
struct _FT5X06_TOUCH
{
    // Touch Properties
    TOUCH_DEVICE touch;
    // I2C Properties
    I2C_DEVICE *i2c; 
    uint16_t address; 
    // General Properties
    GPIO_INFO irq; 
    GPIO_INFO rst; 
    TIMER_HANDLE timer; 
    uint16_t maxx; 
    uint16_t maxy; 
    uint16_t width; 
    uint16_t height; 
    uint32_t maxpoints; 
    uint32_t lastpoints; 
    // FT5x06 Properties
    uint32_t version; 
    char *modelname; 
    char *firmwareversion; 
    FT5X06_REGISTERS registers; 
    FT5X06_PARAMETERS parameters; 
    BOOL swapreportxy; 
    BOOL invertreportx; 
    BOOL invertreporty; 
};

void STDCALL ft5x06_init(void);


TOUCH_DEVICE * STDCALL ft5x06_touch_create(I2C_DEVICE *i2c, uint16_t address, uint32_t width, uint32_t height, GPIO_INFO *irq, GPIO_INFO *rst);

uint32_t STDCALL ft5x06_touch_destroy(TOUCH_DEVICE *touch);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_FT5X06TOUCH_H