PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_i2c_ex.c@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:e87aa4c49e95 1 /**
phungductung 0:e87aa4c49e95 2 ******************************************************************************
phungductung 0:e87aa4c49e95 3 * @file stm32f7xx_hal_i2c_ex.c
phungductung 0:e87aa4c49e95 4 * @author MCD Application Team
phungductung 0:e87aa4c49e95 5 * @version V1.0.4
phungductung 0:e87aa4c49e95 6 * @date 09-December-2015
phungductung 0:e87aa4c49e95 7 * @brief I2C Extended HAL module driver.
phungductung 0:e87aa4c49e95 8 * This file provides firmware functions to manage the following
phungductung 0:e87aa4c49e95 9 * functionalities of I2C Extended peripheral:
phungductung 0:e87aa4c49e95 10 * + Extended features functions
phungductung 0:e87aa4c49e95 11 *
phungductung 0:e87aa4c49e95 12 @verbatim
phungductung 0:e87aa4c49e95 13 ==============================================================================
phungductung 0:e87aa4c49e95 14 ##### I2C peripheral Extended features #####
phungductung 0:e87aa4c49e95 15 ==============================================================================
phungductung 0:e87aa4c49e95 16
phungductung 0:e87aa4c49e95 17 [..] Comparing to other previous devices, the I2C interface for STM32L4XX
phungductung 0:e87aa4c49e95 18 devices contains the following additional features
phungductung 0:e87aa4c49e95 19
phungductung 0:e87aa4c49e95 20 (+) Possibility to disable or enable Analog Noise Filter
phungductung 0:e87aa4c49e95 21 (+) Use of a configured Digital Noise Filter
phungductung 0:e87aa4c49e95 22 (+) Disable or enable wakeup from Stop mode
phungductung 0:e87aa4c49e95 23
phungductung 0:e87aa4c49e95 24 ##### How to use this driver #####
phungductung 0:e87aa4c49e95 25 ==============================================================================
phungductung 0:e87aa4c49e95 26 [..] This driver provides functions to:
phungductung 0:e87aa4c49e95 27 (#) Configure I2C Analog noise filter using the function HAL_I2CEx_ConfigAnalogFilter()
phungductung 0:e87aa4c49e95 28 (#) Configure I2C Digital noise filter using the function HAL_I2CEx_ConfigDigitalFilter()
phungductung 0:e87aa4c49e95 29 @endverbatim
phungductung 0:e87aa4c49e95 30 ******************************************************************************
phungductung 0:e87aa4c49e95 31 * @attention
phungductung 0:e87aa4c49e95 32 *
phungductung 0:e87aa4c49e95 33 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
phungductung 0:e87aa4c49e95 34 *
phungductung 0:e87aa4c49e95 35 * Redistribution and use in source and binary forms, with or without modification,
phungductung 0:e87aa4c49e95 36 * are permitted provided that the following conditions are met:
phungductung 0:e87aa4c49e95 37 * 1. Redistributions of source code must retain the above copyright notice,
phungductung 0:e87aa4c49e95 38 * this list of conditions and the following disclaimer.
phungductung 0:e87aa4c49e95 39 * 2. Redistributions in binary form must reproduce the above copyright notice,
phungductung 0:e87aa4c49e95 40 * this list of conditions and the following disclaimer in the documentation
phungductung 0:e87aa4c49e95 41 * and/or other materials provided with the distribution.
phungductung 0:e87aa4c49e95 42 * 3. Neither the name of STMicroelectronics nor the names of its contributors
phungductung 0:e87aa4c49e95 43 * may be used to endorse or promote products derived from this software
phungductung 0:e87aa4c49e95 44 * without specific prior written permission.
phungductung 0:e87aa4c49e95 45 *
phungductung 0:e87aa4c49e95 46 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
phungductung 0:e87aa4c49e95 47 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
phungductung 0:e87aa4c49e95 48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
phungductung 0:e87aa4c49e95 49 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
phungductung 0:e87aa4c49e95 50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
phungductung 0:e87aa4c49e95 51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
phungductung 0:e87aa4c49e95 52 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
phungductung 0:e87aa4c49e95 53 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
phungductung 0:e87aa4c49e95 54 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
phungductung 0:e87aa4c49e95 55 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
phungductung 0:e87aa4c49e95 56 *
phungductung 0:e87aa4c49e95 57 ******************************************************************************
phungductung 0:e87aa4c49e95 58 */
phungductung 0:e87aa4c49e95 59
phungductung 0:e87aa4c49e95 60 /* Includes ------------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 61 #include "stm32f7xx_hal.h"
phungductung 0:e87aa4c49e95 62
phungductung 0:e87aa4c49e95 63 /** @addtogroup STM32F7xx_HAL_Driver
phungductung 0:e87aa4c49e95 64 * @{
phungductung 0:e87aa4c49e95 65 */
phungductung 0:e87aa4c49e95 66
phungductung 0:e87aa4c49e95 67 /** @defgroup I2CEx I2C Extended HAL module driver
phungductung 0:e87aa4c49e95 68 * @brief I2C Extended HAL module driver
phungductung 0:e87aa4c49e95 69 * @{
phungductung 0:e87aa4c49e95 70 */
phungductung 0:e87aa4c49e95 71
phungductung 0:e87aa4c49e95 72 #ifdef HAL_I2C_MODULE_ENABLED
phungductung 0:e87aa4c49e95 73
phungductung 0:e87aa4c49e95 74 /* Private typedef -----------------------------------------------------------*/
phungductung 0:e87aa4c49e95 75 /* Private define ------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 76 /* Private macro -------------------------------------------------------------*/
phungductung 0:e87aa4c49e95 77 /* Private variables ---------------------------------------------------------*/
phungductung 0:e87aa4c49e95 78 /* Private function prototypes -----------------------------------------------*/
phungductung 0:e87aa4c49e95 79 /* Private functions ---------------------------------------------------------*/
phungductung 0:e87aa4c49e95 80
phungductung 0:e87aa4c49e95 81 /** @defgroup I2CEx_Exported_Functions I2C Extended Exported Functions
phungductung 0:e87aa4c49e95 82 * @{
phungductung 0:e87aa4c49e95 83 */
phungductung 0:e87aa4c49e95 84
phungductung 0:e87aa4c49e95 85 /** @defgroup I2CEx_Exported_Functions_Group1 Extended features functions
phungductung 0:e87aa4c49e95 86 * @brief Extended features functions
phungductung 0:e87aa4c49e95 87 *
phungductung 0:e87aa4c49e95 88 @verbatim
phungductung 0:e87aa4c49e95 89 ===============================================================================
phungductung 0:e87aa4c49e95 90 ##### Extended features functions #####
phungductung 0:e87aa4c49e95 91 ===============================================================================
phungductung 0:e87aa4c49e95 92 [..] This section provides functions allowing to:
phungductung 0:e87aa4c49e95 93 (+) Configure Noise Filters
phungductung 0:e87aa4c49e95 94
phungductung 0:e87aa4c49e95 95 @endverbatim
phungductung 0:e87aa4c49e95 96 * @{
phungductung 0:e87aa4c49e95 97 */
phungductung 0:e87aa4c49e95 98
phungductung 0:e87aa4c49e95 99 /**
phungductung 0:e87aa4c49e95 100 * @brief Configures I2C Analog noise filter.
phungductung 0:e87aa4c49e95 101 * @param hi2c : pointer to a I2C_HandleTypeDef structure that contains
phungductung 0:e87aa4c49e95 102 * the configuration information for the specified I2Cx peripheral.
phungductung 0:e87aa4c49e95 103 * @param AnalogFilter : new state of the Analog filter.
phungductung 0:e87aa4c49e95 104 * @retval HAL status
phungductung 0:e87aa4c49e95 105 */
phungductung 0:e87aa4c49e95 106 HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter)
phungductung 0:e87aa4c49e95 107 {
phungductung 0:e87aa4c49e95 108 /* Check the parameters */
phungductung 0:e87aa4c49e95 109 assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
phungductung 0:e87aa4c49e95 110 assert_param(IS_I2C_ANALOG_FILTER(AnalogFilter));
phungductung 0:e87aa4c49e95 111
phungductung 0:e87aa4c49e95 112 if((hi2c->State == HAL_I2C_STATE_BUSY) || (hi2c->State == HAL_I2C_STATE_MASTER_BUSY_TX) || (hi2c->State == HAL_I2C_STATE_MASTER_BUSY_RX)
phungductung 0:e87aa4c49e95 113 || (hi2c->State == HAL_I2C_STATE_SLAVE_BUSY_TX) || (hi2c->State == HAL_I2C_STATE_SLAVE_BUSY_RX))
phungductung 0:e87aa4c49e95 114 {
phungductung 0:e87aa4c49e95 115 return HAL_BUSY;
phungductung 0:e87aa4c49e95 116 }
phungductung 0:e87aa4c49e95 117
phungductung 0:e87aa4c49e95 118 /* Process Locked */
phungductung 0:e87aa4c49e95 119 __HAL_LOCK(hi2c);
phungductung 0:e87aa4c49e95 120
phungductung 0:e87aa4c49e95 121 hi2c->State = HAL_I2C_STATE_BUSY;
phungductung 0:e87aa4c49e95 122
phungductung 0:e87aa4c49e95 123 /* Disable the selected I2C peripheral */
phungductung 0:e87aa4c49e95 124 __HAL_I2C_DISABLE(hi2c);
phungductung 0:e87aa4c49e95 125
phungductung 0:e87aa4c49e95 126 /* Reset I2Cx ANOFF bit */
phungductung 0:e87aa4c49e95 127 hi2c->Instance->CR1 &= ~(I2C_CR1_ANFOFF);
phungductung 0:e87aa4c49e95 128
phungductung 0:e87aa4c49e95 129 /* Set analog filter bit*/
phungductung 0:e87aa4c49e95 130 hi2c->Instance->CR1 |= AnalogFilter;
phungductung 0:e87aa4c49e95 131
phungductung 0:e87aa4c49e95 132 __HAL_I2C_ENABLE(hi2c);
phungductung 0:e87aa4c49e95 133
phungductung 0:e87aa4c49e95 134 hi2c->State = HAL_I2C_STATE_READY;
phungductung 0:e87aa4c49e95 135
phungductung 0:e87aa4c49e95 136 /* Process Unlocked */
phungductung 0:e87aa4c49e95 137 __HAL_UNLOCK(hi2c);
phungductung 0:e87aa4c49e95 138
phungductung 0:e87aa4c49e95 139 return HAL_OK;
phungductung 0:e87aa4c49e95 140 }
phungductung 0:e87aa4c49e95 141
phungductung 0:e87aa4c49e95 142 /**
phungductung 0:e87aa4c49e95 143 * @brief Configures I2C Digital noise filter.
phungductung 0:e87aa4c49e95 144 * @param hi2c : pointer to a I2C_HandleTypeDef structure that contains
phungductung 0:e87aa4c49e95 145 * the configuration information for the specified I2Cx peripheral.
phungductung 0:e87aa4c49e95 146 * @param DigitalFilter : Coefficient of digital noise filter between 0x00 and 0x0F.
phungductung 0:e87aa4c49e95 147 * @retval HAL status
phungductung 0:e87aa4c49e95 148 */
phungductung 0:e87aa4c49e95 149 HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter)
phungductung 0:e87aa4c49e95 150 {
phungductung 0:e87aa4c49e95 151 uint32_t tmpreg = 0;
phungductung 0:e87aa4c49e95 152
phungductung 0:e87aa4c49e95 153 /* Check the parameters */
phungductung 0:e87aa4c49e95 154 assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
phungductung 0:e87aa4c49e95 155 assert_param(IS_I2C_DIGITAL_FILTER(DigitalFilter));
phungductung 0:e87aa4c49e95 156
phungductung 0:e87aa4c49e95 157 if((hi2c->State == HAL_I2C_STATE_BUSY) || (hi2c->State == HAL_I2C_STATE_MASTER_BUSY_TX) || (hi2c->State == HAL_I2C_STATE_MASTER_BUSY_RX)
phungductung 0:e87aa4c49e95 158 || (hi2c->State == HAL_I2C_STATE_SLAVE_BUSY_TX) || (hi2c->State == HAL_I2C_STATE_SLAVE_BUSY_RX))
phungductung 0:e87aa4c49e95 159 {
phungductung 0:e87aa4c49e95 160 return HAL_BUSY;
phungductung 0:e87aa4c49e95 161 }
phungductung 0:e87aa4c49e95 162
phungductung 0:e87aa4c49e95 163 /* Process Locked */
phungductung 0:e87aa4c49e95 164 __HAL_LOCK(hi2c);
phungductung 0:e87aa4c49e95 165
phungductung 0:e87aa4c49e95 166 hi2c->State = HAL_I2C_STATE_BUSY;
phungductung 0:e87aa4c49e95 167
phungductung 0:e87aa4c49e95 168 /* Disable the selected I2C peripheral */
phungductung 0:e87aa4c49e95 169 __HAL_I2C_DISABLE(hi2c);
phungductung 0:e87aa4c49e95 170
phungductung 0:e87aa4c49e95 171 /* Get the old register value */
phungductung 0:e87aa4c49e95 172 tmpreg = hi2c->Instance->CR1;
phungductung 0:e87aa4c49e95 173
phungductung 0:e87aa4c49e95 174 /* Reset I2Cx DNF bits [11:8] */
phungductung 0:e87aa4c49e95 175 tmpreg &= ~(I2C_CR1_DNF);
phungductung 0:e87aa4c49e95 176
phungductung 0:e87aa4c49e95 177 /* Set I2Cx DNF coefficient */
phungductung 0:e87aa4c49e95 178 tmpreg |= DigitalFilter << 8;
phungductung 0:e87aa4c49e95 179
phungductung 0:e87aa4c49e95 180 /* Store the new register value */
phungductung 0:e87aa4c49e95 181 hi2c->Instance->CR1 = tmpreg;
phungductung 0:e87aa4c49e95 182
phungductung 0:e87aa4c49e95 183 __HAL_I2C_ENABLE(hi2c);
phungductung 0:e87aa4c49e95 184
phungductung 0:e87aa4c49e95 185 hi2c->State = HAL_I2C_STATE_READY;
phungductung 0:e87aa4c49e95 186
phungductung 0:e87aa4c49e95 187 /* Process Unlocked */
phungductung 0:e87aa4c49e95 188 __HAL_UNLOCK(hi2c);
phungductung 0:e87aa4c49e95 189
phungductung 0:e87aa4c49e95 190 return HAL_OK;
phungductung 0:e87aa4c49e95 191 }
phungductung 0:e87aa4c49e95 192
phungductung 0:e87aa4c49e95 193 /**
phungductung 0:e87aa4c49e95 194 * @}
phungductung 0:e87aa4c49e95 195 */
phungductung 0:e87aa4c49e95 196
phungductung 0:e87aa4c49e95 197 /**
phungductung 0:e87aa4c49e95 198 * @}
phungductung 0:e87aa4c49e95 199 */
phungductung 0:e87aa4c49e95 200
phungductung 0:e87aa4c49e95 201 #endif /* HAL_I2C_MODULE_ENABLED */
phungductung 0:e87aa4c49e95 202 /**
phungductung 0:e87aa4c49e95 203 * @}
phungductung 0:e87aa4c49e95 204 */
phungductung 0:e87aa4c49e95 205
phungductung 0:e87aa4c49e95 206 /**
phungductung 0:e87aa4c49e95 207 * @}
phungductung 0:e87aa4c49e95 208 */
phungductung 0:e87aa4c49e95 209
phungductung 0:e87aa4c49e95 210 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/