Alexis Lacasse / BSP_DISCO_F746NG

Projet

Dependents:   DISCO-F746NG_Scope_copy

Fork of BSP_DISCO_F746NG by ST

stm32746g_discovery_ts.h@0:c9112f0c67e3, 2015-09-28 (annotated)

Committer:
bcostm
Date:
Mon Sep 28 13:34:16 2015 +0000
Revision:
0:c9112f0c67e3
Child:
5:5a395e126678
Initial version.

Who changed what in which revision?

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