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

//! Support for the `PCA9538` "Remote 8-Bit I2C AND SMBus Low-power I/O Expander"
use crate::I2cExt;

/// `PCA9538` "Remote 8-Bit I2C AND SMBus Low-power I/O Expander"
pub struct Pca9538<M>(M);

impl<I2C> Pca9538<core::cell::RefCell<Driver<I2C>>>
where
    I2C: crate::I2cBus,
{
    pub fn new(i2c: I2C, a0: bool, a1: bool) -> Self {
        Self::with_mutex(i2c, a0, a1)
    }
}

impl<I2C, M> Pca9538<M>
where
    I2C: crate::I2cBus,
    M: crate::PortMutex<Port = Driver<I2C>>,
{
    pub fn with_mutex(i2c: I2C, a0: bool, a1: bool) -> Self {
        Self(crate::PortMutex::create(Driver::new(i2c, a0, a1)))
    }

    pub fn split(&mut self) -> Parts<'_, I2C, M> {
        Parts {
            io0: crate::Pin::new(0, &self.0),
            io1: crate::Pin::new(1, &self.0),
            io2: crate::Pin::new(2, &self.0),
            io3: crate::Pin::new(3, &self.0),
            io4: crate::Pin::new(4, &self.0),
            io5: crate::Pin::new(5, &self.0),
            io6: crate::Pin::new(6, &self.0),
            io7: crate::Pin::new(7, &self.0),
        }
    }
}

pub struct Parts<'a, I2C, M = core::cell::RefCell<Driver<I2C>>>
where
    I2C: crate::I2cBus,
    M: crate::PortMutex<Port = Driver<I2C>>,
{
    pub io0: crate::Pin<'a, crate::mode::Input, M>,
    pub io1: crate::Pin<'a, crate::mode::Input, M>,
    pub io2: crate::Pin<'a, crate::mode::Input, M>,
    pub io3: crate::Pin<'a, crate::mode::Input, M>,
    pub io4: crate::Pin<'a, crate::mode::Input, M>,
    pub io5: crate::Pin<'a, crate::mode::Input, M>,
    pub io6: crate::Pin<'a, crate::mode::Input, M>,
    pub io7: crate::Pin<'a, crate::mode::Input, M>,
}

#[allow(dead_code)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Regs {
    InputPort = 0x00,
    OutputPort = 0x01,
    PolarityInversion = 0x02,
    Configuration = 0x03,
}

impl From<Regs> for u8 {
    fn from(r: Regs) -> u8 {
        r as u8
    }
}

pub struct Driver<I2C> {
    i2c: I2C,
    addr: u8,
    out: u8,
}

impl<I2C> Driver<I2C> {
    pub fn new(i2c: I2C, a0: bool, a1: bool) -> Self {
        let addr = 0x70 | ((a1 as u8) << 1) | (a0 as u8);
        Self {
            i2c,
            addr,
            out: 0xff,
        }
    }
}

impl<I2C: crate::I2cBus> crate::PortDriver for Driver<I2C> {
    type Error = I2C::BusError;

    fn set(&mut self, mask_high: u32, mask_low: u32) -> Result<(), Self::Error> {
        let previous = self.out;
        self.out |= mask_high as u8;
        self.out &= !mask_low as u8;
        if self.out != previous {
            self.i2c.write_reg(self.addr, Regs::OutputPort, self.out)
        } else {
            // don't do the transfer when nothing changed
            Ok(())
        }
    }

    fn is_set(&mut self, mask_high: u32, mask_low: u32) -> Result<u32, Self::Error> {
        Ok(((self.out as u32) & mask_high) | (!(self.out as u32) & mask_low))
    }

    fn get(&mut self, mask_high: u32, mask_low: u32) -> Result<u32, Self::Error> {
        let in_ = self.i2c.read_reg(self.addr, Regs::InputPort)? as u32;
        Ok((in_ & mask_high) | (!in_ & mask_low))
    }
}

impl<I2C: crate::I2cBus> crate::PortDriverTotemPole for Driver<I2C> {
    fn set_direction(
        &mut self,
        mask: u32,
        dir: crate::Direction,
        state: bool,
    ) -> Result<(), Self::Error> {
        // set state before switching direction to prevent glitch
        if dir == crate::Direction::Output {
            use crate::PortDriver;
            if state {
                self.set(mask, 0)?;
            } else {
                self.set(0, mask)?;
            }
        }

        let (mask_set, mask_clear) = match dir {
            crate::Direction::Input => (mask as u8, 0),
            crate::Direction::Output => (0, mask as u8),
        };
        self.i2c
            .update_reg(self.addr, Regs::Configuration, mask_set, mask_clear)
    }
}

impl<I2C: crate::I2cBus> crate::PortDriverPolarity for Driver<I2C> {
    fn set_polarity(&mut self, mask: u32, inverted: bool) -> Result<(), Self::Error> {
        let (mask_set, mask_clear) = match inverted {
            false => (0, mask as u8),
            true => (mask as u8, 0),
        };

        self.i2c
            .update_reg(self.addr, Regs::PolarityInversion, mask_set, mask_clear)
    }
}

#[cfg(test)]
mod tests {
    use embedded_hal_mock::eh1::i2c as mock_i2c;

    #[test]
    fn pca9538() {
        let expectations = [
            // pin setup io0
            mock_i2c::Transaction::write(0x71, vec![0x01, 0xfe]),
            mock_i2c::Transaction::write_read(0x71, vec![0x03], vec![0xff]),
            mock_i2c::Transaction::write(0x71, vec![0x03, 0xfe]),
            // pin setup io1
            mock_i2c::Transaction::write_read(0x71, vec![0x03], vec![0xfe]),
            mock_i2c::Transaction::write(0x71, vec![0x03, 0xfc]),
            // pin setup io0 as input
            mock_i2c::Transaction::write_read(0x71, vec![0x03], vec![0xfc]),
            mock_i2c::Transaction::write(0x71, vec![0x03, 0xfd]),
            // io1 writes
            mock_i2c::Transaction::write(0x71, vec![0x01, 0xfc]),
            mock_i2c::Transaction::write(0x71, vec![0x01, 0xfe]),
            mock_i2c::Transaction::write(0x71, vec![0x01, 0xfc]),
            // io0 reads
            mock_i2c::Transaction::write_read(0x71, vec![0x00], vec![0x01]),
            mock_i2c::Transaction::write_read(0x71, vec![0x00], vec![0x00]),
            // io4 polarity
            mock_i2c::Transaction::write_read(0x71, vec![0x02], vec![0x00]),
            mock_i2c::Transaction::write(0x71, vec![0x02, 0x10]),
            // io5 polarity
            mock_i2c::Transaction::write_read(0x71, vec![0x02], vec![0x10]),
            mock_i2c::Transaction::write(0x71, vec![0x02, 0x30]),
            mock_i2c::Transaction::write_read(0x71, vec![0x02], vec![0x30]),
            mock_i2c::Transaction::write(0x71, vec![0x02, 0x10]),
        ];
        let mut bus = mock_i2c::Mock::new(&expectations);

        let mut pca = super::Pca9538::new(bus.clone(), true, false);
        let pca_pins = pca.split();

        let io0 = pca_pins.io0.into_output().unwrap();
        let mut io1 = pca_pins.io1.into_output_high().unwrap();

        let io0 = io0.into_input().unwrap();

        io1.set_low().unwrap();
        io1.set_high().unwrap();
        io1.toggle().unwrap();

        assert!(io0.is_high().unwrap());
        assert!(io0.is_low().unwrap());

        pca_pins.io4.into_inverted().unwrap();
        let mut io5 = pca_pins.io5;
        io5.set_inverted(true).unwrap();
        io5.set_inverted(false).unwrap();

        bus.done();
    }
}