Sylvain Letreguilly / Mbed 2 deprecated cpelcddemo

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

lib/BSP_DISCO_F746NG/stm32746g_discovery_ts.h@0:14f16771fe40, 2015-11-05 (annotated)

Committer:
agemio
Date:
Thu Nov 05 12:53:31 2015 +0000
Revision:
0:14f16771fe40
first commit;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
agemio 0:14f16771fe40 1 /**
agemio 0:14f16771fe40 2 ******************************************************************************
agemio 0:14f16771fe40 3 * @file stm32746g_discovery_ts.h
agemio 0:14f16771fe40 4 * @author MCD Application Team
agemio 0:14f16771fe40 5 * @version V1.0.0
agemio 0:14f16771fe40 6 * @date 25-June-2015
agemio 0:14f16771fe40 7 * @brief This file contains the common defines and functions prototypes for
agemio 0:14f16771fe40 8 * the stm32746g_discovery_ts.c driver.
agemio 0:14f16771fe40 9 ******************************************************************************
agemio 0:14f16771fe40 10 * @attention
agemio 0:14f16771fe40 11 *
agemio 0:14f16771fe40 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
agemio 0:14f16771fe40 13 *
agemio 0:14f16771fe40 14 * Redistribution and use in source and binary forms, with or without modification,
agemio 0:14f16771fe40 15 * are permitted provided that the following conditions are met:
agemio 0:14f16771fe40 16 * 1. Redistributions of source code must retain the above copyright notice,
agemio 0:14f16771fe40 17 * this list of conditions and the following disclaimer.
agemio 0:14f16771fe40 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
agemio 0:14f16771fe40 19 * this list of conditions and the following disclaimer in the documentation
agemio 0:14f16771fe40 20 * and/or other materials provided with the distribution.
agemio 0:14f16771fe40 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
agemio 0:14f16771fe40 22 * may be used to endorse or promote products derived from this software
agemio 0:14f16771fe40 23 * without specific prior written permission.
agemio 0:14f16771fe40 24 *
agemio 0:14f16771fe40 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
agemio 0:14f16771fe40 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
agemio 0:14f16771fe40 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
agemio 0:14f16771fe40 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
agemio 0:14f16771fe40 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
agemio 0:14f16771fe40 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
agemio 0:14f16771fe40 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
agemio 0:14f16771fe40 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
agemio 0:14f16771fe40 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
agemio 0:14f16771fe40 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
agemio 0:14f16771fe40 35 *
agemio 0:14f16771fe40 36 ******************************************************************************
agemio 0:14f16771fe40 37 */
agemio 0:14f16771fe40 38
agemio 0:14f16771fe40 39 /* Define to prevent recursive inclusion -------------------------------------*/
agemio 0:14f16771fe40 40 #ifndef __STM32746G_DISCOVERY_TS_H
agemio 0:14f16771fe40 41 #define __STM32746G_DISCOVERY_TS_H
agemio 0:14f16771fe40 42
agemio 0:14f16771fe40 43 #ifdef __cplusplus
agemio 0:14f16771fe40 44 extern "C" {
agemio 0:14f16771fe40 45 #endif
agemio 0:14f16771fe40 46
agemio 0:14f16771fe40 47 /* Includes ------------------------------------------------------------------*/
agemio 0:14f16771fe40 48 #include "stm32746g_discovery.h"
agemio 0:14f16771fe40 49 /* Include touch screen FT5336 component Driver */
agemio 0:14f16771fe40 50 #include "ft5336.h"
agemio 0:14f16771fe40 51
agemio 0:14f16771fe40 52 /** @addtogroup BSP
agemio 0:14f16771fe40 53 * @{
agemio 0:14f16771fe40 54 */
agemio 0:14f16771fe40 55
agemio 0:14f16771fe40 56 /** @addtogroup STM32746G_DISCOVERY
agemio 0:14f16771fe40 57 * @{
agemio 0:14f16771fe40 58 */
agemio 0:14f16771fe40 59
agemio 0:14f16771fe40 60 /** @addtogroup STM32746G_DISCOVERY_TS
agemio 0:14f16771fe40 61 * @{
agemio 0:14f16771fe40 62 */
agemio 0:14f16771fe40 63
agemio 0:14f16771fe40 64 /** @defgroup STM32746G_DISCOVERY_TS_Exported_Constants STM32746G_DISCOVERY_TS Exported Constants
agemio 0:14f16771fe40 65 * @{
agemio 0:14f16771fe40 66 */
agemio 0:14f16771fe40 67
agemio 0:14f16771fe40 68 /** @brief With FT5336 : maximum 5 touches detected simultaneously
agemio 0:14f16771fe40 69 */
agemio 0:14f16771fe40 70 #define TS_MAX_NB_TOUCH ((uint32_t) FT5336_MAX_DETECTABLE_TOUCH)
agemio 0:14f16771fe40 71
agemio 0:14f16771fe40 72 #define TS_NO_IRQ_PENDING ((uint8_t) 0)
agemio 0:14f16771fe40 73 #define TS_IRQ_PENDING ((uint8_t) 1)
agemio 0:14f16771fe40 74
agemio 0:14f16771fe40 75 #define TS_SWAP_NONE ((uint8_t) 0x01)
agemio 0:14f16771fe40 76 #define TS_SWAP_X ((uint8_t) 0x02)
agemio 0:14f16771fe40 77 #define TS_SWAP_Y ((uint8_t) 0x04)
agemio 0:14f16771fe40 78 #define TS_SWAP_XY ((uint8_t) 0x08)
agemio 0:14f16771fe40 79
agemio 0:14f16771fe40 80 /**
agemio 0:14f16771fe40 81 * @}
agemio 0:14f16771fe40 82 */
agemio 0:14f16771fe40 83
agemio 0:14f16771fe40 84 /** @defgroup STM32746G_DISCOVERY_TS_Exported_Types STM32746G_DISCOVERY_TS Exported Types
agemio 0:14f16771fe40 85 * @{
agemio 0:14f16771fe40 86 */
agemio 0:14f16771fe40 87 /**
agemio 0:14f16771fe40 88 * @brief TS_StateTypeDef
agemio 0:14f16771fe40 89 * Define TS State structure
agemio 0:14f16771fe40 90 */
agemio 0:14f16771fe40 91 typedef struct
agemio 0:14f16771fe40 92 {
agemio 0:14f16771fe40 93 uint8_t touchDetected; /*!< Total number of active touches detected at last scan */
agemio 0:14f16771fe40 94 uint16_t touchX[TS_MAX_NB_TOUCH]; /*!< Touch X[0], X[1] coordinates on 12 bits */
agemio 0:14f16771fe40 95 uint16_t touchY[TS_MAX_NB_TOUCH]; /*!< Touch Y[0], Y[1] coordinates on 12 bits */
agemio 0:14f16771fe40 96
agemio 0:14f16771fe40 97 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
agemio 0:14f16771fe40 98 uint8_t touchWeight[TS_MAX_NB_TOUCH]; /*!< Touch_Weight[0], Touch_Weight[1] : weight property of touches */
agemio 0:14f16771fe40 99 uint8_t touchEventId[TS_MAX_NB_TOUCH]; /*!< Touch_EventId[0], Touch_EventId[1] : take value of type @ref TS_TouchEventTypeDef */
agemio 0:14f16771fe40 100 uint8_t touchArea[TS_MAX_NB_TOUCH]; /*!< Touch_Area[0], Touch_Area[1] : touch area of each touch */
agemio 0:14f16771fe40 101 uint32_t gestureId; /*!< type of gesture detected : take value of type @ref TS_GestureIdTypeDef */
agemio 0:14f16771fe40 102 #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */
agemio 0:14f16771fe40 103
agemio 0:14f16771fe40 104 } TS_StateTypeDef;
agemio 0:14f16771fe40 105
agemio 0:14f16771fe40 106 /**
agemio 0:14f16771fe40 107 * @}
agemio 0:14f16771fe40 108 */
agemio 0:14f16771fe40 109
agemio 0:14f16771fe40 110 /** @defgroup STM32746G_DISCOVERY_TS_Exported_Constants STM32746G_DISCOVERY_TS Exported Constants
agemio 0:14f16771fe40 111 * @{
agemio 0:14f16771fe40 112 */
agemio 0:14f16771fe40 113
agemio 0:14f16771fe40 114 typedef enum
agemio 0:14f16771fe40 115 {
agemio 0:14f16771fe40 116 TS_OK = 0x00, /*!< Touch Ok */
agemio 0:14f16771fe40 117 TS_ERROR = 0x01, /*!< Touch Error */
agemio 0:14f16771fe40 118 TS_TIMEOUT = 0x02, /*!< Touch Timeout */
agemio 0:14f16771fe40 119 TS_DEVICE_NOT_FOUND = 0x03 /*!< Touchscreen device not found */
agemio 0:14f16771fe40 120 }TS_StatusTypeDef;
agemio 0:14f16771fe40 121
agemio 0:14f16771fe40 122 /**
agemio 0:14f16771fe40 123 * @brief TS_GestureIdTypeDef
agemio 0:14f16771fe40 124 * Define Possible managed gesture identification values returned by touch screen
agemio 0:14f16771fe40 125 * driver.
agemio 0:14f16771fe40 126 */
agemio 0:14f16771fe40 127 typedef enum
agemio 0:14f16771fe40 128 {
agemio 0:14f16771fe40 129 GEST_ID_NO_GESTURE = 0x00, /*!< Gesture not defined / recognized */
agemio 0:14f16771fe40 130 GEST_ID_MOVE_UP = 0x01, /*!< Gesture Move Up */
agemio 0:14f16771fe40 131 GEST_ID_MOVE_RIGHT = 0x02, /*!< Gesture Move Right */
agemio 0:14f16771fe40 132 GEST_ID_MOVE_DOWN = 0x03, /*!< Gesture Move Down */
agemio 0:14f16771fe40 133 GEST_ID_MOVE_LEFT = 0x04, /*!< Gesture Move Left */
agemio 0:14f16771fe40 134 GEST_ID_ZOOM_IN = 0x05, /*!< Gesture Zoom In */
agemio 0:14f16771fe40 135 GEST_ID_ZOOM_OUT = 0x06, /*!< Gesture Zoom Out */
agemio 0:14f16771fe40 136 GEST_ID_NB_MAX = 0x07 /*!< max number of gesture id */
agemio 0:14f16771fe40 137
agemio 0:14f16771fe40 138 } TS_GestureIdTypeDef;
agemio 0:14f16771fe40 139
agemio 0:14f16771fe40 140 /**
agemio 0:14f16771fe40 141 * @brief TS_TouchEventTypeDef
agemio 0:14f16771fe40 142 * Define Possible touch events kind as returned values
agemio 0:14f16771fe40 143 * by touch screen IC Driver.
agemio 0:14f16771fe40 144 */
agemio 0:14f16771fe40 145 typedef enum
agemio 0:14f16771fe40 146 {
agemio 0:14f16771fe40 147 TOUCH_EVENT_NO_EVT = 0x00, /*!< Touch Event : undetermined */
agemio 0:14f16771fe40 148 TOUCH_EVENT_PRESS_DOWN = 0x01, /*!< Touch Event Press Down */
agemio 0:14f16771fe40 149 TOUCH_EVENT_LIFT_UP = 0x02, /*!< Touch Event Lift Up */
agemio 0:14f16771fe40 150 TOUCH_EVENT_CONTACT = 0x03, /*!< Touch Event Contact */
agemio 0:14f16771fe40 151 TOUCH_EVENT_NB_MAX = 0x04 /*!< max number of touch events kind */
agemio 0:14f16771fe40 152
agemio 0:14f16771fe40 153 } TS_TouchEventTypeDef;
agemio 0:14f16771fe40 154 /**
agemio 0:14f16771fe40 155 * @}
agemio 0:14f16771fe40 156 */
agemio 0:14f16771fe40 157
agemio 0:14f16771fe40 158 /** @defgroup STM32746G_DISCOVERY_TS_Imported_Variables STM32746G_DISCOVERY_TS Imported Variables
agemio 0:14f16771fe40 159 * @{
agemio 0:14f16771fe40 160 */
agemio 0:14f16771fe40 161 /**
agemio 0:14f16771fe40 162 * @brief Table for touchscreen event information display on LCD :
agemio 0:14f16771fe40 163 * table indexed on enum @ref TS_TouchEventTypeDef information
agemio 0:14f16771fe40 164 */
agemio 0:14f16771fe40 165 extern char * ts_event_string_tab[TOUCH_EVENT_NB_MAX];
agemio 0:14f16771fe40 166
agemio 0:14f16771fe40 167 /**
agemio 0:14f16771fe40 168 * @brief Table for touchscreen gesture Id information display on LCD : table indexed
agemio 0:14f16771fe40 169 * on enum @ref TS_GestureIdTypeDef information
agemio 0:14f16771fe40 170 */
agemio 0:14f16771fe40 171 extern char * ts_gesture_id_string_tab[GEST_ID_NB_MAX];
agemio 0:14f16771fe40 172 /**
agemio 0:14f16771fe40 173 * @}
agemio 0:14f16771fe40 174 */
agemio 0:14f16771fe40 175
agemio 0:14f16771fe40 176 /** @addtogroup STM32746G_DISCOVERY_TS_Exported_Functions
agemio 0:14f16771fe40 177 * @{
agemio 0:14f16771fe40 178 */
agemio 0:14f16771fe40 179 uint8_t BSP_TS_Init(uint16_t ts_SizeX, uint16_t ts_SizeY);
agemio 0:14f16771fe40 180 uint8_t BSP_TS_DeInit(void);
agemio 0:14f16771fe40 181 uint8_t BSP_TS_GetState(TS_StateTypeDef *TS_State);
agemio 0:14f16771fe40 182
agemio 0:14f16771fe40 183 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
agemio 0:14f16771fe40 184 uint8_t BSP_TS_Get_GestureId(TS_StateTypeDef *TS_State);
agemio 0:14f16771fe40 185 #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */
agemio 0:14f16771fe40 186
agemio 0:14f16771fe40 187 uint8_t BSP_TS_ITConfig(void);
agemio 0:14f16771fe40 188 uint8_t BSP_TS_ITGetStatus(void);
agemio 0:14f16771fe40 189 void BSP_TS_ITClear(void);
agemio 0:14f16771fe40 190 uint8_t BSP_TS_ResetTouchData(TS_StateTypeDef *TS_State);
agemio 0:14f16771fe40 191 /**
agemio 0:14f16771fe40 192 * @}
agemio 0:14f16771fe40 193 */
agemio 0:14f16771fe40 194
agemio 0:14f16771fe40 195 /**
agemio 0:14f16771fe40 196 * @}
agemio 0:14f16771fe40 197 */
agemio 0:14f16771fe40 198
agemio 0:14f16771fe40 199 /**
agemio 0:14f16771fe40 200 * @}
agemio 0:14f16771fe40 201 */
agemio 0:14f16771fe40 202
agemio 0:14f16771fe40 203 /**
agemio 0:14f16771fe40 204 * @}
agemio 0:14f16771fe40 205 */
agemio 0:14f16771fe40 206
agemio 0:14f16771fe40 207
agemio 0:14f16771fe40 208 #ifdef __cplusplus
agemio 0:14f16771fe40 209 }
agemio 0:14f16771fe40 210 #endif
agemio 0:14f16771fe40 211
agemio 0:14f16771fe40 212 #endif /* __STM32746G_DISCOVERY_TS_H */
agemio 0:14f16771fe40 213
agemio 0:14f16771fe40 214 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/