ssam_irq_setup(9)

📦 version 7.3.1, in nixpkgs unstable

💖 NAME 💖

okay so this page is ssam_irq_setup, and it comes to you straight from the Kernel API Manual. bestie, it sets up the SAM EC wakeup-GPIO interrupt. that's the whole name, no cap. ✨

⚡ SYNOPSIS ⚡

int ssam_irq_setup (struct ssam_controller *ctrl );

🎀 ARGUMENTS 🎀

  • ctrl — the controller for which the IRQ should be set up. that's the one, bestie. 🫶

🦋 DESCRIPTION 🦋

okay so picture this: ssam_irq_setup sets up an IRQ for the wakeup-GPIO pin of the SAM EC. this IRQ can be used to wake the device from a low power state. it's giving “sleepy device, but make it wake-up-able.” 💤➡️👑

big caveat though, bestie: this IRQ can only be triggered while the EC is in the display-off state. and in this state, events are not sent to the host in the usual way. instead, the wakeup-GPIO gets pulled to "high" as long as there are pending events, and those events need to be released one-by-one via the GPIO callback request — either until there are no events left and the GPIO is reset, or all at once by transitioning the EC out of the display-off state, which will also clear the GPIO. 🫶✨

not all events should trigger a full system wakeup, though. instead, the driver should — if necessary — inspect and forward each event to the corresponding subsystem, which in turn should decide if the system needs to be woken up. this logic has not been implemented yet, so wakeup by this IRQ should be disabled by default to avoid spurious wake-ups, caused, for example, by the remaining battery percentage changing. refer to comments in this function and comments in the corresponding IRQ handler for more details on how this should be implemented. 👀💅

also: see also ssam_ctrl_notif_display_off and ssam_ctrl_notif_display_off for functions to transition the EC into and out of the display-off state as well as more details on it. yes, the page really lists that same one twice — i'm just keeping the facts, no cap. 🫠

the IRQ is disabled by default and has to be enabled before it can wake up the device from suspend via ssam_irq_arm_for_wakeup. on teardown, the IRQ should be freed via ssam_irq_free. 🧹💖

🌈 SEE ALSO 🌈

psst — kernel file incoming, plus the whole extended friend group of references. every single one is here, bestie. 💜

Kernel file: ./drivers/platform/surface/aggregator/controller.c

kiss kiss 💋, this lil rewrite is signed off from the source/version line ./drivers/platform/surface/agg... and the date October 2026, with the page name ssam_irq_setup(9) still living its best life. 🫶🎀

📦 where this page comes from