adafruit_seesaw/modules/
gpio.rs

1use super::{Modules, Reg};
2use crate::{devices::SeesawDevice, Driver, DriverExt, SeesawError};
3
4/// WO - 32 bits
5/// Writing a 1 to any bit in this register sets the direction of the
6/// corresponding pin to OUTPUT. Writing 0 has no effect.
7#[allow(dead_code)]
8const SET_OUTPUT: &Reg = &[Modules::Gpio.into_u8(), 0x02];
9
10/// WO - 32 bits
11/// Writing a 1 to any bit in this register sets the direction of the
12/// corresponding pin to INPUT. Writing 0 has no effect.
13const SET_INPUT: &Reg = &[Modules::Gpio.into_u8(), 0x03];
14
15/// WR - 32 bits
16/// When written to, all bits that are set to 0 will have their
17/// corresponding pins set LOW. All bits that are set to 1 will
18/// have their corresponding pins set HIGH.
19/// Reading this register reads all pins on PORTA of the seesaw device.
20const GPIO: &Reg = &[Modules::Gpio.into_u8(), 0x04];
21
22/// WO - 32 bits
23/// Writing a 1 to any bit in this register writes the corresponding pin
24/// HIGH. Writing 0 has no effect.
25const SET_HIGH: &Reg = &[Modules::Gpio.into_u8(), 0x05];
26
27/// WO - 32 bits
28/// Writing a 1 to any bit in this register writes the corresponding pin
29/// LOW. Writing 0 has no effect.
30const SET_LOW: &Reg = &[Modules::Gpio.into_u8(), 0x06];
31
32/// W0 - 32 bits
33/// Writing a 1 to any bit in this register toggles the corresponding pin.
34/// Writing 0 has no effect.
35#[allow(dead_code)]
36const TOGGLE: &Reg = &[Modules::Gpio.into_u8(), 0x07];
37
38/// WO - 32 bits
39/// Writing a 1 to any bit in this register enables the interrupt on the
40/// corresponding pin. When the value on this pin changes, the corresponding
41/// bit will be set in the INTFLAG register. Writing 0 has no effect.
42#[allow(dead_code)]
43const INT_ENABLE: &Reg = &[Modules::Gpio.into_u8(), 0x08];
44
45/// WO - 32 bits
46/// Writing a 1 to any bit in this register disables the interrupt on the
47/// corresponding pin. Writing 0 has no effect.
48#[allow(dead_code)]
49const INT_DISABLE: &Reg = &[Modules::Gpio.into_u8(), 0x09];
50
51/// RO - 32 bits
52/// This register hold the status of all GPIO interrupts.
53/// When an interrupt fires, the corresponding bit in this register gets
54/// set. Reading this register clears all interrupts.
55#[allow(dead_code)]
56const INT_FLAG: &Reg = &[Modules::Gpio.into_u8(), 0x0A];
57
58/// WO - 32 bits
59/// Writing a 1 to any bit in this register enables the internal pullup or
60/// pulldown on the corresponding pin. The pull direction (up/down) is
61/// determined by the GPIO (output) value - if the corresponding GPIO
62/// register bit is low,  its a pulldown. High, its a pullup. Writing 0 has
63/// no effect.
64const PULL_ENABLE: &Reg = &[Modules::Gpio.into_u8(), 0x0B];
65
66/// WO - 32 bits
67/// Writing a 1 to any bit in this register disables the pull up/down on the
68/// corresponding pin. Writing 0 has no effect.
69#[allow(dead_code)]
70const PULL_DISABLE: &Reg = &[Modules::Gpio.into_u8(), 0x0C];
71
72/// The GPIO module provides every day input and outputs. You'll get logic GPIO
73/// pins that can act as outputs or inputs. With pullups or pulldowns. When
74/// inputs, you can also create pin-change interrupts that are routed the the
75/// IRQ pin.
76///
77/// On SAMD09-based boards the GPIO is 3V only.
78///
79/// On ATtiny-based boards, the GPIO logic is whatever the power pin is, 3V or
80/// 5V.
81///
82/// The module base register address for the GPIO module is 0x01.
83pub trait GpioModule<D: Driver>: SeesawDevice<Driver = D> {
84    fn digital_read(&mut self, pin: u8) -> Result<bool, SeesawError<D::Error>> {
85        self.digital_read_bulk()
86            .map(|pins| !matches!((pins >> pin) & 0x1, 1))
87    }
88
89    fn digital_read_bulk(&mut self) -> Result<u32, SeesawError<D::Error>> {
90        let addr = self.addr();
91        self.driver().read_u32(addr, GPIO).map_err(SeesawError::I2c)
92    }
93
94    fn digital_write(&mut self, pin: u8, output: PinOutput) -> Result<(), SeesawError<D::Error>> {
95        self.digital_write_bulk(1 << pin, output)
96    }
97
98    fn digital_write_bulk(
99        &mut self,
100        pins: u32,
101        output: PinOutput,
102    ) -> Result<(), SeesawError<D::Error>> {
103        let addr = self.addr();
104        let bus = self.driver();
105
106        match output {
107            PinOutput::High => bus.write_u32(addr, SET_HIGH, pins),
108            PinOutput::Low => bus.write_u32(addr, SET_LOW, pins),
109            PinOutput::Set => bus.write_u32(addr, GPIO, pins),
110            PinOutput::Toggle => bus.write_u32(addr, TOGGLE, pins),
111        }
112        .map_err(SeesawError::I2c)
113    }
114
115    fn set_pin_mode(&mut self, pin: u8, mode: PinMode) -> Result<(), SeesawError<D::Error>> {
116        self.set_pin_mode_bulk(1 << pin, mode)
117    }
118
119    fn set_pin_mode_bulk(&mut self, pins: u32, mode: PinMode) -> Result<(), SeesawError<D::Error>> {
120        let addr = self.addr();
121        let bus = self.driver();
122
123        match mode {
124            PinMode::Output => bus.write_u32(addr, SET_OUTPUT, pins),
125            PinMode::Input => bus.write_u32(addr, SET_INPUT, pins),
126            PinMode::InputPullup => bus
127                .write_u32(addr, SET_INPUT, pins)
128                .and_then(|_| bus.write_u32(addr, PULL_ENABLE, pins))
129                .and_then(|_| bus.write_u32(addr, SET_HIGH, pins)),
130            PinMode::InputPulldown => bus
131                .write_u32(addr, SET_INPUT, pins)
132                .and_then(|_| bus.write_u32(addr, PULL_ENABLE, pins))
133                .and_then(|_| bus.write_u32(addr, SET_LOW, pins)),
134            _ => unimplemented!("Other pins modes are not supported."),
135        }
136        .map_err(SeesawError::I2c)
137    }
138}
139
140#[derive(Clone, Copy, Debug)]
141#[cfg_attr(feature = "defmt", derive(defmt::Format))]
142#[repr(u8)]
143pub enum PinOutput {
144    High,
145    Low,
146    Set,
147    Toggle,
148}
149
150#[derive(Clone, Copy, Debug)]
151#[cfg_attr(feature = "defmt", derive(defmt::Format))]
152#[repr(u8)]
153pub enum PinMode {
154    Input = 0x01,
155    Output = 0x02,
156    Pullup = 0x04,
157    InputPullup = 0x05,
158    Pulldown = 0x08,
159    InputPulldown = 0x09,
160    OpenDrain = 0x10,
161    OutputOpenDrain = 0x12,
162    Special = 0xF0,
163    Function1 = 0x00,
164    Function2 = 0x20,
165    Function3 = 0x40,
166    Function4 = 0x60,
167    Function5 = 0x80,
168    Function6 = 0xA0,
169    Analog = 0xC0,
170}
171
172impl From<PinMode> for u8 {
173    fn from(value: PinMode) -> Self {
174        value as u8
175    }
176}
177
178#[derive(Clone, Copy, Debug)]
179#[cfg_attr(feature = "defmt", derive(defmt::Format))]
180#[repr(u8)]
181pub enum InterruptMode {
182    Disabled = 0x00,
183    Rising = 0x01,
184    Falling = 0x02,
185    Change = 0x03,
186    Onlow = 0x04,
187    Onhigh = 0x05,
188    OnlowWe = 0x0C,
189    OnhighWe = 0x0D,
190}
191
192impl From<InterruptMode> for u8 {
193    fn from(value: InterruptMode) -> Self {
194        value as u8
195    }
196}
adafruit_seesaw/modules/gpio.rs

adafruit_seesaw/modules/
gpio.rs
