Viktor Zhezher / Mbed 2 deprecated SI570_VFO_F746NG

Library to control Silicon Labs SI570 10 MHZ TO 1.4 GHZ I2C PROGRAMMABLE XO/VCXO.

Dependencies:   mbed

Fork of SI570 by Gerrit Polder

BSP_F746NG/stm32746g_discovery_ts.h@1:1556bcaaf759, 2016-03-27 (annotated)

Committer:
DL3LD
Date:
Sun Mar 27 06:55:59 2016 +0000
Revision:
1:1556bcaaf759
STM32F746NG SI570 VFO Test

Who changed what in which revision?

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