blob: 001e9ceda4c3b51bed2ba47248d9333e18d39487 [file] [log] [blame]
Alan Sterndb5bd1e2010-06-17 10:36:49 -04001/*
2 * scsi_pm.c Copyright (C) 2010 Alan Stern
3 *
4 * SCSI dynamic Power Management
5 * Initial version: Alan Stern <stern@rowland.harvard.edu>
6 */
7
8#include <linux/pm_runtime.h>
Paul Gortmaker09703662011-05-27 09:37:25 -04009#include <linux/export.h>
Alan Sternfea6d602012-02-17 16:25:08 -050010#include <linux/async.h>
Alan Sterndb5bd1e2010-06-17 10:36:49 -040011
12#include <scsi/scsi.h>
13#include <scsi/scsi_device.h>
14#include <scsi/scsi_driver.h>
15#include <scsi/scsi_host.h>
16
17#include "scsi_priv.h"
18
Aaron Lu6627b382013-10-28 15:27:49 +080019#ifdef CONFIG_PM_SLEEP
20
Aaron Lu80d2fd42012-11-09 15:27:54 +080021static int scsi_dev_type_suspend(struct device *dev, int (*cb)(struct device *))
Alan Sterndb5bd1e2010-06-17 10:36:49 -040022{
Alan Sterndb5bd1e2010-06-17 10:36:49 -040023 int err;
24
25 err = scsi_device_quiesce(to_scsi_device(dev));
26 if (err == 0) {
Aaron Lu80d2fd42012-11-09 15:27:54 +080027 if (cb) {
28 err = cb(dev);
Aaron Lud20ec592012-05-15 14:43:00 +080029 if (err)
30 scsi_device_resume(to_scsi_device(dev));
31 }
Alan Sterndb5bd1e2010-06-17 10:36:49 -040032 }
33 dev_dbg(dev, "scsi suspend: %d\n", err);
34 return err;
35}
36
Aaron Lu80d2fd42012-11-09 15:27:54 +080037static int scsi_dev_type_resume(struct device *dev, int (*cb)(struct device *))
Alan Sterndb5bd1e2010-06-17 10:36:49 -040038{
Alan Sterndb5bd1e2010-06-17 10:36:49 -040039 int err = 0;
40
Aaron Lu80d2fd42012-11-09 15:27:54 +080041 if (cb)
42 err = cb(dev);
Alan Sterndb5bd1e2010-06-17 10:36:49 -040043 scsi_device_resume(to_scsi_device(dev));
44 dev_dbg(dev, "scsi resume: %d\n", err);
45 return err;
46}
47
Aaron Lu80d2fd42012-11-09 15:27:54 +080048static int
49scsi_bus_suspend_common(struct device *dev, int (*cb)(struct device *))
Alan Sterndb5bd1e2010-06-17 10:36:49 -040050{
51 int err = 0;
52
Lin Ming28640512011-12-05 09:20:25 +080053 if (scsi_is_sdev_device(dev)) {
54 /*
Aaron Lu80d2fd42012-11-09 15:27:54 +080055 * All the high-level SCSI drivers that implement runtime
56 * PM treat runtime suspend, system suspend, and system
Oliver Neukum95897912013-09-16 13:28:15 +020057 * hibernate nearly identically. In all cases the requirements
58 * for runtime suspension are stricter.
Lin Ming28640512011-12-05 09:20:25 +080059 */
Aaron Lu80d2fd42012-11-09 15:27:54 +080060 if (pm_runtime_suspended(dev))
61 return 0;
Lin Ming28640512011-12-05 09:20:25 +080062
Aaron Lu80d2fd42012-11-09 15:27:54 +080063 err = scsi_dev_type_suspend(dev, cb);
Lin Ming28640512011-12-05 09:20:25 +080064 }
Aaron Lu80d2fd42012-11-09 15:27:54 +080065
Alan Sterndb5bd1e2010-06-17 10:36:49 -040066 return err;
67}
68
Aaron Lu80d2fd42012-11-09 15:27:54 +080069static int
70scsi_bus_resume_common(struct device *dev, int (*cb)(struct device *))
Alan Sterndb5bd1e2010-06-17 10:36:49 -040071{
72 int err = 0;
73
Aaron Lu9c31d8e2012-11-09 15:27:53 +080074 if (scsi_is_sdev_device(dev))
Aaron Lu80d2fd42012-11-09 15:27:54 +080075 err = scsi_dev_type_resume(dev, cb);
Aaron Lu63347902012-11-09 15:27:52 +080076
Alan Sternbc4f2402010-06-17 10:41:42 -040077 if (err == 0) {
78 pm_runtime_disable(dev);
79 pm_runtime_set_active(dev);
80 pm_runtime_enable(dev);
81 }
Alan Sterndb5bd1e2010-06-17 10:36:49 -040082 return err;
83}
84
Alan Sternfea6d602012-02-17 16:25:08 -050085static int scsi_bus_prepare(struct device *dev)
86{
87 if (scsi_is_sdev_device(dev)) {
88 /* sd probing uses async_schedule. Wait until it finishes. */
Dan Williamsa7a20d12012-03-22 17:05:11 -070089 async_synchronize_full_domain(&scsi_sd_probe_domain);
Alan Sternfea6d602012-02-17 16:25:08 -050090
91 } else if (scsi_is_host_device(dev)) {
92 /* Wait until async scanning is finished */
93 scsi_complete_async_scans();
94 }
95 return 0;
96}
97
Alan Sterndb5bd1e2010-06-17 10:36:49 -040098static int scsi_bus_suspend(struct device *dev)
99{
Aaron Lu80d2fd42012-11-09 15:27:54 +0800100 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
101 return scsi_bus_suspend_common(dev, pm ? pm->suspend : NULL);
102}
103
104static int scsi_bus_resume(struct device *dev)
105{
106 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
107 return scsi_bus_resume_common(dev, pm ? pm->resume : NULL);
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400108}
109
110static int scsi_bus_freeze(struct device *dev)
111{
Aaron Lu80d2fd42012-11-09 15:27:54 +0800112 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
113 return scsi_bus_suspend_common(dev, pm ? pm->freeze : NULL);
114}
115
116static int scsi_bus_thaw(struct device *dev)
117{
118 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
119 return scsi_bus_resume_common(dev, pm ? pm->thaw : NULL);
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400120}
121
122static int scsi_bus_poweroff(struct device *dev)
123{
Aaron Lu80d2fd42012-11-09 15:27:54 +0800124 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
125 return scsi_bus_suspend_common(dev, pm ? pm->poweroff : NULL);
126}
127
128static int scsi_bus_restore(struct device *dev)
129{
130 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
131 return scsi_bus_resume_common(dev, pm ? pm->restore : NULL);
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400132}
133
134#else /* CONFIG_PM_SLEEP */
135
Alan Sternfea6d602012-02-17 16:25:08 -0500136#define scsi_bus_prepare NULL
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400137#define scsi_bus_suspend NULL
Aaron Lu80d2fd42012-11-09 15:27:54 +0800138#define scsi_bus_resume NULL
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400139#define scsi_bus_freeze NULL
Aaron Lu80d2fd42012-11-09 15:27:54 +0800140#define scsi_bus_thaw NULL
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400141#define scsi_bus_poweroff NULL
Aaron Lu80d2fd42012-11-09 15:27:54 +0800142#define scsi_bus_restore NULL
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400143
144#endif /* CONFIG_PM_SLEEP */
145
Alan Sternbc4f2402010-06-17 10:41:42 -0400146#ifdef CONFIG_PM_RUNTIME
147
Aaron Lu6627b382013-10-28 15:27:49 +0800148static int sdev_runtime_suspend(struct device *dev)
Lin Ming6df339a2013-03-23 11:42:28 +0800149{
Aaron Lu6627b382013-10-28 15:27:49 +0800150 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
151 struct scsi_device *sdev = to_scsi_device(dev);
Lin Ming6df339a2013-03-23 11:42:28 +0800152 int err;
153
154 err = blk_pre_runtime_suspend(sdev->request_queue);
155 if (err)
156 return err;
Aaron Lu6627b382013-10-28 15:27:49 +0800157 if (pm && pm->runtime_suspend)
158 err = pm->runtime_suspend(dev);
Lin Ming6df339a2013-03-23 11:42:28 +0800159 blk_post_runtime_suspend(sdev->request_queue, err);
160
161 return err;
162}
163
Alan Sternbc4f2402010-06-17 10:41:42 -0400164static int scsi_runtime_suspend(struct device *dev)
165{
166 int err = 0;
167
168 dev_dbg(dev, "scsi_runtime_suspend\n");
Lin Ming6df339a2013-03-23 11:42:28 +0800169 if (scsi_is_sdev_device(dev))
170 err = sdev_runtime_suspend(dev);
Alan Sternbc4f2402010-06-17 10:41:42 -0400171
172 /* Insert hooks here for targets, hosts, and transport classes */
173
174 return err;
175}
176
Lin Ming6df339a2013-03-23 11:42:28 +0800177static int sdev_runtime_resume(struct device *dev)
178{
179 struct scsi_device *sdev = to_scsi_device(dev);
180 const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
Aaron Lu6627b382013-10-28 15:27:49 +0800181 int err = 0;
Lin Ming6df339a2013-03-23 11:42:28 +0800182
Aaron Lu6627b382013-10-28 15:27:49 +0800183 blk_pre_runtime_resume(sdev->request_queue);
184 if (pm && pm->runtime_resume)
185 err = pm->runtime_resume(dev);
186 blk_post_runtime_resume(sdev->request_queue, err);
187
188 return err;
Lin Ming6df339a2013-03-23 11:42:28 +0800189}
190
Alan Sternbc4f2402010-06-17 10:41:42 -0400191static int scsi_runtime_resume(struct device *dev)
192{
193 int err = 0;
194
195 dev_dbg(dev, "scsi_runtime_resume\n");
196 if (scsi_is_sdev_device(dev))
Lin Ming6df339a2013-03-23 11:42:28 +0800197 err = sdev_runtime_resume(dev);
Alan Sternbc4f2402010-06-17 10:41:42 -0400198
199 /* Insert hooks here for targets, hosts, and transport classes */
200
201 return err;
202}
203
204static int scsi_runtime_idle(struct device *dev)
205{
Alan Sternbc4f2402010-06-17 10:41:42 -0400206 dev_dbg(dev, "scsi_runtime_idle\n");
207
208 /* Insert hooks here for targets, hosts, and transport classes */
209
Lin Ming6df339a2013-03-23 11:42:28 +0800210 if (scsi_is_sdev_device(dev)) {
Aaron Lu6627b382013-10-28 15:27:49 +0800211 pm_runtime_mark_last_busy(dev);
212 pm_runtime_autosuspend(dev);
213 return -EBUSY;
Lin Ming6df339a2013-03-23 11:42:28 +0800214 }
Aaron Lu6627b382013-10-28 15:27:49 +0800215
Rafael J. Wysocki45f0a852013-06-03 21:49:52 +0200216 return 0;
Alan Sternbc4f2402010-06-17 10:41:42 -0400217}
218
219int scsi_autopm_get_device(struct scsi_device *sdev)
220{
221 int err;
222
223 err = pm_runtime_get_sync(&sdev->sdev_gendev);
Rafael J. Wysocki632e2702011-07-01 22:29:15 +0200224 if (err < 0 && err !=-EACCES)
Alan Sternbc4f2402010-06-17 10:41:42 -0400225 pm_runtime_put_sync(&sdev->sdev_gendev);
Rafael J. Wysocki632e2702011-07-01 22:29:15 +0200226 else
Alan Sternbc4f2402010-06-17 10:41:42 -0400227 err = 0;
228 return err;
229}
230EXPORT_SYMBOL_GPL(scsi_autopm_get_device);
231
232void scsi_autopm_put_device(struct scsi_device *sdev)
233{
234 pm_runtime_put_sync(&sdev->sdev_gendev);
235}
236EXPORT_SYMBOL_GPL(scsi_autopm_put_device);
237
238void scsi_autopm_get_target(struct scsi_target *starget)
239{
240 pm_runtime_get_sync(&starget->dev);
241}
242
243void scsi_autopm_put_target(struct scsi_target *starget)
244{
245 pm_runtime_put_sync(&starget->dev);
246}
247
248int scsi_autopm_get_host(struct Scsi_Host *shost)
249{
250 int err;
251
252 err = pm_runtime_get_sync(&shost->shost_gendev);
Rafael J. Wysocki632e2702011-07-01 22:29:15 +0200253 if (err < 0 && err !=-EACCES)
Alan Sternbc4f2402010-06-17 10:41:42 -0400254 pm_runtime_put_sync(&shost->shost_gendev);
Rafael J. Wysocki632e2702011-07-01 22:29:15 +0200255 else
Alan Sternbc4f2402010-06-17 10:41:42 -0400256 err = 0;
257 return err;
258}
259
260void scsi_autopm_put_host(struct Scsi_Host *shost)
261{
262 pm_runtime_put_sync(&shost->shost_gendev);
263}
264
265#else
266
267#define scsi_runtime_suspend NULL
268#define scsi_runtime_resume NULL
269#define scsi_runtime_idle NULL
270
271#endif /* CONFIG_PM_RUNTIME */
272
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400273const struct dev_pm_ops scsi_bus_pm_ops = {
Alan Sternfea6d602012-02-17 16:25:08 -0500274 .prepare = scsi_bus_prepare,
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400275 .suspend = scsi_bus_suspend,
Aaron Lu80d2fd42012-11-09 15:27:54 +0800276 .resume = scsi_bus_resume,
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400277 .freeze = scsi_bus_freeze,
Aaron Lu80d2fd42012-11-09 15:27:54 +0800278 .thaw = scsi_bus_thaw,
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400279 .poweroff = scsi_bus_poweroff,
Aaron Lu80d2fd42012-11-09 15:27:54 +0800280 .restore = scsi_bus_restore,
Alan Sternbc4f2402010-06-17 10:41:42 -0400281 .runtime_suspend = scsi_runtime_suspend,
282 .runtime_resume = scsi_runtime_resume,
283 .runtime_idle = scsi_runtime_idle,
Alan Sterndb5bd1e2010-06-17 10:36:49 -0400284};