| NUC029FAE BSP V3.01.002 The Board Support Package for NUC029FAE

i2c.h
Go to the documentation of this file.
1 /**************************************************************************/
12 #ifndef __I2C_H__
13 #define __I2C_H__
14
15 #ifdef __cplusplus
16 extern "C"
17 {
18 #endif
19
20
34 #define I2C_STA 0x20
35 #define I2C_STO 0x10
36 #define I2C_SI 0x08
37 #define I2C_AA 0x04
39 /* end of group NUC029FAE_I2C_EXPORTED_CONSTANTS */
40
41
52 #define I2C_SET_CONTROL_REG(i2c, u8Ctrl) ( (i2c)->I2CON = ((i2c)->I2CON & ~0x3c) | u8Ctrl )
53
59 #define I2C_START(i2c) ( (i2c)->I2CON = ((i2c)->I2CON & ~I2C_I2CON_SI_Msk) | I2C_I2CON_STA_Msk )
60
66 #define I2C_STOP(i2c) ( (i2c)->I2CON = ((i2c)->I2CON & ~I2C_I2CON_SI_Msk) | I2C_I2CON_STO_Msk )
67
73 #define I2C_WAIT_READY(i2c) while(!((i2c)->I2CON & I2C_I2CON_SI_Msk))
74
80 #define I2C_DISABLE_FIFO(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_TWOFF_EN_Msk )
81
87 #define I2C_ENABLE_FIFO(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_TWOFF_EN_Msk )
88
94 #define I2C_DISABLE_CLOCK_STRETCH(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_NOSTRETCH_Msk )
95
101 #define I2C_ENABLE_CLOCK_STRETCH(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_NOSTRETCH_Msk )
102
108 #define I2C_DISABLE_OVERRUN_INT(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_OVER_INTEN_Msk )
109
115 #define I2C_ENABLE_OVERRUN_INT(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_OVER_INTEN_Msk )
116
122 #define I2C_ENABLE_UNDERRUN_INT(i2c) ( (i2c)->I2CON2 |= I2C_I2CON2_UNDER_INTEN_Msk )
123
129 #define I2C_DISABLE_UNDERRUN_INT(i2c) ( (i2c)->I2CON2 &= ~I2C_I2CON2_UNDER_INTEN_Msk )
130
136 #define I2C_GET_DATA(i2c) ( (i2c)->I2CDAT )
137
144 #define I2C_SET_DATA(i2c, u8Data) ( (i2c)->I2CDAT = u8Data )
145
151 #define I2C_GET_STATUS(i2c) ( (i2c)->I2CSTATUS )
152
160 #define I2C_GET_TIMEOUT_FLAG(i2c) ( ((i2c)->I2CTOC & I2C_I2CTOC_TIF_Msk) == I2C_I2CTOC_TIF_Msk ? 1:0 )
161
169 #define I2C_GET_WAKEUP_FLAG(i2c) ( ((i2c)->I2CSTATUS2 & I2C_I2CSTATUS2_WAKEUP_Msk) == I2C_I2CSTATUS2_WAKEUP_Msk ? 1:0 )
170
176 #define I2C_CLEAR_WAKEUP_FLAG(i2c) ((i2c)->I2CSTATUS2 |= I2C_I2CSTATUS2_WAKEUP_Msk )
177
178 uint32_t I2C_Open(I2C_T *i2c, uint32_t u32BusClock);
179 void I2C_Close(I2C_T *i2c);
180 void I2C_ClearTimeoutFlag(I2C_T *i2c);
181 void I2C_Trigger(I2C_T *i2c, uint8_t u8Start, uint8_t u8Stop, uint8_t u8Si, uint8_t u8Ack);
182 void I2C_DisableInt(I2C_T *i2c);
183 void I2C_EnableInt(I2C_T *i2c);
184 uint32_t I2C_GetBusClockFreq(I2C_T *i2c);
185 uint32_t I2C_SetBusClockFreq(I2C_T *i2c, uint32_t u32BusClock);
186 uint32_t I2C_GetIntFlag(I2C_T *i2c);
187 uint32_t I2C_GetStatus(I2C_T *i2c);
188 uint32_t I2C_GetData(I2C_T *i2c);
189 void I2C_SetData(I2C_T *i2c, uint8_t u8Data);
190 void I2C_SetSlaveAddr(I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddr, uint8_t u8GCMode);
191 void I2C_SetSlaveAddrMask(I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddrMask);
192 void I2C_EnableTimeout(I2C_T *i2c, uint8_t u8LongTimeout);
193 void I2C_DisableTimeout(I2C_T *i2c);
194 void I2C_EnableWakeup(I2C_T *i2c);
195 void I2C_DisableWakeup(I2C_T *i2c);
196 /* end of group NUC029FAE_I2C_EXPORTED_FUNCTIONS */
198 /* end of group NUC029FAE_I2C_Driver */
200 /* end of group NUC029FAE_Device_Driver */
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif //__I2C_H__
208
209 /*** (C) COPYRIGHT 2013 Nuvoton Technology Corp. ***/
I2C_GetIntFlag
uint32_t I2C_GetIntFlag(I2C_T *i2c)
This function gets the interrupt flag (SI bit) of I2C module.
Definition: i2c.c:151
I2C_T
Definition: NUC029FAE.h:1040
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.
Definition: i2c.c:80
I2C_Close
void I2C_Close(I2C_T *i2c)
This function closes the I2C module.
Definition: i2c.c:51
I2C_SetData
void I2C_SetData(I2C_T *i2c, uint8_t u8Data)
This function writes the data to data register of I2C module.
Definition: i2c.c:182
I2C_EnableWakeup
void I2C_EnableWakeup(I2C_T *i2c)
This function enables the wakeup function of I2C module.
Definition: i2c.c:275
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".
Definition: i2c.c:223
I2C_SetBusClockFreq
uint32_t I2C_SetBusClockFreq(I2C_T *i2c, uint32_t u32BusClock)
This function enables the interrupt (EI bit) of I2C module.
Definition: i2c.c:134
I2C_GetBusClockFreq
uint32_t I2C_GetBusClockFreq(I2C_T *i2c)
This function returns the real bus clock of I2C module.
Definition: i2c.c:121
I2C_DisableTimeout
void I2C_DisableTimeout(I2C_T *i2c)
This function disables timeout function.
Definition: i2c.c:265
I2C_GetData
uint32_t I2C_GetData(I2C_T *i2c)
This function returns the data stored in data register of I2C module.
Definition: i2c.c:171
I2C_DisableInt
void I2C_DisableInt(I2C_T *i2c)
This function disables the interrupt (EI bit) of I2C module.
Definition: i2c.c:101
I2C_ClearTimeoutFlag
void I2C_ClearTimeoutFlag(I2C_T *i2c)
This function clears the timeout flag.
Definition: i2c.c:66
I2C_DisableWakeup
void I2C_DisableWakeup(I2C_T *i2c)
This function disables the wakeup function of I2C module.
Definition: i2c.c:285
I2C_GetStatus
uint32_t I2C_GetStatus(I2C_T *i2c)
This function returns the status of I2C module.
Definition: i2c.c:161
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.
Definition: i2c.c:33
I2C_EnableInt
void I2C_EnableInt(I2C_T *i2c)
This function enables the interrupt (EI bit) of I2C module.
Definition: i2c.c:111
I2C_SetSlaveAddr
void I2C_SetSlaveAddr(I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddr, uint8_t u8GCMode)
Configure slave address and enable GC mode.
Definition: i2c.c:195
I2C_EnableTimeout
void I2C_EnableTimeout(I2C_T *i2c, uint8_t u8LongTimeout)
This function enables timeout function and configures DIV4 function to support long timeout.
Definition: i2c.c:250