ft5xx6.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2023 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 FT5XX6_H
#define FT5XX6_H
 
#include "drv_i2c_master.h"
#include "drv_digital_in.h"
#include "drv_name.h"
#include "tp.h"
 
#define FT5XX6_REG_DEVICE_MODE 0x0
 
#define FT5XX6_REG_GEST_ID 0x1
 
#define FT5XX6_REG_TD_STATUS 0x2
 
#define FT5XX6_REG_TOUCH1_XH 0x3
 
#define FT5XX6_REG_TOUCH1_XL 0x4
 
#define FT5XX6_REG_TOUCH1_YH 0x5
 
#define FT5XX6_REG_TOUCH1_YL 0x6
 
#define FT5XX6_REG_TOUCH2_XH 0x9
 
#define FT5XX6_REG_TOUCH2_XL 0xA
 
#define FT5XX6_REG_TOUCH2_YH 0xB
 
#define FT5XX6_REG_TOUCH2_YL 0xC
 
#define FT5XX6_REG_TOUCH3_XH 0xF
 
#define FT5XX6_REG_TOUCH3_XL 0x10
 
#define FT5XX6_REG_TOUCH3_YH 0x11
 
#define FT5XX6_REG_TOUCH3_YL 0x12
 
#define FT5XX6_REG_TOUCH4_XH 0x15
 
#define FT5XX6_REG_TOUCH4_XL 0x16
 
#define FT5XX6_REG_TOUCH4_YH 0x17
 
#define FT5XX6_REG_TOUCH4_YL 0x18
 
#define FT5XX6_REG_TOUCH5_XH 0x1B
 
#define FT5XX6_REG_TOUCH5_XL 0x1C
 
#define FT5XX6_REG_TOUCH5_YH 0x1D
 
#define FT5XX6_REG_TOUCH5_YL 0x1E
 
#define FT5XX6_REG_TOUCH_DET_TH 0x80
 
#define FT5XX6_REG_TOUCH_PEAK_DET_TH 0x81
 
#define FT5XX6_REG_TOUCH_TH_CAL 0x82
 
#define FT5XX6_REG_TOUCH_TH_WATER 0x83
 
#define FT5XX6_REG_TOUCH_TH_TEMP_COMP 0x84
 
#define FT5XX6_REG_POWER_CTRL_MODE 0x86
 
#define FT5XX6_REG_MONITOR_STATUS_TMR 0x87
 
#define FT5XX6_REG_MONITOR_ACT_PERIOD 0x88
 
#define FT5XX6_REG_ENTER_IDLE_TIMER 0x89
 
#define FT5XX6_REG_AUTO_CALIB_MODE 0xA0
 
#define FT5XX6_REG_LIB_VERSION_H 0xA1
 
#define FT5XX6_REG_LIB_VERSION_L 0xA2
 
#define FT5XX6_REG_LIB_CHIP_VENDOR_ID 0xA3
 
#define FT5XX6_REG_IVT_TO_HOST_STATUS 0xA4
 
#define FT5XX6_REG_POWER_CONSUME_MODE 0xA5
 
#define FT5XX6_REG_FW_ID 0xA6
 
#define FT5XX6_REG_RUNNING_STATE 0xA7
 
#define FT5XX6_REG_CTPM_VENDOR_ID 0xA8
 
#define FT5XX6_REG_ERROR_ID 0xA9
 
#define FT5XX6_REG_CONFIGURE_CAL_MODE 0xAA
 
#define FT5XX6_REG_BIG_AREA_TH 0xAE
 // ft5xx6_registers
 
#define FT5XX6_INT_MODE_POLLING 0
 
#define FT5XX6_INT_MODE_TRIGGER 1
 
#define FT5XX6_I2C_ADDR 0x38
 
#define FT5XX6_N_DATA_TRANSFER_MIN 1
 
#define FT5XX6_N_DATA_TRANSFER_MAX 256
 
#define FT5XX6_GESTURE_ITEMS_MAX 7
 
#define FT5XX6_EVENT_PRESS_DET 0x80
 
#define FT5XX6_MASK_PRESS_COORD 0xFFF
 
#define FT5XX6_MASK_PRESS_EVENT 0xC0
 
#define FT5XX6_MASK_PRESS_DET 0xC0
 
#define FT5XX6_MASK_TP_NUM 0xF
 // ft5xx6_masks
 
#define FT5XX6_OFFSET_PRESS_EVENT 6
 
#define FT5XX6_OFFSET_PRESS_ID 4
 
#define FT5XX6_OFFSET_DEV_MODE 4
 
#define FT5XX6_OFFSET_TOUCH_READING 6
 // ft5xx6_offsets
 
#define FT5XX6_MAP_PINS( cfg ) \
 cfg.i2c_cfg.scl = CTP_SCL; \
 cfg.i2c_cfg.sda = CTP_SDA; \
 cfg.int_pin = CTP_INT
 // ft5xx6_settings // ft5xx6 // middlewaregroup
 
typedef enum
{
 FT5XX6_DEV_MODE_NORMAL, 
 FT5XX6_DEV_MODE_SYS_INFO, 
 FT5XX6_DEV_MODE_TEST = 4 
} ft5xx6_dev_mode_t;
 
typedef enum
{
 FT5XX6_RUN_MODE_CFG, 
 FT5XX6_RUN_MODE_WORK, 
 FT5XX6_RUN_MODE_CAL, 
 FT5XX6_RUN_MODE_FACT, 
 FT5XX6_RUN_MODE_AUTO_CAL 
} ft5xx6_run_mode_t;
 
typedef struct
{
 uint8_t key; 
 tp_event_t value; 
} ft5xx6_gest_item_t;
 
typedef struct
{
 ft5xx6_gest_item_t gest_items[ FT5XX6_GESTURE_ITEMS_MAX ]; 
} ft5xx6_controller_t;
 
typedef struct
{
 pin_name_t int_pin; 
 i2c_master_config_t i2c_cfg; 
 const ft5xx6_controller_t * controller; 
} ft5xx6_cfg_t;
 
typedef struct
{
 i2c_master_t i2c; 
 digital_in_t int_pin; 
 const ft5xx6_controller_t * controller; 
 tp_event_t press_det; 
 tp_touch_item_t touch; 
 tp_event_t gesture; 
} ft5xx6_t;
 
extern const ft5xx6_controller_t FT5X06_CONTROLLER;
 
extern const ft5xx6_controller_t FT5X16_CONTROLLER;
 
extern const ft5xx6_controller_t FT5X26_CONTROLLER;
 
extern const ft5xx6_controller_t FT5X46_CONTROLLER;
 
#ifdef __cplusplus
extern "C"{
#endif
 
void
ft5xx6_cfg_setup( ft5xx6_cfg_t * cfg, const ft5xx6_controller_t * controller );
 
tp_err_t
ft5xx6_init( ft5xx6_t * ctx, ft5xx6_cfg_t * cfg, tp_drv_t * drv );
 
void
ft5xx6_default_cfg( ft5xx6_t * ctx );
 
void
ft5xx6_generic_write( ft5xx6_t * ctx, uint8_t reg_addr, uint8_t data_in );
 
uint8_t
ft5xx6_generic_read_single( ft5xx6_t * ctx, uint8_t reg_addr );
 
tp_err_t
ft5xx6_generic_read_multiple( ft5xx6_t * ctx, uint8_t reg_addr,
 uint8_t * data_out, uint16_t n_bytes );
 
void
ft5xx6_dev_mode_setup( ft5xx6_t * ctx, ft5xx6_dev_mode_t mode );
 
void
ft5xx6_run_mode_setup( ft5xx6_t * ctx, ft5xx6_run_mode_t mode );
 
tp_event_t
ft5xx6_press_detect( ft5xx6_t * ctx );
 
void
ft5xx6_press_coordinates( ft5xx6_t * ctx, tp_touch_item_t * touch_item );
 
void
ft5xx6_gesture( ft5xx6_t * ctx, tp_event_t * event );
 
tp_err_t
ft5xx6_process( ft5xx6_t * ctx );
 
#ifdef __cplusplus
}
#endif
#endif // FT5XX6_H
 // ft5xx6 // middlewaregroup
 
// ------------------------------------------------------------------------ END