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
//! # Serial
//!
//! Asynchronous serial communication using the interal USART peripherals
//!
//! The serial modules implement the [`Read`] and [`Write`] traits.
//!
//! [`Read`]: embedded_hal::serial::Read
//! [`Write`]: embedded_hal::serial::Write
use core::{
convert::{Infallible, TryFrom},
fmt,
ops::Deref,
};
use crate::{
gpio::{gpioa, gpiob, gpioc, AF7},
hal::{blocking, serial, serial::Write},
pac::{
rcc::cfgr3::USART1SW_A,
usart1::{cr1::M_A, cr1::PCE_A, cr1::PS_A, RegisterBlock},
Interrupt, USART1, USART2, USART3,
},
rcc::{self, Clocks},
time::fixed_point::FixedPoint,
time::rate::{Baud, Hertz},
Switch,
};
#[allow(unused_imports)]
use crate::pac::RCC;
use cfg_if::cfg_if;
#[cfg(feature = "enumset")]
use enumset::{EnumSet, EnumSetType};
use crate::dma;
/// Interrupt and status events.
///
/// All events can be cleared by [`Serial::clear_event`] or [`Serial::clear_events`].
/// Some events are also cleared on other conditions.
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[cfg_attr(feature = "enumset", derive(EnumSetType))]
#[cfg_attr(not(feature = "enumset"), derive(Copy, Clone, PartialEq, Eq))]
#[non_exhaustive]
// TODO: Split up in transmission and reception events (RM0316 29.7)
pub enum Event {
/// Transmit data register empty / new data can be sent.
///
/// This event is set by hardware when the content of the TDR register has been transferred
/// into the shift register. It is cleared by [`Serial`]s [`serial::Write::write()`]
/// implementation to the TDR register.
#[doc(alias = "TXE")]
TransmitDataRegisterEmtpy,
/// CTS (Clear to Send) event.
///
/// This event is set by hardware when the CTS input toggles, if the CTSE bit is set.
#[doc(alias = "CTSIF")]
CtsInterrupt,
/// Transmission complete
///
/// This event is set by hardware if the transmission of a frame containing data is complete and
/// if TXE is set.
/// It is cleared by [`Serial`]s [`serial::Write::write()`] implementaiton to the USART_TDR register.
#[doc(alias = "TC")]
TransmissionComplete,
/// Read data register not empty / new data has been received.
///
/// This event is set by hardware when the content of the RDR shift register has been
/// transferred to the RDR register.
/// It is cleared by [`Serial`]s [`serial::Read::read()`] to the USART_RDR register.
#[doc(alias = "RXNE")]
ReceiveDataRegisterNotEmpty,
/// Overrun Error detected.
///
/// This event is set by hardware when the data currently being received in the shift register
/// is ready to be transferred into the RDR register while
/// [`Event::ReceiveDataRegisterNotEmpty`] is set.
///
/// See [`Error::Overrun`] for a more detailed description.
#[doc(alias = "ORE")]
OverrunError,
/// Idle line state detected.
///
/// This event is set by hardware when an Idle Line is detected.
Idle,
/// Parity error detected.
///
/// This event is set by hardware when a parity error occurs in receiver mode.
///
/// Parity can be configured by using [`config::Parity`] to create a [`config::Config`].
#[doc(alias = "PE")]
ParityError,
/// Noise error detected.
///
/// This event is set by hardware when noise is detected on a received frame.
#[doc(alias = "NF")]
NoiseError,
/// Framing error detected
///
/// This event is set by hardware when a de-synchronization, excessive noise or a break character
/// is detected.
#[doc(alias = "FE")]
FramingError,
/// LIN break
///
/// This bit is set by hardware when the LIN break is detected.
#[doc(alias = "LBDF")]
LinBreak,
/// The received character matched the configured character.
///
/// The matching character can be configured with [`Serial::match_character()`]
#[doc(alias = "CMF")]
CharacterMatch,
/// Nothing was received since the last received character for
/// [`Serial::receiver_timeout()`] amount of time.
///
/// # Note
///
/// Never set for UART peripheral, which does not have [`ReceiverTimeoutExt`]
/// implemented.
#[doc(alias = "RTOF")]
ReceiverTimeout,
// TODO(Sh3Rm4n): SmartCard Mode not implemented, no use as of now.
// EndOfBlock,
// TODO(Sh3Rm4n): The wakeup from stop mode is alittle bit more complicated:
// - UESM has to be enabled so that it works (RM0316 29.8.1)
// - Only works with LSI and HSI (which are not configurable yet)
// - ...
// /// The peripheral was woken up from "Stop Mode".
// ///
// /// This event is set by hardware, when a wakeup event is detected.
// ///
// /// The condition, when it does wake up can be configured via
// /// [`Serial::set_wakeup_from_stopmode_reason()`]
// #[doc(alias = "WUF")]
// WakeupFromStopMode,
}
/// Serial error
///
/// As these are status events, they can be converted to [`Event`]s, via [`Into`].
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[non_exhaustive]
pub enum Error {
/// Framing error
///
/// This error is thrown by hardware when a de-synchronization, excessive noise or a break
/// character is detected.
Framing,
/// Noise error
///
/// This error is thrown by hardware when noise is detected on a received frame.
Noise,
/// RX buffer overrun
///
/// # Cause
///
/// An overrun error occurs when a character is received when RXNE has not been reset. Data can
/// not be transferred from the shift register to the RDR register until the RXNE bit is
/// cleared. The RXNE flag is set after every byte received. An overrun error occurs if RXNE
/// flag is set when the next data is received or the previous DMA request has not been
/// serviced.
///
/// # Behavior
///
/// - The RDR content will not be lost. The previous data is available when a read to USART_RDR
/// is performed.
/// - The shift register will be overwritten. After that point, any data received
/// during overrun is lost
Overrun,
/// Parity check error
///
/// This error is thrown by hardware when a parity error occurs in receiver mode.
Parity,
}
impl From<Error> for Event {
fn from(error: Error) -> Self {
match error {
Error::Framing => Event::FramingError,
Error::Overrun => Event::OverrunError,
Error::Noise => Event::NoiseError,
Error::Parity => Event::ParityError,
}
}
}
/// The error type returned when a [`Event`] to [`Error`] conversion failed.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TryFromEventError(pub(crate) ());
impl TryFrom<Event> for Error {
type Error = TryFromEventError;
fn try_from(event: Event) -> Result<Self, Self::Error> {
Ok(match event {
Event::FramingError => Error::Framing,
Event::OverrunError => Error::Overrun,
Event::NoiseError => Error::Noise,
Event::ParityError => Error::Parity,
_ => return Err(TryFromEventError(())),
})
}
}
/// An convinicnce enum for the most typical baud rates
#[derive(Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum BaudTable {
Bd1200,
Bd9600,
Bd19200,
Bd38400,
Bd57600,
Bd115200,
Bd230400,
Bd460800,
}
impl From<BaudTable> for Baud {
fn from(baud: BaudTable) -> Self {
match baud {
BaudTable::Bd1200 => Baud(1_200),
BaudTable::Bd9600 => Baud(9_600),
BaudTable::Bd19200 => Baud(19_200),
BaudTable::Bd38400 => Baud(38_400),
BaudTable::Bd57600 => Baud(57_600),
BaudTable::Bd115200 => Baud(115_200),
BaudTable::Bd230400 => Baud(230_400),
BaudTable::Bd460800 => Baud(460_800),
}
}
}
/// The error type returned when a [`Baud`] to [`BaudTable`] conversion failed.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct TryFromBaudError(pub(crate) ());
impl TryFrom<Baud> for BaudTable {
type Error = TryFromBaudError;
fn try_from(baud: Baud) -> Result<Self, Self::Error> {
Ok(match baud {
Baud(1_200) => BaudTable::Bd1200,
Baud(9_600) => BaudTable::Bd9600,
Baud(19_200) => BaudTable::Bd19200,
Baud(38_400) => BaudTable::Bd38400,
Baud(57_600) => BaudTable::Bd57600,
Baud(115_200) => BaudTable::Bd115200,
Baud(230_400) => BaudTable::Bd230400,
Baud(460_800) => BaudTable::Bd460800,
_ => return Err(TryFromBaudError(())),
})
}
}
/// TX pin
pub trait TxPin<Usart>: crate::private::Sealed {}
/// RX pin
pub trait RxPin<Usart>: crate::private::Sealed {}
impl<Otype> TxPin<USART1> for gpioa::PA9<AF7<Otype>> {}
impl<Otype> TxPin<USART1> for gpiob::PB6<AF7<Otype>> {}
impl<Otype> TxPin<USART1> for gpioc::PC4<AF7<Otype>> {}
impl<Otype> RxPin<USART1> for gpioa::PA10<AF7<Otype>> {}
impl<Otype> RxPin<USART1> for gpiob::PB7<AF7<Otype>> {}
impl<Otype> RxPin<USART1> for gpioc::PC5<AF7<Otype>> {}
impl<Otype> TxPin<USART2> for gpioa::PA2<AF7<Otype>> {}
impl<Otype> TxPin<USART2> for gpiob::PB3<AF7<Otype>> {}
impl<Otype> RxPin<USART2> for gpioa::PA3<AF7<Otype>> {}
impl<Otype> RxPin<USART2> for gpiob::PB4<AF7<Otype>> {}
impl<Otype> TxPin<USART3> for gpiob::PB10<AF7<Otype>> {}
impl<Otype> TxPin<USART3> for gpioc::PC10<AF7<Otype>> {}
impl<Otype> RxPin<USART3> for gpioc::PC11<AF7<Otype>> {}
cfg_if! {
if #[cfg(any(feature = "gpio-f303", feature = "gpio-f303e", feature = "gpio-f373"))] {
use crate::gpio::{gpiod, gpioe};
impl<Otype> TxPin<USART1> for gpioe::PE0<AF7<Otype>> {}
impl<Otype> RxPin<USART1> for gpioe::PE1<AF7<Otype>> {}
impl<Otype> TxPin<USART2> for gpiod::PD5<AF7<Otype>> {}
impl<Otype> RxPin<USART2> for gpiod::PD6<AF7<Otype>> {}
impl<Otype> TxPin<USART3> for gpiod::PD8<AF7<Otype>> {}
impl<Otype> RxPin<USART3> for gpiod::PD9<AF7<Otype>> {}
impl<Otype> RxPin<USART3> for gpioe::PE15<AF7<Otype>> {}
}
}
cfg_if! {
if #[cfg(not(feature = "gpio-f373"))] {
impl<Otype> TxPin<USART2> for gpioa::PA14<AF7<Otype>> {}
impl<Otype> RxPin<USART2> for gpioa::PA15<AF7<Otype>> {}
impl<Otype> RxPin<USART3> for gpiob::PB11<AF7<Otype>> {}
}
}
cfg_if! {
if #[cfg(any(feature = "gpio-f303", feature = "gpio-f303e",))] {
use crate::pac::{UART4, UART5};
use crate::gpio::AF5;
impl<Otype> TxPin<UART4> for gpioc::PC10<AF5<Otype>> {}
impl<Otype> RxPin<UART4> for gpioc::PC11<AF5<Otype>> {}
impl<Otype> TxPin<UART5> for gpioc::PC12<AF5<Otype>> {}
impl<Otype> RxPin<UART5> for gpiod::PD2<AF5<Otype>> {}
}
}
pub mod config;
/// Serial abstraction
///
/// This is an abstraction of the UART peripheral intended to be
/// used for standard duplex serial communication.
pub struct Serial<Usart, Pins> {
usart: Usart,
pins: Pins,
}
impl<Usart, Tx, Rx> Serial<Usart, (Tx, Rx)>
where
Usart: Instance,
{
/// Configures a USART peripheral to provide serial communication
///
/// # Panics
///
/// Panics if the configured baud rate is impossible for the hardware to setup.
pub fn new<Config>(
usart: Usart,
pins: (Tx, Rx),
config: Config,
clocks: Clocks,
apb: &mut <Usart as rcc::RccBus>::Bus,
) -> Self
where
Usart: Instance,
Tx: TxPin<Usart>,
Rx: RxPin<Usart>,
Config: Into<config::Config>,
{
use config::Parity;
let config = config.into();
// Enable USART peripheral for any further interaction.
Usart::enable(apb);
Usart::reset(apb);
// Disable USART because some configuration bits could only be written
// in this state.
usart.cr1.modify(|_, w| w.ue().disabled());
let brr = Usart::clock(&clocks).integer() / config.baudrate.integer();
crate::assert!(brr >= 16, "impossible baud rate");
usart.brr.write(|w| {
w.brr().bits(
// SAFETY: safe because of assert before
unsafe { u16::try_from(brr).unwrap_unchecked() },
)
});
// We currently support only eight data bits as supporting a full-blown
// configuration gets complicated pretty fast. The USART counts data
// and partiy bits together so the actual amount depends on the parity
// selection.
let (m0, ps, pce) = match config.parity {
Parity::None => (M_A::Bit8, PS_A::Even, PCE_A::Disabled),
Parity::Even => (M_A::Bit9, PS_A::Even, PCE_A::Enabled),
Parity::Odd => (M_A::Bit9, PS_A::Odd, PCE_A::Enabled),
};
usart
.cr2
.modify(|_, w| w.stop().variant(config.stopbits.into()));
usart.cr1.modify(|_, w| {
w.ps().variant(ps); // set parity mode
w.pce().variant(pce); // enable parity checking/generation
w.m().variant(m0); // set data bits
w.re().enabled(); // enable receiver
w.te().enabled() // enable transmitter
});
// Finally enable the configured UART.
usart.cr1.modify(|_, w| w.ue().enabled());
Self { usart, pins }
}
/// Get access to the underlying register block.
///
/// # Safety
///
/// This function is not _memory_ unsafe per se, but does not guarantee
/// anything about assumptions of invariants made in this implementation.
///
/// Changing specific options can lead to un-expected behavior and nothing
/// is guaranteed.
pub unsafe fn peripheral(&mut self) -> &mut Usart {
&mut self.usart
}
/// Releases the USART peripheral and associated pins
pub fn free(self) -> (Usart, (Tx, Rx)) {
self.usart
.cr1
.modify(|_, w| w.ue().disabled().re().disabled().te().disabled());
(self.usart, self.pins)
}
}
impl<Usart, Pins> Serial<Usart, Pins>
where
Usart: Instance,
{
/// Serial read out of the read register
///
/// No error handling and no additional side-effects, besides the implied
/// side-effects when reading out the RDR register.
/// Handling errors has to be done manually. This can be done, by checking
/// the triggered events via [`Serial::triggered_events`].
///
/// Returns `None` if the hardware is busy.
///
/// ## Embedded HAL
///
/// To have a more managed way to read from the serial use the [`embedded_hal::serial::Read`]
/// trait implementation.
#[doc(alias = "RDR")]
pub fn read_data_register(&self) -> Option<u8> {
if self.usart.isr.read().busy().bit_is_set() {
return None;
}
#[allow(clippy::cast_possible_truncation)]
Some(self.usart.rdr.read().rdr().bits() as u8)
}
/// Check if the USART peripheral is busy.
///
/// This can be useful to block on to synchronize between peripheral and CPU
/// because of the asynchronous nature of the peripheral.
pub fn is_busy(&mut self) -> bool {
self.usart.isr.read().busy().bit_is_set()
}
/// Obtain the associated interrupt number for the serial peripheral.
///
/// Used to unmask / enable the interrupt with [`cortex_m::peripheral::NVIC::unmask()`].
/// This is useful for all `cortex_m::peripheral::INTERRUPT` functions.
///
/// # Note
///
/// This is the easier alternative to obatain the interrupt for:
///
/// ```
/// use cortex_m::peripheral::INTERRUPT;
/// use stm32f3xx_hal::pac::USART1;
/// use stm32f3xx_hal::interrupt::InterruptNumber;
///
/// const INTERRUPT: Interrupt = <USART1 as InterruptNumber>::INTERRUPT;
/// ```
///
/// though this function can not be used in a const context.
#[doc(alias = "unmask")]
pub fn interrupt(&self) -> <Usart as crate::interrupts::InterruptNumber>::Interrupt {
<Usart as crate::interrupts::InterruptNumber>::INTERRUPT
}
/// Enable the interrupt for the specified [`Event`].
#[inline]
pub fn enable_interrupt(&mut self, event: Event) {
self.configure_interrupt(event, Switch::On);
}
/// Disable the interrupt for the specified [`Event`].
#[inline]
pub fn disable_interrupt(&mut self, event: Event) {
self.configure_interrupt(event, Switch::Off);
}
/// Enable or disable the interrupt for the specified [`Event`].
#[inline]
pub fn configure_interrupt(&mut self, event: Event, enable: impl Into<Switch>) {
// Do a round way trip to be convert Into<Switch> -> bool
let enable: Switch = enable.into();
let enable: bool = enable.into();
match event {
Event::TransmitDataRegisterEmtpy => self.usart.cr1.modify(|_, w| w.txeie().bit(enable)),
Event::CtsInterrupt => self.usart.cr3.modify(|_, w| w.ctsie().bit(enable)),
Event::TransmissionComplete => self.usart.cr1.modify(|_, w| w.tcie().bit(enable)),
Event::ReceiveDataRegisterNotEmpty => {
self.usart.cr1.modify(|_, w| w.rxneie().bit(enable));
}
Event::ParityError => self.usart.cr1.modify(|_, w| w.peie().bit(enable)),
Event::LinBreak => self.usart.cr2.modify(|_, w| w.lbdie().bit(enable)),
Event::NoiseError | Event::OverrunError | Event::FramingError => {
self.usart.cr3.modify(|_, w| w.eie().bit(enable));
}
Event::Idle => self.usart.cr1.modify(|_, w| w.idleie().bit(enable)),
Event::CharacterMatch => self.usart.cr1.modify(|_, w| w.cmie().bit(enable)),
Event::ReceiverTimeout => self.usart.cr1.modify(|_, w| w.rtoie().bit(enable)),
// Event::EndOfBlock => self.usart.cr1.modify(|_, w| w.eobie().bit(enable)),
// Event::WakeupFromStopMode => self.usart.cr3.modify(|_, w| w.wufie().bit(enable)),
};
}
/// Enable or disable interrupt for the specified [`Event`]s.
///
/// Like [`Serial::configure_interrupt`], but instead using an enumset. The corresponding
/// interrupt for every [`Event`] in the set will be enabled, every other interrupt will be
/// **disabled**.
#[cfg(feature = "enumset")]
#[cfg_attr(docsrs, doc(cfg(feature = "enumset")))]
pub fn configure_interrupts(&mut self, events: EnumSet<Event>) {
for event in events.complement().iter() {
self.configure_interrupt(event, false);
}
for event in events.iter() {
self.configure_interrupt(event, true);
}
}
/// Check if an interrupt is configured for the [`Event`]
#[inline]
pub fn is_interrupt_configured(&self, event: Event) -> bool {
match event {
Event::TransmitDataRegisterEmtpy => self.usart.cr1.read().txeie().is_enabled(),
Event::CtsInterrupt => self.usart.cr3.read().ctsie().is_enabled(),
Event::TransmissionComplete => self.usart.cr1.read().tcie().is_enabled(),
Event::ReceiveDataRegisterNotEmpty => self.usart.cr1.read().rxneie().is_enabled(),
Event::ParityError => self.usart.cr1.read().peie().is_enabled(),
Event::LinBreak => self.usart.cr2.read().lbdie().is_enabled(),
Event::NoiseError | Event::OverrunError | Event::FramingError => {
self.usart.cr3.read().eie().is_enabled()
}
Event::Idle => self.usart.cr1.read().idleie().is_enabled(),
Event::CharacterMatch => self.usart.cr1.read().cmie().is_enabled(),
Event::ReceiverTimeout => self.usart.cr1.read().rtoie().is_enabled(),
// Event::EndOfBlock => self.usart.cr1.read().eobie().is_enabled(),
// Event::WakeupFromStopMode => self.usart.cr3.read().wufie().is_enabled(),
}
}
/// Check which interrupts are enabled for all [`Event`]s
#[cfg(feature = "enumset")]
#[cfg_attr(docsrs, doc(cfg(feature = "enumset")))]
#[inline]
pub fn configured_interrupts(&mut self) -> EnumSet<Event> {
let mut events = EnumSet::new();
for event in EnumSet::<Event>::all().iter() {
if self.is_interrupt_configured(event) {
events |= event;
}
}
events
}
/// Check if an interrupt event happend.
#[inline]
pub fn is_event_triggered(&self, event: Event) -> bool {
let isr = self.usart.isr.read();
match event {
Event::TransmitDataRegisterEmtpy => isr.txe().bit(),
Event::CtsInterrupt => isr.ctsif().bit(),
Event::TransmissionComplete => isr.tc().bit(),
Event::ReceiveDataRegisterNotEmpty => isr.rxne().bit(),
Event::OverrunError => isr.ore().bit(),
Event::Idle => isr.idle().bit(),
Event::ParityError => isr.pe().bit(),
Event::LinBreak => isr.lbdf().bit(),
Event::NoiseError => isr.nf().bit(),
Event::FramingError => isr.fe().bit(),
Event::CharacterMatch => isr.cmf().bit(),
Event::ReceiverTimeout => isr.rtof().bit(),
// Event::EndOfBlock => isr.eobf().bit(),
// Event::WakeupFromStopMode => isr.wuf().bit(),
}
}
/// Get an [`EnumSet`] of all fired interrupt events.
///
/// # Examples
///
/// This allows disabling all fired event at once, via the enum set abstraction, like so
///
/// ```rust
/// for event in serial.events() {
/// serial.listen(event, false);
/// }
/// ```
#[cfg(feature = "enumset")]
#[cfg_attr(docsrs, doc(cfg(feature = "enumset")))]
pub fn triggered_events(&self) -> EnumSet<Event> {
let mut events = EnumSet::new();
for event in EnumSet::<Event>::all().iter() {
if self.is_event_triggered(event) {
events |= event;
}
}
events
}
/// Clear the given interrupt event flag.
#[inline]
pub fn clear_event(&mut self, event: Event) {
self.usart.icr.write(|w| match event {
Event::CtsInterrupt => w.ctscf().clear(),
Event::TransmissionComplete => w.tccf().clear(),
Event::OverrunError => w.orecf().clear(),
Event::Idle => w.idlecf().clear(),
Event::ParityError => w.pecf().clear(),
Event::LinBreak => w.lbdcf().clear(),
Event::NoiseError => w.ncf().clear(),
Event::FramingError => w.fecf().clear(),
Event::CharacterMatch => w.cmcf().clear(),
Event::ReceiverTimeout => w.rtocf().clear(),
// Event::EndOfBlock => w.eobcf().clear(),
// Event::WakeupFromStopMode => w.wucf().clear(),
Event::ReceiveDataRegisterNotEmpty => {
// Flush the register data queue, so that this even will not be thrown again.
self.usart.rqr.write(|w| w.rxfrq().set_bit());
w
}
// Do nothing with this event (only useful for Smartcard, which is not
// supported right now)
Event::TransmitDataRegisterEmtpy => w,
});
}
/// Clear **all** interrupt events.
#[inline]
pub fn clear_events(&mut self) {
// SAFETY: This atomic write clears all flags and ignores the reserverd bit fields.
self.usart.icr.write(|w| unsafe { w.bits(u32::MAX) });
}
/// Enable or disable overrun detection
///
/// When overrun detection is disabled and new data is received while the
/// [`Event::ReceiveDataRegisterNotEmpty`] flag is still set,
/// the [`Event::OverrunError`] flag is not set and the new received data overwrites the
/// previous content of the RDR register.
#[doc(alias = "OVRDIS")]
#[inline]
pub fn detect_overrun(&mut self, enable: bool) {
let uart_enabled = self.usart.cr1.read().ue().bit();
self.usart.cr1.modify(|_, w| w.ue().disabled());
self.usart.cr3.modify(|_, w| w.ovrdis().bit(!enable));
self.usart.cr1.modify(|_, w| w.ue().bit(uart_enabled));
}
/// Configuring the UART to match each received character,
/// with the configured one.
///
/// If the character is matched [`Event::CharacterMatch`] is generated,
/// which can fire an interrupt, if enabled via [`Serial::configure_interrupt()`]
pub fn set_match_character(&mut self, char: u8) {
// Note: This bit field can only be written when reception is disabled (RE = 0) or the
// USART is disabled
let enabled = self.usart.cr1.read().ue().bit_is_set();
self.usart.cr1.modify(|_, w| w.ue().disabled());
self.usart.cr2.modify(|_, w| w.add().bits(char));
self.usart.cr1.modify(|_, w| w.ue().bit(enabled));
}
/// Read out the configured match character.
pub fn match_character(&self) -> u8 {
self.usart.cr2.read().add().bits()
}
}
impl<Usart, Tx, Rx> Serial<Usart, (Tx, Rx)>
where
Usart: Instance + ReceiverTimeoutExt,
{
/// Set the receiver timeout value.
///
/// The RTOF flag ([`Event::ReceiverTimeout`]) is set if, after the last received character,
/// no new start bit is detected for more than the receiver timeout value, where the value
/// is being a counter, which is decreased by the configured baud rate.
///
/// A simple calculation might be `time_per_counter_value = 1 / configured_baud_rate`
///
///
/// ## Note
///
/// - If the value is None, the receiver timeout feature is disabled.
/// - This value must only be programmed once per received character.
/// - Can be written on the fly. If the new value is lower than or equal to the counter,
/// the RTOF flag is set.
/// - Values higher than 24 bits are truncated to 24 bit max (`16_777_216`).
pub fn set_receiver_timeout(&mut self, value: Option<u32>) {
if let Some(value) = value {
self.usart.cr2.modify(|_, w| w.rtoen().enabled());
self.usart.rtor.modify(|_, w| w.rto().bits(value));
} else {
self.usart.cr2.modify(|_, w| w.rtoen().disabled());
}
}
/// Read out the currently set timeout value
///
/// The relationship between the unit value and time is described in
/// [`Serial::receiver_timeout`].
///
/// - If the value is None, the receiver timeout feature is disabled.
pub fn receiver_timeout(&self) -> Option<u32> {
if self.usart.cr2.read().rtoen().is_enabled() {
Some(self.usart.rtor.read().rto().bits())
} else {
None
}
}
}
/// Implementation of the [`embedded_hal::serial::Read`] trait
/// shared between [`Rx::read()`] and [`Serial::read()`]
fn eh_read<Usart>(usart: &mut Usart) -> nb::Result<u8, Error>
where
Usart: Instance,
{
let isr = usart.isr.read();
Err(if isr.pe().bit_is_set() {
usart.icr.write(|w| w.pecf().clear());
nb::Error::Other(Error::Parity)
} else if isr.fe().bit_is_set() {
usart.icr.write(|w| w.fecf().clear());
nb::Error::Other(Error::Framing)
} else if isr.nf().bit_is_set() {
usart.icr.write(|w| w.ncf().clear());
nb::Error::Other(Error::Noise)
} else if isr.ore().bit_is_set() {
usart.icr.write(|w| w.orecf().clear());
// Flush the receive data
//
// Imagine a case of an overrun, where 2 or more bytes have been received by the hardware
// but haven't been read out yet: An overrun is signaled!
//
// The current state is: One byte is in the RDR (read data register) one one byte is still
// in the hardware pipeline (shift register).
//
// With this implementation, the overrun flag would be cleared but the data would not be
// read out, so there are still to bytes waiting in the pipeline.
//
// In case the flush wasn't called: The next read would then be successful, as the RDR is
// cleared, but the read after that would again report an overrun error, because the byte
// still in the hardware shift register would signal it.
//
// This means, that the overrun error is not completely handled by this read()
// implementation and leads to surprising behavior, if one would explicitly check for
// Error::Overrun and think, that this error would than be handled, which would not be the
// case.
//
// This is because, with this function signature, the data can not be returned
// simultainously with the error.
//
// To mitigate this and have an implementation without these surprises flush the RDR
// register. This leads to loosing a theoretically still receivable data byte! But at least
// no cleanup is needed, after an overrun is called.
usart.rqr.write(|w| w.rxfrq().set_bit());
nb::Error::Other(Error::Overrun)
} else if isr.rxne().bit_is_set() {
#[allow(clippy::cast_possible_truncation)]
return Ok(usart.rdr.read().bits() as u8);
} else {
nb::Error::WouldBlock
})
}
// TODO: Check if u16 for WORD is feasiable / possible
impl<Usart, Tx, Rx> serial::Read<u8> for Serial<Usart, (Tx, Rx)>
where
Usart: Instance,
{
type Error = Error;
/// Getting back an error means that the error is defined as "handled":
///
/// This implementation has the side effect for error handling, that the [`Event`] flag of the returned
/// [`Error`] is cleared.
///
/// This might be a problem, because if an interrupt is enabled for this particular flag, the
/// interrupt handler might not have the chance to find out from which flag the interrupt
/// originated.
///
/// So this function is only intended to be used for direct error handling and not leaving it
/// up to the interrupt handler.
///
/// To read out the content of the read register without internal error handling, use
/// [`embedded_hal::serial::Read`].
/// ...
// -> According to this API it should be skipped.
fn read(&mut self) -> nb::Result<u8, Error> {
eh_read(&mut self.usart)
}
}
impl<Usart, Pins> serial::Write<u8> for Serial<Usart, Pins>
where
Usart: Instance,
{
// NOTE(Infallible) See section "29.7 USART interrupts"; the only possible errors during
// transmission are: clear to send (which is disabled in this case) errors and
// framing errors (which only occur in SmartCard mode); neither of these apply to
// our hardware configuration
type Error = Infallible;
fn flush(&mut self) -> nb::Result<(), Infallible> {
if self.usart.isr.read().tc().bit_is_set() {
Ok(())
} else {
Err(nb::Error::WouldBlock)
}
}
fn write(&mut self, byte: u8) -> nb::Result<(), Infallible> {
if self.usart.isr.read().txe().bit_is_set() {
self.usart.tdr.write(|w| w.tdr().bits(u16::from(byte)));
Ok(())
} else {
Err(nb::Error::WouldBlock)
}
}
}
impl<Usart, Pins> fmt::Write for Serial<Usart, Pins>
where
Serial<Usart, Pins>: serial::Write<u8>,
{
fn write_str(&mut self, s: &str) -> fmt::Result {
s.bytes()
.try_for_each(|c| nb::block!(self.write(c)))
.map_err(|_| fmt::Error)
}
}
impl<USART, TX, RX> blocking::serial::write::Default<u8> for Serial<USART, (TX, RX)> where
USART: Instance
{
}
impl<Usart, Pins> Serial<Usart, Pins>
where
Usart: Instance + Dma,
{
/// Fill the buffer with received data using DMA.
pub fn read_exact<B, C>(self, buffer: B, mut channel: C) -> dma::Transfer<B, C, Self>
where
Self: dma::OnChannel<C>,
B: dma::WriteBuffer<Word = u8> + 'static,
C: dma::Channel,
{
// SAFETY: RDR is valid peripheral address, safe to dereference and pass to the DMA
unsafe {
channel.set_peripheral_address(
core::ptr::addr_of!(self.usart.rdr) as u32,
dma::Increment::Disable,
);
};
dma::Transfer::start_write(buffer, channel, self)
}
/// Transmit all data in the buffer using DMA.
pub fn write_all<B, C>(self, buffer: B, mut channel: C) -> dma::Transfer<B, C, Self>
where
Self: dma::OnChannel<C>,
B: dma::ReadBuffer<Word = u8> + 'static,
C: dma::Channel,
{
// SAFETY: TDR is valid peripheral address, safe to dereference and pass to the DMA
unsafe {
channel.set_peripheral_address(
core::ptr::addr_of!(self.usart.tdr) as u32,
dma::Increment::Disable,
);
};
dma::Transfer::start_read(buffer, channel, self)
}
}
impl<Usart, Pins> dma::Target for Serial<Usart, Pins>
where
Usart: Instance + Dma,
{
fn enable_dma(&mut self) {
self.usart
.cr3
.modify(|_, w| w.dmar().enabled().dmat().enabled());
}
fn disable_dma(&mut self) {
self.usart
.cr3
.modify(|_, w| w.dmar().disabled().dmat().disabled());
}
}
/// Marker trait for DMA capable UART implementations.
pub trait Dma: crate::private::Sealed {}
impl Dma for USART1 {}
impl Dma for USART2 {}
impl Dma for USART3 {}
/// Marker trait for Receiver Timeout capable UART implementations.
pub trait ReceiverTimeoutExt: crate::private::Sealed {}
impl ReceiverTimeoutExt for USART1 {}
#[cfg(not(any(feature = "gpio-f333")))]
impl ReceiverTimeoutExt for USART2 {}
#[cfg(not(any(feature = "gpio-f333")))]
impl ReceiverTimeoutExt for USART3 {}
/// UART instance
pub trait Instance:
Deref<Target = RegisterBlock>
+ crate::interrupts::InterruptNumber
+ crate::private::Sealed
+ rcc::Enable
+ rcc::Reset
{
#[doc(hidden)]
fn clock(clocks: &Clocks) -> Hertz;
}
macro_rules! usart {
(
$(
$USARTX:ident: ($INTERRUPT:path),
)+
) => {
$(
impl crate::interrupts::InterruptNumber for $USARTX {
type Interrupt = Interrupt;
const INTERRUPT: Interrupt = $INTERRUPT;
}
#[cfg(feature = "defmt")]
impl<Pins> defmt::Format for Serial<$USARTX, Pins> {
fn format(&self, f: defmt::Formatter) {
// Omitting pins makes it:
// 1. Easier.
// 2. Not to specialized to use it ergonimically for users
// even in a generic context.
// 3. Not require specialization.
defmt::write!(
f,
"Serial {{ usart: {}, pins: ? }}",
stringify!($USARTX),
);
}
}
impl<Pins> fmt::Debug for Serial<$USARTX, Pins> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct(stringify!(Serial))
.field("usart", &stringify!($USARTX))
.field("pins", &"?")
.finish()
}
}
)+
};
([ $(($X:literal, $INTERRUPT:path)),+ ]) => {
paste::paste! {
usart!(
$(
[<USART $X>]: ($INTERRUPT),
)+
);
}
};
}
/// Generates a clock function for UART Peripherals, where
/// the only clock source can be the peripheral clock
#[allow(unused_macros)]
macro_rules! usart_static_clock {
($($USARTX:ident),+) => {
$(
impl Instance for $USARTX {
fn clock(clocks: &Clocks) -> Hertz {
<$USARTX as rcc::BusClock>::clock(clocks)
}
}
)+
};
($($X:literal),+) => {
paste::paste! {
usart_static_clock!(
$([<USART $X>]),+
);
}
};
}
/// Generates a clock function for UART Peripherals, where
/// the clock source can vary.
macro_rules! usart_var_clock {
($($USARTX:ident, $usartXsw:ident),+) => {
$(
impl Instance for $USARTX {
fn clock(clocks: &Clocks) -> Hertz {
// SAFETY: The read instruction of the RCC.cfgr3 register should be atomic
match unsafe {(*RCC::ptr()).cfgr3.read().$usartXsw().variant()} {
USART1SW_A::Pclk => <$USARTX as rcc::BusClock>::clock(clocks),
USART1SW_A::Hsi => crate::rcc::HSI,
USART1SW_A::Sysclk => clocks.sysclk(),
USART1SW_A::Lse => crate::rcc::LSE,
}
}
}
)+
};
($($X:literal),+) => {
paste::paste! {
usart_var_clock!(
$([<USART $X>], [<usart $X sw>]),+
);
}
};
}
cfg_if::cfg_if! {
if #[cfg(any(
feature = "stm32f301x6",
feature = "stm32f301x8",
feature = "stm32f318x8",
feature = "stm32f302x6",
feature = "stm32f302x8",
feature = "stm32f303x6",
feature = "stm32f303x8",
feature = "stm32f328x8",
feature = "stm32f334x4",
feature = "stm32f334x6",
feature = "stm32f334x8",
))] {
// USART1 is accessed through APB2,
// but USART1SW_A::PCLK will connect its phy to PCLK1.
usart_var_clock!(1);
// These are uart peripherals, where the only clock source
// is the PCLK (peripheral clock).
usart_static_clock!(2, 3);
} else {
usart_var_clock!(1, 2, 3);
}
}
#[cfg(not(feature = "svd-f373"))]
usart!([
(1, Interrupt::USART1_EXTI25),
(2, Interrupt::USART2_EXTI26),
(3, Interrupt::USART3_EXTI28)
]);
#[cfg(feature = "svd-f373")]
usart!([
(1, Interrupt::USART1),
(2, Interrupt::USART2),
(3, Interrupt::USART3)
]);
cfg_if::cfg_if! {
// See table 29.4 RM0316
if #[cfg(any(feature = "gpio-f303", feature = "gpio-f303e"))] {
macro_rules! uart {
([ $(($X:literal, $INTERRUPT:path)),+ ]) => {
paste::paste! {
usart!(
$(
[<UART $X>]: ($INTERRUPT),
)+
);
}
};
}
macro_rules! uart_var_clock {
($($X:literal),+) => {
paste::paste! {
usart_var_clock!(
$([<UART $X>], [<uart $X sw>]),+
);
}
};
}
uart_var_clock!(4, 5);
uart!([(4, Interrupt::UART4_EXTI34), (5, Interrupt::UART5_EXTI35)]);
impl Dma for UART4 {}
impl ReceiverTimeoutExt for UART4 {}
impl ReceiverTimeoutExt for UART5 {}
}
}