dvcdbg 0.3.0

Lightweight diagnostics toolkit for embedded (no_std, I2C scan, quick tests)
Documentation 
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

//! src/compat/i2c_compat.rs
use core::fmt::Debug;
#[cfg(feature = "ehal_1_0")]
use embedded_hal_1::i2c::{Error as Ehal1Error, ErrorKind as Ehal1ErrorKind}; // Add this for ehal 1.0 ErrorKind

/// common I2C trait
pub trait I2cCompat {
    type Error: Debug;

    fn write(&mut self, addr: u8, bytes: &[u8]) -> Result<(), Self::Error>;
    fn read(&mut self, addr: u8, buffer: &mut [u8]) -> Result<(), Self::Error>;
    fn write_read(&mut self, addr: u8, bytes: &[u8], buffer: &mut [u8]) -> Result<(), Self::Error>;
    /// Check if a device exists at the given I2C address.
    /// This is typically implemented by a 1-byte write or a dummy read,
    /// which checks for an ACK from the device.
    fn probe(&mut self, addr: u8) -> Result<bool, Self::Error>;
    /// Check if the error is a NACK error.
    fn is_nack(&self, error: &Self::Error) -> bool;
}

// ========== ehal 0.2.x ==========
#[cfg(all(feature = "ehal_0_2", not(feature = "ehal_1_0")))]
impl<I2C, E> I2cCompat for I2C
where
    I2C: embedded_hal_0_2::blocking::i2c::Write<Error = E>
        + embedded_hal_0_2::blocking::i2c::Read<Error = E>
        + embedded_hal_0_2::blocking::i2c::WriteRead<Error = E>,
    E: Debug, // Removed embedded_hal_0_2::blocking::i2c::Error
{
    type Error = E;

    fn write(&mut self, addr: u8, bytes: &[u8]) -> Result<(), Self::Error> {
        embedded_hal_0_2::blocking::i2c::Write::write(self, addr, bytes)
    }

    fn read(&mut self, addr: u8, buffer: &mut [u8]) -> Result<(), Self::Error> {
        embedded_hal_0_2::blocking::i2c::Read::read(self, addr, buffer)
    }

    fn write_read(&mut self, addr: u8, bytes: &[u8], buffer: &mut [u8]) -> Result<(), Self::Error> {
        embedded_hal_0_2::blocking::i2c::WriteRead::write_read(self, addr, bytes, buffer)
    }

    fn probe(&mut self, addr: u8) -> Result<bool, Self::Error> {
        // For ehal 0.2.x, there's no standard way to check for NACK specifically
        // without a custom error type that implements a `kind()` method.
        // We'll assume any error means the device is not present or there's a bus issue.
        // A successful 0-byte write implies the device is present.
        match embedded_hal_0_2::blocking::i2c::Write::write(self, addr, &[]) {
            Ok(_) => Ok(true),
            Err(_) => Ok(false), // Assume any error means the device is not present.
        }
    }

    fn is_nack(&self, _error: &Self::Error) -> bool {
        // For ehal 0.2.x, there's no standard way to check for NACK specifically.
        // This would require the error type `E` to provide a method for this.
        false
    }
}

// ========== ehal 1.0 ==========
#[cfg(feature = "ehal_1_0")]
impl<I2C> I2cCompat for I2C
where
    I2C: embedded_hal_1::i2c::I2c,
    I2C::Error: embedded_hal_1::i2c::Error,
{
    type Error = I2C::Error;

    fn write(&mut self, addr: u8, bytes: &[u8]) -> Result<(), Self::Error> {
        embedded_hal_1::i2c::I2c::write(self, addr, bytes)
    }

    fn read(&mut self, addr: u8, buffer: &mut [u8]) -> Result<(), Self::Error> {
        embedded_hal_1::i2c::I2c::read(self, addr, buffer)
    }

    fn write_read(&mut self, addr: u8, bytes: &[u8], buffer: &mut [u8]) -> Result<(), Self::Error> {
        embedded_hal_1::i2c::I2c::write_read(self, addr, bytes, buffer)
    }

    fn probe(&mut self, addr: u8) -> Result<bool, Self::Error> {
        match embedded_hal_1::i2c::I2c::transaction(
            self,
            addr,
            &mut [embedded_hal_1::i2c::Operation::Write(&[])],
        ) {
            Ok(_) => Ok(true),
            Err(e) => {
                if matches!(e.kind(), Ehal1ErrorKind::NoAcknowledge(_)) {
                    // Use matches! macro with wildcard for NoAcknowledgeSource
                    Ok(false)
                } else {
                    Err(e)
                }
            }
        }
    }

    fn is_nack(&self, error: &Self::Error) -> bool {
        matches!(error.kind(), Ehal1ErrorKind::NoAcknowledge(_)) // Use matches! macro with wildcard for NoAcknowledgeSource
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // ===== 1.0 Dummy I2C =====
    #[cfg(feature = "ehal_1_0")]
    mod ehal_1_0_tests {
        use super::*;
        use embedded_hal_1::i2c::{ErrorType, I2c, Operation};
        #[derive(Debug)]
        struct DummyI2c;

        impl ErrorType for DummyI2c {
            type Error = core::convert::Infallible;
        }

        impl I2c for DummyI2c {
            fn write(&mut self, _addr: u8, _bytes: &[u8]) -> Result<(), Self::Error> {
                Ok(())
            }
            fn read(&mut self, _addr: u8, buffer: &mut [u8]) -> Result<(), Self::Error> {
                for b in buffer.iter_mut() {
                    *b = 0xAA;
                }
                Ok(())
            }
            fn write_read(
                &mut self,
                _addr: u8,
                _bytes: &[u8],
                buffer: &mut [u8],
            ) -> Result<(), Self::Error> {
                for b in buffer.iter_mut() {
                    *b = 0x55;
                }
                Ok(())
            }
            fn transaction(
                &mut self,
                _addr: u8,
                _ops: &mut [Operation<'_>],
            ) -> Result<(), Self::Error> {
                Ok(())
            }
        }

        #[test]
        fn test_dummy_i2c() {
            let mut i2c = DummyI2c;
            let mut buf = [0u8; 4];

            assert!(I2c::write(&mut i2c, 0x42, &[1, 2, 3]).is_ok());
            assert!(I2c::read(&mut i2c, 0x42, &mut buf).is_ok());
            assert_eq!(buf, [0xAA; 4]);

            assert!(I2c::write_read(&mut i2c, 0x42, &[9], &mut buf).is_ok());
            assert_eq!(buf, [0x55; 4]);

            let mut ops = [];
            assert!(i2c.transaction(0x42, &mut ops).is_ok());
        }
    }

    // ===== 0.2 Dummy I2C =====
    #[cfg(all(feature = "ehal_0_2", not(feature = "ehal_1_0")))]
    mod ehal_0_2_tests {
        use super::*;
        use embedded_hal_0_2::blocking::i2c::{Read, Write, WriteRead};

        #[derive(Debug)]
        struct DummyI2c;

        impl Write for DummyI2c {
            type Error = core::convert::Infallible;
            fn write(&mut self, _addr: u8, _bytes: &[u8]) -> Result<(), Self::Error> {
                Ok(())
            }
        }

        impl Read for DummyI2c {
            type Error = core::convert::Infallible;
            fn read(&mut self, _addr: u8, buffer: &mut [u8]) -> Result<(), Self::Error> {
                for b in buffer.iter_mut() {
                    *b = 0xAA;
                }
                Ok(())
            }
        }

        impl WriteRead for DummyI2c {
            type Error = core::convert::Infallible;
            fn write_read(
                &mut self,
                _addr: u8,
                _bytes: &[u8],
                buffer: &mut [u8],
            ) -> Result<(), Self::Error> {
                for b in buffer.iter_mut() {
                    *b = 0x55;
                }
                Ok(())
            }
        }

        #[test]
        fn test_i2c_write_read_0_2() {
            let mut i2c = DummyI2c;
            let mut buf = [0u8; 4];

            assert!(i2c.write(0x42, &[1, 2, 3]).is_ok());
            assert!(i2c.read(0x42, &mut buf).is_ok());
            assert_eq!(buf, [0xAA; 4]);

            assert!(i2c.write_read(0x42, &[9], &mut buf).is_ok());
            assert_eq!(buf, [0x55; 4]);
        }
    }
}