mbed library with additional peripherals for ST F401 board

Fork of mbed-src by mbed official

This mbed LIB has additional peripherals for ST F401 board

  • UART2 : PA_3 rx, PA_2 tx
  • UART3 : PC_7 rx, PC_6 tx
  • I2C2 : PB_3 SDA, PB_10 SCL
  • I2C3 : PB_4 SDA, PA_8 SCL
Committer:
mbed_official
Date:
Wed Feb 26 09:45:12 2014 +0000
Revision:
106:ced8cbb51063
Parent:
87:085cde657901
Synchronized with git revision 4222735eff5868389433f0e9271976b39c8115cd

Full URL: https://github.com/mbedmicro/mbed/commit/4222735eff5868389433f0e9271976b39c8115cd/

[NUCLEO_xxx] Update STM32CubeF4 driver V1.0.0 + update license

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 87:085cde657901 1 /**
mbed_official 87:085cde657901 2 ******************************************************************************
mbed_official 87:085cde657901 3 * @file stm32f4xx_hal_i2c.h
mbed_official 87:085cde657901 4 * @author MCD Application Team
mbed_official 106:ced8cbb51063 5 * @version V1.0.0
mbed_official 106:ced8cbb51063 6 * @date 18-February-2014
mbed_official 87:085cde657901 7 * @brief Header file of I2C HAL module.
mbed_official 87:085cde657901 8 ******************************************************************************
mbed_official 87:085cde657901 9 * @attention
mbed_official 87:085cde657901 10 *
mbed_official 87:085cde657901 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 87:085cde657901 12 *
mbed_official 87:085cde657901 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 87:085cde657901 14 * are permitted provided that the following conditions are met:
mbed_official 87:085cde657901 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 87:085cde657901 16 * this list of conditions and the following disclaimer.
mbed_official 87:085cde657901 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 87:085cde657901 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 87:085cde657901 19 * and/or other materials provided with the distribution.
mbed_official 87:085cde657901 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 87:085cde657901 21 * may be used to endorse or promote products derived from this software
mbed_official 87:085cde657901 22 * without specific prior written permission.
mbed_official 87:085cde657901 23 *
mbed_official 87:085cde657901 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 87:085cde657901 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 87:085cde657901 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 87:085cde657901 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 87:085cde657901 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 87:085cde657901 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 87:085cde657901 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 87:085cde657901 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 87:085cde657901 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 87:085cde657901 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 87:085cde657901 34 *
mbed_official 87:085cde657901 35 ******************************************************************************
mbed_official 87:085cde657901 36 */
mbed_official 87:085cde657901 37
mbed_official 87:085cde657901 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 87:085cde657901 39 #ifndef __STM32F4xx_HAL_I2C_H
mbed_official 87:085cde657901 40 #define __STM32F4xx_HAL_I2C_H
mbed_official 87:085cde657901 41
mbed_official 87:085cde657901 42 #ifdef __cplusplus
mbed_official 87:085cde657901 43 extern "C" {
mbed_official 87:085cde657901 44 #endif
mbed_official 87:085cde657901 45
mbed_official 87:085cde657901 46 /* Includes ------------------------------------------------------------------*/
mbed_official 87:085cde657901 47 #include "stm32f4xx_hal_def.h"
mbed_official 87:085cde657901 48
mbed_official 87:085cde657901 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 87:085cde657901 50 * @{
mbed_official 87:085cde657901 51 */
mbed_official 87:085cde657901 52
mbed_official 87:085cde657901 53 /** @addtogroup I2C
mbed_official 87:085cde657901 54 * @{
mbed_official 87:085cde657901 55 */
mbed_official 87:085cde657901 56
mbed_official 87:085cde657901 57 /* Exported types ------------------------------------------------------------*/
mbed_official 87:085cde657901 58
mbed_official 87:085cde657901 59 /**
mbed_official 87:085cde657901 60 * @brief I2C Configuration Structure definition
mbed_official 87:085cde657901 61 */
mbed_official 87:085cde657901 62 typedef struct
mbed_official 87:085cde657901 63 {
mbed_official 87:085cde657901 64 uint32_t ClockSpeed; /*!< Specifies the clock frequency.
mbed_official 87:085cde657901 65 This parameter must be set to a value lower than 400kHz */
mbed_official 87:085cde657901 66
mbed_official 87:085cde657901 67 uint32_t DutyCycle; /*!< Specifies the I2C fast mode duty cycle.
mbed_official 87:085cde657901 68 This parameter can be a value of @ref I2C_duty_cycle_in_fast_mode */
mbed_official 87:085cde657901 69
mbed_official 87:085cde657901 70 uint32_t OwnAddress1; /*!< Specifies the first device own address.
mbed_official 87:085cde657901 71 This parameter can be a 7-bit or 10-bit address. */
mbed_official 87:085cde657901 72
mbed_official 87:085cde657901 73 uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
mbed_official 87:085cde657901 74 This parameter can be a value of @ref I2C_addressing_mode */
mbed_official 87:085cde657901 75
mbed_official 87:085cde657901 76 uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
mbed_official 87:085cde657901 77 This parameter can be a value of @ref I2C_dual_addressing_mode */
mbed_official 87:085cde657901 78
mbed_official 87:085cde657901 79 uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
mbed_official 87:085cde657901 80 This parameter can be a 7-bit address. */
mbed_official 87:085cde657901 81
mbed_official 87:085cde657901 82 uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
mbed_official 87:085cde657901 83 This parameter can be a value of @ref I2C_general_call_addressing_mode. */
mbed_official 87:085cde657901 84
mbed_official 87:085cde657901 85 uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
mbed_official 87:085cde657901 86 This parameter can be a value of @ref I2C_nostretch_mode */
mbed_official 87:085cde657901 87
mbed_official 87:085cde657901 88 }I2C_InitTypeDef;
mbed_official 87:085cde657901 89
mbed_official 87:085cde657901 90 /**
mbed_official 87:085cde657901 91 * @brief HAL State structures definition
mbed_official 87:085cde657901 92 */
mbed_official 87:085cde657901 93 typedef enum
mbed_official 87:085cde657901 94 {
mbed_official 87:085cde657901 95 HAL_I2C_STATE_RESET = 0x00, /*!< I2C not yet initialized or disabled */
mbed_official 87:085cde657901 96 HAL_I2C_STATE_READY = 0x01, /*!< I2C initialized and ready for use */
mbed_official 87:085cde657901 97 HAL_I2C_STATE_BUSY = 0x02, /*!< I2C internal process is ongoing */
mbed_official 87:085cde657901 98 HAL_I2C_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
mbed_official 87:085cde657901 99 HAL_I2C_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
mbed_official 87:085cde657901 100 HAL_I2C_STATE_MEM_BUSY_TX = 0x32, /*!< Memory Data Transmission process is ongoing */
mbed_official 87:085cde657901 101 HAL_I2C_STATE_MEM_BUSY_RX = 0x42, /*!< Memory Data Reception process is ongoing */
mbed_official 87:085cde657901 102 HAL_I2C_STATE_TIMEOUT = 0x03, /*!< I2C timeout state */
mbed_official 87:085cde657901 103 HAL_I2C_STATE_ERROR = 0x04 /*!< I2C error state */
mbed_official 87:085cde657901 104
mbed_official 87:085cde657901 105 }HAL_I2C_StateTypeDef;
mbed_official 87:085cde657901 106
mbed_official 87:085cde657901 107 /**
mbed_official 87:085cde657901 108 * @brief HAL I2C Error Code structure definition
mbed_official 87:085cde657901 109 */
mbed_official 87:085cde657901 110 typedef enum
mbed_official 87:085cde657901 111 {
mbed_official 87:085cde657901 112 HAL_I2C_ERROR_NONE = 0x00, /*!< No error */
mbed_official 87:085cde657901 113 HAL_I2C_ERROR_BERR = 0x01, /*!< BERR error */
mbed_official 87:085cde657901 114 HAL_I2C_ERROR_ARLO = 0x02, /*!< ARLO error */
mbed_official 87:085cde657901 115 HAL_I2C_ERROR_AF = 0x04, /*!< AF error */
mbed_official 87:085cde657901 116 HAL_I2C_ERROR_OVR = 0x08, /*!< OVR error */
mbed_official 87:085cde657901 117 HAL_I2C_ERROR_DMA = 0x10, /*!< DMA transfer error */
mbed_official 87:085cde657901 118 HAL_I2C_ERROR_TIMEOUT = 0x20 /*!< Timeout error */
mbed_official 87:085cde657901 119
mbed_official 87:085cde657901 120 }HAL_I2C_ErrorTypeDef;
mbed_official 87:085cde657901 121
mbed_official 87:085cde657901 122 /**
mbed_official 87:085cde657901 123 * @brief I2C handle Structure definition
mbed_official 87:085cde657901 124 */
mbed_official 87:085cde657901 125 typedef struct
mbed_official 87:085cde657901 126 {
mbed_official 87:085cde657901 127 I2C_TypeDef *Instance; /*!< I2C registers base address */
mbed_official 87:085cde657901 128
mbed_official 87:085cde657901 129 I2C_InitTypeDef Init; /*!< I2C communication parameters */
mbed_official 87:085cde657901 130
mbed_official 87:085cde657901 131 uint8_t *pBuffPtr; /*!< Pointer to I2C transfer buffer */
mbed_official 87:085cde657901 132
mbed_official 87:085cde657901 133 uint16_t XferSize; /*!< I2C transfer size */
mbed_official 87:085cde657901 134
mbed_official 87:085cde657901 135 __IO uint16_t XferCount; /*!< I2C transfer counter */
mbed_official 87:085cde657901 136
mbed_official 87:085cde657901 137 DMA_HandleTypeDef *hdmatx; /*!< I2C Tx DMA handle parameters */
mbed_official 87:085cde657901 138
mbed_official 87:085cde657901 139 DMA_HandleTypeDef *hdmarx; /*!< I2C Rx DMA handle parameters */
mbed_official 87:085cde657901 140
mbed_official 87:085cde657901 141 HAL_LockTypeDef Lock; /*!< I2C locking object */
mbed_official 87:085cde657901 142
mbed_official 87:085cde657901 143 __IO HAL_I2C_StateTypeDef State; /*!< I2C communication state */
mbed_official 87:085cde657901 144
mbed_official 87:085cde657901 145 __IO HAL_I2C_ErrorTypeDef ErrorCode; /* I2C Error code */
mbed_official 87:085cde657901 146
mbed_official 87:085cde657901 147 }I2C_HandleTypeDef;
mbed_official 87:085cde657901 148
mbed_official 87:085cde657901 149 /* Exported constants --------------------------------------------------------*/
mbed_official 87:085cde657901 150
mbed_official 87:085cde657901 151 /** @defgroup I2C_Exported_Constants
mbed_official 87:085cde657901 152 * @{
mbed_official 87:085cde657901 153 */
mbed_official 87:085cde657901 154
mbed_official 87:085cde657901 155 /** @defgroup I2C_duty_cycle_in_fast_mode
mbed_official 87:085cde657901 156 * @{
mbed_official 87:085cde657901 157 */
mbed_official 87:085cde657901 158 #define I2C_DUTYCYCLE_2 ((uint32_t)0x00000000)
mbed_official 87:085cde657901 159 #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
mbed_official 87:085cde657901 160
mbed_official 87:085cde657901 161 #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
mbed_official 87:085cde657901 162 ((CYCLE) == I2C_DUTYCYCLE_16_9))
mbed_official 87:085cde657901 163 /**
mbed_official 87:085cde657901 164 * @}
mbed_official 87:085cde657901 165 */
mbed_official 87:085cde657901 166
mbed_official 87:085cde657901 167 /** @defgroup I2C_addressing_mode
mbed_official 87:085cde657901 168 * @{
mbed_official 87:085cde657901 169 */
mbed_official 87:085cde657901 170 #define I2C_ADDRESSINGMODE_7BIT ((uint32_t)0x00004000)
mbed_official 87:085cde657901 171 #define I2C_ADDRESSINGMODE_10BIT (I2C_OAR1_ADDMODE | ((uint32_t)0x00004000))
mbed_official 87:085cde657901 172
mbed_official 87:085cde657901 173 #define IS_I2C_ADDRESSING_MODE(ADDRESS) (((ADDRESS) == I2C_ADDRESSINGMODE_7BIT) || \
mbed_official 87:085cde657901 174 ((ADDRESS) == I2C_ADDRESSINGMODE_10BIT))
mbed_official 87:085cde657901 175 /**
mbed_official 87:085cde657901 176 * @}
mbed_official 87:085cde657901 177 */
mbed_official 87:085cde657901 178
mbed_official 87:085cde657901 179 /** @defgroup I2C_dual_addressing_mode
mbed_official 87:085cde657901 180 * @{
mbed_official 87:085cde657901 181 */
mbed_official 87:085cde657901 182 #define I2C_DUALADDRESS_DISABLED ((uint32_t)0x00000000)
mbed_official 87:085cde657901 183 #define I2C_DUALADDRESS_ENABLED I2C_OAR2_ENDUAL
mbed_official 87:085cde657901 184
mbed_official 87:085cde657901 185 #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLED) || \
mbed_official 87:085cde657901 186 ((ADDRESS) == I2C_DUALADDRESS_ENABLED))
mbed_official 87:085cde657901 187 /**
mbed_official 87:085cde657901 188 * @}
mbed_official 87:085cde657901 189 */
mbed_official 87:085cde657901 190
mbed_official 87:085cde657901 191 /** @defgroup I2C_general_call_addressing_mode
mbed_official 87:085cde657901 192 * @{
mbed_official 87:085cde657901 193 */
mbed_official 87:085cde657901 194 #define I2C_GENERALCALL_DISABLED ((uint32_t)0x00000000)
mbed_official 87:085cde657901 195 #define I2C_GENERALCALL_ENABLED I2C_CR1_ENGC
mbed_official 87:085cde657901 196
mbed_official 87:085cde657901 197 #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLED) || \
mbed_official 87:085cde657901 198 ((CALL) == I2C_GENERALCALL_ENABLED))
mbed_official 87:085cde657901 199 /**
mbed_official 87:085cde657901 200 * @}
mbed_official 87:085cde657901 201 */
mbed_official 87:085cde657901 202
mbed_official 87:085cde657901 203 /** @defgroup I2C_nostretch_mode
mbed_official 87:085cde657901 204 * @{
mbed_official 87:085cde657901 205 */
mbed_official 87:085cde657901 206 #define I2C_NOSTRETCH_DISABLED ((uint32_t)0x00000000)
mbed_official 87:085cde657901 207 #define I2C_NOSTRETCH_ENABLED I2C_CR1_NOSTRETCH
mbed_official 87:085cde657901 208
mbed_official 87:085cde657901 209 #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLED) || \
mbed_official 87:085cde657901 210 ((STRETCH) == I2C_NOSTRETCH_ENABLED))
mbed_official 87:085cde657901 211 /**
mbed_official 87:085cde657901 212 * @}
mbed_official 87:085cde657901 213 */
mbed_official 87:085cde657901 214
mbed_official 87:085cde657901 215 /** @defgroup I2C_Memory_Address_Size
mbed_official 87:085cde657901 216 * @{
mbed_official 87:085cde657901 217 */
mbed_official 87:085cde657901 218 #define I2C_MEMADD_SIZE_8BIT ((uint32_t)0x00000001)
mbed_official 87:085cde657901 219 #define I2C_MEMADD_SIZE_16BIT ((uint32_t)0x00000010)
mbed_official 87:085cde657901 220
mbed_official 87:085cde657901 221 #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
mbed_official 87:085cde657901 222 ((SIZE) == I2C_MEMADD_SIZE_16BIT))
mbed_official 87:085cde657901 223 /**
mbed_official 87:085cde657901 224 * @}
mbed_official 87:085cde657901 225 */
mbed_official 87:085cde657901 226
mbed_official 87:085cde657901 227 /** @defgroup I2C_Interrupt_configuration_definition
mbed_official 87:085cde657901 228 * @{
mbed_official 87:085cde657901 229 */
mbed_official 87:085cde657901 230 #define I2C_IT_BUF I2C_CR2_ITBUFEN
mbed_official 87:085cde657901 231 #define I2C_IT_EVT I2C_CR2_ITEVTEN
mbed_official 87:085cde657901 232 #define I2C_IT_ERR I2C_CR2_ITERREN
mbed_official 87:085cde657901 233 /**
mbed_official 87:085cde657901 234 * @}
mbed_official 87:085cde657901 235 */
mbed_official 87:085cde657901 236
mbed_official 87:085cde657901 237 /** @defgroup I2C_Flag_definition
mbed_official 87:085cde657901 238 * @{
mbed_official 87:085cde657901 239 */
mbed_official 87:085cde657901 240 #define I2C_FLAG_SMBALERT ((uint32_t)0x00018000)
mbed_official 87:085cde657901 241 #define I2C_FLAG_TIMEOUT ((uint32_t)0x00014000)
mbed_official 87:085cde657901 242 #define I2C_FLAG_PECERR ((uint32_t)0x00011000)
mbed_official 87:085cde657901 243 #define I2C_FLAG_OVR ((uint32_t)0x00010800)
mbed_official 87:085cde657901 244 #define I2C_FLAG_AF ((uint32_t)0x00010400)
mbed_official 87:085cde657901 245 #define I2C_FLAG_ARLO ((uint32_t)0x00010200)
mbed_official 87:085cde657901 246 #define I2C_FLAG_BERR ((uint32_t)0x00010100)
mbed_official 87:085cde657901 247 #define I2C_FLAG_TXE ((uint32_t)0x00010080)
mbed_official 87:085cde657901 248 #define I2C_FLAG_RXNE ((uint32_t)0x00010040)
mbed_official 87:085cde657901 249 #define I2C_FLAG_STOPF ((uint32_t)0x00010010)
mbed_official 87:085cde657901 250 #define I2C_FLAG_ADD10 ((uint32_t)0x00010008)
mbed_official 87:085cde657901 251 #define I2C_FLAG_BTF ((uint32_t)0x00010004)
mbed_official 87:085cde657901 252 #define I2C_FLAG_ADDR ((uint32_t)0x00010002)
mbed_official 87:085cde657901 253 #define I2C_FLAG_SB ((uint32_t)0x00010001)
mbed_official 87:085cde657901 254 #define I2C_FLAG_DUALF ((uint32_t)0x00100080)
mbed_official 87:085cde657901 255 #define I2C_FLAG_SMBHOST ((uint32_t)0x00100040)
mbed_official 87:085cde657901 256 #define I2C_FLAG_SMBDEFAULT ((uint32_t)0x00100020)
mbed_official 87:085cde657901 257 #define I2C_FLAG_GENCALL ((uint32_t)0x00100010)
mbed_official 87:085cde657901 258 #define I2C_FLAG_TRA ((uint32_t)0x00100004)
mbed_official 87:085cde657901 259 #define I2C_FLAG_BUSY ((uint32_t)0x00100002)
mbed_official 87:085cde657901 260 #define I2C_FLAG_MSL ((uint32_t)0x00100001)
mbed_official 87:085cde657901 261 /**
mbed_official 87:085cde657901 262 * @}
mbed_official 87:085cde657901 263 */
mbed_official 87:085cde657901 264
mbed_official 87:085cde657901 265 /**
mbed_official 87:085cde657901 266 * @}
mbed_official 87:085cde657901 267 */
mbed_official 87:085cde657901 268
mbed_official 87:085cde657901 269 /* Exported macro ------------------------------------------------------------*/
mbed_official 87:085cde657901 270
mbed_official 87:085cde657901 271 /** @brief Enable or disable the specified I2C interrupts.
mbed_official 87:085cde657901 272 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 273 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 274 * @param __INTERRUPT__: specifies the interrupt source to enable or disable.
mbed_official 87:085cde657901 275 * This parameter can be one of the following values:
mbed_official 87:085cde657901 276 * @arg I2C_IT_BUF: Buffer interrupt enable
mbed_official 87:085cde657901 277 * @arg I2C_IT_EVT: Event interrupt enable
mbed_official 87:085cde657901 278 * @arg I2C_IT_ERR: Error interrupt enable
mbed_official 87:085cde657901 279 * @retval None
mbed_official 87:085cde657901 280 */
mbed_official 87:085cde657901 281
mbed_official 87:085cde657901 282 #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 |= (__INTERRUPT__))
mbed_official 87:085cde657901 283 #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR2 &= (~(__INTERRUPT__)))
mbed_official 87:085cde657901 284
mbed_official 87:085cde657901 285 /** @brief Checks if the specified I2C interrupt source is enabled or disabled.
mbed_official 87:085cde657901 286 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 287 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 288 * @param __INTERRUPT__: specifies the I2C interrupt source to check.
mbed_official 87:085cde657901 289 * This parameter can be one of the following values:
mbed_official 87:085cde657901 290 * @arg I2C_IT_BUF: Buffer interrupt enable
mbed_official 87:085cde657901 291 * @arg I2C_IT_EVT: Event interrupt enable
mbed_official 87:085cde657901 292 * @arg I2C_IT_ERR: Error interrupt enable
mbed_official 87:085cde657901 293 * @retval The new state of __INTERRUPT__ (TRUE or FALSE).
mbed_official 87:085cde657901 294 */
mbed_official 87:085cde657901 295 #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
mbed_official 87:085cde657901 296
mbed_official 87:085cde657901 297 /** @brief Checks whether the specified I2C flag is set or not.
mbed_official 87:085cde657901 298 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 299 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 300 * @param __FLAG__: specifies the flag to check.
mbed_official 87:085cde657901 301 * This parameter can be one of the following values:
mbed_official 87:085cde657901 302 * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
mbed_official 87:085cde657901 303 * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
mbed_official 87:085cde657901 304 * @arg I2C_FLAG_PECERR: PEC error in reception flag
mbed_official 87:085cde657901 305 * @arg I2C_FLAG_OVR: Overrun/Underrun flag
mbed_official 87:085cde657901 306 * @arg I2C_FLAG_AF: Acknowledge failure flag
mbed_official 87:085cde657901 307 * @arg I2C_FLAG_ARLO: Arbitration lost flag
mbed_official 87:085cde657901 308 * @arg I2C_FLAG_BERR: Bus error flag
mbed_official 87:085cde657901 309 * @arg I2C_FLAG_TXE: Data register empty flag
mbed_official 87:085cde657901 310 * @arg I2C_FLAG_RXNE: Data register not empty flag
mbed_official 87:085cde657901 311 * @arg I2C_FLAG_STOPF: Stop detection flag
mbed_official 87:085cde657901 312 * @arg I2C_FLAG_ADD10: 10-bit header sent flag
mbed_official 87:085cde657901 313 * @arg I2C_FLAG_BTF: Byte transfer finished flag
mbed_official 87:085cde657901 314 * @arg I2C_FLAG_ADDR: Address sent flag
mbed_official 87:085cde657901 315 * Address matched flag
mbed_official 87:085cde657901 316 * @arg I2C_FLAG_SB: Start bit flag
mbed_official 87:085cde657901 317 * @arg I2C_FLAG_DUALF: Dual flag
mbed_official 87:085cde657901 318 * @arg I2C_FLAG_SMBHOST: SMBus host header
mbed_official 87:085cde657901 319 * @arg I2C_FLAG_SMBDEFAULT: SMBus default header
mbed_official 87:085cde657901 320 * @arg I2C_FLAG_GENCALL: General call header flag
mbed_official 87:085cde657901 321 * @arg I2C_FLAG_TRA: Transmitter/Receiver flag
mbed_official 87:085cde657901 322 * @arg I2C_FLAG_BUSY: Bus busy flag
mbed_official 87:085cde657901 323 * @arg I2C_FLAG_MSL: Master/Slave flag
mbed_official 87:085cde657901 324 * @retval The new state of __FLAG__ (TRUE or FALSE).
mbed_official 87:085cde657901 325 */
mbed_official 87:085cde657901 326 #define I2C_FLAG_MASK ((uint32_t)0x0000FFFF)
mbed_official 87:085cde657901 327 #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16)) == 0x01)?((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)): \
mbed_official 87:085cde657901 328 ((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)))
mbed_official 87:085cde657901 329
mbed_official 87:085cde657901 330 /** @brief Clears the I2C pending flags which are cleared by writing 0 in a specific bit.
mbed_official 87:085cde657901 331 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 332 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 333 * @param __FLAG__: specifies the flag to clear.
mbed_official 87:085cde657901 334 * This parameter can be any combination of the following values:
mbed_official 87:085cde657901 335 * @arg I2C_FLAG_SMBALERT: SMBus Alert flag
mbed_official 87:085cde657901 336 * @arg I2C_FLAG_TIMEOUT: Timeout or Tlow error flag
mbed_official 87:085cde657901 337 * @arg I2C_FLAG_PECERR: PEC error in reception flag
mbed_official 87:085cde657901 338 * @arg I2C_FLAG_OVR: Overrun/Underrun flag (Slave mode)
mbed_official 87:085cde657901 339 * @arg I2C_FLAG_AF: Acknowledge failure flag
mbed_official 87:085cde657901 340 * @arg I2C_FLAG_ARLO: Arbitration lost flag (Master mode)
mbed_official 87:085cde657901 341 * @arg I2C_FLAG_BERR: Bus error flag
mbed_official 87:085cde657901 342 * @retval None
mbed_official 87:085cde657901 343 */
mbed_official 87:085cde657901 344 #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 &= ~((__FLAG__) & I2C_FLAG_MASK))
mbed_official 87:085cde657901 345
mbed_official 87:085cde657901 346 /** @brief Clears the I2C ADDR pending flag.
mbed_official 87:085cde657901 347 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 348 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 349 * @retval None
mbed_official 87:085cde657901 350 */
mbed_official 87:085cde657901 351
mbed_official 87:085cde657901 352 #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR1;\
mbed_official 87:085cde657901 353 (__HANDLE__)->Instance->SR2;}while(0)
mbed_official 87:085cde657901 354
mbed_official 87:085cde657901 355 /** @brief Clears the I2C STOPF pending flag.
mbed_official 87:085cde657901 356 * @param __HANDLE__: specifies the I2C Handle.
mbed_official 87:085cde657901 357 * This parameter can be I2C where x: 1, 2, or 3 to select the I2C peripheral.
mbed_official 87:085cde657901 358 * @retval None
mbed_official 87:085cde657901 359 */
mbed_official 87:085cde657901 360 #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR1;\
mbed_official 87:085cde657901 361 (__HANDLE__)->Instance->CR1 |= I2C_CR1_PE;}while(0)
mbed_official 87:085cde657901 362
mbed_official 87:085cde657901 363 #define __HAL_I2C_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= I2C_CR1_PE)
mbed_official 87:085cde657901 364 #define __HAL_I2C_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~I2C_CR1_PE)
mbed_official 87:085cde657901 365
mbed_official 87:085cde657901 366 #define __HAL_I2C_FREQRANGE(__PCLK__) ((__PCLK__)/1000000)
mbed_official 87:085cde657901 367 #define __HAL_I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000) ? ((__FREQRANGE__) + 1) : ((((__FREQRANGE__) * 300) / 1000) + 1))
mbed_official 87:085cde657901 368 #define __HAL_I2C_SPEED_STANDARD(__PCLK__, __SPEED__) (((((__PCLK__)/((__SPEED__) << 1)) & I2C_CCR_CCR) < 4)? 4:((__PCLK__) / ((__SPEED__) << 1)))
mbed_official 87:085cde657901 369 #define __HAL_I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? ((__PCLK__) / ((__SPEED__) * 3)) : (((__PCLK__) / ((__SPEED__) * 25)) | I2C_DUTYCYCLE_16_9))
mbed_official 87:085cde657901 370 #define __HAL_I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000)? (__HAL_I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
mbed_official 87:085cde657901 371 ((__HAL_I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0)? 1 : \
mbed_official 87:085cde657901 372 ((__HAL_I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
mbed_official 87:085cde657901 373
mbed_official 87:085cde657901 374 #define __HAL_I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (~I2C_OAR1_ADD0)))
mbed_official 87:085cde657901 375 #define __HAL_I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | I2C_OAR1_ADD0))
mbed_official 87:085cde657901 376
mbed_official 87:085cde657901 377 #define __HAL_I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FF))))
mbed_official 87:085cde657901 378 #define __HAL_I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300))) >> 7) | (uint16_t)(0xF0))))
mbed_official 87:085cde657901 379 #define __HAL_I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0x0300))) >> 7) | (uint16_t)(0xF1))))
mbed_official 87:085cde657901 380
mbed_official 87:085cde657901 381 #define __HAL_I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)(0xFF00))) >> 8)))
mbed_official 87:085cde657901 382 #define __HAL_I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)(0x00FF))))
mbed_official 87:085cde657901 383
mbed_official 87:085cde657901 384 #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0) && ((SPEED) <= 400000))
mbed_official 87:085cde657901 385 #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & (uint32_t)(0xFFFFFC00)) == 0)
mbed_official 87:085cde657901 386 #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & (uint32_t)(0xFFFFFF01)) == 0)
mbed_official 87:085cde657901 387
mbed_official 87:085cde657901 388 /* Include I2C HAL Extension module */
mbed_official 87:085cde657901 389 #include "stm32f4xx_hal_i2c_ex.h"
mbed_official 87:085cde657901 390
mbed_official 87:085cde657901 391 /* Exported functions --------------------------------------------------------*/
mbed_official 87:085cde657901 392 /* Initialization/de-initialization functions **********************************/
mbed_official 87:085cde657901 393 HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 394 HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 395 void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 396 void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 397
mbed_official 87:085cde657901 398 /* I/O operation functions *****************************************************/
mbed_official 87:085cde657901 399 /******* Blocking mode: Polling */
mbed_official 87:085cde657901 400 HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 401 HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 402 HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 403 HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 87:085cde657901 404 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);
mbed_official 87:085cde657901 405 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);
mbed_official 87:085cde657901 406 HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
mbed_official 87:085cde657901 407
mbed_official 87:085cde657901 408 /******* Non-Blocking mode: Interrupt */
mbed_official 87:085cde657901 409 HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 410 HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 411 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 412 HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 413 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);
mbed_official 87:085cde657901 414 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);
mbed_official 87:085cde657901 415
mbed_official 87:085cde657901 416 /******* Non-Blocking mode: DMA */
mbed_official 87:085cde657901 417 HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 418 HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 419 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 420 HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
mbed_official 87:085cde657901 421 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);
mbed_official 87:085cde657901 422 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);
mbed_official 87:085cde657901 423
mbed_official 87:085cde657901 424 /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
mbed_official 87:085cde657901 425 void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 426 void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 427 void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 428 void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 429 void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 430 void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 431 void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 432 void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
mbed_official 106:ced8cbb51063 433 void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 434
mbed_official 87:085cde657901 435 /* Peripheral Control and State functions **************************************/
mbed_official 87:085cde657901 436 HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 437 uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
mbed_official 87:085cde657901 438
mbed_official 87:085cde657901 439 /**
mbed_official 87:085cde657901 440 * @}
mbed_official 87:085cde657901 441 */
mbed_official 87:085cde657901 442
mbed_official 87:085cde657901 443 /**
mbed_official 87:085cde657901 444 * @}
mbed_official 87:085cde657901 445 */
mbed_official 87:085cde657901 446
mbed_official 87:085cde657901 447 #ifdef __cplusplus
mbed_official 87:085cde657901 448 }
mbed_official 87:085cde657901 449 #endif
mbed_official 87:085cde657901 450
mbed_official 87:085cde657901 451
mbed_official 87:085cde657901 452 #endif /* __STM32F4xx_HAL_I2C_H */
mbed_official 87:085cde657901 453
mbed_official 87:085cde657901 454 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/