Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_L476RG/stm32l4xx_hal_i2c_ex.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
107:4f6c30876dfa 
.

Who changed what in which revision?

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