nguyen nam / F746-GUI

SPKT

Dependents:   Player

BSP_DISCO_F746NG/ft5336.h@0:4e245f4bc8ac, 2019-06-07 (annotated)

Committer:
phungductung
Date:
Fri Jun 07 05:06:42 2019 +0000
Revision:
0:4e245f4bc8ac
spkt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:4e245f4bc8ac 1 /**
phungductung 0:4e245f4bc8ac 2 ******************************************************************************
phungductung 0:4e245f4bc8ac 3 * @file ft5336.h
phungductung 0:4e245f4bc8ac 4 * @author MCD Application Team
phungductung 0:4e245f4bc8ac 5 * @version V1.0.0
phungductung 0:4e245f4bc8ac 6 * @date 25-June-2015
phungductung 0:4e245f4bc8ac 7 * @brief This file contains all the functions prototypes for the
phungductung 0:4e245f4bc8ac 8 * ft5336.c Touch screen driver.
phungductung 0:4e245f4bc8ac 9 ******************************************************************************
phungductung 0:4e245f4bc8ac 10 * @attention
phungductung 0:4e245f4bc8ac 11 *
phungductung 0:4e245f4bc8ac 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
phungductung 0:4e245f4bc8ac 13 *
phungductung 0:4e245f4bc8ac 14 * Redistribution and use in source and binary forms, with or without modification,
phungductung 0:4e245f4bc8ac 15 * are permitted provided that the following conditions are met:
phungductung 0:4e245f4bc8ac 16 * 1. Redistributions of source code must retain the above copyright notice,
phungductung 0:4e245f4bc8ac 17 * this list of conditions and the following disclaimer.
phungductung 0:4e245f4bc8ac 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
phungductung 0:4e245f4bc8ac 19 * this list of conditions and the following disclaimer in the documentation
phungductung 0:4e245f4bc8ac 20 * and/or other materials provided with the distribution.
phungductung 0:4e245f4bc8ac 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
phungductung 0:4e245f4bc8ac 22 * may be used to endorse or promote products derived from this software
phungductung 0:4e245f4bc8ac 23 * without specific prior written permission.
phungductung 0:4e245f4bc8ac 24 *
phungductung 0:4e245f4bc8ac 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
phungductung 0:4e245f4bc8ac 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
phungductung 0:4e245f4bc8ac 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
phungductung 0:4e245f4bc8ac 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
phungductung 0:4e245f4bc8ac 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
phungductung 0:4e245f4bc8ac 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
phungductung 0:4e245f4bc8ac 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
phungductung 0:4e245f4bc8ac 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
phungductung 0:4e245f4bc8ac 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
phungductung 0:4e245f4bc8ac 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
phungductung 0:4e245f4bc8ac 35 *
phungductung 0:4e245f4bc8ac 36 ******************************************************************************
phungductung 0:4e245f4bc8ac 37 */
phungductung 0:4e245f4bc8ac 38
phungductung 0:4e245f4bc8ac 39 /* Define to prevent recursive inclusion -------------------------------------*/
phungductung 0:4e245f4bc8ac 40 #ifndef __FT5336_H
phungductung 0:4e245f4bc8ac 41 #define __FT5336_H
phungductung 0:4e245f4bc8ac 42
phungductung 0:4e245f4bc8ac 43 #ifdef __cplusplus
phungductung 0:4e245f4bc8ac 44 extern "C" {
phungductung 0:4e245f4bc8ac 45 #endif
phungductung 0:4e245f4bc8ac 46
phungductung 0:4e245f4bc8ac 47 /* Set Multi-touch as supported */
phungductung 0:4e245f4bc8ac 48 #if !defined(TS_MONO_TOUCH_SUPPORTED)
phungductung 0:4e245f4bc8ac 49 #define TS_MULTI_TOUCH_SUPPORTED 1
phungductung 0:4e245f4bc8ac 50 #endif /* TS_MONO_TOUCH_SUPPORTED */
phungductung 0:4e245f4bc8ac 51
phungductung 0:4e245f4bc8ac 52 /* Includes ------------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 53 #include "ts.h" // MBED
phungductung 0:4e245f4bc8ac 54
phungductung 0:4e245f4bc8ac 55 /* Macros --------------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 56
phungductung 0:4e245f4bc8ac 57 #if defined(FT5336_ENABLE_ASSERT)
phungductung 0:4e245f4bc8ac 58 /* Assert activated */
phungductung 0:4e245f4bc8ac 59 #define FT5336_ASSERT(__condition__) do { if(__condition__) \
phungductung 0:4e245f4bc8ac 60 { \
phungductung 0:4e245f4bc8ac 61 while(1); \
phungductung 0:4e245f4bc8ac 62 } \
phungductung 0:4e245f4bc8ac 63 }while(0)
phungductung 0:4e245f4bc8ac 64 #else
phungductung 0:4e245f4bc8ac 65 /* Assert not activated : macro has no effect */
phungductung 0:4e245f4bc8ac 66 #define FT5336_ASSERT(__condition__) do { if(__condition__) \
phungductung 0:4e245f4bc8ac 67 { \
phungductung 0:4e245f4bc8ac 68 ; \
phungductung 0:4e245f4bc8ac 69 } \
phungductung 0:4e245f4bc8ac 70 }while(0)
phungductung 0:4e245f4bc8ac 71 #endif /* FT5336_ENABLE_ASSERT == 1 */
phungductung 0:4e245f4bc8ac 72
phungductung 0:4e245f4bc8ac 73 /** @typedef ft5336_handle_TypeDef
phungductung 0:4e245f4bc8ac 74 * ft5336 Handle definition.
phungductung 0:4e245f4bc8ac 75 */
phungductung 0:4e245f4bc8ac 76 typedef struct
phungductung 0:4e245f4bc8ac 77 {
phungductung 0:4e245f4bc8ac 78 uint8_t i2cInitialized;
phungductung 0:4e245f4bc8ac 79
phungductung 0:4e245f4bc8ac 80 /* field holding the current number of simultaneous active touches */
phungductung 0:4e245f4bc8ac 81 uint8_t currActiveTouchNb;
phungductung 0:4e245f4bc8ac 82
phungductung 0:4e245f4bc8ac 83 /* field holding the touch index currently managed */
phungductung 0:4e245f4bc8ac 84 uint8_t currActiveTouchIdx;
phungductung 0:4e245f4bc8ac 85
phungductung 0:4e245f4bc8ac 86 } ft5336_handle_TypeDef;
phungductung 0:4e245f4bc8ac 87
phungductung 0:4e245f4bc8ac 88 /** @addtogroup BSP
phungductung 0:4e245f4bc8ac 89 * @{
phungductung 0:4e245f4bc8ac 90 */
phungductung 0:4e245f4bc8ac 91
phungductung 0:4e245f4bc8ac 92 /** @addtogroup Component
phungductung 0:4e245f4bc8ac 93 * @{
phungductung 0:4e245f4bc8ac 94 */
phungductung 0:4e245f4bc8ac 95
phungductung 0:4e245f4bc8ac 96 /** @defgroup FT5336
phungductung 0:4e245f4bc8ac 97 * @{
phungductung 0:4e245f4bc8ac 98 */
phungductung 0:4e245f4bc8ac 99
phungductung 0:4e245f4bc8ac 100 /* Exported types ------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 101
phungductung 0:4e245f4bc8ac 102 /** @defgroup FT5336_Exported_Types
phungductung 0:4e245f4bc8ac 103 * @{
phungductung 0:4e245f4bc8ac 104 */
phungductung 0:4e245f4bc8ac 105
phungductung 0:4e245f4bc8ac 106 /* Exported constants --------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 107
phungductung 0:4e245f4bc8ac 108 /** @defgroup FT5336_Exported_Constants
phungductung 0:4e245f4bc8ac 109 * @{
phungductung 0:4e245f4bc8ac 110 */
phungductung 0:4e245f4bc8ac 111
phungductung 0:4e245f4bc8ac 112 /* I2C Slave address of touchscreen FocalTech FT5336 */
phungductung 0:4e245f4bc8ac 113 #define FT5336_I2C_SLAVE_ADDRESS ((uint8_t)0x70)
phungductung 0:4e245f4bc8ac 114
phungductung 0:4e245f4bc8ac 115 /* Maximum border values of the touchscreen pad */
phungductung 0:4e245f4bc8ac 116 #define FT5336_MAX_WIDTH ((uint16_t)480) /* Touchscreen pad max width */
phungductung 0:4e245f4bc8ac 117 #define FT5336_MAX_HEIGHT ((uint16_t)272) /* Touchscreen pad max height */
phungductung 0:4e245f4bc8ac 118
phungductung 0:4e245f4bc8ac 119 /* Possible values of driver functions return status */
phungductung 0:4e245f4bc8ac 120 #define FT5336_STATUS_OK ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 121 #define FT5336_STATUS_NOT_OK ((uint8_t)0x01)
phungductung 0:4e245f4bc8ac 122
phungductung 0:4e245f4bc8ac 123 /* Possible values of global variable 'TS_I2C_Initialized' */
phungductung 0:4e245f4bc8ac 124 #define FT5336_I2C_NOT_INITIALIZED ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 125 #define FT5336_I2C_INITIALIZED ((uint8_t)0x01)
phungductung 0:4e245f4bc8ac 126
phungductung 0:4e245f4bc8ac 127 /* Max detectable simultaneous touches */
phungductung 0:4e245f4bc8ac 128 #define FT5336_MAX_DETECTABLE_TOUCH ((uint8_t)0x05)
phungductung 0:4e245f4bc8ac 129
phungductung 0:4e245f4bc8ac 130 /**
phungductung 0:4e245f4bc8ac 131 * @brief : Definitions for FT5336 I2C register addresses on 8 bit
phungductung 0:4e245f4bc8ac 132 **/
phungductung 0:4e245f4bc8ac 133
phungductung 0:4e245f4bc8ac 134 /* Current mode register of the FT5336 (R/W) */
phungductung 0:4e245f4bc8ac 135 #define FT5336_DEV_MODE_REG ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 136
phungductung 0:4e245f4bc8ac 137 /* Possible values of FT5336_DEV_MODE_REG */
phungductung 0:4e245f4bc8ac 138 #define FT5336_DEV_MODE_WORKING ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 139 #define FT5336_DEV_MODE_FACTORY ((uint8_t)0x04)
phungductung 0:4e245f4bc8ac 140
phungductung 0:4e245f4bc8ac 141 #define FT5336_DEV_MODE_MASK ((uint8_t)0x07)
phungductung 0:4e245f4bc8ac 142 #define FT5336_DEV_MODE_SHIFT ((uint8_t)0x04)
phungductung 0:4e245f4bc8ac 143
phungductung 0:4e245f4bc8ac 144 /* Gesture ID register */
phungductung 0:4e245f4bc8ac 145 #define FT5336_GEST_ID_REG ((uint8_t)0x01)
phungductung 0:4e245f4bc8ac 146
phungductung 0:4e245f4bc8ac 147 /* Possible values of FT5336_GEST_ID_REG */
phungductung 0:4e245f4bc8ac 148 #define FT5336_GEST_ID_NO_GESTURE ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 149 #define FT5336_GEST_ID_MOVE_UP ((uint8_t)0x10)
phungductung 0:4e245f4bc8ac 150 #define FT5336_GEST_ID_MOVE_RIGHT ((uint8_t)0x14)
phungductung 0:4e245f4bc8ac 151 #define FT5336_GEST_ID_MOVE_DOWN ((uint8_t)0x18)
phungductung 0:4e245f4bc8ac 152 #define FT5336_GEST_ID_MOVE_LEFT ((uint8_t)0x1C)
phungductung 0:4e245f4bc8ac 153 #define FT5336_GEST_ID_SINGLE_CLICK ((uint8_t)0x20)
phungductung 0:4e245f4bc8ac 154 #define FT5336_GEST_ID_DOUBLE_CLICK ((uint8_t)0x22)
phungductung 0:4e245f4bc8ac 155 #define FT5336_GEST_ID_ROTATE_CLOCKWISE ((uint8_t)0x28)
phungductung 0:4e245f4bc8ac 156 #define FT5336_GEST_ID_ROTATE_C_CLOCKWISE ((uint8_t)0x29)
phungductung 0:4e245f4bc8ac 157 #define FT5336_GEST_ID_ZOOM_IN ((uint8_t)0x40)
phungductung 0:4e245f4bc8ac 158 #define FT5336_GEST_ID_ZOOM_OUT ((uint8_t)0x49)
phungductung 0:4e245f4bc8ac 159
phungductung 0:4e245f4bc8ac 160 /* Touch Data Status register : gives number of active touch points (0..5) */
phungductung 0:4e245f4bc8ac 161 #define FT5336_TD_STAT_REG ((uint8_t)0x02)
phungductung 0:4e245f4bc8ac 162
phungductung 0:4e245f4bc8ac 163 /* Values related to FT5336_TD_STAT_REG */
phungductung 0:4e245f4bc8ac 164 #define FT5336_TD_STAT_MASK ((uint8_t)0x0F)
phungductung 0:4e245f4bc8ac 165 #define FT5336_TD_STAT_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 166
phungductung 0:4e245f4bc8ac 167 /* Values Pn_XH and Pn_YH related */
phungductung 0:4e245f4bc8ac 168 #define FT5336_TOUCH_EVT_FLAG_PRESS_DOWN ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 169 #define FT5336_TOUCH_EVT_FLAG_LIFT_UP ((uint8_t)0x01)
phungductung 0:4e245f4bc8ac 170 #define FT5336_TOUCH_EVT_FLAG_CONTACT ((uint8_t)0x02)
phungductung 0:4e245f4bc8ac 171 #define FT5336_TOUCH_EVT_FLAG_NO_EVENT ((uint8_t)0x03)
phungductung 0:4e245f4bc8ac 172
phungductung 0:4e245f4bc8ac 173 #define FT5336_TOUCH_EVT_FLAG_SHIFT ((uint8_t)0x06)
phungductung 0:4e245f4bc8ac 174 #define FT5336_TOUCH_EVT_FLAG_MASK ((uint8_t)(3 << FT5336_TOUCH_EVT_FLAG_SHIFT))
phungductung 0:4e245f4bc8ac 175
phungductung 0:4e245f4bc8ac 176 #define FT5336_TOUCH_POS_MSB_MASK ((uint8_t)0x0F)
phungductung 0:4e245f4bc8ac 177 #define FT5336_TOUCH_POS_MSB_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 178
phungductung 0:4e245f4bc8ac 179 /* Values Pn_XL and Pn_YL related */
phungductung 0:4e245f4bc8ac 180 #define FT5336_TOUCH_POS_LSB_MASK ((uint8_t)0xFF)
phungductung 0:4e245f4bc8ac 181 #define FT5336_TOUCH_POS_LSB_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 182
phungductung 0:4e245f4bc8ac 183 #define FT5336_P1_XH_REG ((uint8_t)0x03)
phungductung 0:4e245f4bc8ac 184 #define FT5336_P1_XL_REG ((uint8_t)0x04)
phungductung 0:4e245f4bc8ac 185 #define FT5336_P1_YH_REG ((uint8_t)0x05)
phungductung 0:4e245f4bc8ac 186 #define FT5336_P1_YL_REG ((uint8_t)0x06)
phungductung 0:4e245f4bc8ac 187
phungductung 0:4e245f4bc8ac 188 /* Touch Pressure register value (R) */
phungductung 0:4e245f4bc8ac 189 #define FT5336_P1_WEIGHT_REG ((uint8_t)0x07)
phungductung 0:4e245f4bc8ac 190
phungductung 0:4e245f4bc8ac 191 /* Values Pn_WEIGHT related */
phungductung 0:4e245f4bc8ac 192 #define FT5336_TOUCH_WEIGHT_MASK ((uint8_t)0xFF)
phungductung 0:4e245f4bc8ac 193 #define FT5336_TOUCH_WEIGHT_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 194
phungductung 0:4e245f4bc8ac 195 /* Touch area register */
phungductung 0:4e245f4bc8ac 196 #define FT5336_P1_MISC_REG ((uint8_t)0x08)
phungductung 0:4e245f4bc8ac 197
phungductung 0:4e245f4bc8ac 198 /* Values related to FT5336_Pn_MISC_REG */
phungductung 0:4e245f4bc8ac 199 #define FT5336_TOUCH_AREA_MASK ((uint8_t)(0x04 << 4))
phungductung 0:4e245f4bc8ac 200 #define FT5336_TOUCH_AREA_SHIFT ((uint8_t)0x04)
phungductung 0:4e245f4bc8ac 201
phungductung 0:4e245f4bc8ac 202 #define FT5336_P2_XH_REG ((uint8_t)0x09)
phungductung 0:4e245f4bc8ac 203 #define FT5336_P2_XL_REG ((uint8_t)0x0A)
phungductung 0:4e245f4bc8ac 204 #define FT5336_P2_YH_REG ((uint8_t)0x0B)
phungductung 0:4e245f4bc8ac 205 #define FT5336_P2_YL_REG ((uint8_t)0x0C)
phungductung 0:4e245f4bc8ac 206 #define FT5336_P2_WEIGHT_REG ((uint8_t)0x0D)
phungductung 0:4e245f4bc8ac 207 #define FT5336_P2_MISC_REG ((uint8_t)0x0E)
phungductung 0:4e245f4bc8ac 208
phungductung 0:4e245f4bc8ac 209 #define FT5336_P3_XH_REG ((uint8_t)0x0F)
phungductung 0:4e245f4bc8ac 210 #define FT5336_P3_XL_REG ((uint8_t)0x10)
phungductung 0:4e245f4bc8ac 211 #define FT5336_P3_YH_REG ((uint8_t)0x11)
phungductung 0:4e245f4bc8ac 212 #define FT5336_P3_YL_REG ((uint8_t)0x12)
phungductung 0:4e245f4bc8ac 213 #define FT5336_P3_WEIGHT_REG ((uint8_t)0x13)
phungductung 0:4e245f4bc8ac 214 #define FT5336_P3_MISC_REG ((uint8_t)0x14)
phungductung 0:4e245f4bc8ac 215
phungductung 0:4e245f4bc8ac 216 #define FT5336_P4_XH_REG ((uint8_t)0x15)
phungductung 0:4e245f4bc8ac 217 #define FT5336_P4_XL_REG ((uint8_t)0x16)
phungductung 0:4e245f4bc8ac 218 #define FT5336_P4_YH_REG ((uint8_t)0x17)
phungductung 0:4e245f4bc8ac 219 #define FT5336_P4_YL_REG ((uint8_t)0x18)
phungductung 0:4e245f4bc8ac 220 #define FT5336_P4_WEIGHT_REG ((uint8_t)0x19)
phungductung 0:4e245f4bc8ac 221 #define FT5336_P4_MISC_REG ((uint8_t)0x1A)
phungductung 0:4e245f4bc8ac 222
phungductung 0:4e245f4bc8ac 223 #define FT5336_P5_XH_REG ((uint8_t)0x1B)
phungductung 0:4e245f4bc8ac 224 #define FT5336_P5_XL_REG ((uint8_t)0x1C)
phungductung 0:4e245f4bc8ac 225 #define FT5336_P5_YH_REG ((uint8_t)0x1D)
phungductung 0:4e245f4bc8ac 226 #define FT5336_P5_YL_REG ((uint8_t)0x1E)
phungductung 0:4e245f4bc8ac 227 #define FT5336_P5_WEIGHT_REG ((uint8_t)0x1F)
phungductung 0:4e245f4bc8ac 228 #define FT5336_P5_MISC_REG ((uint8_t)0x20)
phungductung 0:4e245f4bc8ac 229
phungductung 0:4e245f4bc8ac 230 #define FT5336_P6_XH_REG ((uint8_t)0x21)
phungductung 0:4e245f4bc8ac 231 #define FT5336_P6_XL_REG ((uint8_t)0x22)
phungductung 0:4e245f4bc8ac 232 #define FT5336_P6_YH_REG ((uint8_t)0x23)
phungductung 0:4e245f4bc8ac 233 #define FT5336_P6_YL_REG ((uint8_t)0x24)
phungductung 0:4e245f4bc8ac 234 #define FT5336_P6_WEIGHT_REG ((uint8_t)0x25)
phungductung 0:4e245f4bc8ac 235 #define FT5336_P6_MISC_REG ((uint8_t)0x26)
phungductung 0:4e245f4bc8ac 236
phungductung 0:4e245f4bc8ac 237 #define FT5336_P7_XH_REG ((uint8_t)0x27)
phungductung 0:4e245f4bc8ac 238 #define FT5336_P7_XL_REG ((uint8_t)0x28)
phungductung 0:4e245f4bc8ac 239 #define FT5336_P7_YH_REG ((uint8_t)0x29)
phungductung 0:4e245f4bc8ac 240 #define FT5336_P7_YL_REG ((uint8_t)0x2A)
phungductung 0:4e245f4bc8ac 241 #define FT5336_P7_WEIGHT_REG ((uint8_t)0x2B)
phungductung 0:4e245f4bc8ac 242 #define FT5336_P7_MISC_REG ((uint8_t)0x2C)
phungductung 0:4e245f4bc8ac 243
phungductung 0:4e245f4bc8ac 244 #define FT5336_P8_XH_REG ((uint8_t)0x2D)
phungductung 0:4e245f4bc8ac 245 #define FT5336_P8_XL_REG ((uint8_t)0x2E)
phungductung 0:4e245f4bc8ac 246 #define FT5336_P8_YH_REG ((uint8_t)0x2F)
phungductung 0:4e245f4bc8ac 247 #define FT5336_P8_YL_REG ((uint8_t)0x30)
phungductung 0:4e245f4bc8ac 248 #define FT5336_P8_WEIGHT_REG ((uint8_t)0x31)
phungductung 0:4e245f4bc8ac 249 #define FT5336_P8_MISC_REG ((uint8_t)0x32)
phungductung 0:4e245f4bc8ac 250
phungductung 0:4e245f4bc8ac 251 #define FT5336_P9_XH_REG ((uint8_t)0x33)
phungductung 0:4e245f4bc8ac 252 #define FT5336_P9_XL_REG ((uint8_t)0x34)
phungductung 0:4e245f4bc8ac 253 #define FT5336_P9_YH_REG ((uint8_t)0x35)
phungductung 0:4e245f4bc8ac 254 #define FT5336_P9_YL_REG ((uint8_t)0x36)
phungductung 0:4e245f4bc8ac 255 #define FT5336_P9_WEIGHT_REG ((uint8_t)0x37)
phungductung 0:4e245f4bc8ac 256 #define FT5336_P9_MISC_REG ((uint8_t)0x38)
phungductung 0:4e245f4bc8ac 257
phungductung 0:4e245f4bc8ac 258 #define FT5336_P10_XH_REG ((uint8_t)0x39)
phungductung 0:4e245f4bc8ac 259 #define FT5336_P10_XL_REG ((uint8_t)0x3A)
phungductung 0:4e245f4bc8ac 260 #define FT5336_P10_YH_REG ((uint8_t)0x3B)
phungductung 0:4e245f4bc8ac 261 #define FT5336_P10_YL_REG ((uint8_t)0x3C)
phungductung 0:4e245f4bc8ac 262 #define FT5336_P10_WEIGHT_REG ((uint8_t)0x3D)
phungductung 0:4e245f4bc8ac 263 #define FT5336_P10_MISC_REG ((uint8_t)0x3E)
phungductung 0:4e245f4bc8ac 264
phungductung 0:4e245f4bc8ac 265 /* Threshold for touch detection */
phungductung 0:4e245f4bc8ac 266 #define FT5336_TH_GROUP_REG ((uint8_t)0x80)
phungductung 0:4e245f4bc8ac 267
phungductung 0:4e245f4bc8ac 268 /* Values FT5336_TH_GROUP_REG : threshold related */
phungductung 0:4e245f4bc8ac 269 #define FT5336_THRESHOLD_MASK ((uint8_t)0xFF)
phungductung 0:4e245f4bc8ac 270 #define FT5336_THRESHOLD_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 271
phungductung 0:4e245f4bc8ac 272 /* Filter function coefficients */
phungductung 0:4e245f4bc8ac 273 #define FT5336_TH_DIFF_REG ((uint8_t)0x85)
phungductung 0:4e245f4bc8ac 274
phungductung 0:4e245f4bc8ac 275 /* Control register */
phungductung 0:4e245f4bc8ac 276 #define FT5336_CTRL_REG ((uint8_t)0x86)
phungductung 0:4e245f4bc8ac 277
phungductung 0:4e245f4bc8ac 278 /* Values related to FT5336_CTRL_REG */
phungductung 0:4e245f4bc8ac 279
phungductung 0:4e245f4bc8ac 280 /* Will keep the Active mode when there is no touching */
phungductung 0:4e245f4bc8ac 281 #define FT5336_CTRL_KEEP_ACTIVE_MODE ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 282
phungductung 0:4e245f4bc8ac 283 /* Switching from Active mode to Monitor mode automatically when there is no touching */
phungductung 0:4e245f4bc8ac 284 #define FT5336_CTRL_KEEP_AUTO_SWITCH_MONITOR_MODE ((uint8_t)0x01
phungductung 0:4e245f4bc8ac 285
phungductung 0:4e245f4bc8ac 286 /* The time period of switching from Active mode to Monitor mode when there is no touching */
phungductung 0:4e245f4bc8ac 287 #define FT5336_TIMEENTERMONITOR_REG ((uint8_t)0x87)
phungductung 0:4e245f4bc8ac 288
phungductung 0:4e245f4bc8ac 289 /* Report rate in Active mode */
phungductung 0:4e245f4bc8ac 290 #define FT5336_PERIODACTIVE_REG ((uint8_t)0x88)
phungductung 0:4e245f4bc8ac 291
phungductung 0:4e245f4bc8ac 292 /* Report rate in Monitor mode */
phungductung 0:4e245f4bc8ac 293 #define FT5336_PERIODMONITOR_REG ((uint8_t)0x89)
phungductung 0:4e245f4bc8ac 294
phungductung 0:4e245f4bc8ac 295 /* The value of the minimum allowed angle while Rotating gesture mode */
phungductung 0:4e245f4bc8ac 296 #define FT5336_RADIAN_VALUE_REG ((uint8_t)0x91)
phungductung 0:4e245f4bc8ac 297
phungductung 0:4e245f4bc8ac 298 /* Maximum offset while Moving Left and Moving Right gesture */
phungductung 0:4e245f4bc8ac 299 #define FT5336_OFFSET_LEFT_RIGHT_REG ((uint8_t)0x92)
phungductung 0:4e245f4bc8ac 300
phungductung 0:4e245f4bc8ac 301 /* Maximum offset while Moving Up and Moving Down gesture */
phungductung 0:4e245f4bc8ac 302 #define FT5336_OFFSET_UP_DOWN_REG ((uint8_t)0x93)
phungductung 0:4e245f4bc8ac 303
phungductung 0:4e245f4bc8ac 304 /* Minimum distance while Moving Left and Moving Right gesture */
phungductung 0:4e245f4bc8ac 305 #define FT5336_DISTANCE_LEFT_RIGHT_REG ((uint8_t)0x94)
phungductung 0:4e245f4bc8ac 306
phungductung 0:4e245f4bc8ac 307 /* Minimum distance while Moving Up and Moving Down gesture */
phungductung 0:4e245f4bc8ac 308 #define FT5336_DISTANCE_UP_DOWN_REG ((uint8_t)0x95)
phungductung 0:4e245f4bc8ac 309
phungductung 0:4e245f4bc8ac 310 /* Maximum distance while Zoom In and Zoom Out gesture */
phungductung 0:4e245f4bc8ac 311 #define FT5336_DISTANCE_ZOOM_REG ((uint8_t)0x96)
phungductung 0:4e245f4bc8ac 312
phungductung 0:4e245f4bc8ac 313 /* High 8-bit of LIB Version info */
phungductung 0:4e245f4bc8ac 314 #define FT5336_LIB_VER_H_REG ((uint8_t)0xA1)
phungductung 0:4e245f4bc8ac 315
phungductung 0:4e245f4bc8ac 316 /* Low 8-bit of LIB Version info */
phungductung 0:4e245f4bc8ac 317 #define FT5336_LIB_VER_L_REG ((uint8_t)0xA2)
phungductung 0:4e245f4bc8ac 318
phungductung 0:4e245f4bc8ac 319 /* Chip Selecting */
phungductung 0:4e245f4bc8ac 320 #define FT5336_CIPHER_REG ((uint8_t)0xA3)
phungductung 0:4e245f4bc8ac 321
phungductung 0:4e245f4bc8ac 322 /* Interrupt mode register (used when in interrupt mode) */
phungductung 0:4e245f4bc8ac 323 #define FT5336_GMODE_REG ((uint8_t)0xA4)
phungductung 0:4e245f4bc8ac 324
phungductung 0:4e245f4bc8ac 325 #define FT5336_G_MODE_INTERRUPT_MASK ((uint8_t)0x03)
phungductung 0:4e245f4bc8ac 326 #define FT5336_G_MODE_INTERRUPT_SHIFT ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 327
phungductung 0:4e245f4bc8ac 328 /* Possible values of FT5336_GMODE_REG */
phungductung 0:4e245f4bc8ac 329 #define FT5336_G_MODE_INTERRUPT_POLLING ((uint8_t)0x00)
phungductung 0:4e245f4bc8ac 330 #define FT5336_G_MODE_INTERRUPT_TRIGGER ((uint8_t)0x01)
phungductung 0:4e245f4bc8ac 331
phungductung 0:4e245f4bc8ac 332 /* Current power mode the FT5336 system is in (R) */
phungductung 0:4e245f4bc8ac 333 #define FT5336_PWR_MODE_REG ((uint8_t)0xA5)
phungductung 0:4e245f4bc8ac 334
phungductung 0:4e245f4bc8ac 335 /* FT5336 firmware version */
phungductung 0:4e245f4bc8ac 336 #define FT5336_FIRMID_REG ((uint8_t)0xA6)
phungductung 0:4e245f4bc8ac 337
phungductung 0:4e245f4bc8ac 338 /* FT5336 Chip identification register */
phungductung 0:4e245f4bc8ac 339 #define FT5336_CHIP_ID_REG ((uint8_t)0xA8)
phungductung 0:4e245f4bc8ac 340
phungductung 0:4e245f4bc8ac 341 /* Possible values of FT5336_CHIP_ID_REG */
phungductung 0:4e245f4bc8ac 342 #define FT5336_ID_VALUE ((uint8_t)0x51)
phungductung 0:4e245f4bc8ac 343
phungductung 0:4e245f4bc8ac 344 /* Release code version */
phungductung 0:4e245f4bc8ac 345 #define FT5336_RELEASE_CODE_ID_REG ((uint8_t)0xAF)
phungductung 0:4e245f4bc8ac 346
phungductung 0:4e245f4bc8ac 347 /* Current operating mode the FT5336 system is in (R) */
phungductung 0:4e245f4bc8ac 348 #define FT5336_STATE_REG ((uint8_t)0xBC)
phungductung 0:4e245f4bc8ac 349
phungductung 0:4e245f4bc8ac 350 /**
phungductung 0:4e245f4bc8ac 351 * @}
phungductung 0:4e245f4bc8ac 352 */
phungductung 0:4e245f4bc8ac 353
phungductung 0:4e245f4bc8ac 354 /* Exported macro ------------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 355
phungductung 0:4e245f4bc8ac 356 /** @defgroup ft5336_Exported_Macros
phungductung 0:4e245f4bc8ac 357 * @{
phungductung 0:4e245f4bc8ac 358 */
phungductung 0:4e245f4bc8ac 359
phungductung 0:4e245f4bc8ac 360 /* Exported functions --------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 361
phungductung 0:4e245f4bc8ac 362 /** @defgroup ft5336_Exported_Functions
phungductung 0:4e245f4bc8ac 363 * @{
phungductung 0:4e245f4bc8ac 364 */
phungductung 0:4e245f4bc8ac 365
phungductung 0:4e245f4bc8ac 366 /**
phungductung 0:4e245f4bc8ac 367 * @brief ft5336 Control functions
phungductung 0:4e245f4bc8ac 368 */
phungductung 0:4e245f4bc8ac 369
phungductung 0:4e245f4bc8ac 370
phungductung 0:4e245f4bc8ac 371 /**
phungductung 0:4e245f4bc8ac 372 * @brief Initialize the ft5336 communication bus
phungductung 0:4e245f4bc8ac 373 * from MCU to FT5336 : ie I2C channel initialization (if required).
phungductung 0:4e245f4bc8ac 374 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 375 * @retval None
phungductung 0:4e245f4bc8ac 376 */
phungductung 0:4e245f4bc8ac 377 void ft5336_Init(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 378
phungductung 0:4e245f4bc8ac 379 /**
phungductung 0:4e245f4bc8ac 380 * @brief Software Reset the ft5336.
phungductung 0:4e245f4bc8ac 381 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 382 * @retval None
phungductung 0:4e245f4bc8ac 383 */
phungductung 0:4e245f4bc8ac 384 void ft5336_Reset(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 385
phungductung 0:4e245f4bc8ac 386 /**
phungductung 0:4e245f4bc8ac 387 * @brief Read the ft5336 device ID, pre initialize I2C in case of need to be
phungductung 0:4e245f4bc8ac 388 * able to read the FT5336 device ID, and verify this is a FT5336.
phungductung 0:4e245f4bc8ac 389 * @param DeviceAddr: I2C FT5336 Slave address.
phungductung 0:4e245f4bc8ac 390 * @retval The Device ID (two bytes).
phungductung 0:4e245f4bc8ac 391 */
phungductung 0:4e245f4bc8ac 392 uint16_t ft5336_ReadID(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 393
phungductung 0:4e245f4bc8ac 394 /**
phungductung 0:4e245f4bc8ac 395 * @brief Configures the touch Screen IC device to start detecting touches
phungductung 0:4e245f4bc8ac 396 * @param DeviceAddr: Device address on communication Bus (I2C slave address).
phungductung 0:4e245f4bc8ac 397 * @retval None.
phungductung 0:4e245f4bc8ac 398 */
phungductung 0:4e245f4bc8ac 399 void ft5336_TS_Start(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 400
phungductung 0:4e245f4bc8ac 401 /**
phungductung 0:4e245f4bc8ac 402 * @brief Return if there is touches detected or not.
phungductung 0:4e245f4bc8ac 403 * Try to detect new touches and forget the old ones (reset internal global
phungductung 0:4e245f4bc8ac 404 * variables).
phungductung 0:4e245f4bc8ac 405 * @param DeviceAddr: Device address on communication Bus.
phungductung 0:4e245f4bc8ac 406 * @retval : Number of active touches detected (can be 0, 1 or 2).
phungductung 0:4e245f4bc8ac 407 */
phungductung 0:4e245f4bc8ac 408 uint8_t ft5336_TS_DetectTouch(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 409
phungductung 0:4e245f4bc8ac 410 /**
phungductung 0:4e245f4bc8ac 411 * @brief Get the touch screen X and Y positions values
phungductung 0:4e245f4bc8ac 412 * Manage multi touch thanks to touch Index global
phungductung 0:4e245f4bc8ac 413 * variable 'ft5336_handle.currActiveTouchIdx'.
phungductung 0:4e245f4bc8ac 414 * @param DeviceAddr: Device address on communication Bus.
phungductung 0:4e245f4bc8ac 415 * @param X: Pointer to X position value
phungductung 0:4e245f4bc8ac 416 * @param Y: Pointer to Y position value
phungductung 0:4e245f4bc8ac 417 * @retval None.
phungductung 0:4e245f4bc8ac 418 */
phungductung 0:4e245f4bc8ac 419 void ft5336_TS_GetXY(uint16_t DeviceAddr, uint16_t *X, uint16_t *Y);
phungductung 0:4e245f4bc8ac 420
phungductung 0:4e245f4bc8ac 421 /**
phungductung 0:4e245f4bc8ac 422 * @brief Configure the FT5336 device to generate IT on given INT pin
phungductung 0:4e245f4bc8ac 423 * connected to MCU as EXTI.
phungductung 0:4e245f4bc8ac 424 * @param DeviceAddr: Device address on communication Bus (Slave I2C address of FT5336).
phungductung 0:4e245f4bc8ac 425 * @retval None
phungductung 0:4e245f4bc8ac 426 */
phungductung 0:4e245f4bc8ac 427 void ft5336_TS_EnableIT(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 428
phungductung 0:4e245f4bc8ac 429 /**
phungductung 0:4e245f4bc8ac 430 * @brief Configure the FT5336 device to stop generating IT on the given INT pin
phungductung 0:4e245f4bc8ac 431 * connected to MCU as EXTI.
phungductung 0:4e245f4bc8ac 432 * @param DeviceAddr: Device address on communication Bus (Slave I2C address of FT5336).
phungductung 0:4e245f4bc8ac 433 * @retval None
phungductung 0:4e245f4bc8ac 434 */
phungductung 0:4e245f4bc8ac 435 void ft5336_TS_DisableIT(uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 436
phungductung 0:4e245f4bc8ac 437 /**
phungductung 0:4e245f4bc8ac 438 * @brief Get IT status from FT5336 interrupt status registers
phungductung 0:4e245f4bc8ac 439 * Should be called Following an EXTI coming to the MCU to know the detailed
phungductung 0:4e245f4bc8ac 440 * reason of the interrupt.
phungductung 0:4e245f4bc8ac 441 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 442 * @retval TS interrupts status
phungductung 0:4e245f4bc8ac 443 */
phungductung 0:4e245f4bc8ac 444 uint8_t ft5336_TS_ITStatus (uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 445
phungductung 0:4e245f4bc8ac 446 /**
phungductung 0:4e245f4bc8ac 447 * @brief Clear IT status in FT5336 interrupt status clear registers
phungductung 0:4e245f4bc8ac 448 * Should be called Following an EXTI coming to the MCU.
phungductung 0:4e245f4bc8ac 449 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 450 * @retval TS interrupts status
phungductung 0:4e245f4bc8ac 451 */
phungductung 0:4e245f4bc8ac 452 void ft5336_TS_ClearIT (uint16_t DeviceAddr);
phungductung 0:4e245f4bc8ac 453
phungductung 0:4e245f4bc8ac 454 /**** NEW FEATURES enabled when Multi-touch support is enabled ****/
phungductung 0:4e245f4bc8ac 455
phungductung 0:4e245f4bc8ac 456 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
phungductung 0:4e245f4bc8ac 457
phungductung 0:4e245f4bc8ac 458 /**
phungductung 0:4e245f4bc8ac 459 * @brief Get the last touch gesture identification (zoom, move up/down...).
phungductung 0:4e245f4bc8ac 460 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 461 * @param pGestureId : Pointer to get last touch gesture Identification.
phungductung 0:4e245f4bc8ac 462 * @retval None.
phungductung 0:4e245f4bc8ac 463 */
phungductung 0:4e245f4bc8ac 464 void ft5336_TS_GetGestureID(uint16_t DeviceAddr, uint32_t * pGestureId);
phungductung 0:4e245f4bc8ac 465
phungductung 0:4e245f4bc8ac 466 /**
phungductung 0:4e245f4bc8ac 467 * @brief Get the touch detailed informations on touch number 'touchIdx' (0..1)
phungductung 0:4e245f4bc8ac 468 * This touch detailed information contains :
phungductung 0:4e245f4bc8ac 469 * - weight that was applied to this touch
phungductung 0:4e245f4bc8ac 470 * - sub-area of the touch in the touch panel
phungductung 0:4e245f4bc8ac 471 * - event of linked to the touch (press down, lift up, ...)
phungductung 0:4e245f4bc8ac 472 * @param DeviceAddr: Device address on communication Bus (I2C slave address of FT5336).
phungductung 0:4e245f4bc8ac 473 * @param touchIdx : Passed index of the touch (0..1) on which we want to get the
phungductung 0:4e245f4bc8ac 474 * detailed information.
phungductung 0:4e245f4bc8ac 475 * @param pWeight : Pointer to to get the weight information of 'touchIdx'.
phungductung 0:4e245f4bc8ac 476 * @param pArea : Pointer to to get the sub-area information of 'touchIdx'.
phungductung 0:4e245f4bc8ac 477 * @param pEvent : Pointer to to get the event information of 'touchIdx'.
phungductung 0:4e245f4bc8ac 478
phungductung 0:4e245f4bc8ac 479 * @retval None.
phungductung 0:4e245f4bc8ac 480 */
phungductung 0:4e245f4bc8ac 481 void ft5336_TS_GetTouchInfo(uint16_t DeviceAddr,
phungductung 0:4e245f4bc8ac 482 uint32_t touchIdx,
phungductung 0:4e245f4bc8ac 483 uint32_t * pWeight,
phungductung 0:4e245f4bc8ac 484 uint32_t * pArea,
phungductung 0:4e245f4bc8ac 485 uint32_t * pEvent);
phungductung 0:4e245f4bc8ac 486
phungductung 0:4e245f4bc8ac 487 #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */
phungductung 0:4e245f4bc8ac 488
phungductung 0:4e245f4bc8ac 489 /* Imported TS IO functions --------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 490
phungductung 0:4e245f4bc8ac 491 /** @defgroup ft5336_Imported_Functions
phungductung 0:4e245f4bc8ac 492 * @{
phungductung 0:4e245f4bc8ac 493 */
phungductung 0:4e245f4bc8ac 494
phungductung 0:4e245f4bc8ac 495 /* TouchScreen (TS) external IO functions */
phungductung 0:4e245f4bc8ac 496 extern void TS_IO_Init(void);
phungductung 0:4e245f4bc8ac 497 extern void TS_IO_Write(uint8_t Addr, uint8_t Reg, uint8_t Value);
phungductung 0:4e245f4bc8ac 498 extern uint8_t TS_IO_Read(uint8_t Addr, uint8_t Reg);
phungductung 0:4e245f4bc8ac 499 extern void TS_IO_Delay(uint32_t Delay);
phungductung 0:4e245f4bc8ac 500
phungductung 0:4e245f4bc8ac 501 /**
phungductung 0:4e245f4bc8ac 502 * @}
phungductung 0:4e245f4bc8ac 503 */
phungductung 0:4e245f4bc8ac 504
phungductung 0:4e245f4bc8ac 505 /* Imported global variables --------------------------------------------------------*/
phungductung 0:4e245f4bc8ac 506
phungductung 0:4e245f4bc8ac 507 /** @defgroup ft5336_Imported_Globals
phungductung 0:4e245f4bc8ac 508 * @{
phungductung 0:4e245f4bc8ac 509 */
phungductung 0:4e245f4bc8ac 510
phungductung 0:4e245f4bc8ac 511
phungductung 0:4e245f4bc8ac 512 /* Touch screen driver structure */
phungductung 0:4e245f4bc8ac 513 extern TS_DrvTypeDef ft5336_ts_drv;
phungductung 0:4e245f4bc8ac 514
phungductung 0:4e245f4bc8ac 515 /**
phungductung 0:4e245f4bc8ac 516 * @}
phungductung 0:4e245f4bc8ac 517 */
phungductung 0:4e245f4bc8ac 518
phungductung 0:4e245f4bc8ac 519 #ifdef __cplusplus
phungductung 0:4e245f4bc8ac 520 }
phungductung 0:4e245f4bc8ac 521 #endif
phungductung 0:4e245f4bc8ac 522 #endif /* __FT5336_H */
phungductung 0:4e245f4bc8ac 523
phungductung 0:4e245f4bc8ac 524
phungductung 0:4e245f4bc8ac 525 /**
phungductung 0:4e245f4bc8ac 526 * @}
phungductung 0:4e245f4bc8ac 527 */
phungductung 0:4e245f4bc8ac 528
phungductung 0:4e245f4bc8ac 529 /**
phungductung 0:4e245f4bc8ac 530 * @}
phungductung 0:4e245f4bc8ac 531 */
phungductung 0:4e245f4bc8ac 532
phungductung 0:4e245f4bc8ac 533 /**
phungductung 0:4e245f4bc8ac 534 * @}
phungductung 0:4e245f4bc8ac 535 */
phungductung 0:4e245f4bc8ac 536
phungductung 0:4e245f4bc8ac 537 /**
phungductung 0:4e245f4bc8ac 538 * @}
phungductung 0:4e245f4bc8ac 539 */
phungductung 0:4e245f4bc8ac 540 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/