STM32L4R9I-Discovery BSP User Manual: stm32l4r9i_discovery_io.h Source File

STM32L4R9I-Discovery BSP

stm32l4r9i_discovery_io.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32l4r9i_discovery_io.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32l4r9i_discovery_io.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 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 __STM32L4R9I_DISCO_IO_H
00039 #define __STM32L4R9I_DISCO_IO_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include "stm32l4r9i_discovery.h"
00047 #include "../Components/mfxstm32l152/mfxstm32l152.h"
00048 
00049 /** @addtogroup BSP
00050   * @{
00051   */
00052 
00053 /** @addtogroup STM32L4R9I_DISCOVERY
00054   * @{
00055   */
00056 
00057 /** @addtogroup STM32L4R9I_DISCOVERY_IO
00058   * @{
00059   */
00060 
00061 /* Exported types ------------------------------------------------------------*/
00062 
00063 /** @defgroup STM32L4R9I_DISCOVERY_IO_Exported_Types Exported Types
00064   * @{
00065   */
00066 typedef enum
00067 {
00068   IO_OK       = 0x00,
00069   IO_ERROR    = 0x01,
00070   IO_TIMEOUT  = 0x02
00071 }IO_StatusTypeDef;
00072 /**
00073   * @}
00074   */
00075 
00076 /** @defgroup STM32L4R9I_DISCOVERY_IO_Exported_Constants Exported Constants
00077   * @{
00078   */
00079 #define IO_PIN_0                  ((uint32_t)0x00000001)
00080 #define IO_PIN_1                  ((uint32_t)0x00000002)
00081 #define IO_PIN_2                  ((uint32_t)0x00000004)
00082 #define IO_PIN_3                  ((uint32_t)0x00000008)
00083 #define IO_PIN_4                  ((uint32_t)0x00000010)
00084 #define IO_PIN_5                  ((uint32_t)0x00000020)
00085 #define IO_PIN_6                  ((uint32_t)0x00000040)
00086 #define IO_PIN_7                  ((uint32_t)0x00000080)
00087 #define IO_PIN_8                  ((uint32_t)0x00000100)
00088 #define IO_PIN_9                  ((uint32_t)0x00000200)
00089 #define IO_PIN_10                 ((uint32_t)0x00000400)
00090 #define IO_PIN_11                 ((uint32_t)0x00000800)
00091 #define IO_PIN_12                 ((uint32_t)0x00001000)
00092 #define IO_PIN_13                 ((uint32_t)0x00002000)
00093 #define IO_PIN_14                 ((uint32_t)0x00004000)
00094 #define IO_PIN_15                 ((uint32_t)0x00008000)
00095 #define AGPIO_PIN_0               ((uint32_t)0x00010000)
00096 #define AGPIO_PIN_1               ((uint32_t)0x00020000)
00097 #define AGPIO_PIN_2               ((uint32_t)0x00040000)
00098 #define IO_PIN_ALL                ((uint32_t)0x0003FFFF)
00099 /**
00100   * @}
00101   */
00102 
00103 /* Exported functions --------------------------------------------------------*/
00104 
00105 /** @defgroup STM32L4R9I_DISCOVERY_IO_Exported_Functions Exported Functions
00106   * @{
00107   */
00108 
00109 uint8_t  BSP_IO_Init(void);
00110 uint8_t  BSP_IO_DeInit(void);
00111 uint32_t BSP_IO_ITGetStatus(uint32_t IO_Pin);
00112 void     BSP_IO_ITClear(uint32_t IO_Pin);
00113 uint8_t  BSP_IO_ConfigPin(uint32_t IO_Pin, IO_ModeTypedef IO_Mode);
00114 void     BSP_IO_WritePin(uint32_t IO_Pin, uint8_t PinState);
00115 uint32_t BSP_IO_ReadPin(uint32_t IO_Pin);
00116 void     BSP_IO_TogglePin(uint32_t IO_Pin);
00117 
00118 /**
00119   * @}
00120   */
00121 
00122 /**
00123   * @}
00124   */
00125 
00126 /**
00127   * @}
00128   */
00129 
00130 /**
00131   * @}
00132   */
00133 
00134 #ifdef __cplusplus
00135 }
00136 #endif
00137 
00138 #endif /* __STM32L4R9I_DISCOVERY_IO_H */
00139 
00140 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Fri Oct 13 2017 02:37:42 for STM32L4R9I-Discovery BSP User Manual by   doxygen 1.7.6.1