usci_i2c.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. /**************************************************************************//**
  2. * @file USCI_I2C.h
  3. * @version V3.0
  4. * @brief M480 series USCI I2C(UI2C) driver header file
  5. *
  6. * @copyright (C) 2016 Nuvoton Technology Corp. All rights reserved.
  7. ******************************************************************************/
  8. #ifndef __USCI_I2C_H__
  9. #define __USCI_I2C_H__
  10. #ifdef __cplusplus
  11. extern "C"
  12. {
  13. #endif
  14. /** @addtogroup Standard_Driver Standard Driver
  15. @{
  16. */
  17. /** @addtogroup USCI_I2C_Driver USCI_I2C Driver
  18. @{
  19. */
  20. /** @addtogroup USCI_I2C_EXPORTED_CONSTANTS USCI_I2C Exported Constants
  21. @{
  22. */
  23. /*---------------------------------------------------------------------------------------------------------*/
  24. /* USCI_I2C master event definitions */
  25. /*---------------------------------------------------------------------------------------------------------*/
  26. enum UI2C_MASTER_EVENT
  27. {
  28. MASTER_SEND_ADDRESS = 10, /*!< Master send address to Slave */
  29. MASTER_SEND_H_WR_ADDRESS, /*!< Master send High address to Slave */
  30. MASTER_SEND_H_RD_ADDRESS, /*!< Master send address to Slave (Read ADDR) */
  31. MASTER_SEND_L_ADDRESS, /*!< Master send Low address to Slave */
  32. MASTER_SEND_DATA, /*!< Master Send Data to Slave */
  33. MASTER_SEND_REPEAT_START, /*!< Master send repeat start to Slave */
  34. MASTER_READ_DATA, /*!< Master Get Data from Slave */
  35. MASTER_STOP, /*!< Master send stop to Slave */
  36. MASTER_SEND_START /*!< Master send start to Slave */
  37. };
  38. /*---------------------------------------------------------------------------------------------------------*/
  39. /* USCI_I2C slave event definitions */
  40. /*---------------------------------------------------------------------------------------------------------*/
  41. enum UI2C_SLAVE_EVENT
  42. {
  43. SLAVE_ADDRESS_ACK = 100, /*!< Slave send address ACK */
  44. SLAVE_H_WR_ADDRESS_ACK, /*!< Slave send High address ACK */
  45. SLAVE_L_WR_ADDRESS_ACK, /*!< Slave send Low address ACK */
  46. SLAVE_GET_DATA, /*!< Slave Get Data from Master (Write CMD) */
  47. SLAVE_SEND_DATA, /*!< Slave Send Data to Master (Read CMD) */
  48. SLAVE_H_RD_ADDRESS_ACK, /*!< Slave send High address ACK */
  49. SLAVE_L_RD_ADDRESS_ACK /*!< Slave send Low address ACK */
  50. };
  51. /*---------------------------------------------------------------------------------------------------------*/
  52. /* USCI_CTL constant definitions. */
  53. /*---------------------------------------------------------------------------------------------------------*/
  54. #define UI2C_CTL_PTRG 0x20UL /*!< USCI_CTL setting for I2C control bits. It would set PTRG bit \hideinitializer */
  55. #define UI2C_CTL_STA 0x08UL /*!< USCI_CTL setting for I2C control bits. It would set STA bit \hideinitializer */
  56. #define UI2C_CTL_STO 0x04UL /*!< USCI_CTL setting for I2C control bits. It would set STO bit \hideinitializer */
  57. #define UI2C_CTL_AA 0x02UL /*!< USCI_CTL setting for I2C control bits. It would set AA bit \hideinitializer */
  58. /*---------------------------------------------------------------------------------------------------------*/
  59. /* USCI_I2C GCMode constant definitions. */
  60. /*---------------------------------------------------------------------------------------------------------*/
  61. #define UI2C_GCMODE_ENABLE (1U) /*!< Enable USCI_I2C GC Mode \hideinitializer */
  62. #define UI2C_GCMODE_DISABLE (0U) /*!< Disable USCI_I2C GC Mode \hideinitializer */
  63. /*---------------------------------------------------------------------------------------------------------*/
  64. /* USCI_I2C Wakeup Mode constant definitions. */
  65. /*---------------------------------------------------------------------------------------------------------*/
  66. #define UI2C_DATA_TOGGLE_WK (0x0U << UI2C_WKCTL_WKADDREN_Pos) /*!< Wakeup according data toggle \hideinitializer */
  67. #define UI2C_ADDR_MATCH_WK (0x1U << UI2C_WKCTL_WKADDREN_Pos) /*!< Wakeup according address match \hideinitializer */
  68. /*---------------------------------------------------------------------------------------------------------*/
  69. /* USCI_I2C interrupt mask definitions */
  70. /*---------------------------------------------------------------------------------------------------------*/
  71. #define UI2C_TO_INT_MASK (0x001U) /*!< Time-out interrupt mask \hideinitializer */
  72. #define UI2C_STAR_INT_MASK (0x002U) /*!< Start condition received interrupt mask \hideinitializer */
  73. #define UI2C_STOR_INT_MASK (0x004U) /*!< Stop condition received interrupt mask \hideinitializer */
  74. #define UI2C_NACK_INT_MASK (0x008U) /*!< Non-acknowledge interrupt mask \hideinitializer */
  75. #define UI2C_ARBLO_INT_MASK (0x010U) /*!< Arbitration lost interrupt mask \hideinitializer */
  76. #define UI2C_ERR_INT_MASK (0x020U) /*!< Error interrupt mask \hideinitializer */
  77. #define UI2C_ACK_INT_MASK (0x040U) /*!< Acknowledge interrupt mask \hideinitializer */
  78. /*@}*/ /* end of group USCI_I2C_EXPORTED_CONSTANTS */
  79. /** @addtogroup USCI_I2C_EXPORTED_FUNCTIONS USCI_I2C Exported Functions
  80. @{
  81. */
  82. /**
  83. * @brief This macro sets the USCI_I2C protocol control register at one time
  84. *
  85. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  86. * @param[in] u8Ctrl Set the register value of USCI_I2C control register.
  87. *
  88. * @return None
  89. *
  90. * @details Set UI2C_PROTCTL register to control USCI_I2C bus conditions of START, STOP, SI, ACK.
  91. * \hideinitializer
  92. */
  93. #define UI2C_SET_CONTROL_REG(ui2c, u8Ctrl) ((ui2c)->PROTCTL = ((ui2c)->PROTCTL & ~0x2EU) | (u8Ctrl))
  94. /**
  95. * @brief This macro only set START bit to protocol control register of USCI_I2C module.
  96. *
  97. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  98. *
  99. * @return None
  100. *
  101. * @details Set the USCI_I2C bus START condition in UI2C_PROTCTL register.
  102. * \hideinitializer
  103. */
  104. #define UI2C_START(ui2c) ((ui2c)->PROTCTL = ((ui2c)->PROTCTL & ~UI2C_PROTCTL_PTRG_Msk) | UI2C_PROTCTL_STA_Msk)
  105. /**
  106. * @brief This macro only set STOP bit to the control register of USCI_I2C module
  107. *
  108. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  109. *
  110. * @return None
  111. *
  112. * @details Set the USCI_I2C bus STOP condition in UI2C_PROTCTL register.
  113. * \hideinitializer
  114. */
  115. #define UI2C_STOP(ui2c) ((ui2c)->PROTCTL = ((ui2c)->PROTCTL & ~0x2E) | (UI2C_PROTCTL_PTRG_Msk | UI2C_PROTCTL_STO_Msk))
  116. /**
  117. * @brief This macro returns the data stored in data register of USCI_I2C module
  118. *
  119. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  120. *
  121. * @return Data
  122. *
  123. * @details Read a byte data value of UI2C_RXDAT register from USCI_I2C bus
  124. * \hideinitializer
  125. */
  126. #define UI2C_GET_DATA(ui2c) ((ui2c)->RXDAT)
  127. /**
  128. * @brief This macro writes the data to data register of USCI_I2C module
  129. *
  130. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  131. * @param[in] u8Data The data which will be written to data register of USCI_I2C module.
  132. *
  133. * @return None
  134. *
  135. * @details Write a byte data value of UI2C_TXDAT register, then sends address or data to USCI I2C bus
  136. * \hideinitializer
  137. */
  138. #define UI2C_SET_DATA(ui2c, u8Data) ((ui2c)->TXDAT = (u8Data))
  139. /**
  140. * @brief This macro returns time-out flag
  141. *
  142. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  143. *
  144. * @retval 0 USCI_I2C bus time-out is not happened
  145. * @retval 1 USCI_I2C bus time-out is happened
  146. *
  147. * @details USCI_I2C bus occurs time-out event, the time-out flag will be set. If not occurs time-out event, this bit is cleared.
  148. * \hideinitializer
  149. */
  150. #define UI2C_GET_TIMEOUT_FLAG(ui2c) (((ui2c)->PROTSTS & UI2C_PROTSTS_TOIF_Msk) == UI2C_PROTSTS_TOIF_Msk ? 1:0)
  151. /**
  152. * @brief This macro returns wake-up flag
  153. *
  154. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  155. *
  156. * @retval 0 Chip is not woken-up from power-down mode
  157. * @retval 1 Chip is woken-up from power-down mode
  158. *
  159. * @details USCI_I2C controller wake-up flag will be set when USCI_I2C bus occurs wake-up from deep-sleep.
  160. * \hideinitializer
  161. */
  162. #define UI2C_GET_WAKEUP_FLAG(ui2c) (((ui2c)->WKSTS & UI2C_WKSTS_WKF_Msk) == UI2C_WKSTS_WKF_Msk ? 1:0)
  163. /**
  164. * @brief This macro is used to clear USCI_I2C wake-up flag
  165. *
  166. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  167. *
  168. * @return None
  169. *
  170. * @details If USCI_I2C wake-up flag is set, use this macro to clear it.
  171. * \hideinitializer
  172. */
  173. #define UI2C_CLR_WAKEUP_FLAG(ui2c) ((ui2c)->WKSTS = UI2C_WKSTS_WKF_Msk)
  174. /**
  175. * @brief This macro disables the USCI_I2C 10-bit address mode
  176. *
  177. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  178. *
  179. * @return None
  180. *
  181. * @details The UI2C_I2C is 7-bit address mode, when disable USCI_I2C 10-bit address match function.
  182. * \hideinitializer
  183. */
  184. #define UI2C_DISABLE_10BIT_ADDR_MODE(ui2c) ((ui2c)->PROTCTL &= ~(UI2C_PROTCTL_ADDR10EN_Msk))
  185. /**
  186. * @brief This macro enables the 10-bit address mode
  187. *
  188. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  189. *
  190. * @return None
  191. *
  192. * @details To enable USCI_I2C 10-bit address match function.
  193. * \hideinitializer
  194. */
  195. #define UI2C_ENABLE_10BIT_ADDR_MODE(ui2c) ((ui2c)->PROTCTL |= UI2C_PROTCTL_ADDR10EN_Msk)
  196. /**
  197. * @brief This macro gets USCI_I2C protocol interrupt flag or bus status
  198. *
  199. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  200. *
  201. * @return A word data of USCI_I2C_PROTSTS register
  202. *
  203. * @details Read a word data of USCI_I2C PROTSTS register to get USCI_I2C bus Interrupt flags or status.
  204. * \hideinitializer
  205. */
  206. #define UI2C_GET_PROT_STATUS(ui2c) ((ui2c)->PROTSTS)
  207. /**
  208. * @brief This macro clears specified protocol interrupt flag
  209. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  210. * @param[in] u32IntTypeFlag Interrupt Type Flag, should be
  211. * - \ref UI2C_PROTSTS_ACKIF_Msk
  212. * - \ref UI2C_PROTSTS_ERRIF_Msk
  213. * - \ref UI2C_PROTSTS_ARBLOIF_Msk
  214. * - \ref UI2C_PROTSTS_NACKIF_Msk
  215. * - \ref UI2C_PROTSTS_STORIF_Msk
  216. * - \ref UI2C_PROTSTS_STARIF_Msk
  217. * - \ref UI2C_PROTSTS_TOIF_Msk
  218. * @return None
  219. *
  220. * @details To clear interrupt flag when USCI_I2C occurs interrupt and set interrupt flag.
  221. * \hideinitializer
  222. */
  223. #define UI2C_CLR_PROT_INT_FLAG(ui2c,u32IntTypeFlag) ((ui2c)->PROTSTS = (u32IntTypeFlag))
  224. /**
  225. * @brief This macro enables specified protocol interrupt
  226. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  227. * @param[in] u32IntSel Interrupt Type, should be
  228. * - \ref UI2C_PROTIEN_ACKIEN_Msk
  229. * - \ref UI2C_PROTIEN_ERRIEN_Msk
  230. * - \ref UI2C_PROTIEN_ARBLOIEN_Msk
  231. * - \ref UI2C_PROTIEN_NACKIEN_Msk
  232. * - \ref UI2C_PROTIEN_STORIEN_Msk
  233. * - \ref UI2C_PROTIEN_STARIEN_Msk
  234. * - \ref UI2C_PROTIEN_TOIEN_Msk
  235. * @return None
  236. *
  237. * @details Set specified USCI_I2C protocol interrupt bits to enable interrupt function.
  238. * \hideinitializer
  239. */
  240. #define UI2C_ENABLE_PROT_INT(ui2c, u32IntSel) ((ui2c)->PROTIEN |= (u32IntSel))
  241. /**
  242. * @brief This macro disables specified protocol interrupt
  243. * @param[in] ui2c The pointer of the specified USCI_I2C module.
  244. * @param[in] u32IntSel Interrupt Type, should be
  245. * - \ref UI2C_PROTIEN_ACKIEN_Msk
  246. * - \ref UI2C_PROTIEN_ERRIEN_Msk
  247. * - \ref UI2C_PROTIEN_ARBLOIEN_Msk
  248. * - \ref UI2C_PROTIEN_NACKIEN_Msk
  249. * - \ref UI2C_PROTIEN_STORIEN_Msk
  250. * - \ref UI2C_PROTIEN_STARIEN_Msk
  251. * - \ref UI2C_PROTIEN_TOIEN_Msk
  252. * @return None
  253. *
  254. * @details Clear specified USCI_I2C protocol interrupt bits to disable interrupt function.
  255. * \hideinitializer
  256. */
  257. #define UI2C_DISABLE_PROT_INT(ui2c, u32IntSel) ((ui2c)->PROTIEN &= ~ (u32IntSel))
  258. uint32_t UI2C_Open(UI2C_T *ui2c, uint32_t u32BusClock);
  259. void UI2C_Close(UI2C_T *ui2c);
  260. void UI2C_ClearTimeoutFlag(UI2C_T *ui2c);
  261. void UI2C_Trigger(UI2C_T *ui2c, uint8_t u8Start, uint8_t u8Stop, uint8_t u8Ptrg, uint8_t u8Ack);
  262. void UI2C_DisableInt(UI2C_T *ui2c, uint32_t u32Mask);
  263. void UI2C_EnableInt(UI2C_T *ui2c, uint32_t u32Mask);
  264. uint32_t UI2C_GetBusClockFreq(UI2C_T *ui2c);
  265. uint32_t UI2C_SetBusClockFreq(UI2C_T *ui2c, uint32_t u32BusClock);
  266. uint32_t UI2C_GetIntFlag(UI2C_T *ui2c, uint32_t u32Mask);
  267. void UI2C_ClearIntFlag(UI2C_T* ui2c, uint32_t u32Mask);
  268. uint32_t UI2C_GetData(UI2C_T *ui2c);
  269. void UI2C_SetData(UI2C_T *ui2c, uint8_t u8Data);
  270. void UI2C_SetSlaveAddr(UI2C_T *ui2c, uint8_t u8SlaveNo, uint16_t u16SlaveAddr, uint8_t u8GCMode);
  271. void UI2C_SetSlaveAddrMask(UI2C_T *ui2c, uint8_t u8SlaveNo, uint16_t u16SlaveAddrMask);
  272. void UI2C_EnableTimeout(UI2C_T *ui2c, uint32_t u32TimeoutCnt);
  273. void UI2C_DisableTimeout(UI2C_T *ui2c);
  274. void UI2C_EnableWakeup(UI2C_T *ui2c, uint8_t u8WakeupMode);
  275. void UI2C_DisableWakeup(UI2C_T *ui2c);
  276. uint8_t UI2C_WriteByte(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t data);
  277. uint32_t UI2C_WriteMultiBytes(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t *data, uint32_t u32wLen);
  278. uint8_t UI2C_WriteByteOneReg(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t data);
  279. uint32_t UI2C_WriteMultiBytesOneReg(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t *data, uint32_t u32wLen);
  280. uint8_t UI2C_WriteByteTwoRegs(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t data);
  281. uint32_t UI2C_WriteMultiBytesTwoRegs(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t *data, uint32_t u32wLen);
  282. uint8_t UI2C_ReadByte(UI2C_T *ui2c, uint8_t u8SlaveAddr);
  283. uint32_t UI2C_ReadMultiBytes(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t *rdata, uint32_t u32rLen);
  284. uint8_t UI2C_ReadByteOneReg(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr);
  285. uint32_t UI2C_ReadMultiBytesOneReg(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint8_t u8DataAddr, uint8_t *rdata, uint32_t u32rLen);
  286. uint8_t UI2C_ReadByteTwoRegs(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr);
  287. uint32_t UI2C_ReadMultiBytesTwoRegs(UI2C_T *ui2c, uint8_t u8SlaveAddr, uint16_t u16DataAddr, uint8_t *rdata, uint32_t u32rLen);
  288. /*@}*/ /* end of group USCI_I2C_EXPORTED_FUNCTIONS */
  289. /*@}*/ /* end of group USCI_I2C_Driver */
  290. /*@}*/ /* end of group Standard_Driver */
  291. #ifdef __cplusplus
  292. }
  293. #endif
  294. #endif
  295. /*** (C) COPYRIGHT 2016 Nuvoton Technology Corp. ***/