lib/main/STM32G4/Drivers/STM32G4xx_HAL_Driver/Src/stm32g4xx_ll_i2c.c

   1 /**
   2   ******************************************************************************
   3   * @file    stm32g4xx_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 "stm32g4xx_ll_i2c.h"
  23 #include "stm32g4xx_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 STM32G4xx_LL_Driver
  31   * @{
  32   */
  33
  34 #if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4)
  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 #if defined(I2C4)
 120   else if (I2Cx == I2C4)
 121   {
 122     /* Force reset of I2C clock */
 123     LL_APB1_GRP2_ForceReset(LL_APB1_GRP2_PERIPH_I2C4);
 124
 125     /* Release reset of I2C clock */
 126     LL_APB1_GRP2_ReleaseReset(LL_APB1_GRP2_PERIPH_I2C4);
 127   }
 128 #endif
 129   else
 130   {
 131     status = ERROR;
 132   }
 133
 134   return status;
 135 }
 136
 137 /**
 138   * @brief  Initialize the I2C registers according to the specified parameters in I2C_InitStruct.
 139   * @param  I2Cx I2C Instance.
 140   * @param  I2C_InitStruct pointer to a @ref LL_I2C_InitTypeDef structure.
 141   * @retval An ErrorStatus enumeration value:
 142   *          - SUCCESS: I2C registers are initialized
 143   *          - ERROR: Not applicable
 144   */
 145 ErrorStatus LL_I2C_Init(I2C_TypeDef *I2Cx, LL_I2C_InitTypeDef *I2C_InitStruct)
 146 {
 147   /* Check the I2C Instance I2Cx */
 148   assert_param(IS_I2C_ALL_INSTANCE(I2Cx));
 149
 150   /* Check the I2C parameters from I2C_InitStruct */
 151   assert_param(IS_LL_I2C_PERIPHERAL_MODE(I2C_InitStruct->PeripheralMode));
 152   assert_param(IS_LL_I2C_ANALOG_FILTER(I2C_InitStruct->AnalogFilter));
 153   assert_param(IS_LL_I2C_DIGITAL_FILTER(I2C_InitStruct->DigitalFilter));
 154   assert_param(IS_LL_I2C_OWN_ADDRESS1(I2C_InitStruct->OwnAddress1));
 155   assert_param(IS_LL_I2C_TYPE_ACKNOWLEDGE(I2C_InitStruct->TypeAcknowledge));
 156   assert_param(IS_LL_I2C_OWN_ADDRSIZE(I2C_InitStruct->OwnAddrSize));
 157
 158   /* Disable the selected I2Cx Peripheral */
 159   LL_I2C_Disable(I2Cx);
 160
 161   /*---------------------------- I2Cx CR1 Configuration ------------------------
 162    * Configure the analog and digital noise filters with parameters :
 163    * - AnalogFilter: I2C_CR1_ANFOFF bit
 164    * - DigitalFilter: I2C_CR1_DNF[3:0] bits
 165    */
 166   LL_I2C_ConfigFilters(I2Cx, I2C_InitStruct->AnalogFilter, I2C_InitStruct->DigitalFilter);
 167
 168   /*---------------------------- I2Cx TIMINGR Configuration --------------------
 169    * Configure the SDA setup, hold time and the SCL high, low period with parameter :
 170    * - Timing: I2C_TIMINGR_PRESC[3:0], I2C_TIMINGR_SCLDEL[3:0], I2C_TIMINGR_SDADEL[3:0],
 171    *           I2C_TIMINGR_SCLH[7:0] and I2C_TIMINGR_SCLL[7:0] bits
 172    */
 173   LL_I2C_SetTiming(I2Cx, I2C_InitStruct->Timing);
 174
 175   /* Enable the selected I2Cx Peripheral */
 176   LL_I2C_Enable(I2Cx);
 177
 178   /*---------------------------- I2Cx OAR1 Configuration -----------------------
 179    * Disable, Configure and Enable I2Cx device own address 1 with parameters :
 180    * - OwnAddress1:  I2C_OAR1_OA1[9:0] bits
 181    * - OwnAddrSize:  I2C_OAR1_OA1MODE bit
 182    */
 183   LL_I2C_DisableOwnAddress1(I2Cx);
 184   LL_I2C_SetOwnAddress1(I2Cx, I2C_InitStruct->OwnAddress1, I2C_InitStruct->OwnAddrSize);
 185
 186   /* OwnAdress1 == 0 is reserved for General Call address */
 187   if (I2C_InitStruct->OwnAddress1 != 0U)
 188   {
 189     LL_I2C_EnableOwnAddress1(I2Cx);
 190   }
 191
 192   /*---------------------------- I2Cx MODE Configuration -----------------------
 193   * Configure I2Cx peripheral mode with parameter :
 194    * - PeripheralMode: I2C_CR1_SMBDEN and I2C_CR1_SMBHEN bits
 195    */
 196   LL_I2C_SetMode(I2Cx, I2C_InitStruct->PeripheralMode);
 197
 198   /*---------------------------- I2Cx CR2 Configuration ------------------------
 199    * Configure the ACKnowledge or Non ACKnowledge condition
 200    * after the address receive match code or next received byte with parameter :
 201    * - TypeAcknowledge: I2C_CR2_NACK bit
 202    */
 203   LL_I2C_AcknowledgeNextData(I2Cx, I2C_InitStruct->TypeAcknowledge);
 204
 205   return SUCCESS;
 206 }
 207
 208 /**
 209   * @brief  Set each @ref LL_I2C_InitTypeDef field to default value.
 210   * @param  I2C_InitStruct Pointer to a @ref LL_I2C_InitTypeDef structure.
 211   * @retval None
 212   */
 213 void LL_I2C_StructInit(LL_I2C_InitTypeDef *I2C_InitStruct)
 214 {
 215   /* Set I2C_InitStruct fields to default values */
 216   I2C_InitStruct->PeripheralMode  = LL_I2C_MODE_I2C;
 217   I2C_InitStruct->Timing          = 0U;
 218   I2C_InitStruct->AnalogFilter    = LL_I2C_ANALOGFILTER_ENABLE;
 219   I2C_InitStruct->DigitalFilter   = 0U;
 220   I2C_InitStruct->OwnAddress1     = 0U;
 221   I2C_InitStruct->TypeAcknowledge = LL_I2C_NACK;
 222   I2C_InitStruct->OwnAddrSize     = LL_I2C_OWNADDRESS1_7BIT;
 223 }
 224
 225 /**
 226   * @}
 227   */
 228
 229 /**
 230   * @}
 231   */
 232
 233 /**
 234   * @}
 235   */
 236
 237 #endif /* I2C1 || I2C2 || I2C3 || I2C4 */
 238
 239 /**
 240   * @}
 241   */
 242
 243 #endif /* USE_FULL_LL_DRIVER */
 244
 245 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/