mbed - my fork

Users » filartrix » Code » mbed

my fork

TARGET_NUCLEO_F072RB/stm32f0xx_hal_i2c.h@85:024bf7f99721, 2014-06-11 (annotated)

Committer:: bogdanm
Date:: Wed Jun 11 15:14:05 2014 +0100
Revision:: 85:024bf7f99721
Child:: 92:4fc01daae5a5

Release 85 of the mbed library



Main changes:



- K64F Ethernet fixes

- Updated tests

- Fixes for various mbed targets

- Code cleanup: fixed warnings, more consistent code style

- GCC support for K64F



There is a known issue with the I2C interface on some ST targets. If you

find the I2C interface problematic on your ST board, please log a bug

against this on mbed.org.

Who changed what in which revision?

User	Revision	Line number	New contents of line
bogdanm	85:024bf7f99721	1	/**
bogdanm	85:024bf7f99721	2	******************************************************************************
bogdanm	85:024bf7f99721	3	* @file stm32f0xx_hal_i2c.h
bogdanm	85:024bf7f99721	4	* @author MCD Application Team
bogdanm	85:024bf7f99721	5	* @version V1.0.0
bogdanm	85:024bf7f99721	6	* @date 28-May-2014
bogdanm	85:024bf7f99721	7	* @brief Header file of I2C HAL module.
bogdanm	85:024bf7f99721	8	******************************************************************************
bogdanm	85:024bf7f99721	9	* @attention
bogdanm	85:024bf7f99721	10	*
bogdanm	85:024bf7f99721	11	* <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm	85:024bf7f99721	12	*
bogdanm	85:024bf7f99721	13	* Redistribution and use in source and binary forms, with or without modification,
bogdanm	85:024bf7f99721	14	* are permitted provided that the following conditions are met:
bogdanm	85:024bf7f99721	15	* 1. Redistributions of source code must retain the above copyright notice,
bogdanm	85:024bf7f99721	16	* this list of conditions and the following disclaimer.
bogdanm	85:024bf7f99721	17	* 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm	85:024bf7f99721	18	* this list of conditions and the following disclaimer in the documentation
bogdanm	85:024bf7f99721	19	* and/or other materials provided with the distribution.
bogdanm	85:024bf7f99721	20	* 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm	85:024bf7f99721	21	* may be used to endorse or promote products derived from this software
bogdanm	85:024bf7f99721	22	* without specific prior written permission.
bogdanm	85:024bf7f99721	23	*
bogdanm	85:024bf7f99721	24	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm	85:024bf7f99721	25	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm	85:024bf7f99721	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm	85:024bf7f99721	27	* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm	85:024bf7f99721	28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm	85:024bf7f99721	29	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm	85:024bf7f99721	30	* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm	85:024bf7f99721	31	* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm	85:024bf7f99721	32	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm	85:024bf7f99721	33	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm	85:024bf7f99721	34	*
bogdanm	85:024bf7f99721	35	******************************************************************************
bogdanm	85:024bf7f99721	36	*/
bogdanm	85:024bf7f99721	37
bogdanm	85:024bf7f99721	38	/* Define to prevent recursive inclusion -------------------------------------*/
bogdanm	85:024bf7f99721	39	#ifndef __STM32F0xx_HAL_I2C_H
bogdanm	85:024bf7f99721	40	#define __STM32F0xx_HAL_I2C_H
bogdanm	85:024bf7f99721	41
bogdanm	85:024bf7f99721	42	#ifdef __cplusplus
bogdanm	85:024bf7f99721	43	extern "C" {
bogdanm	85:024bf7f99721	44	#endif
bogdanm	85:024bf7f99721	45
bogdanm	85:024bf7f99721	46	/* Includes ------------------------------------------------------------------*/
bogdanm	85:024bf7f99721	47	#include "stm32f0xx_hal_def.h"
bogdanm	85:024bf7f99721	48
bogdanm	85:024bf7f99721	49	/** @addtogroup STM32F0xx_HAL_Driver
bogdanm	85:024bf7f99721	50	* @{
bogdanm	85:024bf7f99721	51	*/
bogdanm	85:024bf7f99721	52
bogdanm	85:024bf7f99721	53	/** @addtogroup I2C
bogdanm	85:024bf7f99721	54	* @{
bogdanm	85:024bf7f99721	55	*/
bogdanm	85:024bf7f99721	56
bogdanm	85:024bf7f99721	57	/* Exported types ------------------------------------------------------------*/
bogdanm	85:024bf7f99721	58
bogdanm	85:024bf7f99721	59	/**
bogdanm	85:024bf7f99721	60	* @brief I2C Configuration Structure definition
bogdanm	85:024bf7f99721	61	*/
bogdanm	85:024bf7f99721	62	typedef struct
bogdanm	85:024bf7f99721	63	{
bogdanm	85:024bf7f99721	64	uint32_t Timing; /*!< Specifies the I2C_TIMINGR_register value.
bogdanm	85:024bf7f99721	65	This parameter calculated by referring to I2C initialization
bogdanm	85:024bf7f99721	66	section in Reference manual */
bogdanm	85:024bf7f99721	67
bogdanm	85:024bf7f99721	68	uint32_t OwnAddress1; /*!< Specifies the first device own address.
bogdanm	85:024bf7f99721	69	This parameter can be a 7-bit or 10-bit address. */
bogdanm	85:024bf7f99721	70
bogdanm	85:024bf7f99721	71	uint32_t AddressingMode; /*!< Specifies if 7-bit or 10-bit addressing mode is selected.
bogdanm	85:024bf7f99721	72	This parameter can be a value of @ref I2C_addressing_mode */
bogdanm	85:024bf7f99721	73
bogdanm	85:024bf7f99721	74	uint32_t DualAddressMode; /*!< Specifies if dual addressing mode is selected.
bogdanm	85:024bf7f99721	75	This parameter can be a value of @ref I2C_dual_addressing_mode */
bogdanm	85:024bf7f99721	76
bogdanm	85:024bf7f99721	77	uint32_t OwnAddress2; /*!< Specifies the second device own address if dual addressing mode is selected
bogdanm	85:024bf7f99721	78	This parameter can be a 7-bit address. */
bogdanm	85:024bf7f99721	79
bogdanm	85:024bf7f99721	80	uint32_t OwnAddress2Masks; /*!< Specifies the acknoledge mask address second device own address if dual addressing mode is selected
bogdanm	85:024bf7f99721	81	This parameter can be a value of @ref I2C_own_address2_masks. */
bogdanm	85:024bf7f99721	82
bogdanm	85:024bf7f99721	83	uint32_t GeneralCallMode; /*!< Specifies if general call mode is selected.
bogdanm	85:024bf7f99721	84	This parameter can be a value of @ref I2C_general_call_addressing_mode. */
bogdanm	85:024bf7f99721	85
bogdanm	85:024bf7f99721	86	uint32_t NoStretchMode; /*!< Specifies if nostretch mode is selected.
bogdanm	85:024bf7f99721	87	This parameter can be a value of @ref I2C_nostretch_mode */
bogdanm	85:024bf7f99721	88
bogdanm	85:024bf7f99721	89	}I2C_InitTypeDef;
bogdanm	85:024bf7f99721	90
bogdanm	85:024bf7f99721	91	/**
bogdanm	85:024bf7f99721	92	* @brief HAL State structures definition
bogdanm	85:024bf7f99721	93	*/
bogdanm	85:024bf7f99721	94	typedef enum
bogdanm	85:024bf7f99721	95	{
bogdanm	85:024bf7f99721	96	HAL_I2C_STATE_RESET = 0x00, /!< I2C not yet initialized or disabled /
bogdanm	85:024bf7f99721	97	HAL_I2C_STATE_READY = 0x01, /!< I2C initialized and ready for use /
bogdanm	85:024bf7f99721	98	HAL_I2C_STATE_BUSY = 0x02, /!< I2C internal process is ongoing /
bogdanm	85:024bf7f99721	99	HAL_I2C_STATE_MASTER_BUSY_TX = 0x12, /!< Master Data Transmission process is ongoing /
bogdanm	85:024bf7f99721	100	HAL_I2C_STATE_MASTER_BUSY_RX = 0x22, /!< Master Data Reception process is ongoing /
bogdanm	85:024bf7f99721	101	HAL_I2C_STATE_SLAVE_BUSY_TX = 0x32, /!< Slave Data Transmission process is ongoing /
bogdanm	85:024bf7f99721	102	HAL_I2C_STATE_SLAVE_BUSY_RX = 0x42, /!< Slave Data Reception process is ongoing /
bogdanm	85:024bf7f99721	103	HAL_I2C_STATE_MEM_BUSY_TX = 0x52, /!< Memory Data Transmission process is ongoing /
bogdanm	85:024bf7f99721	104	HAL_I2C_STATE_MEM_BUSY_RX = 0x62, /!< Memory Data Reception process is ongoing /
bogdanm	85:024bf7f99721	105	HAL_I2C_STATE_TIMEOUT = 0x03, /!< Timeout state /
bogdanm	85:024bf7f99721	106	HAL_I2C_STATE_ERROR = 0x04 /!< Reception process is ongoing /
bogdanm	85:024bf7f99721	107
bogdanm	85:024bf7f99721	108	}HAL_I2C_StateTypeDef;
bogdanm	85:024bf7f99721	109
bogdanm	85:024bf7f99721	110	/**
bogdanm	85:024bf7f99721	111	* @brief HAL I2C Error Code structure definition
bogdanm	85:024bf7f99721	112	*/
bogdanm	85:024bf7f99721	113	typedef enum
bogdanm	85:024bf7f99721	114	{
bogdanm	85:024bf7f99721	115	HAL_I2C_ERROR_NONE = 0x00, /!< No error /
bogdanm	85:024bf7f99721	116	HAL_I2C_ERROR_BERR = 0x01, /!< BERR error /
bogdanm	85:024bf7f99721	117	HAL_I2C_ERROR_ARLO = 0x02, /!< ARLO error /
bogdanm	85:024bf7f99721	118	HAL_I2C_ERROR_AF = 0x04, /!< AF error /
bogdanm	85:024bf7f99721	119	HAL_I2C_ERROR_OVR = 0x08, /!< OVR error /
bogdanm	85:024bf7f99721	120	HAL_I2C_ERROR_DMA = 0x10, /!< DMA transfer error /
bogdanm	85:024bf7f99721	121	HAL_I2C_ERROR_TIMEOUT = 0x20, /!< Timeout error /
bogdanm	85:024bf7f99721	122	HAL_I2C_ERROR_SIZE = 0x40 /!< Size Management error /
bogdanm	85:024bf7f99721	123	}HAL_I2C_ErrorTypeDef;
bogdanm	85:024bf7f99721	124
bogdanm	85:024bf7f99721	125	/**
bogdanm	85:024bf7f99721	126	* @brief I2C handle Structure definition
bogdanm	85:024bf7f99721	127	*/
bogdanm	85:024bf7f99721	128	typedef struct
bogdanm	85:024bf7f99721	129	{
bogdanm	85:024bf7f99721	130	I2C_TypeDef Instance; /!< I2C registers base address */
bogdanm	85:024bf7f99721	131
bogdanm	85:024bf7f99721	132	I2C_InitTypeDef Init; /!< I2C communication parameters /
bogdanm	85:024bf7f99721	133
bogdanm	85:024bf7f99721	134	uint8_t pBuffPtr; /!< Pointer to I2C transfer buffer */
bogdanm	85:024bf7f99721	135
bogdanm	85:024bf7f99721	136	uint16_t XferSize; /!< I2C transfer size /
bogdanm	85:024bf7f99721	137
bogdanm	85:024bf7f99721	138	__IO uint16_t XferCount; /!< I2C transfer counter /
bogdanm	85:024bf7f99721	139
bogdanm	85:024bf7f99721	140	DMA_HandleTypeDef hdmatx; /!< I2C Tx DMA handle parameters */
bogdanm	85:024bf7f99721	141
bogdanm	85:024bf7f99721	142	DMA_HandleTypeDef hdmarx; /!< I2C Rx DMA handle parameters */
bogdanm	85:024bf7f99721	143
bogdanm	85:024bf7f99721	144	HAL_LockTypeDef Lock; /!< I2C locking object /
bogdanm	85:024bf7f99721	145
bogdanm	85:024bf7f99721	146	__IO HAL_I2C_StateTypeDef State; /!< I2C communication state /
bogdanm	85:024bf7f99721	147
bogdanm	85:024bf7f99721	148	__IO HAL_I2C_ErrorTypeDef ErrorCode; /* I2C Error code */
bogdanm	85:024bf7f99721	149
bogdanm	85:024bf7f99721	150	}I2C_HandleTypeDef;
bogdanm	85:024bf7f99721	151
bogdanm	85:024bf7f99721	152	/* Exported constants --------------------------------------------------------*/
bogdanm	85:024bf7f99721	153
bogdanm	85:024bf7f99721	154	/** @defgroup I2C_Exported_Constants
bogdanm	85:024bf7f99721	155	* @{
bogdanm	85:024bf7f99721	156	*/
bogdanm	85:024bf7f99721	157
bogdanm	85:024bf7f99721	158	/** @defgroup I2C_addressing_mode
bogdanm	85:024bf7f99721	159	* @{
bogdanm	85:024bf7f99721	160	*/
bogdanm	85:024bf7f99721	161	#define I2C_ADDRESSINGMODE_7BIT ((uint32_t)0x00000001)
bogdanm	85:024bf7f99721	162	#define I2C_ADDRESSINGMODE_10BIT ((uint32_t)0x00000002)
bogdanm	85:024bf7f99721	163
bogdanm	85:024bf7f99721	164	#define IS_I2C_ADDRESSING_MODE(MODE) (((MODE) == I2C_ADDRESSINGMODE_7BIT) \|\| \
bogdanm	85:024bf7f99721	165	((MODE) == I2C_ADDRESSINGMODE_10BIT))
bogdanm	85:024bf7f99721	166	/**
bogdanm	85:024bf7f99721	167	* @}
bogdanm	85:024bf7f99721	168	*/
bogdanm	85:024bf7f99721	169
bogdanm	85:024bf7f99721	170	/** @defgroup I2C_dual_addressing_mode
bogdanm	85:024bf7f99721	171	* @{
bogdanm	85:024bf7f99721	172	*/
bogdanm	85:024bf7f99721	173
bogdanm	85:024bf7f99721	174	#define I2C_DUALADDRESS_DISABLED ((uint32_t)0x00000000)
bogdanm	85:024bf7f99721	175	#define I2C_DUALADDRESS_ENABLED I2C_OAR2_OA2EN
bogdanm	85:024bf7f99721	176
bogdanm	85:024bf7f99721	177	#define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLED) \|\| \
bogdanm	85:024bf7f99721	178	((ADDRESS) == I2C_DUALADDRESS_ENABLED))
bogdanm	85:024bf7f99721	179	/**
bogdanm	85:024bf7f99721	180	* @}
bogdanm	85:024bf7f99721	181	*/
bogdanm	85:024bf7f99721	182
bogdanm	85:024bf7f99721	183	/** @defgroup I2C_own_address2_masks
bogdanm	85:024bf7f99721	184	* @{
bogdanm	85:024bf7f99721	185	*/
bogdanm	85:024bf7f99721	186
bogdanm	85:024bf7f99721	187	#define I2C_OA2_NOMASK ((uint8_t)0x00)
bogdanm	85:024bf7f99721	188	#define I2C_OA2_MASK01 ((uint8_t)0x01)
bogdanm	85:024bf7f99721	189	#define I2C_OA2_MASK02 ((uint8_t)0x02)
bogdanm	85:024bf7f99721	190	#define I2C_OA2_MASK03 ((uint8_t)0x03)
bogdanm	85:024bf7f99721	191	#define I2C_OA2_MASK04 ((uint8_t)0x04)
bogdanm	85:024bf7f99721	192	#define I2C_OA2_MASK05 ((uint8_t)0x05)
bogdanm	85:024bf7f99721	193	#define I2C_OA2_MASK06 ((uint8_t)0x06)
bogdanm	85:024bf7f99721	194	#define I2C_OA2_MASK07 ((uint8_t)0x07)
bogdanm	85:024bf7f99721	195
bogdanm	85:024bf7f99721	196	#define IS_I2C_OWN_ADDRESS2_MASK(MASK) (((MASK) == I2C_OA2_NOMASK) \|\| \
bogdanm	85:024bf7f99721	197	((MASK) == I2C_OA2_MASK01) \|\| \
bogdanm	85:024bf7f99721	198	((MASK) == I2C_OA2_MASK02) \|\| \
bogdanm	85:024bf7f99721	199	((MASK) == I2C_OA2_MASK03) \|\| \
bogdanm	85:024bf7f99721	200	((MASK) == I2C_OA2_MASK04) \|\| \
bogdanm	85:024bf7f99721	201	((MASK) == I2C_OA2_MASK05) \|\| \
bogdanm	85:024bf7f99721	202	((MASK) == I2C_OA2_MASK06) \|\| \
bogdanm	85:024bf7f99721	203	((MASK) == I2C_OA2_MASK07))
bogdanm	85:024bf7f99721	204	/**
bogdanm	85:024bf7f99721	205	* @}
bogdanm	85:024bf7f99721	206	*/
bogdanm	85:024bf7f99721	207
bogdanm	85:024bf7f99721	208	/** @defgroup I2C_general_call_addressing_mode
bogdanm	85:024bf7f99721	209	* @{
bogdanm	85:024bf7f99721	210	*/
bogdanm	85:024bf7f99721	211	#define I2C_GENERALCALL_DISABLED ((uint32_t)0x00000000)
bogdanm	85:024bf7f99721	212	#define I2C_GENERALCALL_ENABLED I2C_CR1_GCEN
bogdanm	85:024bf7f99721	213
bogdanm	85:024bf7f99721	214	#define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLED) \|\| \
bogdanm	85:024bf7f99721	215	((CALL) == I2C_GENERALCALL_ENABLED))
bogdanm	85:024bf7f99721	216	/**
bogdanm	85:024bf7f99721	217	* @}
bogdanm	85:024bf7f99721	218	*/
bogdanm	85:024bf7f99721	219
bogdanm	85:024bf7f99721	220	/** @defgroup I2C_nostretch_mode
bogdanm	85:024bf7f99721	221	* @{
bogdanm	85:024bf7f99721	222	*/
bogdanm	85:024bf7f99721	223	#define I2C_NOSTRETCH_DISABLED ((uint32_t)0x00000000)
bogdanm	85:024bf7f99721	224	#define I2C_NOSTRETCH_ENABLED I2C_CR1_NOSTRETCH
bogdanm	85:024bf7f99721	225
bogdanm	85:024bf7f99721	226	#define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLED) \|\| \
bogdanm	85:024bf7f99721	227	((STRETCH) == I2C_NOSTRETCH_ENABLED))
bogdanm	85:024bf7f99721	228	/**
bogdanm	85:024bf7f99721	229	* @}
bogdanm	85:024bf7f99721	230	*/
bogdanm	85:024bf7f99721	231
bogdanm	85:024bf7f99721	232	/** @defgroup I2C_Memory_Address_Size
bogdanm	85:024bf7f99721	233	* @{
bogdanm	85:024bf7f99721	234	*/
bogdanm	85:024bf7f99721	235	#define I2C_MEMADD_SIZE_8BIT ((uint32_t)0x00000001)
bogdanm	85:024bf7f99721	236	#define I2C_MEMADD_SIZE_16BIT ((uint32_t)0x00000002)
bogdanm	85:024bf7f99721	237
bogdanm	85:024bf7f99721	238	#define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) \|\| \
bogdanm	85:024bf7f99721	239	((SIZE) == I2C_MEMADD_SIZE_16BIT))
bogdanm	85:024bf7f99721	240	/**
bogdanm	85:024bf7f99721	241	* @}
bogdanm	85:024bf7f99721	242	*/
bogdanm	85:024bf7f99721	243
bogdanm	85:024bf7f99721	244	/** @defgroup I2C_ReloadEndMode_definition
bogdanm	85:024bf7f99721	245	* @{
bogdanm	85:024bf7f99721	246	*/
bogdanm	85:024bf7f99721	247
bogdanm	85:024bf7f99721	248	#define I2C_RELOAD_MODE I2C_CR2_RELOAD
bogdanm	85:024bf7f99721	249	#define I2C_AUTOEND_MODE I2C_CR2_AUTOEND
bogdanm	85:024bf7f99721	250	#define I2C_SOFTEND_MODE ((uint32_t)0x00000000)
bogdanm	85:024bf7f99721	251
bogdanm	85:024bf7f99721	252	#define IS_TRANSFER_MODE(MODE) (((MODE) == I2C_RELOAD_MODE) \|\| \
bogdanm	85:024bf7f99721	253	((MODE) == I2C_AUTOEND_MODE) \|\| \
bogdanm	85:024bf7f99721	254	((MODE) == I2C_SOFTEND_MODE))
bogdanm	85:024bf7f99721	255	/**
bogdanm	85:024bf7f99721	256	* @}
bogdanm	85:024bf7f99721	257	*/
bogdanm	85:024bf7f99721	258
bogdanm	85:024bf7f99721	259	/** @defgroup I2C_StartStopMode_definition
bogdanm	85:024bf7f99721	260	* @{
bogdanm	85:024bf7f99721	261	*/
bogdanm	85:024bf7f99721	262
bogdanm	85:024bf7f99721	263	#define I2C_NO_STARTSTOP ((uint32_t)0x00000000)
bogdanm	85:024bf7f99721	264	#define I2C_GENERATE_STOP I2C_CR2_STOP
bogdanm	85:024bf7f99721	265	#define I2C_GENERATE_START_READ (uint32_t)(I2C_CR2_START \| I2C_CR2_RD_WRN)
bogdanm	85:024bf7f99721	266	#define I2C_GENERATE_START_WRITE I2C_CR2_START
bogdanm	85:024bf7f99721	267
bogdanm	85:024bf7f99721	268	#define IS_TRANSFER_REQUEST(REQUEST) (((REQUEST) == I2C_GENERATE_STOP) \|\| \
bogdanm	85:024bf7f99721	269	((REQUEST) == I2C_GENERATE_START_READ) \|\| \
bogdanm	85:024bf7f99721	270	((REQUEST) == I2C_GENERATE_START_WRITE) \|\| \
bogdanm	85:024bf7f99721	271	((REQUEST) == I2C_NO_STARTSTOP))
bogdanm	85:024bf7f99721	272
bogdanm	85:024bf7f99721	273	/**
bogdanm	85:024bf7f99721	274	* @}
bogdanm	85:024bf7f99721	275	*/
bogdanm	85:024bf7f99721	276
bogdanm	85:024bf7f99721	277	/** @defgroup I2C_Interrupt_configuration_definition
bogdanm	85:024bf7f99721	278	* @brief I2C Interrupt definition
bogdanm	85:024bf7f99721	279	* Elements values convention: 0xXXXXXXXX
bogdanm	85:024bf7f99721	280	* - XXXXXXXX : Interrupt control mask
bogdanm	85:024bf7f99721	281	* @{
bogdanm	85:024bf7f99721	282	*/
bogdanm	85:024bf7f99721	283	#define I2C_IT_ERRI I2C_CR1_ERRIE
bogdanm	85:024bf7f99721	284	#define I2C_IT_TCI I2C_CR1_TCIE
bogdanm	85:024bf7f99721	285	#define I2C_IT_STOPI I2C_CR1_STOPIE
bogdanm	85:024bf7f99721	286	#define I2C_IT_NACKI I2C_CR1_NACKIE
bogdanm	85:024bf7f99721	287	#define I2C_IT_ADDRI I2C_CR1_ADDRIE
bogdanm	85:024bf7f99721	288	#define I2C_IT_RXI I2C_CR1_RXIE
bogdanm	85:024bf7f99721	289	#define I2C_IT_TXI I2C_CR1_TXIE
bogdanm	85:024bf7f99721	290
bogdanm	85:024bf7f99721	291	/**
bogdanm	85:024bf7f99721	292	* @}
bogdanm	85:024bf7f99721	293	*/
bogdanm	85:024bf7f99721	294
bogdanm	85:024bf7f99721	295
bogdanm	85:024bf7f99721	296	/** @defgroup I2C_Flag_definition
bogdanm	85:024bf7f99721	297	* @{
bogdanm	85:024bf7f99721	298	*/
bogdanm	85:024bf7f99721	299
bogdanm	85:024bf7f99721	300	#define I2C_FLAG_TXE I2C_ISR_TXE
bogdanm	85:024bf7f99721	301	#define I2C_FLAG_TXIS I2C_ISR_TXIS
bogdanm	85:024bf7f99721	302	#define I2C_FLAG_RXNE I2C_ISR_RXNE
bogdanm	85:024bf7f99721	303	#define I2C_FLAG_ADDR I2C_ISR_ADDR
bogdanm	85:024bf7f99721	304	#define I2C_FLAG_AF I2C_ISR_NACKF
bogdanm	85:024bf7f99721	305	#define I2C_FLAG_STOPF I2C_ISR_STOPF
bogdanm	85:024bf7f99721	306	#define I2C_FLAG_TC I2C_ISR_TC
bogdanm	85:024bf7f99721	307	#define I2C_FLAG_TCR I2C_ISR_TCR
bogdanm	85:024bf7f99721	308	#define I2C_FLAG_BERR I2C_ISR_BERR
bogdanm	85:024bf7f99721	309	#define I2C_FLAG_ARLO I2C_ISR_ARLO
bogdanm	85:024bf7f99721	310	#define I2C_FLAG_OVR I2C_ISR_OVR
bogdanm	85:024bf7f99721	311	#define I2C_FLAG_PECERR I2C_ISR_PECERR
bogdanm	85:024bf7f99721	312	#define I2C_FLAG_TIMEOUT I2C_ISR_TIMEOUT
bogdanm	85:024bf7f99721	313	#define I2C_FLAG_ALERT I2C_ISR_ALERT
bogdanm	85:024bf7f99721	314	#define I2C_FLAG_BUSY I2C_ISR_BUSY
bogdanm	85:024bf7f99721	315	#define I2C_FLAG_DIR I2C_ISR_DIR
bogdanm	85:024bf7f99721	316	/**
bogdanm	85:024bf7f99721	317	* @}
bogdanm	85:024bf7f99721	318	*/
bogdanm	85:024bf7f99721	319
bogdanm	85:024bf7f99721	320	/**
bogdanm	85:024bf7f99721	321	* @}
bogdanm	85:024bf7f99721	322	*/
bogdanm	85:024bf7f99721	323
bogdanm	85:024bf7f99721	324	/* Exported macros -----------------------------------------------------------*/
bogdanm	85:024bf7f99721	325
bogdanm	85:024bf7f99721	326	/** @brief Reset I2C handle state
bogdanm	85:024bf7f99721	327	* @param __HANDLE__: I2C handle.
bogdanm	85:024bf7f99721	328	* @retval None
bogdanm	85:024bf7f99721	329	*/
bogdanm	85:024bf7f99721	330	#define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
bogdanm	85:024bf7f99721	331
bogdanm	85:024bf7f99721	332	/** @brief Enables or disables the specified I2C interrupts.
bogdanm	85:024bf7f99721	333	* @param __HANDLE__: specifies the I2C Handle.
bogdanm	85:024bf7f99721	334	* This parameter can be I2C where x: 1 or 2 to select the I2C peripheral.
bogdanm	85:024bf7f99721	335	* @param __INTERRUPT__: specifies the interrupt source to enable or disable.
bogdanm	85:024bf7f99721	336	* This parameter can be one of the following values:
bogdanm	85:024bf7f99721	337	* @arg I2C_IT_ERRI: Errors interrupt enable
bogdanm	85:024bf7f99721	338	* @arg I2C_IT_TCI: Transfer complete interrupt enable
bogdanm	85:024bf7f99721	339	* @arg I2C_IT_STOPI: STOP detection interrupt enable
bogdanm	85:024bf7f99721	340	* @arg I2C_IT_NACKI: NACK received interrupt enable
bogdanm	85:024bf7f99721	341	* @arg I2C_IT_ADDRI: Address match interrupt enable
bogdanm	85:024bf7f99721	342	* @arg I2C_IT_RXI: RX interrupt enable
bogdanm	85:024bf7f99721	343	* @arg I2C_IT_TXI: TX interrupt enable
bogdanm	85:024bf7f99721	344	*
bogdanm	85:024bf7f99721	345	* @retval None
bogdanm	85:024bf7f99721	346	*/
bogdanm	85:024bf7f99721	347
bogdanm	85:024bf7f99721	348	#define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 \|= (__INTERRUPT__))
bogdanm	85:024bf7f99721	349	#define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR1 &= (~(__INTERRUPT__)))
bogdanm	85:024bf7f99721	350
bogdanm	85:024bf7f99721	351	/** @brief Checks if the specified I2C interrupt source is enabled or disabled.
bogdanm	85:024bf7f99721	352	* @param __HANDLE__: specifies the I2C Handle.
bogdanm	85:024bf7f99721	353	* This parameter can be I2C where x: 1 or 2 to select the I2C peripheral.
bogdanm	85:024bf7f99721	354	* @param __INTERRUPT__: specifies the I2C interrupt source to check.
bogdanm	85:024bf7f99721	355	* This parameter can be one of the following values:
bogdanm	85:024bf7f99721	356	* @arg I2C_IT_ERRI: Errors interrupt enable
bogdanm	85:024bf7f99721	357	* @arg I2C_IT_TCI: Transfer complete interrupt enable
bogdanm	85:024bf7f99721	358	* @arg I2C_IT_STOPI: STOP detection interrupt enable
bogdanm	85:024bf7f99721	359	* @arg I2C_IT_NACKI: NACK received interrupt enable
bogdanm	85:024bf7f99721	360	* @arg I2C_IT_ADDRI: Address match interrupt enable
bogdanm	85:024bf7f99721	361	* @arg I2C_IT_RXI: RX interrupt enable
bogdanm	85:024bf7f99721	362	* @arg I2C_IT_TXI: TX interrupt enable
bogdanm	85:024bf7f99721	363	*
bogdanm	85:024bf7f99721	364	* @retval The new state of __IT__ (TRUE or FALSE).
bogdanm	85:024bf7f99721	365	*/
bogdanm	85:024bf7f99721	366	#define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR1 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
bogdanm	85:024bf7f99721	367
bogdanm	85:024bf7f99721	368	/** @brief Checks whether the specified I2C flag is set or not.
bogdanm	85:024bf7f99721	369	* @param __HANDLE__: specifies the I2C Handle.
bogdanm	85:024bf7f99721	370	* This parameter can be I2C where x: 1 or 2 to select the I2C peripheral.
bogdanm	85:024bf7f99721	371	* @param __FLAG__: specifies the flag to check.
bogdanm	85:024bf7f99721	372	* This parameter can be one of the following values:
bogdanm	85:024bf7f99721	373	* @arg I2C_FLAG_TXE: Transmit data register empty
bogdanm	85:024bf7f99721	374	* @arg I2C_FLAG_TXIS: Transmit interrupt status
bogdanm	85:024bf7f99721	375	* @arg I2C_FLAG_RXNE: Receive data register not empty
bogdanm	85:024bf7f99721	376	* @arg I2C_FLAG_ADDR: Address matched (slave mode)
bogdanm	85:024bf7f99721	377	* @arg I2C_FLAG_AF: Acknowledge failure received flag
bogdanm	85:024bf7f99721	378	* @arg I2C_FLAG_STOPF: STOP detection flag
bogdanm	85:024bf7f99721	379	* @arg I2C_FLAG_TC: Transfer complete (master mode)
bogdanm	85:024bf7f99721	380	* @arg I2C_FLAG_TCR: Transfer complete reload
bogdanm	85:024bf7f99721	381	* @arg I2C_FLAG_BERR: Bus error
bogdanm	85:024bf7f99721	382	* @arg I2C_FLAG_ARLO: Arbitration lost
bogdanm	85:024bf7f99721	383	* @arg I2C_FLAG_OVR: Overrun/Underrun
bogdanm	85:024bf7f99721	384	* @arg I2C_FLAG_PECERR: PEC error in reception
bogdanm	85:024bf7f99721	385	* @arg I2C_FLAG_TIMEOUT: Timeout or Tlow detection flag
bogdanm	85:024bf7f99721	386	* @arg I2C_FLAG_ALERT: SMBus alert
bogdanm	85:024bf7f99721	387	* @arg I2C_FLAG_BUSY: Bus busy
bogdanm	85:024bf7f99721	388	* @arg I2C_FLAG_DIR: Transfer direction (slave mode)
bogdanm	85:024bf7f99721	389	*
bogdanm	85:024bf7f99721	390	* @retval The new state of __FLAG__ (TRUE or FALSE).
bogdanm	85:024bf7f99721	391	*/
bogdanm	85:024bf7f99721	392	#define I2C_FLAG_MASK ((uint32_t)0x0001FFFF)
bogdanm	85:024bf7f99721	393	#define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)))
bogdanm	85:024bf7f99721	394
bogdanm	85:024bf7f99721	395	/** @brief Clears the I2C pending flags which are cleared by writing 1 in a specific bit.
bogdanm	85:024bf7f99721	396	* @param __HANDLE__: specifies the I2C Handle.
bogdanm	85:024bf7f99721	397	* This parameter can be I2C where x: 1 or 2 to select the I2C peripheral.
bogdanm	85:024bf7f99721	398	* @param __FLAG__: specifies the flag to clear.
bogdanm	85:024bf7f99721	399	* This parameter can be any combination of the following values:
bogdanm	85:024bf7f99721	400	* @arg I2C_FLAG_ADDR: Address matched (slave mode)
bogdanm	85:024bf7f99721	401	* @arg I2C_FLAG_AF: Acknowledge failure flag
bogdanm	85:024bf7f99721	402	* @arg I2C_FLAG_STOPF: STOP detection flag
bogdanm	85:024bf7f99721	403	* @arg I2C_FLAG_BERR: Bus error
bogdanm	85:024bf7f99721	404	* @arg I2C_FLAG_ARLO: Arbitration lost
bogdanm	85:024bf7f99721	405	* @arg I2C_FLAG_OVR: Overrun/Underrun
bogdanm	85:024bf7f99721	406	* @arg I2C_FLAG_PECERR: PEC error in reception
bogdanm	85:024bf7f99721	407	* @arg I2C_FLAG_TIMEOUT: Timeout or Tlow detection flag
bogdanm	85:024bf7f99721	408	* @arg I2C_FLAG_ALERT: SMBus alert
bogdanm	85:024bf7f99721	409	*
bogdanm	85:024bf7f99721	410	* @retval None
bogdanm	85:024bf7f99721	411	*/
bogdanm	85:024bf7f99721	412	#define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR \|= ((__FLAG__) & I2C_FLAG_MASK))
bogdanm	85:024bf7f99721	413
bogdanm	85:024bf7f99721	414
bogdanm	85:024bf7f99721	415	#define __HAL_I2C_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 \|= I2C_CR1_PE)
bogdanm	85:024bf7f99721	416	#define __HAL_I2C_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~I2C_CR1_PE)
bogdanm	85:024bf7f99721	417
bogdanm	85:024bf7f99721	418	#define __HAL_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)))
bogdanm	85:024bf7f99721	419
bogdanm	85:024bf7f99721	420	#define __HAL_I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)(((__ADDRESS__) & 0xFF00) >> 8))
bogdanm	85:024bf7f99721	421	#define __HAL_I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((__ADDRESS__) & 0x00FF))
bogdanm	85:024bf7f99721	422
bogdanm	85:024bf7f99721	423	#define __HAL_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)) : \
bogdanm	85:024bf7f99721	424	(uint32_t)((((uint32_t)(__ADDRESS__) & (I2C_CR2_SADD)) \| (I2C_CR2_ADD10) \| (I2C_CR2_START)) & (~I2C_CR2_RD_WRN)))
bogdanm	85:024bf7f99721	425
bogdanm	85:024bf7f99721	426	#define IS_I2C_OWN_ADDRESS1(ADDRESS1) ((ADDRESS1) <= (uint32_t)0x000003FF)
bogdanm	85:024bf7f99721	427	#define IS_I2C_OWN_ADDRESS2(ADDRESS2) ((ADDRESS2) <= (uint16_t)0x00FF)
bogdanm	85:024bf7f99721	428
bogdanm	85:024bf7f99721	429	/* Include I2C HAL Extension module */
bogdanm	85:024bf7f99721	430	#include "stm32f0xx_hal_i2c_ex.h"
bogdanm	85:024bf7f99721	431
bogdanm	85:024bf7f99721	432	/* Exported functions --------------------------------------------------------*/
bogdanm	85:024bf7f99721	433	/* Initialization/de-initialization functions **********************************/
bogdanm	85:024bf7f99721	434	HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	435	HAL_StatusTypeDef HAL_I2C_DeInit (I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	436	void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	437	void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	438
bogdanm	85:024bf7f99721	439	/* IO operation functions *****************************************************/
bogdanm	85:024bf7f99721	440	/******* Blocking mode: Polling */
bogdanm	85:024bf7f99721	441	HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t Timeout);
bogdanm	85:024bf7f99721	442	HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size, uint32_t Timeout);
bogdanm	85:024bf7f99721	443	HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t Timeout);
bogdanm	85:024bf7f99721	444	HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size, uint32_t Timeout);
bogdanm	85:024bf7f99721	445	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);
bogdanm	85:024bf7f99721	446	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);
bogdanm	85:024bf7f99721	447	HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
bogdanm	85:024bf7f99721	448
bogdanm	85:024bf7f99721	449	/******* Non-Blocking mode: Interrupt */
bogdanm	85:024bf7f99721	450	HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	451	HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	452	HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	453	HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	454	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);
bogdanm	85:024bf7f99721	455	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);
bogdanm	85:024bf7f99721	456
bogdanm	85:024bf7f99721	457	/******* Non-Blocking mode: DMA */
bogdanm	85:024bf7f99721	458	HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	459	HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef hi2c, uint16_t DevAddress, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	460	HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	461	HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef hi2c, uint8_t pData, uint16_t Size);
bogdanm	85:024bf7f99721	462	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);
bogdanm	85:024bf7f99721	463	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);
bogdanm	85:024bf7f99721	464
bogdanm	85:024bf7f99721	465	/******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
bogdanm	85:024bf7f99721	466	void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	467	void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	468	void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	469	void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	470	void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	471	void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	472	void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	473	void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	474	void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	475
bogdanm	85:024bf7f99721	476	/* Peripheral State functions **************************************/
bogdanm	85:024bf7f99721	477	HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	478	uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
bogdanm	85:024bf7f99721	479
bogdanm	85:024bf7f99721	480	/**
bogdanm	85:024bf7f99721	481	* @}
bogdanm	85:024bf7f99721	482	*/
bogdanm	85:024bf7f99721	483
bogdanm	85:024bf7f99721	484	/**
bogdanm	85:024bf7f99721	485	* @}
bogdanm	85:024bf7f99721	486	*/
bogdanm	85:024bf7f99721	487
bogdanm	85:024bf7f99721	488	#ifdef __cplusplus
bogdanm	85:024bf7f99721	489	}
bogdanm	85:024bf7f99721	490	#endif
bogdanm	85:024bf7f99721	491
bogdanm	85:024bf7f99721	492
bogdanm	85:024bf7f99721	493	#endif /* __STM32F0xx_HAL_I2C_H */
bogdanm	85:024bf7f99721	494
bogdanm	85:024bf7f99721	495	/********************** (C) COPYRIGHT STMicroelectronics *END OF FILE**/

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	08 Apr 2015
Imports:	2
Forks:	0
Commits:	98
Dependents:	1
Dependencies:	0
Followers:	1

TARGET_NUCLEO_F072RB/stm32f0xx_hal_i2c.h@85:024bf7f99721, 2014-06-11 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning