nrf_uarte.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655
  1. /**
  2. * Copyright (c) 2015 - 2019, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef NRF_UARTE_H__
  41. #define NRF_UARTE_H__
  42. #include <nrfx.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. #define NRF_UARTE_PSEL_DISCONNECTED 0xFFFFFFFF
  47. /**
  48. * @defgroup nrf_uarte_hal UARTE HAL
  49. * @{
  50. * @ingroup nrf_uarte
  51. * @brief Hardware access layer for managing the UARTE peripheral.
  52. */
  53. /**
  54. * @enum nrf_uarte_task_t
  55. * @brief UARTE tasks.
  56. */
  57. typedef enum
  58. {
  59. /*lint -save -e30*/
  60. NRF_UARTE_TASK_STARTRX = offsetof(NRF_UARTE_Type, TASKS_STARTRX), ///< Start UART receiver.
  61. NRF_UARTE_TASK_STOPRX = offsetof(NRF_UARTE_Type, TASKS_STOPRX), ///< Stop UART receiver.
  62. NRF_UARTE_TASK_STARTTX = offsetof(NRF_UARTE_Type, TASKS_STARTTX), ///< Start UART transmitter.
  63. NRF_UARTE_TASK_STOPTX = offsetof(NRF_UARTE_Type, TASKS_STOPTX), ///< Stop UART transmitter.
  64. NRF_UARTE_TASK_FLUSHRX = offsetof(NRF_UARTE_Type, TASKS_FLUSHRX) ///< Flush RX FIFO in RX buffer.
  65. /*lint -restore*/
  66. } nrf_uarte_task_t;
  67. /**
  68. * @enum nrf_uarte_event_t
  69. * @brief UARTE events.
  70. */
  71. typedef enum
  72. {
  73. /*lint -save -e30*/
  74. NRF_UARTE_EVENT_CTS = offsetof(NRF_UARTE_Type, EVENTS_CTS), ///< CTS is activated.
  75. NRF_UARTE_EVENT_NCTS = offsetof(NRF_UARTE_Type, EVENTS_NCTS), ///< CTS is deactivated.
  76. NRF_UARTE_EVENT_RXDRDY = offsetof(NRF_UARTE_Type, EVENTS_RXDRDY), ///< Data received in RXD (but potentially not yet transferred to Data RAM).
  77. NRF_UARTE_EVENT_ENDRX = offsetof(NRF_UARTE_Type, EVENTS_ENDRX), ///< Receive buffer is filled up.
  78. NRF_UARTE_EVENT_TXDRDY = offsetof(NRF_UARTE_Type, EVENTS_TXDRDY), ///< Data sent from TXD.
  79. NRF_UARTE_EVENT_ENDTX = offsetof(NRF_UARTE_Type, EVENTS_ENDTX), ///< Last TX byte transmitted.
  80. NRF_UARTE_EVENT_ERROR = offsetof(NRF_UARTE_Type, EVENTS_ERROR), ///< Error detected.
  81. NRF_UARTE_EVENT_RXTO = offsetof(NRF_UARTE_Type, EVENTS_RXTO), ///< Receiver timeout.
  82. NRF_UARTE_EVENT_RXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_RXSTARTED), ///< Receiver has started.
  83. NRF_UARTE_EVENT_TXSTARTED = offsetof(NRF_UARTE_Type, EVENTS_TXSTARTED), ///< Transmitter has started.
  84. NRF_UARTE_EVENT_TXSTOPPED = offsetof(NRF_UARTE_Type, EVENTS_TXSTOPPED) ///< Transmitted stopped.
  85. /*lint -restore*/
  86. } nrf_uarte_event_t;
  87. /**
  88. * @brief Types of UARTE shortcuts.
  89. */
  90. typedef enum
  91. {
  92. NRF_UARTE_SHORT_ENDRX_STARTRX = UARTE_SHORTS_ENDRX_STARTRX_Msk, ///< Shortcut between ENDRX event and STARTRX task.
  93. NRF_UARTE_SHORT_ENDRX_STOPRX = UARTE_SHORTS_ENDRX_STOPRX_Msk ///< Shortcut between ENDRX event and STOPRX task.
  94. } nrf_uarte_short_t;
  95. /**
  96. * @enum nrf_uarte_int_mask_t
  97. * @brief UARTE interrupts.
  98. */
  99. typedef enum
  100. {
  101. NRF_UARTE_INT_CTS_MASK = UARTE_INTENSET_CTS_Msk, ///< Interrupt on CTS event.
  102. NRF_UARTE_INT_NCTS_MASK = UARTE_INTENSET_NCTS_Msk, ///< Interrupt on NCTS event.
  103. NRF_UARTE_INT_RXDRDY_MASK = UARTE_INTENSET_RXDRDY_Msk, ///< Interrupt on RXDRDY event.
  104. NRF_UARTE_INT_ENDRX_MASK = UARTE_INTENSET_ENDRX_Msk, ///< Interrupt on ENDRX event.
  105. NRF_UARTE_INT_TXDRDY_MASK = UARTE_INTENSET_TXDRDY_Msk, ///< Interrupt on TXDRDY event.
  106. NRF_UARTE_INT_ENDTX_MASK = UARTE_INTENSET_ENDTX_Msk, ///< Interrupt on ENDTX event.
  107. NRF_UARTE_INT_ERROR_MASK = UARTE_INTENSET_ERROR_Msk, ///< Interrupt on ERROR event.
  108. NRF_UARTE_INT_RXTO_MASK = UARTE_INTENSET_RXTO_Msk, ///< Interrupt on RXTO event.
  109. NRF_UARTE_INT_RXSTARTED_MASK = UARTE_INTENSET_RXSTARTED_Msk, ///< Interrupt on RXSTARTED event.
  110. NRF_UARTE_INT_TXSTARTED_MASK = UARTE_INTENSET_TXSTARTED_Msk, ///< Interrupt on TXSTARTED event.
  111. NRF_UARTE_INT_TXSTOPPED_MASK = UARTE_INTENSET_TXSTOPPED_Msk ///< Interrupt on TXSTOPPED event.
  112. } nrf_uarte_int_mask_t;
  113. /**
  114. * @enum nrf_uarte_baudrate_t
  115. * @brief Baudrates supported by UARTE.
  116. */
  117. typedef enum
  118. {
  119. NRF_UARTE_BAUDRATE_1200 = UARTE_BAUDRATE_BAUDRATE_Baud1200, ///< 1200 baud.
  120. NRF_UARTE_BAUDRATE_2400 = UARTE_BAUDRATE_BAUDRATE_Baud2400, ///< 2400 baud.
  121. NRF_UARTE_BAUDRATE_4800 = UARTE_BAUDRATE_BAUDRATE_Baud4800, ///< 4800 baud.
  122. NRF_UARTE_BAUDRATE_9600 = UARTE_BAUDRATE_BAUDRATE_Baud9600, ///< 9600 baud.
  123. NRF_UARTE_BAUDRATE_14400 = UARTE_BAUDRATE_BAUDRATE_Baud14400, ///< 14400 baud.
  124. NRF_UARTE_BAUDRATE_19200 = UARTE_BAUDRATE_BAUDRATE_Baud19200, ///< 19200 baud.
  125. NRF_UARTE_BAUDRATE_28800 = UARTE_BAUDRATE_BAUDRATE_Baud28800, ///< 28800 baud.
  126. NRF_UARTE_BAUDRATE_31250 = UARTE_BAUDRATE_BAUDRATE_Baud31250, ///< 31250 baud.
  127. NRF_UARTE_BAUDRATE_38400 = UARTE_BAUDRATE_BAUDRATE_Baud38400, ///< 38400 baud.
  128. NRF_UARTE_BAUDRATE_56000 = UARTE_BAUDRATE_BAUDRATE_Baud56000, ///< 56000 baud.
  129. NRF_UARTE_BAUDRATE_57600 = UARTE_BAUDRATE_BAUDRATE_Baud57600, ///< 57600 baud.
  130. NRF_UARTE_BAUDRATE_76800 = UARTE_BAUDRATE_BAUDRATE_Baud76800, ///< 76800 baud.
  131. NRF_UARTE_BAUDRATE_115200 = UARTE_BAUDRATE_BAUDRATE_Baud115200, ///< 115200 baud.
  132. NRF_UARTE_BAUDRATE_230400 = UARTE_BAUDRATE_BAUDRATE_Baud230400, ///< 230400 baud.
  133. NRF_UARTE_BAUDRATE_250000 = UARTE_BAUDRATE_BAUDRATE_Baud250000, ///< 250000 baud.
  134. NRF_UARTE_BAUDRATE_460800 = UARTE_BAUDRATE_BAUDRATE_Baud460800, ///< 460800 baud.
  135. NRF_UARTE_BAUDRATE_921600 = UARTE_BAUDRATE_BAUDRATE_Baud921600, ///< 921600 baud.
  136. NRF_UARTE_BAUDRATE_1000000 = UARTE_BAUDRATE_BAUDRATE_Baud1M ///< 1000000 baud.
  137. } nrf_uarte_baudrate_t;
  138. /**
  139. * @enum nrf_uarte_error_mask_t
  140. * @brief Types of UARTE error masks.
  141. */
  142. typedef enum
  143. {
  144. NRF_UARTE_ERROR_OVERRUN_MASK = UARTE_ERRORSRC_OVERRUN_Msk, ///< Overrun error.
  145. NRF_UARTE_ERROR_PARITY_MASK = UARTE_ERRORSRC_PARITY_Msk, ///< Parity error.
  146. NRF_UARTE_ERROR_FRAMING_MASK = UARTE_ERRORSRC_FRAMING_Msk, ///< Framing error.
  147. NRF_UARTE_ERROR_BREAK_MASK = UARTE_ERRORSRC_BREAK_Msk ///< Break error.
  148. } nrf_uarte_error_mask_t;
  149. /**
  150. * @enum nrf_uarte_parity_t
  151. * @brief Types of UARTE parity modes.
  152. */
  153. typedef enum
  154. {
  155. NRF_UARTE_PARITY_EXCLUDED = UARTE_CONFIG_PARITY_Excluded << UARTE_CONFIG_PARITY_Pos, ///< Parity excluded.
  156. NRF_UARTE_PARITY_INCLUDED = UARTE_CONFIG_PARITY_Included << UARTE_CONFIG_PARITY_Pos ///< Parity included.
  157. } nrf_uarte_parity_t;
  158. /**
  159. * @enum nrf_uarte_hwfc_t
  160. * @brief Types of UARTE flow control modes.
  161. */
  162. typedef enum
  163. {
  164. NRF_UARTE_HWFC_DISABLED = UARTE_CONFIG_HWFC_Disabled << UARTE_CONFIG_HWFC_Pos, ///< HW flow control disabled.
  165. NRF_UARTE_HWFC_ENABLED = UARTE_CONFIG_HWFC_Enabled << UARTE_CONFIG_HWFC_Pos ///< HW flow control enabled.
  166. } nrf_uarte_hwfc_t;
  167. /**
  168. * @brief Function for clearing a specific UARTE event.
  169. *
  170. * @param[in] p_reg Pointer to the peripheral registers structure.
  171. * @param[in] event Event to clear.
  172. */
  173. __STATIC_INLINE void nrf_uarte_event_clear(NRF_UARTE_Type * p_reg, nrf_uarte_event_t event);
  174. /**
  175. * @brief Function for checking the state of a specific UARTE event.
  176. *
  177. * @param[in] p_reg Pointer to the peripheral registers structure.
  178. * @param[in] event Event to check.
  179. *
  180. * @retval True if event is set, False otherwise.
  181. */
  182. __STATIC_INLINE bool nrf_uarte_event_check(NRF_UARTE_Type * p_reg, nrf_uarte_event_t event);
  183. /**
  184. * @brief Function for returning the address of a specific UARTE event register.
  185. *
  186. * @param[in] p_reg Pointer to the peripheral registers structure.
  187. * @param[in] event Desired event.
  188. *
  189. * @retval Address of specified event register.
  190. */
  191. __STATIC_INLINE uint32_t nrf_uarte_event_address_get(NRF_UARTE_Type * p_reg,
  192. nrf_uarte_event_t event);
  193. /**
  194. * @brief Function for enabling UARTE shortcuts.
  195. *
  196. * @param p_reg Pointer to the peripheral registers structure.
  197. * @param shorts_mask Shortcuts to enable.
  198. */
  199. __STATIC_INLINE void nrf_uarte_shorts_enable(NRF_UARTE_Type * p_reg, uint32_t shorts_mask);
  200. /**
  201. * @brief Function for disabling UARTE shortcuts.
  202. *
  203. * @param p_reg Pointer to the peripheral registers structure.
  204. * @param shorts_mask Shortcuts to disable.
  205. */
  206. __STATIC_INLINE void nrf_uarte_shorts_disable(NRF_UARTE_Type * p_reg, uint32_t shorts_mask);
  207. /**
  208. * @brief Function for enabling UARTE interrupts.
  209. *
  210. * @param p_reg Pointer to the peripheral registers structure.
  211. * @param int_mask Interrupts to enable.
  212. */
  213. __STATIC_INLINE void nrf_uarte_int_enable(NRF_UARTE_Type * p_reg, uint32_t int_mask);
  214. /**
  215. * @brief Function for retrieving the state of a given interrupt.
  216. *
  217. * @param p_reg Pointer to the peripheral registers structure.
  218. * @param int_mask Mask of interrupt to check.
  219. *
  220. * @retval true If the interrupt is enabled.
  221. * @retval false If the interrupt is not enabled.
  222. */
  223. __STATIC_INLINE bool nrf_uarte_int_enable_check(NRF_UARTE_Type * p_reg, nrf_uarte_int_mask_t int_mask);
  224. /**
  225. * @brief Function for disabling specific interrupts.
  226. *
  227. * @param p_reg Instance.
  228. * @param int_mask Interrupts to disable.
  229. */
  230. __STATIC_INLINE void nrf_uarte_int_disable(NRF_UARTE_Type * p_reg, uint32_t int_mask);
  231. #if defined(DPPI_PRESENT) || defined(__NRFX_DOXYGEN__)
  232. /**
  233. * @brief Function for setting the subscribe configuration for a given
  234. * UARTE task.
  235. *
  236. * @param[in] p_reg Pointer to the structure of registers of the peripheral.
  237. * @param[in] task Task for which to set the configuration.
  238. * @param[in] channel Channel through which to subscribe events.
  239. */
  240. __STATIC_INLINE void nrf_uarte_subscribe_set(NRF_UARTE_Type * p_reg,
  241. nrf_uarte_task_t task,
  242. uint8_t channel);
  243. /**
  244. * @brief Function for clearing the subscribe configuration for a given
  245. * UARTE task.
  246. *
  247. * @param[in] p_reg Pointer to the structure of registers of the peripheral.
  248. * @param[in] task Task for which to clear the configuration.
  249. */
  250. __STATIC_INLINE void nrf_uarte_subscribe_clear(NRF_UARTE_Type * p_reg,
  251. nrf_uarte_task_t task);
  252. /**
  253. * @brief Function for setting the publish configuration for a given
  254. * UARTE event.
  255. *
  256. * @param[in] p_reg Pointer to the structure of registers of the peripheral.
  257. * @param[in] event Event for which to set the configuration.
  258. * @param[in] channel Channel through which to publish the event.
  259. */
  260. __STATIC_INLINE void nrf_uarte_publish_set(NRF_UARTE_Type * p_reg,
  261. nrf_uarte_event_t event,
  262. uint8_t channel);
  263. /**
  264. * @brief Function for clearing the publish configuration for a given
  265. * UARTE event.
  266. *
  267. * @param[in] p_reg Pointer to the structure of registers of the peripheral.
  268. * @param[in] event Event for which to clear the configuration.
  269. */
  270. __STATIC_INLINE void nrf_uarte_publish_clear(NRF_UARTE_Type * p_reg,
  271. nrf_uarte_event_t event);
  272. #endif // defined(DPPI_PRESENT) || defined(__NRFX_DOXYGEN__)
  273. /**
  274. * @brief Function for getting error source mask. Function is clearing error source flags after reading.
  275. *
  276. * @param p_reg Pointer to the peripheral registers structure.
  277. * @return Mask with error source flags.
  278. */
  279. __STATIC_INLINE uint32_t nrf_uarte_errorsrc_get_and_clear(NRF_UARTE_Type * p_reg);
  280. /**
  281. * @brief Function for enabling UARTE.
  282. *
  283. * @param p_reg Pointer to the peripheral registers structure.
  284. */
  285. __STATIC_INLINE void nrf_uarte_enable(NRF_UARTE_Type * p_reg);
  286. /**
  287. * @brief Function for disabling UARTE.
  288. *
  289. * @param p_reg Pointer to the peripheral registers structure.
  290. */
  291. __STATIC_INLINE void nrf_uarte_disable(NRF_UARTE_Type * p_reg);
  292. /**
  293. * @brief Function for configuring TX/RX pins.
  294. *
  295. * @param p_reg Pointer to the peripheral registers structure.
  296. * @param pseltxd TXD pin number.
  297. * @param pselrxd RXD pin number.
  298. */
  299. __STATIC_INLINE void nrf_uarte_txrx_pins_set(NRF_UARTE_Type * p_reg, uint32_t pseltxd, uint32_t pselrxd);
  300. /**
  301. * @brief Function for disconnecting TX/RX pins.
  302. *
  303. * @param p_reg Pointer to the peripheral registers structure.
  304. */
  305. __STATIC_INLINE void nrf_uarte_txrx_pins_disconnect(NRF_UARTE_Type * p_reg);
  306. /**
  307. * @brief Function for getting TX pin.
  308. *
  309. * @param p_reg Pointer to the peripheral registers structure.
  310. */
  311. __STATIC_INLINE uint32_t nrf_uarte_tx_pin_get(NRF_UARTE_Type * p_reg);
  312. /**
  313. * @brief Function for getting RX pin.
  314. *
  315. * @param p_reg Pointer to the peripheral registers structure.
  316. */
  317. __STATIC_INLINE uint32_t nrf_uarte_rx_pin_get(NRF_UARTE_Type * p_reg);
  318. /**
  319. * @brief Function for getting RTS pin.
  320. *
  321. * @param p_reg Pointer to the peripheral registers structure.
  322. */
  323. __STATIC_INLINE uint32_t nrf_uarte_rts_pin_get(NRF_UARTE_Type * p_reg);
  324. /**
  325. * @brief Function for getting CTS pin.
  326. *
  327. * @param p_reg Pointer to the peripheral registers structure.
  328. */
  329. __STATIC_INLINE uint32_t nrf_uarte_cts_pin_get(NRF_UARTE_Type * p_reg);
  330. /**
  331. * @brief Function for configuring flow control pins.
  332. *
  333. * @param p_reg Pointer to the peripheral registers structure.
  334. * @param pselrts RTS pin number.
  335. * @param pselcts CTS pin number.
  336. */
  337. __STATIC_INLINE void nrf_uarte_hwfc_pins_set(NRF_UARTE_Type * p_reg,
  338. uint32_t pselrts,
  339. uint32_t pselcts);
  340. /**
  341. * @brief Function for disconnecting flow control pins.
  342. *
  343. * @param p_reg Pointer to the peripheral registers structure.
  344. */
  345. __STATIC_INLINE void nrf_uarte_hwfc_pins_disconnect(NRF_UARTE_Type * p_reg);
  346. /**
  347. * @brief Function for starting an UARTE task.
  348. *
  349. * @param p_reg Pointer to the peripheral registers structure.
  350. * @param task Task.
  351. */
  352. __STATIC_INLINE void nrf_uarte_task_trigger(NRF_UARTE_Type * p_reg, nrf_uarte_task_t task);
  353. /**
  354. * @brief Function for returning the address of a specific task register.
  355. *
  356. * @param p_reg Pointer to the peripheral registers structure.
  357. * @param task Task.
  358. *
  359. * @return Task address.
  360. */
  361. __STATIC_INLINE uint32_t nrf_uarte_task_address_get(NRF_UARTE_Type * p_reg, nrf_uarte_task_t task);
  362. /**
  363. * @brief Function for configuring UARTE.
  364. *
  365. * @param p_reg Pointer to the peripheral registers structure.
  366. * @param hwfc Hardware flow control. Enabled if true.
  367. * @param parity Parity. Included if true.
  368. */
  369. __STATIC_INLINE void nrf_uarte_configure(NRF_UARTE_Type * p_reg,
  370. nrf_uarte_parity_t parity,
  371. nrf_uarte_hwfc_t hwfc);
  372. /**
  373. * @brief Function for setting UARTE baudrate.
  374. *
  375. * @param p_reg Instance.
  376. * @param baudrate Baudrate.
  377. */
  378. __STATIC_INLINE void nrf_uarte_baudrate_set(NRF_UARTE_Type * p_reg, nrf_uarte_baudrate_t baudrate);
  379. /**
  380. * @brief Function for setting the transmit buffer.
  381. *
  382. * @param[in] p_reg Instance.
  383. * @param[in] p_buffer Pointer to the buffer with data to send.
  384. * @param[in] length Maximum number of data bytes to transmit.
  385. */
  386. __STATIC_INLINE void nrf_uarte_tx_buffer_set(NRF_UARTE_Type * p_reg,
  387. uint8_t const * p_buffer,
  388. size_t length);
  389. /**
  390. * @brief Function for getting number of bytes transmitted in the last transaction.
  391. *
  392. * @param[in] p_reg Instance.
  393. *
  394. * @retval Amount of bytes transmitted.
  395. */
  396. __STATIC_INLINE uint32_t nrf_uarte_tx_amount_get(NRF_UARTE_Type * p_reg);
  397. /**
  398. * @brief Function for setting the receive buffer.
  399. *
  400. * @param[in] p_reg Pointer to the peripheral registers structure.
  401. * @param[in] p_buffer Pointer to the buffer for received data.
  402. * @param[in] length Maximum number of data bytes to receive.
  403. */
  404. __STATIC_INLINE void nrf_uarte_rx_buffer_set(NRF_UARTE_Type * p_reg,
  405. uint8_t * p_buffer,
  406. size_t length);
  407. /**
  408. * @brief Function for getting number of bytes received in the last transaction.
  409. *
  410. * @param[in] p_reg Pointer to the peripheral registers structure.
  411. *
  412. * @retval Amount of bytes received.
  413. */
  414. __STATIC_INLINE uint32_t nrf_uarte_rx_amount_get(NRF_UARTE_Type * p_reg);
  415. #ifndef SUPPRESS_INLINE_IMPLEMENTATION
  416. __STATIC_INLINE void nrf_uarte_event_clear(NRF_UARTE_Type * p_reg, nrf_uarte_event_t event)
  417. {
  418. *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)event)) = 0x0UL;
  419. #if __CORTEX_M == 0x04
  420. volatile uint32_t dummy = *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)event));
  421. (void)dummy;
  422. #endif
  423. }
  424. __STATIC_INLINE bool nrf_uarte_event_check(NRF_UARTE_Type * p_reg, nrf_uarte_event_t event)
  425. {
  426. return (bool)*(volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)event);
  427. }
  428. __STATIC_INLINE uint32_t nrf_uarte_event_address_get(NRF_UARTE_Type * p_reg,
  429. nrf_uarte_event_t event)
  430. {
  431. return (uint32_t)((uint8_t *)p_reg + (uint32_t)event);
  432. }
  433. __STATIC_INLINE void nrf_uarte_shorts_enable(NRF_UARTE_Type * p_reg, uint32_t shorts_mask)
  434. {
  435. p_reg->SHORTS |= shorts_mask;
  436. }
  437. __STATIC_INLINE void nrf_uarte_shorts_disable(NRF_UARTE_Type * p_reg, uint32_t shorts_mask)
  438. {
  439. p_reg->SHORTS &= ~(shorts_mask);
  440. }
  441. __STATIC_INLINE void nrf_uarte_int_enable(NRF_UARTE_Type * p_reg, uint32_t int_mask)
  442. {
  443. p_reg->INTENSET = int_mask;
  444. }
  445. __STATIC_INLINE bool nrf_uarte_int_enable_check(NRF_UARTE_Type * p_reg, nrf_uarte_int_mask_t int_mask)
  446. {
  447. return (bool)(p_reg->INTENSET & int_mask);
  448. }
  449. __STATIC_INLINE void nrf_uarte_int_disable(NRF_UARTE_Type * p_reg, uint32_t int_mask)
  450. {
  451. p_reg->INTENCLR = int_mask;
  452. }
  453. #if defined(DPPI_PRESENT)
  454. __STATIC_INLINE void nrf_uarte_subscribe_set(NRF_UARTE_Type * p_reg,
  455. nrf_uarte_task_t task,
  456. uint8_t channel)
  457. {
  458. *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) task + 0x80uL)) =
  459. ((uint32_t)channel | UARTE_SUBSCRIBE_STARTRX_EN_Msk);
  460. }
  461. __STATIC_INLINE void nrf_uarte_subscribe_clear(NRF_UARTE_Type * p_reg,
  462. nrf_uarte_task_t task)
  463. {
  464. *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) task + 0x80uL)) = 0;
  465. }
  466. __STATIC_INLINE void nrf_uarte_publish_set(NRF_UARTE_Type * p_reg,
  467. nrf_uarte_event_t event,
  468. uint8_t channel)
  469. {
  470. *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) event + 0x80uL)) =
  471. ((uint32_t)channel | UARTE_PUBLISH_CTS_EN_Msk);
  472. }
  473. __STATIC_INLINE void nrf_uarte_publish_clear(NRF_UARTE_Type * p_reg,
  474. nrf_uarte_event_t event)
  475. {
  476. *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) event + 0x80uL)) = 0;
  477. }
  478. #endif // defined(DPPI_PRESENT)
  479. __STATIC_INLINE uint32_t nrf_uarte_errorsrc_get_and_clear(NRF_UARTE_Type * p_reg)
  480. {
  481. uint32_t errsrc_mask = p_reg->ERRORSRC;
  482. p_reg->ERRORSRC = errsrc_mask;
  483. return errsrc_mask;
  484. }
  485. __STATIC_INLINE void nrf_uarte_enable(NRF_UARTE_Type * p_reg)
  486. {
  487. p_reg->ENABLE = UARTE_ENABLE_ENABLE_Enabled;
  488. }
  489. __STATIC_INLINE void nrf_uarte_disable(NRF_UARTE_Type * p_reg)
  490. {
  491. p_reg->ENABLE = UARTE_ENABLE_ENABLE_Disabled;
  492. }
  493. __STATIC_INLINE void nrf_uarte_txrx_pins_set(NRF_UARTE_Type * p_reg, uint32_t pseltxd, uint32_t pselrxd)
  494. {
  495. p_reg->PSEL.TXD = pseltxd;
  496. p_reg->PSEL.RXD = pselrxd;
  497. }
  498. __STATIC_INLINE void nrf_uarte_txrx_pins_disconnect(NRF_UARTE_Type * p_reg)
  499. {
  500. nrf_uarte_txrx_pins_set(p_reg, NRF_UARTE_PSEL_DISCONNECTED, NRF_UARTE_PSEL_DISCONNECTED);
  501. }
  502. __STATIC_INLINE uint32_t nrf_uarte_tx_pin_get(NRF_UARTE_Type * p_reg)
  503. {
  504. return p_reg->PSEL.TXD;
  505. }
  506. __STATIC_INLINE uint32_t nrf_uarte_rx_pin_get(NRF_UARTE_Type * p_reg)
  507. {
  508. return p_reg->PSEL.RXD;
  509. }
  510. __STATIC_INLINE uint32_t nrf_uarte_rts_pin_get(NRF_UARTE_Type * p_reg)
  511. {
  512. return p_reg->PSEL.RTS;
  513. }
  514. __STATIC_INLINE uint32_t nrf_uarte_cts_pin_get(NRF_UARTE_Type * p_reg)
  515. {
  516. return p_reg->PSEL.CTS;
  517. }
  518. __STATIC_INLINE void nrf_uarte_hwfc_pins_set(NRF_UARTE_Type * p_reg, uint32_t pselrts, uint32_t pselcts)
  519. {
  520. p_reg->PSEL.RTS = pselrts;
  521. p_reg->PSEL.CTS = pselcts;
  522. }
  523. __STATIC_INLINE void nrf_uarte_hwfc_pins_disconnect(NRF_UARTE_Type * p_reg)
  524. {
  525. nrf_uarte_hwfc_pins_set(p_reg, NRF_UARTE_PSEL_DISCONNECTED, NRF_UARTE_PSEL_DISCONNECTED);
  526. }
  527. __STATIC_INLINE void nrf_uarte_task_trigger(NRF_UARTE_Type * p_reg, nrf_uarte_task_t task)
  528. {
  529. *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)task)) = 0x1UL;
  530. }
  531. __STATIC_INLINE uint32_t nrf_uarte_task_address_get(NRF_UARTE_Type * p_reg, nrf_uarte_task_t task)
  532. {
  533. return (uint32_t)p_reg + (uint32_t)task;
  534. }
  535. __STATIC_INLINE void nrf_uarte_configure(NRF_UARTE_Type * p_reg,
  536. nrf_uarte_parity_t parity,
  537. nrf_uarte_hwfc_t hwfc)
  538. {
  539. p_reg->CONFIG = (uint32_t)parity | (uint32_t)hwfc;
  540. }
  541. __STATIC_INLINE void nrf_uarte_baudrate_set(NRF_UARTE_Type * p_reg, nrf_uarte_baudrate_t baudrate)
  542. {
  543. p_reg->BAUDRATE = baudrate;
  544. }
  545. __STATIC_INLINE void nrf_uarte_tx_buffer_set(NRF_UARTE_Type * p_reg,
  546. uint8_t const * p_buffer,
  547. size_t length)
  548. {
  549. p_reg->TXD.PTR = (uint32_t)p_buffer;
  550. p_reg->TXD.MAXCNT = length;
  551. }
  552. __STATIC_INLINE uint32_t nrf_uarte_tx_amount_get(NRF_UARTE_Type * p_reg)
  553. {
  554. return p_reg->TXD.AMOUNT;
  555. }
  556. __STATIC_INLINE void nrf_uarte_rx_buffer_set(NRF_UARTE_Type * p_reg,
  557. uint8_t * p_buffer,
  558. size_t length)
  559. {
  560. p_reg->RXD.PTR = (uint32_t)p_buffer;
  561. p_reg->RXD.MAXCNT = length;
  562. }
  563. __STATIC_INLINE uint32_t nrf_uarte_rx_amount_get(NRF_UARTE_Type * p_reg)
  564. {
  565. return p_reg->RXD.AMOUNT;
  566. }
  567. #endif //SUPPRESS_INLINE_IMPLEMENTATION
  568. /** @} */
  569. #ifdef __cplusplus
  570. }
  571. #endif
  572. #endif //NRF_UARTE_H__