| Mini51 BSP V3.02.002 The Board Support Package for Mini51 Series

Macros | Functions
i2c.h File Reference

Mini51 series I2C driver header file. More...

Go to the source code of this file.

## Macros
#define | I2C_STA 0x20
#define | I2C_STO 0x10
#define | I2C_SI 0x08
#define | I2C_AA 0x04
#define | I2C_SET_CONTROL_REG(i2c, u8Ctrl) ( (i2c)->I2CON = ((i2c)->I2CON & ~0x3c) | u8Ctrl )
| This macro sets the I2C control register at one time. More...
#define | I2C_START(i2c) ( (i2c)->I2CON = ((i2c)->I2CON & ~I2C_I2CON_SI_Msk) | I2C_I2CON_STA_Msk )
| This macro only set START bit to the control register of I2C module. More...
#define | I2C_STOP(i2c)
| This macro only set STOP bit to the control register of I2C module. More...
#define | I2C_WAIT_READY(i2c) while(!((i2c)->I2CON & I2C_I2CON_SI_Msk))
| This macro will return when I2C module is ready. More...
#define | I2C_DISABLE_FIFO(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_TWOFF_EN_Msk )
| This macro disables the FIFO function. More...
#define | I2C_ENABLE_FIFO(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_TWOFF_EN_Msk )
| This macro enables the FIFO function. More...
#define | I2C_DISABLE_CLOCK_STRETCH(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_NOSTRETCH_Msk )
| This macro disables clock stretch function. More...
#define | I2C_ENABLE_CLOCK_STRETCH(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_NOSTRETCH_Msk )
| This macro enables clock stretch function. More...
#define | I2C_DISABLE_OVERRUN_INT(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_OVER_INTEN_Msk )
| This macro disables over-run interrupt. More...
#define | I2C_ENABLE_OVERRUN_INT(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_OVER_INTEN_Msk )
| This macro enables over-run interrupt. More...
#define | I2C_ENABLE_UNDERRUN_INT(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_UNDER_INTEN_Msk )
| This macro enables under-run interrupt. More...
#define | I2C_DISABLE_UNDERRUN_INT(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_UNDER_INTEN_Msk )
| This macro disables under-run interrupt. More...
#define | I2C_GET_DATA(i2c) ( (i2c)->I2CDAT )
| This macro returns the data stored in data register of I2C module. More...
#define | I2C_SET_DATA(i2c, u8Data) ( (i2c)->I2CDAT = u8Data )
| This macro writes the data to data register of I2C module. More...
#define | I2C_GET_STATUS(i2c) ( (i2c)->I2CSTATUS )
| This macro returns the status of I2C module. More...
#define | I2C_GET_TIMEOUT_FLAG(i2c) ( ((i2c)->I2CTOC & I2C_I2CTOC_TIF_Msk) == I2C_I2CTOC_TIF_Msk ? 1:0 )
| This macro returns timeout flag. More...
#define | I2C_GET_WAKEUP_FLAG(i2c) ( ((i2c)->I2CSTATUS2 & I2C_I2CSTATUS2_WAKEUP_Msk) == I2C_I2CSTATUS2_WAKEUP_Msk ? 1:0 )
| This macro returns wakeup flag. More...
#define | I2C_CLEAR_WAKEUP_FLAG(i2c) ((i2c)->I2CSTATUS2 |= I2C_I2CSTATUS2_WAKEUP_Msk )
| This macro clears wakeup flag. More...

## Functions
uint32_t | I2C_Open (I2C_T *i2c, uint32_t u32BusClock)
| This function make I2C module be ready and set the wanted bus clock. More...
void | I2C_Close (I2C_T *i2c)
| This function closes the I2C module. More...
void | I2C_ClearTimeoutFlag (I2C_T *i2c)
| This function clears the timeout flag. More...
void | I2C_Trigger (I2C_T *i2c, uint8_t u8Start, uint8_t u8Stop, uint8_t u8Si, uint8_t u8Ack)
| This function sets the control bit of the I2C module. More...
void | I2C_DisableInt (I2C_T *i2c)
| This function disables the interrupt (EI bit) of I2C module. More...
void | I2C_EnableInt (I2C_T *i2c)
| This function enables the interrupt (EI bit) of I2C module. More...
uint32_t | I2C_GetBusClockFreq (I2C_T *i2c)
| This function returns the real bus clock of I2C module. More...
uint32_t | I2C_SetBusClockFreq (I2C_T *i2c, uint32_t u32BusClock)
| This function enables the interrupt (EI bit) of I2C module. More...
uint32_t | I2C_GetIntFlag (I2C_T *i2c)
| This function gets the interrupt flag (SI bit) of I2C module. More...
uint32_t | I2C_GetStatus (I2C_T *i2c)
| This function returns the status of I2C module. More...
uint32_t | I2C_GetData (I2C_T *i2c)
| This function returns the data stored in data register of I2C module. More...
void | I2C_SetData (I2C_T *i2c, uint8_t u8Data)
| This function writes the data to data register of I2C module. More...
void | I2C_SetSlaveAddr (I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddr, uint8_t u8GCMode)
| Configure slave address and enable GC mode. More...
void | I2C_SetSlaveAddrMask (I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddrMask)
| Configure the mask of slave address. The corresponding address bit is "Don't Care". More...
void | I2C_EnableTimeout (I2C_T *i2c, uint8_t u8LongTimeout)
| This function enables timeout function and configures DIV4 function to support long timeout. More...
void | I2C_DisableTimeout (I2C_T *i2c)
| This function disables timeout function. More...
void | I2C_EnableWakeup (I2C_T *i2c)
| This function enables the wakeup function of I2C module. More...
void | I2C_DisableWakeup (I2C_T *i2c)
| This function disables the wakeup function of I2C module. More...

## Detailed Description

Mini51 series I2C driver header file.

Version
  V1.00

Revision
  12

Date
  15/12/31 1:06p

Note
  SPDX-License-Identifier: Apache-2.0 Copyright (C) 2013 Nuvoton Technology Corp. All rights reserved.

Definition in file i2c.h.