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