mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_DISCO_L496AG/TOOLCHAIN_ARM_STD/stm32l4xx_hal_i2c_ex.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /**
AnnaBridge 189:f392fc9709a3 2 ******************************************************************************
AnnaBridge 189:f392fc9709a3 3 * @file stm32l4xx_hal_i2c_ex.h
AnnaBridge 189:f392fc9709a3 4 * @author MCD Application Team
AnnaBridge 189:f392fc9709a3 5 * @brief Header file of I2C HAL Extended module.
AnnaBridge 189:f392fc9709a3 6 ******************************************************************************
AnnaBridge 189:f392fc9709a3 7 * @attention
AnnaBridge 189:f392fc9709a3 8 *
AnnaBridge 189:f392fc9709a3 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 12 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 189:f392fc9709a3 14 * this list of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 189:f392fc9709a3 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 189:f392fc9709a3 17 * and/or other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 189:f392fc9709a3 19 * may be used to endorse or promote products derived from this software
AnnaBridge 189:f392fc9709a3 20 * without specific prior written permission.
AnnaBridge 189:f392fc9709a3 21 *
AnnaBridge 189:f392fc9709a3 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 189:f392fc9709a3 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 189:f392fc9709a3 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 189:f392fc9709a3 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 189:f392fc9709a3 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 189:f392fc9709a3 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 189:f392fc9709a3 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 189:f392fc9709a3 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 189:f392fc9709a3 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 32 *
AnnaBridge 189:f392fc9709a3 33 ******************************************************************************
AnnaBridge 189:f392fc9709a3 34 */
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 189:f392fc9709a3 37 #ifndef __STM32L4xx_HAL_I2C_EX_H
AnnaBridge 189:f392fc9709a3 38 #define __STM32L4xx_HAL_I2C_EX_H
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 41 extern "C" {
AnnaBridge 189:f392fc9709a3 42 #endif
AnnaBridge 189:f392fc9709a3 43
AnnaBridge 189:f392fc9709a3 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 45 #include "stm32l4xx_hal_def.h"
AnnaBridge 189:f392fc9709a3 46
AnnaBridge 189:f392fc9709a3 47 /** @addtogroup STM32L4xx_HAL_Driver
AnnaBridge 189:f392fc9709a3 48 * @{
AnnaBridge 189:f392fc9709a3 49 */
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /** @addtogroup I2CEx
AnnaBridge 189:f392fc9709a3 52 * @{
AnnaBridge 189:f392fc9709a3 53 */
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 56 /* Exported constants --------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 57
AnnaBridge 189:f392fc9709a3 58 /** @defgroup I2CEx_Exported_Constants I2C Extended Exported Constants
AnnaBridge 189:f392fc9709a3 59 * @{
AnnaBridge 189:f392fc9709a3 60 */
AnnaBridge 189:f392fc9709a3 61
AnnaBridge 189:f392fc9709a3 62 /** @defgroup I2CEx_Analog_Filter I2C Extended Analog Filter
AnnaBridge 189:f392fc9709a3 63 * @{
AnnaBridge 189:f392fc9709a3 64 */
AnnaBridge 189:f392fc9709a3 65 #define I2C_ANALOGFILTER_ENABLE 0x00000000U
AnnaBridge 189:f392fc9709a3 66 #define I2C_ANALOGFILTER_DISABLE I2C_CR1_ANFOFF
AnnaBridge 189:f392fc9709a3 67 /**
AnnaBridge 189:f392fc9709a3 68 * @}
AnnaBridge 189:f392fc9709a3 69 */
AnnaBridge 189:f392fc9709a3 70
AnnaBridge 189:f392fc9709a3 71 /** @defgroup I2CEx_FastModePlus I2C Extended Fast Mode Plus
AnnaBridge 189:f392fc9709a3 72 * @{
AnnaBridge 189:f392fc9709a3 73 */
AnnaBridge 189:f392fc9709a3 74 #define I2C_FMP_NOT_SUPPORTED 0xAAAA0000U /*!< Fast Mode Plus not supported */
AnnaBridge 189:f392fc9709a3 75 #define I2C_FASTMODEPLUS_PB6 SYSCFG_CFGR1_I2C_PB6_FMP /*!< Enable Fast Mode Plus on PB6 */
AnnaBridge 189:f392fc9709a3 76 #define I2C_FASTMODEPLUS_PB7 SYSCFG_CFGR1_I2C_PB7_FMP /*!< Enable Fast Mode Plus on PB7 */
AnnaBridge 189:f392fc9709a3 77 #if defined(SYSCFG_CFGR1_I2C_PB8_FMP)
AnnaBridge 189:f392fc9709a3 78 #define I2C_FASTMODEPLUS_PB8 SYSCFG_CFGR1_I2C_PB8_FMP /*!< Enable Fast Mode Plus on PB8 */
AnnaBridge 189:f392fc9709a3 79 #define I2C_FASTMODEPLUS_PB9 SYSCFG_CFGR1_I2C_PB9_FMP /*!< Enable Fast Mode Plus on PB9 */
AnnaBridge 189:f392fc9709a3 80 #else
AnnaBridge 189:f392fc9709a3 81 #define I2C_FASTMODEPLUS_PB8 (uint32_t)(0x00000010U | I2C_FMP_NOT_SUPPORTED) /*!< Fast Mode Plus PB8 not supported */
AnnaBridge 189:f392fc9709a3 82 #define I2C_FASTMODEPLUS_PB9 (uint32_t)(0x00000012U | I2C_FMP_NOT_SUPPORTED) /*!< Fast Mode Plus PB9 not supported */
AnnaBridge 189:f392fc9709a3 83 #endif
AnnaBridge 189:f392fc9709a3 84 #define I2C_FASTMODEPLUS_I2C1 SYSCFG_CFGR1_I2C1_FMP /*!< Enable Fast Mode Plus on I2C1 pins */
AnnaBridge 189:f392fc9709a3 85 #if defined(SYSCFG_CFGR1_I2C2_FMP)
AnnaBridge 189:f392fc9709a3 86 #define I2C_FASTMODEPLUS_I2C2 SYSCFG_CFGR1_I2C2_FMP /*!< Enable Fast Mode Plus on I2C2 pins */
AnnaBridge 189:f392fc9709a3 87 #else
AnnaBridge 189:f392fc9709a3 88 #define I2C_FASTMODEPLUS_I2C2 (uint32_t)(0x00000200U | I2C_FMP_NOT_SUPPORTED) /*!< Fast Mode Plus I2C2 not supported */
AnnaBridge 189:f392fc9709a3 89 #endif
AnnaBridge 189:f392fc9709a3 90 #define I2C_FASTMODEPLUS_I2C3 SYSCFG_CFGR1_I2C3_FMP /*!< Enable Fast Mode Plus on I2C3 pins */
AnnaBridge 189:f392fc9709a3 91 #if defined(SYSCFG_CFGR1_I2C4_FMP)
AnnaBridge 189:f392fc9709a3 92 #define I2C_FASTMODEPLUS_I2C4 SYSCFG_CFGR1_I2C4_FMP /*!< Enable Fast Mode Plus on I2C4 pins */
AnnaBridge 189:f392fc9709a3 93 #else
AnnaBridge 189:f392fc9709a3 94 #define I2C_FASTMODEPLUS_I2C4 (uint32_t)(0x00000800U | I2C_FMP_NOT_SUPPORTED) /*!< Fast Mode Plus I2C4 not supported */
AnnaBridge 189:f392fc9709a3 95 #endif
AnnaBridge 189:f392fc9709a3 96 /**
AnnaBridge 189:f392fc9709a3 97 * @}
AnnaBridge 189:f392fc9709a3 98 */
AnnaBridge 189:f392fc9709a3 99
AnnaBridge 189:f392fc9709a3 100 /**
AnnaBridge 189:f392fc9709a3 101 * @}
AnnaBridge 189:f392fc9709a3 102 */
AnnaBridge 189:f392fc9709a3 103
AnnaBridge 189:f392fc9709a3 104 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 105 /* Exported functions --------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 106
AnnaBridge 189:f392fc9709a3 107 /** @addtogroup I2CEx_Exported_Functions I2C Extended Exported Functions
AnnaBridge 189:f392fc9709a3 108 * @{
AnnaBridge 189:f392fc9709a3 109 */
AnnaBridge 189:f392fc9709a3 110
AnnaBridge 189:f392fc9709a3 111 /** @addtogroup I2CEx_Exported_Functions_Group1 Extended features functions
AnnaBridge 189:f392fc9709a3 112 * @brief Extended features functions
AnnaBridge 189:f392fc9709a3 113 * @{
AnnaBridge 189:f392fc9709a3 114 */
AnnaBridge 189:f392fc9709a3 115
AnnaBridge 189:f392fc9709a3 116 /* Peripheral Control functions ************************************************/
AnnaBridge 189:f392fc9709a3 117 HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
AnnaBridge 189:f392fc9709a3 118 HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
AnnaBridge 189:f392fc9709a3 119 HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 120 HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 121 void HAL_I2CEx_EnableFastModePlus(uint32_t ConfigFastModePlus);
AnnaBridge 189:f392fc9709a3 122 void HAL_I2CEx_DisableFastModePlus(uint32_t ConfigFastModePlus);
AnnaBridge 189:f392fc9709a3 123
AnnaBridge 189:f392fc9709a3 124 /* Private constants ---------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 125 /** @defgroup I2CEx_Private_Constants I2C Extended Private Constants
AnnaBridge 189:f392fc9709a3 126 * @{
AnnaBridge 189:f392fc9709a3 127 */
AnnaBridge 189:f392fc9709a3 128
AnnaBridge 189:f392fc9709a3 129 /**
AnnaBridge 189:f392fc9709a3 130 * @}
AnnaBridge 189:f392fc9709a3 131 */
AnnaBridge 189:f392fc9709a3 132
AnnaBridge 189:f392fc9709a3 133 /* Private macros ------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 134 /** @defgroup I2CEx_Private_Macro I2C Extended Private Macros
AnnaBridge 189:f392fc9709a3 135 * @{
AnnaBridge 189:f392fc9709a3 136 */
AnnaBridge 189:f392fc9709a3 137 #define IS_I2C_ANALOG_FILTER(FILTER) (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
AnnaBridge 189:f392fc9709a3 138 ((FILTER) == I2C_ANALOGFILTER_DISABLE))
AnnaBridge 189:f392fc9709a3 139
AnnaBridge 189:f392fc9709a3 140 #define IS_I2C_DIGITAL_FILTER(FILTER) ((FILTER) <= 0x0000000FU)
AnnaBridge 189:f392fc9709a3 141
AnnaBridge 189:f392fc9709a3 142 #define IS_I2C_FASTMODEPLUS(__CONFIG__) ((((__CONFIG__) & I2C_FMP_NOT_SUPPORTED) != I2C_FMP_NOT_SUPPORTED) && \
AnnaBridge 189:f392fc9709a3 143 ((((__CONFIG__) & (I2C_FASTMODEPLUS_PB6)) == I2C_FASTMODEPLUS_PB6) || \
AnnaBridge 189:f392fc9709a3 144 (((__CONFIG__) & (I2C_FASTMODEPLUS_PB7)) == I2C_FASTMODEPLUS_PB7) || \
AnnaBridge 189:f392fc9709a3 145 (((__CONFIG__) & (I2C_FASTMODEPLUS_PB8)) == I2C_FASTMODEPLUS_PB8) || \
AnnaBridge 189:f392fc9709a3 146 (((__CONFIG__) & (I2C_FASTMODEPLUS_PB9)) == I2C_FASTMODEPLUS_PB9) || \
AnnaBridge 189:f392fc9709a3 147 (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C1)) == I2C_FASTMODEPLUS_I2C1) || \
AnnaBridge 189:f392fc9709a3 148 (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C2)) == I2C_FASTMODEPLUS_I2C2) || \
AnnaBridge 189:f392fc9709a3 149 (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C3)) == I2C_FASTMODEPLUS_I2C3) || \
AnnaBridge 189:f392fc9709a3 150 (((__CONFIG__) & (I2C_FASTMODEPLUS_I2C4)) == I2C_FASTMODEPLUS_I2C4)))
AnnaBridge 189:f392fc9709a3 151 /**
AnnaBridge 189:f392fc9709a3 152 * @}
AnnaBridge 189:f392fc9709a3 153 */
AnnaBridge 189:f392fc9709a3 154
AnnaBridge 189:f392fc9709a3 155 /* Private Functions ---------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 156 /** @defgroup I2CEx_Private_Functions I2C Extended Private Functions
AnnaBridge 189:f392fc9709a3 157 * @{
AnnaBridge 189:f392fc9709a3 158 */
AnnaBridge 189:f392fc9709a3 159 /* Private functions are defined in stm32l4xx_hal_i2c_ex.c file */
AnnaBridge 189:f392fc9709a3 160 /**
AnnaBridge 189:f392fc9709a3 161 * @}
AnnaBridge 189:f392fc9709a3 162 */
AnnaBridge 189:f392fc9709a3 163
AnnaBridge 189:f392fc9709a3 164 /**
AnnaBridge 189:f392fc9709a3 165 * @}
AnnaBridge 189:f392fc9709a3 166 */
AnnaBridge 189:f392fc9709a3 167
AnnaBridge 189:f392fc9709a3 168 /**
AnnaBridge 189:f392fc9709a3 169 * @}
AnnaBridge 189:f392fc9709a3 170 */
AnnaBridge 189:f392fc9709a3 171
AnnaBridge 189:f392fc9709a3 172 /**
AnnaBridge 189:f392fc9709a3 173 * @}
AnnaBridge 189:f392fc9709a3 174 */
AnnaBridge 189:f392fc9709a3 175
AnnaBridge 189:f392fc9709a3 176 /**
AnnaBridge 189:f392fc9709a3 177 * @}
AnnaBridge 189:f392fc9709a3 178 */
AnnaBridge 189:f392fc9709a3 179
AnnaBridge 189:f392fc9709a3 180 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 181 }
AnnaBridge 189:f392fc9709a3 182 #endif
AnnaBridge 189:f392fc9709a3 183
AnnaBridge 189:f392fc9709a3 184 #endif /* __STM32L4xx_HAL_I2C_EX_H */
AnnaBridge 189:f392fc9709a3 185
AnnaBridge 189:f392fc9709a3 186 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/