NANO103 BSP V3.01.004
The Board Support Package for Nano103 Series
Macros | Functions
Collaboration diagram for I2C Exported Functions:

Macros

#define I2C_SET_CONTROL_REG(i2c, u8Ctrl)
 This macro sets the I2C control register at one time. More...
 
#define I2C_START(i2c)
 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)
 This macro will return when I2C module is ready and flag is cleared. More...
 
#define I2C_GET_DATA(i2c)
 This macro returns the data stored in data register of I2C module. More...
 
#define I2C_SET_DATA(i2c, u8Data)
 This macro writes the data to data register of I2C module. More...
 
#define I2C_GET_STATUS(i2c)
 This macro returns the status of I2C module. More...
 
#define I2C_GET_TIMEOUT_FLAG(i2c)
 This macro returns timeout flag. More...
 
#define I2C_CLEAR_TIMEOUT_FLAG(i2c)
 This macro clears timeout flag. More...
 
#define I2C_GET_WAKEUP_FLAG(i2c)
 This macro returns wakeup flag. More...
 
#define I2C_GET_WAKEUP_ACK_DONE_FLAG(i2c)
 This macro returns acknowledge status after waking up. More...
 
#define I2C_CLEAR_WAKEUP_FLAG(i2c)
 This macro clears wakeup flag. More...
 
#define I2C_CLEAR_WAKEUP_ACK_DONE_FLAG(i2c)
 This macro clears acknowledge status after waking up. And also release SCK pin after clearing this flag. More...
 
#define I2C_DISABLE_FIFO(i2c)
 This macro disables the FIFO function. More...
 
#define I2C_ENABLE_FIFO(i2c)
 This macro enables the FIFO function. More...
 
#define I2C_DISABLE_CLOCK_STRETCH(i2c)
 This macro disables clock stretch function. More...
 
#define I2C_ENABLE_CLOCK_STRETCH(i2c)
 This macro enables clock stretch function. More...
 
#define I2C_DISABLE_OVERRUN_INT(i2c)
 This macro disables over-run interrupt. More...
 
#define I2C_ENABLE_OVERRUN_INT(i2c)
 This macro enables over-run interrupt. More...
 
#define I2C_ENABLE_UNDERRUN_INT(i2c)
 This macro enables under-run interrupt. More...
 
#define I2C_DISABLE_UNDERRUN_INT(i2c)
 This macro disables under-run interrupt. More...
 
#define I2C_GET_BUS_FREE_FLAG(i2c)
 This macro returns I2C bus status flag. More...
 
#define I2C_GET_WAKEUP_RW_FLAG(i2c)
 This macro returns wakeup read/write flag. After system wake up, this bit indicates that the master wants to read or write in R/W bit of I2C data. More...
 
#define I2C_DISABLE_DATAMODE(i2c)
 This macro disables the data mode. More...
 
#define I2C_ENABLE_DATAMODE(i2c)
 This macro enables the data mode. More...
 
#define I2C_SET_DATAMODE_WRITE(i2c)
 This macro sets write direction of data mode for master. More...
 
#define I2C_SET_DATAMODE_READ(i2c)
 This macro sets read direction of data mode for slave. 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 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 sets bus frequency of I2C module. More...
 
uint32_t I2C_GetIntFlag (I2C_T *i2c)
 This function gets the interrupt flag of I2C module. More...
 
void I2C_ClearIntFlag (I2C_T *i2c)
 This function clears the interrupt flag 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

Macro Definition Documentation

◆ I2C_CLEAR_TIMEOUT_FLAG

#define I2C_CLEAR_TIMEOUT_FLAG (   i2c)

This macro clears timeout flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 132 of file i2c.h.

◆ I2C_CLEAR_WAKEUP_ACK_DONE_FLAG

#define I2C_CLEAR_WAKEUP_ACK_DONE_FLAG (   i2c)

This macro clears acknowledge status after waking up. And also release SCK pin after clearing this flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 169 of file i2c.h.

◆ I2C_CLEAR_WAKEUP_FLAG

#define I2C_CLEAR_WAKEUP_FLAG (   i2c)

This macro clears wakeup flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 160 of file i2c.h.

◆ I2C_DISABLE_CLOCK_STRETCH

#define I2C_DISABLE_CLOCK_STRETCH (   i2c)

This macro disables clock stretch function.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 193 of file i2c.h.

◆ I2C_DISABLE_DATAMODE

#define I2C_DISABLE_DATAMODE (   i2c)

This macro disables the data mode.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 262 of file i2c.h.

◆ I2C_DISABLE_FIFO

#define I2C_DISABLE_FIFO (   i2c)

This macro disables the FIFO function.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 177 of file i2c.h.

◆ I2C_DISABLE_OVERRUN_INT

#define I2C_DISABLE_OVERRUN_INT (   i2c)

This macro disables over-run interrupt.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 209 of file i2c.h.

◆ I2C_DISABLE_UNDERRUN_INT

#define I2C_DISABLE_UNDERRUN_INT (   i2c)

This macro disables under-run interrupt.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 233 of file i2c.h.

◆ I2C_ENABLE_CLOCK_STRETCH

#define I2C_ENABLE_CLOCK_STRETCH (   i2c)

This macro enables clock stretch function.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 201 of file i2c.h.

◆ I2C_ENABLE_DATAMODE

#define I2C_ENABLE_DATAMODE (   i2c)

This macro enables the data mode.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 270 of file i2c.h.

◆ I2C_ENABLE_FIFO

#define I2C_ENABLE_FIFO (   i2c)

This macro enables the FIFO function.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 185 of file i2c.h.

◆ I2C_ENABLE_OVERRUN_INT

#define I2C_ENABLE_OVERRUN_INT (   i2c)

This macro enables over-run interrupt.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 217 of file i2c.h.

◆ I2C_ENABLE_UNDERRUN_INT

#define I2C_ENABLE_UNDERRUN_INT (   i2c)

This macro enables under-run interrupt.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 225 of file i2c.h.

◆ I2C_GET_BUS_FREE_FLAG

#define I2C_GET_BUS_FREE_FLAG (   i2c)

This macro returns I2C bus status flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.
Return values
0Bus is busy.
1Bus is free.

Definition at line 243 of file i2c.h.

◆ I2C_GET_DATA

#define I2C_GET_DATA (   i2c)

This macro returns the data stored in data register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
Data.

Definition at line 97 of file i2c.h.

◆ I2C_GET_STATUS

#define I2C_GET_STATUS (   i2c)

This macro returns the status of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.

Definition at line 114 of file i2c.h.

◆ I2C_GET_TIMEOUT_FLAG

#define I2C_GET_TIMEOUT_FLAG (   i2c)

This macro returns timeout flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.
Return values
0Flag is not set.
1Flag is set.

Definition at line 124 of file i2c.h.

◆ I2C_GET_WAKEUP_ACK_DONE_FLAG

#define I2C_GET_WAKEUP_ACK_DONE_FLAG (   i2c)

This macro returns acknowledge status after waking up.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.
Return values
0Acknowledge signal isn't detected.
1Acknowledge signal is detected.

Definition at line 152 of file i2c.h.

◆ I2C_GET_WAKEUP_FLAG

#define I2C_GET_WAKEUP_FLAG (   i2c)

This macro returns wakeup flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.
Return values
0Flag is not set.
1Flag is set.

Definition at line 142 of file i2c.h.

◆ I2C_GET_WAKEUP_RW_FLAG

#define I2C_GET_WAKEUP_RW_FLAG (   i2c)

This macro returns wakeup read/write flag. After system wake up, this bit indicates that the master wants to read or write in R/W bit of I2C data.

Parameters
[in]i2cis the base address of I2C module.
Returns
Status.
Return values
0Write command.
1Read command.

Definition at line 254 of file i2c.h.

◆ I2C_SET_CONTROL_REG

#define I2C_SET_CONTROL_REG (   i2c,
  u8Ctrl 
)

This macro sets the I2C control register at one time.

Parameters
[in]i2cis the base address of I2C module.
[in]u8Ctrlis the register value of I2C control register.
Returns
none

Definition at line 57 of file i2c.h.

◆ I2C_SET_DATA

#define I2C_SET_DATA (   i2c,
  u8Data 
)

This macro writes the data to data register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
[in]u8Datais the data which will be write to data register of I2C module.
Returns
none

Definition at line 106 of file i2c.h.

◆ I2C_SET_DATAMODE_READ

#define I2C_SET_DATAMODE_READ (   i2c)

This macro sets read direction of data mode for slave.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 286 of file i2c.h.

◆ I2C_SET_DATAMODE_WRITE

#define I2C_SET_DATAMODE_WRITE (   i2c)

This macro sets write direction of data mode for master.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 278 of file i2c.h.

◆ I2C_START

#define I2C_START (   i2c)

This macro only set START bit to the control register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 65 of file i2c.h.

◆ I2C_STOP

#define I2C_STOP (   i2c)

This macro only set STOP bit to the control register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 73 of file i2c.h.

◆ I2C_WAIT_READY

#define I2C_WAIT_READY (   i2c)

This macro will return when I2C module is ready and flag is cleared.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 85 of file i2c.h.

Function Documentation

◆ I2C_ClearIntFlag()

void I2C_ClearIntFlag ( I2C_T i2c)

This function clears the interrupt flag of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 183 of file i2c.c.

◆ I2C_ClearTimeoutFlag()

void I2C_ClearTimeoutFlag ( I2C_T i2c)

This function clears the timeout flag.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 74 of file i2c.c.

◆ I2C_Close()

void I2C_Close ( I2C_T i2c)

This function closes the I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 51 of file i2c.c.

◆ I2C_DisableInt()

void I2C_DisableInt ( I2C_T i2c)

This function disables the interrupt of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 110 of file i2c.c.

◆ I2C_DisableTimeout()

void I2C_DisableTimeout ( I2C_T i2c)

This function disables timeout function.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 287 of file i2c.c.

◆ I2C_DisableWakeup()

void I2C_DisableWakeup ( I2C_T i2c)

This function disables the wakeup function of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 307 of file i2c.c.

◆ I2C_EnableInt()

void I2C_EnableInt ( I2C_T i2c)

This function enables the interrupt (EI bit) of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 120 of file i2c.c.

◆ I2C_EnableTimeout()

void I2C_EnableTimeout ( I2C_T i2c,
uint8_t  u8LongTimeout 
)

This function enables timeout function and configures DIV4 function to support long timeout.

Parameters
[in]i2cis the base address of I2C module.
[in]u8LongTimeoutEnable timeout counter input clock is divide by 4.
Returns
none

Definition at line 272 of file i2c.c.

◆ I2C_EnableWakeup()

void I2C_EnableWakeup ( I2C_T i2c)

This function enables the wakeup function of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
none

Definition at line 297 of file i2c.c.

◆ I2C_GetBusClockFreq()

uint32_t I2C_GetBusClockFreq ( I2C_T i2c)

This function returns the real bus clock of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
Actual I2C bus clock frequency.

Definition at line 130 of file i2c.c.

Here is the call graph for this function:

◆ I2C_GetData()

uint32_t I2C_GetData ( I2C_T i2c)

This function returns the data stored in data register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
Data.

Definition at line 203 of file i2c.c.

◆ I2C_GetIntFlag()

uint32_t I2C_GetIntFlag ( I2C_T i2c)

This function gets the interrupt flag of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
Interrupt flag.
Return values
0Flag is not set.
1Flag is set.

Definition at line 173 of file i2c.c.

◆ I2C_GetStatus()

uint32_t I2C_GetStatus ( I2C_T i2c)

This function returns the status of I2C module.

Parameters
[in]i2cis the base address of I2C module.
Returns
I2C status

Definition at line 193 of file i2c.c.

◆ I2C_Open()

uint32_t I2C_Open ( I2C_T i2c,
uint32_t  u32BusClock 
)

This function make I2C module be ready and set the wanted bus clock.

Parameters
[in]i2cis the base address of I2C module.
[in]u32BusClockis the target bus speed of I2C module.
Returns
Actual I2C bus clock frequency.

Definition at line 34 of file i2c.c.

Here is the call graph for this function:

◆ I2C_SetBusClockFreq()

uint32_t I2C_SetBusClockFreq ( I2C_T i2c,
uint32_t  u32BusClock 
)

This function sets bus frequency of I2C module.

Parameters
[in]i2cis the base address of I2C module.
[in]u32BusClockis the target bus speed of I2C module.
Returns
Actual I2C bus clock frequency.

Definition at line 146 of file i2c.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ I2C_SetData()

void I2C_SetData ( I2C_T i2c,
uint8_t  u8Data 
)

This function writes the data to data register of I2C module.

Parameters
[in]i2cis the base address of I2C module.
[in]u8Datais the data which will be write to data register of I2C module.
Returns
none

Definition at line 214 of file i2c.c.

◆ I2C_SetSlaveAddr()

void I2C_SetSlaveAddr ( I2C_T i2c,
uint8_t  u8SlaveNo,
uint8_t  u8SlaveAddr,
uint8_t  u8GCMode 
)

Configure slave address and enable GC mode.

Parameters
[in]i2cis the base address of I2C module.
[in]u8SlaveNois the set number of salve address.
[in]u8SlaveAddris the slave address.
[in]u8GCModeGC mode enable or not. Valid values are:
Returns
none

Definition at line 229 of file i2c.c.

◆ I2C_SetSlaveAddrMask()

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".

Parameters
[in]i2cis the base address of I2C module.
[in]u8SlaveNois the set number of salve address.
[in]u8SlaveAddrMaskis the slave address mask.
Returns
none

Definition at line 251 of file i2c.c.

◆ I2C_Trigger()

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.

Parameters
[in]i2cis the base address of I2C module.
[in]u8Startsets START bit to I2C module.
[in]u8Stopsets STOP bit to I2C module.
[in]u8Sisets SI bit to I2C module.
[in]u8Acksets ACK bit to I2C module.
Returns
none

Definition at line 88 of file i2c.c.