STM32L4R9I_EVAL BSP User Manual: stm32l4r9i_eval_rgb_ts.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4r9i_eval_rgb_ts.h
00004   * @brief   This file contains the common defines and functions prototypes for
00005   *          the stm32l4r9i_eval_rgb_ts.c driver.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00010   *
00011   * Redistribution and use in source and binary forms, with or without modification,
00012   * are permitted provided that the following conditions are met:
00013   *   1. Redistributions of source code must retain the above copyright notice,
00014   *      this list of conditions and the following disclaimer.
00015   *   2. Redistributions in binary form must reproduce the above copyright notice,
00016   *      this list of conditions and the following disclaimer in the documentation
00017   *      and/or other materials provided with the distribution.
00018   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00019   *      may be used to endorse or promote products derived from this software
00020   *      without specific prior written permission.
00021   *
00022   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00023   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00025   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00026   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00027   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00028   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00030   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00031   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032   *
00033   ******************************************************************************
00034   */
00035 
00036 /* Define to prevent recursive inclusion -------------------------------------*/
00037 #ifndef __STM32L4R9I_EVAL_RGB_TS_H
00038 #define __STM32L4R9I_EVAL_RGB_TS_H
00039 
00040 #ifdef __cplusplus
00041  extern "C" {
00042 #endif
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 #include "stm32l4r9i_eval.h"
00046 /* Include touch screen FT5336 component Driver */
00047 #include "../Components/ft5336/ft5336.h"
00048 
00049 /** @addtogroup BSP
00050   * @{
00051   */
00052 
00053 /** @addtogroup STM32L4R9I_EVAL
00054   * @{
00055   */
00056 
00057 /** @defgroup STM32L4R9I_EVAL_TS STM32L4R9I_EVAL TS
00058   * @{
00059   */
00060 
00061 /** @defgroup STM32L4R9I_EVAL_RGB_TS STM32L4R9I_EVAL RGB TS
00062   * @{
00063   */
00064 
00065 /** @defgroup STM32L4R9I_EVAL_RGB_TS_Imported_Variables Imported Variables
00066   * @{
00067   */
00068 /**
00069  *  @brief Table for touchscreen event information display on LCD :
00070  *  table indexed on enum @ref TS_TouchEventTypeDef information
00071  */
00072 extern char * ts_event_string_tab[TOUCH_EVENT_NB_MAX];
00073 
00074 /**
00075  *  @brief Table for touchscreen gesture Id information display on LCD : table indexed
00076  *  on enum @ref TS_GestureIdTypeDef information
00077  */
00078 extern char * ts_gesture_id_string_tab[GEST_ID_NB_MAX];
00079 /**
00080   * @}
00081   */
00082 
00083 /** @addtogroup STM32L4R9I_EVAL_RGB_TS_Exported_Functions
00084   * @{
00085   */
00086 uint8_t BSP_RGB_TS_Init(uint16_t ts_SizeX, uint16_t ts_SizeY);
00087 uint8_t BSP_RGB_TS_DeInit(void);
00088 uint8_t BSP_RGB_TS_GetState(TS_StateTypeDef *TS_State);
00089 
00090 #if (TS_MULTI_TOUCH_SUPPORTED == 1)
00091 uint8_t BSP_RGB_TS_Get_GestureId(TS_StateTypeDef *TS_State);
00092 #endif /* TS_MULTI_TOUCH_SUPPORTED == 1 */
00093 
00094 uint8_t BSP_RGB_TS_ITConfig(void);
00095 uint8_t BSP_RGB_TS_ITGetStatus(void);
00096 void    BSP_RGB_TS_ITClear(void);
00097 uint8_t BSP_RGB_TS_ResetTouchData(TS_StateTypeDef *TS_State);
00098 
00099 /**
00100   * @}
00101   */
00102 
00103 /**
00104   * @}
00105   */
00106 
00107 /**
00108   * @}
00109   */
00110 
00111 /**
00112   * @}
00113   */
00114 
00115 /**
00116   * @}
00117   */
00118 
00119 #ifdef __cplusplus
00120 }
00121 #endif
00122 
00123 #endif /* __STM32L4R9I_EVAL_RGB_TS_H */
00124 
00125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/