mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /**
AnnaBridge 189:f392fc9709a3 2 ******************************************************************************
AnnaBridge 189:f392fc9709a3 3 * @file stm32l4xx_hal_i2c.h
AnnaBridge 189:f392fc9709a3 4 * @author MCD Application Team
AnnaBridge 189:f392fc9709a3 5 * @brief Header file of I2C HAL module.
AnnaBridge 189:f392fc9709a3 6 ******************************************************************************
AnnaBridge 189:f392fc9709a3 7 * @attention
AnnaBridge 189:f392fc9709a3 8 *
AnnaBridge 189:f392fc9709a3 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 12 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 13 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 189:f392fc9709a3 14 * this list of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 189:f392fc9709a3 16 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 189:f392fc9709a3 17 * and/or other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 189:f392fc9709a3 19 * may be used to endorse or promote products derived from this software
AnnaBridge 189:f392fc9709a3 20 * without specific prior written permission.
AnnaBridge 189:f392fc9709a3 21 *
AnnaBridge 189:f392fc9709a3 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 189:f392fc9709a3 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 189:f392fc9709a3 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 189:f392fc9709a3 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 189:f392fc9709a3 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 189:f392fc9709a3 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 189:f392fc9709a3 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 189:f392fc9709a3 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 189:f392fc9709a3 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 32 *
AnnaBridge 189:f392fc9709a3 33 ******************************************************************************
AnnaBridge 189:f392fc9709a3 34 */
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 189:f392fc9709a3 37 #ifndef __STM32L4xx_HAL_I2C_H
AnnaBridge 189:f392fc9709a3 38 #define __STM32L4xx_HAL_I2C_H
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 41 extern "C" {
AnnaBridge 189:f392fc9709a3 42 #endif
AnnaBridge 189:f392fc9709a3 43
AnnaBridge 189:f392fc9709a3 44 /* Includes ------------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 45 #include "stm32l4xx_hal_def.h"
AnnaBridge 189:f392fc9709a3 46
AnnaBridge 189:f392fc9709a3 47 /** @addtogroup STM32L4xx_HAL_Driver
AnnaBridge 189:f392fc9709a3 48 * @{
AnnaBridge 189:f392fc9709a3 49 */
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /** @addtogroup I2C
AnnaBridge 189:f392fc9709a3 52 * @{
AnnaBridge 189:f392fc9709a3 53 */
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /* Exported types ------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 56 /** @defgroup I2C_Exported_Types I2C Exported Types
AnnaBridge 189:f392fc9709a3 57 * @{
AnnaBridge 189:f392fc9709a3 58 */
AnnaBridge 189:f392fc9709a3 59
AnnaBridge 189:f392fc9709a3 60 /** @defgroup I2C_Configuration_Structure_definition I2C Configuration Structure definition
AnnaBridge 189:f392fc9709a3 61 * @brief I2C Configuration Structure definition
AnnaBridge 189:f392fc9709a3 62 * @{
AnnaBridge 189:f392fc9709a3 63 */
AnnaBridge 189:f392fc9709a3 64 typedef struct
AnnaBridge 189:f392fc9709a3 65 {
AnnaBridge 189:f392fc9709a3 66 uint32_t Timing; /*!< Specifies the I2C_TIMINGR_register value.
AnnaBridge 189:f392fc9709a3 67 This parameter calculated by referring to I2C initialization
AnnaBridge 189:f392fc9709a3 68 section in Reference manual */
AnnaBridge 189:f392fc9709a3 69
AnnaBridge 189:f392fc9709a3 70 uint32_t OwnAddress1; /*!< Specifies the first device own address.
AnnaBridge 189:f392fc9709a3 71 This parameter can be a 7-bit or 10-bit address. */
AnnaBridge 189:f392fc9709a3 72
AnnaBridge 189:f392fc9709a3 73 uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
AnnaBridge 189:f392fc9709a3 74 This parameter can be a value of @ref I2C_ADDRESSING_MODE */
AnnaBridge 189:f392fc9709a3 75
AnnaBridge 189:f392fc9709a3 76 uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
AnnaBridge 189:f392fc9709a3 77 This parameter can be a value of @ref I2C_DUAL_ADDRESSING_MODE */
AnnaBridge 189:f392fc9709a3 78
AnnaBridge 189:f392fc9709a3 79 uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
AnnaBridge 189:f392fc9709a3 80 This parameter can be a 7-bit address. */
AnnaBridge 189:f392fc9709a3 81
AnnaBridge 189:f392fc9709a3 82 uint32_t OwnAddress2Masks; /*!< Specifies the acknowledge mask address second device own address if dual addressing mode is selected
AnnaBridge 189:f392fc9709a3 83 This parameter can be a value of @ref I2C_OWN_ADDRESS2_MASKS */
AnnaBridge 189:f392fc9709a3 84
AnnaBridge 189:f392fc9709a3 85 uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
AnnaBridge 189:f392fc9709a3 86 This parameter can be a value of @ref I2C_GENERAL_CALL_ADDRESSING_MODE */
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
AnnaBridge 189:f392fc9709a3 89 This parameter can be a value of @ref I2C_NOSTRETCH_MODE */
AnnaBridge 189:f392fc9709a3 90
AnnaBridge 189:f392fc9709a3 91 } I2C_InitTypeDef;
AnnaBridge 189:f392fc9709a3 92
AnnaBridge 189:f392fc9709a3 93 /**
AnnaBridge 189:f392fc9709a3 94 * @}
AnnaBridge 189:f392fc9709a3 95 */
AnnaBridge 189:f392fc9709a3 96
AnnaBridge 189:f392fc9709a3 97 /** @defgroup HAL_state_structure_definition HAL state structure definition
AnnaBridge 189:f392fc9709a3 98 * @brief HAL State structure definition
AnnaBridge 189:f392fc9709a3 99 * @note HAL I2C State value coding follow below described bitmap :\n
AnnaBridge 189:f392fc9709a3 100 * b7-b6 Error information\n
AnnaBridge 189:f392fc9709a3 101 * 00 : No Error\n
AnnaBridge 189:f392fc9709a3 102 * 01 : Abort (Abort user request on going)\n
AnnaBridge 189:f392fc9709a3 103 * 10 : Timeout\n
AnnaBridge 189:f392fc9709a3 104 * 11 : Error\n
AnnaBridge 189:f392fc9709a3 105 * b5 IP initilisation status\n
AnnaBridge 189:f392fc9709a3 106 * 0 : Reset (IP not initialized)\n
AnnaBridge 189:f392fc9709a3 107 * 1 : Init done (IP initialized and ready to use. HAL I2C Init function called)\n
AnnaBridge 189:f392fc9709a3 108 * b4 (not used)\n
AnnaBridge 189:f392fc9709a3 109 * x : Should be set to 0\n
AnnaBridge 189:f392fc9709a3 110 * b3\n
AnnaBridge 189:f392fc9709a3 111 * 0 : Ready or Busy (No Listen mode ongoing)\n
AnnaBridge 189:f392fc9709a3 112 * 1 : Listen (IP in Address Listen Mode)\n
AnnaBridge 189:f392fc9709a3 113 * b2 Intrinsic process state\n
AnnaBridge 189:f392fc9709a3 114 * 0 : Ready\n
AnnaBridge 189:f392fc9709a3 115 * 1 : Busy (IP busy with some configuration or internal operations)\n
AnnaBridge 189:f392fc9709a3 116 * b1 Rx state\n
AnnaBridge 189:f392fc9709a3 117 * 0 : Ready (no Rx operation ongoing)\n
AnnaBridge 189:f392fc9709a3 118 * 1 : Busy (Rx operation ongoing)\n
AnnaBridge 189:f392fc9709a3 119 * b0 Tx state\n
AnnaBridge 189:f392fc9709a3 120 * 0 : Ready (no Tx operation ongoing)\n
AnnaBridge 189:f392fc9709a3 121 * 1 : Busy (Tx operation ongoing)
AnnaBridge 189:f392fc9709a3 122 * @{
AnnaBridge 189:f392fc9709a3 123 */
AnnaBridge 189:f392fc9709a3 124 typedef enum
AnnaBridge 189:f392fc9709a3 125 {
AnnaBridge 189:f392fc9709a3 126 HAL_I2C_STATE_RESET = 0x00U, /*!< Peripheral is not yet Initialized */
AnnaBridge 189:f392fc9709a3 127 HAL_I2C_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use */
AnnaBridge 189:f392fc9709a3 128 HAL_I2C_STATE_BUSY = 0x24U, /*!< An internal process is ongoing */
AnnaBridge 189:f392fc9709a3 129 HAL_I2C_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing */
AnnaBridge 189:f392fc9709a3 130 HAL_I2C_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
AnnaBridge 189:f392fc9709a3 131 HAL_I2C_STATE_LISTEN = 0x28U, /*!< Address Listen Mode is ongoing */
AnnaBridge 189:f392fc9709a3 132 HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U, /*!< Address Listen Mode and Data Transmission
AnnaBridge 189:f392fc9709a3 133 process is ongoing */
AnnaBridge 189:f392fc9709a3 134 HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU, /*!< Address Listen Mode and Data Reception
AnnaBridge 189:f392fc9709a3 135 process is ongoing */
AnnaBridge 189:f392fc9709a3 136 HAL_I2C_STATE_ABORT = 0x60U, /*!< Abort user request ongoing */
AnnaBridge 189:f392fc9709a3 137 HAL_I2C_STATE_TIMEOUT = 0xA0U, /*!< Timeout state */
AnnaBridge 189:f392fc9709a3 138 HAL_I2C_STATE_ERROR = 0xE0U /*!< Error */
AnnaBridge 189:f392fc9709a3 139
AnnaBridge 189:f392fc9709a3 140 } HAL_I2C_StateTypeDef;
AnnaBridge 189:f392fc9709a3 141
AnnaBridge 189:f392fc9709a3 142 /**
AnnaBridge 189:f392fc9709a3 143 * @}
AnnaBridge 189:f392fc9709a3 144 */
AnnaBridge 189:f392fc9709a3 145
AnnaBridge 189:f392fc9709a3 146 /** @defgroup HAL_mode_structure_definition HAL mode structure definition
AnnaBridge 189:f392fc9709a3 147 * @brief HAL Mode structure definition
AnnaBridge 189:f392fc9709a3 148 * @note HAL I2C Mode value coding follow below described bitmap :\n
AnnaBridge 189:f392fc9709a3 149 * b7 (not used)\n
AnnaBridge 189:f392fc9709a3 150 * x : Should be set to 0\n
AnnaBridge 189:f392fc9709a3 151 * b6\n
AnnaBridge 189:f392fc9709a3 152 * 0 : None\n
AnnaBridge 189:f392fc9709a3 153 * 1 : Memory (HAL I2C communication is in Memory Mode)\n
AnnaBridge 189:f392fc9709a3 154 * b5\n
AnnaBridge 189:f392fc9709a3 155 * 0 : None\n
AnnaBridge 189:f392fc9709a3 156 * 1 : Slave (HAL I2C communication is in Slave Mode)\n
AnnaBridge 189:f392fc9709a3 157 * b4\n
AnnaBridge 189:f392fc9709a3 158 * 0 : None\n
AnnaBridge 189:f392fc9709a3 159 * 1 : Master (HAL I2C communication is in Master Mode)\n
AnnaBridge 189:f392fc9709a3 160 * b3-b2-b1-b0 (not used)\n
AnnaBridge 189:f392fc9709a3 161 * xxxx : Should be set to 0000
AnnaBridge 189:f392fc9709a3 162 * @{
AnnaBridge 189:f392fc9709a3 163 */
AnnaBridge 189:f392fc9709a3 164 typedef enum
AnnaBridge 189:f392fc9709a3 165 {
AnnaBridge 189:f392fc9709a3 166 HAL_I2C_MODE_NONE = 0x00U, /*!< No I2C communication on going */
AnnaBridge 189:f392fc9709a3 167 HAL_I2C_MODE_MASTER = 0x10U, /*!< I2C communication is in Master Mode */
AnnaBridge 189:f392fc9709a3 168 HAL_I2C_MODE_SLAVE = 0x20U, /*!< I2C communication is in Slave Mode */
AnnaBridge 189:f392fc9709a3 169 HAL_I2C_MODE_MEM = 0x40U /*!< I2C communication is in Memory Mode */
AnnaBridge 189:f392fc9709a3 170
AnnaBridge 189:f392fc9709a3 171 } HAL_I2C_ModeTypeDef;
AnnaBridge 189:f392fc9709a3 172
AnnaBridge 189:f392fc9709a3 173 /**
AnnaBridge 189:f392fc9709a3 174 * @}
AnnaBridge 189:f392fc9709a3 175 */
AnnaBridge 189:f392fc9709a3 176
AnnaBridge 189:f392fc9709a3 177 /** @defgroup I2C_Error_Code_definition I2C Error Code definition
AnnaBridge 189:f392fc9709a3 178 * @brief I2C Error Code definition
AnnaBridge 189:f392fc9709a3 179 * @{
AnnaBridge 189:f392fc9709a3 180 */
AnnaBridge 189:f392fc9709a3 181 #define HAL_I2C_ERROR_NONE (0x00000000U) /*!< No error */
AnnaBridge 189:f392fc9709a3 182 #define HAL_I2C_ERROR_BERR (0x00000001U) /*!< BERR error */
AnnaBridge 189:f392fc9709a3 183 #define HAL_I2C_ERROR_ARLO (0x00000002U) /*!< ARLO error */
AnnaBridge 189:f392fc9709a3 184 #define HAL_I2C_ERROR_AF (0x00000004U) /*!< ACKF error */
AnnaBridge 189:f392fc9709a3 185 #define HAL_I2C_ERROR_OVR (0x00000008U) /*!< OVR error */
AnnaBridge 189:f392fc9709a3 186 #define HAL_I2C_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
AnnaBridge 189:f392fc9709a3 187 #define HAL_I2C_ERROR_TIMEOUT (0x00000020U) /*!< Timeout error */
AnnaBridge 189:f392fc9709a3 188 #define HAL_I2C_ERROR_SIZE (0x00000040U) /*!< Size Management error */
AnnaBridge 189:f392fc9709a3 189 /**
AnnaBridge 189:f392fc9709a3 190 * @}
AnnaBridge 189:f392fc9709a3 191 */
AnnaBridge 189:f392fc9709a3 192
AnnaBridge 189:f392fc9709a3 193 /** @defgroup I2C_handle_Structure_definition I2C handle Structure definition
AnnaBridge 189:f392fc9709a3 194 * @brief I2C handle Structure definition
AnnaBridge 189:f392fc9709a3 195 * @{
AnnaBridge 189:f392fc9709a3 196 */
AnnaBridge 189:f392fc9709a3 197 typedef struct __I2C_HandleTypeDef
AnnaBridge 189:f392fc9709a3 198 {
AnnaBridge 189:f392fc9709a3 199 I2C_TypeDef *Instance; /*!< I2C registers base address */
AnnaBridge 189:f392fc9709a3 200
AnnaBridge 189:f392fc9709a3 201 I2C_InitTypeDef Init; /*!< I2C communication parameters */
AnnaBridge 189:f392fc9709a3 202
AnnaBridge 189:f392fc9709a3 203 uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
AnnaBridge 189:f392fc9709a3 204
AnnaBridge 189:f392fc9709a3 205 uint16_t XferSize; /*!< I2C transfer size */
AnnaBridge 189:f392fc9709a3 206
AnnaBridge 189:f392fc9709a3 207 __IO uint16_t XferCount; /*!< I2C transfer counter */
AnnaBridge 189:f392fc9709a3 208
AnnaBridge 189:f392fc9709a3 209 __IO uint32_t XferOptions; /*!< I2C sequantial transfer options, this parameter can
AnnaBridge 189:f392fc9709a3 210 be a value of @ref I2C_XFEROPTIONS */
AnnaBridge 189:f392fc9709a3 211
AnnaBridge 189:f392fc9709a3 212 __IO uint32_t PreviousState; /*!< I2C communication Previous state */
AnnaBridge 189:f392fc9709a3 213
AnnaBridge 189:f392fc9709a3 214 HAL_StatusTypeDef(*XferISR)(struct __I2C_HandleTypeDef *hi2c, uint32_t ITFlags, uint32_t ITSources); /*!< I2C transfer IRQ handler function pointer */
AnnaBridge 189:f392fc9709a3 215
AnnaBridge 189:f392fc9709a3 216 DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
AnnaBridge 189:f392fc9709a3 217
AnnaBridge 189:f392fc9709a3 218 DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
AnnaBridge 189:f392fc9709a3 219
AnnaBridge 189:f392fc9709a3 220 HAL_LockTypeDef Lock; /*!< I2C locking object */
AnnaBridge 189:f392fc9709a3 221
AnnaBridge 189:f392fc9709a3 222 __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
AnnaBridge 189:f392fc9709a3 223
AnnaBridge 189:f392fc9709a3 224 __IO HAL_I2C_ModeTypeDef Mode; /*!< I2C communication mode */
AnnaBridge 189:f392fc9709a3 225
AnnaBridge 189:f392fc9709a3 226 __IO uint32_t ErrorCode; /*!< I2C Error code */
AnnaBridge 189:f392fc9709a3 227
AnnaBridge 189:f392fc9709a3 228 __IO uint32_t AddrEventCount; /*!< I2C Address Event counter */
AnnaBridge 189:f392fc9709a3 229 } I2C_HandleTypeDef;
AnnaBridge 189:f392fc9709a3 230 /**
AnnaBridge 189:f392fc9709a3 231 * @}
AnnaBridge 189:f392fc9709a3 232 */
AnnaBridge 189:f392fc9709a3 233
AnnaBridge 189:f392fc9709a3 234 /**
AnnaBridge 189:f392fc9709a3 235 * @}
AnnaBridge 189:f392fc9709a3 236 */
AnnaBridge 189:f392fc9709a3 237 /* Exported constants --------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 238
AnnaBridge 189:f392fc9709a3 239 /** @defgroup I2C_Exported_Constants I2C Exported Constants
AnnaBridge 189:f392fc9709a3 240 * @{
AnnaBridge 189:f392fc9709a3 241 */
AnnaBridge 189:f392fc9709a3 242
AnnaBridge 189:f392fc9709a3 243 /** @defgroup I2C_XFEROPTIONS I2C Sequential Transfer Options
AnnaBridge 189:f392fc9709a3 244 * @{
AnnaBridge 189:f392fc9709a3 245 */
AnnaBridge 189:f392fc9709a3 246 #define I2C_FIRST_FRAME ((uint32_t)I2C_SOFTEND_MODE)
AnnaBridge 189:f392fc9709a3 247 #define I2C_FIRST_AND_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE))
AnnaBridge 189:f392fc9709a3 248 #define I2C_NEXT_FRAME ((uint32_t)(I2C_RELOAD_MODE | I2C_SOFTEND_MODE))
AnnaBridge 189:f392fc9709a3 249 #define I2C_FIRST_AND_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
AnnaBridge 189:f392fc9709a3 250 #define I2C_LAST_FRAME ((uint32_t)I2C_AUTOEND_MODE)
AnnaBridge 189:f392fc9709a3 251 /**
AnnaBridge 189:f392fc9709a3 252 * @}
AnnaBridge 189:f392fc9709a3 253 */
AnnaBridge 189:f392fc9709a3 254
AnnaBridge 189:f392fc9709a3 255 /** @defgroup I2C_ADDRESSING_MODE I2C Addressing Mode
AnnaBridge 189:f392fc9709a3 256 * @{
AnnaBridge 189:f392fc9709a3 257 */
AnnaBridge 189:f392fc9709a3 258 #define I2C_ADDRESSINGMODE_7BIT (0x00000001U)
AnnaBridge 189:f392fc9709a3 259 #define I2C_ADDRESSINGMODE_10BIT (0x00000002U)
AnnaBridge 189:f392fc9709a3 260 /**
AnnaBridge 189:f392fc9709a3 261 * @}
AnnaBridge 189:f392fc9709a3 262 */
AnnaBridge 189:f392fc9709a3 263
AnnaBridge 189:f392fc9709a3 264 /** @defgroup I2C_DUAL_ADDRESSING_MODE I2C Dual Addressing Mode
AnnaBridge 189:f392fc9709a3 265 * @{
AnnaBridge 189:f392fc9709a3 266 */
AnnaBridge 189:f392fc9709a3 267 #define I2C_DUALADDRESS_DISABLE (0x00000000U)
AnnaBridge 189:f392fc9709a3 268 #define I2C_DUALADDRESS_ENABLE I2C_OAR2_OA2EN
AnnaBridge 189:f392fc9709a3 269 /**
AnnaBridge 189:f392fc9709a3 270 * @}
AnnaBridge 189:f392fc9709a3 271 */
AnnaBridge 189:f392fc9709a3 272
AnnaBridge 189:f392fc9709a3 273 /** @defgroup I2C_OWN_ADDRESS2_MASKS I2C Own Address2 Masks
AnnaBridge 189:f392fc9709a3 274 * @{
AnnaBridge 189:f392fc9709a3 275 */
AnnaBridge 189:f392fc9709a3 276 #define I2C_OA2_NOMASK ((uint8_t)0x00U)
AnnaBridge 189:f392fc9709a3 277 #define I2C_OA2_MASK01 ((uint8_t)0x01U)
AnnaBridge 189:f392fc9709a3 278 #define I2C_OA2_MASK02 ((uint8_t)0x02U)
AnnaBridge 189:f392fc9709a3 279 #define I2C_OA2_MASK03 ((uint8_t)0x03U)
AnnaBridge 189:f392fc9709a3 280 #define I2C_OA2_MASK04 ((uint8_t)0x04U)
AnnaBridge 189:f392fc9709a3 281 #define I2C_OA2_MASK05 ((uint8_t)0x05U)
AnnaBridge 189:f392fc9709a3 282 #define I2C_OA2_MASK06 ((uint8_t)0x06U)
AnnaBridge 189:f392fc9709a3 283 #define I2C_OA2_MASK07 ((uint8_t)0x07U)
AnnaBridge 189:f392fc9709a3 284 /**
AnnaBridge 189:f392fc9709a3 285 * @}
AnnaBridge 189:f392fc9709a3 286 */
AnnaBridge 189:f392fc9709a3 287
AnnaBridge 189:f392fc9709a3 288 /** @defgroup I2C_GENERAL_CALL_ADDRESSING_MODE I2C General Call Addressing Mode
AnnaBridge 189:f392fc9709a3 289 * @{
AnnaBridge 189:f392fc9709a3 290 */
AnnaBridge 189:f392fc9709a3 291 #define I2C_GENERALCALL_DISABLE (0x00000000U)
AnnaBridge 189:f392fc9709a3 292 #define I2C_GENERALCALL_ENABLE I2C_CR1_GCEN
AnnaBridge 189:f392fc9709a3 293 /**
AnnaBridge 189:f392fc9709a3 294 * @}
AnnaBridge 189:f392fc9709a3 295 */
AnnaBridge 189:f392fc9709a3 296
AnnaBridge 189:f392fc9709a3 297 /** @defgroup I2C_NOSTRETCH_MODE I2C No-Stretch Mode
AnnaBridge 189:f392fc9709a3 298 * @{
AnnaBridge 189:f392fc9709a3 299 */
AnnaBridge 189:f392fc9709a3 300 #define I2C_NOSTRETCH_DISABLE (0x00000000U)
AnnaBridge 189:f392fc9709a3 301 #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
AnnaBridge 189:f392fc9709a3 302 /**
AnnaBridge 189:f392fc9709a3 303 * @}
AnnaBridge 189:f392fc9709a3 304 */
AnnaBridge 189:f392fc9709a3 305
AnnaBridge 189:f392fc9709a3 306 /** @defgroup I2C_MEMORY_ADDRESS_SIZE I2C Memory Address Size
AnnaBridge 189:f392fc9709a3 307 * @{
AnnaBridge 189:f392fc9709a3 308 */
AnnaBridge 189:f392fc9709a3 309 #define I2C_MEMADD_SIZE_8BIT (0x00000001U)
AnnaBridge 189:f392fc9709a3 310 #define I2C_MEMADD_SIZE_16BIT (0x00000002U)
AnnaBridge 189:f392fc9709a3 311 /**
AnnaBridge 189:f392fc9709a3 312 * @}
AnnaBridge 189:f392fc9709a3 313 */
AnnaBridge 189:f392fc9709a3 314
AnnaBridge 189:f392fc9709a3 315 /** @defgroup I2C_XFERDIRECTION I2C Transfer Direction Master Point of View
AnnaBridge 189:f392fc9709a3 316 * @{
AnnaBridge 189:f392fc9709a3 317 */
AnnaBridge 189:f392fc9709a3 318 #define I2C_DIRECTION_TRANSMIT (0x00000000U)
AnnaBridge 189:f392fc9709a3 319 #define I2C_DIRECTION_RECEIVE (0x00000001U)
AnnaBridge 189:f392fc9709a3 320 /**
AnnaBridge 189:f392fc9709a3 321 * @}
AnnaBridge 189:f392fc9709a3 322 */
AnnaBridge 189:f392fc9709a3 323
AnnaBridge 189:f392fc9709a3 324 /** @defgroup I2C_RELOAD_END_MODE I2C Reload End Mode
AnnaBridge 189:f392fc9709a3 325 * @{
AnnaBridge 189:f392fc9709a3 326 */
AnnaBridge 189:f392fc9709a3 327 #define I2C_RELOAD_MODE I2C_CR2_RELOAD
AnnaBridge 189:f392fc9709a3 328 #define I2C_AUTOEND_MODE I2C_CR2_AUTOEND
AnnaBridge 189:f392fc9709a3 329 #define I2C_SOFTEND_MODE (0x00000000U)
AnnaBridge 189:f392fc9709a3 330 /**
AnnaBridge 189:f392fc9709a3 331 * @}
AnnaBridge 189:f392fc9709a3 332 */
AnnaBridge 189:f392fc9709a3 333
AnnaBridge 189:f392fc9709a3 334 /** @defgroup I2C_START_STOP_MODE I2C Start or Stop Mode
AnnaBridge 189:f392fc9709a3 335 * @{
AnnaBridge 189:f392fc9709a3 336 */
AnnaBridge 189:f392fc9709a3 337 #define I2C_NO_STARTSTOP (0x00000000U)
AnnaBridge 189:f392fc9709a3 338 #define I2C_GENERATE_STOP (uint32_t)(0x80000000U | I2C_CR2_STOP)
AnnaBridge 189:f392fc9709a3 339 #define I2C_GENERATE_START_READ (uint32_t)(0x80000000U | I2C_CR2_START | I2C_CR2_RD_WRN)
AnnaBridge 189:f392fc9709a3 340 #define I2C_GENERATE_START_WRITE (uint32_t)(0x80000000U | I2C_CR2_START)
AnnaBridge 189:f392fc9709a3 341 /**
AnnaBridge 189:f392fc9709a3 342 * @}
AnnaBridge 189:f392fc9709a3 343 */
AnnaBridge 189:f392fc9709a3 344
AnnaBridge 189:f392fc9709a3 345 /** @defgroup I2C_Interrupt_configuration_definition I2C Interrupt configuration definition
AnnaBridge 189:f392fc9709a3 346 * @brief I2C Interrupt definition
AnnaBridge 189:f392fc9709a3 347 * Elements values convention: 0xXXXXXXXX
AnnaBridge 189:f392fc9709a3 348 * - XXXXXXXX : Interrupt control mask
AnnaBridge 189:f392fc9709a3 349 * @{
AnnaBridge 189:f392fc9709a3 350 */
AnnaBridge 189:f392fc9709a3 351 #define I2C_IT_ERRI I2C_CR1_ERRIE
AnnaBridge 189:f392fc9709a3 352 #define I2C_IT_TCI I2C_CR1_TCIE
AnnaBridge 189:f392fc9709a3 353 #define I2C_IT_STOPI I2C_CR1_STOPIE
AnnaBridge 189:f392fc9709a3 354 #define I2C_IT_NACKI I2C_CR1_NACKIE
AnnaBridge 189:f392fc9709a3 355 #define I2C_IT_ADDRI I2C_CR1_ADDRIE
AnnaBridge 189:f392fc9709a3 356 #define I2C_IT_RXI I2C_CR1_RXIE
AnnaBridge 189:f392fc9709a3 357 #define I2C_IT_TXI I2C_CR1_TXIE
AnnaBridge 189:f392fc9709a3 358 /**
AnnaBridge 189:f392fc9709a3 359 * @}
AnnaBridge 189:f392fc9709a3 360 */
AnnaBridge 189:f392fc9709a3 361
AnnaBridge 189:f392fc9709a3 362 /** @defgroup I2C_Flag_definition I2C Flag definition
AnnaBridge 189:f392fc9709a3 363 * @{
AnnaBridge 189:f392fc9709a3 364 */
AnnaBridge 189:f392fc9709a3 365 #define I2C_FLAG_TXE I2C_ISR_TXE
AnnaBridge 189:f392fc9709a3 366 #define I2C_FLAG_TXIS I2C_ISR_TXIS
AnnaBridge 189:f392fc9709a3 367 #define I2C_FLAG_RXNE I2C_ISR_RXNE
AnnaBridge 189:f392fc9709a3 368 #define I2C_FLAG_ADDR I2C_ISR_ADDR
AnnaBridge 189:f392fc9709a3 369 #define I2C_FLAG_AF I2C_ISR_NACKF
AnnaBridge 189:f392fc9709a3 370 #define I2C_FLAG_STOPF I2C_ISR_STOPF
AnnaBridge 189:f392fc9709a3 371 #define I2C_FLAG_TC I2C_ISR_TC
AnnaBridge 189:f392fc9709a3 372 #define I2C_FLAG_TCR I2C_ISR_TCR
AnnaBridge 189:f392fc9709a3 373 #define I2C_FLAG_BERR I2C_ISR_BERR
AnnaBridge 189:f392fc9709a3 374 #define I2C_FLAG_ARLO I2C_ISR_ARLO
AnnaBridge 189:f392fc9709a3 375 #define I2C_FLAG_OVR I2C_ISR_OVR
AnnaBridge 189:f392fc9709a3 376 #define I2C_FLAG_PECERR I2C_ISR_PECERR
AnnaBridge 189:f392fc9709a3 377 #define I2C_FLAG_TIMEOUT I2C_ISR_TIMEOUT
AnnaBridge 189:f392fc9709a3 378 #define I2C_FLAG_ALERT I2C_ISR_ALERT
AnnaBridge 189:f392fc9709a3 379 #define I2C_FLAG_BUSY I2C_ISR_BUSY
AnnaBridge 189:f392fc9709a3 380 #define I2C_FLAG_DIR I2C_ISR_DIR
AnnaBridge 189:f392fc9709a3 381 /**
AnnaBridge 189:f392fc9709a3 382 * @}
AnnaBridge 189:f392fc9709a3 383 */
AnnaBridge 189:f392fc9709a3 384
AnnaBridge 189:f392fc9709a3 385 /**
AnnaBridge 189:f392fc9709a3 386 * @}
AnnaBridge 189:f392fc9709a3 387 */
AnnaBridge 189:f392fc9709a3 388
AnnaBridge 189:f392fc9709a3 389 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 390
AnnaBridge 189:f392fc9709a3 391 /** @defgroup I2C_Exported_Macros I2C Exported Macros
AnnaBridge 189:f392fc9709a3 392 * @{
AnnaBridge 189:f392fc9709a3 393 */
AnnaBridge 189:f392fc9709a3 394
AnnaBridge 189:f392fc9709a3 395 /** @brief Reset I2C handle state.
AnnaBridge 189:f392fc9709a3 396 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 397 * @retval None
AnnaBridge 189:f392fc9709a3 398 */
AnnaBridge 189:f392fc9709a3 399 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
AnnaBridge 189:f392fc9709a3 400
AnnaBridge 189:f392fc9709a3 401 /** @brief Enable the specified I2C interrupt.
AnnaBridge 189:f392fc9709a3 402 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 403 * @param __INTERRUPT__ specifies the interrupt source to enable.
AnnaBridge 189:f392fc9709a3 404 * This parameter can be one of the following values:
AnnaBridge 189:f392fc9709a3 405 * @arg @ref I2C_IT_ERRI Errors interrupt enable
AnnaBridge 189:f392fc9709a3 406 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
AnnaBridge 189:f392fc9709a3 407 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
AnnaBridge 189:f392fc9709a3 408 * @arg @ref I2C_IT_NACKI NACK received interrupt enable
AnnaBridge 189:f392fc9709a3 409 * @arg @ref I2C_IT_ADDRI Address match interrupt enable
AnnaBridge 189:f392fc9709a3 410 * @arg @ref I2C_IT_RXI RX interrupt enable
AnnaBridge 189:f392fc9709a3 411 * @arg @ref I2C_IT_TXI TX interrupt enable
AnnaBridge 189:f392fc9709a3 412 *
AnnaBridge 189:f392fc9709a3 413 * @retval None
AnnaBridge 189:f392fc9709a3 414 */
AnnaBridge 189:f392fc9709a3 415 #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 |= (__INTERRUPT__))
AnnaBridge 189:f392fc9709a3 416
AnnaBridge 189:f392fc9709a3 417 /** @brief Disable the specified I2C interrupt.
AnnaBridge 189:f392fc9709a3 418 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 419 * @param __INTERRUPT__ specifies the interrupt source to disable.
AnnaBridge 189:f392fc9709a3 420 * This parameter can be one of the following values:
AnnaBridge 189:f392fc9709a3 421 * @arg @ref I2C_IT_ERRI Errors interrupt enable
AnnaBridge 189:f392fc9709a3 422 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
AnnaBridge 189:f392fc9709a3 423 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
AnnaBridge 189:f392fc9709a3 424 * @arg @ref I2C_IT_NACKI NACK received interrupt enable
AnnaBridge 189:f392fc9709a3 425 * @arg @ref I2C_IT_ADDRI Address match interrupt enable
AnnaBridge 189:f392fc9709a3 426 * @arg @ref I2C_IT_RXI RX interrupt enable
AnnaBridge 189:f392fc9709a3 427 * @arg @ref I2C_IT_TXI TX interrupt enable
AnnaBridge 189:f392fc9709a3 428 *
AnnaBridge 189:f392fc9709a3 429 * @retval None
AnnaBridge 189:f392fc9709a3 430 */
AnnaBridge 189:f392fc9709a3 431 #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))
AnnaBridge 189:f392fc9709a3 432
AnnaBridge 189:f392fc9709a3 433 /** @brief Check whether the specified I2C interrupt source is enabled or not.
AnnaBridge 189:f392fc9709a3 434 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 435 * @param __INTERRUPT__ specifies the I2C interrupt source to check.
AnnaBridge 189:f392fc9709a3 436 * This parameter can be one of the following values:
AnnaBridge 189:f392fc9709a3 437 * @arg @ref I2C_IT_ERRI Errors interrupt enable
AnnaBridge 189:f392fc9709a3 438 * @arg @ref I2C_IT_TCI Transfer complete interrupt enable
AnnaBridge 189:f392fc9709a3 439 * @arg @ref I2C_IT_STOPI STOP detection interrupt enable
AnnaBridge 189:f392fc9709a3 440 * @arg @ref I2C_IT_NACKI NACK received interrupt enable
AnnaBridge 189:f392fc9709a3 441 * @arg @ref I2C_IT_ADDRI Address match interrupt enable
AnnaBridge 189:f392fc9709a3 442 * @arg @ref I2C_IT_RXI RX interrupt enable
AnnaBridge 189:f392fc9709a3 443 * @arg @ref I2C_IT_TXI TX interrupt enable
AnnaBridge 189:f392fc9709a3 444 *
AnnaBridge 189:f392fc9709a3 445 * @retval The new state of __INTERRUPT__ (SET or RESET).
AnnaBridge 189:f392fc9709a3 446 */
AnnaBridge 189:f392fc9709a3 447 #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
AnnaBridge 189:f392fc9709a3 448
AnnaBridge 189:f392fc9709a3 449 /** @brief Check whether the specified I2C flag is set or not.
AnnaBridge 189:f392fc9709a3 450 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 451 * @param __FLAG__ specifies the flag to check.
AnnaBridge 189:f392fc9709a3 452 * This parameter can be one of the following values:
AnnaBridge 189:f392fc9709a3 453 * @arg @ref I2C_FLAG_TXE Transmit data register empty
AnnaBridge 189:f392fc9709a3 454 * @arg @ref I2C_FLAG_TXIS Transmit interrupt status
AnnaBridge 189:f392fc9709a3 455 * @arg @ref I2C_FLAG_RXNE Receive data register not empty
AnnaBridge 189:f392fc9709a3 456 * @arg @ref I2C_FLAG_ADDR Address matched (slave mode)
AnnaBridge 189:f392fc9709a3 457 * @arg @ref I2C_FLAG_AF Acknowledge failure received flag
AnnaBridge 189:f392fc9709a3 458 * @arg @ref I2C_FLAG_STOPF STOP detection flag
AnnaBridge 189:f392fc9709a3 459 * @arg @ref I2C_FLAG_TC Transfer complete (master mode)
AnnaBridge 189:f392fc9709a3 460 * @arg @ref I2C_FLAG_TCR Transfer complete reload
AnnaBridge 189:f392fc9709a3 461 * @arg @ref I2C_FLAG_BERR Bus error
AnnaBridge 189:f392fc9709a3 462 * @arg @ref I2C_FLAG_ARLO Arbitration lost
AnnaBridge 189:f392fc9709a3 463 * @arg @ref I2C_FLAG_OVR Overrun/Underrun
AnnaBridge 189:f392fc9709a3 464 * @arg @ref I2C_FLAG_PECERR PEC error in reception
AnnaBridge 189:f392fc9709a3 465 * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag
AnnaBridge 189:f392fc9709a3 466 * @arg @ref I2C_FLAG_ALERT SMBus alert
AnnaBridge 189:f392fc9709a3 467 * @arg @ref I2C_FLAG_BUSY Bus busy
AnnaBridge 189:f392fc9709a3 468 * @arg @ref I2C_FLAG_DIR Transfer direction (slave mode)
AnnaBridge 189:f392fc9709a3 469 *
AnnaBridge 189:f392fc9709a3 470 * @retval The new state of __FLAG__ (SET or RESET).
AnnaBridge 189:f392fc9709a3 471 */
AnnaBridge 189:f392fc9709a3 472 #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) == (__FLAG__)) ? SET : RESET)
AnnaBridge 189:f392fc9709a3 473
AnnaBridge 189:f392fc9709a3 474 /** @brief Clear the I2C pending flags which are cleared by writing 1 in a specific bit.
AnnaBridge 189:f392fc9709a3 475 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 476 * @param __FLAG__ specifies the flag to clear.
AnnaBridge 189:f392fc9709a3 477 * This parameter can be any combination of the following values:
AnnaBridge 189:f392fc9709a3 478 * @arg @ref I2C_FLAG_TXE Transmit data register empty
AnnaBridge 189:f392fc9709a3 479 * @arg @ref I2C_FLAG_ADDR Address matched (slave mode)
AnnaBridge 189:f392fc9709a3 480 * @arg @ref I2C_FLAG_AF Acknowledge failure received flag
AnnaBridge 189:f392fc9709a3 481 * @arg @ref I2C_FLAG_STOPF STOP detection flag
AnnaBridge 189:f392fc9709a3 482 * @arg @ref I2C_FLAG_BERR Bus error
AnnaBridge 189:f392fc9709a3 483 * @arg @ref I2C_FLAG_ARLO Arbitration lost
AnnaBridge 189:f392fc9709a3 484 * @arg @ref I2C_FLAG_OVR Overrun/Underrun
AnnaBridge 189:f392fc9709a3 485 * @arg @ref I2C_FLAG_PECERR PEC error in reception
AnnaBridge 189:f392fc9709a3 486 * @arg @ref I2C_FLAG_TIMEOUT Timeout or Tlow detection flag
AnnaBridge 189:f392fc9709a3 487 * @arg @ref I2C_FLAG_ALERT SMBus alert
AnnaBridge 189:f392fc9709a3 488 *
AnnaBridge 189:f392fc9709a3 489 * @retval None
AnnaBridge 189:f392fc9709a3 490 */
AnnaBridge 189:f392fc9709a3 491 #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) (((__FLAG__) == I2C_FLAG_TXE) ? ((__HANDLE__)->Instance->ISR |= (__FLAG__)) \
AnnaBridge 189:f392fc9709a3 492 : ((__HANDLE__)->Instance->ICR = (__FLAG__)))
AnnaBridge 189:f392fc9709a3 493
AnnaBridge 189:f392fc9709a3 494 /** @brief Enable the specified I2C peripheral.
AnnaBridge 189:f392fc9709a3 495 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 496 * @retval None
AnnaBridge 189:f392fc9709a3 497 */
AnnaBridge 189:f392fc9709a3 498 #define __HAL_I2C_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
AnnaBridge 189:f392fc9709a3 499
AnnaBridge 189:f392fc9709a3 500 /** @brief Disable the specified I2C peripheral.
AnnaBridge 189:f392fc9709a3 501 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 502 * @retval None
AnnaBridge 189:f392fc9709a3 503 */
AnnaBridge 189:f392fc9709a3 504 #define __HAL_I2C_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE))
AnnaBridge 189:f392fc9709a3 505
AnnaBridge 189:f392fc9709a3 506 /** @brief Generate a Non-Acknowledge I2C peripheral in Slave mode.
AnnaBridge 189:f392fc9709a3 507 * @param __HANDLE__ specifies the I2C Handle.
AnnaBridge 189:f392fc9709a3 508 * @retval None
AnnaBridge 189:f392fc9709a3 509 */
AnnaBridge 189:f392fc9709a3 510 #define __HAL_I2C_GENERATE_NACK(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR2, I2C_CR2_NACK))
AnnaBridge 189:f392fc9709a3 511 /**
AnnaBridge 189:f392fc9709a3 512 * @}
AnnaBridge 189:f392fc9709a3 513 */
AnnaBridge 189:f392fc9709a3 514
AnnaBridge 189:f392fc9709a3 515 /* Include I2C HAL Extended module */
AnnaBridge 189:f392fc9709a3 516 #include "stm32l4xx_hal_i2c_ex.h"
AnnaBridge 189:f392fc9709a3 517
AnnaBridge 189:f392fc9709a3 518 /* Exported functions --------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 519 /** @addtogroup I2C_Exported_Functions
AnnaBridge 189:f392fc9709a3 520 * @{
AnnaBridge 189:f392fc9709a3 521 */
AnnaBridge 189:f392fc9709a3 522
AnnaBridge 189:f392fc9709a3 523 /** @addtogroup I2C_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 189:f392fc9709a3 524 * @{
AnnaBridge 189:f392fc9709a3 525 */
AnnaBridge 189:f392fc9709a3 526 /* Initialization and de-initialization functions******************************/
AnnaBridge 189:f392fc9709a3 527 HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 528 HAL_StatusTypeDef HAL_I2C_DeInit(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 529 void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 530 void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 531 /**
AnnaBridge 189:f392fc9709a3 532 * @}
AnnaBridge 189:f392fc9709a3 533 */
AnnaBridge 189:f392fc9709a3 534
AnnaBridge 189:f392fc9709a3 535 /** @addtogroup I2C_Exported_Functions_Group2 Input and Output operation functions
AnnaBridge 189:f392fc9709a3 536 * @{
AnnaBridge 189:f392fc9709a3 537 */
AnnaBridge 189:f392fc9709a3 538 /* IO operation functions ****************************************************/
AnnaBridge 189:f392fc9709a3 539 /******* Blocking mode: Polling */
AnnaBridge 189:f392fc9709a3 540 HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 189:f392fc9709a3 541 HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 189:f392fc9709a3 542 HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 189:f392fc9709a3 543 HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 189:f392fc9709a3 544 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 189:f392fc9709a3 545 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 189:f392fc9709a3 546 HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
AnnaBridge 189:f392fc9709a3 547
AnnaBridge 189:f392fc9709a3 548 /******* Non-Blocking mode: Interrupt */
AnnaBridge 189:f392fc9709a3 549 HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 550 HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 551 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 552 HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 553 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 189:f392fc9709a3 554 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 189:f392fc9709a3 555
AnnaBridge 189:f392fc9709a3 556 HAL_StatusTypeDef HAL_I2C_Master_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 189:f392fc9709a3 557 HAL_StatusTypeDef HAL_I2C_Master_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 189:f392fc9709a3 558 HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 189:f392fc9709a3 559 HAL_StatusTypeDef HAL_I2C_Slave_Sequential_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
AnnaBridge 189:f392fc9709a3 560 HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 561 HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 562 HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
AnnaBridge 189:f392fc9709a3 563
AnnaBridge 189:f392fc9709a3 564 /******* Non-Blocking mode: DMA */
AnnaBridge 189:f392fc9709a3 565 HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 566 HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 567 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 568 HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
AnnaBridge 189:f392fc9709a3 569 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 189:f392fc9709a3 570 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 189:f392fc9709a3 571 /**
AnnaBridge 189:f392fc9709a3 572 * @}
AnnaBridge 189:f392fc9709a3 573 */
AnnaBridge 189:f392fc9709a3 574
AnnaBridge 189:f392fc9709a3 575 /** @addtogroup I2C_IRQ_Handler_and_Callbacks IRQ Handler and Callbacks
AnnaBridge 189:f392fc9709a3 576 * @{
AnnaBridge 189:f392fc9709a3 577 */
AnnaBridge 189:f392fc9709a3 578 /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
AnnaBridge 189:f392fc9709a3 579 void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 580 void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 581 void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 582 void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 583 void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 584 void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 585 void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
AnnaBridge 189:f392fc9709a3 586 void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 587 void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 588 void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 589 void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 590 void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 591 /**
AnnaBridge 189:f392fc9709a3 592 * @}
AnnaBridge 189:f392fc9709a3 593 */
AnnaBridge 189:f392fc9709a3 594
AnnaBridge 189:f392fc9709a3 595 /** @addtogroup I2C_Exported_Functions_Group3 Peripheral State, Mode and Error functions
AnnaBridge 189:f392fc9709a3 596 * @{
AnnaBridge 189:f392fc9709a3 597 */
AnnaBridge 189:f392fc9709a3 598 /* Peripheral State, Mode and Error functions *********************************/
AnnaBridge 189:f392fc9709a3 599 HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 600 HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 601 uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
AnnaBridge 189:f392fc9709a3 602
AnnaBridge 189:f392fc9709a3 603 /**
AnnaBridge 189:f392fc9709a3 604 * @}
AnnaBridge 189:f392fc9709a3 605 */
AnnaBridge 189:f392fc9709a3 606
AnnaBridge 189:f392fc9709a3 607 /**
AnnaBridge 189:f392fc9709a3 608 * @}
AnnaBridge 189:f392fc9709a3 609 */
AnnaBridge 189:f392fc9709a3 610
AnnaBridge 189:f392fc9709a3 611 /* Private constants ---------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 612 /** @defgroup I2C_Private_Constants I2C Private Constants
AnnaBridge 189:f392fc9709a3 613 * @{
AnnaBridge 189:f392fc9709a3 614 */
AnnaBridge 189:f392fc9709a3 615
AnnaBridge 189:f392fc9709a3 616 /**
AnnaBridge 189:f392fc9709a3 617 * @}
AnnaBridge 189:f392fc9709a3 618 */
AnnaBridge 189:f392fc9709a3 619
AnnaBridge 189:f392fc9709a3 620 /* Private macros ------------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 621 /** @defgroup I2C_Private_Macro I2C Private Macros
AnnaBridge 189:f392fc9709a3 622 * @{
AnnaBridge 189:f392fc9709a3 623 */
AnnaBridge 189:f392fc9709a3 624
AnnaBridge 189:f392fc9709a3 625 #define IS_I2C_ADDRESSING_MODE(MODE) (((MODE) == I2C_ADDRESSINGMODE_7BIT) || \
AnnaBridge 189:f392fc9709a3 626 ((MODE) == I2C_ADDRESSINGMODE_10BIT))
AnnaBridge 189:f392fc9709a3 627
AnnaBridge 189:f392fc9709a3 628 #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
AnnaBridge 189:f392fc9709a3 629 ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
AnnaBridge 189:f392fc9709a3 630
AnnaBridge 189:f392fc9709a3 631 #define IS_I2C_OWN_ADDRESS2_MASK(MASK) (((MASK) == I2C_OA2_NOMASK) || \
AnnaBridge 189:f392fc9709a3 632 ((MASK) == I2C_OA2_MASK01) || \
AnnaBridge 189:f392fc9709a3 633 ((MASK) == I2C_OA2_MASK02) || \
AnnaBridge 189:f392fc9709a3 634 ((MASK) == I2C_OA2_MASK03) || \
AnnaBridge 189:f392fc9709a3 635 ((MASK) == I2C_OA2_MASK04) || \
AnnaBridge 189:f392fc9709a3 636 ((MASK) == I2C_OA2_MASK05) || \
AnnaBridge 189:f392fc9709a3 637 ((MASK) == I2C_OA2_MASK06) || \
AnnaBridge 189:f392fc9709a3 638 ((MASK) == I2C_OA2_MASK07))
AnnaBridge 189:f392fc9709a3 639
AnnaBridge 189:f392fc9709a3 640 #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
AnnaBridge 189:f392fc9709a3 641 ((CALL) == I2C_GENERALCALL_ENABLE))
AnnaBridge 189:f392fc9709a3 642
AnnaBridge 189:f392fc9709a3 643 #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
AnnaBridge 189:f392fc9709a3 644 ((STRETCH) == I2C_NOSTRETCH_ENABLE))
AnnaBridge 189:f392fc9709a3 645
AnnaBridge 189:f392fc9709a3 646 #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
AnnaBridge 189:f392fc9709a3 647 ((SIZE) == I2C_MEMADD_SIZE_16BIT))
AnnaBridge 189:f392fc9709a3 648
AnnaBridge 189:f392fc9709a3 649 #define IS_TRANSFER_MODE(MODE) (((MODE) == I2C_RELOAD_MODE) || \
AnnaBridge 189:f392fc9709a3 650 ((MODE) == I2C_AUTOEND_MODE) || \
AnnaBridge 189:f392fc9709a3 651 ((MODE) == I2C_SOFTEND_MODE))
AnnaBridge 189:f392fc9709a3 652
AnnaBridge 189:f392fc9709a3 653 #define IS_TRANSFER_REQUEST(REQUEST) (((REQUEST) == I2C_GENERATE_STOP) || \
AnnaBridge 189:f392fc9709a3 654 ((REQUEST) == I2C_GENERATE_START_READ) || \
AnnaBridge 189:f392fc9709a3 655 ((REQUEST) == I2C_GENERATE_START_WRITE) || \
AnnaBridge 189:f392fc9709a3 656 ((REQUEST) == I2C_NO_STARTSTOP))
AnnaBridge 189:f392fc9709a3 657
AnnaBridge 189:f392fc9709a3 658 #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
AnnaBridge 189:f392fc9709a3 659 ((REQUEST) == I2C_FIRST_AND_NEXT_FRAME) || \
AnnaBridge 189:f392fc9709a3 660 ((REQUEST) == I2C_NEXT_FRAME) || \
AnnaBridge 189:f392fc9709a3 661 ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
AnnaBridge 189:f392fc9709a3 662 ((REQUEST) == I2C_LAST_FRAME))
AnnaBridge 189:f392fc9709a3 663
AnnaBridge 189:f392fc9709a3 664 #define I2C_RESET_CR2(__HANDLE__) ((__HANDLE__)->Instance->CR2 &= (uint32_t)~((uint32_t)(I2C_CR2_SADD | I2C_CR2_HEAD10R | I2C_CR2_NBYTES | I2C_CR2_RELOAD | I2C_CR2_RD_WRN)))
AnnaBridge 189:f392fc9709a3 665
AnnaBridge 189:f392fc9709a3 666 #define I2C_GET_ADDR_MATCH(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_ADDCODE) >> 16U)
AnnaBridge 189:f392fc9709a3 667 #define I2C_GET_DIR(__HANDLE__) (((__HANDLE__)->Instance->ISR & I2C_ISR_DIR) >> 16U)
AnnaBridge 189:f392fc9709a3 668 #define I2C_GET_STOP_MODE(__HANDLE__) ((__HANDLE__)->Instance->CR2 & I2C_CR2_AUTOEND)
AnnaBridge 189:f392fc9709a3 669 #define I2C_GET_OWN_ADDRESS1(__HANDLE__) ((__HANDLE__)->Instance->OAR1 & I2C_OAR1_OA1)
AnnaBridge 189:f392fc9709a3 670 #define I2C_GET_OWN_ADDRESS2(__HANDLE__) ((__HANDLE__)->Instance->OAR2 & I2C_OAR2_OA2)
AnnaBridge 189:f392fc9709a3 671
AnnaBridge 189:f392fc9709a3 672 #define IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= 0x000003FFU)
AnnaBridge 189:f392fc9709a3 673 #define IS_I2C_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FFU)
AnnaBridge 189:f392fc9709a3 674
AnnaBridge 189:f392fc9709a3 675 #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00U))) >> 8U)))
AnnaBridge 189:f392fc9709a3 676 #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FFU))))
AnnaBridge 189:f392fc9709a3 677
AnnaBridge 189:f392fc9709a3 678 #define I2C_GENERATE_START(__ADDMODE__,__ADDRESS__) (((__ADDMODE__) == I2C_ADDRESSINGMODE_7BIT) ? (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_START) | (I2C_CR2_AUTOEND)) & (~I2C_CR2_RD_WRN)) : \
AnnaBridge 189:f392fc9709a3 679 (uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) | (I2C_CR2_ADD10) | (I2C_CR2_START)) & (~I2C_CR2_RD_WRN)))
AnnaBridge 189:f392fc9709a3 680 /**
AnnaBridge 189:f392fc9709a3 681 * @}
AnnaBridge 189:f392fc9709a3 682 */
AnnaBridge 189:f392fc9709a3 683
AnnaBridge 189:f392fc9709a3 684 /* Private Functions ---------------------------------------------------------*/
AnnaBridge 189:f392fc9709a3 685 /** @defgroup I2C_Private_Functions I2C Private Functions
AnnaBridge 189:f392fc9709a3 686 * @{
AnnaBridge 189:f392fc9709a3 687 */
AnnaBridge 189:f392fc9709a3 688 /* Private functions are defined in stm32l4xx_hal_i2c.c file */
AnnaBridge 189:f392fc9709a3 689 /**
AnnaBridge 189:f392fc9709a3 690 * @}
AnnaBridge 189:f392fc9709a3 691 */
AnnaBridge 189:f392fc9709a3 692
AnnaBridge 189:f392fc9709a3 693 /**
AnnaBridge 189:f392fc9709a3 694 * @}
AnnaBridge 189:f392fc9709a3 695 */
AnnaBridge 189:f392fc9709a3 696
AnnaBridge 189:f392fc9709a3 697 /**
AnnaBridge 189:f392fc9709a3 698 * @}
AnnaBridge 189:f392fc9709a3 699 */
AnnaBridge 189:f392fc9709a3 700
AnnaBridge 189:f392fc9709a3 701 #ifdef __cplusplus
AnnaBridge 189:f392fc9709a3 702 }
AnnaBridge 189:f392fc9709a3 703 #endif
AnnaBridge 189:f392fc9709a3 704
AnnaBridge 189:f392fc9709a3 705
AnnaBridge 189:f392fc9709a3 706 #endif /* __STM32L4xx_HAL_I2C_H */
AnnaBridge 189:f392fc9709a3 707
AnnaBridge 189:f392fc9709a3 708 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/