lib/main/STM32F1/Drivers/STM32F1xx_HAL_Driver/Src/stm32f1xx_ll_i2c.c

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_ll_i2c.c
   4   * @author  MCD Application Team
   5   * @version V1.1.1
   6   * @date    12-May-2017
   7   * @brief   I2C LL module driver.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2016 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 "stm32f1xx_ll_i2c.h"
  41 #include "stm32f1xx_ll_bus.h"
  42 #include "stm32f1xx_ll_rcc.h"
  43 #ifdef  USE_FULL_ASSERT
  44 #include "stm32_assert.h"
  45 #else
  46 #define assert_param(expr) ((void)0U)
  47 #endif
  48
  49 /** @addtogroup STM32F1xx_LL_Driver
  50   * @{
  51   */
  52
  53 #if defined (I2C1) || defined (I2C2)
  54
  55 /** @defgroup I2C_LL I2C
  56   * @{
  57   */
  58
  59 /* Private types -------------------------------------------------------------*/
  60 /* Private variables ---------------------------------------------------------*/
  61 /* Private constants ---------------------------------------------------------*/
  62 /* Private macros ------------------------------------------------------------*/
  63 /** @addtogroup I2C_LL_Private_Macros
  64   * @{
  65   */
  66
  67 #define IS_LL_I2C_PERIPHERAL_MODE(__VALUE__)    (((__VALUE__) == LL_I2C_MODE_I2C)          || \
  68                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_HOST)   || \
  69                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_DEVICE) || \
  70                                                  ((__VALUE__) == LL_I2C_MODE_SMBUS_DEVICE_ARP))
  71
  72 #define IS_I2C_CLOCK_SPEED(__VALUE__)           (((__VALUE__) > 0U) && ((__VALUE__) <= LL_I2C_MAX_SPEED_FAST))
  73
  74 #define IS_I2C_DUTY_CYCLE(__VALUE__)            (((__VALUE__) == LL_I2C_DUTYCYCLE_2) || \
  75                                                  ((__VALUE__) == LL_I2C_DUTYCYCLE_16_9))
  76
  77 #define IS_LL_I2C_OWN_ADDRESS1(__VALUE__)       ((__VALUE__) <= 0x000003FFU)
  78
  79 #define IS_LL_I2C_TYPE_ACKNOWLEDGE(__VALUE__)   (((__VALUE__) == LL_I2C_ACK) || \
  80                                                  ((__VALUE__) == LL_I2C_NACK))
  81
  82 #define IS_LL_I2C_OWN_ADDRSIZE(__VALUE__)       (((__VALUE__) == LL_I2C_OWNADDRESS1_7BIT) || \
  83                                                  ((__VALUE__) == LL_I2C_OWNADDRESS1_10BIT))
  84 /**
  85   * @}
  86   */
  87
  88 /* Private function prototypes -----------------------------------------------*/
  89
  90 /* Exported functions --------------------------------------------------------*/
  91 /** @addtogroup I2C_LL_Exported_Functions
  92   * @{
  93   */
  94
  95 /** @addtogroup I2C_LL_EF_Init
  96   * @{
  97   */
  98
  99 /**
 100   * @brief  De-initialize the I2C registers to their default reset values.
 101   * @param  I2Cx I2C Instance.
 102   * @retval An ErrorStatus enumeration value:
 103   *          - SUCCESS: I2C registers are de-initialized
 104   *          - ERROR: I2C registers are not de-initialized
 105   */
 106 uint32_t LL_I2C_DeInit(I2C_TypeDef *I2Cx)
 107 {
 108   ErrorStatus status = SUCCESS;
 109
 110   /* Check the I2C Instance I2Cx */
 111   assert_param(IS_I2C_ALL_INSTANCE(I2Cx));
 112
 113   if (I2Cx == I2C1)
 114   {
 115     /* Force reset of I2C clock */
 116     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C1);
 117
 118     /* Release reset of I2C clock */
 119     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C1);
 120   }
 121 #if defined(I2C2)
 122   else if (I2Cx == I2C2)
 123   {
 124     /* Force reset of I2C clock */
 125     LL_APB1_GRP1_ForceReset(LL_APB1_GRP1_PERIPH_I2C2);
 126
 127     /* Release reset of I2C clock */
 128     LL_APB1_GRP1_ReleaseReset(LL_APB1_GRP1_PERIPH_I2C2);
 129
 130   }
 131 #endif /* I2C2 */
 132   else
 133   {
 134     status = ERROR;
 135   }
 136
 137   return status;
 138 }
 139
 140 /**
 141   * @brief  Initialize the I2C registers according to the specified parameters in I2C_InitStruct.
 142   * @param  I2Cx I2C Instance.
 143   * @param  I2C_InitStruct pointer to a @ref LL_I2C_InitTypeDef structure.
 144   * @retval An ErrorStatus enumeration value:
 145   *          - SUCCESS: I2C registers are initialized
 146   *          - ERROR: Not applicable
 147   */
 148 uint32_t LL_I2C_Init(I2C_TypeDef *I2Cx, LL_I2C_InitTypeDef *I2C_InitStruct)
 149 {
 150   LL_RCC_ClocksTypeDef rcc_clocks;
 151
 152   /* Check the I2C Instance I2Cx */
 153   assert_param(IS_I2C_ALL_INSTANCE(I2Cx));
 154
 155   /* Check the I2C parameters from I2C_InitStruct */
 156   assert_param(IS_LL_I2C_PERIPHERAL_MODE(I2C_InitStruct->PeripheralMode));
 157   assert_param(IS_I2C_CLOCK_SPEED(I2C_InitStruct->ClockSpeed));
 158   assert_param(IS_I2C_DUTY_CYCLE(I2C_InitStruct->DutyCycle));
 159   assert_param(IS_LL_I2C_OWN_ADDRESS1(I2C_InitStruct->OwnAddress1));
 160   assert_param(IS_LL_I2C_TYPE_ACKNOWLEDGE(I2C_InitStruct->TypeAcknowledge));
 161   assert_param(IS_LL_I2C_OWN_ADDRSIZE(I2C_InitStruct->OwnAddrSize));
 162
 163   /* Disable the selected I2Cx Peripheral */
 164   LL_I2C_Disable(I2Cx);
 165
 166   /* Retrieve Clock frequencies */
 167   LL_RCC_GetSystemClocksFreq(&rcc_clocks);
 168
 169   /*---------------------------- I2Cx SCL Clock Speed Configuration ------------
 170    * Configure the SCL speed :
 171    * - ClockSpeed: I2C_CR2_FREQ[5:0], I2C_TRISE_TRISE[5:0], I2C_CCR_FS,
 172    *           and I2C_CCR_CCR[11:0] bits
 173    * - DutyCycle: I2C_CCR_DUTY[7:0] bits
 174    */
 175   LL_I2C_ConfigSpeed(I2Cx, rcc_clocks.PCLK1_Frequency, I2C_InitStruct->ClockSpeed, I2C_InitStruct->DutyCycle);
 176
 177   /*---------------------------- I2Cx OAR1 Configuration -----------------------
 178    * Disable, Configure and Enable I2Cx device own address 1 with parameters :
 179    * - OwnAddress1:  I2C_OAR1_ADD[9:8], I2C_OAR1_ADD[7:1] and I2C_OAR1_ADD0 bits
 180    * - OwnAddrSize:  I2C_OAR1_ADDMODE bit
 181    */
 182   LL_I2C_SetOwnAddress1(I2Cx, I2C_InitStruct->OwnAddress1, I2C_InitStruct->OwnAddrSize);
 183
 184   /*---------------------------- I2Cx MODE Configuration -----------------------
 185   * Configure I2Cx peripheral mode with parameter :
 186    * - PeripheralMode: I2C_CR1_SMBUS, I2C_CR1_SMBTYPE and I2C_CR1_ENARP bits
 187    */
 188   LL_I2C_SetMode(I2Cx, I2C_InitStruct->PeripheralMode);
 189
 190   /* Enable the selected I2Cx Peripheral */
 191   LL_I2C_Enable(I2Cx);
 192
 193   /*---------------------------- I2Cx CR2 Configuration ------------------------
 194    * Configure the ACKnowledge or Non ACKnowledge condition
 195    * after the address receive match code or next received byte with parameter :
 196    * - TypeAcknowledge: I2C_CR2_NACK bit
 197    */
 198   LL_I2C_AcknowledgeNextData(I2Cx, I2C_InitStruct->TypeAcknowledge);
 199
 200   return SUCCESS;
 201 }
 202
 203 /**
 204   * @brief  Set each @ref LL_I2C_InitTypeDef field to default value.
 205   * @param  I2C_InitStruct Pointer to a @ref LL_I2C_InitTypeDef structure.
 206   * @retval None
 207   */
 208 void LL_I2C_StructInit(LL_I2C_InitTypeDef *I2C_InitStruct)
 209 {
 210   /* Set I2C_InitStruct fields to default values */
 211   I2C_InitStruct->PeripheralMode  = LL_I2C_MODE_I2C;
 212   I2C_InitStruct->ClockSpeed      = 5000U;
 213   I2C_InitStruct->DutyCycle       = LL_I2C_DUTYCYCLE_2;
 214   I2C_InitStruct->OwnAddress1     = 0U;
 215   I2C_InitStruct->TypeAcknowledge = LL_I2C_NACK;
 216   I2C_InitStruct->OwnAddrSize     = LL_I2C_OWNADDRESS1_7BIT;
 217 }
 218
 219 /**
 220   * @}
 221   */
 222
 223 /**
 224   * @}
 225   */
 226
 227 /**
 228   * @}
 229   */
 230
 231 #endif /* I2C1 || I2C2 */
 232
 233 /**
 234   * @}
 235   */
 236
 237 #endif /* USE_FULL_LL_DRIVER */
 238
 239 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/