stm32f4xx_hal_i2c_ex.h 4.9 KB

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