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