mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_DISCO_L475VG_IOT01A/TARGET_STM/TARGET_STM32L4/device/stm32l4xx_hal_i2c_ex.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
161:aa5281ff4a02
Release 145 of the mbed library.

Who changed what in which revision?

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