STM32-TSC: enable discriminating between pins within same TSC group and improve TSC library in general

.gitignore

@@ -5,4 +5,7 @@ Cargo.lock
 third_party
 /Cargo.toml
 out/
+# editor artifacts
 .zed
+.neoconf.json
+*.vim

embassy-stm32/src/tsc/acquisition_banks.rs

@@ -0,0 +1,209 @@
+use super::io_pin::*;
+#[cfg(any(tsc_v2, tsc_v3))]
+use super::pin_groups::G7;
+#[cfg(tsc_v3)]
+use super::pin_groups::G8;
+use super::pin_groups::{pin_roles, G1, G2, G3, G4, G5, G6};
+use super::types::{Group, GroupStatus};
+use super::TSC_NUM_GROUPS;
+
+/// Represents a collection of TSC (Touch Sensing Controller) pins for an acquisition bank.
+///
+/// This struct holds optional `tsc::IOPin` values for each TSC group, allowing for flexible
+/// configuration of TSC acquisition banks. Each field corresponds to a specific TSC group
+/// and can be set to `Some(tsc::IOPin)` if that group is to be included in the acquisition,
+/// or `None` if it should be excluded.
+#[allow(missing_docs)]
+#[derive(Default)]
+pub struct AcquisitionBankPins {
+ pub g1_pin: Option<IOPinWithRole<G1, pin_roles::Channel>>,
+ pub g2_pin: Option<IOPinWithRole<G2, pin_roles::Channel>>,
+ pub g3_pin: Option<IOPinWithRole<G3, pin_roles::Channel>>,
+ pub g4_pin: Option<IOPinWithRole<G4, pin_roles::Channel>>,
+ pub g5_pin: Option<IOPinWithRole<G5, pin_roles::Channel>>,
+ pub g6_pin: Option<IOPinWithRole<G6, pin_roles::Channel>>,
+ #[cfg(any(tsc_v2, tsc_v3))]
+ pub g7_pin: Option<IOPinWithRole<G7, pin_roles::Channel>>,
+ #[cfg(tsc_v3)]
+ pub g8_pin: Option<IOPinWithRole<G8, pin_roles::Channel>>,
+}
+
+impl AcquisitionBankPins {
+ /// Returns an iterator over the pins in this acquisition bank.
+ ///
+ /// This method allows for easy traversal of all configured pins in the bank.
+ pub fn iter(&self) -> AcquisitionBankPinsIterator {
+ AcquisitionBankPinsIterator(AcquisitionBankIterator::new(self))
+ }
+}
+
+/// Iterator for TSC acquisition banks.
+///
+/// This iterator allows traversing through the pins of a `AcquisitionBankPins` struct,
+/// yielding each configured pin in order of the TSC groups.
+pub struct AcquisitionBankIterator<'a> {
+ pins: &'a AcquisitionBankPins,
+ current_group: u8,
+}
+
+impl<'a> AcquisitionBankIterator<'a> {
+ fn new(pins: &'a AcquisitionBankPins) -> Self {
+ Self { pins, current_group: 0 }
+ }
+
+ fn next_pin(&mut self) -> Option<IOPin> {
+ while self.current_group < TSC_NUM_GROUPS as u8 {
+ let pin = match self.current_group {
+ 0 => self.pins.g1_pin.map(IOPinWithRole::get_pin),
+ 1 => self.pins.g2_pin.map(IOPinWithRole::get_pin),
+ 2 => self.pins.g3_pin.map(IOPinWithRole::get_pin),
+ 3 => self.pins.g4_pin.map(IOPinWithRole::get_pin),
+ 4 => self.pins.g5_pin.map(IOPinWithRole::get_pin),
+ 5 => self.pins.g6_pin.map(IOPinWithRole::get_pin),
+ #[cfg(any(tsc_v2, tsc_v3))]
+ 6 => self.pins.g7_pin.map(IOPinWithRole::get_pin),
+ #[cfg(tsc_v3)]
+ 7 => self.pins.g8_pin.map(IOPinWithRole::get_pin),
+ _ => None,
+ };
+ self.current_group += 1;
+ if pin.is_some() {
+ return pin;
+ }
+ }
+ None
+ }
+}
+
+/// Iterator for TSC acquisition bank pins.
+///
+/// This iterator yields `tsc::IOPin` values for each configured pin in the acquisition bank.
+pub struct AcquisitionBankPinsIterator<'a>(AcquisitionBankIterator<'a>);
+
+impl<'a> Iterator for AcquisitionBankPinsIterator<'a> {
+ type Item = IOPin;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next_pin()
+ }
+}
+
+impl AcquisitionBankPins {
+ /// Returns an iterator over the available pins in the bank
+ pub fn pins_iterator(&self) -> AcquisitionBankPinsIterator {
+ AcquisitionBankPinsIterator(AcquisitionBankIterator::new(self))
+ }
+}
+
+/// Represents a collection of TSC pins to be acquired simultaneously.
+///
+/// This struct contains a set of pins to be used in a TSC acquisition with a pre-computed and
+/// verified mask for efficiently setting up the TSC peripheral before performing an acquisition.
+/// It ensures that only one channel pin per TSC group is included, adhering to hardware limitations.
+pub struct AcquisitionBank {
+ pub(super) pins: AcquisitionBankPins,
+ pub(super) mask: u32,
+}
+
+impl AcquisitionBank {
+ /// Returns an iterator over the available pins in the bank.
+ pub fn pins_iterator(&self) -> AcquisitionBankPinsIterator {
+ self.pins.pins_iterator()
+ }
+
+ /// Returns the mask for this bank.
+ pub fn mask(&self) -> u32 {
+ self.mask
+ }
+
+ /// Retrieves the TSC I/O pin for a given group in this acquisition bank.
+ ///
+ /// # Arguments
+ /// * `group` - The TSC group to retrieve the pin for.
+ ///
+ /// # Returns
+ /// An `Option<tsc::IOPin>` containing the pin if it exists for the given group, or `None` if not.
+ pub fn get_pin(&self, group: Group) -> Option<IOPin> {
+ match group {
+ Group::One => self.pins.g1_pin.map(|p| p.pin),
+ Group::Two => self.pins.g2_pin.map(|p| p.pin),
+ Group::Three => self.pins.g3_pin.map(|p| p.pin),
+ Group::Four => self.pins.g4_pin.map(|p| p.pin),
+ Group::Five => self.pins.g5_pin.map(|p| p.pin),
+ Group::Six => self.pins.g6_pin.map(|p| p.pin),
+ #[cfg(any(tsc_v2, tsc_v3))]
+ Group::Seven => self.pins.g7_pin.map(|p| p.pin),
+ #[cfg(tsc_v3)]
+ Group::Eight => self.pins.g8_pin.map(|p| p.pin),
+ }
+ }
+}
+
+/// Represents the status of all TSC groups in an acquisition bank
+#[derive(Default)]
+pub struct AcquisitionBankStatus {
+ pub(super) groups: [Option<GroupStatus>; TSC_NUM_GROUPS],
+}
+
+impl AcquisitionBankStatus {
+ /// Check if all groups in the bank are complete
+ pub fn all_complete(&self) -> bool {
+ self.groups
+ .iter()
+ .all(|&status| status.map_or(true, |s| s == GroupStatus::Complete))
+ }
+
+ /// Check if any group in the bank is ongoing
+ pub fn any_ongoing(&self) -> bool {
+ self.groups.iter().any(|&status| status == Some(GroupStatus::Ongoing))
+ }
+
+ /// Get the status of a specific group, if the group is present in the bank
+ pub fn get_group_status(&self, group: Group) -> Option<GroupStatus> {
+ let index: usize = group.into();
+ self.groups[index]
+ }
+
+ /// Iterator for groups present in the bank
+ pub fn iter(&self) -> impl Iterator<Item = (Group, GroupStatus)> + '_ {
+ self.groups.iter().enumerate().filter_map(|(group_num, status)| {
+ status.and_then(|s| Group::try_from(group_num).ok().map(|group| (group, s)))
+ })
+ }
+}
+
+/// Represents the result of a Touch Sensing Controller (TSC) acquisition for a specific pin.
+///
+/// This struct contains a reference to the `tsc::IOPin` from which a value was read,
+/// along with the actual sensor reading for that pin. It provides a convenient way
+/// to associate TSC readings with their corresponding pins after an acquisition.
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[derive(Clone, Copy, Debug)]
+pub struct ChannelReading {
+ /// The sensor reading value obtained from the TSC acquisition.
+ /// Lower values typically indicate a detected touch, while higher values indicate no touch.
+ pub sensor_value: u16,
+
+ /// The `tsc::IOPin` associated with this reading.
+ /// This allows for easy identification of which pin the reading corresponds to.
+ pub tsc_pin: IOPin,
+}
+
+/// Represents the readings from all TSC groups
+#[derive(Default)]
+pub struct AcquisitionBankReadings {
+ pub(super) groups: [Option<ChannelReading>; TSC_NUM_GROUPS],
+}
+
+impl AcquisitionBankReadings {
+ /// Get the reading for a specific group, if the group is present in the bank
+ pub fn get_group_reading(&self, group: Group) -> Option<ChannelReading> {
+ let index: usize = group.into();
+ self.groups[index]
+ }
+
+ /// Iterator for readings for groups present in the bank
+ pub fn iter(&self) -> impl Iterator<Item = ChannelReading> + '_ {
+ self.groups.iter().filter_map(|&x| x)
+ }
+}

embassy-stm32/src/tsc/config.rs

@@ -0,0 +1,175 @@
+/// Charge transfer pulse cycles
+#[allow(missing_docs)]
+#[derive(Copy, Clone, PartialEq)]
+pub enum ChargeTransferPulseCycle {
+ _1,
+ _2,
+ _3,
+ _4,
+ _5,
+ _6,
+ _7,
+ _8,
+ _9,
+ _10,
+ _11,
+ _12,
+ _13,
+ _14,
+ _15,
+ _16,
+}
+
+impl Into<u8> for ChargeTransferPulseCycle {
+ fn into(self) -> u8 {
+ match self {
+ ChargeTransferPulseCycle::_1 => 0,
+ ChargeTransferPulseCycle::_2 => 1,
+ ChargeTransferPulseCycle::_3 => 2,
+ ChargeTransferPulseCycle::_4 => 3,
+ ChargeTransferPulseCycle::_5 => 4,
+ ChargeTransferPulseCycle::_6 => 5,
+ ChargeTransferPulseCycle::_7 => 6,
+ ChargeTransferPulseCycle::_8 => 7,
+ ChargeTransferPulseCycle::_9 => 8,
+ ChargeTransferPulseCycle::_10 => 9,
+ ChargeTransferPulseCycle::_11 => 10,
+ ChargeTransferPulseCycle::_12 => 11,
+ ChargeTransferPulseCycle::_13 => 12,
+ ChargeTransferPulseCycle::_14 => 13,
+ ChargeTransferPulseCycle::_15 => 14,
+ ChargeTransferPulseCycle::_16 => 15,
+ }
+ }
+}
+
+/// Max count
+#[allow(missing_docs)]
+#[derive(Copy, Clone)]
+pub enum MaxCount {
+ _255,
+ _511,
+ _1023,
+ _2047,
+ _4095,
+ _8191,
+ _16383,
+}
+
+impl Into<u8> for MaxCount {
+ fn into(self) -> u8 {
+ match self {
+ MaxCount::_255 => 0,
+ MaxCount::_511 => 1,
+ MaxCount::_1023 => 2,
+ MaxCount::_2047 => 3,
+ MaxCount::_4095 => 4,
+ MaxCount::_8191 => 5,
+ MaxCount::_16383 => 6,
+ }
+ }
+}
+
+/// Prescaler divider
+#[allow(missing_docs)]
+#[derive(Copy, Clone, PartialEq)]
+pub enum PGPrescalerDivider {
+ _1,
+ _2,
+ _4,
+ _8,
+ _16,
+ _32,
+ _64,
+ _128,
+}
+
+impl Into<u8> for PGPrescalerDivider {
+ fn into(self) -> u8 {
+ match self {
+ PGPrescalerDivider::_1 => 0,
+ PGPrescalerDivider::_2 => 1,
+ PGPrescalerDivider::_4 => 2,
+ PGPrescalerDivider::_8 => 3,
+ PGPrescalerDivider::_16 => 4,
+ PGPrescalerDivider::_32 => 5,
+ PGPrescalerDivider::_64 => 6,
+ PGPrescalerDivider::_128 => 7,
+ }
+ }
+}
+
+/// Error type for SSDeviation
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum SSDeviationError {
+ /// The provided value is too low (0)
+ ValueTooLow,
+ /// The provided value is too high (greater than 128)
+ ValueTooHigh,
+}
+
+/// Spread Spectrum Deviation
+#[derive(Copy, Clone)]
+pub struct SSDeviation(u8);
+impl SSDeviation {
+ /// Create new deviation value, acceptable inputs are 1-128
+ pub fn new(val: u8) -> Result<Self, SSDeviationError> {
+ if val == 0 {
+ return Err(SSDeviationError::ValueTooLow);
+ } else if val > 128 {
+ return Err(SSDeviationError::ValueTooHigh);
+ }
+ Ok(Self(val - 1))
+ }
+}
+
+impl Into<u8> for SSDeviation {
+ fn into(self) -> u8 {
+ self.0
+ }
+}
+
+/// Peripheral configuration
+#[derive(Clone, Copy)]
+pub struct Config {
+ /// Duration of high state of the charge transfer pulse
+ pub ct_pulse_high_length: ChargeTransferPulseCycle,
+ /// Duration of the low state of the charge transfer pulse
+ pub ct_pulse_low_length: ChargeTransferPulseCycle,
+ /// Enable/disable of spread spectrum feature
+ pub spread_spectrum: bool,
+ /// Adds variable number of periods of the SS clk to pulse high state
+ pub spread_spectrum_deviation: SSDeviation,
+ /// Selects AHB clock divider used to generate SS clk
+ pub spread_spectrum_prescaler: bool,
+ /// Selects AHB clock divider used to generate pulse generator clk
+ pub pulse_generator_prescaler: PGPrescalerDivider,
+ /// Maximum number of charge transfer pulses that can be generated before error
+ pub max_count_value: MaxCount,
+ /// Defines config of all IOs when no ongoing acquisition
+ pub io_default_mode: bool,
+ /// Polarity of sync input pin
+ pub synchro_pin_polarity: bool,
+ /// Acquisition starts when start bit is set or with sync pin input
+ pub acquisition_mode: bool,
+ /// Enable max count interrupt
+ pub max_count_interrupt: bool,
+}
+
+impl Default for Config {
+ fn default() -> Self {
+ Self {
+ ct_pulse_high_length: ChargeTransferPulseCycle::_1,
+ ct_pulse_low_length: ChargeTransferPulseCycle::_1,
+ spread_spectrum: false,
+ spread_spectrum_deviation: SSDeviation::new(1).unwrap(),
+ spread_spectrum_prescaler: false,
+ pulse_generator_prescaler: PGPrescalerDivider::_1,
+ max_count_value: MaxCount::_255,
+ io_default_mode: false,
+ synchro_pin_polarity: false,
+ acquisition_mode: false,
+ max_count_interrupt: false,
+ }
+ }
+}