]>
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 | ||
b804049d | 97 | blk_set_runtime_active(sdev->request_queue); |
3f7e62bb | 98 | } |
3c31b52f DW |
99 | } |
100 | ||
db5bd1e0 AS |
101 | return err; |
102 | } | |
103 | ||
80d2fd48 | 104 | static int |
3c31b52f DW |
105 | scsi_bus_suspend_common(struct device *dev, |
106 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
db5bd1e0 AS |
107 | { |
108 | int err = 0; | |
109 | ||
28640516 LM |
110 | if (scsi_is_sdev_device(dev)) { |
111 | /* | |
80d2fd48 AL |
112 | * All the high-level SCSI drivers that implement runtime |
113 | * PM treat runtime suspend, system suspend, and system | |
95897910 ON |
114 | * hibernate nearly identically. In all cases the requirements |
115 | * for runtime suspension are stricter. | |
28640516 | 116 | */ |
80d2fd48 AL |
117 | if (pm_runtime_suspended(dev)) |
118 | return 0; | |
28640516 | 119 | |
80d2fd48 | 120 | err = scsi_dev_type_suspend(dev, cb); |
28640516 | 121 | } |
80d2fd48 | 122 | |
db5bd1e0 AS |
123 | return err; |
124 | } | |
125 | ||
3c31b52f | 126 | static void async_sdev_resume(void *dev, async_cookie_t cookie) |
db5bd1e0 | 127 | { |
3c31b52f DW |
128 | scsi_dev_type_resume(dev, do_scsi_resume); |
129 | } | |
db5bd1e0 | 130 | |
3c31b52f DW |
131 | static void async_sdev_thaw(void *dev, async_cookie_t cookie) |
132 | { | |
133 | scsi_dev_type_resume(dev, do_scsi_thaw); | |
134 | } | |
63347905 | 135 | |
3c31b52f DW |
136 | static void async_sdev_restore(void *dev, async_cookie_t cookie) |
137 | { | |
138 | scsi_dev_type_resume(dev, do_scsi_restore); | |
139 | } | |
140 | ||
141 | static int scsi_bus_resume_common(struct device *dev, | |
142 | int (*cb)(struct device *, const struct dev_pm_ops *)) | |
143 | { | |
144 | async_func_t fn; | |
145 | ||
146 | if (!scsi_is_sdev_device(dev)) | |
147 | fn = NULL; | |
148 | else if (cb == do_scsi_resume) | |
149 | fn = async_sdev_resume; | |
150 | else if (cb == do_scsi_thaw) | |
151 | fn = async_sdev_thaw; | |
152 | else if (cb == do_scsi_restore) | |
153 | fn = async_sdev_restore; | |
154 | else | |
155 | fn = NULL; | |
156 | ||
157 | if (fn) { | |
158 | async_schedule_domain(fn, dev, &scsi_sd_pm_domain); | |
159 | ||
160 | /* | |
161 | * If a user has disabled async probing a likely reason | |
162 | * is due to a storage enclosure that does not inject | |
163 | * staggered spin-ups. For safety, make resume | |
164 | * synchronous as well in that case. | |
165 | */ | |
166 | if (strncmp(scsi_scan_type, "async", 5) != 0) | |
167 | async_synchronize_full_domain(&scsi_sd_pm_domain); | |
168 | } else { | |
bc4f2401 AS |
169 | pm_runtime_disable(dev); |
170 | pm_runtime_set_active(dev); | |
171 | pm_runtime_enable(dev); | |
172 | } | |
3c31b52f | 173 | return 0; |
db5bd1e0 AS |
174 | } |
175 | ||
fea6d607 AS |
176 | static int scsi_bus_prepare(struct device *dev) |
177 | { | |
f049cf1a | 178 | if (scsi_is_host_device(dev)) { |
fea6d607 AS |
179 | /* Wait until async scanning is finished */ |
180 | scsi_complete_async_scans(); | |
181 | } | |
182 | return 0; | |
183 | } | |
184 | ||
db5bd1e0 AS |
185 | static int scsi_bus_suspend(struct device *dev) |
186 | { | |
3c31b52f | 187 | return scsi_bus_suspend_common(dev, do_scsi_suspend); |
80d2fd48 AL |
188 | } |
189 | ||
190 | static int scsi_bus_resume(struct device *dev) | |
191 | { | |
3c31b52f | 192 | return scsi_bus_resume_common(dev, do_scsi_resume); |
db5bd1e0 AS |
193 | } |
194 | ||
195 | static int scsi_bus_freeze(struct device *dev) | |
196 | { | |
3c31b52f | 197 | return scsi_bus_suspend_common(dev, do_scsi_freeze); |
80d2fd48 AL |
198 | } |
199 | ||
200 | static int scsi_bus_thaw(struct device *dev) | |
201 | { | |
3c31b52f | 202 | return scsi_bus_resume_common(dev, do_scsi_thaw); |
db5bd1e0 AS |
203 | } |
204 | ||
205 | static int scsi_bus_poweroff(struct device *dev) | |
206 | { | |
3c31b52f | 207 | return scsi_bus_suspend_common(dev, do_scsi_poweroff); |
80d2fd48 AL |
208 | } |
209 | ||
210 | static int scsi_bus_restore(struct device *dev) | |
211 | { | |
3c31b52f | 212 | return scsi_bus_resume_common(dev, do_scsi_restore); |
db5bd1e0 AS |
213 | } |
214 | ||
215 | #else /* CONFIG_PM_SLEEP */ | |
216 | ||
fea6d607 | 217 | #define scsi_bus_prepare NULL |
db5bd1e0 | 218 | #define scsi_bus_suspend NULL |
80d2fd48 | 219 | #define scsi_bus_resume NULL |
db5bd1e0 | 220 | #define scsi_bus_freeze NULL |
80d2fd48 | 221 | #define scsi_bus_thaw NULL |
db5bd1e0 | 222 | #define scsi_bus_poweroff NULL |
80d2fd48 | 223 | #define scsi_bus_restore NULL |
db5bd1e0 AS |
224 | |
225 | #endif /* CONFIG_PM_SLEEP */ | |
226 | ||
6627b38f | 227 | static int sdev_runtime_suspend(struct device *dev) |
6df339a5 | 228 | { |
6627b38f AL |
229 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; |
230 | struct scsi_device *sdev = to_scsi_device(dev); | |
49718f0f | 231 | int err = 0; |
6df339a5 | 232 | |
1c69d3b6 KX |
233 | err = blk_pre_runtime_suspend(sdev->request_queue); |
234 | if (err) | |
235 | return err; | |
236 | if (pm && pm->runtime_suspend) | |
6627b38f | 237 | err = pm->runtime_suspend(dev); |
1c69d3b6 KX |
238 | blk_post_runtime_suspend(sdev->request_queue, err); |
239 | ||
6df339a5 LM |
240 | return err; |
241 | } | |
242 | ||
bc4f2401 AS |
243 | static int scsi_runtime_suspend(struct device *dev) |
244 | { | |
245 | int err = 0; | |
246 | ||
247 | dev_dbg(dev, "scsi_runtime_suspend\n"); | |
6df339a5 LM |
248 | if (scsi_is_sdev_device(dev)) |
249 | err = sdev_runtime_suspend(dev); | |
bc4f2401 AS |
250 | |
251 | /* Insert hooks here for targets, hosts, and transport classes */ | |
252 | ||
253 | return err; | |
254 | } | |
255 | ||
6627b38f | 256 | static int sdev_runtime_resume(struct device *dev) |
bc4f2401 | 257 | { |
6627b38f AL |
258 | struct scsi_device *sdev = to_scsi_device(dev); |
259 | const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL; | |
bc4f2401 | 260 | int err = 0; |
6df339a5 | 261 | |
1c69d3b6 KX |
262 | blk_pre_runtime_resume(sdev->request_queue); |
263 | if (pm && pm->runtime_resume) | |
6627b38f | 264 | err = pm->runtime_resume(dev); |
1c69d3b6 KX |
265 | blk_post_runtime_resume(sdev->request_queue, err); |
266 | ||
6df339a5 LM |
267 | return err; |
268 | } | |
269 | ||
6df339a5 LM |
270 | static int scsi_runtime_resume(struct device *dev) |
271 | { | |
272 | int err = 0; | |
bc4f2401 AS |
273 | |
274 | dev_dbg(dev, "scsi_runtime_resume\n"); | |
275 | if (scsi_is_sdev_device(dev)) | |
6df339a5 | 276 | err = sdev_runtime_resume(dev); |
bc4f2401 AS |
277 | |
278 | /* Insert hooks here for targets, hosts, and transport classes */ | |
279 | ||
280 | return err; | |
281 | } | |
282 | ||
283 | static int scsi_runtime_idle(struct device *dev) | |
284 | { | |
bc4f2401 AS |
285 | dev_dbg(dev, "scsi_runtime_idle\n"); |
286 | ||
287 | /* Insert hooks here for targets, hosts, and transport classes */ | |
288 | ||
6df339a5 | 289 | if (scsi_is_sdev_device(dev)) { |
6627b38f AL |
290 | pm_runtime_mark_last_busy(dev); |
291 | pm_runtime_autosuspend(dev); | |
292 | return -EBUSY; | |
6df339a5 | 293 | } |
6627b38f | 294 | |
45f0a85c | 295 | return 0; |
bc4f2401 AS |
296 | } |
297 | ||
298 | int scsi_autopm_get_device(struct scsi_device *sdev) | |
299 | { | |
300 | int err; | |
301 | ||
302 | err = pm_runtime_get_sync(&sdev->sdev_gendev); | |
632e270e | 303 | if (err < 0 && err !=-EACCES) |
bc4f2401 | 304 | pm_runtime_put_sync(&sdev->sdev_gendev); |
632e270e | 305 | else |
bc4f2401 AS |
306 | err = 0; |
307 | return err; | |
308 | } | |
309 | EXPORT_SYMBOL_GPL(scsi_autopm_get_device); | |
310 | ||
311 | void scsi_autopm_put_device(struct scsi_device *sdev) | |
312 | { | |
313 | pm_runtime_put_sync(&sdev->sdev_gendev); | |
314 | } | |
315 | EXPORT_SYMBOL_GPL(scsi_autopm_put_device); | |
316 | ||
317 | void scsi_autopm_get_target(struct scsi_target *starget) | |
318 | { | |
319 | pm_runtime_get_sync(&starget->dev); | |
320 | } | |
321 | ||
322 | void scsi_autopm_put_target(struct scsi_target *starget) | |
323 | { | |
324 | pm_runtime_put_sync(&starget->dev); | |
325 | } | |
326 | ||
327 | int scsi_autopm_get_host(struct Scsi_Host *shost) | |
328 | { | |
329 | int err; | |
330 | ||
331 | err = pm_runtime_get_sync(&shost->shost_gendev); | |
632e270e | 332 | if (err < 0 && err !=-EACCES) |
bc4f2401 | 333 | pm_runtime_put_sync(&shost->shost_gendev); |
632e270e | 334 | else |
bc4f2401 AS |
335 | err = 0; |
336 | return err; | |
337 | } | |
338 | ||
339 | void scsi_autopm_put_host(struct Scsi_Host *shost) | |
340 | { | |
341 | pm_runtime_put_sync(&shost->shost_gendev); | |
342 | } | |
343 | ||
db5bd1e0 | 344 | const struct dev_pm_ops scsi_bus_pm_ops = { |
fea6d607 | 345 | .prepare = scsi_bus_prepare, |
db5bd1e0 | 346 | .suspend = scsi_bus_suspend, |
80d2fd48 | 347 | .resume = scsi_bus_resume, |
db5bd1e0 | 348 | .freeze = scsi_bus_freeze, |
80d2fd48 | 349 | .thaw = scsi_bus_thaw, |
db5bd1e0 | 350 | .poweroff = scsi_bus_poweroff, |
80d2fd48 | 351 | .restore = scsi_bus_restore, |
bc4f2401 AS |
352 | .runtime_suspend = scsi_runtime_suspend, |
353 | .runtime_resume = scsi_runtime_resume, | |
354 | .runtime_idle = scsi_runtime_idle, | |
db5bd1e0 | 355 | }; |