iic.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. /*
  2. * Copyright (C) 2017-2020 Alibaba Group Holding Limited
  3. */
  4. /******************************************************************************
  5. * @file iic.h
  6. * @brief header file for iic driver
  7. * @version V1.0
  8. * @date 08. Apr 2020
  9. * @model iic
  10. ******************************************************************************/
  11. #ifndef _DRV_IIC_H_
  12. #define _DRV_IIC_H_
  13. #include <stdint.h>
  14. #ifdef __cplusplus
  15. extern "C" {
  16. #endif
  17. typedef struct {
  18. uint8_t readable;
  19. uint8_t writeable;
  20. uint8_t error;
  21. } csi_state_t;
  22. typedef struct csi_dev csi_dev_t;
  23. struct csi_dev {
  24. unsigned long reg_base;
  25. uint8_t irq_num;
  26. uint8_t idx;
  27. uint16_t dev_tag;
  28. void (*irq_handler)(void *);
  29. };
  30. /**
  31. \enum csi_iic_mode_t
  32. \brief iic work in master/slave mode
  33. */
  34. typedef enum {
  35. IIC_MODE_MASTER = 0U, ///< IIC master
  36. IIC_MODE_SLAVE ///< IIC slave
  37. } csi_iic_mode_t;
  38. /**
  39. \enum csi_iic_speed_t
  40. \brief iic speed mode
  41. */
  42. typedef enum {
  43. IIC_BUS_SPEED_STANDARD = 0U, ///< Standard Speed (<=100kHz)
  44. IIC_BUS_SPEED_FAST, ///< Fast Speed (<=400kHz)
  45. IIC_BUS_SPEED_FAST_PLUS, ///< Fast plus Speed (<= 1MHz)
  46. IIC_BUS_SPEED_HIGH ///< High Speed (<=3.4MHz)
  47. } csi_iic_speed_t;
  48. /**
  49. \enum csi_iic_address_mode_t
  50. \brief iic address mode
  51. */
  52. typedef enum {
  53. IIC_ADDRESS_7BIT = 0U, ///< 7-bit address mode
  54. IIC_ADDRESS_10BIT ///< 10-bit address mode
  55. } csi_iic_addr_mode_t;
  56. /**
  57. \enum csi_iic_mem_addr_size_t
  58. \brief iic memory address size
  59. */
  60. typedef enum {
  61. IIC_MEM_ADDR_SIZE_8BIT = 0U, ///< IIC e2prom 8bit address mode
  62. IIC_MEM_ADDR_SIZE_16BIT ///< IIC e2prom 16bit address mode
  63. } csi_iic_mem_addr_size_t;
  64. /**
  65. \enum csi_iic_event_t
  66. \brief iic event signaled by iic driver
  67. */
  68. typedef enum {
  69. IIC_EVENT_SEND_COMPLETE = 0U, ///< Master/slave Send finished
  70. IIC_EVENT_RECEIVE_COMPLETE, ///< Master/slave Receive finished
  71. IIC_EVENT_ERROR_OVERFLOW, ///< Master/slave fifo overflow error
  72. IIC_EVENT_ERROR_UNDERFLOW, ///< Master/slave fifo underflow error
  73. IIC_EVENT_ERROR ///< The receive buffer was completely filled to FIFO and more data arrived. That data is lost
  74. } csi_iic_event_t;
  75. /**
  76. \struct csi_iic_t
  77. \brief iic ctrl block
  78. */
  79. typedef struct csi_iic csi_iic_t;
  80. struct csi_iic {
  81. csi_dev_t dev; ///< IIC hw-device info
  82. void (*callback)(csi_iic_t *iic, csi_iic_event_t event, void *arg); ///< IIC event callback for user
  83. void *arg; ///< User private param passed to user callback
  84. uint8_t *data; ///< IIC transfer-data buffer
  85. uint32_t size; ///< IIC transfer-data size
  86. csi_iic_mode_t mode; ///< IIC mode
  87. void *send; ///< Send function pointer asynchronously
  88. void *receive; ///< Receive function pointer asynchronously
  89. csi_state_t state; ///< IIC current state
  90. void *priv;
  91. };
  92. typedef void (*csi_iic_master_send_async_t)(csi_iic_t *iic, uint32_t devaddr, const void *data, uint32_t size);
  93. typedef void (*csi_iic_master_receive_async_t)(csi_iic_t *iic, uint32_t devaddr, void *data, uint32_t size);
  94. typedef void (*csi_iic_slave_send_async_t)(csi_iic_t *iic, const void *data, uint32_t size);
  95. typedef void (*csi_iic_slave_receive_async_t)(csi_iic_t *iic, void *data, uint32_t size);
  96. /**
  97. \brief Init iic ctrl block
  98. Initializes the resources needed for the iic instance
  99. \param[in] iic Handle of iic instance
  100. \param[in] idx Index of instance
  101. \return error code \ref int
  102. */
  103. int csi_iic_init(csi_iic_t *iic, uint32_t idx);
  104. /**
  105. \brief Uninit iic ctrl block
  106. Stops operation and releases the software resources used by the instance
  107. \param[in] iic Handle of iic instance
  108. \return None
  109. */
  110. void csi_iic_uninit(csi_iic_t *iic);
  111. /**
  112. \brief Config iic master or slave mode
  113. \param[in] iic Handle of iic instance
  114. \param[in] mode iic mode \ref csi_iic_mode_t
  115. \return error code \ref int
  116. */
  117. int csi_iic_mode(csi_iic_t *iic, csi_iic_mode_t mode);
  118. /**
  119. \brief Config iic addr mode
  120. \param[in] iic Handle of iic instance
  121. \param[in] addr_mode iic addr mode \ref csi_iic_addr_mode_t
  122. \return error code \ref int
  123. */
  124. int csi_iic_addr_mode(csi_iic_t *iic, csi_iic_addr_mode_t addr_mode);
  125. /**
  126. \brief Config iic speed
  127. \param[in] iic Handle of iic instance
  128. \param[in] speed iic speed mode \ref csi_iic_speed_t
  129. \return error code \ref int
  130. */
  131. int csi_iic_speed(csi_iic_t *iic, csi_iic_speed_t speed);
  132. /**
  133. \brief Config iic own addr
  134. \param[in] iic Handle of iic instance
  135. \param[in] own_addr iic set own addr at slave mode
  136. \return error code \ref int
  137. */
  138. int csi_iic_own_addr(csi_iic_t *iic, uint32_t own_addr);
  139. /**
  140. \brief Start sending data as iic master
  141. This function is blocking
  142. \param[in] iic Handle of iic instance
  143. \param[in] devaddr Addrress of slave device
  144. \param[in] data Pointer to send data buffer
  145. \param[in] size Size of data items to send
  146. \param[in] timout Unit of time delay(ms)
  147. \return The amount of real data sent or error code
  148. */
  149. int32_t csi_iic_master_send(csi_iic_t *iic, uint32_t devaddr, const void *data, uint32_t size, uint32_t timeout);
  150. /**
  151. \brief Start receiving data as iic master
  152. This function is blocking
  153. \param[in] iic Handle to operate
  154. \param[in] devaddr iic addrress of slave device
  155. \param[out] data Pointer to buffer for data to receive from iic receiver
  156. \param[in] size Size of data items to receive
  157. \param[in] timeout Unit of time delay(ms)
  158. \return The amount of real data received or error code
  159. */
  160. int32_t csi_iic_master_receive(csi_iic_t *iic, uint32_t devaddr, void *data, uint32_t size, uint32_t timeout);
  161. /**
  162. \brief Start sending data as iic master
  163. This function is non-blocking,\ref csi_iic_event_t is signaled when transfer completes or error happens
  164. \param[in] iic Handle to operate
  165. \param[in] devaddr iic addrress of slave device
  166. \param[in] data Pointer to send data buffer
  167. \param[in] size Size of data items to send
  168. \return error code \ref int
  169. */
  170. int csi_iic_master_send_async(csi_iic_t *iic, uint32_t devaddr, const void *data, uint32_t size);
  171. /**
  172. \brief Start receiving data as iic master.
  173. This function is non-blocking.\ref csi_iic_event_t is signaled when transfer completes or error happens
  174. \param[in] iic Handle to operate
  175. \param[in] devaddr iic addrress of slave device
  176. \param[out] data Pointer to buffer for data to receive from iic receiver
  177. \param[in] size Size of data items to receive
  178. \return error code \ref int
  179. */
  180. int csi_iic_master_receive_async(csi_iic_t *iic, uint32_t devaddr, void *data, uint32_t size);
  181. /**
  182. \brief Start sending data as iic master
  183. This function is blocking
  184. \param[in] iic Handle of iic instance
  185. \param[in] devaddr Addrress of slave device
  186. \param[in] memaddr Internal addr of device
  187. \param[in] memaddr_size Internal addr mode of device
  188. \param[in] data Pointer to send data buffer
  189. \param[in] size Size of data items to send
  190. \param[in] timout Unit of time delay(ms)
  191. \return The amount of real data sent or error code
  192. */
  193. int32_t csi_iic_mem_send(csi_iic_t *iic, uint32_t devaddr, uint16_t memaddr, csi_iic_mem_addr_size_t memaddr_size, const void *data, uint32_t size, uint32_t timeout);
  194. /**
  195. \brief Start receiving data as IIC Master.(write with a write stop,then a start read)
  196. This function is blocking
  197. \param[in] iic Handle to operate
  198. \param[in] devaddr iic addrress of slave device
  199. \param[in] memaddr Internal addr of device
  200. \param[in] memaddr_mode Internal addr mode of device
  201. \param[out] data Pointer to buffer for data to receive from eeprom device
  202. \param[in] size Size of data items to receive
  203. \param[in] timeout Unit of time delay(ms)
  204. \return The amount of real data received or error code
  205. */
  206. int32_t csi_iic_mem_receive(csi_iic_t *iic, uint32_t devaddr, uint16_t memaddr, csi_iic_mem_addr_size_t memaddr_size, void *data, uint32_t size, uint32_t timeout);
  207. /**
  208. \brief Start receiving data as IIC Master(Sr timing between write and read).
  209. This function is blocking
  210. \param[in] iic handle to operate.
  211. \param[in] devaddr iic addrress of slave device.
  212. \param[in] memaddr internal addr of device
  213. \param[in] memaddr_mode internal addr mode of device
  214. \param[out] data Pointer to buffer for data to receive from IIC receiver
  215. \param[in] size size of data items to receive
  216. \param[in] timeout unit of time delay
  217. \return memory receive real size and error code
  218. */
  219. int32_t csi_iic_mem_receive_sr(csi_iic_t *iic, uint32_t devaddr, uint16_t memaddr, csi_iic_mem_addr_size_t memaddr_size, void *data, uint32_t size, uint32_t timeout);
  220. /**
  221. \brief Start sending data as iic slave
  222. This function is blocking
  223. \param[in] iic Handle to operate
  224. \param[in] data Pointer to buffer with data to send to iic master
  225. \param[in] size Size of data items to send
  226. \param[in] timeout Unit of time delay(ms)
  227. \return The amount of real data sent or error code
  228. */
  229. int32_t csi_iic_slave_send(csi_iic_t *iic, const void *data, uint32_t size, uint32_t timeout);
  230. /**
  231. \brief Start receiving data as iic slave
  232. This function is blocking
  233. \param[in] iic Handle to operate
  234. \param[out] data Pointer to buffer for data to receive from iic master
  235. \param[in] size Size of data items to receive
  236. \param[in] timeout Unit of time delay(ms)
  237. \return The amount of real data received or error code
  238. */
  239. int32_t csi_iic_slave_receive(csi_iic_t *iic, void *data, uint32_t size, uint32_t timeout);
  240. /**
  241. \brief Start sending data as iic slave
  242. This function is non-blocking,\ref csi_iic_event_t is signaled when transfer completes or error happens
  243. \param[in] iic Handle to operate
  244. \param[in] data Pointer to buffer with data to send to iic master
  245. \param[in] size Size of data items to send
  246. \return error code \ref int
  247. */
  248. int csi_iic_slave_send_async(csi_iic_t *iic, const void *data, uint32_t size);
  249. /**
  250. \brief Start receiving data as iic slave
  251. This function is non-blocking,\ref csi_iic_event_t is signaled when transfer completes or error happens
  252. \param[in] handle iic handle to operate
  253. \param[out] data Pointer to buffer for data to receive from iic master
  254. \param[in] size Size of data items to receive
  255. \return error code \ref int
  256. */
  257. int csi_iic_slave_receive_async(csi_iic_t *iic, void *data, uint32_t size);
  258. /**
  259. \brief Attach callback to the iic
  260. \param[in] iic iic handle to operate
  261. \param[in] cb Event callback function \ref csi_iic_callback_t
  262. \param[in] arg User private param for event callback
  263. \return error code \ref int
  264. */
  265. int csi_iic_attach_callback(csi_iic_t *iic, void *callback, void *arg);
  266. /**
  267. \brief Detach callback from the iic
  268. \param[in] iic iic handle to operate
  269. \return None
  270. */
  271. void csi_iic_detach_callback(csi_iic_t *iic);
  272. /**
  273. \brief Config iic stop to generate
  274. \param[in] iic iic handle to operate
  275. \param[in] enable Transfer operation is pending - stop condition will not be generated
  276. \return error code \ref int
  277. */
  278. int csi_iic_xfer_pending(csi_iic_t *iic, bool enable);
  279. /**
  280. \brief Get iic state
  281. \param[in] iic Handle to operate
  282. \param[out] state iic state \ref csi_state_t
  283. \return error code \ref int
  284. */
  285. int csi_iic_get_state(csi_iic_t *iic, csi_state_t *state);
  286. /**
  287. \brief Enable iic power manage
  288. \param[in] iic iic handle to operate
  289. \return error code \ref int
  290. */
  291. int csi_iic_enable_pm(csi_iic_t *iic);
  292. /**
  293. \brief Disable iic power manage
  294. \param[in] iic iic handle to operate
  295. \return None
  296. */
  297. void csi_iic_disable_pm(csi_iic_t *iic);
  298. #ifdef __cplusplus
  299. }
  300. #endif
  301. #endif /* _DRV_IIC_H_ */