tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_i2c_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_i2c_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of I2C HAL Extended 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 __STM32F3xx_HAL_I2C_EX_H
  40 #define __STM32F3xx_HAL_I2C_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup I2CEx I2C Extended HAL module driver
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /* Exported constants --------------------------------------------------------*/
  59
  60 /** @defgroup I2CEx_Exported_Constants I2C Extended Exported Constants
  61   * @{
  62   */
  63
  64 /** @defgroup I2CEx_Analog_Filter I2C Extended Analog Filter
  65   * @{
  66   */
  67 #define I2C_ANALOGFILTER_ENABLED        ((uint32_t)0x00000000)
  68 #define I2C_ANALOGFILTER_DISABLED       I2C_CR1_ANFOFF
  69
  70 #define IS_I2C_ANALOG_FILTER(FILTER) (((FILTER) == I2C_ANALOGFILTER_ENABLED) || \
  71                                       ((FILTER) == I2C_ANALOGFILTER_DISABLED))
  72 /**
  73   * @}
  74   */
  75
  76 /** @defgroup I2CEx_Digital_Filter I2C Extended Digital Filter
  77   * @{
  78   */
  79 #define IS_I2C_DIGITAL_FILTER(FILTER)   ((FILTER) <= 0x0000000F)
  80 /**
  81   * @}
  82   */
  83
  84 /**
  85   * @}
  86   */
  87
  88 /* Exported macro ------------------------------------------------------------*/
  89 /* Exported functions --------------------------------------------------------*/
  90
  91 /** @addtogroup I2CEx_Exported_Functions I2C Extended Exported Functions
  92   * @{
  93   */
  94
  95 /** @addtogroup I2CEx_Exported_Functions_Group1 Extended features functions
  96   * @{
  97   */
  98
  99 /* Peripheral Control functions  ************************************************/
 100 HAL_StatusTypeDef HAL_I2CEx_AnalogFilter_Config(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
 101 HAL_StatusTypeDef HAL_I2CEx_DigitalFilter_Config(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
 102 HAL_StatusTypeDef HAL_I2CEx_EnableWakeUp (I2C_HandleTypeDef *hi2c);
 103 HAL_StatusTypeDef HAL_I2CEx_DisableWakeUp (I2C_HandleTypeDef *hi2c);
 104
 105 /**
 106   * @}
 107   */
 108
 109 /**
 110   * @}
 111   */
 112
 113 /**
 114   * @}
 115   */
 116
 117 /**
 118   * @}
 119   */
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* __STM32F3xx_HAL_I2C_EX_H */
 126
 127
 128 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/