Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
uart.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018-2019 Nordic Semiconductor ASA
3 * Copyright (c) 2015 Wind River Systems, Inc.
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
13#ifndef ZEPHYR_INCLUDE_DRIVERS_UART_H_
14#define ZEPHYR_INCLUDE_DRIVERS_UART_H_
15
25#include <errno.h>
26#include <stddef.h>
27
28#include <zephyr/device.h>
29
30#ifdef __cplusplus
31extern "C" {
32#endif
33
42
77
86
94
103
117
128
141typedef void (*uart_irq_callback_user_data_t)(const struct device *dev,
142 void *user_data);
143
149typedef void (*uart_irq_config_func_t)(const struct device *dev);
150
260
264 const uint8_t *buf;
266 size_t len;
267};
268
279 size_t offset;
281 size_t len;
282};
283
289
297
314
324typedef void (*uart_callback_t)(const struct device *dev,
325 struct uart_event *evt, void *user_data);
326
338__subsystem struct uart_driver_api {
339
340#ifdef CONFIG_UART_ASYNC_API
341
342 int (*callback_set)(const struct device *dev,
343 uart_callback_t callback,
344 void *user_data);
345
346 int (*tx)(const struct device *dev, const uint8_t *buf, size_t len,
347 int32_t timeout);
348 int (*tx_abort)(const struct device *dev);
349
350 int (*rx_enable)(const struct device *dev, uint8_t *buf, size_t len,
351 int32_t timeout);
352 int (*rx_buf_rsp)(const struct device *dev, uint8_t *buf, size_t len);
353 int (*rx_disable)(const struct device *dev);
354
355#ifdef CONFIG_UART_WIDE_DATA
356 int (*tx_u16)(const struct device *dev, const uint16_t *buf,
357 size_t len, int32_t timeout);
358 int (*rx_enable_u16)(const struct device *dev, uint16_t *buf,
359 size_t len, int32_t timeout);
360 int (*rx_buf_rsp_u16)(const struct device *dev, uint16_t *buf,
361 size_t len);
362#endif
363
364#endif
365
367 int (*poll_in)(const struct device *dev, unsigned char *p_char);
368 void (*poll_out)(const struct device *dev, unsigned char out_char);
369
370#ifdef CONFIG_UART_WIDE_DATA
371 int (*poll_in_u16)(const struct device *dev, uint16_t *p_u16);
372 void (*poll_out_u16)(const struct device *dev, uint16_t out_u16);
373#endif
374
376 int (*err_check)(const struct device *dev);
377
378#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
380 int (*configure)(const struct device *dev,
381 const struct uart_config *cfg);
382 int (*config_get)(const struct device *dev, struct uart_config *cfg);
383#endif
384
385#ifdef CONFIG_UART_INTERRUPT_DRIVEN
386
388 int (*fifo_fill)(const struct device *dev, const uint8_t *tx_data,
389 int len);
390
391#ifdef CONFIG_UART_WIDE_DATA
392 int (*fifo_fill_u16)(const struct device *dev, const uint16_t *tx_data,
393 int len);
394#endif
395
397 int (*fifo_read)(const struct device *dev, uint8_t *rx_data,
398 const int size);
399
400#ifdef CONFIG_UART_WIDE_DATA
401 int (*fifo_read_u16)(const struct device *dev, uint16_t *rx_data,
402 const int size);
403#endif
404
406 void (*irq_tx_enable)(const struct device *dev);
407
409 void (*irq_tx_disable)(const struct device *dev);
410
412 int (*irq_tx_ready)(const struct device *dev);
413
415 void (*irq_rx_enable)(const struct device *dev);
416
418 void (*irq_rx_disable)(const struct device *dev);
419
421 int (*irq_tx_complete)(const struct device *dev);
422
424 int (*irq_rx_ready)(const struct device *dev);
425
427 void (*irq_err_enable)(const struct device *dev);
428
430 void (*irq_err_disable)(const struct device *dev);
431
433 int (*irq_is_pending)(const struct device *dev);
434
436 int (*irq_update)(const struct device *dev);
437
439 void (*irq_callback_set)(const struct device *dev,
441 void *user_data);
442
443#endif
444
445#ifdef CONFIG_UART_LINE_CTRL
446 int (*line_ctrl_set)(const struct device *dev, uint32_t ctrl,
447 uint32_t val);
448 int (*line_ctrl_get)(const struct device *dev, uint32_t ctrl,
449 uint32_t *val);
450#endif
451
452#ifdef CONFIG_UART_DRV_CMD
453 int (*drv_cmd)(const struct device *dev, uint32_t cmd, uint32_t p);
454#endif
455
456};
457
469__syscall int uart_err_check(const struct device *dev);
470
471static inline int z_impl_uart_err_check(const struct device *dev)
472{
473 const struct uart_driver_api *api =
474 (const struct uart_driver_api *)dev->api;
475
476 if (api->err_check == NULL) {
477 return -ENOSYS;
478 }
479
480 return api->err_check(dev);
481}
482
506__syscall int uart_poll_in(const struct device *dev, unsigned char *p_char);
507
508static inline int z_impl_uart_poll_in(const struct device *dev,
509 unsigned char *p_char)
510{
511 const struct uart_driver_api *api =
512 (const struct uart_driver_api *)dev->api;
513
514 if (api->poll_in == NULL) {
515 return -ENOSYS;
516 }
517
518 return api->poll_in(dev, p_char);
519}
520
540__syscall int uart_poll_in_u16(const struct device *dev, uint16_t *p_u16);
541
542static inline int z_impl_uart_poll_in_u16(const struct device *dev,
543 uint16_t *p_u16)
544{
545#ifdef CONFIG_UART_WIDE_DATA
546 const struct uart_driver_api *api =
547 (const struct uart_driver_api *)dev->api;
548
549 if (api->poll_in_u16 == NULL) {
550 return -ENOSYS;
551 }
552
553 return api->poll_in_u16(dev, p_u16);
554#else
555 ARG_UNUSED(dev);
556 ARG_UNUSED(p_u16);
557 return -ENOTSUP;
558#endif
559}
560
575__syscall void uart_poll_out(const struct device *dev,
576 unsigned char out_char);
577
578static inline void z_impl_uart_poll_out(const struct device *dev,
579 unsigned char out_char)
580{
581 const struct uart_driver_api *api =
582 (const struct uart_driver_api *)dev->api;
583
584 api->poll_out(dev, out_char);
585}
586
601__syscall void uart_poll_out_u16(const struct device *dev, uint16_t out_u16);
602
603static inline void z_impl_uart_poll_out_u16(const struct device *dev,
604 uint16_t out_u16)
605{
606#ifdef CONFIG_UART_WIDE_DATA
607 const struct uart_driver_api *api =
608 (const struct uart_driver_api *)dev->api;
609
610 api->poll_out_u16(dev, out_u16);
611#else
612 ARG_UNUSED(dev);
613 ARG_UNUSED(out_u16);
614#endif
615}
616
635__syscall int uart_configure(const struct device *dev,
636 const struct uart_config *cfg);
637
638static inline int z_impl_uart_configure(const struct device *dev,
639 const struct uart_config *cfg)
640{
641#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
642 const struct uart_driver_api *api =
643 (const struct uart_driver_api *)dev->api;
644
645 if (api->configure == NULL) {
646 return -ENOSYS;
647 }
648 return api->configure(dev, cfg);
649#else
650 ARG_UNUSED(dev);
651 ARG_UNUSED(cfg);
652 return -ENOTSUP;
653#endif
654}
655
670__syscall int uart_config_get(const struct device *dev,
671 struct uart_config *cfg);
672
673static inline int z_impl_uart_config_get(const struct device *dev,
674 struct uart_config *cfg)
675{
676#ifdef CONFIG_UART_USE_RUNTIME_CONFIGURE
677 const struct uart_driver_api *api =
678 (const struct uart_driver_api *)dev->api;
679
680 if (api->config_get == NULL) {
681 return -ENOSYS;
682 }
683
684 return api->config_get(dev, cfg);
685#else
686 ARG_UNUSED(dev);
687 ARG_UNUSED(cfg);
688 return -ENOTSUP;
689#endif
690}
691
717static inline int uart_fifo_fill(const struct device *dev,
718 const uint8_t *tx_data,
719 int size)
720{
721#ifdef CONFIG_UART_INTERRUPT_DRIVEN
722 const struct uart_driver_api *api =
723 (const struct uart_driver_api *)dev->api;
724
725 if (api->fifo_fill == NULL) {
726 return -ENOSYS;
727 }
728
729 return api->fifo_fill(dev, tx_data, size);
730#else
731 ARG_UNUSED(dev);
732 ARG_UNUSED(tx_data);
733 ARG_UNUSED(size);
734 return -ENOTSUP;
735#endif
736}
737
758static inline int uart_fifo_fill_u16(const struct device *dev,
759 const uint16_t *tx_data,
760 int size)
761{
762#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
763 const struct uart_driver_api *api =
764 (const struct uart_driver_api *)dev->api;
765
766 if (api->fifo_fill_u16 == NULL) {
767 return -ENOSYS;
768 }
769
770 return api->fifo_fill_u16(dev, tx_data, size);
771#else
772 ARG_UNUSED(dev);
773 ARG_UNUSED(tx_data);
774 ARG_UNUSED(size);
775 return -ENOTSUP;
776#endif
777}
778
800static inline int uart_fifo_read(const struct device *dev, uint8_t *rx_data,
801 const int size)
802{
803#ifdef CONFIG_UART_INTERRUPT_DRIVEN
804 const struct uart_driver_api *api =
805 (const struct uart_driver_api *)dev->api;
806
807 if (api->fifo_read == NULL) {
808 return -ENOSYS;
809 }
810
811 return api->fifo_read(dev, rx_data, size);
812#else
813 ARG_UNUSED(dev);
814 ARG_UNUSED(rx_data);
815 ARG_UNUSED(size);
816 return -ENOTSUP;
817#endif
818}
819
841static inline int uart_fifo_read_u16(const struct device *dev,
842 uint16_t *rx_data,
843 const int size)
844{
845#if defined(CONFIG_UART_INTERRUPT_DRIVEN) && defined(CONFIG_UART_WIDE_DATA)
846 const struct uart_driver_api *api =
847 (const struct uart_driver_api *)dev->api;
848
849 if (api->fifo_read_u16 == NULL) {
850 return -ENOSYS;
851 }
852
853 return api->fifo_read_u16(dev, rx_data, size);
854#else
855 ARG_UNUSED(dev);
856 ARG_UNUSED(rx_data);
857 ARG_UNUSED(size);
858 return -ENOTSUP;
859#endif
860}
861
867__syscall void uart_irq_tx_enable(const struct device *dev);
868
869static inline void z_impl_uart_irq_tx_enable(const struct device *dev)
870{
871#ifdef CONFIG_UART_INTERRUPT_DRIVEN
872 const struct uart_driver_api *api =
873 (const struct uart_driver_api *)dev->api;
874
875 if (api->irq_tx_enable != NULL) {
876 api->irq_tx_enable(dev);
877 }
878#else
879 ARG_UNUSED(dev);
880#endif
881}
882
888__syscall void uart_irq_tx_disable(const struct device *dev);
889
890static inline void z_impl_uart_irq_tx_disable(const struct device *dev)
891{
892#ifdef CONFIG_UART_INTERRUPT_DRIVEN
893 const struct uart_driver_api *api =
894 (const struct uart_driver_api *)dev->api;
895
896 if (api->irq_tx_disable != NULL) {
897 api->irq_tx_disable(dev);
898 }
899#else
900 ARG_UNUSED(dev);
901#endif
902}
903
924static inline int uart_irq_tx_ready(const struct device *dev)
925{
926#ifdef CONFIG_UART_INTERRUPT_DRIVEN
927 const struct uart_driver_api *api =
928 (const struct uart_driver_api *)dev->api;
929
930 if (api->irq_tx_ready == NULL) {
931 return -ENOSYS;
932 }
933
934 return api->irq_tx_ready(dev);
935#else
936 ARG_UNUSED(dev);
937 return -ENOTSUP;
938#endif
939}
940
946__syscall void uart_irq_rx_enable(const struct device *dev);
947
948static inline void z_impl_uart_irq_rx_enable(const struct device *dev)
949{
950#ifdef CONFIG_UART_INTERRUPT_DRIVEN
951 const struct uart_driver_api *api =
952 (const struct uart_driver_api *)dev->api;
953
954 if (api->irq_rx_enable != NULL) {
955 api->irq_rx_enable(dev);
956 }
957#else
958 ARG_UNUSED(dev);
959#endif
960}
961
967__syscall void uart_irq_rx_disable(const struct device *dev);
968
969static inline void z_impl_uart_irq_rx_disable(const struct device *dev)
970{
971#ifdef CONFIG_UART_INTERRUPT_DRIVEN
972 const struct uart_driver_api *api =
973 (const struct uart_driver_api *)dev->api;
974
975 if (api->irq_rx_disable != NULL) {
976 api->irq_rx_disable(dev);
977 }
978#else
979 ARG_UNUSED(dev);
980#endif
981}
982
1002static inline int uart_irq_tx_complete(const struct device *dev)
1003{
1004#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1005 const struct uart_driver_api *api =
1006 (const struct uart_driver_api *)dev->api;
1007
1008 if (api->irq_tx_complete == NULL) {
1009 return -ENOSYS;
1010 }
1011 return api->irq_tx_complete(dev);
1012#else
1013 ARG_UNUSED(dev);
1014 return -ENOTSUP;
1015#endif
1016}
1017
1038static inline int uart_irq_rx_ready(const struct device *dev)
1039{
1040#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1041 const struct uart_driver_api *api =
1042 (const struct uart_driver_api *)dev->api;
1043
1044 if (api->irq_rx_ready == NULL) {
1045 return -ENOSYS;
1046 }
1047 return api->irq_rx_ready(dev);
1048#else
1049 ARG_UNUSED(dev);
1050 return -ENOTSUP;
1051#endif
1052}
1058__syscall void uart_irq_err_enable(const struct device *dev);
1059
1060static inline void z_impl_uart_irq_err_enable(const struct device *dev)
1061{
1062#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1063 const struct uart_driver_api *api =
1064 (const struct uart_driver_api *)dev->api;
1065
1066 if (api->irq_err_enable) {
1067 api->irq_err_enable(dev);
1068 }
1069#else
1070 ARG_UNUSED(dev);
1071#endif
1072}
1073
1079__syscall void uart_irq_err_disable(const struct device *dev);
1080
1081static inline void z_impl_uart_irq_err_disable(const struct device *dev)
1082{
1083#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1084 const struct uart_driver_api *api =
1085 (const struct uart_driver_api *)dev->api;
1086
1087 if (api->irq_err_disable) {
1088 api->irq_err_disable(dev);
1089 }
1090#else
1091 ARG_UNUSED(dev);
1092#endif
1093}
1094
1105__syscall int uart_irq_is_pending(const struct device *dev);
1106
1107static inline int z_impl_uart_irq_is_pending(const struct device *dev)
1108{
1109#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1110 const struct uart_driver_api *api =
1111 (const struct uart_driver_api *)dev->api;
1112
1113 if (api->irq_is_pending == NULL) {
1114 return -ENOSYS;
1115 }
1116 return api->irq_is_pending(dev);
1117#else
1118 ARG_UNUSED(dev);
1119 return -ENOTSUP;
1120#endif
1121}
1122
1148__syscall int uart_irq_update(const struct device *dev);
1149
1150static inline int z_impl_uart_irq_update(const struct device *dev)
1151{
1152#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1153 const struct uart_driver_api *api =
1154 (const struct uart_driver_api *)dev->api;
1155
1156 if (api->irq_update == NULL) {
1157 return -ENOSYS;
1158 }
1159 return api->irq_update(dev);
1160#else
1161 ARG_UNUSED(dev);
1162 return -ENOTSUP;
1163#endif
1164}
1165
1181static inline int uart_irq_callback_user_data_set(const struct device *dev,
1183 void *user_data)
1184{
1185#ifdef CONFIG_UART_INTERRUPT_DRIVEN
1186 const struct uart_driver_api *api =
1187 (const struct uart_driver_api *)dev->api;
1188
1189 if ((api != NULL) && (api->irq_callback_set != NULL)) {
1190 api->irq_callback_set(dev, cb, user_data);
1191 return 0;
1192 } else {
1193 return -ENOSYS;
1194 }
1195#else
1196 ARG_UNUSED(dev);
1197 ARG_UNUSED(cb);
1198 ARG_UNUSED(user_data);
1199 return -ENOTSUP;
1200#endif
1201}
1202
1216static inline int uart_irq_callback_set(const struct device *dev,
1218{
1219 return uart_irq_callback_user_data_set(dev, cb, NULL);
1220}
1221
1246static inline int uart_callback_set(const struct device *dev,
1247 uart_callback_t callback,
1248 void *user_data)
1249{
1250#ifdef CONFIG_UART_ASYNC_API
1251 const struct uart_driver_api *api =
1252 (const struct uart_driver_api *)dev->api;
1253
1254 if (api->callback_set == NULL) {
1255 return -ENOSYS;
1256 }
1257
1258 return api->callback_set(dev, callback, user_data);
1259#else
1260 ARG_UNUSED(dev);
1261 ARG_UNUSED(callback);
1262 ARG_UNUSED(user_data);
1263 return -ENOTSUP;
1264#endif
1265}
1266
1284__syscall int uart_tx(const struct device *dev, const uint8_t *buf,
1285 size_t len,
1286 int32_t timeout);
1287
1288static inline int z_impl_uart_tx(const struct device *dev, const uint8_t *buf,
1289 size_t len, int32_t timeout)
1290
1291{
1292#ifdef CONFIG_UART_ASYNC_API
1293 const struct uart_driver_api *api =
1294 (const struct uart_driver_api *)dev->api;
1295
1296 return api->tx(dev, buf, len, timeout);
1297#else
1298 ARG_UNUSED(dev);
1299 ARG_UNUSED(buf);
1300 ARG_UNUSED(len);
1301 ARG_UNUSED(timeout);
1302 return -ENOTSUP;
1303#endif
1304}
1305
1323__syscall int uart_tx_u16(const struct device *dev, const uint16_t *buf,
1324 size_t len, int32_t timeout);
1325
1326static inline int z_impl_uart_tx_u16(const struct device *dev,
1327 const uint16_t *buf,
1328 size_t len, int32_t timeout)
1329
1330{
1331#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1332 const struct uart_driver_api *api =
1333 (const struct uart_driver_api *)dev->api;
1334
1335 return api->tx_u16(dev, buf, len, timeout);
1336#else
1337 ARG_UNUSED(dev);
1338 ARG_UNUSED(buf);
1339 ARG_UNUSED(len);
1340 ARG_UNUSED(timeout);
1341 return -ENOTSUP;
1342#endif
1343}
1344
1357__syscall int uart_tx_abort(const struct device *dev);
1358
1359static inline int z_impl_uart_tx_abort(const struct device *dev)
1360{
1361#ifdef CONFIG_UART_ASYNC_API
1362 const struct uart_driver_api *api =
1363 (const struct uart_driver_api *)dev->api;
1364
1365 return api->tx_abort(dev);
1366#else
1367 ARG_UNUSED(dev);
1368 return -ENOTSUP;
1369#endif
1370}
1371
1393__syscall int uart_rx_enable(const struct device *dev, uint8_t *buf,
1394 size_t len,
1395 int32_t timeout);
1396
1397static inline int z_impl_uart_rx_enable(const struct device *dev,
1398 uint8_t *buf,
1399 size_t len, int32_t timeout)
1400{
1401#ifdef CONFIG_UART_ASYNC_API
1402 const struct uart_driver_api *api =
1403 (const struct uart_driver_api *)dev->api;
1404
1405 return api->rx_enable(dev, buf, len, timeout);
1406#else
1407 ARG_UNUSED(dev);
1408 ARG_UNUSED(buf);
1409 ARG_UNUSED(len);
1410 ARG_UNUSED(timeout);
1411 return -ENOTSUP;
1412#endif
1413}
1414
1436__syscall int uart_rx_enable_u16(const struct device *dev, uint16_t *buf,
1437 size_t len, int32_t timeout);
1438
1439static inline int z_impl_uart_rx_enable_u16(const struct device *dev,
1440 uint16_t *buf, size_t len,
1441 int32_t timeout)
1442{
1443#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1444 const struct uart_driver_api *api =
1445 (const struct uart_driver_api *)dev->api;
1446
1447 return api->rx_enable_u16(dev, buf, len, timeout);
1448#else
1449 ARG_UNUSED(dev);
1450 ARG_UNUSED(buf);
1451 ARG_UNUSED(len);
1452 ARG_UNUSED(timeout);
1453 return -ENOTSUP;
1454#endif
1455}
1456
1477static inline int uart_rx_buf_rsp(const struct device *dev, uint8_t *buf,
1478 size_t len)
1479{
1480#ifdef CONFIG_UART_ASYNC_API
1481 const struct uart_driver_api *api =
1482 (const struct uart_driver_api *)dev->api;
1483
1484 return api->rx_buf_rsp(dev, buf, len);
1485#else
1486 ARG_UNUSED(dev);
1487 ARG_UNUSED(buf);
1488 ARG_UNUSED(len);
1489 return -ENOTSUP;
1490#endif
1491}
1492
1514static inline int uart_rx_buf_rsp_u16(const struct device *dev, uint16_t *buf,
1515 size_t len)
1516{
1517#if defined(CONFIG_UART_ASYNC_API) && defined(CONFIG_UART_WIDE_DATA)
1518 const struct uart_driver_api *api =
1519 (const struct uart_driver_api *)dev->api;
1520
1521 return api->rx_buf_rsp_u16(dev, buf, len);
1522#else
1523 ARG_UNUSED(dev);
1524 ARG_UNUSED(buf);
1525 ARG_UNUSED(len);
1526 return -ENOTSUP;
1527#endif
1528}
1529
1545__syscall int uart_rx_disable(const struct device *dev);
1546
1547static inline int z_impl_uart_rx_disable(const struct device *dev)
1548{
1549#ifdef CONFIG_UART_ASYNC_API
1550 const struct uart_driver_api *api =
1551 (const struct uart_driver_api *)dev->api;
1552
1553 return api->rx_disable(dev);
1554#else
1555 ARG_UNUSED(dev);
1556 return -ENOTSUP;
1557#endif
1558}
1559
1576__syscall int uart_line_ctrl_set(const struct device *dev,
1577 uint32_t ctrl, uint32_t val);
1578
1579static inline int z_impl_uart_line_ctrl_set(const struct device *dev,
1580 uint32_t ctrl, uint32_t val)
1581{
1582#ifdef CONFIG_UART_LINE_CTRL
1583 const struct uart_driver_api *api =
1584 (const struct uart_driver_api *)dev->api;
1585
1586 if (api->line_ctrl_set == NULL) {
1587 return -ENOSYS;
1588 }
1589 return api->line_ctrl_set(dev, ctrl, val);
1590#else
1591 ARG_UNUSED(dev);
1592 ARG_UNUSED(ctrl);
1593 ARG_UNUSED(val);
1594 return -ENOTSUP;
1595#endif
1596}
1597
1610__syscall int uart_line_ctrl_get(const struct device *dev, uint32_t ctrl,
1611 uint32_t *val);
1612
1613static inline int z_impl_uart_line_ctrl_get(const struct device *dev,
1614 uint32_t ctrl, uint32_t *val)
1615{
1616#ifdef CONFIG_UART_LINE_CTRL
1617 const struct uart_driver_api *api =
1618 (const struct uart_driver_api *)dev->api;
1619
1620 if (api->line_ctrl_get == NULL) {
1621 return -ENOSYS;
1622 }
1623 return api->line_ctrl_get(dev, ctrl, val);
1624#else
1625 ARG_UNUSED(dev);
1626 ARG_UNUSED(ctrl);
1627 ARG_UNUSED(val);
1628 return -ENOTSUP;
1629#endif
1630}
1631
1647__syscall int uart_drv_cmd(const struct device *dev, uint32_t cmd, uint32_t p);
1648
1649static inline int z_impl_uart_drv_cmd(const struct device *dev, uint32_t cmd,
1650 uint32_t p)
1651{
1652#ifdef CONFIG_UART_DRV_CMD
1653 const struct uart_driver_api *api =
1654 (const struct uart_driver_api *)dev->api;
1655
1656 if (api->drv_cmd == NULL) {
1657 return -ENOSYS;
1658 }
1659 return api->drv_cmd(dev, cmd, p);
1660#else
1661 ARG_UNUSED(dev);
1662 ARG_UNUSED(cmd);
1663 ARG_UNUSED(p);
1664 return -ENOTSUP;
1665#endif
1666}
1667
1668#ifdef __cplusplus
1669}
1670#endif
1671
1676#include <zephyr/syscalls/uart.h>
1677
1678#endif /* ZEPHYR_INCLUDE_DRIVERS_UART_H_ */
System error numbers.
static void cmd(uint32_t command)
Execute a display list command by co-processor engine.
Definition ft8xx_reference_api.h:153
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define ENOTSUP
Unsupported value.
Definition errno.h:114
void(* uart_callback_t)(const struct device *dev, struct uart_event *evt, void *user_data)
Define the application callback function signature for uart_callback_set() function.
Definition uart.h:324
int uart_rx_enable_u16(const struct device *dev, uint16_t *buf, size_t len, int32_t timeout)
Start receiving wide data through UART.
static int uart_rx_buf_rsp(const struct device *dev, uint8_t *buf, size_t len)
Provide receive buffer in response to UART_RX_BUF_REQUEST event.
Definition uart.h:1477
static int uart_rx_buf_rsp_u16(const struct device *dev, uint16_t *buf, size_t len)
Provide wide data receive buffer in response to UART_RX_BUF_REQUEST event.
Definition uart.h:1514
int uart_rx_enable(const struct device *dev, uint8_t *buf, size_t len, int32_t timeout)
Start receiving data through UART.
int uart_tx_abort(const struct device *dev)
Abort current TX transmission.
int uart_tx_u16(const struct device *dev, const uint16_t *buf, size_t len, int32_t timeout)
Send given number of datum from buffer through UART.
static int uart_callback_set(const struct device *dev, uart_callback_t callback, void *user_data)
Set event handler function.
Definition uart.h:1246
uart_event_type
Types of events passed to callback in UART_ASYNC_API.
Definition uart.h:207
int uart_tx(const struct device *dev, const uint8_t *buf, size_t len, int32_t timeout)
Send given number of bytes from buffer through UART.
int uart_rx_disable(const struct device *dev)
Disable RX.
@ UART_RX_STOPPED
RX has stopped due to external event.
Definition uart.h:258
@ UART_TX_ABORTED
Transmitting aborted due to timeout or uart_tx_abort call.
Definition uart.h:217
@ UART_RX_BUF_REQUEST
Driver requests next buffer for continuous reception.
Definition uart.h:240
@ UART_TX_DONE
Whole TX buffer was transmitted.
Definition uart.h:209
@ UART_RX_RDY
Received data is ready for processing.
Definition uart.h:228
@ UART_RX_DISABLED
RX has been disabled and can be reenabled.
Definition uart.h:252
@ UART_RX_BUF_RELEASED
Buffer is no longer used by UART driver.
Definition uart.h:244
uart_line_ctrl
Line control signals.
Definition uart.h:35
int uart_err_check(const struct device *dev)
Check whether an error was detected.
int uart_config_get(const struct device *dev, struct uart_config *cfg)
Get UART configuration.
uart_config_flow_control
Hardware flow control options.
Definition uart.h:111
int uart_configure(const struct device *dev, const struct uart_config *cfg)
Set UART configuration.
int uart_drv_cmd(const struct device *dev, uint32_t cmd, uint32_t p)
Send extra command to driver.
int uart_line_ctrl_set(const struct device *dev, uint32_t ctrl, uint32_t val)
Manipulate line control for UART.
uart_config_parity
Parity modes.
Definition uart.h:79
uart_config_data_bits
Number of data bits.
Definition uart.h:96
uart_rx_stop_reason
Reception stop reasons.
Definition uart.h:49
uart_config_stop_bits
Number of stop bits.
Definition uart.h:88
int uart_line_ctrl_get(const struct device *dev, uint32_t ctrl, uint32_t *val)
Retrieve line control for UART.
@ UART_LINE_CTRL_DTR
Data Terminal Ready (DTR)
Definition uart.h:38
@ UART_LINE_CTRL_RTS
Request To Send (RTS)
Definition uart.h:37
@ UART_LINE_CTRL_BAUD_RATE
Baud rate.
Definition uart.h:36
@ UART_LINE_CTRL_DCD
Data Carrier Detect (DCD)
Definition uart.h:39
@ UART_LINE_CTRL_DSR
Data Set Ready (DSR)
Definition uart.h:40
@ UART_CFG_FLOW_CTRL_DTR_DSR
DTR/DSR flow control.
Definition uart.h:114
@ UART_CFG_FLOW_CTRL_NONE
No flow control.
Definition uart.h:112
@ UART_CFG_FLOW_CTRL_RS485
RS485 flow control.
Definition uart.h:115
@ UART_CFG_FLOW_CTRL_RTS_CTS
RTS/CTS flow control.
Definition uart.h:113
@ UART_CFG_PARITY_MARK
Mark parity.
Definition uart.h:83
@ UART_CFG_PARITY_NONE
No parity.
Definition uart.h:80
@ UART_CFG_PARITY_ODD
Odd parity.
Definition uart.h:81
@ UART_CFG_PARITY_SPACE
Space parity.
Definition uart.h:84
@ UART_CFG_PARITY_EVEN
Even parity.
Definition uart.h:82
@ UART_CFG_DATA_BITS_5
5 data bits
Definition uart.h:97
@ UART_CFG_DATA_BITS_8
8 data bits
Definition uart.h:100
@ UART_CFG_DATA_BITS_7
7 data bits
Definition uart.h:99
@ UART_CFG_DATA_BITS_6
6 data bits
Definition uart.h:98
@ UART_CFG_DATA_BITS_9
9 data bits
Definition uart.h:101
@ UART_ERROR_NOISE
Noise error.
Definition uart.h:75
@ UART_ERROR_OVERRUN
Overrun error.
Definition uart.h:51
@ UART_BREAK
Break interrupt.
Definition uart.h:63
@ UART_ERROR_PARITY
Parity error.
Definition uart.h:53
@ UART_ERROR_COLLISION
Collision error.
Definition uart.h:73
@ UART_ERROR_FRAMING
Framing error.
Definition uart.h:55
@ UART_CFG_STOP_BITS_1_5
1.5 stop bits
Definition uart.h:91
@ UART_CFG_STOP_BITS_0_5
0.5 stop bit
Definition uart.h:89
@ UART_CFG_STOP_BITS_1
1 stop bit
Definition uart.h:90
@ UART_CFG_STOP_BITS_2
2 stop bits
Definition uart.h:92
int uart_irq_is_pending(const struct device *dev)
Check if any IRQs is pending.
static int uart_fifo_read_u16(const struct device *dev, uint16_t *rx_data, const int size)
Read wide data from FIFO.
Definition uart.h:841
void uart_irq_rx_enable(const struct device *dev)
Enable RX interrupt.
static int uart_irq_tx_ready(const struct device *dev)
Check if UART TX buffer can accept bytes.
Definition uart.h:924
static int uart_irq_callback_set(const struct device *dev, uart_irq_callback_user_data_t cb)
Set the IRQ callback function pointer (legacy).
Definition uart.h:1216
void(* uart_irq_config_func_t)(const struct device *dev)
For configuring IRQ on each individual UART device.
Definition uart.h:149
void uart_irq_err_enable(const struct device *dev)
Enable error interrupt.
static int uart_irq_tx_complete(const struct device *dev)
Check if UART TX block finished transmission.
Definition uart.h:1002
void uart_irq_tx_enable(const struct device *dev)
Enable TX interrupt in IER.
void uart_irq_rx_disable(const struct device *dev)
Disable RX interrupt.
static int uart_fifo_fill_u16(const struct device *dev, const uint16_t *tx_data, int size)
Fill FIFO with wide data.
Definition uart.h:758
void uart_irq_err_disable(const struct device *dev)
Disable error interrupt.
static int uart_fifo_read(const struct device *dev, uint8_t *rx_data, const int size)
Read data from FIFO.
Definition uart.h:800
int uart_irq_update(const struct device *dev)
Start processing interrupts in ISR.
static int uart_irq_rx_ready(const struct device *dev)
Check if UART RX buffer has a received char.
Definition uart.h:1038
void(* uart_irq_callback_user_data_t)(const struct device *dev, void *user_data)
Define the application callback function signature for uart_irq_callback_user_data_set() function.
Definition uart.h:141
static int uart_irq_callback_user_data_set(const struct device *dev, uart_irq_callback_user_data_t cb, void *user_data)
Set the IRQ callback function pointer.
Definition uart.h:1181
void uart_irq_tx_disable(const struct device *dev)
Disable TX interrupt in IER.
static int uart_fifo_fill(const struct device *dev, const uint8_t *tx_data, int size)
Fill FIFO with data.
Definition uart.h:717
void uart_poll_out(const struct device *dev, unsigned char out_char)
Write a character to the device for output.
void uart_poll_out_u16(const struct device *dev, uint16_t out_u16)
Write a 16-bit datum to the device for output.
int uart_poll_in_u16(const struct device *dev, uint16_t *p_u16)
Read a 16-bit datum from the device for input.
int uart_poll_in(const struct device *dev, unsigned char *p_char)
Read a character from the device for input.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:412
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:418
UART controller configuration structure.
Definition uart.h:121
uint8_t stop_bits
Stop bits, use uart_config_stop_bits.
Definition uart.h:124
uint8_t parity
Parity bit, use uart_config_parity.
Definition uart.h:123
uint8_t data_bits
Data bits, use uart_config_data_bits.
Definition uart.h:125
uint32_t baudrate
Baudrate setting in bps.
Definition uart.h:122
uint8_t flow_ctrl
Flow control setting, use uart_config_flow_control.
Definition uart.h:126
UART RX buffer released event data.
Definition uart.h:285
uint8_t * buf
Pointer to buffer that is no longer in use.
Definition uart.h:287
UART RX stopped data.
Definition uart.h:291
struct uart_event_rx data
Last received data.
Definition uart.h:295
enum uart_rx_stop_reason reason
Reason why receiving stopped.
Definition uart.h:293
UART RX event data.
Definition uart.h:275
uint8_t * buf
Pointer to current buffer.
Definition uart.h:277
size_t len
Number of new bytes received.
Definition uart.h:281
size_t offset
Currently received data offset in bytes.
Definition uart.h:279
UART TX event data.
Definition uart.h:262
const uint8_t * buf
Pointer to current buffer.
Definition uart.h:264
size_t len
Number of bytes sent.
Definition uart.h:266
Structure containing information about current event.
Definition uart.h:299
union uart_event::uart_event_data data
enum uart_event_type type
Type of event.
Definition uart.h:301
Event data.
Definition uart.h:303
struct uart_event_tx tx
UART_TX_DONE and UART_TX_ABORTED events data.
Definition uart.h:305
struct uart_event_rx_stop rx_stop
UART_RX_STOPPED event data.
Definition uart.h:311
struct uart_event_rx_buf rx_buf
UART_RX_BUF_RELEASED event data.
Definition uart.h:309
struct uart_event_rx rx
UART_RX_RDY event data.
Definition uart.h:307