|
STM32469I_EVAL BSP User Manual
|
stm32469i_eval_io.c
Go to the documentation of this file.
00001 /** 00002 ****************************************************************************** 00003 * @file stm32469i_eval_io.c 00004 * @author MCD Application Team 00005 * @version V1.0.2 00006 * @date 12-January-2016 00007 * @brief This file provides a set of functions needed to manage the IO pins 00008 * on STM32469I-EVAL evaluation board. 00009 ****************************************************************************** 00010 * @attention 00011 * 00012 * <h2><center>© 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 /* File Info : ----------------------------------------------------------------- 00040 User NOTES 00041 1. How To use this driver: 00042 -------------------------- 00043 - This driver is used to drive the IO module of the STM32469I-EVAL evaluation 00044 board. 00045 - The MFXSTM32L152 IO expander device component driver must be included with this 00046 driver in order to run the IO functionalities commanded by the IO expander 00047 device mounted on the evaluation board. 00048 00049 2. Driver description: 00050 --------------------- 00051 + Initialization steps: 00052 o Initialize the IO module using the BSP_IO_Init() function. This 00053 function includes the MSP layer hardware resources initialization and the 00054 communication layer configuration to start the IO functionalities use. 00055 00056 + IO functionalities use 00057 o The IO pin mode is configured when calling the function BSP_IO_ConfigPin(), you 00058 must specify the desired IO mode by choosing the "IO_ModeTypedef" parameter 00059 predefined value. 00060 o If an IO pin is used in interrupt mode, the function BSP_IO_ITGetStatus() is 00061 needed to get the interrupt status. To clear the IT pending bits, you should 00062 call the function BSP_IO_ITClearPin() with specifying the IO pending bit to clear. 00063 o The IT is handled using the corresponding external interrupt IRQ handler, 00064 the user IT callback treatment is implemented on the same external interrupt 00065 callback. 00066 o To get/set an IO pin combination state you can use the functions 00067 BSP_IO_ReadPin()/BSP_IO_WritePin() or the function BSP_IO_TogglePin() to toggle the pin 00068 state. 00069 00070 ------------------------------------------------------------------------------*/ 00071 00072 /* Includes ------------------------------------------------------------------*/ 00073 #include "stm32469i_eval_io.h" 00074 00075 /** @addtogroup BSP 00076 * @{ 00077 */ 00078 00079 /** @addtogroup STM32469I_EVAL 00080 * @{ 00081 */ 00082 00083 /** @defgroup STM32469I-EVAL_IO STM32469I EVAL IO 00084 * @{ 00085 */ 00086 00087 /** @defgroup STM32469I-EVAL_IO_Private_Types_Definitions STM32469I EVAL IO Private Types Definitions 00088 * @{ 00089 */ 00090 /** 00091 * @} 00092 */ 00093 00094 /** @defgroup STM32469I-EVAL_IO_Private_Defines STM32469I EVAL IO Private Defines 00095 * @{ 00096 */ 00097 /** 00098 * @} 00099 */ 00100 00101 /** @defgroup STM32469I-EVAL_IO_Private_Macros STM32469I EVAL IO Private Macros 00102 * @{ 00103 */ 00104 /** 00105 * @} 00106 */ 00107 00108 /** @defgroup STM32469I-EVAL_IO_Private_Variables STM32469I EVAL IO Private Variables 00109 * @{ 00110 */ 00111 static IO_DrvTypeDef *IoDrv = NULL; 00112 /** 00113 * @} 00114 */ 00115 00116 /** @defgroup STM32469I-EVAL_IO_Private_Function_Prototypes STM32469I EVAL IO Private Function Prototypes 00117 * @{ 00118 */ 00119 /** 00120 * @} 00121 */ 00122 00123 /** @defgroup STM32469I-EVAL_IO_Private_Functions STM32469I EVAL IO Private Functions 00124 * @{ 00125 */ 00126 00127 /** 00128 * @brief Initializes and configures the IO functionalities and configures all 00129 * necessary hardware resources (GPIOs, clocks..). 00130 * @note BSP_IO_Init() is using HAL_Delay() function to ensure that MFXSTM32L152 00131 * IO Expander is correctly reset. HAL_Delay() function provides accurate 00132 * delay (in milliseconds) based on variable incremented in SysTick ISR. 00133 * This implies that if BSP_IO_Init() is called from a peripheral ISR process, 00134 * then the SysTick interrupt must have higher priority (numerically lower) 00135 * than the peripheral interrupt. Otherwise the caller ISR process will be blocked. 00136 * @retval IO_OK if all initializations are OK. Other value if error. 00137 */ 00138 uint8_t BSP_IO_Init(void) 00139 { 00140 uint8_t ret = IO_ERROR; 00141 uint8_t mfxstm32l152_id = 0; 00142 HAL_Delay(1); 00143 /* Read ID and verify the IO expander is ready */ 00144 mfxstm32l152_id = mfxstm32l152_io_drv.ReadID(IO_I2C_ADDRESS); 00145 if((mfxstm32l152_id == MFXSTM32L152_ID_1) || (mfxstm32l152_id == MFXSTM32L152_ID_2)) 00146 { 00147 /* Initialize the IO driver structure */ 00148 IoDrv = &mfxstm32l152_io_drv; 00149 ret = IO_OK; 00150 } 00151 00152 if(ret == IO_OK) 00153 { 00154 IoDrv->Init(IO_I2C_ADDRESS); 00155 IoDrv->Start(IO_I2C_ADDRESS, IO_PIN_ALL); 00156 } 00157 return ret; 00158 } 00159 00160 /** 00161 * @brief DeInit allows Mfx Inititialization to be executed again 00162 * @note BSP_IO_Init() has no effect if the IoDrv is already initialized 00163 * BSP_IO_DeInit() allows to erase the pointer such to allow init to be effective 00164 * @retval IO_OK 00165 */ 00166 uint8_t BSP_IO_DeInit(void) 00167 { 00168 IoDrv = NULL; 00169 return IO_OK; 00170 } 00171 00172 /** 00173 * @brief Gets the selected pins IT status. 00174 * @param IoPin: Selected pins to check the status. 00175 * This parameter can be any combination of the IO pins. 00176 * @retval IO_OK if read status OK. Other value if error. 00177 */ 00178 uint32_t BSP_IO_ITGetStatus(uint32_t IoPin) 00179 { 00180 /* Return the IO Pin IT status */ 00181 return (IoDrv->ITStatus(IO_I2C_ADDRESS, IoPin)); 00182 } 00183 00184 /** 00185 * @brief Clears all the IO IT pending bits. 00186 */ 00187 void BSP_IO_ITClear(void) 00188 { 00189 /* Clear all IO IT pending bits */ 00190 IoDrv->ClearIT(IO_I2C_ADDRESS, MFXSTM32L152_GPIO_PINS_ALL); 00191 } 00192 00193 /** 00194 * @brief Clear only one or a selection of IO IT pending bits. 00195 * @param IO_Pins_To_Clear : MFX IRQ status IO pin to clear (or combination of several IOs) 00196 */ 00197 void BSP_IO_ITClearPin(uint32_t IO_Pins_To_Clear) 00198 { 00199 /* Clear only the selected list of IO IT pending bits */ 00200 IoDrv->ClearIT(IO_I2C_ADDRESS, IO_Pins_To_Clear); 00201 } 00202 00203 /** 00204 * @brief Configures the IO pin(s) according to IO mode structure value. 00205 * @param IO_Pin: IO pin(s) to be configured. 00206 * This parameter can be one of the following values: 00207 * @arg MFXSTM32L152_GPIO_PIN_x: where x can be from 0 to 23. 00208 * @param IO_Mode: IO pin mode to configure 00209 * This parameter can be one of the following values: 00210 * @arg IO_MODE_INPUT 00211 * @arg IO_MODE_OUTPUT 00212 * @arg IO_MODE_IT_RISING_EDGE 00213 * @arg IO_MODE_IT_FALLING_EDGE 00214 * @arg IO_MODE_IT_LOW_LEVEL 00215 * @arg IO_MODE_IT_HIGH_LEVEL 00216 * @arg IO_MODE_ANALOG 00217 * @arg IO_MODE_OFF 00218 * @arg IO_MODE_INPUT_PU, 00219 * @arg IO_MODE_INPUT_PD, 00220 * @arg IO_MODE_OUTPUT_OD, 00221 * @arg IO_MODE_OUTPUT_OD_PU, 00222 * @arg IO_MODE_OUTPUT_OD_PD, 00223 * @arg IO_MODE_OUTPUT_PP, 00224 * @arg IO_MODE_OUTPUT_PP_PU, 00225 * @arg IO_MODE_OUTPUT_PP_PD, 00226 * @arg IO_MODE_IT_RISING_EDGE_PU 00227 * @arg IO_MODE_IT_FALLING_EDGE_PU 00228 * @arg IO_MODE_IT_LOW_LEVEL_PU 00229 * @arg IO_MODE_IT_HIGH_LEVEL_PU 00230 * @arg IO_MODE_IT_RISING_EDGE_PD 00231 * @arg IO_MODE_IT_FALLING_EDGE_PD 00232 * @arg IO_MODE_IT_LOW_LEVEL_PD 00233 * @arg IO_MODE_IT_HIGH_LEVEL_PD 00234 * @retval IO_OK if all initializations are OK. Other value if error. 00235 */ 00236 uint8_t BSP_IO_ConfigPin(uint32_t IO_Pin, IO_ModeTypedef IO_Mode) 00237 { 00238 /* Configure the selected IO pin(s) mode */ 00239 IoDrv->Config(IO_I2C_ADDRESS, IO_Pin, IO_Mode); 00240 00241 return IO_OK; 00242 } 00243 00244 /** 00245 * @brief Sets the selected pins state. 00246 * @param IO_Pin: Selected pins to write. 00247 * This parameter can be any combination of the IO pins. 00248 * @param PinState: New pins state to write 00249 */ 00250 void BSP_IO_WritePin(uint32_t IO_Pin, BSP_IO_PinStateTypeDef PinState) 00251 { 00252 /* Set the Pin state */ 00253 IoDrv->WritePin(IO_I2C_ADDRESS, IO_Pin, PinState); 00254 } 00255 00256 /** 00257 * @brief Gets the selected pins current state. 00258 * @param IO_Pin: Selected pins to read. 00259 * This parameter can be any combination of the IO pins. 00260 * @retval The current pins state 00261 */ 00262 uint32_t BSP_IO_ReadPin(uint32_t IO_Pin) 00263 { 00264 return(IoDrv->ReadPin(IO_I2C_ADDRESS, IO_Pin)); 00265 } 00266 00267 /** 00268 * @brief Toggles the selected pins state. 00269 * @param IO_Pin: Selected pins to toggle. 00270 * This parameter can be any combination of the IO pins. 00271 * @note This function is only used to toggle one pin in the same time 00272 */ 00273 void BSP_IO_TogglePin(uint32_t IO_Pin) 00274 { 00275 /* Toggle the current pin state */ 00276 if(IoDrv->ReadPin(IO_I2C_ADDRESS, IO_Pin) != 0) /* Set */ 00277 { 00278 IoDrv->WritePin(IO_I2C_ADDRESS, IO_Pin, 0); /* Reset */ 00279 } 00280 else 00281 { 00282 IoDrv->WritePin(IO_I2C_ADDRESS, IO_Pin, 1); /* Set */ 00283 } 00284 } 00285 00286 /** 00287 * @} 00288 */ 00289 00290 /** 00291 * @} 00292 */ 00293 00294 /** 00295 * @} 00296 */ 00297 00298 /** 00299 * @} 00300 */ 00301 00302 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Tue Jan 12 2016 17:51:25 for STM32469I_EVAL BSP User Manual by
1.7.6.1