Skip to content

WIP: rp2: Make GPIO wakeup from lightsleep consistent. #16442

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.

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

projectgus
Copy link
Contributor

@projectgus projectgus commented Dec 18, 2024

Summary

Make the Pin.irq() wakeup behaviour more consistent on rp2. Closes #7035 and partial fix for #16180

Goal is that any pin which has Pin.irq() and a trigger set will wake rp2 port from any machine.lightsleep() call.

Details

Currently:

  • A Pin with an irq() trigger is a wakeup source only when machine.lightsleep(n) is used with a timeout, and only if an IRQ handler is set.

After this PR:

  • A Pin with an irq() trigger is a wakeup source from both indefinite machine.lightsleep() and machine.lightsleep(n) with a timeout.

  • A Pin with an irq() trigger is a wakeup source even if no handler function is set.

TODOs

  • Waking RP2040 repeatedly from machine.lightsleep() with no timeout and USB causes the USB connection to misbehave and eventually the CPU hangs. This is the same thing fixed for lightsleep with a timeout in rp2: Selectively leave the USB clocks enabled in light sleep. #15111 and rp2: Fix USB PLL glitch during wake from light sleep. #15301 . However, with no timeout argument the RP2 goes to the lower power "DORMANT" mode so keeping USB clock running isn't an option. Calling tud_disconnect()/tud_connect() or tud_deinit()/tud_init() before and after going to dormant mode doesn't seem to be enough to fix this. One heavy-handed workaround would be to not select DORMANT if USB is enabled, just call WFI instead. However, then the wakeup conditions are a lot different which may be confusing if developing and testing via USB and then deploying...
  • Test on RP2350. I have hardware coming, otherwise help is welcome.
  • This implementation doesn't match the machine.Pin docs re: irq(wake=) argument. However, I think only cc3200 port has actually implemented this argument as documented, so the fix here might be to make the docs match the current reality rather than the other way around.

This work was funded through GitHub Sponsors.

Testing

  • TBD

Trade-offs and Alternatives

  • It seems like machine.lightsleep() has had very limited utility until now (i.e. no possible wake source?) so maybe we should refactor to only use DORMANT mode for deep sleep where we don't have to worry about recovering the USB peripheral. Keeping clocks running does increase consumption, though.

Before this commit:

- A Pin with an irq() trigger is a wakeup source only when
  machine.lightsleep(n) is used with a timeout, and only if an IRQ handler
  is set.

After this commit:

- A Pin with an irq() trigger is a wakeup source from both
  indefinite machine.lightsleep() and machine.lightsleep(n) with
  a timeout.

- A Pin with an irq() trigger is a wakeup source even if no handler
  function is set.

Issues at present:

- Waking RP2040 repeatedly from machine.lightsleep() with no timeout and
  USB causes the USB connection to misbehave and eventually the CPU hangs.

- This implementation doesn't match the machine.Pin docs re: irq(wake=)
  argument. However, I think only cc3200 port has actually implemented
  this argument as documented.

This work was funded through GitHub Sponsors.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
Copy link

Code size report:

   bare-arm:    +0 +0.000% 
minimal x86:    +0 +0.000% 
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:   +24 +0.003% RPI_PICO_W
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS
  qemu rv32:    +0 +0.000% VIRT_RV32

@Gadgetoid
Copy link
Contributor

Just ran afoul of this while testing #16454 so I'm dropping a cross reference in for posterity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rp2: Can't wake from lightsleep with Pin IRQ
2 participants