esp_hal/twai/mod.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
//! # Two-wire Automotive Interface (TWAI)
//!
//! ## Overview
//!
//! The TWAI is a multi-master, multi-cast communication protocol with error
//! detection and signaling and inbuilt message priorities and arbitration. The
//! TWAI protocol is suited for automotive and industrial applications.
//!
//! See ESP-IDF's
#, "/api-reference/peripherals/twai.html#twai-protocol-summary)")]
//! for a summary on the protocol.
//!
//! ## Configuration
//! The driver offers functions for initializing the TWAI peripheral, setting
//! up the timing parameters, configuring acceptance filters, handling
//! interrupts, and transmitting/receiving messages on the TWAI bus.
//!
//! This driver manages the ISO 11898-1 compatible TWAI
//! controllers. It supports Standard Frame Format (11-bit) and Extended Frame
//! Format (29-bit) frame identifiers.
//!
//! ## Examples
//!
//! ### Transmitting and Receiving Messages
//!
//! ```rust, no_run
#![doc = crate::before_snippet!()]
//! # use esp_hal::twai;
//! # use esp_hal::twai::filter;
//! # use esp_hal::twai::filter::SingleStandardFilter;
//! # use esp_hal::twai::TwaiConfiguration;
//! # use esp_hal::twai::BaudRate;
//! # use esp_hal::twai::TwaiMode;
//! # use nb::block;
//! // Use GPIO pins 2 and 3 to connect to the respective pins on the TWAI
//! // transceiver.
//! let twai_rx_pin = peripherals.GPIO3;
//! let twai_tx_pin = peripherals.GPIO2;
//!
//! // The speed of the TWAI bus.
//! const TWAI_BAUDRATE: twai::BaudRate = BaudRate::B1000K;
//!
//! // Begin configuring the TWAI peripheral. The peripheral is in a reset like
//! // state that prevents transmission but allows configuration.
//! let mut twai_config = twai::TwaiConfiguration::new(
//! peripherals.TWAI0,
//! twai_rx_pin,
//! twai_tx_pin,
//! TWAI_BAUDRATE,
//! TwaiMode::Normal
//! );
//!
//! // Partially filter the incoming messages to reduce overhead of receiving
//! // undesired messages
//! twai_config.set_filter(const { SingleStandardFilter::new(b"xxxxxxxxxx0",
//! b"x", [b"xxxxxxxx", b"xxxxxxxx"]) });
//!
//! // Start the peripheral. This locks the configuration settings of the
//! // peripheral and puts it into operation mode, allowing packets to be sent
//! // and received.
//! let mut twai = twai_config.start();
//!
//! loop {
//! // Wait for a frame to be received.
//! let frame = block!(twai.receive())?;
//!
//! // Transmit the frame back.
//! let _result = block!(twai.transmit(&frame))?;
//! }
//! # }
//! ```
//!
//! ### Self-testing (self reception of transmitted messages)
//! ```rust, no_run
#![doc = crate::before_snippet!()]
//! # use esp_hal::twai;
//! # use esp_hal::twai::filter;
//! # use esp_hal::twai::filter::SingleStandardFilter;
//! # use esp_hal::twai::TwaiConfiguration;
//! # use esp_hal::twai::BaudRate;
//! # use esp_hal::twai::EspTwaiFrame;
//! # use esp_hal::twai::StandardId;
//! # use esp_hal::twai::TwaiMode;
//! # use nb::block;
//! // Use GPIO pins 2 and 3 to connect to the respective pins on the TWAI
//! // transceiver.
//! let can_rx_pin = peripherals.GPIO3;
//! let can_tx_pin = peripherals.GPIO2;
//!
//! // The speed of the TWAI bus.
//! const TWAI_BAUDRATE: twai::BaudRate = BaudRate::B1000K;
//!
//! // Begin configuring the TWAI peripheral.
//! let mut can_config = twai::TwaiConfiguration::new(
//! peripherals.TWAI0,
//! can_rx_pin,
//! can_tx_pin,
//! TWAI_BAUDRATE,
//! TwaiMode::SelfTest
//! );
//!
//! // Partially filter the incoming messages to reduce overhead of receiving
//! // undesired messages
//! can_config.set_filter(const { SingleStandardFilter::new(b"xxxxxxxxxx0",
//! b"x", [b"xxxxxxxx", b"xxxxxxxx"]) });
//!
//! // Start the peripheral. This locks the configuration settings of the
//! // peripheral and puts it into operation mode, allowing packets to be sent
//! // and received.
//! let mut can = can_config.start();
//!
//! # // TODO: `new_*` should return Result not Option
//! let frame = EspTwaiFrame::new_self_reception(StandardId::ZERO,
//! &[1, 2, 3]).unwrap(); // Wait for a frame to be received.
//! let frame = block!(can.receive())?;
//!
//! # loop {}
//! # }
//! ```
use core::marker::PhantomData;
use self::filter::{Filter, FilterType};
use crate::{
gpio::{
interconnect::{PeripheralInput, PeripheralOutput},
InputSignal,
OutputSignal,
Pull,
},
interrupt::InterruptHandler,
pac::twai0::RegisterBlock,
peripheral::{Peripheral, PeripheralRef},
system::{Cpu, PeripheralGuard},
twai::filter::SingleStandardFilter,
Async,
Blocking,
DriverMode,
};
pub mod filter;
/// TWAI error kind
///
/// This represents a common set of TWAI operation errors. HAL implementations
/// are free to define more specific or additional error types. However, by
/// providing a mapping to these common TWAI errors, generic code can still
/// react to them.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[non_exhaustive]
pub enum ErrorKind {
/// The peripheral receive buffer was overrun.
Overrun,
// MAC sublayer errors
/// A bit error is detected at that bit time when the bit value that is
/// monitored differs from the bit value sent.
Bit,
/// A stuff error is detected at the bit time of the sixth consecutive
/// equal bit level in a frame field that shall be coded by the method
/// of bit stuffing.
Stuff,
/// Calculated CRC sequence does not equal the received one.
Crc,
/// A form error shall be detected when a fixed-form bit field contains
/// one or more illegal bits.
Form,
/// An ACK error shall be detected by a transmitter whenever it does not
/// monitor a dominant bit during the ACK slot.
Acknowledge,
/// A different error occurred. The original error may contain more
/// information.
Other,
}
macro_rules! impl_display {
($($kind:ident => $msg:expr),* $(,)?) => {
impl core::fmt::Display for ErrorKind {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
match self {
$(Self::$kind => write!(f, $msg)),*
}
}
}
#[cfg(feature = "defmt")]
impl defmt::Format for ErrorKind {
fn format(&self, f: defmt::Formatter<'_>) {
match self {
$(Self::$kind => defmt::write!(f, $msg)),*
}
}
}
};
}
impl_display! {
Overrun => "The peripheral receive buffer was overrun",
Bit => "Bit value that is monitored differs from the bit value sent",
Stuff => "Sixth consecutive equal bits detected",
Crc => "Calculated CRC sequence does not equal the received one",
Form => "A fixed-form bit field contains one or more illegal bits",
Acknowledge => "Transmitted frame was not acknowledged",
Other => "A different error occurred. The original error may contain more information",
}
#[instability::unstable]
impl From<ErrorKind> for embedded_can::ErrorKind {
fn from(value: ErrorKind) -> Self {
match value {
ErrorKind::Overrun => embedded_can::ErrorKind::Overrun,
ErrorKind::Bit => embedded_can::ErrorKind::Bit,
ErrorKind::Stuff => embedded_can::ErrorKind::Stuff,
ErrorKind::Crc => embedded_can::ErrorKind::Crc,
ErrorKind::Form => embedded_can::ErrorKind::Form,
ErrorKind::Acknowledge => embedded_can::ErrorKind::Acknowledge,
ErrorKind::Other => embedded_can::ErrorKind::Other,
}
}
}
#[instability::unstable]
impl embedded_can::Error for ErrorKind {
fn kind(&self) -> embedded_can::ErrorKind {
(*self).into()
}
}
/// Specifies in which mode the TWAI controller will operate.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum TwaiMode {
/// Normal operating mode
Normal,
/// Self-test mode (no acknowledgement required for a successful message
/// transmission)
SelfTest,
/// Listen only operating mode
ListenOnly,
}
/// Standard 11-bit TWAI Identifier (`0..=0x7FF`).
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct StandardId(u16);
impl StandardId {
/// TWAI ID `0`, the highest priority.
pub const ZERO: Self = StandardId(0);
/// TWAI ID `0x7FF`, the lowest priority.
pub const MAX: Self = StandardId(0x7FF);
/// Tries to create a `StandardId` from a raw 16-bit integer.
///
/// This will return `None` if `raw` is out of range of an 11-bit integer
/// (`> 0x7FF`).
#[inline]
pub fn new(raw: u16) -> Option<Self> {
if raw <= 0x7FF {
Some(StandardId(raw))
} else {
None
}
}
/// Creates a new `StandardId` without checking if it is inside the valid
/// range.
///
/// # Safety
/// Using this method can create an invalid ID and is thus marked as unsafe.
#[inline]
pub const unsafe fn new_unchecked(raw: u16) -> Self {
StandardId(raw)
}
/// Returns TWAI Identifier as a raw 16-bit integer.
#[inline]
pub fn as_raw(&self) -> u16 {
self.0
}
}
#[instability::unstable]
impl From<StandardId> for embedded_can::StandardId {
fn from(value: StandardId) -> Self {
embedded_can::StandardId::new(value.as_raw()).unwrap()
}
}
#[instability::unstable]
impl From<embedded_can::StandardId> for StandardId {
fn from(value: embedded_can::StandardId) -> Self {
StandardId::new(value.as_raw()).unwrap()
}
}
/// Extended 29-bit TWAI Identifier (`0..=1FFF_FFFF`).
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct ExtendedId(u32);
impl ExtendedId {
/// TWAI ID `0`, the highest priority.
pub const ZERO: Self = ExtendedId(0);
/// TWAI ID `0x1FFFFFFF`, the lowest priority.
pub const MAX: Self = ExtendedId(0x1FFF_FFFF);
/// Tries to create a `ExtendedId` from a raw 32-bit integer.
///
/// This will return `None` if `raw` is out of range of an 29-bit integer
/// (`> 0x1FFF_FFFF`).
#[inline]
pub fn new(raw: u32) -> Option<Self> {
if raw <= 0x1FFF_FFFF {
Some(ExtendedId(raw))
} else {
None
}
}
/// Creates a new `ExtendedId` without checking if it is inside the valid
/// range.
///
/// # Safety
/// Using this method can create an invalid ID and is thus marked as unsafe.
#[inline]
pub const unsafe fn new_unchecked(raw: u32) -> Self {
ExtendedId(raw)
}
/// Returns TWAI Identifier as a raw 32-bit integer.
#[inline]
pub fn as_raw(&self) -> u32 {
self.0
}
/// Returns the Base ID part of this extended identifier.
pub fn standard_id(&self) -> StandardId {
// ID-28 to ID-18
StandardId((self.0 >> 18) as u16)
}
}
#[instability::unstable]
impl From<ExtendedId> for embedded_can::ExtendedId {
fn from(value: ExtendedId) -> Self {
embedded_can::ExtendedId::new(value.0).unwrap()
}
}
#[instability::unstable]
impl From<embedded_can::ExtendedId> for ExtendedId {
fn from(value: embedded_can::ExtendedId) -> Self {
ExtendedId::new(value.as_raw()).unwrap()
}
}
/// A TWAI Identifier (standard or extended).
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum Id {
/// Standard 11-bit Identifier (`0..=0x7FF`).
Standard(StandardId),
/// Extended 29-bit Identifier (`0..=0x1FFF_FFFF`).
Extended(ExtendedId),
}
impl From<StandardId> for Id {
#[inline]
fn from(id: StandardId) -> Self {
Id::Standard(id)
}
}
impl From<ExtendedId> for Id {
#[inline]
fn from(id: ExtendedId) -> Self {
Id::Extended(id)
}
}
#[instability::unstable]
impl From<Id> for embedded_can::Id {
fn from(value: Id) -> Self {
match value {
Id::Standard(id) => embedded_can::Id::Standard(id.into()),
Id::Extended(id) => embedded_can::Id::Extended(id.into()),
}
}
}
#[instability::unstable]
impl From<embedded_can::Id> for Id {
fn from(value: embedded_can::Id) -> Self {
match value {
embedded_can::Id::Standard(id) => Id::Standard(id.into()),
embedded_can::Id::Extended(id) => Id::Extended(id.into()),
}
}
}
/// A TWAI Frame.
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct EspTwaiFrame {
id: Id,
dlc: usize,
data: [u8; 8],
is_remote: bool,
self_reception: bool,
}
impl EspTwaiFrame {
/// Creates a new `EspTwaiFrame` with the specified ID and data payload.
pub fn new(id: impl Into<Id>, data: &[u8]) -> Option<Self> {
// TWAI frames cannot contain more than 8 bytes of data.
if data.len() > 8 {
return None;
}
let mut d: [u8; 8] = [0; 8];
d[..data.len()].copy_from_slice(data);
Some(EspTwaiFrame {
id: id.into(),
data: d,
dlc: data.len(),
is_remote: false,
self_reception: false,
})
}
/// Creates a new `EspTwaiFrame` for a transmission request with the
/// specified ID and data length (DLC).
pub fn new_remote(id: impl Into<Id>, dlc: usize) -> Option<Self> {
// TWAI frames cannot have more than 8 bytes.
if dlc > 8 {
return None;
}
Some(EspTwaiFrame {
id: id.into(),
data: [0; 8],
dlc,
is_remote: true,
self_reception: false,
})
}
/// Creates a new `EspTwaiFrame` ready for self-reception with the specified
/// ID and data payload.
pub fn new_self_reception(id: impl Into<Id>, data: &[u8]) -> Option<Self> {
if data.len() > 8 {
return None;
}
let mut d: [u8; 8] = [0; 8];
d[..data.len()].copy_from_slice(data);
Some(EspTwaiFrame {
id: id.into(),
data: d,
dlc: data.len(),
is_remote: false,
self_reception: true,
})
}
/// Make a new frame from an id, pointer to the TWAI_DATA_x_REG registers,
/// and the length of the data payload (dlc).
///
/// # Safety
/// This is unsafe because it directly accesses peripheral registers.
unsafe fn new_from_data_registers(
id: impl Into<Id>,
registers: *const u32,
dlc: usize,
) -> Self {
let mut data: [u8; 8] = [0; 8];
// Copy the data from the memory mapped peripheral into actual memory.
copy_from_data_register(&mut data[..dlc], registers);
Self {
id: id.into(),
data,
dlc,
is_remote: false,
self_reception: false,
}
}
}
#[instability::unstable]
impl embedded_can::Frame for EspTwaiFrame {
fn new(id: impl Into<embedded_can::Id>, data: &[u8]) -> Option<Self> {
Self::new(id.into(), data)
}
fn new_remote(id: impl Into<embedded_can::Id>, dlc: usize) -> Option<Self> {
Self::new_remote(id.into(), dlc)
}
fn is_extended(&self) -> bool {
matches!(self.id, Id::Extended(_))
}
fn is_remote_frame(&self) -> bool {
self.is_remote
}
fn id(&self) -> embedded_can::Id {
self.id.into()
}
fn dlc(&self) -> usize {
self.dlc
}
fn data(&self) -> &[u8] {
// Remote frames do not contain data, yet have a value for the dlc so return
// an empty slice for remote frames.
match self.is_remote {
true => &[],
false => &self.data[0..self.dlc],
}
}
}
/// The underlying timings for the TWAI peripheral.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TimingConfig {
/// The baudrate prescaler is used to determine the period of each time
/// quantum by dividing the TWAI controller's source clock.
pub baud_rate_prescaler: u16,
/// The synchronization jump width is used to determine the maximum number
/// of time quanta a single bit time can be lengthened/shortened for
/// synchronization purposes.
pub sync_jump_width: u8,
/// Timing segment 1 consists of 1 to 16 time quanta before sample point.
pub tseg_1: u8,
/// Timing Segment 2 consists of 1 to 8 time quanta after sample point.
pub tseg_2: u8,
/// Enabling triple sampling causes 3 time quanta to be sampled per bit
/// instead of 1.
pub triple_sample: bool,
}
/// A selection of pre-determined baudrates for the TWAI driver.
/// Currently these timings are sourced from the ESP IDF C driver which assumes
/// an APB clock of 80MHz.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum BaudRate {
/// A baud rate of 125 Kbps.
B125K,
/// A baud rate of 250 Kbps.
B250K,
/// A baud rate of 500 Kbps.
B500K,
/// A baud rate of 1 Mbps.
B1000K,
/// A custom baud rate defined by the user.
///
/// This variant allows users to specify their own timing configuration
/// using a `TimingConfig` struct.
Custom(TimingConfig),
}
impl BaudRate {
/// Convert the BaudRate into the timings that the peripheral needs.
// See: https://github.com/espressif/esp-idf/tree/master/components/hal/include/hal/twai_types.h
const fn timing(self) -> TimingConfig {
#[cfg(not(esp32h2))]
let timing = match self {
Self::B125K => TimingConfig {
baud_rate_prescaler: 32,
sync_jump_width: 3,
tseg_1: 15,
tseg_2: 4,
triple_sample: false,
},
Self::B250K => TimingConfig {
baud_rate_prescaler: 16,
sync_jump_width: 3,
tseg_1: 15,
tseg_2: 4,
triple_sample: false,
},
Self::B500K => TimingConfig {
baud_rate_prescaler: 8,
sync_jump_width: 3,
tseg_1: 15,
tseg_2: 4,
triple_sample: false,
},
Self::B1000K => TimingConfig {
baud_rate_prescaler: 4,
sync_jump_width: 3,
tseg_1: 15,
tseg_2: 4,
triple_sample: false,
},
Self::Custom(timing_config) => timing_config,
};
#[cfg(esp32h2)]
let timing = match self {
Self::B125K => TimingConfig {
baud_rate_prescaler: 16,
sync_jump_width: 3,
tseg_1: 11,
tseg_2: 4,
triple_sample: false,
},
Self::B250K => TimingConfig {
baud_rate_prescaler: 8,
sync_jump_width: 3,
tseg_1: 11,
tseg_2: 4,
triple_sample: false,
},
Self::B500K => TimingConfig {
baud_rate_prescaler: 4,
sync_jump_width: 3,
tseg_1: 11,
tseg_2: 4,
triple_sample: false,
},
Self::B1000K => TimingConfig {
baud_rate_prescaler: 2,
sync_jump_width: 3,
tseg_1: 11,
tseg_2: 4,
triple_sample: false,
},
Self::Custom(timing_config) => timing_config,
};
// clock source on ESP32-C6 is xtal (40MHz)
#[cfg(esp32c6)]
let timing = TimingConfig {
baud_rate_prescaler: timing.baud_rate_prescaler / 2,
..timing
};
timing
}
}
/// An inactive TWAI peripheral in the "Reset"/configuration state.
pub struct TwaiConfiguration<'d, Dm: DriverMode> {
twai: PeripheralRef<'d, AnyTwai>,
filter: Option<(FilterType, [u8; 8])>,
phantom: PhantomData<Dm>,
mode: TwaiMode,
_guard: PeripheralGuard,
}
impl<'d, Dm> TwaiConfiguration<'d, Dm>
where
Dm: DriverMode,
{
fn new_internal<TX: PeripheralOutput, RX: PeripheralInput>(
twai: PeripheralRef<'d, AnyTwai>,
rx_pin: impl Peripheral<P = RX> + 'd,
tx_pin: impl Peripheral<P = TX> + 'd,
baud_rate: BaudRate,
no_transceiver: bool,
mode: TwaiMode,
) -> Self {
crate::into_mapped_ref!(tx_pin, rx_pin);
let guard = PeripheralGuard::new(twai.peripheral());
let mut this = TwaiConfiguration {
twai,
filter: None, // We'll immediately call `set_filter`
phantom: PhantomData,
mode,
_guard: guard,
};
// Accept all messages by default.
this.set_filter(
const { SingleStandardFilter::new(b"xxxxxxxxxxx", b"x", [b"xxxxxxxx", b"xxxxxxxx"]) },
);
// Set RESET bit to 1
this.regs().mode().write(|w| w.reset_mode().set_bit());
// Enable extended register layout
#[cfg(esp32)]
this.regs()
.clock_divider()
.modify(|_, w| w.ext_mode().set_bit());
// Set up the GPIO pins.
let rx_pull = if no_transceiver {
tx_pin.set_to_open_drain_output();
tx_pin.pull_direction(Pull::Up);
Pull::Up
} else {
tx_pin.set_to_push_pull_output();
Pull::None
};
this.twai.output_signal().connect_to(tx_pin);
// Setting up RX pin later allows us to use a single pin in tests.
// `set_to_push_pull_output` disables input, here we re-enable it if rx_pin
// uses the same GPIO.
rx_pin.init_input(rx_pull);
this.twai.input_signal().connect_to(rx_pin);
// Freeze REC by changing to LOM mode
this.set_mode(TwaiMode::ListenOnly);
// Set TEC to 0
this.regs()
.tx_err_cnt()
.write(|w| unsafe { w.tx_err_cnt().bits(0) });
// Set REC to 0
this.regs()
.rx_err_cnt()
.write(|w| unsafe { w.rx_err_cnt().bits(0) });
// Set EWL to 96
this.regs()
.err_warning_limit()
.write(|w| unsafe { w.err_warning_limit().bits(96) });
this.set_baud_rate(baud_rate);
this
}
fn regs(&self) -> &RegisterBlock {
self.twai.register_block()
}
fn internal_set_interrupt_handler(&mut self, handler: InterruptHandler) {
for core in Cpu::other() {
crate::interrupt::disable(core, self.twai.interrupt());
}
unsafe { crate::interrupt::bind_interrupt(self.twai.interrupt(), handler.handler()) };
unwrap!(crate::interrupt::enable(
self.twai.interrupt(),
handler.priority()
));
}
/// Set the bitrate of the bus.
///
/// Note: The timings currently assume a APB_CLK of 80MHz.
fn set_baud_rate(&mut self, baud_rate: BaudRate) {
// TWAI is clocked from the APB_CLK according to Table 6-4 [ESP32C3 Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf)
// Included timings are all for 80MHz so assert that we are running at 80MHz.
#[cfg(not(any(esp32h2, esp32c6)))]
{
let apb_clock = crate::clock::Clocks::get().apb_clock;
assert!(apb_clock.as_mhz() == 80);
}
// Unpack the baud rate timings and convert them to the values needed for the
// register. Many of the registers have a minimum value of 1 which is
// represented by having zero bits set, therefore many values need to
// have 1 subtracted from them before being stored into the register.
let timing = baud_rate.timing();
#[cfg_attr(not(esp32), allow(unused_mut))]
let mut prescaler = timing.baud_rate_prescaler;
#[cfg(esp32)]
{
// From <https://github.com/espressif/esp-idf/blob/6e5a178b3120dced7fa5c29c655cc22ea182df3d/components/soc/esp32/register/soc/twai_struct.h#L79>
// and <https://github.com/espressif/esp-idf/blob/6e5a178b3120dced7fa5c29c655cc22ea182df3d/components/hal/esp32/include/hal/twai_ll.h#L528-L534>:
if timing.baud_rate_prescaler > 128 {
// Enable /2 baudrate divider by setting `brp_div`.
// `brp_div` is not an interrupt, it will prescale BRP by 2. Only available on
// ESP32 Revision 2 or later. Reserved otherwise.
self.regs().int_ena().modify(|_, w| w.brp_div().set_bit());
prescaler = timing.baud_rate_prescaler / 2;
} else {
// Disable /2 baudrate divider by clearing brp_div.
self.regs().int_ena().modify(|_, w| w.brp_div().clear_bit());
}
}
let prescale = (prescaler / 2) - 1;
let sjw = timing.sync_jump_width - 1;
let tseg_1 = timing.tseg_1 - 1;
let tseg_2 = timing.tseg_2 - 1;
let triple_sample = timing.triple_sample;
// Set up the prescaler and sync jump width.
self.regs().bus_timing_0().modify(|_, w| unsafe {
w.baud_presc().bits(prescale as _);
w.sync_jump_width().bits(sjw)
});
// Set up the time segment 1, time segment 2, and triple sample.
self.regs().bus_timing_1().modify(|_, w| unsafe {
w.time_seg1().bits(tseg_1);
w.time_seg2().bits(tseg_2);
w.time_samp().bit(triple_sample)
});
// disable CLKOUT
self.regs()
.clock_divider()
.modify(|_, w| w.clock_off().set_bit());
}
/// Set up the acceptance filter on the device.
///
/// NOTE: On a bus with mixed 11-bit and 29-bit packet id's, you may
/// experience an 11-bit filter match against a 29-bit frame and vice
/// versa. Your application should check the id again once a frame has
/// been received to make sure it is the expected value.
///
/// You may use a `const {}` block to ensure that the filter is parsed
/// during program compilation.
///
/// The filter is not applied to the peripheral until [`Self::start`] is
/// called.
///
/// [ESP32C3 Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf#subsubsection.29.4.6)
pub fn set_filter(&mut self, filter: impl Filter) {
// Convert the filter into values for the registers and store them for later
// use.
self.filter = Some((filter.filter_type(), filter.to_registers()));
}
fn apply_filter(&self) {
let Some((filter_type, registers)) = self.filter.as_ref() else {
return;
};
// Set or clear the rx filter mode bit depending on the filter type.
self.regs()
.mode()
.modify(|_, w| w.rx_filter_mode().bit(*filter_type == FilterType::Single));
// Copy the filter to the peripheral.
unsafe {
copy_to_data_register(self.regs().data_0().as_ptr(), registers);
}
}
/// Set the error warning threshold.
///
/// In the case when any of an error counter value exceeds the threshold, or
/// all the error counter values are below the threshold, an error
/// warning interrupt will be triggered (given the enable signal is
/// valid).
pub fn set_error_warning_limit(&mut self, limit: u8) {
self.regs()
.err_warning_limit()
.write(|w| unsafe { w.err_warning_limit().bits(limit) });
}
/// Set the operating mode based on provided option
fn set_mode(&self, mode: TwaiMode) {
self.regs().mode().modify(|_, w| {
// self-test mode turns off acknowledgement requirement
w.self_test_mode().bit(mode == TwaiMode::SelfTest);
w.listen_only_mode().bit(mode == TwaiMode::ListenOnly)
});
}
/// Put the peripheral into Operation Mode, allowing the transmission and
/// reception of packets using the new object.
pub fn start(self) -> Twai<'d, Dm> {
self.apply_filter();
self.set_mode(self.mode);
// Clear the TEC and REC
self.regs()
.tx_err_cnt()
.write(|w| unsafe { w.tx_err_cnt().bits(0) });
let rec =
if cfg!(any(esp32, esp32s2, esp32s3, esp32c3)) && self.mode == TwaiMode::ListenOnly {
// Errata workaround: Prevent transmission of dominant error frame while in
// listen only mode by setting REC to 128 before exiting reset mode.
// This forces the controller to be error passive (thus only transmits recessive
// bits). The TEC/REC remain frozen in listen only mode thus
// ensuring we remain error passive.
128
} else {
0
};
self.regs()
.rx_err_cnt()
.write(|w| unsafe { w.rx_err_cnt().bits(rec) });
// Clear any interrupts by reading the status register
cfg_if::cfg_if! {
if #[cfg(any(esp32, esp32c3, esp32s2, esp32s3))] {
let _ = self.regs().int_raw().read();
} else {
let _ = self.regs().interrupt().read();
}
}
// Put the peripheral into operation mode by clearing the reset mode bit.
self.regs().mode().modify(|_, w| w.reset_mode().clear_bit());
Twai {
rx: TwaiRx {
twai: unsafe { self.twai.clone_unchecked() },
phantom: PhantomData,
_guard: PeripheralGuard::new(self.twai.peripheral()),
},
tx: TwaiTx {
twai: unsafe { self.twai.clone_unchecked() },
phantom: PhantomData,
_guard: PeripheralGuard::new(self.twai.peripheral()),
},
twai: unsafe { self.twai.clone_unchecked() },
phantom: PhantomData,
}
}
}
impl<'d> TwaiConfiguration<'d, Blocking> {
/// Create a new instance of [TwaiConfiguration]
///
/// You will need to use a transceiver to connect to the TWAI bus
pub fn new<RX: PeripheralInput, TX: PeripheralOutput>(
peripheral: impl Peripheral<P = impl Instance> + 'd,
rx_pin: impl Peripheral<P = RX> + 'd,
tx_pin: impl Peripheral<P = TX> + 'd,
baud_rate: BaudRate,
mode: TwaiMode,
) -> Self {
crate::into_mapped_ref!(peripheral);
Self::new_internal(peripheral, rx_pin, tx_pin, baud_rate, false, mode)
}
/// Create a new instance of [TwaiConfiguration] meant to connect two ESP32s
/// directly
///
/// You don't need a transceiver by following the description in the
/// `twai.rs` example
pub fn new_no_transceiver<RX: PeripheralInput, TX: PeripheralOutput>(
peripheral: impl Peripheral<P = impl Instance> + 'd,
rx_pin: impl Peripheral<P = RX> + 'd,
tx_pin: impl Peripheral<P = TX> + 'd,
baud_rate: BaudRate,
mode: TwaiMode,
) -> Self {
crate::into_mapped_ref!(peripheral);
Self::new_internal(peripheral, rx_pin, tx_pin, baud_rate, true, mode)
}
/// Convert the configuration into an async configuration.
pub fn into_async(mut self) -> TwaiConfiguration<'d, Async> {
self.set_interrupt_handler(self.twai.async_handler());
TwaiConfiguration {
twai: self.twai,
filter: self.filter,
phantom: PhantomData,
mode: self.mode,
_guard: self._guard,
}
}
/// Registers an interrupt handler for the TWAI peripheral.
///
/// Note that this will replace any previously registered interrupt
/// handlers.
#[instability::unstable]
pub fn set_interrupt_handler(&mut self, handler: crate::interrupt::InterruptHandler) {
self.internal_set_interrupt_handler(handler);
}
}
impl<'d> TwaiConfiguration<'d, Async> {
/// Convert the configuration into a blocking configuration.
pub fn into_blocking(self) -> TwaiConfiguration<'d, Blocking> {
use crate::{interrupt, system::Cpu};
interrupt::disable(Cpu::current(), self.twai.interrupt());
// Re-create in blocking mode
TwaiConfiguration {
twai: self.twai,
filter: self.filter,
phantom: PhantomData,
mode: self.mode,
_guard: self._guard,
}
}
}
impl crate::private::Sealed for TwaiConfiguration<'_, Blocking> {}
#[instability::unstable]
impl crate::interrupt::InterruptConfigurable for TwaiConfiguration<'_, Blocking> {
fn set_interrupt_handler(&mut self, handler: crate::interrupt::InterruptHandler) {
self.internal_set_interrupt_handler(handler);
}
}
/// An active TWAI peripheral in Normal Mode.
///
/// In this mode, the TWAI controller can transmit and receive messages
/// including error signals (such as error and overload frames).
pub struct Twai<'d, Dm: DriverMode> {
twai: PeripheralRef<'d, AnyTwai>,
tx: TwaiTx<'d, Dm>,
rx: TwaiRx<'d, Dm>,
phantom: PhantomData<Dm>,
}
impl<'d, Dm> Twai<'d, Dm>
where
Dm: DriverMode,
{
fn regs(&self) -> &RegisterBlock {
self.twai.register_block()
}
fn mode(&self) -> TwaiMode {
let mode = self.regs().mode().read();
if mode.self_test_mode().bit_is_set() {
TwaiMode::SelfTest
} else if mode.listen_only_mode().bit_is_set() {
TwaiMode::ListenOnly
} else {
TwaiMode::Normal
}
}
/// Stop the peripheral, putting it into reset mode and enabling
/// reconfiguration.
pub fn stop(self) -> TwaiConfiguration<'d, Dm> {
// Put the peripheral into reset/configuration mode by setting the reset mode
// bit.
self.regs().mode().modify(|_, w| w.reset_mode().set_bit());
let mode = self.mode();
let guard = PeripheralGuard::new(self.twai.peripheral());
TwaiConfiguration {
twai: self.twai,
filter: None, // filter already applied, no need to restore it
phantom: PhantomData,
mode,
_guard: guard,
}
}
/// Returns the value of the receive error counter.
pub fn receive_error_count(&self) -> u8 {
self.regs().rx_err_cnt().read().rx_err_cnt().bits()
}
/// Returns the value of the transmit error counter.
pub fn transmit_error_count(&self) -> u8 {
self.regs().tx_err_cnt().read().tx_err_cnt().bits()
}
/// Check if the controller is in a bus off state.
pub fn is_bus_off(&self) -> bool {
self.regs().status().read().bus_off_st().bit_is_set()
}
/// Get the number of messages that the peripheral has available in the
/// receive FIFO.
///
/// Note that this may not be the number of valid messages in the receive
/// FIFO due to fifo overflow/overrun.
pub fn num_available_messages(&self) -> u8 {
self.regs()
.rx_message_cnt()
.read()
.rx_message_counter()
.bits()
}
/// Clear the receive FIFO, discarding any valid, partial, or invalid
/// packets.
///
/// This is typically used to clear an overrun receive FIFO.
///
/// TODO: Not sure if this needs to be guarded against Bus Off or other
/// error states.
pub fn clear_receive_fifo(&self) {
while self.num_available_messages() > 0 {
release_receive_fifo(self.regs());
}
}
/// Sends the specified `EspTwaiFrame` over the TWAI bus.
pub fn transmit(&mut self, frame: &EspTwaiFrame) -> nb::Result<(), EspTwaiError> {
self.tx.transmit(frame)
}
/// Receives a TWAI frame from the TWAI bus.
pub fn receive(&mut self) -> nb::Result<EspTwaiFrame, EspTwaiError> {
self.rx.receive()
}
/// Consumes this `Twai` instance and splits it into transmitting and
/// receiving halves.
pub fn split(self) -> (TwaiRx<'d, Dm>, TwaiTx<'d, Dm>) {
(self.rx, self.tx)
}
}
/// Interface to the TWAI transmitter part.
pub struct TwaiTx<'d, Dm: DriverMode> {
twai: PeripheralRef<'d, AnyTwai>,
phantom: PhantomData<Dm>,
_guard: PeripheralGuard,
}
impl<Dm> TwaiTx<'_, Dm>
where
Dm: DriverMode,
{
fn regs(&self) -> &RegisterBlock {
self.twai.register_block()
}
/// Transmit a frame.
///
/// Because of how the TWAI registers are set up, we have to do some
/// assembly of bytes. Note that these registers serve a filter
/// configuration role when the device is in configuration mode so
/// patching the svd files to improve this may be non-trivial.
///
/// [ESP32C3 Reference Manual](https://www.espressif.com/sites/default/files/documentation/esp32-c3_technical_reference_manual_en.pdf#subsubsection.29.4.4.2)
///
/// NOTE: TODO: This may not work if using the self reception/self test
/// functionality. See notes 1 and 2 in the "Frame Identifier" section
/// of the reference manual.
pub fn transmit(&mut self, frame: &EspTwaiFrame) -> nb::Result<(), EspTwaiError> {
let status = self.regs().status().read();
// Check that the peripheral is not in a bus off state.
if status.bus_off_st().bit_is_set() {
return nb::Result::Err(nb::Error::Other(EspTwaiError::BusOff));
}
// Check that the peripheral is not already transmitting a packet.
if !status.tx_buf_st().bit_is_set() {
return nb::Result::Err(nb::Error::WouldBlock);
}
write_frame(self.regs(), frame);
Ok(())
}
}
/// Interface to the TWAI receiver part.
pub struct TwaiRx<'d, Dm: DriverMode> {
twai: PeripheralRef<'d, AnyTwai>,
phantom: PhantomData<Dm>,
_guard: PeripheralGuard,
}
impl<Dm> TwaiRx<'_, Dm>
where
Dm: DriverMode,
{
fn regs(&self) -> &RegisterBlock {
self.twai.register_block()
}
/// Receive a frame
pub fn receive(&mut self) -> nb::Result<EspTwaiFrame, EspTwaiError> {
let status = self.regs().status().read();
// Check that the peripheral is not in a bus off state.
if status.bus_off_st().bit_is_set() {
return nb::Result::Err(nb::Error::Other(EspTwaiError::BusOff));
}
// Check that we actually have packets to receive.
if !status.rx_buf_st().bit_is_set() {
return nb::Result::Err(nb::Error::WouldBlock);
}
// Check if the packet in the receive buffer is valid or overrun.
if status.miss_st().bit_is_set() {
return nb::Result::Err(nb::Error::Other(EspTwaiError::EmbeddedHAL(
ErrorKind::Overrun,
)));
}
Ok(read_frame(self.regs())?)
}
}
/// Represents errors that can occur in the TWAI driver.
/// This enum defines the possible errors that can be encountered when
/// interacting with the TWAI peripheral.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum EspTwaiError {
/// TWAI peripheral has entered a bus-off state.
BusOff,
/// The received frame contains an invalid DLC.
NonCompliantDlc(u8),
/// Encapsulates errors defined by the embedded-hal crate.
EmbeddedHAL(ErrorKind),
}
#[instability::unstable]
impl embedded_can::Error for EspTwaiError {
fn kind(&self) -> embedded_can::ErrorKind {
if let Self::EmbeddedHAL(kind) = self {
(*kind).into()
} else {
embedded_can::ErrorKind::Other
}
}
}
/// Copy data from multiple TWAI_DATA_x_REG registers, packing the source into
/// the destination.
///
/// # Safety
/// This function is marked unsafe because it reads arbitrarily from
/// memory-mapped registers. Specifically, this function is used with the
/// TWAI_DATA_x_REG registers which has different results based on the mode of
/// the peripheral.
#[inline(always)]
unsafe fn copy_from_data_register(dest: &mut [u8], src: *const u32) {
for (i, dest) in dest.iter_mut().enumerate() {
// Perform a volatile read to avoid compiler optimizations.
*dest = src.add(i).read_volatile() as u8;
}
}
/// Copy data to multiple TWAI_DATA_x_REG registers, unpacking the source into
/// the destination.
///
/// # Safety
/// This function is marked unsafe because it writes arbitrarily to
/// memory-mapped registers. Specifically, this function is used with the
/// TWAI_DATA_x_REG registers which has different results based on the mode of
/// the peripheral.
#[inline(always)]
unsafe fn copy_to_data_register(dest: *mut u32, src: &[u8]) {
for (i, src) in src.iter().enumerate() {
// Perform a volatile write to avoid compiler optimizations.
dest.add(i).write_volatile(*src as u32);
}
}
#[instability::unstable]
impl<Dm> embedded_can::nb::Can for Twai<'_, Dm>
where
Dm: DriverMode,
{
type Frame = EspTwaiFrame;
type Error = EspTwaiError;
/// Transmit a frame.
fn transmit(&mut self, frame: &Self::Frame) -> nb::Result<Option<Self::Frame>, Self::Error> {
self.tx.transmit(frame)?;
// Success in readying packet for transmit. No packets can be replaced in the
// transmit buffer so return None in accordance with the
// embedded-can/embedded-hal trait.
nb::Result::Ok(None)
}
/// Return a received frame if there are any available.
fn receive(&mut self) -> nb::Result<Self::Frame, Self::Error> {
self.rx.receive()
}
}
/// TWAI peripheral instance.
#[doc(hidden)]
pub trait Instance: Peripheral<P = Self> + Into<AnyTwai> + 'static {
/// The identifier number for this TWAI instance.
fn number(&self) -> usize;
/// Returns the system peripheral marker for this instance.
fn peripheral(&self) -> crate::system::Peripheral;
/// Input signal.
fn input_signal(&self) -> InputSignal;
/// Output signal.
fn output_signal(&self) -> OutputSignal;
/// The interrupt associated with this TWAI instance.
fn interrupt(&self) -> crate::peripherals::Interrupt;
/// Provides an asynchronous interrupt handler for TWAI instance.
fn async_handler(&self) -> InterruptHandler;
/// Returns a reference to the register block for TWAI instance.
fn register_block(&self) -> &RegisterBlock;
/// Enables interrupts for the TWAI peripheral.
fn enable_interrupts(&self) {
cfg_if::cfg_if! {
if #[cfg(any(esp32, esp32c3, esp32s2, esp32s3))] {
self.register_block().int_ena().modify(|_, w| {
w.rx_int_ena().set_bit();
w.tx_int_ena().set_bit();
w.bus_err_int_ena().set_bit();
w.arb_lost_int_ena().set_bit();
w.err_passive_int_ena().set_bit()
});
} else {
self.register_block().interrupt_enable().modify(|_, w| {
w.ext_receive_int_ena().set_bit();
w.ext_transmit_int_ena().set_bit();
w.bus_err_int_ena().set_bit();
w.arbitration_lost_int_ena().set_bit();
w.err_passive_int_ena().set_bit()
});
}
}
}
/// Returns a reference to the asynchronous state for this TWAI instance.
fn async_state(&self) -> &asynch::TwaiAsyncState;
}
/// Read a frame from the peripheral.
fn read_frame(register_block: &RegisterBlock) -> Result<EspTwaiFrame, EspTwaiError> {
// Read the frame information and extract the frame id format and dlc.
let data_0 = register_block.data_0().read().tx_byte_0().bits();
let is_standard_format = data_0 & (0b1 << 7) == 0;
let is_data_frame = data_0 & (0b1 << 6) == 0;
let self_reception = data_0 & (0b1 << 4) != 0;
let dlc = data_0 & 0b1111;
if dlc > 8 {
// Release the packet we read from the FIFO, allowing the peripheral to prepare
// the next packet.
release_receive_fifo(register_block);
return Err(EspTwaiError::NonCompliantDlc(dlc));
}
let dlc = dlc as usize;
// Read the payload from the packet and construct a frame.
let (id, data_ptr) = if is_standard_format {
// Frame uses standard 11 bit id.
let data_1 = register_block.data_1().read().tx_byte_1().bits();
let data_2 = register_block.data_2().read().tx_byte_2().bits();
let raw_id: u16 = ((data_1 as u16) << 3) | ((data_2 as u16) >> 5);
let id = Id::from(StandardId::new(raw_id).unwrap());
(id, register_block.data_3().as_ptr())
} else {
// Frame uses extended 29 bit id.
let data_1 = register_block.data_1().read().tx_byte_1().bits();
let data_2 = register_block.data_2().read().tx_byte_2().bits();
let data_3 = register_block.data_3().read().tx_byte_3().bits();
let data_4 = register_block.data_4().read().tx_byte_4().bits();
let raw_id: u32 = ((data_1 as u32) << 21)
| ((data_2 as u32) << 13)
| ((data_3 as u32) << 5)
| ((data_4 as u32) >> 3);
let id = Id::from(ExtendedId::new(raw_id).unwrap());
(id, register_block.data_5().as_ptr())
};
let mut frame = if is_data_frame {
unsafe { EspTwaiFrame::new_from_data_registers(id, data_ptr, dlc) }
} else {
EspTwaiFrame::new_remote(id, dlc).unwrap()
};
frame.self_reception = self_reception;
// Release the packet we read from the FIFO, allowing the peripheral to prepare
// the next packet.
release_receive_fifo(register_block);
Ok(frame)
}
/// Release the message in the buffer. This will decrement the received
/// message counter and prepare the next message in the FIFO for
/// reading.
fn release_receive_fifo(register_block: &RegisterBlock) {
register_block.cmd().write(|w| w.release_buf().set_bit());
}
/// Write a frame to the peripheral.
fn write_frame(register_block: &RegisterBlock, frame: &EspTwaiFrame) {
// Assemble the frame information into the data_0 byte.
let frame_format: u8 = matches!(frame.id, Id::Extended(_)) as u8;
let self_reception: u8 = frame.self_reception as u8;
let rtr_bit: u8 = frame.is_remote as u8;
let dlc_bits: u8 = frame.dlc as u8 & 0b1111;
let data_0: u8 = (frame_format << 7) | (rtr_bit << 6) | (self_reception << 4) | dlc_bits;
register_block
.data_0()
.write(|w| unsafe { w.tx_byte_0().bits(data_0) });
// Assemble the identifier information of the packet and return where the data
// buffer starts.
let data_ptr = match frame.id {
Id::Standard(id) => {
let id = id.as_raw();
register_block
.data_1()
.write(|w| unsafe { w.tx_byte_1().bits((id >> 3) as u8) });
register_block
.data_2()
.write(|w| unsafe { w.tx_byte_2().bits((id << 5) as u8) });
register_block.data_3().as_ptr()
}
Id::Extended(id) => {
let id = id.as_raw();
register_block
.data_1()
.write(|w| unsafe { w.tx_byte_1().bits((id >> 21) as u8) });
register_block
.data_2()
.write(|w| unsafe { w.tx_byte_2().bits((id >> 13) as u8) });
register_block
.data_3()
.write(|w| unsafe { w.tx_byte_3().bits((id >> 5) as u8) });
register_block
.data_4()
.write(|w| unsafe { w.tx_byte_4().bits((id << 3) as u8) });
register_block.data_5().as_ptr()
}
};
// Store the data portion of the packet into the transmit buffer.
unsafe {
copy_to_data_register(
data_ptr,
match frame.is_remote {
true => &[], // RTR frame, so no data is included.
false => &frame.data[0..frame.dlc],
},
)
}
// Trigger the appropriate transmission request based on self_reception flag
if frame.self_reception {
register_block.cmd().write(|w| w.self_rx_req().set_bit());
} else {
// Set the transmit request command, this will lock the transmit buffer until
// the transmission is complete or aborted.
register_block.cmd().write(|w| w.tx_req().set_bit());
}
}
impl Instance for crate::peripherals::TWAI0 {
fn number(&self) -> usize {
0
}
fn peripheral(&self) -> crate::system::Peripheral {
crate::system::Peripheral::Twai0
}
fn input_signal(&self) -> InputSignal {
cfg_if::cfg_if! {
if #[cfg(any(esp32, esp32c3, esp32s2, esp32s3))] {
InputSignal::TWAI_RX
} else {
InputSignal::TWAI0_RX
}
}
}
fn output_signal(&self) -> OutputSignal {
cfg_if::cfg_if! {
if #[cfg(any(esp32, esp32c3, esp32s2, esp32s3))] {
OutputSignal::TWAI_TX
} else {
OutputSignal::TWAI0_TX
}
}
}
fn interrupt(&self) -> crate::peripherals::Interrupt {
crate::peripherals::Interrupt::TWAI0
}
fn async_handler(&self) -> InterruptHandler {
asynch::twai0
}
#[inline(always)]
fn register_block(&self) -> &RegisterBlock {
crate::peripherals::TWAI0::regs()
}
fn async_state(&self) -> &asynch::TwaiAsyncState {
static STATE: asynch::TwaiAsyncState = asynch::TwaiAsyncState::new();
&STATE
}
}
#[cfg(twai1)]
impl Instance for crate::peripherals::TWAI1 {
fn number(&self) -> usize {
1
}
fn peripheral(&self) -> crate::system::Peripheral {
crate::system::Peripheral::Twai1
}
fn input_signal(&self) -> InputSignal {
InputSignal::TWAI1_RX
}
fn output_signal(&self) -> OutputSignal {
OutputSignal::TWAI1_TX
}
fn interrupt(&self) -> crate::peripherals::Interrupt {
crate::peripherals::Interrupt::TWAI1
}
fn async_handler(&self) -> InterruptHandler {
asynch::twai1
}
#[inline(always)]
fn register_block(&self) -> &RegisterBlock {
crate::peripherals::TWAI1::regs()
}
fn async_state(&self) -> &asynch::TwaiAsyncState {
static STATE: asynch::TwaiAsyncState = asynch::TwaiAsyncState::new();
&STATE
}
}
crate::any_peripheral! {
/// Any TWAI peripheral.
pub peripheral AnyTwai {
#[cfg(twai0)]
Twai0(crate::peripherals::TWAI0),
#[cfg(twai1)]
Twai1(crate::peripherals::TWAI1),
}
}
impl Instance for AnyTwai {
delegate::delegate! {
to match &self.0 {
#[cfg(twai0)]
AnyTwaiInner::Twai0(twai) => twai,
#[cfg(twai1)]
AnyTwaiInner::Twai1(twai) => twai,
} {
fn number(&self) -> usize;
fn peripheral(&self) -> crate::system::Peripheral;
fn input_signal(&self) -> InputSignal;
fn output_signal(&self) -> OutputSignal;
fn interrupt(&self) -> crate::peripherals::Interrupt;
fn async_handler(&self) -> InterruptHandler;
fn register_block(&self) -> &RegisterBlock;
fn async_state(&self) -> &asynch::TwaiAsyncState;
}
}
}
mod asynch {
use core::{future::poll_fn, task::Poll};
use embassy_sync::{
blocking_mutex::raw::CriticalSectionRawMutex,
channel::Channel,
waitqueue::AtomicWaker,
};
use procmacros::handler;
use super::*;
use crate::peripherals::TWAI0;
#[cfg(twai1)]
use crate::peripherals::TWAI1;
pub struct TwaiAsyncState {
pub tx_waker: AtomicWaker,
pub err_waker: AtomicWaker,
pub rx_queue: Channel<CriticalSectionRawMutex, Result<EspTwaiFrame, EspTwaiError>, 32>,
}
impl Default for TwaiAsyncState {
fn default() -> Self {
Self::new()
}
}
impl TwaiAsyncState {
pub const fn new() -> Self {
Self {
tx_waker: AtomicWaker::new(),
err_waker: AtomicWaker::new(),
rx_queue: Channel::new(),
}
}
}
impl Twai<'_, Async> {
/// Transmits an `EspTwaiFrame` asynchronously over the TWAI bus.
///
/// The transmission is aborted if the future is dropped. The technical
/// reference manual does not specifiy if aborting the transmission also
/// stops it, in case it is activly transmitting. Therefor it could be
/// the case that even though the future is dropped, the frame was sent
/// anyways.
pub async fn transmit_async(&mut self, frame: &EspTwaiFrame) -> Result<(), EspTwaiError> {
self.tx.transmit_async(frame).await
}
/// Receives an `EspTwaiFrame` asynchronously over the TWAI bus.
pub async fn receive_async(&mut self) -> Result<EspTwaiFrame, EspTwaiError> {
self.rx.receive_async().await
}
}
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct TransmitFuture<'d, 'f> {
twai: PeripheralRef<'d, AnyTwai>,
frame: &'f EspTwaiFrame,
in_flight: bool,
}
impl<'d, 'f> TransmitFuture<'d, 'f> {
pub fn new(twai: impl Peripheral<P = AnyTwai> + 'd, frame: &'f EspTwaiFrame) -> Self {
crate::into_ref!(twai);
Self {
twai,
frame,
in_flight: false,
}
}
}
impl core::future::Future for TransmitFuture<'_, '_> {
type Output = Result<(), EspTwaiError>;
fn poll(
mut self: core::pin::Pin<&mut Self>,
cx: &mut core::task::Context<'_>,
) -> Poll<Self::Output> {
self.twai.async_state().tx_waker.register(cx.waker());
let regs = self.twai.register_block();
let status = regs.status().read();
// Check that the peripheral is not in a bus off state.
if status.bus_off_st().bit_is_set() {
return Poll::Ready(Err(EspTwaiError::BusOff));
}
// Check that the peripheral is not currently transmitting a packet.
if !status.tx_buf_st().bit_is_set() {
return Poll::Pending;
}
if !self.in_flight {
write_frame(regs, self.frame);
self.in_flight = true;
return Poll::Pending;
}
Poll::Ready(Ok(()))
}
}
impl Drop for TransmitFuture<'_, '_> {
fn drop(&mut self) {
self.twai
.register_block()
.cmd()
.write(|w| w.abort_tx().set_bit());
}
}
impl TwaiTx<'_, Async> {
/// Transmits an `EspTwaiFrame` asynchronously over the TWAI bus.
///
/// The transmission is aborted if the future is dropped. The technical
/// reference manual does not specifiy if aborting the transmission also
/// stops it, in case it is activly transmitting. Therefor it could be
/// the case that even though the future is dropped, the frame was sent
/// anyways.
pub async fn transmit_async(&mut self, frame: &EspTwaiFrame) -> Result<(), EspTwaiError> {
self.twai.enable_interrupts();
TransmitFuture::new(self.twai.reborrow(), frame).await
}
}
impl TwaiRx<'_, Async> {
/// Receives an `EspTwaiFrame` asynchronously over the TWAI bus.
pub async fn receive_async(&mut self) -> Result<EspTwaiFrame, EspTwaiError> {
self.twai.enable_interrupts();
poll_fn(|cx| {
self.twai.async_state().err_waker.register(cx.waker());
if let Poll::Ready(result) = self.twai.async_state().rx_queue.poll_receive(cx) {
return Poll::Ready(result);
}
let status = self.regs().status().read();
// Check that the peripheral is not in a bus off state.
if status.bus_off_st().bit_is_set() {
return Poll::Ready(Err(EspTwaiError::BusOff));
}
// Check if the packet in the receive buffer is valid or overrun.
if status.miss_st().bit_is_set() {
return Poll::Ready(Err(EspTwaiError::EmbeddedHAL(ErrorKind::Overrun)));
}
Poll::Pending
})
.await
}
}
fn handle_interrupt(register_block: &RegisterBlock, async_state: &TwaiAsyncState) {
cfg_if::cfg_if! {
if #[cfg(any(esp32, esp32c3, esp32s2, esp32s3))] {
let intr_enable = register_block.int_ena().read();
let intr_status = register_block.int_raw().read();
let int_ena_reg = register_block.int_ena();
let tx_int_status = intr_status.tx_int_st();
let rx_int_status = intr_status.rx_int_st();
} else {
let intr_enable = register_block.interrupt_enable().read();
let intr_status = register_block.interrupt().read();
let int_ena_reg = register_block.interrupt_enable();
let tx_int_status = intr_status.transmit_int_st();
let rx_int_status = intr_status.receive_int_st();
}
}
if tx_int_status.bit_is_set() {
async_state.tx_waker.wake();
}
if rx_int_status.bit_is_set() {
let status = register_block.status().read();
let rx_queue = &async_state.rx_queue;
if status.bus_off_st().bit_is_set() {
let _ = rx_queue.try_send(Err(EspTwaiError::BusOff));
}
if status.miss_st().bit_is_set() {
let _ = rx_queue.try_send(Err(EspTwaiError::EmbeddedHAL(ErrorKind::Overrun)));
}
match read_frame(register_block) {
Ok(frame) => {
let _ = rx_queue.try_send(Ok(frame));
}
Err(e) => warn!("Error reading frame: {:?}", e),
}
}
if intr_status.bits() & 0b11111100 > 0 {
let err_capture = register_block.err_code_cap().read();
let status = register_block.status().read();
// Read error code direction (transmitting or receiving)
let ecc_direction = err_capture.ecc_direction().bit_is_set();
// If the error comes from Tx and Tx request is pending
if !ecc_direction && !status.tx_buf_st().bit_is_set() {
// Cancel a pending transmission request
register_block.cmd().write(|w| w.abort_tx().set_bit());
}
async_state.err_waker.wake();
}
// Clear interrupt request bits
unsafe {
int_ena_reg.modify(|_, w| w.bits(intr_enable.bits() & (!intr_status.bits() | 1)));
}
}
#[handler]
pub(super) fn twai0() {
let twai = unsafe { TWAI0::steal() };
handle_interrupt(twai.register_block(), twai.async_state());
}
#[cfg(twai1)]
#[handler]
pub(super) fn twai1() {
let twai = unsafe { TWAI1::steal() };
handle_interrupt(twai.register_block(), twai.async_state());
}
}