STM32F723E-Discovery BSP User Manual: stm32f723e_discovery_ts.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f723e_discovery_ts.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32f723E_discovery_ts.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __STM32F723E_DISCOVERY_TS_H
00039 #define __STM32F723E_DISCOVERY_TS_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32f723e_discovery.h"
00047 
00048 /* Include TouchScreen component driver */
00049 #include "../Components/ft6x06/ft6x06.h"
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup STM32F723E_DISCOVERY
00056   * @{
00057   */
00058 
00059 /** @addtogroup STM32F723E_DISCOVERY_TS STM32F723E-DISCOVERY TS
00060   * @{
00061   */
00062 
00063  /** @defgroup STM32F723E-DISCOVERY_TS_Exported_Constants TS Exported Constants
00064    * @{
00065    */
00066 /** @brief With FT6206 : maximum 2 touches detected simultaneously
00067   */
00068 #define TS_MAX_NB_TOUCH                 ((uint32_t) FT6206_MAX_DETECTABLE_TOUCH)
00069 
00070 #define TS_NO_IRQ_PENDING               ((uint8_t) 0)
00071 #define TS_IRQ_PENDING                  ((uint8_t) 1)
00072 
00073 #define TS_SWAP_NONE                    ((uint8_t) 0x01)
00074 #define TS_SWAP_X                       ((uint8_t) 0x02)
00075 #define TS_SWAP_Y                       ((uint8_t) 0x04)
00076 #define TS_SWAP_XY                      ((uint8_t) 0x08)
00077 
00078 #define TS_ORIENTATION_PORTRAIT         ((uint8_t) 0x00)
00079 #define TS_ORIENTATION_LANDSCAPE        ((uint8_t) 0x01)
00080 #define TS_ORIENTATION_LANDSCAPE_ROT180 ((uint8_t) 0x02)
00081 
00082  /**
00083    * @}
00084    */
00085 
00086 /** @defgroup STM32F723E-DISCOVERY_TS_Exported_Types  TS Exported Types
00087   * @{
00088   */
00089 /**
00090 *  @brief TS_StateTypeDef
00091 *  Define TS State structure
00092 */
00093 typedef struct
00094 {
00095   uint8_t  touchDetected;                /*!< Total number of active touches detected at last scan */
00096   uint16_t touchX[TS_MAX_NB_TOUCH];      /*!< Touch X[0], X[1] coordinates on 12 bits */
00097   uint16_t touchY[TS_MAX_NB_TOUCH];      /*!< Touch Y[0], Y[1] coordinates on 12 bits */
00098 
00099 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
00100   uint8_t  touchWeight[TS_MAX_NB_TOUCH]; /*!< Touch_Weight[0], Touch_Weight[1] : weight property of touches */
00101   uint8_t  touchEventId[TS_MAX_NB_TOUCH];     /*!< Touch_EventId[0], Touch_EventId[1] : take value of type @ref TS_TouchEventTypeDef */
00102   uint8_t  touchArea[TS_MAX_NB_TOUCH];   /*!< Touch_Area[0], Touch_Area[1] : touch area of each touch */
00103   uint32_t gestureId; /*!< type of gesture detected : take value of type @ref TS_GestureIdTypeDef */
00104 #endif  /* TS_MULTI_TOUCH_SUPPORTED == 1 */
00105 
00106 } TS_StateTypeDef;
00107 
00108 /**
00109  *  @brief TS_StatusTypeDef
00110  *  Define BSP_TS_xxx() functions possible return value,
00111  *  when status is returned by those functions.
00112  */
00113 typedef enum
00114 {
00115   TS_OK                = 0x00, /*!< Touch Ok */
00116   TS_ERROR             = 0x01, /*!< Touch Error */
00117   TS_TIMEOUT           = 0x02, /*!< Touch Timeout */
00118   TS_DEVICE_NOT_FOUND  = 0x03  /*!< Touchscreen device not found */
00119 } TS_StatusTypeDef;
00120 
00121 /**
00122  *  @brief TS_GestureIdTypeDef
00123  *  Define Possible managed gesture identification values returned by touch screen
00124  *  driver.
00125  */
00126 typedef enum
00127 {
00128   GEST_ID_NO_GESTURE = 0x00, /*!< Gesture not defined / recognized */
00129   GEST_ID_MOVE_UP    = 0x01, /*!< Gesture Move Up */
00130   GEST_ID_MOVE_RIGHT = 0x02, /*!< Gesture Move Right */
00131   GEST_ID_MOVE_DOWN  = 0x03, /*!< Gesture Move Down */
00132   GEST_ID_MOVE_LEFT  = 0x04, /*!< Gesture Move Left */
00133   GEST_ID_ZOOM_IN    = 0x05, /*!< Gesture Zoom In */
00134   GEST_ID_ZOOM_OUT   = 0x06, /*!< Gesture Zoom Out */
00135   GEST_ID_NB_MAX     = 0x07 /*!< max number of gesture id */
00136 } TS_GestureIdTypeDef;
00137 
00138 /**
00139  *  @brief TS_TouchEventTypeDef
00140  *  Define Possible touch events kind as returned values
00141  *  by touch screen IC Driver.
00142  */
00143 typedef enum
00144 {
00145   TOUCH_EVENT_NO_EVT        = 0x00, /*!< Touch Event : undetermined */
00146   TOUCH_EVENT_PRESS_DOWN    = 0x01, /*!< Touch Event Press Down */
00147   TOUCH_EVENT_LIFT_UP       = 0x02, /*!< Touch Event Lift Up */
00148   TOUCH_EVENT_CONTACT       = 0x03, /*!< Touch Event Contact */
00149   TOUCH_EVENT_NB_MAX        = 0x04  /*!< max number of touch events kind */
00150 } TS_TouchEventTypeDef;
00151 
00152 /**
00153   * @}
00154   */
00155 
00156 /** @addtogroup STM32F723E-DISCOVERY_TS_Imported_Variables TS Imported Variables
00157   * @{
00158   */
00159 /**
00160  *  @brief Table for touchscreen event information display on LCD :
00161  *  table indexed on enum @ref TS_TouchEventTypeDef information
00162  */
00163 extern char * ts_event_string_tab[TOUCH_EVENT_NB_MAX];
00164 
00165 /**
00166  *  @brief Table for touchscreen gesture Id information display on LCD : table indexed
00167  *  on enum @ref TS_GestureIdTypeDef information
00168  */
00169 extern char * ts_gesture_id_string_tab[GEST_ID_NB_MAX];
00170 /**
00171   * @}
00172   */
00173 
00174 /** @defgroup STM32F723E-DISCOVERY_TS_Exported_Functions TS Exported Functions
00175   * @{
00176   */
00177 uint8_t BSP_TS_Init(uint16_t ts_SizeX, uint16_t ts_SizeY);
00178 uint8_t BSP_TS_InitEx(uint16_t ts_SizeX, uint16_t ts_SizeY, uint8_t  orientation);
00179 uint8_t BSP_TS_GetState(TS_StateTypeDef *TS_State);
00180 
00181 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
00182 uint8_t BSP_TS_Get_GestureId(TS_StateTypeDef *TS_State);
00183 uint8_t BSP_TS_ResetTouchData(TS_StateTypeDef *TS_State);
00184 #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */
00185 
00186 uint8_t BSP_TS_ITConfig(void);
00187 
00188 /* These __weak function can be surcharged by application code in case the current settings
00189    need to be changed for specific (example GPIO allocation) */
00190 void BSP_TS_INT_MspInit(void);
00191 
00192 /**
00193   * @}
00194   */
00195 
00196 /**
00197   * @}
00198   */
00199 
00200 /**
00201   * @}
00202   */
00203 
00204 /**
00205   * @}
00206   */
00207 
00208 
00209 #ifdef __cplusplus
00210 }
00211 #endif
00212 
00213 #endif /* __STM32F723E_DISCOVERY_TS_H */
00214 
00215 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/