Nano102_112 Series BSP  V3.03.002
The Board Support Package for Nano102_112 Series
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 
33 #define I2C_STA 0x08
34 #define I2C_STO 0x04
35 #define I2C_SI 0x10
36 #define I2C_AA 0x02
38 #define I2C_GCMODE_ENABLE 1
39 #define I2C_GCMODE_DISABLE 0
41  /* end of group NANO1X2_I2C_EXPORTED_CONSTANTS */
42 
43 
55 #define I2C_SET_CONTROL_REG(i2c, u8Ctrl) ( (i2c)->CON = ((i2c)->CON & ~0x1e) | u8Ctrl )
56 
63 #define I2C_START(i2c) ( (i2c)->CON = ((i2c)->CON & ~I2C_CON_I2C_STS_Msk) | I2C_CON_START_Msk )
64 
71 #define I2C_STOP(i2c) \
72 do { \
73  (i2c)->CON |= (I2C_CON_I2C_STS_Msk | I2C_CON_STOP_Msk); \
74  while((i2c)->CON & I2C_CON_STOP_Msk); \
75 } while(0)
76 
83 #define I2C_WAIT_READY(i2c) \
84 do { \
85  while(!((i2c)->INTSTS & I2C_INTSTS_INTSTS_Msk)); \
86  (i2c)->INTSTS |= I2C_INTSTS_INTSTS_Msk; \
87 } while(0)
88 
95 #define I2C_GET_DATA(i2c) ((i2c)->DATA )
96 
104 #define I2C_SET_DATA(i2c, u8Data) ( (i2c)->DATA = u8Data )
105 
112 #define I2C_GET_STATUS(i2c) ( (i2c)->STATUS )
113 
122 #define I2C_GET_TIMEOUT_FLAG(i2c) ( ((i2c)->INTSTS & I2C_INTSTS_TIF_Msk) == I2C_INTSTS_TIF_Msk ? 1:0 )
123 
130 #define I2C_CLEAR_TIMEOUT_FLAG(i2c) ( (i2c)->INTSTS |= I2C_INTSTS_TIF_Msk )
131 
140 #define I2C_GET_WAKEUP_FLAG(i2c) ( ((i2c)->STATUS2 & I2C_STATUS2_WKUPIF_Msk) == I2C_STATUS2_WKUPIF_Msk ? 1:0 )
141 
150 #define I2C_GET_WAKEUP_ACK_DONE_FLAG(i2c) ( ((i2c)->INTSTS & I2C_INTSTS_WAKEUP_ACK_DONE_Msk) == I2C_INTSTS_WAKEUP_ACK_DONE_Msk ? 1:0 )
151 
158 #define I2C_CLEAR_WAKEUP_FLAG(i2c) ( (i2c)->STATUS2 |= I2C_STATUS2_WKUPIF_Msk )
159 
167 #define I2C_CLEAR_WAKEUP_ACK_DONE_FLAG(i2c) ( (i2c)->INTSTS |= I2C_INTSTS_WAKEUP_ACK_DONE_Msk )
168 
175 #define I2C_DISABLE_FIFO(i2c) ( (i2c)->CON2 &= ~I2C_CON2_TWOFF_EN_Msk )
176 
183 #define I2C_ENABLE_FIFO(i2c) ( (i2c)->CON2 |= I2C_CON2_TWOFF_EN_Msk )
184 
191 #define I2C_DISABLE_CLOCK_STRETCH(i2c) ( (i2c)->CON2 |= I2C_CON2_NOSTRETCH_Msk )
192 
199 #define I2C_ENABLE_CLOCK_STRETCH(i2c) ( (i2c)->CON2 &= ~I2C_CON2_NOSTRETCH_Msk )
200 
207 #define I2C_DISABLE_OVERRUN_INT(i2c) ( (i2c)->CON2 &= ~I2C_CON2_OVER_INTEN_Msk )
208 
215 #define I2C_ENABLE_OVERRUN_INT(i2c) ( (i2c)->CON2 |= I2C_CON2_OVER_INTEN_Msk )
216 
223 #define I2C_ENABLE_UNDERRUN_INT(i2c) ( (i2c)->CON2 |= I2C_CON2_UNDER_INTEN_Msk )
224 
231 #define I2C_DISABLE_UNDERRUN_INT(i2c) ((i2c)->CON2 &= ~I2C_CON2_UNDER_INTEN_Msk )
232 
241 #define I2C_GET_BUS_FREE_FLAG(i2c) ( ((i2c)->STATUS2 & I2C_STATUS2_BUS_FREE_Msk) == I2C_STATUS2_BUS_FREE_Msk ? 1:0 )
242 
252 #define I2C_GET_WAKEUP_RW_FLAG(i2c) ( ((i2c)->STATUS2 & I2C_STATUS2_WR_STATUS_Msk) == I2C_STATUS2_WR_STATUS_Msk ? 1:0 )
253 
254 uint32_t I2C_Open(I2C_T *i2c, uint32_t u32BusClock);
255 void I2C_Close(I2C_T *i2c);
256 void I2C_ClearTimeoutFlag(I2C_T *i2c);
257 void I2C_Trigger(I2C_T *i2c, uint8_t u8Start, uint8_t u8Stop, uint8_t u8Si, uint8_t u8Ack);
258 void I2C_DisableInt(I2C_T *i2c);
259 void I2C_EnableInt(I2C_T *i2c);
260 uint32_t I2C_GetBusClockFreq(I2C_T *i2c);
261 uint32_t I2C_SetBusClockFreq(I2C_T *i2c, uint32_t u32BusClock);
262 uint32_t I2C_GetIntFlag(I2C_T *i2c);
263 void I2C_ClearIntFlag(I2C_T *i2c);
264 uint32_t I2C_GetStatus(I2C_T *i2c);
265 uint32_t I2C_GetData(I2C_T *i2c);
266 void I2C_SetData(I2C_T *i2c, uint8_t u8Data);
267 void I2C_SetSlaveAddr(I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddr, uint8_t u8GCMode);
268 void I2C_SetSlaveAddrMask(I2C_T *i2c, uint8_t u8SlaveNo, uint8_t u8SlaveAddrMask);
269 void I2C_EnableTimeout(I2C_T *i2c, uint8_t u8LongTimeout);
270 void I2C_DisableTimeout(I2C_T *i2c);
271 void I2C_EnableWakeup(I2C_T *i2c);
272 void I2C_DisableWakeup(I2C_T *i2c);
273  /* end of group NANO1X2_I2C_EXPORTED_FUNCTIONS */
275  /* end of group NANO1X2_I2C_Driver */
277  /* end of group NANO1X2_Device_Driver */
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 
284 #endif //__I2C_H__
285 
286 /*** (C) COPYRIGHT 2014 Nuvoton Technology Corp. ***/
void I2C_EnableWakeup(I2C_T *i2c)
This function enables the wakeup function of I2C module.
Definition: i2c.c:287
void I2C_SetData(I2C_T *i2c, uint8_t u8Data)
This function writes the data to data register of I2C module.
Definition: i2c.c:204
void I2C_ClearIntFlag(I2C_T *i2c)
This function clears the interrupt flag of I2C module.
Definition: i2c.c:173
uint32_t I2C_GetIntFlag(I2C_T *i2c)
This function gets the interrupt flag of I2C module.
Definition: i2c.c:163
void I2C_DisableInt(I2C_T *i2c)
This function disables the interrupt of I2C module.
Definition: i2c.c:112
void I2C_DisableWakeup(I2C_T *i2c)
This function disables the wakeup function of I2C module.
Definition: i2c.c:297
uint32_t I2C_GetData(I2C_T *i2c)
This function returns the data stored in data register of I2C module.
Definition: i2c.c:193
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:241
void I2C_Close(I2C_T *i2c)
This function closes the I2C module.
Definition: i2c.c:53
void I2C_EnableInt(I2C_T *i2c)
This function enables the interrupt (EI bit) of I2C module.
Definition: i2c.c:122
uint32_t I2C_SetBusClockFreq(I2C_T *i2c, uint32_t u32BusClock)
This function sets bus frequency of I2C module.
Definition: i2c.c:145
void I2C_DisableTimeout(I2C_T *i2c)
This function disables timeout function.
Definition: i2c.c:277
uint32_t I2C_GetBusClockFreq(I2C_T *i2c)
This function returns the real bus clock of I2C module.
Definition: i2c.c:132
void I2C_ClearTimeoutFlag(I2C_T *i2c)
This function clears the timeout flag.
Definition: i2c.c:76
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:90
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:34
uint32_t I2C_GetStatus(I2C_T *i2c)
This function returns the status of I2C module.
Definition: i2c.c:183
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:262
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:219