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

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f429i_discovery_io.h
00004   * @author  MCD Application Team
00005   * @version V2.1.5
00006   * @date    27-January-2017
00007   * @brief   This file contains all the functions prototypes for the
00008   *          stm32f429i_discovery_io.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2017 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_IO_H
00041 #define __STM32F429I_DISCOVERY_IO_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32f429i_discovery.h"
00049 /* Include IO 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_IO
00061   * @{
00062   */
00063 
00064 /** @defgroup STM32F429I_DISCOVERY_IO_Exported_Types STM32F429I DISCOVERY IO Exported Types
00065   * @{
00066   */
00067 typedef enum 
00068 {
00069   IO_OK       = 0,
00070   IO_ERROR    = 1,
00071   IO_TIMEOUT  = 2
00072 }IO_StatusTypeDef;
00073 /**
00074   * @}
00075   */  
00076 
00077 /** @defgroup STM32F429I_DISCOVERY_IO_Exported_Constants STM32F429I DISCOVERY IO Exported Constants
00078   * @{
00079   */
00080 #define IO_PIN_0                     0x01
00081 #define IO_PIN_1                     0x02
00082 #define IO_PIN_2                     0x04
00083 #define IO_PIN_3                     0x08
00084 #define IO_PIN_4                     0x10
00085 #define IO_PIN_5                     0x20
00086 #define IO_PIN_6                     0x40
00087 #define IO_PIN_7                     0x80
00088 #define IO_PIN_ALL                   0xFF
00089 /**
00090   * @}
00091   */  
00092 
00093 /** @defgroup STM32F429I_DISCOVERY_IO_Exported_Macros STM32F429I DISCOVERY IO Exported Macros
00094   * @{
00095   */
00096 /**
00097   * @}
00098   */  
00099 
00100 /** @defgroup STM32F429I_DISCOVERY_IO_Exported_Functions STM32F429I DISCOVERY IO Exported Functions
00101   * @{
00102   */
00103 uint8_t  BSP_IO_Init(void);
00104 uint8_t  BSP_IO_ITGetStatus(uint16_t IoPin);
00105 void     BSP_IO_ITClear(void);
00106 void     BSP_IO_ConfigPin(uint16_t IoPin, IO_ModeTypedef IoMode);
00107 void     BSP_IO_WritePin(uint16_t IoPin, uint8_t PinState);
00108 uint16_t BSP_IO_ReadPin(uint16_t IoPin);
00109 void     BSP_IO_TogglePin(uint16_t IoPin);
00110   
00111 /**
00112   * @}
00113   */ 
00114 
00115 /**
00116   * @}
00117   */
00118 
00119 /**
00120   * @}
00121   */ 
00122 
00123 /**
00124   * @}
00125   */
00126 
00127 #ifdef __cplusplus
00128 }
00129 #endif
00130 
00131 #endif /* __STM32F429I_DISCOVERY_IO_H */
00132 
00133 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/