Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * drivers/base/power/generic_ops.c - Generic PM callbacks for subsystems
4 *
5 * Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
6 */
7#include <linux/pm.h>
8#include <linux/pm_runtime.h>
9#include <linux/export.h>
10
11#ifdef CONFIG_PM
12/**
13 * pm_generic_runtime_suspend - Generic runtime suspend callback for subsystems.
14 * @dev: Device to suspend.
15 *
16 * If PM operations are defined for the @dev's driver and they include
17 * ->runtime_suspend(), execute it and return its error code. Otherwise,
18 * return 0.
19 */
20int pm_generic_runtime_suspend(struct device *dev)
21{
22 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
23 int ret;
24
25 ret = pm && pm->runtime_suspend ? pm->runtime_suspend(dev) : 0;
26
27 return ret;
28}
29EXPORT_SYMBOL_GPL(pm_generic_runtime_suspend);
30
31/**
32 * pm_generic_runtime_resume - Generic runtime resume callback for subsystems.
33 * @dev: Device to resume.
34 *
35 * If PM operations are defined for the @dev's driver and they include
36 * ->runtime_resume(), execute it and return its error code. Otherwise,
37 * return 0.
38 */
39int pm_generic_runtime_resume(struct device *dev)
40{
41 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
42 int ret;
43
44 ret = pm && pm->runtime_resume ? pm->runtime_resume(dev) : 0;
45
46 return ret;
47}
48EXPORT_SYMBOL_GPL(pm_generic_runtime_resume);
49#endif /* CONFIG_PM */
50
51#ifdef CONFIG_PM_SLEEP
52/**
53 * pm_generic_prepare - Generic routine preparing a device for power transition.
54 * @dev: Device to prepare.
55 *
56 * Prepare a device for a system-wide power transition.
57 */
58int pm_generic_prepare(struct device *dev)
59{
60 struct device_driver *drv = dev->driver;
61 int ret = 0;
62
63 if (drv && drv->pm && drv->pm->prepare)
64 ret = drv->pm->prepare(dev);
65
66 return ret;
67}
68
69/**
70 * pm_generic_suspend_noirq - Generic suspend_noirq callback for subsystems.
71 * @dev: Device to suspend.
72 */
73int pm_generic_suspend_noirq(struct device *dev)
74{
75 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
76
77 return pm && pm->suspend_noirq ? pm->suspend_noirq(dev) : 0;
78}
79EXPORT_SYMBOL_GPL(pm_generic_suspend_noirq);
80
81/**
82 * pm_generic_suspend_late - Generic suspend_late callback for subsystems.
83 * @dev: Device to suspend.
84 */
85int pm_generic_suspend_late(struct device *dev)
86{
87 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
88
89 return pm && pm->suspend_late ? pm->suspend_late(dev) : 0;
90}
91EXPORT_SYMBOL_GPL(pm_generic_suspend_late);
92
93/**
94 * pm_generic_suspend - Generic suspend callback for subsystems.
95 * @dev: Device to suspend.
96 */
97int pm_generic_suspend(struct device *dev)
98{
99 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
100
101 return pm && pm->suspend ? pm->suspend(dev) : 0;
102}
103EXPORT_SYMBOL_GPL(pm_generic_suspend);
104
105/**
106 * pm_generic_freeze_noirq - Generic freeze_noirq callback for subsystems.
107 * @dev: Device to freeze.
108 */
109int pm_generic_freeze_noirq(struct device *dev)
110{
111 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
112
113 return pm && pm->freeze_noirq ? pm->freeze_noirq(dev) : 0;
114}
115EXPORT_SYMBOL_GPL(pm_generic_freeze_noirq);
116
117/**
118 * pm_generic_freeze_late - Generic freeze_late callback for subsystems.
119 * @dev: Device to freeze.
120 */
121int pm_generic_freeze_late(struct device *dev)
122{
123 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
124
125 return pm && pm->freeze_late ? pm->freeze_late(dev) : 0;
126}
127EXPORT_SYMBOL_GPL(pm_generic_freeze_late);
128
129/**
130 * pm_generic_freeze - Generic freeze callback for subsystems.
131 * @dev: Device to freeze.
132 */
133int pm_generic_freeze(struct device *dev)
134{
135 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
136
137 return pm && pm->freeze ? pm->freeze(dev) : 0;
138}
139EXPORT_SYMBOL_GPL(pm_generic_freeze);
140
141/**
142 * pm_generic_poweroff_noirq - Generic poweroff_noirq callback for subsystems.
143 * @dev: Device to handle.
144 */
145int pm_generic_poweroff_noirq(struct device *dev)
146{
147 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
148
149 return pm && pm->poweroff_noirq ? pm->poweroff_noirq(dev) : 0;
150}
151EXPORT_SYMBOL_GPL(pm_generic_poweroff_noirq);
152
153/**
154 * pm_generic_poweroff_late - Generic poweroff_late callback for subsystems.
155 * @dev: Device to handle.
156 */
157int pm_generic_poweroff_late(struct device *dev)
158{
159 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
160
161 return pm && pm->poweroff_late ? pm->poweroff_late(dev) : 0;
162}
163EXPORT_SYMBOL_GPL(pm_generic_poweroff_late);
164
165/**
166 * pm_generic_poweroff - Generic poweroff callback for subsystems.
167 * @dev: Device to handle.
168 */
169int pm_generic_poweroff(struct device *dev)
170{
171 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
172
173 return pm && pm->poweroff ? pm->poweroff(dev) : 0;
174}
175EXPORT_SYMBOL_GPL(pm_generic_poweroff);
176
177/**
178 * pm_generic_thaw_noirq - Generic thaw_noirq callback for subsystems.
179 * @dev: Device to thaw.
180 */
181int pm_generic_thaw_noirq(struct device *dev)
182{
183 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
184
185 return pm && pm->thaw_noirq ? pm->thaw_noirq(dev) : 0;
186}
187EXPORT_SYMBOL_GPL(pm_generic_thaw_noirq);
188
189/**
190 * pm_generic_thaw_early - Generic thaw_early callback for subsystems.
191 * @dev: Device to thaw.
192 */
193int pm_generic_thaw_early(struct device *dev)
194{
195 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
196
197 return pm && pm->thaw_early ? pm->thaw_early(dev) : 0;
198}
199EXPORT_SYMBOL_GPL(pm_generic_thaw_early);
200
201/**
202 * pm_generic_thaw - Generic thaw callback for subsystems.
203 * @dev: Device to thaw.
204 */
205int pm_generic_thaw(struct device *dev)
206{
207 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
208
209 return pm && pm->thaw ? pm->thaw(dev) : 0;
210}
211EXPORT_SYMBOL_GPL(pm_generic_thaw);
212
213/**
214 * pm_generic_resume_noirq - Generic resume_noirq callback for subsystems.
215 * @dev: Device to resume.
216 */
217int pm_generic_resume_noirq(struct device *dev)
218{
219 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
220
221 return pm && pm->resume_noirq ? pm->resume_noirq(dev) : 0;
222}
223EXPORT_SYMBOL_GPL(pm_generic_resume_noirq);
224
225/**
226 * pm_generic_resume_early - Generic resume_early callback for subsystems.
227 * @dev: Device to resume.
228 */
229int pm_generic_resume_early(struct device *dev)
230{
231 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
232
233 return pm && pm->resume_early ? pm->resume_early(dev) : 0;
234}
235EXPORT_SYMBOL_GPL(pm_generic_resume_early);
236
237/**
238 * pm_generic_resume - Generic resume callback for subsystems.
239 * @dev: Device to resume.
240 */
241int pm_generic_resume(struct device *dev)
242{
243 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
244
245 return pm && pm->resume ? pm->resume(dev) : 0;
246}
247EXPORT_SYMBOL_GPL(pm_generic_resume);
248
249/**
250 * pm_generic_restore_noirq - Generic restore_noirq callback for subsystems.
251 * @dev: Device to restore.
252 */
253int pm_generic_restore_noirq(struct device *dev)
254{
255 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
256
257 return pm && pm->restore_noirq ? pm->restore_noirq(dev) : 0;
258}
259EXPORT_SYMBOL_GPL(pm_generic_restore_noirq);
260
261/**
262 * pm_generic_restore_early - Generic restore_early callback for subsystems.
263 * @dev: Device to resume.
264 */
265int pm_generic_restore_early(struct device *dev)
266{
267 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
268
269 return pm && pm->restore_early ? pm->restore_early(dev) : 0;
270}
271EXPORT_SYMBOL_GPL(pm_generic_restore_early);
272
273/**
274 * pm_generic_restore - Generic restore callback for subsystems.
275 * @dev: Device to restore.
276 */
277int pm_generic_restore(struct device *dev)
278{
279 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
280
281 return pm && pm->restore ? pm->restore(dev) : 0;
282}
283EXPORT_SYMBOL_GPL(pm_generic_restore);
284
285/**
286 * pm_generic_complete - Generic routine completing a device power transition.
287 * @dev: Device to handle.
288 *
289 * Complete a device power transition during a system-wide power transition.
290 */
291void pm_generic_complete(struct device *dev)
292{
293 struct device_driver *drv = dev->driver;
294
295 if (drv && drv->pm && drv->pm->complete)
296 drv->pm->complete(dev);
297}
298#endif /* CONFIG_PM_SLEEP */
1/*
2 * drivers/base/power/generic_ops.c - Generic PM callbacks for subsystems
3 *
4 * Copyright (c) 2010 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
5 *
6 * This file is released under the GPLv2.
7 */
8
9#include <linux/pm.h>
10#include <linux/pm_runtime.h>
11#include <linux/export.h>
12
13#ifdef CONFIG_PM_RUNTIME
14/**
15 * pm_generic_runtime_idle - Generic runtime idle callback for subsystems.
16 * @dev: Device to handle.
17 *
18 * If PM operations are defined for the @dev's driver and they include
19 * ->runtime_idle(), execute it and return its error code, if nonzero.
20 * Otherwise, execute pm_runtime_suspend() for the device and return 0.
21 */
22int pm_generic_runtime_idle(struct device *dev)
23{
24 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
25
26 if (pm && pm->runtime_idle) {
27 int ret = pm->runtime_idle(dev);
28 if (ret)
29 return ret;
30 }
31
32 pm_runtime_suspend(dev);
33 return 0;
34}
35EXPORT_SYMBOL_GPL(pm_generic_runtime_idle);
36
37/**
38 * pm_generic_runtime_suspend - Generic runtime suspend callback for subsystems.
39 * @dev: Device to suspend.
40 *
41 * If PM operations are defined for the @dev's driver and they include
42 * ->runtime_suspend(), execute it and return its error code. Otherwise,
43 * return 0.
44 */
45int pm_generic_runtime_suspend(struct device *dev)
46{
47 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
48 int ret;
49
50 ret = pm && pm->runtime_suspend ? pm->runtime_suspend(dev) : 0;
51
52 return ret;
53}
54EXPORT_SYMBOL_GPL(pm_generic_runtime_suspend);
55
56/**
57 * pm_generic_runtime_resume - Generic runtime resume callback for subsystems.
58 * @dev: Device to resume.
59 *
60 * If PM operations are defined for the @dev's driver and they include
61 * ->runtime_resume(), execute it and return its error code. Otherwise,
62 * return 0.
63 */
64int pm_generic_runtime_resume(struct device *dev)
65{
66 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
67 int ret;
68
69 ret = pm && pm->runtime_resume ? pm->runtime_resume(dev) : 0;
70
71 return ret;
72}
73EXPORT_SYMBOL_GPL(pm_generic_runtime_resume);
74#endif /* CONFIG_PM_RUNTIME */
75
76#ifdef CONFIG_PM_SLEEP
77/**
78 * pm_generic_prepare - Generic routine preparing a device for power transition.
79 * @dev: Device to prepare.
80 *
81 * Prepare a device for a system-wide power transition.
82 */
83int pm_generic_prepare(struct device *dev)
84{
85 struct device_driver *drv = dev->driver;
86 int ret = 0;
87
88 if (drv && drv->pm && drv->pm->prepare)
89 ret = drv->pm->prepare(dev);
90
91 return ret;
92}
93
94/**
95 * pm_generic_suspend_noirq - Generic suspend_noirq callback for subsystems.
96 * @dev: Device to suspend.
97 */
98int pm_generic_suspend_noirq(struct device *dev)
99{
100 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
101
102 return pm && pm->suspend_noirq ? pm->suspend_noirq(dev) : 0;
103}
104EXPORT_SYMBOL_GPL(pm_generic_suspend_noirq);
105
106/**
107 * pm_generic_suspend_late - Generic suspend_late callback for subsystems.
108 * @dev: Device to suspend.
109 */
110int pm_generic_suspend_late(struct device *dev)
111{
112 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
113
114 return pm && pm->suspend_late ? pm->suspend_late(dev) : 0;
115}
116EXPORT_SYMBOL_GPL(pm_generic_suspend_late);
117
118/**
119 * pm_generic_suspend - Generic suspend callback for subsystems.
120 * @dev: Device to suspend.
121 */
122int pm_generic_suspend(struct device *dev)
123{
124 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
125
126 return pm && pm->suspend ? pm->suspend(dev) : 0;
127}
128EXPORT_SYMBOL_GPL(pm_generic_suspend);
129
130/**
131 * pm_generic_freeze_noirq - Generic freeze_noirq callback for subsystems.
132 * @dev: Device to freeze.
133 */
134int pm_generic_freeze_noirq(struct device *dev)
135{
136 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
137
138 return pm && pm->freeze_noirq ? pm->freeze_noirq(dev) : 0;
139}
140EXPORT_SYMBOL_GPL(pm_generic_freeze_noirq);
141
142/**
143 * pm_generic_freeze_late - Generic freeze_late callback for subsystems.
144 * @dev: Device to freeze.
145 */
146int pm_generic_freeze_late(struct device *dev)
147{
148 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
149
150 return pm && pm->freeze_late ? pm->freeze_late(dev) : 0;
151}
152EXPORT_SYMBOL_GPL(pm_generic_freeze_late);
153
154/**
155 * pm_generic_freeze - Generic freeze callback for subsystems.
156 * @dev: Device to freeze.
157 */
158int pm_generic_freeze(struct device *dev)
159{
160 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
161
162 return pm && pm->freeze ? pm->freeze(dev) : 0;
163}
164EXPORT_SYMBOL_GPL(pm_generic_freeze);
165
166/**
167 * pm_generic_poweroff_noirq - Generic poweroff_noirq callback for subsystems.
168 * @dev: Device to handle.
169 */
170int pm_generic_poweroff_noirq(struct device *dev)
171{
172 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
173
174 return pm && pm->poweroff_noirq ? pm->poweroff_noirq(dev) : 0;
175}
176EXPORT_SYMBOL_GPL(pm_generic_poweroff_noirq);
177
178/**
179 * pm_generic_poweroff_late - Generic poweroff_late callback for subsystems.
180 * @dev: Device to handle.
181 */
182int pm_generic_poweroff_late(struct device *dev)
183{
184 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
185
186 return pm && pm->poweroff_late ? pm->poweroff_late(dev) : 0;
187}
188EXPORT_SYMBOL_GPL(pm_generic_poweroff_late);
189
190/**
191 * pm_generic_poweroff - Generic poweroff callback for subsystems.
192 * @dev: Device to handle.
193 */
194int pm_generic_poweroff(struct device *dev)
195{
196 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
197
198 return pm && pm->poweroff ? pm->poweroff(dev) : 0;
199}
200EXPORT_SYMBOL_GPL(pm_generic_poweroff);
201
202/**
203 * pm_generic_thaw_noirq - Generic thaw_noirq callback for subsystems.
204 * @dev: Device to thaw.
205 */
206int pm_generic_thaw_noirq(struct device *dev)
207{
208 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
209
210 return pm && pm->thaw_noirq ? pm->thaw_noirq(dev) : 0;
211}
212EXPORT_SYMBOL_GPL(pm_generic_thaw_noirq);
213
214/**
215 * pm_generic_thaw_early - Generic thaw_early callback for subsystems.
216 * @dev: Device to thaw.
217 */
218int pm_generic_thaw_early(struct device *dev)
219{
220 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
221
222 return pm && pm->thaw_early ? pm->thaw_early(dev) : 0;
223}
224EXPORT_SYMBOL_GPL(pm_generic_thaw_early);
225
226/**
227 * pm_generic_thaw - Generic thaw callback for subsystems.
228 * @dev: Device to thaw.
229 */
230int pm_generic_thaw(struct device *dev)
231{
232 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
233
234 return pm && pm->thaw ? pm->thaw(dev) : 0;
235}
236EXPORT_SYMBOL_GPL(pm_generic_thaw);
237
238/**
239 * pm_generic_resume_noirq - Generic resume_noirq callback for subsystems.
240 * @dev: Device to resume.
241 */
242int pm_generic_resume_noirq(struct device *dev)
243{
244 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
245
246 return pm && pm->resume_noirq ? pm->resume_noirq(dev) : 0;
247}
248EXPORT_SYMBOL_GPL(pm_generic_resume_noirq);
249
250/**
251 * pm_generic_resume_early - Generic resume_early callback for subsystems.
252 * @dev: Device to resume.
253 */
254int pm_generic_resume_early(struct device *dev)
255{
256 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
257
258 return pm && pm->resume_early ? pm->resume_early(dev) : 0;
259}
260EXPORT_SYMBOL_GPL(pm_generic_resume_early);
261
262/**
263 * pm_generic_resume - Generic resume callback for subsystems.
264 * @dev: Device to resume.
265 */
266int pm_generic_resume(struct device *dev)
267{
268 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
269
270 return pm && pm->resume ? pm->resume(dev) : 0;
271}
272EXPORT_SYMBOL_GPL(pm_generic_resume);
273
274/**
275 * pm_generic_restore_noirq - Generic restore_noirq callback for subsystems.
276 * @dev: Device to restore.
277 */
278int pm_generic_restore_noirq(struct device *dev)
279{
280 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
281
282 return pm && pm->restore_noirq ? pm->restore_noirq(dev) : 0;
283}
284EXPORT_SYMBOL_GPL(pm_generic_restore_noirq);
285
286/**
287 * pm_generic_restore_early - Generic restore_early callback for subsystems.
288 * @dev: Device to resume.
289 */
290int pm_generic_restore_early(struct device *dev)
291{
292 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
293
294 return pm && pm->restore_early ? pm->restore_early(dev) : 0;
295}
296EXPORT_SYMBOL_GPL(pm_generic_restore_early);
297
298/**
299 * pm_generic_restore - Generic restore callback for subsystems.
300 * @dev: Device to restore.
301 */
302int pm_generic_restore(struct device *dev)
303{
304 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
305
306 return pm && pm->restore ? pm->restore(dev) : 0;
307}
308EXPORT_SYMBOL_GPL(pm_generic_restore);
309
310/**
311 * pm_generic_complete - Generic routine competing a device power transition.
312 * @dev: Device to handle.
313 *
314 * Complete a device power transition during a system-wide power transition.
315 */
316void pm_generic_complete(struct device *dev)
317{
318 struct device_driver *drv = dev->driver;
319
320 if (drv && drv->pm && drv->pm->complete)
321 drv->pm->complete(dev);
322
323 /*
324 * Let runtime PM try to suspend devices that haven't been in use before
325 * going into the system-wide sleep state we're resuming from.
326 */
327 pm_runtime_idle(dev);
328}
329#endif /* CONFIG_PM_SLEEP */