stm32f4xx_hal_i2c_ex.h 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_i2c_ex.h
  4. * @author MCD Application Team
  5. * @version V1.3.0
  6. * @date 09-March-2015
  7. * @brief Header file of I2C HAL Extension module.
  8. ******************************************************************************
  9. * @attention
  10. *
  11. * <h2><center>&copy; COPYRIGHT(c) 2015 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. /* Define to prevent recursive inclusion -------------------------------------*/
  38. #ifndef __STM32F4xx_HAL_I2C_EX_H
  39. #define __STM32F4xx_HAL_I2C_EX_H
  40. #ifdef __cplusplus
  41. extern "C" {
  42. #endif
  43. #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
  44. defined(STM32F401xC) || defined(STM32F401xE) || defined(STM32F411xE) || defined(STM32F446xx)
  45. /* Includes ------------------------------------------------------------------*/
  46. #include "stm32f4xx_hal_def.h"
  47. /** @addtogroup STM32F4xx_HAL_Driver
  48. * @{
  49. */
  50. /** @addtogroup I2CEx
  51. * @{
  52. */
  53. /* Exported types ------------------------------------------------------------*/
  54. /* Exported constants --------------------------------------------------------*/
  55. /** @defgroup I2CEx_Exported_Constants I2C Exported Constants
  56. * @{
  57. */
  58. /** @defgroup I2CEx_Analog_Filter I2C Analog Filter
  59. * @{
  60. */
  61. #define I2C_ANALOGFILTER_ENABLE ((uint32_t)0x00000000)
  62. #define I2C_ANALOGFILTER_DISABLE I2C_FLTR_ANOFF
  63. /**
  64. * @}
  65. */
  66. /**
  67. * @}
  68. */
  69. /* Exported macro ------------------------------------------------------------*/
  70. /* Exported functions --------------------------------------------------------*/
  71. /** @addtogroup I2CEx_Exported_Functions
  72. * @{
  73. */
  74. /** @addtogroup I2CEx_Exported_Functions_Group1
  75. * @{
  76. */
  77. /* Peripheral Control functions ************************************************/
  78. HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter);
  79. HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter);
  80. /**
  81. * @}
  82. */
  83. /**
  84. * @}
  85. */
  86. /* Private types -------------------------------------------------------------*/
  87. /* Private variables ---------------------------------------------------------*/
  88. /* Private constants ---------------------------------------------------------*/
  89. /** @defgroup I2CEx_Private_Constants I2C Private Constants
  90. * @{
  91. */
  92. /**
  93. * @}
  94. */
  95. /* Private macros ------------------------------------------------------------*/
  96. /** @defgroup I2CEx_Private_Macros I2C Private Macros
  97. * @{
  98. */
  99. #define IS_I2C_ANALOG_FILTER(FILTER) (((FILTER) == I2C_ANALOGFILTER_ENABLE) || \
  100. ((FILTER) == I2C_ANALOGFILTER_DISABLE))
  101. #define IS_I2C_DIGITAL_FILTER(FILTER) ((FILTER) <= 0x0000000F)
  102. /**
  103. * @}
  104. */
  105. /**
  106. * @}
  107. */
  108. /**
  109. * @}
  110. */
  111. #endif /* STM32F427xx || STM32F429xx || STM32F437xx || STM32F439xx || STM32F401xC || STM32F401xE || STM32F411xE || STM32F446xx */
  112. #ifdef __cplusplus
  113. }
  114. #endif
  115. #endif /* __STM32F4xx_HAL_I2C_EX_H */
  116. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/