lib/main/STM32F7/Drivers/STM32F7xx_HAL_Driver/Src/stm32f7xx_ll_i2c.c

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