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_L072CZ_LRWAN1/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_i2c_ex.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Child:
167:84c0a372a020
Release 143 of the mbed library.

Who changed what in which revision?

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