STM32F10x Standard Peripherals Library  3.5.0
/opt/STM32F10x_StdPeriph_Lib_V3.5.0/Libraries/STM32F10x_StdPeriph_Driver/inc/stm32f10x_i2c.h File Reference

This file contains all the functions prototypes for the I2C firmware library. More...

#include "stm32f10x.h"

Go to the source code of this file.

Data Structures

struct  I2C_InitTypeDef
 I2C Init structure definition. More...

Defines

#define IS_I2C_ALL_PERIPH(PERIPH)
#define I2C_Mode_I2C   ((uint16_t)0x0000)
#define I2C_Mode_SMBusDevice   ((uint16_t)0x0002)
#define I2C_Mode_SMBusHost   ((uint16_t)0x000A)
#define IS_I2C_MODE(MODE)
#define I2C_DutyCycle_16_9   ((uint16_t)0x4000)
#define I2C_DutyCycle_2   ((uint16_t)0xBFFF)
#define IS_I2C_DUTY_CYCLE(CYCLE)
#define I2C_Ack_Enable   ((uint16_t)0x0400)
#define I2C_Ack_Disable   ((uint16_t)0x0000)
#define IS_I2C_ACK_STATE(STATE)
#define I2C_Direction_Transmitter   ((uint8_t)0x00)
#define I2C_Direction_Receiver   ((uint8_t)0x01)
#define IS_I2C_DIRECTION(DIRECTION)
#define I2C_AcknowledgedAddress_7bit   ((uint16_t)0x4000)
#define I2C_AcknowledgedAddress_10bit   ((uint16_t)0xC000)
#define IS_I2C_ACKNOWLEDGE_ADDRESS(ADDRESS)
#define I2C_Register_CR1   ((uint8_t)0x00)
#define I2C_Register_CR2   ((uint8_t)0x04)
#define I2C_Register_OAR1   ((uint8_t)0x08)
#define I2C_Register_OAR2   ((uint8_t)0x0C)
#define I2C_Register_DR   ((uint8_t)0x10)
#define I2C_Register_SR1   ((uint8_t)0x14)
#define I2C_Register_SR2   ((uint8_t)0x18)
#define I2C_Register_CCR   ((uint8_t)0x1C)
#define I2C_Register_TRISE   ((uint8_t)0x20)
#define IS_I2C_REGISTER(REGISTER)
#define I2C_SMBusAlert_Low   ((uint16_t)0x2000)
#define I2C_SMBusAlert_High   ((uint16_t)0xDFFF)
#define IS_I2C_SMBUS_ALERT(ALERT)
#define I2C_PECPosition_Next   ((uint16_t)0x0800)
#define I2C_PECPosition_Current   ((uint16_t)0xF7FF)
#define IS_I2C_PEC_POSITION(POSITION)
#define I2C_NACKPosition_Next   ((uint16_t)0x0800)
#define I2C_NACKPosition_Current   ((uint16_t)0xF7FF)
#define IS_I2C_NACK_POSITION(POSITION)
#define I2C_IT_BUF   ((uint16_t)0x0400)
#define I2C_IT_EVT   ((uint16_t)0x0200)
#define I2C_IT_ERR   ((uint16_t)0x0100)
#define IS_I2C_CONFIG_IT(IT)   ((((IT) & (uint16_t)0xF8FF) == 0x00) && ((IT) != 0x00))
#define I2C_IT_SMBALERT   ((uint32_t)0x01008000)
#define I2C_IT_TIMEOUT   ((uint32_t)0x01004000)
#define I2C_IT_PECERR   ((uint32_t)0x01001000)
#define I2C_IT_OVR   ((uint32_t)0x01000800)
#define I2C_IT_AF   ((uint32_t)0x01000400)
#define I2C_IT_ARLO   ((uint32_t)0x01000200)
#define I2C_IT_BERR   ((uint32_t)0x01000100)
#define I2C_IT_TXE   ((uint32_t)0x06000080)
#define I2C_IT_RXNE   ((uint32_t)0x06000040)
#define I2C_IT_STOPF   ((uint32_t)0x02000010)
#define I2C_IT_ADD10   ((uint32_t)0x02000008)
#define I2C_IT_BTF   ((uint32_t)0x02000004)
#define I2C_IT_ADDR   ((uint32_t)0x02000002)
#define I2C_IT_SB   ((uint32_t)0x02000001)
#define IS_I2C_CLEAR_IT(IT)   ((((IT) & (uint16_t)0x20FF) == 0x00) && ((IT) != (uint16_t)0x00))
#define IS_I2C_GET_IT(IT)
#define I2C_FLAG_DUALF   ((uint32_t)0x00800000)
 SR2 register flags.
#define I2C_FLAG_SMBHOST   ((uint32_t)0x00400000)
#define I2C_FLAG_SMBDEFAULT   ((uint32_t)0x00200000)
#define I2C_FLAG_GENCALL   ((uint32_t)0x00100000)
#define I2C_FLAG_TRA   ((uint32_t)0x00040000)
#define I2C_FLAG_BUSY   ((uint32_t)0x00020000)
#define I2C_FLAG_MSL   ((uint32_t)0x00010000)
#define I2C_FLAG_SMBALERT   ((uint32_t)0x10008000)
 SR1 register flags.
#define I2C_FLAG_TIMEOUT   ((uint32_t)0x10004000)
#define I2C_FLAG_PECERR   ((uint32_t)0x10001000)
#define I2C_FLAG_OVR   ((uint32_t)0x10000800)
#define I2C_FLAG_AF   ((uint32_t)0x10000400)
#define I2C_FLAG_ARLO   ((uint32_t)0x10000200)
#define I2C_FLAG_BERR   ((uint32_t)0x10000100)
#define I2C_FLAG_TXE   ((uint32_t)0x10000080)
#define I2C_FLAG_RXNE   ((uint32_t)0x10000040)
#define I2C_FLAG_STOPF   ((uint32_t)0x10000010)
#define I2C_FLAG_ADD10   ((uint32_t)0x10000008)
#define I2C_FLAG_BTF   ((uint32_t)0x10000004)
#define I2C_FLAG_ADDR   ((uint32_t)0x10000002)
#define I2C_FLAG_SB   ((uint32_t)0x10000001)
#define IS_I2C_CLEAR_FLAG(FLAG)   ((((FLAG) & (uint16_t)0x20FF) == 0x00) && ((FLAG) != (uint16_t)0x00))
#define IS_I2C_GET_FLAG(FLAG)
#define I2C_EVENT_MASTER_MODE_SELECT   ((uint32_t)0x00030001)
 Communication start.
#define I2C_EVENT_MASTER_TRANSMITTER_MODE_SELECTED   ((uint32_t)0x00070082)
 Address Acknowledge.
#define I2C_EVENT_MASTER_RECEIVER_MODE_SELECTED   ((uint32_t)0x00030002)
#define I2C_EVENT_MASTER_MODE_ADDRESS10   ((uint32_t)0x00030008)
#define I2C_EVENT_MASTER_BYTE_RECEIVED   ((uint32_t)0x00030040)
 Communication events.
#define I2C_EVENT_MASTER_BYTE_TRANSMITTING   ((uint32_t)0x00070080)
#define I2C_EVENT_MASTER_BYTE_TRANSMITTED   ((uint32_t)0x00070084)
#define I2C_EVENT_SLAVE_RECEIVER_ADDRESS_MATCHED   ((uint32_t)0x00020002)
 Communication start events.
#define I2C_EVENT_SLAVE_TRANSMITTER_ADDRESS_MATCHED   ((uint32_t)0x00060082)
#define I2C_EVENT_SLAVE_RECEIVER_SECONDADDRESS_MATCHED   ((uint32_t)0x00820000)
#define I2C_EVENT_SLAVE_TRANSMITTER_SECONDADDRESS_MATCHED   ((uint32_t)0x00860080)
#define I2C_EVENT_SLAVE_GENERALCALLADDRESS_MATCHED   ((uint32_t)0x00120000)
#define I2C_EVENT_SLAVE_BYTE_RECEIVED   ((uint32_t)0x00020040)
 Communication events.
#define I2C_EVENT_SLAVE_STOP_DETECTED   ((uint32_t)0x00000010)
#define I2C_EVENT_SLAVE_BYTE_TRANSMITTED   ((uint32_t)0x00060084)
#define I2C_EVENT_SLAVE_BYTE_TRANSMITTING   ((uint32_t)0x00060080)
#define I2C_EVENT_SLAVE_ACK_FAILURE   ((uint32_t)0x00000400)
#define IS_I2C_EVENT(EVENT)
#define IS_I2C_OWN_ADDRESS1(ADDRESS1)   ((ADDRESS1) <= 0x3FF)
#define IS_I2C_CLOCK_SPEED(SPEED)   (((SPEED) >= 0x1) && ((SPEED) <= 400000))

Functions

void I2C_DeInit (I2C_TypeDef *I2Cx)
 Deinitializes the I2Cx peripheral registers to their default reset values.
void I2C_Init (I2C_TypeDef *I2Cx, I2C_InitTypeDef *I2C_InitStruct)
 Initializes the I2Cx peripheral according to the specified parameters in the I2C_InitStruct.
void I2C_StructInit (I2C_InitTypeDef *I2C_InitStruct)
 Fills each I2C_InitStruct member with its default value.
void I2C_Cmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C peripheral.
void I2C_DMACmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C DMA requests.
void I2C_DMALastTransferCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Specifies if the next DMA transfer will be the last one.
void I2C_GenerateSTART (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Generates I2Cx communication START condition.
void I2C_GenerateSTOP (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Generates I2Cx communication STOP condition.
void I2C_AcknowledgeConfig (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C acknowledge feature.
void I2C_OwnAddress2Config (I2C_TypeDef *I2Cx, uint8_t Address)
 Configures the specified I2C own address2.
void I2C_DualAddressCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C dual addressing mode.
void I2C_GeneralCallCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C general call feature.
void I2C_ITConfig (I2C_TypeDef *I2Cx, uint16_t I2C_IT, FunctionalState NewState)
 Enables or disables the specified I2C interrupts.
void I2C_SendData (I2C_TypeDef *I2Cx, uint8_t Data)
 Sends a data byte through the I2Cx peripheral.
uint8_t I2C_ReceiveData (I2C_TypeDef *I2Cx)
 Returns the most recent received data by the I2Cx peripheral.
void I2C_Send7bitAddress (I2C_TypeDef *I2Cx, uint8_t Address, uint8_t I2C_Direction)
 Transmits the address byte to select the slave device.
uint16_t I2C_ReadRegister (I2C_TypeDef *I2Cx, uint8_t I2C_Register)
 Reads the specified I2C register and returns its value.
void I2C_SoftwareResetCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C software reset.
void I2C_NACKPositionConfig (I2C_TypeDef *I2Cx, uint16_t I2C_NACKPosition)
 Selects the specified I2C NACK position in master receiver mode. This function is useful in I2C Master Receiver mode when the number of data to be received is equal to 2. In this case, this function should be called (with parameter I2C_NACKPosition_Next) before data reception starts,as described in the 2-byte reception procedure recommended in Reference Manual in Section: Master receiver.
void I2C_SMBusAlertConfig (I2C_TypeDef *I2Cx, uint16_t I2C_SMBusAlert)
 Drives the SMBusAlert pin high or low for the specified I2C.
void I2C_TransmitPEC (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C PEC transfer.
void I2C_PECPositionConfig (I2C_TypeDef *I2Cx, uint16_t I2C_PECPosition)
 Selects the specified I2C PEC position.
void I2C_CalculatePEC (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the PEC value calculation of the transferred bytes.
uint8_t I2C_GetPEC (I2C_TypeDef *I2Cx)
 Returns the PEC value for the specified I2C.
void I2C_ARPCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C ARP.
void I2C_StretchClockCmd (I2C_TypeDef *I2Cx, FunctionalState NewState)
 Enables or disables the specified I2C Clock stretching.
void I2C_FastModeDutyCycleConfig (I2C_TypeDef *I2Cx, uint16_t I2C_DutyCycle)
 Selects the specified I2C fast mode duty cycle.
ErrorStatus I2C_CheckEvent (I2C_TypeDef *I2Cx, uint32_t I2C_EVENT)
 I2C State Monitoring Functions.
uint32_t I2C_GetLastEvent (I2C_TypeDef *I2Cx)
 Returns the last I2Cx Event.
FlagStatus I2C_GetFlagStatus (I2C_TypeDef *I2Cx, uint32_t I2C_FLAG)
 Checks whether the specified I2C flag is set or not.
void I2C_ClearFlag (I2C_TypeDef *I2Cx, uint32_t I2C_FLAG)
 Clears the I2Cx's pending flags.
ITStatus I2C_GetITStatus (I2C_TypeDef *I2Cx, uint32_t I2C_IT)
 Checks whether the specified I2C interrupt has occurred or not.
void I2C_ClearITPendingBit (I2C_TypeDef *I2Cx, uint32_t I2C_IT)
 Clears the I2Cx’s interrupt pending bits.

Detailed Description

This file contains all the functions prototypes for the I2C firmware library.

Author:
MCD Application Team
Version:
V3.5.0
Date:
11-March-2011
Attention:

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

© COPYRIGHT 2011 STMicroelectronics

Definition in file stm32f10x_i2c.h.