Skip to content

Replace the IO expander pull enable API with explicit modes #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lovyan03 merged 1 commit into from
Aug 17, 2026
Merged

Replace the IO expander pull enable API with explicit modes #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/M5Unified.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2170,13 +2170,13 @@ static constexpr const uint8_t _pin_table_mbus[][31] = {
auto& ioexp = getIOExpander(0);
// lcd backlight
ioexp.setDirection(7, true);
ioexp.setPullMode(7, false);
ioexp.setPullMode(7, IOExpander_Base::pull_down);
ioexp.setHighImpedance(7, false);

for (int i = 0; i < 3; ++i) {
// button a~c
ioexp.setDirection(i, false);
ioexp.setPullMode(i, true);
ioexp.setPullMode(i, IOExpander_Base::pull_up);
ioexp.setHighImpedance(i, false);
}
delay(100);
Expand Down
14 changes: 10 additions & 4 deletions src/utility/IOExpander_Base.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ namespace m5
class IOExpander_Base : public I2C_Device
{
public:
enum gpio_pull_t : std::uint8_t
{ pull_none = 0
, pull_up = 1
, pull_down = 2
};

IOExpander_Base(std::uint8_t i2c_addr, std::uint32_t freq = 400000, m5::I2C_Class* i2c = &m5::In_I2C)
: I2C_Device(i2c_addr, freq, i2c)
{}
Expand All @@ -20,10 +26,10 @@ namespace m5
// false input, true output
virtual void setDirection(uint8_t pin, bool direction) = 0;

virtual void enablePull(uint8_t pin, bool enablePull) = 0;

// false down, true up
virtual void setPullMode(uint8_t pin, bool mode) = 0;
/// Set the GPIO pull resistor state.
/// @return true only when the requested state was completely established;
/// false for an invalid pin, mode, or I2C failure.
virtual bool setPullMode(uint8_t pin, gpio_pull_t mode) = 0;

virtual void setHighImpedance(uint8_t pin, bool enable) = 0;

Expand Down
34 changes: 16 additions & 18 deletions src/utility/M5IOE1_Class.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,29 +48,27 @@ namespace m5
direction ? bitOn(reg, bit) : bitOff(reg, bit);
}

void M5IOE1_Class::enablePull(uint8_t pin, bool enablePull)
bool M5IOE1_Class::setPullMode(uint8_t pin, gpio_pull_t mode)
{
if (!_isValidPin(pin)) { return; }
if (!_isValidPin(pin)) { return false; }
const auto pu_reg = _regForPin(M5IOE1_REG_GPIO_PU_L, pin);
const auto pd_reg = _regForPin(M5IOE1_REG_GPIO_PD_L, pin);
const auto bit = _bitForPin(pin);
if (enablePull) {
bitOn(pu_reg, bit);
} else {
bitOff(pu_reg, bit);
bitOff(pd_reg, bit);
switch (mode) {
case pull_none: {
const bool pu_ok = bitOff(pu_reg, bit);
const bool pd_ok = bitOff(pd_reg, bit);
return pu_ok && pd_ok;
}
case pull_up:
if (!bitOff(pd_reg, bit)) { return false; }
return bitOn(pu_reg, bit);
case pull_down:
if (!bitOff(pu_reg, bit)) { return false; }
return bitOn(pd_reg, bit);
default:
return false;
}
}

void M5IOE1_Class::setPullMode(uint8_t pin, bool mode)
{
if (!_isValidPin(pin)) { return; }
const auto pu_reg = _regForPin(M5IOE1_REG_GPIO_PU_L, pin);
const auto pd_reg = _regForPin(M5IOE1_REG_GPIO_PD_L, pin);
const auto bit = _bitForPin(pin);
// false=pull-down, true=pull-up.
mode ? bitOn(pu_reg, bit) : bitOff(pu_reg, bit);
mode ? bitOff(pd_reg, bit) : bitOn(pd_reg, bit);
}

void M5IOE1_Class::setHighImpedance(uint8_t pin, bool enable)
Expand Down
4 changes: 1 addition & 3 deletions src/utility/M5IOE1_Class.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ namespace m5

void setDirection(uint8_t pin, bool direction) override;

void enablePull(uint8_t pin, bool enablePull) override;

void setPullMode(uint8_t pin, bool mode) override;
bool setPullMode(uint8_t pin, gpio_pull_t mode) override;

void setHighImpedance(uint8_t pin, bool enable) override;

Expand Down
29 changes: 14 additions & 15 deletions src/utility/PI4IOE5V6408_Class.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,21 @@ void PI4IOE5V6408_Class::setDirection(uint8_t pin, bool direction)
}
}

void PI4IOE5V6408_Class::enablePull(uint8_t pin, bool enablePull)
bool PI4IOE5V6408_Class::setPullMode(uint8_t pin, gpio_pull_t mode)
{
if (enablePull) {
bitOn(0x0B, 1 << pin);
} else {
bitOff(0x0B, 1 << pin);
}
}

// false down, true up
void PI4IOE5V6408_Class::setPullMode(uint8_t pin, bool mode)
{
if (mode) {
bitOn(0x0D, 1 << pin);
} else {
bitOff(0x0D, 1 << pin);
if (pin >= 8) return false;
const auto bit = 1 << pin;
switch (mode) {
case pull_none:
return bitOff(0x0B, bit);
case pull_up:
if (!bitOn(0x0D, bit)) { return false; }
return bitOn(0x0B, bit);
case pull_down:
if (!bitOff(0x0D, bit)) { return false; }
return bitOn(0x0B, bit);
default:
return false;
}
}

Expand Down
5 changes: 1 addition & 4 deletions src/utility/PI4IOE5V6408_Class.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,7 @@ namespace m5
// false input, true output
void setDirection(uint8_t pin, bool direction) override;

void enablePull(uint8_t pin, bool enablePull) override;

// false down, true up
void setPullMode(uint8_t pin, bool mode) override;
bool setPullMode(uint8_t pin, gpio_pull_t mode) override;

void setHighImpedance(uint8_t pin, bool enable) override;

Expand Down
12 changes: 6 additions & 6 deletions src/utility/Power_Class.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ namespace m5
auto& ioe1 = M5.getIOExpander(0);
ioe1.setDirection(M5IOE1_Class::gpio1, false);
ioe1.setHighImpedance(M5IOE1_Class::gpio1, true);
ioe1.enablePull(M5IOE1_Class::gpio1, false);
ioe1.setPullMode(M5IOE1_Class::gpio1, IOExpander_Base::pull_none);
ioe1.setDirection(M5IOE1_Class::gpio3, false);
}
M5pm1.setBatteryCharge(true);
Expand Down Expand Up @@ -465,7 +465,7 @@ namespace m5
auto& ioe1 = M5.getIOExpander(0);
// M5IOE1_G3 -- Charge Status
ioe1.setDirection(M5IOE1_Class::gpio3, false);
ioe1.enablePull(M5IOE1_Class::gpio3, false);
ioe1.setPullMode(M5IOE1_Class::gpio3, IOExpander_Base::pull_none);
// M5IOE1_G4 -- Boost Control
ioe1.setHighImpedance(M5IOE1_Class::gpio4, false);
ioe1.setDirection(M5IOE1_Class::gpio4, true);
Expand Down Expand Up @@ -874,13 +874,13 @@ namespace m5
if (port_mask & ext_port_mask_t::ext_PA)
{
auto& ioe = M5.getIOExpander(0);
ioe.setPullMode(2, enable);
ioe.setPullMode(2, enable ? IOExpander_Base::pull_up : IOExpander_Base::pull_down);
ioe.digitalWrite(2, enable);
}
if (port_mask & ext_port_mask_t::ext_USB)
{
auto& ioe = M5.getIOExpander(1);
ioe.setPullMode(3, enable);
ioe.setPullMode(3, enable ? IOExpander_Base::pull_up : IOExpander_Base::pull_down);
ioe.digitalWrite(3, enable);
}
break;
Expand Down Expand Up @@ -2331,14 +2331,14 @@ namespace m5
auto& ioe1 = M5.getIOExpander(0);
if (max_mA >= 650)
{
ioe1.enablePull(M5IOE1_Class::gpio3, false);
ioe1.setPullMode(M5IOE1_Class::gpio3, IOExpander_Base::pull_none);
ioe1.digitalWrite(M5IOE1_Class::gpio3, false);
ioe1.setHighImpedance(M5IOE1_Class::gpio3, false);
ioe1.setDirection(M5IOE1_Class::gpio3, true);
}
else
{
ioe1.enablePull(M5IOE1_Class::gpio3, false);
ioe1.setPullMode(M5IOE1_Class::gpio3, IOExpander_Base::pull_none);
ioe1.setDirection(M5IOE1_Class::gpio3, false);
}
}
Expand Down
Loading