tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_i2c_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f4xx_hal_i2c_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    19-June-2014
   7   * @brief   Header file of I2C HAL Extension module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F4xx_HAL_I2C_EX_H
  40 #define __STM32F4xx_HAL_I2C_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
  47     defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE)
  48 /* Includes ------------------------------------------------------------------*/
  49 #include "stm32f4xx_hal_def.h"
  50
  51 /** @addtogroup STM32F4xx_HAL_Driver
  52   * @{
  53   */
  54
  55 /** @addtogroup I2CEx
  56   * @{
  57   */
  58
  59 /* Exported types ------------------------------------------------------------*/
  60 /* Exported constants --------------------------------------------------------*/
  61
  62 /** @defgroup I2CEx_Exported_Constants
  63   * @{
  64   */
  65
  66 /** @defgroup I2CEx_Analog_Filter
  67   * @{
  68   */
  69 #define I2C_ANALOGFILTER_ENABLED        ((uint32_t)0x00000000)
  70 #define I2C_ANALOGFILTER_DISABLED       I2C_FLTR_ANOFF
  71
  72 #define IS_I2C_ANALOG_FILTER(FILTER) (((FILTER) == I2C_ANALOGFILTER_ENABLED) || \
  73                                       ((FILTER) == I2C_ANALOGFILTER_DISABLED))
  74 /**
  75   * @}
  76   */
  77
  78 /** @defgroup I2CEx_Digital_Filter
  79   * @{
  80   */
  81 #define IS_I2C_DIGITAL_FILTER(FILTER)   ((FILTER) <= 0x0000000F)
  82 /**
  83   * @}
  84   */
  85
  86 /**
  87   * @}
  88   */
  89
  90 /* Exported macro ------------------------------------------------------------*/
  91 /* Exported functions --------------------------------------------------------*/
  92
  93 /* Peripheral Control functions  ************************************************/
  94 HAL_StatusTypeDef HAL_I2CEx_AnalogFilter_Config(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
  95 HAL_StatusTypeDef HAL_I2CEx_DigitalFilter_Config(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
  96
  97 /**
  98   * @}
  99   */
 100 #endif /* STM32F427xx || STM32F429xx || STM32F437xx || STM32F439xx || STM32F401xC || STM32F401xE */
 101 /**
 102   * @}
 103   */
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif /* __STM32F4xx_HAL_I2C_EX_H */
 110
 111
 112 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/