Commit | Line | Data |
---|---|---|
457c8996 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
db5bd1e0 AS |
2 | /* |
3 | * scsi_pm.c Copyright (C) 2010 Alan Stern | |
4 | * | |
5 | * SCSI dynamic Power Management | |
6 | * Initial version: Alan Stern <stern@rowland.harvard.edu> | |
7 | */ | |
8 | ||
9 | #include <linux/pm_runtime.h> | |
09703660 | 10 | #include <linux/export.h> |
fea6d607 | 11 | #include <linux/async.h> |
bca6b067 | 12 | #include <linux/blk-pm.h> |
db5bd1e0 AS |
13 | |
14 | #include <scsi/scsi.h> | |
15 | #include <scsi/scsi_device.h> | |
16 | #include <scsi/scsi_driver.h> | |
17 | #include <scsi/scsi_host.h> | |
18 | ||
19 | #include "scsi_priv.h" | |
20 | ||
6627b38f AL |
21 | #ifdef CONFIG_PM_SLEEP |
22 | ||
3c31b52f | 23 | static int do_scsi_suspend(struct device *dev, const struct dev_pm_ops *pm) |
db5bd1e0 | 24 | { |
3c31b52f DW |
25 | return pm && pm->suspend ? pm->suspend(dev) : 0; |
26 | } | |
27 | ||
28 | static int do_scsi_freeze(struct device *dev, const struct dev_pm_ops *pm) | |
29 | { | |
30 | return pm && pm->freeze ? pm->freeze(dev) : 0; | |
31 | } | |
32 | ||
33 | static int do_scsi_poweroff(struct device *dev, const struct dev_pm_ops *pm) | |
34 | { | |
35 | return pm && pm->poweroff ? pm->poweroff(dev) : 0; | |
36 | } | |
37 | ||
38 | static int do_scsi_resume(struct device *dev, const struct dev_pm_ops *pm) | |
39 | { | |
40 | return pm && pm->resume ? pm->resume(dev) : 0; | |
41 | } | |
42 | ||
43 | static int do_scsi_thaw(struct device *dev, const struct dev_pm_ops *pm) | |
44 | { | |
45 | return pm && pm->thaw ? pm->thaw(dev) : 0; | |
46 | } | |
47 | ||
48 | static int do_scsi_restore(struct device *dev, const struct dev_pm_ops *pm) | |
49 | { | |
50 | return pm && pm->restore ? pm->restore(dev) : 0; | |
51 | } | |
52 | ||
53 | static int scsi_dev_type_suspend(struct device *dev, | |
54 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
55 | { | |
56 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; | |
db5bd1e0 AS |
57 | int err; |
58 | ||
3c31b52f DW |
59 | /* flush pending in-flight resume operations, suspend is synchronous */ |
60 | async_synchronize_full_domain(&scsi_sd_pm_domain); | |
61 | ||
db5bd1e0 AS |
62 | err = scsi_device_quiesce(to_scsi_device(dev)); |
63 | if (err == 0) { | |
3c31b52f DW |
64 | err = cb(dev, pm); |
65 | if (err) | |
66 | scsi_device_resume(to_scsi_device(dev)); | |
db5bd1e0 AS |
67 | } |
68 | dev_dbg(dev, "scsi suspend: %d\n", err); | |
69 | return err; | |
70 | } | |
71 | ||
3c31b52f DW |
72 | static int scsi_dev_type_resume(struct device *dev, |
73 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
db5bd1e0 | 74 | { |
3c31b52f | 75 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; |
db5bd1e0 AS |
76 | int err = 0; |
77 | ||
3c31b52f | 78 | err = cb(dev, pm); |
db5bd1e0 AS |
79 | scsi_device_resume(to_scsi_device(dev)); |
80 | dev_dbg(dev, "scsi resume: %d\n", err); | |
3c31b52f DW |
81 | |
82 | if (err == 0) { | |
83 | pm_runtime_disable(dev); | |
3f7e62bb | 84 | err = pm_runtime_set_active(dev); |
3c31b52f | 85 | pm_runtime_enable(dev); |
3f7e62bb SC |
86 | |
87 | /* | |
88 | * Forcibly set runtime PM status of request queue to "active" | |
89 | * to make sure we can again get requests from the queue | |
90 | * (see also blk_pm_peek_request()). | |
91 | * | |
92 | * The resume hook will correct runtime PM status of the disk. | |
93 | */ | |
94 | if (!err && scsi_is_sdev_device(dev)) { | |
95 | struct scsi_device *sdev = to_scsi_device(dev); | |
96 | ||
97 | if (sdev->request_queue->dev) | |
98 | blk_set_runtime_active(sdev->request_queue); | |
99 | } | |
3c31b52f DW |
100 | } |
101 | ||
db5bd1e0 AS |
102 | return err; |
103 | } | |
104 | ||
80d2fd48 | 105 | static int |
3c31b52f DW |
106 | scsi_bus_suspend_common(struct device *dev, |
107 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
db5bd1e0 AS |
108 | { |
109 | int err = 0; | |
110 | ||
28640516 LM |
111 | if (scsi_is_sdev_device(dev)) { |
112 | /* | |
80d2fd48 AL |
113 | * All the high-level SCSI drivers that implement runtime |
114 | * PM treat runtime suspend, system suspend, and system | |
95897910 ON |
115 | * hibernate nearly identically. In all cases the requirements |
116 | * for runtime suspension are stricter. | |
28640516 | 117 | */ |
80d2fd48 AL |
118 | if (pm_runtime_suspended(dev)) |
119 | return 0; | |
28640516 | 120 | |
80d2fd48 | 121 | err = scsi_dev_type_suspend(dev, cb); |
28640516 | 122 | } |
80d2fd48 | 123 | |
db5bd1e0 AS |
124 | return err; |
125 | } | |
126 | ||
3c31b52f | 127 | static void async_sdev_resume(void *dev, async_cookie_t cookie) |
db5bd1e0 | 128 | { |
3c31b52f DW |
129 | scsi_dev_type_resume(dev, do_scsi_resume); |
130 | } | |
db5bd1e0 | 131 | |
3c31b52f DW |
132 | static void async_sdev_thaw(void *dev, async_cookie_t cookie) |
133 | { | |
134 | scsi_dev_type_resume(dev, do_scsi_thaw); | |
135 | } | |
63347905 | 136 | |
3c31b52f DW |
137 | static void async_sdev_restore(void *dev, async_cookie_t cookie) |
138 | { | |
139 | scsi_dev_type_resume(dev, do_scsi_restore); | |
140 | } | |
141 | ||
142 | static int scsi_bus_resume_common(struct device *dev, | |
143 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
144 | { | |
145 | async_func_t fn; | |
146 | ||
147 | if (!scsi_is_sdev_device(dev)) | |
148 | fn = NULL; | |
149 | else if (cb == do_scsi_resume) | |
150 | fn = async_sdev_resume; | |
151 | else if (cb == do_scsi_thaw) | |
152 | fn = async_sdev_thaw; | |
153 | else if (cb == do_scsi_restore) | |
154 | fn = async_sdev_restore; | |
155 | else | |
156 | fn = NULL; | |
157 | ||
158 | if (fn) { | |
159 | async_schedule_domain(fn, dev, &scsi_sd_pm_domain); | |
160 | ||
161 | /* | |
162 | * If a user has disabled async probing a likely reason | |
163 | * is due to a storage enclosure that does not inject | |
164 | * staggered spin-ups. For safety, make resume | |
165 | * synchronous as well in that case. | |
166 | */ | |
167 | if (strncmp(scsi_scan_type, "async", 5) != 0) | |
168 | async_synchronize_full_domain(&scsi_sd_pm_domain); | |
169 | } else { | |
bc4f2401 AS |
170 | pm_runtime_disable(dev); |
171 | pm_runtime_set_active(dev); | |
172 | pm_runtime_enable(dev); | |
173 | } | |
3c31b52f | 174 | return 0; |
db5bd1e0 AS |
175 | } |
176 | ||
fea6d607 AS |
177 | static int scsi_bus_prepare(struct device *dev) |
178 | { | |
179 | if (scsi_is_sdev_device(dev)) { | |
180 | /* sd probing uses async_schedule. Wait until it finishes. */ | |
a7a20d10 | 181 | async_synchronize_full_domain(&scsi_sd_probe_domain); |
fea6d607 AS |
182 | |
183 | } else if (scsi_is_host_device(dev)) { | |
184 | /* Wait until async scanning is finished */ | |
185 | scsi_complete_async_scans(); | |
186 | } | |
187 | return 0; | |
188 | } | |
189 | ||
db5bd1e0 AS |
190 | static int scsi_bus_suspend(struct device *dev) |
191 | { | |
3c31b52f | 192 | return scsi_bus_suspend_common(dev, do_scsi_suspend); |
80d2fd48 AL |
193 | } |
194 | ||
195 | static int scsi_bus_resume(struct device *dev) | |
196 | { | |
3c31b52f | 197 | return scsi_bus_resume_common(dev, do_scsi_resume); |
db5bd1e0 AS |
198 | } |
199 | ||
200 | static int scsi_bus_freeze(struct device *dev) | |
201 | { | |
3c31b52f | 202 | return scsi_bus_suspend_common(dev, do_scsi_freeze); |
80d2fd48 AL |
203 | } |
204 | ||
205 | static int scsi_bus_thaw(struct device *dev) | |
206 | { | |
3c31b52f | 207 | return scsi_bus_resume_common(dev, do_scsi_thaw); |
db5bd1e0 AS |
208 | } |
209 | ||
210 | static int scsi_bus_poweroff(struct device *dev) | |
211 | { | |
3c31b52f | 212 | return scsi_bus_suspend_common(dev, do_scsi_poweroff); |
80d2fd48 AL |
213 | } |
214 | ||
215 | static int scsi_bus_restore(struct device *dev) | |
216 | { | |
3c31b52f | 217 | return scsi_bus_resume_common(dev, do_scsi_restore); |
db5bd1e0 AS |
218 | } |
219 | ||
220 | #else /* CONFIG_PM_SLEEP */ | |
221 | ||
fea6d607 | 222 | #define scsi_bus_prepare NULL |
db5bd1e0 | 223 | #define scsi_bus_suspend NULL |
80d2fd48 | 224 | #define scsi_bus_resume NULL |
db5bd1e0 | 225 | #define scsi_bus_freeze NULL |
80d2fd48 | 226 | #define scsi_bus_thaw NULL |
db5bd1e0 | 227 | #define scsi_bus_poweroff NULL |
80d2fd48 | 228 | #define scsi_bus_restore NULL |
db5bd1e0 AS |
229 | |
230 | #endif /* CONFIG_PM_SLEEP */ | |
231 | ||
6627b38f | 232 | static int sdev_runtime_suspend(struct device *dev) |
6df339a5 | 233 | { |
6627b38f AL |
234 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; |
235 | struct scsi_device *sdev = to_scsi_device(dev); | |
49718f0f | 236 | int err = 0; |
6df339a5 | 237 | |
1c69d3b6 KX |
238 | err = blk_pre_runtime_suspend(sdev->request_queue); |
239 | if (err) | |
240 | return err; | |
241 | if (pm && pm->runtime_suspend) | |
6627b38f | 242 | err = pm->runtime_suspend(dev); |
1c69d3b6 KX |
243 | blk_post_runtime_suspend(sdev->request_queue, err); |
244 | ||
6df339a5 LM |
245 | return err; |
246 | } | |
247 | ||
bc4f2401 AS |
248 | static int scsi_runtime_suspend(struct device *dev) |
249 | { | |
250 | int err = 0; | |
251 | ||
252 | dev_dbg(dev, "scsi_runtime_suspend\n"); | |
6df339a5 LM |
253 | if (scsi_is_sdev_device(dev)) |
254 | err = sdev_runtime_suspend(dev); | |
bc4f2401 AS |
255 | |
256 | /* Insert hooks here for targets, hosts, and transport classes */ | |
257 | ||
258 | return err; | |
259 | } | |
260 | ||
6627b38f | 261 | static int sdev_runtime_resume(struct device *dev) |
bc4f2401 | 262 | { |
6627b38f AL |
263 | struct scsi_device *sdev = to_scsi_device(dev); |
264 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; | |
bc4f2401 | 265 | int err = 0; |
6df339a5 | 266 | |
1c69d3b6 KX |
267 | blk_pre_runtime_resume(sdev->request_queue); |
268 | if (pm && pm->runtime_resume) | |
6627b38f | 269 | err = pm->runtime_resume(dev); |
1c69d3b6 KX |
270 | blk_post_runtime_resume(sdev->request_queue, err); |
271 | ||
6df339a5 LM |
272 | return err; |
273 | } | |
274 | ||
6df339a5 LM |
275 | static int scsi_runtime_resume(struct device *dev) |
276 | { | |
277 | int err = 0; | |
bc4f2401 AS |
278 | |
279 | dev_dbg(dev, "scsi_runtime_resume\n"); | |
280 | if (scsi_is_sdev_device(dev)) | |
6df339a5 | 281 | err = sdev_runtime_resume(dev); |
bc4f2401 AS |
282 | |
283 | /* Insert hooks here for targets, hosts, and transport classes */ | |
284 | ||
285 | return err; | |
286 | } | |
287 | ||
288 | static int scsi_runtime_idle(struct device *dev) | |
289 | { | |
bc4f2401 AS |
290 | dev_dbg(dev, "scsi_runtime_idle\n"); |
291 | ||
292 | /* Insert hooks here for targets, hosts, and transport classes */ | |
293 | ||
6df339a5 | 294 | if (scsi_is_sdev_device(dev)) { |
6627b38f AL |
295 | pm_runtime_mark_last_busy(dev); |
296 | pm_runtime_autosuspend(dev); | |
297 | return -EBUSY; | |
6df339a5 | 298 | } |
6627b38f | 299 | |
45f0a85c | 300 | return 0; |
bc4f2401 AS |
301 | } |
302 | ||
303 | int scsi_autopm_get_device(struct scsi_device *sdev) | |
304 | { | |
305 | int err; | |
306 | ||
307 | err = pm_runtime_get_sync(&sdev->sdev_gendev); | |
632e270e | 308 | if (err < 0 && err !=-EACCES) |
bc4f2401 | 309 | pm_runtime_put_sync(&sdev->sdev_gendev); |
632e270e | 310 | else |
bc4f2401 AS |
311 | err = 0; |
312 | return err; | |
313 | } | |
314 | EXPORT_SYMBOL_GPL(scsi_autopm_get_device); | |
315 | ||
316 | void scsi_autopm_put_device(struct scsi_device *sdev) | |
317 | { | |
318 | pm_runtime_put_sync(&sdev->sdev_gendev); | |
319 | } | |
320 | EXPORT_SYMBOL_GPL(scsi_autopm_put_device); | |
321 | ||
322 | void scsi_autopm_get_target(struct scsi_target *starget) | |
323 | { | |
324 | pm_runtime_get_sync(&starget->dev); | |
325 | } | |
326 | ||
327 | void scsi_autopm_put_target(struct scsi_target *starget) | |
328 | { | |
329 | pm_runtime_put_sync(&starget->dev); | |
330 | } | |
331 | ||
332 | int scsi_autopm_get_host(struct Scsi_Host *shost) | |
333 | { | |
334 | int err; | |
335 | ||
336 | err = pm_runtime_get_sync(&shost->shost_gendev); | |
632e270e | 337 | if (err < 0 && err !=-EACCES) |
bc4f2401 | 338 | pm_runtime_put_sync(&shost->shost_gendev); |
632e270e | 339 | else |
bc4f2401 AS |
340 | err = 0; |
341 | return err; | |
342 | } | |
343 | ||
344 | void scsi_autopm_put_host(struct Scsi_Host *shost) | |
345 | { | |
346 | pm_runtime_put_sync(&shost->shost_gendev); | |
347 | } | |
348 | ||
db5bd1e0 | 349 | const struct dev_pm_ops scsi_bus_pm_ops = { |
fea6d607 | 350 | .prepare = scsi_bus_prepare, |
db5bd1e0 | 351 | .suspend = scsi_bus_suspend, |
80d2fd48 | 352 | .resume = scsi_bus_resume, |
db5bd1e0 | 353 | .freeze = scsi_bus_freeze, |
80d2fd48 | 354 | .thaw = scsi_bus_thaw, |
db5bd1e0 | 355 | .poweroff = scsi_bus_poweroff, |
80d2fd48 | 356 | .restore = scsi_bus_restore, |
bc4f2401 AS |
357 | .runtime_suspend = scsi_runtime_suspend, |
358 | .runtime_resume = scsi_runtime_resume, | |
359 | .runtime_idle = scsi_runtime_idle, | |
db5bd1e0 | 360 | }; |