STM32F429I-Discovery BSP User Manual: stm32f429i_discovery_ts.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f429i_discovery_ts.h
00004   * @author  MCD Application Team
00005   * @version V2.1.3
00006   * @date    13-January-2016
00007   * @brief   This file contains all the functions prototypes for the
00008   *          stm32f429i_discovery_ts.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */ 
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32F429I_DISCOVERY_TS_H
00041 #define __STM32F429I_DISCOVERY_TS_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif   
00046    
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32f429i_discovery.h"
00049 /* Include TouchScreen component driver */
00050 #include "../Components/stmpe811/stmpe811.h"   
00051    
00052 /** @addtogroup BSP
00053   * @{
00054   */
00055 
00056 /** @addtogroup STM32F429I_DISCOVERY
00057   * @{
00058   */ 
00059 
00060 /** @addtogroup STM32F429I_DISCOVERY_TS
00061   * @{
00062   */
00063 
00064 /** @defgroup STM32F429I_DISCOVERY_TS_Exported_Types STM32F429I DISCOVERY TS Exported Types
00065   * @{
00066   */ 
00067 typedef struct
00068 {
00069   uint16_t TouchDetected;
00070   uint16_t X;
00071   uint16_t Y;
00072   uint16_t Z;
00073 }TS_StateTypeDef;
00074 /**
00075   * @}
00076   */
00077 
00078 /** @defgroup STM32F429I_DISCOVERY_TS_Exported_Constants STM32F429I DISCOVERY TS Exported Constants
00079   * @{
00080   */ 
00081 #define TS_SWAP_NONE                    0x00
00082 #define TS_SWAP_X                       0x01
00083 #define TS_SWAP_Y                       0x02
00084 #define TS_SWAP_XY                      0x04
00085 
00086 typedef enum 
00087 {
00088   TS_OK       = 0x00,
00089   TS_ERROR    = 0x01,
00090   TS_TIMEOUT  = 0x02
00091 }TS_StatusTypeDef;
00092 /**
00093   * @}
00094   */
00095 
00096 /** @defgroup STM32F429I_DISCOVERY_TS_Exported_Macros STM32F429I DISCOVERY TS Exported Macros
00097   * @{
00098   */
00099 /**
00100   * @}
00101   */
00102 
00103 /** @defgroup STM32F429I_DISCOVERY_TS_Exported_Functions STM32F429I DISCOVERY TS Exported Functions
00104   * @{
00105   */
00106 uint8_t BSP_TS_Init(uint16_t XSize, uint16_t YSize);
00107 void    BSP_TS_GetState(TS_StateTypeDef *TsState);
00108 uint8_t BSP_TS_ITConfig(void);
00109 uint8_t BSP_TS_ITGetStatus(void);
00110 void    BSP_TS_ITClear(void);
00111 
00112 /**
00113   * @}
00114   */ 
00115 
00116 /**
00117   * @}
00118   */
00119 
00120 /**
00121   * @}
00122   */ 
00123 
00124 /**
00125   * @}
00126   */
00127 
00128 #ifdef __cplusplus
00129 }
00130 #endif
00131 
00132 #endif /* __STM32F429I_DISCOVERY_TS_H */
00133 
00134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/