| M480 BSP V3.05.001 The Board Support Package for M480 Series

Macros | Functions
i2c.h File Reference

M480 series I2C driver header file. More...

Go to the source code of this file.

## Macros
#define | I2C_CTL_STA_SI
#define | I2C_CTL_STA_SI_AA
#define | I2C_CTL_STO_SI
#define | I2C_CTL_STO_SI_AA
#define | I2C_CTL_SI
#define | I2C_CTL_SI_AA
#define | I2C_CTL_STA
#define | I2C_CTL_STO
#define | I2C_CTL_AA
#define | I2C_GCMODE_ENABLE
#define | I2C_GCMODE_DISABLE
#define | I2C_SMBH_ENABLE
#define | I2C_SMBD_ENABLE
#define | I2C_PECTX_ENABLE
#define | I2C_PECTX_DISABLE
#define | I2C_SET_CONTROL_REG(i2c, u8Ctrl)
| The macro is used to set I2C bus condition at One Time. More...
#define | I2C_START(i2c)
| The macro is used to set START condition of I2C Bus. More...
#define | I2C_WAIT_READY(i2c)
| The macro is used to wait I2C bus status get ready. More...
#define | I2C_GET_DATA(i2c)
| The macro is used to Read I2C Bus Data Register. More...
#define | I2C_SET_DATA(i2c, u8Data)
| Write a Data to I2C Data Register. More...
#define | I2C_GET_STATUS(i2c)
| Get I2C Bus status code. More...
#define | I2C_GET_TIMEOUT_FLAG(i2c)
| Get Time-out flag from I2C Bus. More...
#define | I2C_GET_WAKEUP_FLAG(i2c)
| To get wake-up flag from I2C Bus. More...
#define | I2C_CLEAR_WAKEUP_FLAG(i2c)
| To clear wake-up flag. More...
#define | I2C_SMBUS_GET_STATUS(i2c)
| To get SMBus Status. More...
#define | I2C_SMBUS_GET_PEC_VALUE(i2c)
| Get SMBus CRC value. More...
#define | I2C_SMBUS_SET_PACKET_BYTE_COUNT(i2c, u32PktSize)
| Set SMBus Bytes number of Transmission or reception. More...
#define | I2C_SMBUS_ENABLE_ALERT(i2c)
| Enable SMBus Alert function. More...
#define | I2C_SMBUS_DISABLE_ALERT(i2c)
| Disable SMBus Alert pin function. More...
#define | I2C_SMBUS_SET_SUSCON_OUT(i2c)
| Set SMBus SUSCON pin is output mode. More...
#define | I2C_SMBUS_SET_SUSCON_IN(i2c)
| Set SMBus SUSCON pin is input mode. More...
#define | I2C_SMBUS_SET_SUSCON_HIGH(i2c)
| Set SMBus SUSCON pin output high state. More...
#define | I2C_SMBUS_SET_SUSCON_LOW(i2c)
| Set SMBus SUSCON pin output low state. More...
#define | I2C_SMBUS_ACK_MANUAL(i2c)
| Enable SMBus Acknowledge control by manual. More...
#define | I2C_SMBUS_ACK_AUTO(i2c)
| Disable SMBus Acknowledge control by manual. More...
#define | I2C_SMBUS_9THBIT_INT_ENABLE(i2c)
| Enable SMBus Acknowledge manual interrupt. More...
#define | I2C_SMBUS_9THBIT_INT_DISABLE(i2c)
| Disable SMBus Acknowledge manual interrupt. More...
#define | I2C_SMBUS_RST_PEC_AT_START_ENABLE(i2c)
| Enable SMBus PEC clear at REPEAT START. More...
#define | I2C_SMBUS_RST_PEC_AT_START_DISABLE(i2c)
| Disable SMBus PEC clear at Repeat START. More...
#define | I2C_ENABLE_RX_PDMA(i2c)
| Enable RX PDMA function. More...
#define | I2C_ENABLE_TX_PDMA(i2c)
| Enable TX PDMA function. More...
#define | I2C_DISABLE_RX_PDMA(i2c)
| Disable RX PDMA transfer. More...
#define | I2C_DISABLE_TX_PDMA(i2c)
| Disable TX PDMA transfer. More...
#define | I2C_ENABLE_PDMA_STRETCH(i2c)
| Enable PDMA stretch function. More...
#define | I2C_DISABLE_PDMA_STRETCH(i2c)
| Disable PDMA stretch function. More...
#define | I2C_DISABLE_RST_PDMA(i2c)
| Reset PDMA function. More...

## Functions
__STATIC_INLINE void | I2C_STOP (I2C_T *i2c)
| The macro is used to set STOP condition of I2C Bus. More...
void | I2C_ClearTimeoutFlag (I2C_T *i2c)
| Clear Time-out Counter flag. More...
void | I2C_Close (I2C_T *i2c)
| Disable specify I2C Controller. More...
void | I2C_Trigger (I2C_T *i2c, uint8_t u8Start, uint8_t u8Stop, uint8_t u8Si, uint8_t u8Ack)
| Set Control bit of I2C Controller. More...
void | I2C_DisableInt (I2C_T *i2c)
| Disable Interrupt of I2C Controller. More...
void | I2C_EnableInt (I2C_T *i2c)
| Enable Interrupt of I2C Controller. More...
uint32_t | I2C_GetBusClockFreq (I2C_T *i2c)
| Get I2C Bus Clock. More...
uint32_t | I2C_GetIntFlag (I2C_T *i2c)
| Get Interrupt Flag. More...
uint32_t | I2C_GetStatus (I2C_T *i2c)
| Get I2C Bus Status Code. More...
uint32_t | I2C_Open (I2C_T *i2c, uint32_t u32BusClock)
| Enable specify I2C Controller and set Clock Divider. More...
uint8_t | I2C_GetData (I2C_T *i2c)
| Read a Byte from I2C Bus. More...
void | I2C_SetSlaveAddr (I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddr, uint8_t u8GCMode)
| Set 7-bit Slave Address and GC Mode. More...
void | I2C_SetSlaveAddrMask (I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddrMask)
| Configure the mask bits of 7-bit Slave Address. More...
uint32_t | I2C_SetBusClockFreq (I2C_T *i2c, uint32_t u32BusClock)
| Set I2C Bus Clock. More...
void | I2C_EnableTimeout (I2C_T *i2c, uint8_t u8LongTimeout)
| Enable Time-out Counter Function and support Long Time-out. More...
void | I2C_DisableTimeout (I2C_T *i2c)
| Disable Time-out Counter Function. More...
void | I2C_EnableWakeup (I2C_T *i2c)
| Enable I2C Wake-up Function. More...
void | I2C_DisableWakeup (I2C_T *i2c)
| Disable I2C Wake-up Function. More...
void | I2C_SetData (I2C_T *i2c, uint8_t u8Data)
| Send a byte to I2C Bus. More...
void | I2C_SMBusClearInterruptFlag (I2C_T *i2c, uint8_t u8SMBusIntFlag)
| Clear SMBus Interrupt Flag. More...
uint8_t | I2C_WriteByte (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t data)
| Write a byte to Slave. More...
uint32_t | I2C_WriteMultiBytes (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t data[], uint32_t u32wLen)
| Write multi bytes to Slave. More...
uint8_t | I2C_WriteByteOneReg (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t data)
| Specify a byte register address and write a byte to Slave. More...
uint32_t | I2C_WriteMultiBytesOneReg (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t data[], uint32_t u32wLen)
| Specify a byte register address and write multi bytes to Slave. More...
uint8_t | I2C_WriteByteTwoRegs (I2C_T *i2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t data)
| Specify two bytes register address and Write a byte to Slave. More...
uint32_t | I2C_WriteMultiBytesTwoRegs (I2C_T *i2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t data[], uint32_t u32wLen)
| Specify two bytes register address and write multi bytes to Slave. More...
uint8_t | I2C_ReadByte (I2C_T *i2c, uint8_t u8SlaveAddr)
| Read a byte from Slave. More...
uint32_t | I2C_ReadMultiBytes (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t rdata[], uint32_t u32rLen)
| Read multi bytes from Slave. More...
uint8_t | I2C_ReadByteOneReg (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr)
| Specify a byte register address and read a byte from Slave. More...
uint32_t | I2C_ReadMultiBytesOneReg (I2C_T *i2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t rdata[], uint32_t u32rLen)
| Specify a byte register address and read multi bytes from Slave. More...
uint8_t | I2C_ReadByteTwoRegs (I2C_T *i2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr)
| Specify two bytes register address and read a byte from Slave. More...
uint32_t | I2C_ReadMultiBytesTwoRegs (I2C_T *i2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t rdata[], uint32_t u32rLen)
| Specify two bytes register address and read multi bytes from Slave. More...
uint32_t | I2C_SMBusGetStatus (I2C_T *i2c)
| To get SMBus Status. More...
void | I2C_SMBusSetPacketByteCount (I2C_T *i2c, uint32_t u32PktSize)
| Set SMBus Bytes Counts of Transmission or Reception. More...
void | I2C_SMBusOpen (I2C_T *i2c, uint8_t u8HostDevice)
| Init SMBus Host/Device Mode. More...
void | I2C_SMBusClose (I2C_T *i2c)
| Disable SMBus function. More...
void | I2C_SMBusPECTxEnable (I2C_T *i2c, uint8_t u8PECTxEn)
| Enable SMBus PEC Transmit Function. More...
uint8_t | I2C_SMBusGetPECValue (I2C_T *i2c)
| Get SMBus CRC value. More...
void | I2C_SMBusIdleTimeout (I2C_T *i2c, uint32_t us, uint32_t u32Hclk)
| Calculate Time-out of SMBus idle period. More...
void | I2C_SMBusTimeout (I2C_T *i2c, uint32_t ms, uint32_t u32Pclk)
| Calculate Time-out of SMBus active period. More...
void | I2C_SMBusClockLoTimeout (I2C_T *i2c, uint32_t ms, uint32_t u32Pclk)
| Calculate Cumulative Clock low Time-out of SMBus active period. More...

## Detailed Description

M480 series I2C driver header file.

Version
  V1.00 SPDX-License-Identifier: Apache-2.0

Copyright
  (C) 2016-2020 Nuvoton Technology Corp. All rights reserved.

Definition in file i2c.h.