lib/main/STM32H7/Drivers/STM32H7xx_HAL_Driver/Src/stm32h7xx_ll_i2c.c

   1 /**
   2   ******************************************************************************
   3   * @file    stm32h7xx_ll_i2c.c
   4   * @author  MCD Application Team
   5   * @brief   I2C LL module driver.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19 #if defined(USE_FULL_LL_DRIVER)
  20
  21 /* Includes ------------------------------------------------------------------*/
  22 #include "stm32h7xx_ll_i2c.h"
  23 #include "stm32h7xx_ll_bus.h"
  24 #ifdef  USE_FULL_ASSERT
  25 #include "stm32_assert.h"
  26 #else
  27 #define assert_param(expr) ((void)0U)
  28 #endif
  29
  30 /** @addtogroup STM32H7xx_LL_Driver
  31   * @{
  32   */
  33
  34 #if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4) || defined (I2C5)
  35
  36 /** @defgroup I2C_LL I2C
  37   * @{
  38   */
  39
  40 /* Private types -------------------------------------------------------------*/
  41 /* Private variables ---------------------------------------------------------*/
  42 /* Private constants ---------------------------------------------------------*/
  43 /* Private macros ------------------------------------------------------------*/
  44 /** @addtogroup I2C_LL_Private_Macros
  45   * @{
  46   */
  47
  48 #define IS_LL_I2C_PERIPHERAL_MODE(__VALUE__)    (((__VALUE__) == LL_I2C_MODE_I2C)          || \
  49                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_HOST)   || \
  50                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_DEVICE) || \
  51                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_DEVICE_ARP))
  52
  53 #define IS_LL_I2C_ANALOG_FILTER(__VALUE__)      (((__VALUE__) == LL_I2C_ANALOGFILTER_ENABLE) || \
  54                                                  ((__VALUE__) == LL_I2C_ANALOGFILTER_DISABLE))
  55
  56 #define IS_LL_I2C_DIGITAL_FILTER(__VALUE__)     ((__VALUE__) <= 0x0000000FU)
  57
  58 #define IS_LL_I2C_OWN_ADDRESS1(__VALUE__)       ((__VALUE__) <= 0x000003FFU)
  59
  60 #define IS_LL_I2C_TYPE_ACKNOWLEDGE(__VALUE__)   (((__VALUE__) == LL_I2C_ACK) || \
  61                                                  ((__VALUE__) == LL_I2C_NACK))
  62
  63 #define IS_LL_I2C_OWN_ADDRSIZE(__VALUE__)       (((__VALUE__) == LL_I2C_OWNADDRESS1_7BIT) || \
  64                                                  ((__VALUE__) == LL_I2C_OWNADDRESS1_10BIT))
  65 /**
  66   * @}
  67   */
  68
  69 /* Private function prototypes -----------------------------------------------*/
  70
  71 /* Exported functions --------------------------------------------------------*/
  72 /** @addtogroup I2C_LL_Exported_Functions
  73   * @{
  74   */
  75
  76 /** @addtogroup I2C_LL_EF_Init
  77   * @{
  78   */
  79
  80 /**
  81   * @brief  De-initialize the I2C registers to their default reset values.
  82   * @param  I2Cx I2C Instance.
  83   * @retval An ErrorStatus enumeration value:
  84   *          - SUCCESS: I2C registers are de-initialized
  85   *          - ERROR: I2C registers are not de-initialized
  86   */
  87 ErrorStatus LL_I2C_DeInit(I2C_TypeDef *I2Cx)
  88 {
  89   ErrorStatus status = SUCCESS;
  90
  91   /* Check the I2C Instance I2Cx */
  92   assert_param(IS_I2C_ALL_INSTANCE(I2Cx));
  93
  94   if (I2Cx == I2C1)
  95   {
  96     /* Force reset of I2C clock */
  97     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C1);
  98
  99     /* Release reset of I2C clock */
 100     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C1);
 101   }
 102   else if (I2Cx == I2C2)
 103   {
 104     /* Force reset of I2C clock */
 105     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C2);
 106
 107     /* Release reset of I2C clock */
 108     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C2);
 109
 110   }
 111   else if (I2Cx == I2C3)
 112   {
 113     /* Force reset of I2C clock */
 114     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C3);
 115
 116     /* Release reset of I2C clock */
 117     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C3);
 118   }
 119   else if (I2Cx == I2C4)
 120   {
 121     /* Force reset of I2C clock */
 122     LL_APB4_GRP1_ForceReset(LL_APB4_GRP1_PERIPH_I2C4);
 123
 124     /* Release reset of I2C clock */
 125     LL_APB4_GRP1_ReleaseReset(LL_APB4_GRP1_PERIPH_I2C4);
 126   }
 127 #if defined(I2C5)
 128   else if (I2Cx == I2C5)
 129   {
 130     /* Force reset of I2C clock */
 131     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C5);
 132
 133     /* Release reset of I2C clock */
 134     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C5);
 135   }
 136 #endif
 137   else
 138   {
 139     status = ERROR;
 140   }
 141
 142   return status;
 143 }
 144
 145 /**
 146   * @brief  Initialize the I2C registers according to the specified parameters in I2C_InitStruct.
 147   * @param  I2Cx I2C Instance.
 148   * @param  I2C_InitStruct pointer to a @ref LL_I2C_InitTypeDef structure.
 149   * @retval An ErrorStatus enumeration value:
 150   *          - SUCCESS: I2C registers are initialized
 151   *          - ERROR: Not applicable
 152   */
 153 ErrorStatus LL_I2C_Init(I2C_TypeDef *I2Cx, LL_I2C_InitTypeDef *I2C_InitStruct)
 154 {
 155   /* Check the I2C Instance I2Cx */
 156   assert_param(IS_I2C_ALL_INSTANCE(I2Cx));
 157
 158   /* Check the I2C parameters from I2C_InitStruct */
 159   assert_param(IS_LL_I2C_PERIPHERAL_MODE(I2C_InitStruct->PeripheralMode));
 160   assert_param(IS_LL_I2C_ANALOG_FILTER(I2C_InitStruct->AnalogFilter));
 161   assert_param(IS_LL_I2C_DIGITAL_FILTER(I2C_InitStruct->DigitalFilter));
 162   assert_param(IS_LL_I2C_OWN_ADDRESS1(I2C_InitStruct->OwnAddress1));
 163   assert_param(IS_LL_I2C_TYPE_ACKNOWLEDGE(I2C_InitStruct->TypeAcknowledge));
 164   assert_param(IS_LL_I2C_OWN_ADDRSIZE(I2C_InitStruct->OwnAddrSize));
 165
 166   /* Disable the selected I2Cx Peripheral */
 167   LL_I2C_Disable(I2Cx);
 168
 169   /*---------------------------- I2Cx CR1 Configuration ------------------------
 170    * Configure the analog and digital noise filters with parameters :
 171    * - AnalogFilter: I2C_CR1_ANFOFF bit
 172    * - DigitalFilter: I2C_CR1_DNF[3:0] bits
 173    */
 174   LL_I2C_ConfigFilters(I2Cx, I2C_InitStruct->AnalogFilter, I2C_InitStruct->DigitalFilter);
 175
 176   /*---------------------------- I2Cx TIMINGR Configuration --------------------
 177    * Configure the SDA setup, hold time and the SCL high, low period with parameter :
 178    * - Timing: I2C_TIMINGR_PRESC[3:0], I2C_TIMINGR_SCLDEL[3:0], I2C_TIMINGR_SDADEL[3:0],
 179    *           I2C_TIMINGR_SCLH[7:0] and I2C_TIMINGR_SCLL[7:0] bits
 180    */
 181   LL_I2C_SetTiming(I2Cx, I2C_InitStruct->Timing);
 182
 183   /* Enable the selected I2Cx Peripheral */
 184   LL_I2C_Enable(I2Cx);
 185
 186   /*---------------------------- I2Cx OAR1 Configuration -----------------------
 187    * Disable, Configure and Enable I2Cx device own address 1 with parameters :
 188    * - OwnAddress1:  I2C_OAR1_OA1[9:0] bits
 189    * - OwnAddrSize:  I2C_OAR1_OA1MODE bit
 190    */
 191   LL_I2C_DisableOwnAddress1(I2Cx);
 192   LL_I2C_SetOwnAddress1(I2Cx, I2C_InitStruct->OwnAddress1, I2C_InitStruct->OwnAddrSize);
 193
 194   /* OwnAdress1 == 0 is reserved for General Call address */
 195   if (I2C_InitStruct->OwnAddress1 != 0U)
 196   {
 197     LL_I2C_EnableOwnAddress1(I2Cx);
 198   }
 199
 200   /*---------------------------- I2Cx MODE Configuration -----------------------
 201   * Configure I2Cx peripheral mode with parameter :
 202    * - PeripheralMode: I2C_CR1_SMBDEN and I2C_CR1_SMBHEN bits
 203    */
 204   LL_I2C_SetMode(I2Cx, I2C_InitStruct->PeripheralMode);
 205
 206   /*---------------------------- I2Cx CR2 Configuration ------------------------
 207    * Configure the ACKnowledge or Non ACKnowledge condition
 208    * after the address receive match code or next received byte with parameter :
 209    * - TypeAcknowledge: I2C_CR2_NACK bit
 210    */
 211   LL_I2C_AcknowledgeNextData(I2Cx, I2C_InitStruct->TypeAcknowledge);
 212
 213   return SUCCESS;
 214 }
 215
 216 /**
 217   * @brief  Set each @ref LL_I2C_InitTypeDef field to default value.
 218   * @param  I2C_InitStruct Pointer to a @ref LL_I2C_InitTypeDef structure.
 219   * @retval None
 220   */
 221 void LL_I2C_StructInit(LL_I2C_InitTypeDef *I2C_InitStruct)
 222 {
 223   /* Set I2C_InitStruct fields to default values */
 224   I2C_InitStruct->PeripheralMode  = LL_I2C_MODE_I2C;
 225   I2C_InitStruct->Timing          = 0U;
 226   I2C_InitStruct->AnalogFilter    = LL_I2C_ANALOGFILTER_ENABLE;
 227   I2C_InitStruct->DigitalFilter   = 0U;
 228   I2C_InitStruct->OwnAddress1     = 0U;
 229   I2C_InitStruct->TypeAcknowledge = LL_I2C_NACK;
 230   I2C_InitStruct->OwnAddrSize     = LL_I2C_OWNADDRESS1_7BIT;
 231 }
 232
 233 /**
 234   * @}
 235   */
 236
 237 /**
 238   * @}
 239   */
 240
 241 /**
 242   * @}
 243   */
 244
 245 #endif /* I2C1 || I2C2 || I2C3 || I2C4  || I2C5 */
 246
 247 /**
 248   * @}
 249   */
 250
 251 #endif /* USE_FULL_LL_DRIVER */
 252
 253 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/