sp
BSP_DISCO_F746NG/stm32746g_discovery_ts.h
- Committer:
- phungductung
- Date:
- 2019-06-07
- Revision:
- 0:4e245f4bc8ac
File content as of revision 0:4e245f4bc8ac:
/** ****************************************************************************** * @file stm32746g_discovery_ts.h * @author MCD Application Team * @version V1.0.0 * @date 25-June-2015 * @brief This file contains the common defines and functions prototypes for * the stm32746g_discovery_ts.c driver. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __STM32746G_DISCOVERY_TS_H #define __STM32746G_DISCOVERY_TS_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include "stm32746g_discovery.h" /* Include touch screen FT5336 component Driver */ #include "ft5336.h" // MBED /** @addtogroup BSP * @{ */ /** @addtogroup STM32746G_DISCOVERY * @{ */ /** @addtogroup STM32746G_DISCOVERY_TS * @{ */ /** @defgroup STM32746G_DISCOVERY_TS_Exported_Constants STM32746G_DISCOVERY_TS Exported Constants * @{ */ /** @brief With FT5336 : maximum 5 touches detected simultaneously */ #define TS_MAX_NB_TOUCH ((uint32_t) FT5336_MAX_DETECTABLE_TOUCH) #define TS_NO_IRQ_PENDING ((uint8_t) 0) #define TS_IRQ_PENDING ((uint8_t) 1) #define TS_SWAP_NONE ((uint8_t) 0x01) #define TS_SWAP_X ((uint8_t) 0x02) #define TS_SWAP_Y ((uint8_t) 0x04) #define TS_SWAP_XY ((uint8_t) 0x08) /** * @} */ /** @defgroup STM32746G_DISCOVERY_TS_Exported_Types STM32746G_DISCOVERY_TS Exported Types * @{ */ /** * @brief TS_StateTypeDef * Define TS State structure */ typedef struct { uint8_t touchDetected; /*!< Total number of active touches detected at last scan */ uint16_t touchX[TS_MAX_NB_TOUCH]; /*!< Touch X[0], X[1] coordinates on 12 bits */ uint16_t touchY[TS_MAX_NB_TOUCH]; /*!< Touch Y[0], Y[1] coordinates on 12 bits */ #if (TS_MULTI_TOUCH_SUPPORTED == 1) uint8_t touchWeight[TS_MAX_NB_TOUCH]; /*!< Touch_Weight[0], Touch_Weight[1] : weight property of touches */ uint8_t touchEventId[TS_MAX_NB_TOUCH]; /*!< Touch_EventId[0], Touch_EventId[1] : take value of type @ref TS_TouchEventTypeDef */ uint8_t touchArea[TS_MAX_NB_TOUCH]; /*!< Touch_Area[0], Touch_Area[1] : touch area of each touch */ uint32_t gestureId; /*!< type of gesture detected : take value of type @ref TS_GestureIdTypeDef */ #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */ } TS_StateTypeDef; /** * @} */ /** @defgroup STM32746G_DISCOVERY_TS_Exported_Constants STM32746G_DISCOVERY_TS Exported Constants * @{ */ typedef enum { TS_OK = 0x00, /*!< Touch Ok */ TS_ERROR = 0x01, /*!< Touch Error */ TS_TIMEOUT = 0x02, /*!< Touch Timeout */ TS_DEVICE_NOT_FOUND = 0x03 /*!< Touchscreen device not found */ }TS_StatusTypeDef; /** * @brief TS_GestureIdTypeDef * Define Possible managed gesture identification values returned by touch screen * driver. */ typedef enum { GEST_ID_NO_GESTURE = 0x00, /*!< Gesture not defined / recognized */ GEST_ID_MOVE_UP = 0x01, /*!< Gesture Move Up */ GEST_ID_MOVE_RIGHT = 0x02, /*!< Gesture Move Right */ GEST_ID_MOVE_DOWN = 0x03, /*!< Gesture Move Down */ GEST_ID_MOVE_LEFT = 0x04, /*!< Gesture Move Left */ GEST_ID_ZOOM_IN = 0x05, /*!< Gesture Zoom In */ GEST_ID_ZOOM_OUT = 0x06, /*!< Gesture Zoom Out */ GEST_ID_NB_MAX = 0x07 /*!< max number of gesture id */ } TS_GestureIdTypeDef; /** * @brief TS_TouchEventTypeDef * Define Possible touch events kind as returned values * by touch screen IC Driver. */ typedef enum { TOUCH_EVENT_NO_EVT = 0x00, /*!< Touch Event : undetermined */ TOUCH_EVENT_PRESS_DOWN = 0x01, /*!< Touch Event Press Down */ TOUCH_EVENT_LIFT_UP = 0x02, /*!< Touch Event Lift Up */ TOUCH_EVENT_CONTACT = 0x03, /*!< Touch Event Contact */ TOUCH_EVENT_NB_MAX = 0x04 /*!< max number of touch events kind */ } TS_TouchEventTypeDef; /** * @} */ /** @defgroup STM32746G_DISCOVERY_TS_Imported_Variables STM32746G_DISCOVERY_TS Imported Variables * @{ */ /** * @brief Table for touchscreen event information display on LCD : * table indexed on enum @ref TS_TouchEventTypeDef information */ extern char * ts_event_string_tab[TOUCH_EVENT_NB_MAX]; /** * @brief Table for touchscreen gesture Id information display on LCD : table indexed * on enum @ref TS_GestureIdTypeDef information */ extern char * ts_gesture_id_string_tab[GEST_ID_NB_MAX]; /** * @} */ /** @addtogroup STM32746G_DISCOVERY_TS_Exported_Functions * @{ */ uint8_t BSP_TS_Init(uint16_t ts_SizeX, uint16_t ts_SizeY); uint8_t BSP_TS_DeInit(void); uint8_t BSP_TS_GetState(TS_StateTypeDef *TS_State); #if (TS_MULTI_TOUCH_SUPPORTED == 1) uint8_t BSP_TS_Get_GestureId(TS_StateTypeDef *TS_State); #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */ uint8_t BSP_TS_ITConfig(void); uint8_t BSP_TS_ITGetStatus(void); void BSP_TS_ITClear(void); uint8_t BSP_TS_ResetTouchData(TS_StateTypeDef *TS_State); /** * @} */ /** * @} */ /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __STM32746G_DISCOVERY_TS_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/