review: changes part 1

- remove stubs
- compact Commands together, cfg's when diffrences
- update ci (no chip selection is a compile error)
- update st25r39-disco to use feature

Signed-off-by: Krzysztof Królczyk <[email protected]>

Author: kkrolczyk

ci.sh

@@ -17,12 +17,8 @@ cargo build --release --manifest-path rnfc-fm175xx/Cargo.toml --features ''
 cargo build --release --manifest-path rnfc-fm175xx/Cargo.toml --features 'defmt'
 cargo build --release --manifest-path rnfc-fm175xx/Cargo.toml --features 'log'
 
-echo "no-features"
-cargo build --release --manifest-path rnfc-st25r39/Cargo.toml --features ''
-echo "st25r3916"
 cargo build --release --manifest-path rnfc-st25r39/Cargo.toml --features 'st25r3916, defmt'
 cargo build --release --manifest-path rnfc-st25r39/Cargo.toml --features 'st25r3916, log'
-echo "st25r3911b"
 cargo build --release --manifest-path rnfc-st25r39/Cargo.toml --features 'st25r3911b, defmt'
 cargo build --release --manifest-path rnfc-st25r39/Cargo.toml --features 'st25r3911b, log'
 

examples/st25r39-disco/Cargo.toml

@@ -11,7 +11,7 @@ default = [
 ]
 
 [dependencies]
-rnfc-st25r39 = { path = "../../rnfc-st25r39", features = [ "defmt" ] }
+rnfc-st25r39 = { path = "../../rnfc-st25r39", features = [ "defmt", "st25r3916" ] }
 rnfc = { path = "../../rnfc", features = [ "defmt" ] }
 
 embassy-executor = { version = "0.7", features = ["defmt", "nightly", "arch-cortex-m", "executor-thread"] }

rnfc-st25r39/src/commands/cmds_st25r3911b.rs

@@ -1,14 +1,94 @@
-#[cfg(feature = "st25r3916")]
-pub mod cmds_st25r3916;
-#[cfg(feature = "st25r3916")]
-pub use cmds_st25r3916::Command;
-
-#[cfg(feature = "st25r3911b")]
-pub mod cmds_st25r3911b;
-#[cfg(feature = "st25r3911b")]
-pub use cmds_st25r3911b::Command;
-
-#[cfg(all(not(feature = "st25r3911b"), not(feature = "st25r3916")))]
-mod stub;
-#[cfg(all(not(feature = "st25r3911b"), not(feature = "st25r3916")))]
-pub use stub::Command;
+/// Direct commands
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[allow(unused)]
+pub enum Command {
+    /// Puts the chip in default state (same as after power-up)
+    SetDefault = 0xC1,
+    /// Stops all activities and clears FIFO same as C3
+    Stop = 0xC2,
+    /// Stops all activities and clears FIFO same as C2
+    Clear = 0xC3,
+    /// Transmit with CRC
+    TransmitWithCrc = 0xC4,
+    /// Transmit without CRC
+    TransmitWithoutCrc = 0xC5,
+    /// Transmit REQA
+    TransmitReqa = 0xC6,
+    /// Transmit WUPA
+    TransmitWupa = 0xC7,
+    /// NFC transmit with Initial RF Collision Avoidance
+    InitialRfCollision = 0xC8,
+    /// NFC transmit with Response RF Collision Avoidance
+    ResponseRfCollisionN = 0xC9,
+    #[cfg(feature = "st25r3911b")]
+    /// NFC transmit with Response RF Collision Avoidance with n=0
+    ResponseRfCollisionNzero = 0xCA,
+    #[cfg(feature = "st25r3911b")]
+    /// Accepted in NFCIP-1 active communication bitrate detection mode
+    GotoNormalNFCMode = 0xCB,
+    #[cfg(feature = "st25r3911b")]
+    /// Presets Rx and Tx configuration based on state of Mode definition register and Bit rate definition register
+    PresetAnalog = 0xCC,
+    #[cfg(feature = "st25r3916")]
+    /// Passive target logic to Sense/Idle state
+    GotoSense = 0xCD,
+    #[cfg(feature = "st25r3916")]
+    /// Passive target logic to Sleep/Halt state
+    GotoSleep = 0xCE,
+    /// Mask receive data
+    MaskReceiveData = 0xD0,
+    /// Unmask receive data
+    UnmaskReceiveData = 0xD1,
+    #[cfg(feature = "st25r3916")]
+    /// AM Modulation state change
+    AmModStateChange = 0xD2,
+    /// Measure singal amplitude on RFI inputs
+    MeasureAmplitude = 0xD3,
+    #[cfg(feature = "st25r3911b")]
+    /// Performs gain reduction based on the current noise level
+    Squelch = 0xD4,
+    /// Reset RX Gain
+    ResetRxgain = 0xD5,
+    /// Adjust regulators
+    AdjustRegulators = 0xD6,
+    #[cfg(feature = "st25r3911b")]
+    /// Starts sequence that activates the Tx, measures the modulation depth, and adapts it to comply with the specified modulation depth
+    CalibrateModDepth = 0xD7,
+    /// Starts the sequence to adjust the driver timing. Called CalibrateAntenna in st25r3911b
+    CalibrateDriverTiming = 0xD8,
+    /// Measure phase between RFO and RFI signal
+    MeasurePhase = 0xD9,
+    /// Clear RSSI bits and restart the measurement
+    ClearRssi = 0xDA,
+    #[cfg(feature = "st25r3916")]
+    /// Clears FIFO, Collision and IRQ status
+    ClearFifo = 0xDB,
+    /// Transparent mode  - amplitude of signal present on RFI inputs is measured, result is stored in A/D converter output register
+    TransparentMode = 0xDC,
+    /// Calibrate the capacitive sensor
+    CalibrateCSensor = 0xDD,
+    /// Measure capacitance sensor
+    MeasureCapacitance = 0xDE,
+    /// Measure power supply voltage
+    MeasureVdd = 0xDF,
+    /// Start the general purpose timer
+    StartGpTimer = 0xE0,
+    /// Start the wake-up timer
+    StartWupTimer = 0xE1,
+    /// Start the mask-receive timer
+    StartMaskReceiveTimer = 0xE2,
+    /// Start the no-response timer
+    StartNoResponseTimer = 0xE3,
+    #[cfg(feature = "st25r3916")]
+    /// Start PPon2 timer
+    StartPpon2Timer = 0xE4,
+    #[cfg(feature = "st25r3916")]
+    /// Stop No Response Timer
+    StopNrt = 0xE8,
+    #[cfg(feature = "st25r3916")]
+    /// Enable R/W access to the test registers
+    SpaceBAccess = 0xFB,
+    /// Enable R/W access to the test registers
+    TestAccess = 0xFC,
+}

rnfc-st25r39/src/commands/cmds_st25r3916.rs

@@ -8,11 +8,6 @@ pub mod lib_st25r3911b;
 #[cfg(feature = "st25r3911b")]
 pub use lib_st25r3911b::*;
 
-#[cfg(all(not(feature = "st25r3911b"), not(feature = "st25r3916")))]
-mod stub;
-#[cfg(all(not(feature = "st25r3911b"), not(feature = "st25r3916")))]
-pub use stub::*;
-
 // TODO: check wup and other wake-up registers in st25r3911b
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]

rnfc-st25r39/src/commands/mod.rs

@@ -5,9 +5,9 @@
 // This must go FIRST so that other mods see its macros.
 mod fmt;
 
-// no-chip-specified, maybe it'd be useful to have common api
-// or support a mock, in case some tests to validate calculations?
-#[cfg(any(feature = "st25r3911b", feature = "st25r3916"))]
+#[cfg(all(not(feature = "st25r3911b"), not(feature = "st25r3916")))]
+compile_error!("A chip/feature has to be selected in Cargo.toml");
+
 mod aat;
 pub mod commands;
 pub mod impls;
@@ -28,8 +28,11 @@ pub enum Error<T> {
 
 #[derive(PartialEq, Eq, Clone, Copy)]
 enum Mode {
+    /// SPI running, AFE static power consumpton mnimized
     Off,
+    /// Ready mode
     On,
+    /// Low power mode, card presence detection
     Wakeup,
 }