mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_STEVAL_3DP001V1/TOOLCHAIN_IAR/stm32f4xx_hal_i2c.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 161:aa5281ff4a02 1 /**
AnnaBridge 161:aa5281ff4a02 2 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 3 * @file stm32f4xx_hal_i2c.h
AnnaBridge 161:aa5281ff4a02 4 * @author MCD Application Team
AnnaBridge 161:aa5281ff4a02 5 * @brief Header file of I2C HAL module.
AnnaBridge 161:aa5281ff4a02 6 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 7 * @attention
AnnaBridge 161:aa5281ff4a02 8 *
AnnaBridge 161:aa5281ff4a02 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 161:aa5281ff4a02 12 * are permitted provided that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 161:aa5281ff4a02 14 * this list of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 161:aa5281ff4a02 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 161:aa5281ff4a02 17 * and/or other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 161:aa5281ff4a02 19 * may be used to endorse or promote products derived from this software
AnnaBridge 161:aa5281ff4a02 20 * without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 21 *
AnnaBridge 161:aa5281ff4a02 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 161:aa5281ff4a02 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 161:aa5281ff4a02 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 161:aa5281ff4a02 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 161:aa5281ff4a02 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 161:aa5281ff4a02 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 161:aa5281ff4a02 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 161:aa5281ff4a02 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 161:aa5281ff4a02 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 32 *
AnnaBridge 161:aa5281ff4a02 33 ******************************************************************************
AnnaBridge 161:aa5281ff4a02 34 */
AnnaBridge 161:aa5281ff4a02 35
AnnaBridge 161:aa5281ff4a02 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 161:aa5281ff4a02 37 #ifndef __STM32F4xx_HAL_I2C_H
AnnaBridge 161:aa5281ff4a02 38 #define __STM32F4xx_HAL_I2C_H
AnnaBridge 161:aa5281ff4a02 39
AnnaBridge 161:aa5281ff4a02 40 #ifdef __cplusplus
AnnaBridge 161:aa5281ff4a02 41 extern "C" {
AnnaBridge 161:aa5281ff4a02 42 #endif
AnnaBridge 161:aa5281ff4a02 43
AnnaBridge 161:aa5281ff4a02 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 45 #include "stm32f4xx_hal_def.h"
AnnaBridge 161:aa5281ff4a02 46
AnnaBridge 161:aa5281ff4a02 47 /** @addtogroup STM32F4xx_HAL_Driver
AnnaBridge 161:aa5281ff4a02 48 * @{
AnnaBridge 161:aa5281ff4a02 49 */
AnnaBridge 161:aa5281ff4a02 50
AnnaBridge 161:aa5281ff4a02 51 /** @addtogroup I2C
AnnaBridge 161:aa5281ff4a02 52 * @{
AnnaBridge 161:aa5281ff4a02 53 */
AnnaBridge 161:aa5281ff4a02 54
AnnaBridge 161:aa5281ff4a02 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 56 /** @defgroup I2C_Exported_Types I2C Exported Types
AnnaBridge 161:aa5281ff4a02 57 * @{
AnnaBridge 161:aa5281ff4a02 58 */
AnnaBridge 161:aa5281ff4a02 59
AnnaBridge 161:aa5281ff4a02 60 /**
AnnaBridge 161:aa5281ff4a02 61 * @brief I2C Configuration Structure definition
AnnaBridge 161:aa5281ff4a02 62 */
AnnaBridge 161:aa5281ff4a02 63 typedef struct
AnnaBridge 161:aa5281ff4a02 64 {
AnnaBridge 161:aa5281ff4a02 65 uint32_t ClockSpeed; /*!< Specifies the clock frequency.
AnnaBridge 161:aa5281ff4a02 66 This parameter must be set to a value lower than 400kHz */
AnnaBridge 161:aa5281ff4a02 67
AnnaBridge 161:aa5281ff4a02 68 uint32_t DutyCycle; /*!< Specifies the I2C fast mode duty cycle.
AnnaBridge 161:aa5281ff4a02 69 This parameter can be a value of @ref I2C_duty_cycle_in_fast_mode */
AnnaBridge 161:aa5281ff4a02 70
AnnaBridge 161:aa5281ff4a02 71 uint32_t OwnAddress1; /*!< Specifies the first device own address.
AnnaBridge 161:aa5281ff4a02 72 This parameter can be a 7-bit or 10-bit address. */
AnnaBridge 161:aa5281ff4a02 73
AnnaBridge 161:aa5281ff4a02 74 uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
AnnaBridge 161:aa5281ff4a02 75 This parameter can be a value of @ref I2C_addressing_mode */
AnnaBridge 161:aa5281ff4a02 76
AnnaBridge 161:aa5281ff4a02 77 uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
AnnaBridge 161:aa5281ff4a02 78 This parameter can be a value of @ref I2C_dual_addressing_mode */
AnnaBridge 161:aa5281ff4a02 79
AnnaBridge 161:aa5281ff4a02 80 uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
AnnaBridge 161:aa5281ff4a02 81 This parameter can be a 7-bit address. */
AnnaBridge 161:aa5281ff4a02 82
AnnaBridge 161:aa5281ff4a02 83 uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
AnnaBridge 161:aa5281ff4a02 84 This parameter can be a value of @ref I2C_general_call_addressing_mode */
AnnaBridge 161:aa5281ff4a02 85
AnnaBridge 161:aa5281ff4a02 86 uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
AnnaBridge 161:aa5281ff4a02 87 This parameter can be a value of @ref I2C_nostretch_mode */
AnnaBridge 161:aa5281ff4a02 88
AnnaBridge 161:aa5281ff4a02 89 }I2C_InitTypeDef;
AnnaBridge 161:aa5281ff4a02 90
AnnaBridge 161:aa5281ff4a02 91 /**
AnnaBridge 161:aa5281ff4a02 92 * @brief HAL State structure definition
AnnaBridge 161:aa5281ff4a02 93 * @note HAL I2C State value coding follow below described bitmap :
AnnaBridge 161:aa5281ff4a02 94 * b7-b6 Error information
AnnaBridge 161:aa5281ff4a02 95 * 00 : No Error
AnnaBridge 161:aa5281ff4a02 96 * 01 : Abort (Abort user request on going)
AnnaBridge 161:aa5281ff4a02 97 * 10 : Timeout
AnnaBridge 161:aa5281ff4a02 98 * 11 : Error
AnnaBridge 161:aa5281ff4a02 99 * b5 IP initilisation status
AnnaBridge 161:aa5281ff4a02 100 * 0 : Reset (IP not initialized)
AnnaBridge 161:aa5281ff4a02 101 * 1 : Init done (IP initialized and ready to use. HAL I2C Init function called)
AnnaBridge 161:aa5281ff4a02 102 * b4 (not used)
AnnaBridge 161:aa5281ff4a02 103 * x : Should be set to 0
AnnaBridge 161:aa5281ff4a02 104 * b3
AnnaBridge 161:aa5281ff4a02 105 * 0 : Ready or Busy (No Listen mode ongoing)
AnnaBridge 161:aa5281ff4a02 106 * 1 : Listen (IP in Address Listen Mode)
AnnaBridge 161:aa5281ff4a02 107 * b2 Intrinsic process state
AnnaBridge 161:aa5281ff4a02 108 * 0 : Ready
AnnaBridge 161:aa5281ff4a02 109 * 1 : Busy (IP busy with some configuration or internal operations)
AnnaBridge 161:aa5281ff4a02 110 * b1 Rx state
AnnaBridge 161:aa5281ff4a02 111 * 0 : Ready (no Rx operation ongoing)
AnnaBridge 161:aa5281ff4a02 112 * 1 : Busy (Rx operation ongoing)
AnnaBridge 161:aa5281ff4a02 113 * b0 Tx state
AnnaBridge 161:aa5281ff4a02 114 * 0 : Ready (no Tx operation ongoing)
AnnaBridge 161:aa5281ff4a02 115 * 1 : Busy (Tx operation ongoing)
AnnaBridge 161:aa5281ff4a02 116 */
AnnaBridge 161:aa5281ff4a02 117 typedef enum
AnnaBridge 161:aa5281ff4a02 118 {
AnnaBridge 161:aa5281ff4a02 119 HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
AnnaBridge 161:aa5281ff4a02 120 HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */
AnnaBridge 161:aa5281ff4a02 121 HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */
AnnaBridge 161:aa5281ff4a02 122 HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */
AnnaBridge 161:aa5281ff4a02 123 HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
AnnaBridge 161:aa5281ff4a02 124 HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */
AnnaBridge 161:aa5281ff4a02 125 HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission
AnnaBridge 161:aa5281ff4a02 126 process is ongoing */
AnnaBridge 161:aa5281ff4a02 127 HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception
AnnaBridge 161:aa5281ff4a02 128 process is ongoing */
AnnaBridge 161:aa5281ff4a02 129 HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */
AnnaBridge 161:aa5281ff4a02 130 HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */
AnnaBridge 161:aa5281ff4a02 131 HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */
AnnaBridge 161:aa5281ff4a02 132
AnnaBridge 161:aa5281ff4a02 133 }HAL_I2C_StateTypeDef;
AnnaBridge 161:aa5281ff4a02 134
AnnaBridge 161:aa5281ff4a02 135 /**
AnnaBridge 161:aa5281ff4a02 136 * @brief HAL Mode structure definition
AnnaBridge 161:aa5281ff4a02 137 * @note HAL I2C Mode value coding follow below described bitmap :
AnnaBridge 161:aa5281ff4a02 138 * b7 (not used)
AnnaBridge 161:aa5281ff4a02 139 * x : Should be set to 0
AnnaBridge 161:aa5281ff4a02 140 * b6
AnnaBridge 161:aa5281ff4a02 141 * 0 : None
AnnaBridge 161:aa5281ff4a02 142 * 1 : Memory (HAL I2C communication is in Memory Mode)
AnnaBridge 161:aa5281ff4a02 143 * b5
AnnaBridge 161:aa5281ff4a02 144 * 0 : None
AnnaBridge 161:aa5281ff4a02 145 * 1 : Slave (HAL I2C communication is in Slave Mode)
AnnaBridge 161:aa5281ff4a02 146 * b4
AnnaBridge 161:aa5281ff4a02 147 * 0 : None
AnnaBridge 161:aa5281ff4a02 148 * 1 : Master (HAL I2C communication is in Master Mode)
AnnaBridge 161:aa5281ff4a02 149 * b3-b2-b1-b0 (not used)
AnnaBridge 161:aa5281ff4a02 150 * xxxx : Should be set to 0000
AnnaBridge 161:aa5281ff4a02 151 */
AnnaBridge 161:aa5281ff4a02 152 typedef enum
AnnaBridge 161:aa5281ff4a02 153 {
AnnaBridge 161:aa5281ff4a02 154 HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */
AnnaBridge 161:aa5281ff4a02 155 HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */
AnnaBridge 161:aa5281ff4a02 156 HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */
AnnaBridge 161:aa5281ff4a02 157 HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */
AnnaBridge 161:aa5281ff4a02 158
AnnaBridge 161:aa5281ff4a02 159 }HAL_I2C_ModeTypeDef;
AnnaBridge 161:aa5281ff4a02 160
AnnaBridge 161:aa5281ff4a02 161 /**
AnnaBridge 161:aa5281ff4a02 162 * @brief I2C handle Structure definition
AnnaBridge 161:aa5281ff4a02 163 */
AnnaBridge 161:aa5281ff4a02 164 typedef struct
AnnaBridge 161:aa5281ff4a02 165 {
AnnaBridge 161:aa5281ff4a02 166 I2C_TypeDef *Instance; /*!< I2C registers base address */
AnnaBridge 161:aa5281ff4a02 167
AnnaBridge 161:aa5281ff4a02 168 I2C_InitTypeDef Init; /*!< I2C communication parameters */
AnnaBridge 161:aa5281ff4a02 169
AnnaBridge 161:aa5281ff4a02 170 uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
AnnaBridge 161:aa5281ff4a02 171
AnnaBridge 161:aa5281ff4a02 172 uint16_t XferSize; /*!< I2C transfer size */
AnnaBridge 161:aa5281ff4a02 173
AnnaBridge 161:aa5281ff4a02 174 __IO uint16_t XferCount; /*!< I2C transfer counter */
AnnaBridge 161:aa5281ff4a02 175
AnnaBridge 161:aa5281ff4a02 176 __IO uint32_t XferOptions; /*!< I2C transfer options */
AnnaBridge 161:aa5281ff4a02 177
AnnaBridge 161:aa5281ff4a02 178 __IO uint32_t PreviousState; /*!< I2C communication Previous state and mode
AnnaBridge 161:aa5281ff4a02 179 context for internal usage */
AnnaBridge 161:aa5281ff4a02 180
AnnaBridge 161:aa5281ff4a02 181 DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
AnnaBridge 161:aa5281ff4a02 182
AnnaBridge 161:aa5281ff4a02 183 DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
AnnaBridge 161:aa5281ff4a02 184
AnnaBridge 161:aa5281ff4a02 185 HAL_LockTypeDef Lock; /*!< I2C locking object */
AnnaBridge 161:aa5281ff4a02 186
AnnaBridge 161:aa5281ff4a02 187 __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
AnnaBridge 161:aa5281ff4a02 188
AnnaBridge 161:aa5281ff4a02 189 __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */
AnnaBridge 161:aa5281ff4a02 190
AnnaBridge 161:aa5281ff4a02 191 __IO uint32_t ErrorCode; /*!< I2C Error code */
AnnaBridge 161:aa5281ff4a02 192
AnnaBridge 161:aa5281ff4a02 193 __IO uint32_t Devaddress; /*!< I2C Target device address */
AnnaBridge 161:aa5281ff4a02 194
AnnaBridge 161:aa5281ff4a02 195 __IO uint32_t Memaddress; /*!< I2C Target memory address */
AnnaBridge 161:aa5281ff4a02 196
AnnaBridge 161:aa5281ff4a02 197 __IO uint32_t MemaddSize; /*!< I2C Target memory address size */
AnnaBridge 161:aa5281ff4a02 198
AnnaBridge 161:aa5281ff4a02 199 __IO uint32_t EventCount; /*!< I2C Event counter */
AnnaBridge 161:aa5281ff4a02 200
AnnaBridge 161:aa5281ff4a02 201 }I2C_HandleTypeDef;
AnnaBridge 161:aa5281ff4a02 202
AnnaBridge 161:aa5281ff4a02 203 /**
AnnaBridge 161:aa5281ff4a02 204 * @}
AnnaBridge 161:aa5281ff4a02 205 */
AnnaBridge 161:aa5281ff4a02 206
AnnaBridge 161:aa5281ff4a02 207 /* Exported constants --------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 208 /** @defgroup I2C_Exported_Constants I2C Exported Constants
AnnaBridge 161:aa5281ff4a02 209 * @{
AnnaBridge 161:aa5281ff4a02 210 */
AnnaBridge 161:aa5281ff4a02 211
AnnaBridge 161:aa5281ff4a02 212 /** @defgroup I2C_Error_Code I2C Error Code
AnnaBridge 161:aa5281ff4a02 213 * @brief I2C Error Code
AnnaBridge 161:aa5281ff4a02 214 * @{
AnnaBridge 161:aa5281ff4a02 215 */
AnnaBridge 161:aa5281ff4a02 216 #define HAL_I2C_ERROR_NONE 0x00000000U /*!< No error */
AnnaBridge 161:aa5281ff4a02 217 #define HAL_I2C_ERROR_BERR 0x00000001U /*!< BERR error */
AnnaBridge 161:aa5281ff4a02 218 #define HAL_I2C_ERROR_ARLO 0x00000002U /*!< ARLO error */
AnnaBridge 161:aa5281ff4a02 219 #define HAL_I2C_ERROR_AF 0x00000004U /*!< AF error */
AnnaBridge 161:aa5281ff4a02 220 #define HAL_I2C_ERROR_OVR 0x00000008U /*!< OVR error */
AnnaBridge 161:aa5281ff4a02 221 #define HAL_I2C_ERROR_DMA 0x00000010U /*!< DMA transfer error */
AnnaBridge 161:aa5281ff4a02 222 #define HAL_I2C_ERROR_TIMEOUT 0x00000020U /*!< Timeout Error */
AnnaBridge 161:aa5281ff4a02 223 /**
AnnaBridge 161:aa5281ff4a02 224 * @}
AnnaBridge 161:aa5281ff4a02 225 */
AnnaBridge 161:aa5281ff4a02 226
AnnaBridge 161:aa5281ff4a02 227 /** @defgroup I2C_duty_cycle_in_fast_mode I2C duty cycle in fast mode
AnnaBridge 161:aa5281ff4a02 228 * @{
AnnaBridge 161:aa5281ff4a02 229 */
AnnaBridge 161:aa5281ff4a02 230 #define I2C_DUTYCYCLE_2 0x00000000U
AnnaBridge 161:aa5281ff4a02 231 #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
AnnaBridge 161:aa5281ff4a02 232 /**
AnnaBridge 161:aa5281ff4a02 233 * @}
AnnaBridge 161:aa5281ff4a02 234 */
AnnaBridge 161:aa5281ff4a02 235
AnnaBridge 161:aa5281ff4a02 236 /** @defgroup I2C_addressing_mode I2C addressing mode
AnnaBridge 161:aa5281ff4a02 237 * @{
AnnaBridge 161:aa5281ff4a02 238 */
AnnaBridge 161:aa5281ff4a02 239 #define I2C_ADDRESSINGMODE_7BIT 0x00004000U
AnnaBridge 161:aa5281ff4a02 240 #define I2C_ADDRESSINGMODE_10BIT (I2C_OAR1_ADDMODE | 0x00004000U)
AnnaBridge 161:aa5281ff4a02 241 /**
AnnaBridge 161:aa5281ff4a02 242 * @}
AnnaBridge 161:aa5281ff4a02 243 */
AnnaBridge 161:aa5281ff4a02 244
AnnaBridge 161:aa5281ff4a02 245 /** @defgroup I2C_dual_addressing_mode I2C dual addressing mode
AnnaBridge 161:aa5281ff4a02 246 * @{
AnnaBridge 161:aa5281ff4a02 247 */
AnnaBridge 161:aa5281ff4a02 248 #define I2C_DUALADDRESS_DISABLE 0x00000000U
AnnaBridge 161:aa5281ff4a02 249 #define I2C_DUALADDRESS_ENABLE I2C_OAR2_ENDUAL
AnnaBridge 161:aa5281ff4a02 250 /**
AnnaBridge 161:aa5281ff4a02 251 * @}
AnnaBridge 161:aa5281ff4a02 252 */
AnnaBridge 161:aa5281ff4a02 253
AnnaBridge 161:aa5281ff4a02 254 /** @defgroup I2C_general_call_addressing_mode I2C general call addressing mode
AnnaBridge 161:aa5281ff4a02 255 * @{
AnnaBridge 161:aa5281ff4a02 256 */
AnnaBridge 161:aa5281ff4a02 257 #define I2C_GENERALCALL_DISABLE 0x00000000U
AnnaBridge 161:aa5281ff4a02 258 #define I2C_GENERALCALL_ENABLE I2C_CR1_ENGC
AnnaBridge 161:aa5281ff4a02 259 /**
AnnaBridge 161:aa5281ff4a02 260 * @}
AnnaBridge 161:aa5281ff4a02 261 */
AnnaBridge 161:aa5281ff4a02 262
AnnaBridge 161:aa5281ff4a02 263 /** @defgroup I2C_nostretch_mode I2C nostretch mode
AnnaBridge 161:aa5281ff4a02 264 * @{
AnnaBridge 161:aa5281ff4a02 265 */
AnnaBridge 161:aa5281ff4a02 266 #define I2C_NOSTRETCH_DISABLE 0x00000000U
AnnaBridge 161:aa5281ff4a02 267 #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
AnnaBridge 161:aa5281ff4a02 268 /**
AnnaBridge 161:aa5281ff4a02 269 * @}
AnnaBridge 161:aa5281ff4a02 270 */
AnnaBridge 161:aa5281ff4a02 271
AnnaBridge 161:aa5281ff4a02 272 /** @defgroup I2C_Memory_Address_Size I2C Memory Address Size
AnnaBridge 161:aa5281ff4a02 273 * @{
AnnaBridge 161:aa5281ff4a02 274 */
AnnaBridge 161:aa5281ff4a02 275 #define I2C_MEMADD_SIZE_8BIT 0x00000001U
AnnaBridge 161:aa5281ff4a02 276 #define I2C_MEMADD_SIZE_16BIT 0x00000010U
AnnaBridge 161:aa5281ff4a02 277 /**
AnnaBridge 161:aa5281ff4a02 278 * @}
AnnaBridge 161:aa5281ff4a02 279 */
AnnaBridge 161:aa5281ff4a02 280
AnnaBridge 161:aa5281ff4a02 281 /** @defgroup I2C_XferDirection_definition I2C XferDirection definition
AnnaBridge 161:aa5281ff4a02 282 * @{
AnnaBridge 161:aa5281ff4a02 283 */
AnnaBridge 161:aa5281ff4a02 284 #define I2C_DIRECTION_RECEIVE 0x00000000U
AnnaBridge 161:aa5281ff4a02 285 #define I2C_DIRECTION_TRANSMIT 0x00000001U
AnnaBridge 161:aa5281ff4a02 286 /**
AnnaBridge 161:aa5281ff4a02 287 * @}
AnnaBridge 161:aa5281ff4a02 288 */
AnnaBridge 161:aa5281ff4a02 289
AnnaBridge 161:aa5281ff4a02 290 /** @defgroup I2C_XferOptions_definition I2C XferOptions definition
AnnaBridge 161:aa5281ff4a02 291 * @{
AnnaBridge 161:aa5281ff4a02 292 */
AnnaBridge 161:aa5281ff4a02 293 #define I2C_FIRST_FRAME 0x00000001U
AnnaBridge 161:aa5281ff4a02 294 #define I2C_NEXT_FRAME 0x00000002U
AnnaBridge 161:aa5281ff4a02 295 #define I2C_FIRST_AND_LAST_FRAME 0x00000004U
AnnaBridge 161:aa5281ff4a02 296 #define I2C_LAST_FRAME 0x00000008U
AnnaBridge 161:aa5281ff4a02 297 /**
AnnaBridge 161:aa5281ff4a02 298 * @}
AnnaBridge 161:aa5281ff4a02 299 */
AnnaBridge 161:aa5281ff4a02 300
AnnaBridge 161:aa5281ff4a02 301 /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
AnnaBridge 161:aa5281ff4a02 302 * @{
AnnaBridge 161:aa5281ff4a02 303 */
AnnaBridge 161:aa5281ff4a02 304 #define I2C_IT_BUF I2C_CR2_ITBUFEN
AnnaBridge 161:aa5281ff4a02 305 #define I2C_IT_EVT I2C_CR2_ITEVTEN
AnnaBridge 161:aa5281ff4a02 306 #define I2C_IT_ERR I2C_CR2_ITERREN
AnnaBridge 161:aa5281ff4a02 307 /**
AnnaBridge 161:aa5281ff4a02 308 * @}
AnnaBridge 161:aa5281ff4a02 309 */
AnnaBridge 161:aa5281ff4a02 310
AnnaBridge 161:aa5281ff4a02 311 /** @defgroup I2C_Flag_definition I2C Flag definition
AnnaBridge 161:aa5281ff4a02 312 * @{
AnnaBridge 161:aa5281ff4a02 313 */
AnnaBridge 161:aa5281ff4a02 314 #define I2C_FLAG_SMBALERT 0x00018000U
AnnaBridge 161:aa5281ff4a02 315 #define I2C_FLAG_TIMEOUT 0x00014000U
AnnaBridge 161:aa5281ff4a02 316 #define I2C_FLAG_PECERR 0x00011000U
AnnaBridge 161:aa5281ff4a02 317 #define I2C_FLAG_OVR 0x00010800U
AnnaBridge 161:aa5281ff4a02 318 #define I2C_FLAG_AF 0x00010400U
AnnaBridge 161:aa5281ff4a02 319 #define I2C_FLAG_ARLO 0x00010200U
AnnaBridge 161:aa5281ff4a02 320 #define I2C_FLAG_BERR 0x00010100U
AnnaBridge 161:aa5281ff4a02 321 #define I2C_FLAG_TXE 0x00010080U
AnnaBridge 161:aa5281ff4a02 322 #define I2C_FLAG_RXNE 0x00010040U
AnnaBridge 161:aa5281ff4a02 323 #define I2C_FLAG_STOPF 0x00010010U
AnnaBridge 161:aa5281ff4a02 324 #define I2C_FLAG_ADD10 0x00010008U
AnnaBridge 161:aa5281ff4a02 325 #define I2C_FLAG_BTF 0x00010004U
AnnaBridge 161:aa5281ff4a02 326 #define I2C_FLAG_ADDR 0x00010002U
AnnaBridge 161:aa5281ff4a02 327 #define I2C_FLAG_SB 0x00010001U
AnnaBridge 161:aa5281ff4a02 328 #define I2C_FLAG_DUALF 0x00100080U
AnnaBridge 161:aa5281ff4a02 329 #define I2C_FLAG_SMBHOST 0x00100040U
AnnaBridge 161:aa5281ff4a02 330 #define I2C_FLAG_SMBDEFAULT 0x00100020U
AnnaBridge 161:aa5281ff4a02 331 #define I2C_FLAG_GENCALL 0x00100010U
AnnaBridge 161:aa5281ff4a02 332 #define I2C_FLAG_TRA 0x00100004U
AnnaBridge 161:aa5281ff4a02 333 #define I2C_FLAG_BUSY 0x00100002U
AnnaBridge 161:aa5281ff4a02 334 #define I2C_FLAG_MSL 0x00100001U
AnnaBridge 161:aa5281ff4a02 335 /**
AnnaBridge 161:aa5281ff4a02 336 * @}
AnnaBridge 161:aa5281ff4a02 337 */
AnnaBridge 161:aa5281ff4a02 338
AnnaBridge 161:aa5281ff4a02 339 /**
AnnaBridge 161:aa5281ff4a02 340 * @}
AnnaBridge 161:aa5281ff4a02 341 */
AnnaBridge 161:aa5281ff4a02 342
AnnaBridge 161:aa5281ff4a02 343 /* Exported macro ------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 344 /** @defgroup I2C_Exported_Macros I2C Exported Macros
AnnaBridge 161:aa5281ff4a02 345 * @{
AnnaBridge 161:aa5281ff4a02 346 */
AnnaBridge 161:aa5281ff4a02 347
AnnaBridge 161:aa5281ff4a02 348 /** @brief Reset I2C handle state
AnnaBridge 163:e59c8e839560 349 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 350 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 161:aa5281ff4a02 351 * @retval None
AnnaBridge 161:aa5281ff4a02 352 */
AnnaBridge 161:aa5281ff4a02 353 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
AnnaBridge 161:aa5281ff4a02 354
AnnaBridge 161:aa5281ff4a02 355 /** @brief Enable or disable the specified I2C interrupts.
AnnaBridge 163:e59c8e839560 356 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 357 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 163:e59c8e839560 358 * @param __INTERRUPT__ specifies the interrupt source to enable or disable.
AnnaBridge 161:aa5281ff4a02 359 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 360 * @arg I2C_IT_BUF: Buffer interrupt enable
AnnaBridge 161:aa5281ff4a02 361 * @arg I2C_IT_EVT: Event interrupt enable
AnnaBridge 161:aa5281ff4a02 362 * @arg I2C_IT_ERR: Error interrupt enable
AnnaBridge 161:aa5281ff4a02 363 * @retval None
AnnaBridge 161:aa5281ff4a02 364 */
AnnaBridge 161:aa5281ff4a02 365 #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
AnnaBridge 161:aa5281ff4a02 366 #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (~(__INTERRUPT__)))
AnnaBridge 161:aa5281ff4a02 367
AnnaBridge 161:aa5281ff4a02 368 /** @brief Checks if the specified I2C interrupt source is enabled or disabled.
AnnaBridge 163:e59c8e839560 369 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 370 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 163:e59c8e839560 371 * @param __INTERRUPT__ specifies the I2C interrupt source to check.
AnnaBridge 161:aa5281ff4a02 372 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 373 * @arg I2C_IT_BUF: Buffer interrupt enable
AnnaBridge 161:aa5281ff4a02 374 * @arg I2C_IT_EVT: Event interrupt enable
AnnaBridge 161:aa5281ff4a02 375 * @arg I2C_IT_ERR: Error interrupt enable
AnnaBridge 161:aa5281ff4a02 376 * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
AnnaBridge 161:aa5281ff4a02 377 */
AnnaBridge 161:aa5281ff4a02 378 #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
AnnaBridge 161:aa5281ff4a02 379
AnnaBridge 161:aa5281ff4a02 380 /** @brief Checks whether the specified I2C flag is set or not.
AnnaBridge 163:e59c8e839560 381 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 382 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 163:e59c8e839560 383 * @param __FLAG__ specifies the flag to check.
AnnaBridge 161:aa5281ff4a02 384 * This parameter can be one of the following values:
AnnaBridge 161:aa5281ff4a02 385 * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
AnnaBridge 161:aa5281ff4a02 386 * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
AnnaBridge 161:aa5281ff4a02 387 * @arg I2C_FLAG_PECERR: PEC error in reception flag
AnnaBridge 161:aa5281ff4a02 388 * @arg I2C_FLAG_OVR: Overrun/Underrun flag
AnnaBridge 161:aa5281ff4a02 389 * @arg I2C_FLAG_AF: Acknowledge failure flag
AnnaBridge 161:aa5281ff4a02 390 * @arg I2C_FLAG_ARLO: Arbitration lost flag
AnnaBridge 161:aa5281ff4a02 391 * @arg I2C_FLAG_BERR: Bus error flag
AnnaBridge 161:aa5281ff4a02 392 * @arg I2C_FLAG_TXE: Data register empty flag
AnnaBridge 161:aa5281ff4a02 393 * @arg I2C_FLAG_RXNE: Data register not empty flag
AnnaBridge 161:aa5281ff4a02 394 * @arg I2C_FLAG_STOPF: Stop detection flag
AnnaBridge 161:aa5281ff4a02 395 * @arg I2C_FLAG_ADD10: 10-bit header sent flag
AnnaBridge 161:aa5281ff4a02 396 * @arg I2C_FLAG_BTF: Byte transfer finished flag
AnnaBridge 161:aa5281ff4a02 397 * @arg I2C_FLAG_ADDR: Address sent flag
AnnaBridge 161:aa5281ff4a02 398 * Address matched flag
AnnaBridge 161:aa5281ff4a02 399 * @arg I2C_FLAG_SB: Start bit flag
AnnaBridge 161:aa5281ff4a02 400 * @arg I2C_FLAG_DUALF: Dual flag
AnnaBridge 161:aa5281ff4a02 401 * @arg I2C_FLAG_SMBHOST: SMBus host header
AnnaBridge 161:aa5281ff4a02 402 * @arg I2C_FLAG_SMBDEFAULT: SMBus default header
AnnaBridge 161:aa5281ff4a02 403 * @arg I2C_FLAG_GENCALL: General call header flag
AnnaBridge 161:aa5281ff4a02 404 * @arg I2C_FLAG_TRA: Transmitter/Receiver flag
AnnaBridge 161:aa5281ff4a02 405 * @arg I2C_FLAG_BUSY: Bus busy flag
AnnaBridge 161:aa5281ff4a02 406 * @arg I2C_FLAG_MSL: Master/Slave flag
AnnaBridge 161:aa5281ff4a02 407 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 161:aa5281ff4a02 408 */
AnnaBridge 161:aa5281ff4a02 409 #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16U)) == 0x01U)?((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)): \
AnnaBridge 161:aa5281ff4a02 410 ((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)))
AnnaBridge 161:aa5281ff4a02 411
AnnaBridge 161:aa5281ff4a02 412 /** @brief Clears the I2C pending flags which are cleared by writing 0 in a specific bit.
AnnaBridge 163:e59c8e839560 413 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 414 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 163:e59c8e839560 415 * @param __FLAG__ specifies the flag to clear.
AnnaBridge 161:aa5281ff4a02 416 * This parameter can be any combination of the following values:
AnnaBridge 161:aa5281ff4a02 417 * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
AnnaBridge 161:aa5281ff4a02 418 * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
AnnaBridge 161:aa5281ff4a02 419 * @arg I2C_FLAG_PECERR: PEC error in reception flag
AnnaBridge 161:aa5281ff4a02 420 * @arg I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
AnnaBridge 161:aa5281ff4a02 421 * @arg I2C_FLAG_AF: Acknowledge failure flag
AnnaBridge 161:aa5281ff4a02 422 * @arg I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
AnnaBridge 161:aa5281ff4a02 423 * @arg I2C_FLAG_BERR: Bus error flag
AnnaBridge 161:aa5281ff4a02 424 * @retval None
AnnaBridge 161:aa5281ff4a02 425 */
AnnaBridge 161:aa5281ff4a02 426 #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
AnnaBridge 161:aa5281ff4a02 427
AnnaBridge 161:aa5281ff4a02 428 /** @brief Clears the I2C ADDR pending flag.
AnnaBridge 163:e59c8e839560 429 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 430 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 161:aa5281ff4a02 431 * @retval None
AnnaBridge 161:aa5281ff4a02 432 */
AnnaBridge 161:aa5281ff4a02 433 #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) \
AnnaBridge 161:aa5281ff4a02 434 do{ \
AnnaBridge 161:aa5281ff4a02 435 __IO uint32_t tmpreg = 0x00U; \
AnnaBridge 161:aa5281ff4a02 436 tmpreg = (__HANDLE__)->Instance->SR1; \
AnnaBridge 161:aa5281ff4a02 437 tmpreg = (__HANDLE__)->Instance->SR2; \
AnnaBridge 161:aa5281ff4a02 438 UNUSED(tmpreg); \
AnnaBridge 161:aa5281ff4a02 439 } while(0)
AnnaBridge 161:aa5281ff4a02 440
AnnaBridge 161:aa5281ff4a02 441 /** @brief Clears the I2C STOPF pending flag.
AnnaBridge 163:e59c8e839560 442 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 443 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
AnnaBridge 161:aa5281ff4a02 444 * @retval None
AnnaBridge 161:aa5281ff4a02 445 */
AnnaBridge 161:aa5281ff4a02 446 #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) \
AnnaBridge 161:aa5281ff4a02 447 do{ \
AnnaBridge 161:aa5281ff4a02 448 __IO uint32_t tmpreg = 0x00U; \
AnnaBridge 161:aa5281ff4a02 449 tmpreg = (__HANDLE__)->Instance->SR1; \
AnnaBridge 161:aa5281ff4a02 450 (__HANDLE__)->Instance->CR1 |= I2C_CR1_PE; \
AnnaBridge 161:aa5281ff4a02 451 UNUSED(tmpreg); \
AnnaBridge 161:aa5281ff4a02 452 } while(0)
AnnaBridge 161:aa5281ff4a02 453
AnnaBridge 161:aa5281ff4a02 454 /** @brief Enable the I2C peripheral.
AnnaBridge 163:e59c8e839560 455 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 456 * This parameter can be I2Cx where x: 1 or 2 to select the I2C peripheral.
AnnaBridge 161:aa5281ff4a02 457 * @retval None
AnnaBridge 161:aa5281ff4a02 458 */
AnnaBridge 161:aa5281ff4a02 459 #define __HAL_I2C_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= I2C_CR1_PE)
AnnaBridge 161:aa5281ff4a02 460
AnnaBridge 161:aa5281ff4a02 461 /** @brief Disable the I2C peripheral.
AnnaBridge 163:e59c8e839560 462 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 161:aa5281ff4a02 463 * This parameter can be I2Cx where x: 1 or 2 to select the I2C peripheral.
AnnaBridge 161:aa5281ff4a02 464 * @retval None
AnnaBridge 161:aa5281ff4a02 465 */
AnnaBridge 161:aa5281ff4a02 466 #define __HAL_I2C_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~I2C_CR1_PE)
AnnaBridge 161:aa5281ff4a02 467
AnnaBridge 161:aa5281ff4a02 468 /**
AnnaBridge 161:aa5281ff4a02 469 * @}
AnnaBridge 161:aa5281ff4a02 470 */
AnnaBridge 161:aa5281ff4a02 471
AnnaBridge 161:aa5281ff4a02 472 /* Include I2C HAL Extension module */
AnnaBridge 161:aa5281ff4a02 473 #include "stm32f4xx_hal_i2c_ex.h"
AnnaBridge 161:aa5281ff4a02 474
AnnaBridge 161:aa5281ff4a02 475 /* Exported functions --------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 476 /** @addtogroup I2C_Exported_Functions
AnnaBridge 161:aa5281ff4a02 477 * @{
AnnaBridge 161:aa5281ff4a02 478 */
AnnaBridge 161:aa5281ff4a02 479
AnnaBridge 161:aa5281ff4a02 480 /** @addtogroup I2C_Exported_Functions_Group1
AnnaBridge 161:aa5281ff4a02 481 * @{
AnnaBridge 161:aa5281ff4a02 482 */
AnnaBridge 161:aa5281ff4a02 483 /* Initialization/de-initialization functions **********************************/
AnnaBridge 161:aa5281ff4a02 484 HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 485 HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 486 void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 487 void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 488 /**
AnnaBridge 161:aa5281ff4a02 489 * @}
AnnaBridge 161:aa5281ff4a02 490 */
AnnaBridge 161:aa5281ff4a02 491
AnnaBridge 161:aa5281ff4a02 492 /** @addtogroup I2C_Exported_Functions_Group2
AnnaBridge 161:aa5281ff4a02 493 * @{
AnnaBridge 161:aa5281ff4a02 494 */
AnnaBridge 161:aa5281ff4a02 495 /* I/O operation functions *****************************************************/
AnnaBridge 161:aa5281ff4a02 496 /******* Blocking mode: Polling */
AnnaBridge 161:aa5281ff4a02 497 HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 498 HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 499 HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 500 HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 501 HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 502 HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 503 HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
AnnaBridge 161:aa5281ff4a02 504
AnnaBridge 161:aa5281ff4a02 505 /******* Non-Blocking mode: Interrupt */
AnnaBridge 161:aa5281ff4a02 506 HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 507 HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 508 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 509 HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 510 HAL_StatusTypeDef HAL_I2C_Mem_Write_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 511 HAL_StatusTypeDef HAL_I2C_Mem_Read_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 512
AnnaBridge 161:aa5281ff4a02 513 HAL_StatusTypeDef HAL_I2C_Master_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 161:aa5281ff4a02 514 HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 161:aa5281ff4a02 515 HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 161:aa5281ff4a02 516 HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 161:aa5281ff4a02 517 HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
AnnaBridge 161:aa5281ff4a02 518 HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 519 HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 520
AnnaBridge 161:aa5281ff4a02 521 /******* Non-Blocking mode: DMA */
AnnaBridge 161:aa5281ff4a02 522 HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 523 HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 524 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 525 HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 526 HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 527 HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
AnnaBridge 161:aa5281ff4a02 528
AnnaBridge 161:aa5281ff4a02 529 /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
AnnaBridge 161:aa5281ff4a02 530 void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 531 void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 532 void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 533 void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 534 void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 535 void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 536 void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
AnnaBridge 161:aa5281ff4a02 537 void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 538 void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 539 void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 540 void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 541 void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 542 /**
AnnaBridge 161:aa5281ff4a02 543 * @}
AnnaBridge 161:aa5281ff4a02 544 */
AnnaBridge 161:aa5281ff4a02 545
AnnaBridge 161:aa5281ff4a02 546 /** @addtogroup I2C_Exported_Functions_Group3
AnnaBridge 161:aa5281ff4a02 547 * @{
AnnaBridge 161:aa5281ff4a02 548 */
AnnaBridge 161:aa5281ff4a02 549 /* Peripheral State, Mode and Errors functions *********************************/
AnnaBridge 161:aa5281ff4a02 550 HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 551 HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 552 uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
AnnaBridge 161:aa5281ff4a02 553
AnnaBridge 161:aa5281ff4a02 554 /**
AnnaBridge 161:aa5281ff4a02 555 * @}
AnnaBridge 161:aa5281ff4a02 556 */
AnnaBridge 161:aa5281ff4a02 557
AnnaBridge 161:aa5281ff4a02 558 /**
AnnaBridge 161:aa5281ff4a02 559 * @}
AnnaBridge 161:aa5281ff4a02 560 */
AnnaBridge 161:aa5281ff4a02 561 /* Private types -------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 562 /* Private variables ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 563 /* Private constants ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 564 /** @defgroup I2C_Private_Constants I2C Private Constants
AnnaBridge 161:aa5281ff4a02 565 * @{
AnnaBridge 161:aa5281ff4a02 566 */
AnnaBridge 161:aa5281ff4a02 567 #define I2C_FLAG_MASK 0x0000FFFFU
AnnaBridge 161:aa5281ff4a02 568 /**
AnnaBridge 161:aa5281ff4a02 569 * @}
AnnaBridge 161:aa5281ff4a02 570 */
AnnaBridge 161:aa5281ff4a02 571
AnnaBridge 161:aa5281ff4a02 572 /* Private macros ------------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 573 /** @defgroup I2C_Private_Macros I2C Private Macros
AnnaBridge 161:aa5281ff4a02 574 * @{
AnnaBridge 161:aa5281ff4a02 575 */
AnnaBridge 161:aa5281ff4a02 576
AnnaBridge 161:aa5281ff4a02 577 #define I2C_FREQRANGE(__PCLK__) ((__PCLK__)/1000000U)
AnnaBridge 161:aa5281ff4a02 578 #define I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__FREQRANGE__) + 1U) : ((((__FREQRANGE__) * 300U) / 1000U) + 1U))
AnnaBridge 161:aa5281ff4a02 579 #define I2C_SPEED_STANDARD(__PCLK__, __SPEED__) (((((__PCLK__)/((__SPEED__) << 1U)) & I2C_CCR_CCR) < 4U)? 4U:((__PCLK__) / ((__SPEED__) << 1U)))
AnnaBridge 161:aa5281ff4a02 580 #define I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? ((__PCLK__) / ((__SPEED__) * 3U)) : (((__PCLK__) / ((__SPEED__) * 25U)) | I2C_DUTYCYCLE_16_9))
AnnaBridge 161:aa5281ff4a02 581 #define I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000U)? (I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
AnnaBridge 161:aa5281ff4a02 582 ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0U)? 1U : \
AnnaBridge 161:aa5281ff4a02 583 ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
AnnaBridge 161:aa5281ff4a02 584
AnnaBridge 161:aa5281ff4a02 585 #define I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (~I2C_OAR1_ADD0)))
AnnaBridge 161:aa5281ff4a02 586 #define I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | I2C_OAR1_ADD0))
AnnaBridge 161:aa5281ff4a02 587
AnnaBridge 161:aa5281ff4a02 588 #define I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
AnnaBridge 161:aa5281ff4a02 589 #define I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)0x00F0)))
AnnaBridge 161:aa5281ff4a02 590 #define I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)(0x00F1))))
AnnaBridge 161:aa5281ff4a02 591
AnnaBridge 161:aa5281ff4a02 592 #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0xFF00)) >> 8)))
AnnaBridge 161:aa5281ff4a02 593 #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
AnnaBridge 161:aa5281ff4a02 594
AnnaBridge 161:aa5281ff4a02 595 /** @defgroup I2C_IS_RTC_Definitions I2C Private macros to check input parameters
AnnaBridge 161:aa5281ff4a02 596 * @{
AnnaBridge 161:aa5281ff4a02 597 */
AnnaBridge 161:aa5281ff4a02 598 #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
AnnaBridge 161:aa5281ff4a02 599 ((CYCLE) == I2C_DUTYCYCLE_16_9))
AnnaBridge 161:aa5281ff4a02 600 #define IS_I2C_ADDRESSING_MODE(ADDRESS) (((ADDRESS) == I2C_ADDRESSINGMODE_7BIT) || \
AnnaBridge 161:aa5281ff4a02 601 ((ADDRESS) == I2C_ADDRESSINGMODE_10BIT))
AnnaBridge 161:aa5281ff4a02 602 #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
AnnaBridge 161:aa5281ff4a02 603 ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
AnnaBridge 161:aa5281ff4a02 604 #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
AnnaBridge 161:aa5281ff4a02 605 ((CALL) == I2C_GENERALCALL_ENABLE))
AnnaBridge 161:aa5281ff4a02 606 #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
AnnaBridge 161:aa5281ff4a02 607 ((STRETCH) == I2C_NOSTRETCH_ENABLE))
AnnaBridge 161:aa5281ff4a02 608 #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
AnnaBridge 161:aa5281ff4a02 609 ((SIZE) == I2C_MEMADD_SIZE_16BIT))
AnnaBridge 161:aa5281ff4a02 610 #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0U) && ((SPEED) <= 400000U))
AnnaBridge 161:aa5281ff4a02 611 #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & 0xFFFFFC00U) == 0U)
AnnaBridge 161:aa5281ff4a02 612 #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & 0xFFFFFF01U) == 0U)
AnnaBridge 161:aa5281ff4a02 613 #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
AnnaBridge 161:aa5281ff4a02 614 ((REQUEST) == I2C_NEXT_FRAME) || \
AnnaBridge 161:aa5281ff4a02 615 ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
AnnaBridge 161:aa5281ff4a02 616 ((REQUEST) == I2C_LAST_FRAME))
AnnaBridge 161:aa5281ff4a02 617 /**
AnnaBridge 161:aa5281ff4a02 618 * @}
AnnaBridge 161:aa5281ff4a02 619 */
AnnaBridge 161:aa5281ff4a02 620
AnnaBridge 161:aa5281ff4a02 621 /**
AnnaBridge 161:aa5281ff4a02 622 * @}
AnnaBridge 161:aa5281ff4a02 623 */
AnnaBridge 161:aa5281ff4a02 624
AnnaBridge 161:aa5281ff4a02 625 /* Private functions ---------------------------------------------------------*/
AnnaBridge 161:aa5281ff4a02 626 /** @defgroup I2C_Private_Functions I2C Private Functions
AnnaBridge 161:aa5281ff4a02 627 * @{
AnnaBridge 161:aa5281ff4a02 628 */
AnnaBridge 161:aa5281ff4a02 629
AnnaBridge 161:aa5281ff4a02 630 /**
AnnaBridge 161:aa5281ff4a02 631 * @}
AnnaBridge 161:aa5281ff4a02 632 */
AnnaBridge 161:aa5281ff4a02 633
AnnaBridge 161:aa5281ff4a02 634 /**
AnnaBridge 161:aa5281ff4a02 635 * @}
AnnaBridge 161:aa5281ff4a02 636 */
AnnaBridge 161:aa5281ff4a02 637
AnnaBridge 161:aa5281ff4a02 638 /**
AnnaBridge 161:aa5281ff4a02 639 * @}
AnnaBridge 161:aa5281ff4a02 640 */
AnnaBridge 161:aa5281ff4a02 641
AnnaBridge 161:aa5281ff4a02 642 #ifdef __cplusplus
AnnaBridge 161:aa5281ff4a02 643 }
AnnaBridge 161:aa5281ff4a02 644 #endif
AnnaBridge 161:aa5281ff4a02 645
AnnaBridge 161:aa5281ff4a02 646
AnnaBridge 161:aa5281ff4a02 647 #endif /* __STM32F4xx_HAL_I2C_H */
AnnaBridge 161:aa5281ff4a02 648
AnnaBridge 161:aa5281ff4a02 649 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/