1 // SPDX-License-Identifier: GPL-2.0
2 /* Device wakeirq helper functions */
3 #include <linux/device.h>
4 #include <linux/interrupt.h>
6 #include <linux/slab.h>
7 #include <linux/pm_runtime.h>
8 #include <linux/pm_wakeirq.h>
13 * dev_pm_attach_wake_irq - Attach device interrupt as a wake IRQ
15 * @irq: Device wake-up capable interrupt
16 * @wirq: Wake irq specific data
18 * Internal function to attach either a device IO interrupt or a
19 * dedicated wake-up interrupt as a wake IRQ.
21 static int dev_pm_attach_wake_irq(struct device *dev, int irq,
22 struct wake_irq *wirq)
29 spin_lock_irqsave(&dev->power.lock, flags);
30 if (dev_WARN_ONCE(dev, dev->power.wakeirq,
31 "wake irq already initialized\n")) {
32 spin_unlock_irqrestore(&dev->power.lock, flags);
36 dev->power.wakeirq = wirq;
37 device_wakeup_attach_irq(dev, wirq);
39 spin_unlock_irqrestore(&dev->power.lock, flags);
44 * dev_pm_set_wake_irq - Attach device IO interrupt as wake IRQ
46 * @irq: Device IO interrupt
48 * Attach a device IO interrupt as a wake IRQ. The wake IRQ gets
49 * automatically configured for wake-up from suspend based
50 * on the device specific sysfs wakeup entry. Typically called
51 * during driver probe after calling device_init_wakeup().
53 int dev_pm_set_wake_irq(struct device *dev, int irq)
55 struct wake_irq *wirq;
61 wirq = kzalloc(sizeof(*wirq), GFP_KERNEL);
68 err = dev_pm_attach_wake_irq(dev, irq, wirq);
74 EXPORT_SYMBOL_GPL(dev_pm_set_wake_irq);
77 * dev_pm_clear_wake_irq - Detach a device IO interrupt wake IRQ
80 * Detach a device wake IRQ and free resources.
82 * Note that it's OK for drivers to call this without calling
83 * dev_pm_set_wake_irq() as all the driver instances may not have
84 * a wake IRQ configured. This avoid adding wake IRQ specific
85 * checks into the drivers.
87 void dev_pm_clear_wake_irq(struct device *dev)
89 struct wake_irq *wirq = dev->power.wakeirq;
95 spin_lock_irqsave(&dev->power.lock, flags);
96 device_wakeup_detach_irq(dev);
97 dev->power.wakeirq = NULL;
98 spin_unlock_irqrestore(&dev->power.lock, flags);
100 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED) {
101 free_irq(wirq->irq, wirq);
102 wirq->status &= ~WAKE_IRQ_DEDICATED_MASK;
107 EXPORT_SYMBOL_GPL(dev_pm_clear_wake_irq);
110 * handle_threaded_wake_irq - Handler for dedicated wake-up interrupts
111 * @irq: Device specific dedicated wake-up interrupt
112 * @_wirq: Wake IRQ data
114 * Some devices have a separate wake-up interrupt in addition to the
115 * device IO interrupt. The wake-up interrupt signals that a device
116 * should be woken up from it's idle state. This handler uses device
117 * specific pm_runtime functions to wake the device, and then it's
118 * up to the device to do whatever it needs to. Note that as the
119 * device may need to restore context and start up regulators, we
120 * use a threaded IRQ.
122 * Also note that we are not resending the lost device interrupts.
123 * We assume that the wake-up interrupt just needs to wake-up the
124 * device, and then device's pm_runtime_resume() can deal with the
127 static irqreturn_t handle_threaded_wake_irq(int irq, void *_wirq)
129 struct wake_irq *wirq = _wirq;
132 /* Maybe abort suspend? */
133 if (irqd_is_wakeup_set(irq_get_irq_data(irq))) {
134 pm_wakeup_event(wirq->dev, 0);
139 /* We don't want RPM_ASYNC or RPM_NOWAIT here */
140 res = pm_runtime_resume(wirq->dev);
143 "wake IRQ with no resume: %i\n", res);
148 static int __dev_pm_set_dedicated_wake_irq(struct device *dev, int irq, unsigned int flag)
150 struct wake_irq *wirq;
156 wirq = kzalloc(sizeof(*wirq), GFP_KERNEL);
160 wirq->name = kasprintf(GFP_KERNEL, "%s:wakeup", dev_name(dev));
168 irq_set_status_flags(irq, IRQ_NOAUTOEN);
170 /* Prevent deferred spurious wakeirqs with disable_irq_nosync() */
171 irq_set_status_flags(irq, IRQ_DISABLE_UNLAZY);
174 * Consumer device may need to power up and restore state
175 * so we use a threaded irq.
177 err = request_threaded_irq(irq, NULL, handle_threaded_wake_irq,
178 IRQF_ONESHOT, wirq->name, wirq);
182 err = dev_pm_attach_wake_irq(dev, irq, wirq);
186 wirq->status = WAKE_IRQ_DEDICATED_ALLOCATED | flag;
202 * dev_pm_set_dedicated_wake_irq - Request a dedicated wake-up interrupt
204 * @irq: Device wake-up interrupt
206 * Unless your hardware has separate wake-up interrupts in addition
207 * to the device IO interrupts, you don't need this.
209 * Sets up a threaded interrupt handler for a device that has
210 * a dedicated wake-up interrupt in addition to the device IO
213 * The interrupt starts disabled, and needs to be managed for
214 * the device by the bus code or the device driver using
215 * dev_pm_enable_wake_irq*() and dev_pm_disable_wake_irq*()
218 int dev_pm_set_dedicated_wake_irq(struct device *dev, int irq)
220 return __dev_pm_set_dedicated_wake_irq(dev, irq, 0);
222 EXPORT_SYMBOL_GPL(dev_pm_set_dedicated_wake_irq);
225 * dev_pm_set_dedicated_wake_irq_reverse - Request a dedicated wake-up interrupt
226 * with reverse enable ordering
228 * @irq: Device wake-up interrupt
230 * Unless your hardware has separate wake-up interrupts in addition
231 * to the device IO interrupts, you don't need this.
233 * Sets up a threaded interrupt handler for a device that has a dedicated
234 * wake-up interrupt in addition to the device IO interrupt. It sets
235 * the status of WAKE_IRQ_DEDICATED_REVERSE to tell rpm_suspend()
236 * to enable dedicated wake-up interrupt after running the runtime suspend
239 * The interrupt starts disabled, and needs to be managed for
240 * the device by the bus code or the device driver using
241 * dev_pm_enable_wake_irq*() and dev_pm_disable_wake_irq*()
244 int dev_pm_set_dedicated_wake_irq_reverse(struct device *dev, int irq)
246 return __dev_pm_set_dedicated_wake_irq(dev, irq, WAKE_IRQ_DEDICATED_REVERSE);
248 EXPORT_SYMBOL_GPL(dev_pm_set_dedicated_wake_irq_reverse);
251 * dev_pm_enable_wake_irq - Enable device wake-up interrupt
254 * Optionally called from the bus code or the device driver for
255 * runtime_resume() to override the PM runtime core managed wake-up
256 * interrupt handling to enable the wake-up interrupt.
258 * Note that for runtime_suspend()) the wake-up interrupts
259 * should be unconditionally enabled unlike for suspend()
260 * that is conditional.
262 void dev_pm_enable_wake_irq(struct device *dev)
264 struct wake_irq *wirq = dev->power.wakeirq;
266 if (wirq && (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED))
267 enable_irq(wirq->irq);
269 EXPORT_SYMBOL_GPL(dev_pm_enable_wake_irq);
272 * dev_pm_disable_wake_irq - Disable device wake-up interrupt
275 * Optionally called from the bus code or the device driver for
276 * runtime_suspend() to override the PM runtime core managed wake-up
277 * interrupt handling to disable the wake-up interrupt.
279 void dev_pm_disable_wake_irq(struct device *dev)
281 struct wake_irq *wirq = dev->power.wakeirq;
283 if (wirq && (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED))
284 disable_irq_nosync(wirq->irq);
286 EXPORT_SYMBOL_GPL(dev_pm_disable_wake_irq);
289 * dev_pm_enable_wake_irq_check - Checks and enables wake-up interrupt
291 * @can_change_status: Can change wake-up interrupt status
293 * Enables wakeirq conditionally. We need to enable wake-up interrupt
294 * lazily on the first rpm_suspend(). This is needed as the consumer device
295 * starts in RPM_SUSPENDED state, and the the first pm_runtime_get() would
296 * otherwise try to disable already disabled wakeirq. The wake-up interrupt
297 * starts disabled with IRQ_NOAUTOEN set.
299 * Should be only called from rpm_suspend() and rpm_resume() path.
300 * Caller must hold &dev->power.lock to change wirq->status
302 void dev_pm_enable_wake_irq_check(struct device *dev,
303 bool can_change_status)
305 struct wake_irq *wirq = dev->power.wakeirq;
307 if (!wirq || !(wirq->status & WAKE_IRQ_DEDICATED_MASK))
310 if (likely(wirq->status & WAKE_IRQ_DEDICATED_MANAGED)) {
312 } else if (can_change_status) {
313 wirq->status |= WAKE_IRQ_DEDICATED_MANAGED;
320 if (!can_change_status || !(wirq->status & WAKE_IRQ_DEDICATED_REVERSE)) {
321 enable_irq(wirq->irq);
322 wirq->status |= WAKE_IRQ_DEDICATED_ENABLED;
327 * dev_pm_disable_wake_irq_check - Checks and disables wake-up interrupt
329 * @cond_disable: if set, also check WAKE_IRQ_DEDICATED_REVERSE
331 * Disables wake-up interrupt conditionally based on status.
332 * Should be only called from rpm_suspend() and rpm_resume() path.
334 void dev_pm_disable_wake_irq_check(struct device *dev, bool cond_disable)
336 struct wake_irq *wirq = dev->power.wakeirq;
338 if (!wirq || !(wirq->status & WAKE_IRQ_DEDICATED_MASK))
341 if (cond_disable && (wirq->status & WAKE_IRQ_DEDICATED_REVERSE))
344 if (wirq->status & WAKE_IRQ_DEDICATED_MANAGED) {
345 wirq->status &= ~WAKE_IRQ_DEDICATED_ENABLED;
346 disable_irq_nosync(wirq->irq);
351 * dev_pm_enable_wake_irq_complete - enable wake IRQ not enabled before
352 * @dev: Device using the wake IRQ
354 * Enable wake IRQ conditionally based on status, mainly used if want to
355 * enable wake IRQ after running ->runtime_suspend() which depends on
356 * WAKE_IRQ_DEDICATED_REVERSE.
358 * Should be only called from rpm_suspend() path.
360 void dev_pm_enable_wake_irq_complete(struct device *dev)
362 struct wake_irq *wirq = dev->power.wakeirq;
364 if (!wirq || !(wirq->status & WAKE_IRQ_DEDICATED_MASK))
367 if (wirq->status & WAKE_IRQ_DEDICATED_MANAGED &&
368 wirq->status & WAKE_IRQ_DEDICATED_REVERSE) {
369 enable_irq(wirq->irq);
370 wirq->status |= WAKE_IRQ_DEDICATED_ENABLED;
375 * dev_pm_arm_wake_irq - Arm device wake-up
376 * @wirq: Device wake-up interrupt
378 * Sets up the wake-up event conditionally based on the
381 void dev_pm_arm_wake_irq(struct wake_irq *wirq)
386 if (device_may_wakeup(wirq->dev)) {
387 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED &&
388 !(wirq->status & WAKE_IRQ_DEDICATED_ENABLED))
389 enable_irq(wirq->irq);
391 enable_irq_wake(wirq->irq);
396 * dev_pm_disarm_wake_irq - Disarm device wake-up
397 * @wirq: Device wake-up interrupt
399 * Clears up the wake-up event conditionally based on the
402 void dev_pm_disarm_wake_irq(struct wake_irq *wirq)
407 if (device_may_wakeup(wirq->dev)) {
408 disable_irq_wake(wirq->irq);
410 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED &&
411 !(wirq->status & WAKE_IRQ_DEDICATED_ENABLED))
412 disable_irq_nosync(wirq->irq);