2 * wakeirq.c - Device wakeirq helper functions
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This program is distributed "as is" WITHOUT ANY WARRANTY of any
9 * kind, whether express or implied; without even the implied warranty
10 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/device.h>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/slab.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/pm_wakeirq.h>
24 * dev_pm_attach_wake_irq - Attach device interrupt as a wake IRQ
26 * @irq: Device wake-up capable interrupt
27 * @wirq: Wake irq specific data
29 * Internal function to attach either a device IO interrupt or a
30 * dedicated wake-up interrupt as a wake IRQ.
32 static int dev_pm_attach_wake_irq(struct device *dev, int irq,
33 struct wake_irq *wirq)
41 spin_lock_irqsave(&dev->power.lock, flags);
42 if (dev_WARN_ONCE(dev, dev->power.wakeirq,
43 "wake irq already initialized\n")) {
44 spin_unlock_irqrestore(&dev->power.lock, flags);
48 err = device_wakeup_attach_irq(dev, wirq);
50 dev->power.wakeirq = wirq;
52 spin_unlock_irqrestore(&dev->power.lock, flags);
57 * dev_pm_set_wake_irq - Attach device IO interrupt as wake IRQ
59 * @irq: Device IO interrupt
61 * Attach a device IO interrupt as a wake IRQ. The wake IRQ gets
62 * automatically configured for wake-up from suspend based
63 * on the device specific sysfs wakeup entry. Typically called
64 * during driver probe after calling device_init_wakeup().
66 int dev_pm_set_wake_irq(struct device *dev, int irq)
68 struct wake_irq *wirq;
74 wirq = kzalloc(sizeof(*wirq), GFP_KERNEL);
81 err = dev_pm_attach_wake_irq(dev, irq, wirq);
87 EXPORT_SYMBOL_GPL(dev_pm_set_wake_irq);
90 * dev_pm_clear_wake_irq - Detach a device IO interrupt wake IRQ
93 * Detach a device wake IRQ and free resources.
95 * Note that it's OK for drivers to call this without calling
96 * dev_pm_set_wake_irq() as all the driver instances may not have
97 * a wake IRQ configured. This avoid adding wake IRQ specific
98 * checks into the drivers.
100 void dev_pm_clear_wake_irq(struct device *dev)
102 struct wake_irq *wirq = dev->power.wakeirq;
108 spin_lock_irqsave(&dev->power.lock, flags);
109 device_wakeup_detach_irq(dev);
110 dev->power.wakeirq = NULL;
111 spin_unlock_irqrestore(&dev->power.lock, flags);
113 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED) {
114 free_irq(wirq->irq, wirq);
115 wirq->status &= ~WAKE_IRQ_DEDICATED_MASK;
119 EXPORT_SYMBOL_GPL(dev_pm_clear_wake_irq);
122 * handle_threaded_wake_irq - Handler for dedicated wake-up interrupts
123 * @irq: Device specific dedicated wake-up interrupt
124 * @_wirq: Wake IRQ data
126 * Some devices have a separate wake-up interrupt in addition to the
127 * device IO interrupt. The wake-up interrupt signals that a device
128 * should be woken up from it's idle state. This handler uses device
129 * specific pm_runtime functions to wake the device, and then it's
130 * up to the device to do whatever it needs to. Note that as the
131 * device may need to restore context and start up regulators, we
132 * use a threaded IRQ.
134 * Also note that we are not resending the lost device interrupts.
135 * We assume that the wake-up interrupt just needs to wake-up the
136 * device, and then device's pm_runtime_resume() can deal with the
139 static irqreturn_t handle_threaded_wake_irq(int irq, void *_wirq)
141 struct wake_irq *wirq = _wirq;
144 /* Maybe abort suspend? */
145 if (irqd_is_wakeup_set(irq_get_irq_data(irq))) {
146 pm_wakeup_event(wirq->dev, 0);
151 /* We don't want RPM_ASYNC or RPM_NOWAIT here */
152 res = pm_runtime_resume(wirq->dev);
155 "wake IRQ with no resume: %i\n", res);
161 * dev_pm_set_dedicated_wake_irq - Request a dedicated wake-up interrupt
163 * @irq: Device wake-up interrupt
165 * Unless your hardware has separate wake-up interrupts in addition
166 * to the device IO interrupts, you don't need this.
168 * Sets up a threaded interrupt handler for a device that has
169 * a dedicated wake-up interrupt in addition to the device IO
172 * The interrupt starts disabled, and needs to be managed for
173 * the device by the bus code or the device driver using
174 * dev_pm_enable_wake_irq() and dev_pm_disable_wake_irq()
177 int dev_pm_set_dedicated_wake_irq(struct device *dev, int irq)
179 struct wake_irq *wirq;
185 wirq = kzalloc(sizeof(*wirq), GFP_KERNEL);
191 irq_set_status_flags(irq, IRQ_NOAUTOEN);
194 * Consumer device may need to power up and restore state
195 * so we use a threaded irq.
197 err = request_threaded_irq(irq, NULL, handle_threaded_wake_irq,
198 IRQF_ONESHOT, dev_name(dev), wirq);
202 err = dev_pm_attach_wake_irq(dev, irq, wirq);
206 wirq->status = WAKE_IRQ_DEDICATED_ALLOCATED;
217 EXPORT_SYMBOL_GPL(dev_pm_set_dedicated_wake_irq);
220 * dev_pm_enable_wake_irq - Enable device wake-up interrupt
223 * Optionally called from the bus code or the device driver for
224 * runtime_resume() to override the PM runtime core managed wake-up
225 * interrupt handling to enable the wake-up interrupt.
227 * Note that for runtime_suspend()) the wake-up interrupts
228 * should be unconditionally enabled unlike for suspend()
229 * that is conditional.
231 void dev_pm_enable_wake_irq(struct device *dev)
233 struct wake_irq *wirq = dev->power.wakeirq;
235 if (wirq && (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED))
236 enable_irq(wirq->irq);
238 EXPORT_SYMBOL_GPL(dev_pm_enable_wake_irq);
241 * dev_pm_disable_wake_irq - Disable device wake-up interrupt
244 * Optionally called from the bus code or the device driver for
245 * runtime_suspend() to override the PM runtime core managed wake-up
246 * interrupt handling to disable the wake-up interrupt.
248 void dev_pm_disable_wake_irq(struct device *dev)
250 struct wake_irq *wirq = dev->power.wakeirq;
252 if (wirq && (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED))
253 disable_irq_nosync(wirq->irq);
255 EXPORT_SYMBOL_GPL(dev_pm_disable_wake_irq);
258 * dev_pm_enable_wake_irq_check - Checks and enables wake-up interrupt
260 * @can_change_status: Can change wake-up interrupt status
262 * Enables wakeirq conditionally. We need to enable wake-up interrupt
263 * lazily on the first rpm_suspend(). This is needed as the consumer device
264 * starts in RPM_SUSPENDED state, and the the first pm_runtime_get() would
265 * otherwise try to disable already disabled wakeirq. The wake-up interrupt
266 * starts disabled with IRQ_NOAUTOEN set.
268 * Should be only called from rpm_suspend() and rpm_resume() path.
269 * Caller must hold &dev->power.lock to change wirq->status
271 void dev_pm_enable_wake_irq_check(struct device *dev,
272 bool can_change_status)
274 struct wake_irq *wirq = dev->power.wakeirq;
276 if (!wirq || !((wirq->status & WAKE_IRQ_DEDICATED_MASK)))
279 if (likely(wirq->status & WAKE_IRQ_DEDICATED_MANAGED)) {
281 } else if (can_change_status) {
282 wirq->status |= WAKE_IRQ_DEDICATED_MANAGED;
289 enable_irq(wirq->irq);
293 * dev_pm_disable_wake_irq_check - Checks and disables wake-up interrupt
296 * Disables wake-up interrupt conditionally based on status.
297 * Should be only called from rpm_suspend() and rpm_resume() path.
299 void dev_pm_disable_wake_irq_check(struct device *dev)
301 struct wake_irq *wirq = dev->power.wakeirq;
303 if (!wirq || !((wirq->status & WAKE_IRQ_DEDICATED_MASK)))
306 if (wirq->status & WAKE_IRQ_DEDICATED_MANAGED)
307 disable_irq_nosync(wirq->irq);
311 * dev_pm_arm_wake_irq - Arm device wake-up
312 * @wirq: Device wake-up interrupt
314 * Sets up the wake-up event conditionally based on the
317 void dev_pm_arm_wake_irq(struct wake_irq *wirq)
322 if (device_may_wakeup(wirq->dev)) {
323 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED &&
324 !pm_runtime_status_suspended(wirq->dev))
325 enable_irq(wirq->irq);
327 enable_irq_wake(wirq->irq);
332 * dev_pm_disarm_wake_irq - Disarm device wake-up
333 * @wirq: Device wake-up interrupt
335 * Clears up the wake-up event conditionally based on the
338 void dev_pm_disarm_wake_irq(struct wake_irq *wirq)
343 if (device_may_wakeup(wirq->dev)) {
344 disable_irq_wake(wirq->irq);
346 if (wirq->status & WAKE_IRQ_DEDICATED_ALLOCATED &&
347 !pm_runtime_status_suspended(wirq->dev))
348 disable_irq_nosync(wirq->irq);