Commit | Line | Data |
---|---|---|
ec2cd81c RW |
1 | /* |
2 | * drivers/acpi/device_pm.c - ACPI device power management routines. | |
3 | * | |
4 | * Copyright (C) 2012, Intel Corp. | |
5 | * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> | |
6 | * | |
7 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as published | |
11 | * by the Free Software Foundation. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License along | |
19 | * with this program; if not, write to the Free Software Foundation, Inc., | |
20 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
21 | * | |
22 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
23 | */ | |
24 | ||
25 | #include <linux/device.h> | |
86b3832c | 26 | #include <linux/export.h> |
ec2cd81c | 27 | #include <linux/mutex.h> |
86b3832c | 28 | #include <linux/pm_qos.h> |
cd7bd02d | 29 | #include <linux/pm_runtime.h> |
ec2cd81c RW |
30 | |
31 | #include <acpi/acpi.h> | |
32 | #include <acpi/acpi_bus.h> | |
33 | ||
34 | static DEFINE_MUTEX(acpi_pm_notifier_lock); | |
35 | ||
36 | /** | |
37 | * acpi_add_pm_notifier - Register PM notifier for given ACPI device. | |
38 | * @adev: ACPI device to add the notifier for. | |
39 | * @context: Context information to pass to the notifier routine. | |
40 | * | |
41 | * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of | |
42 | * PM wakeup events. For example, wakeup events may be generated for bridges | |
43 | * if one of the devices below the bridge is signaling wakeup, even if the | |
44 | * bridge itself doesn't have a wakeup GPE associated with it. | |
45 | */ | |
46 | acpi_status acpi_add_pm_notifier(struct acpi_device *adev, | |
47 | acpi_notify_handler handler, void *context) | |
48 | { | |
49 | acpi_status status = AE_ALREADY_EXISTS; | |
50 | ||
51 | mutex_lock(&acpi_pm_notifier_lock); | |
52 | ||
53 | if (adev->wakeup.flags.notifier_present) | |
54 | goto out; | |
55 | ||
56 | status = acpi_install_notify_handler(adev->handle, | |
57 | ACPI_SYSTEM_NOTIFY, | |
58 | handler, context); | |
59 | if (ACPI_FAILURE(status)) | |
60 | goto out; | |
61 | ||
62 | adev->wakeup.flags.notifier_present = true; | |
63 | ||
64 | out: | |
65 | mutex_unlock(&acpi_pm_notifier_lock); | |
66 | return status; | |
67 | } | |
68 | ||
69 | /** | |
70 | * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device. | |
71 | * @adev: ACPI device to remove the notifier from. | |
72 | */ | |
73 | acpi_status acpi_remove_pm_notifier(struct acpi_device *adev, | |
74 | acpi_notify_handler handler) | |
75 | { | |
76 | acpi_status status = AE_BAD_PARAMETER; | |
77 | ||
78 | mutex_lock(&acpi_pm_notifier_lock); | |
79 | ||
80 | if (!adev->wakeup.flags.notifier_present) | |
81 | goto out; | |
82 | ||
83 | status = acpi_remove_notify_handler(adev->handle, | |
84 | ACPI_SYSTEM_NOTIFY, | |
85 | handler); | |
86 | if (ACPI_FAILURE(status)) | |
87 | goto out; | |
88 | ||
89 | adev->wakeup.flags.notifier_present = false; | |
90 | ||
91 | out: | |
92 | mutex_unlock(&acpi_pm_notifier_lock); | |
93 | return status; | |
94 | } | |
86b3832c RW |
95 | |
96 | /** | |
97 | * acpi_device_power_state - Get preferred power state of ACPI device. | |
98 | * @dev: Device whose preferred target power state to return. | |
99 | * @adev: ACPI device node corresponding to @dev. | |
100 | * @target_state: System state to match the resultant device state. | |
101 | * @d_max_in: Deepest low-power state to take into consideration. | |
102 | * @d_min_p: Location to store the upper limit of the allowed states range. | |
103 | * Return value: Preferred power state of the device on success, -ENODEV | |
104 | * (if there's no 'struct acpi_device' for @dev) or -EINVAL on failure | |
105 | * | |
106 | * Find the lowest power (highest number) ACPI device power state that the | |
107 | * device can be in while the system is in the state represented by | |
108 | * @target_state. If @d_min_p is set, the highest power (lowest number) device | |
109 | * power state that @dev can be in for the given system sleep state is stored | |
110 | * at the location pointed to by it. | |
111 | * | |
112 | * Callers must ensure that @dev and @adev are valid pointers and that @adev | |
113 | * actually corresponds to @dev before using this function. | |
114 | */ | |
115 | int acpi_device_power_state(struct device *dev, struct acpi_device *adev, | |
116 | u32 target_state, int d_max_in, int *d_min_p) | |
117 | { | |
118 | char acpi_method[] = "_SxD"; | |
119 | unsigned long long d_min, d_max; | |
120 | bool wakeup = false; | |
121 | ||
122 | if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3) | |
123 | return -EINVAL; | |
124 | ||
125 | if (d_max_in > ACPI_STATE_D3_HOT) { | |
126 | enum pm_qos_flags_status stat; | |
127 | ||
128 | stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF); | |
129 | if (stat == PM_QOS_FLAGS_ALL) | |
130 | d_max_in = ACPI_STATE_D3_HOT; | |
131 | } | |
132 | ||
133 | acpi_method[2] = '0' + target_state; | |
134 | /* | |
135 | * If the sleep state is S0, the lowest limit from ACPI is D3, | |
136 | * but if the device has _S0W, we will use the value from _S0W | |
137 | * as the lowest limit from ACPI. Finally, we will constrain | |
138 | * the lowest limit with the specified one. | |
139 | */ | |
140 | d_min = ACPI_STATE_D0; | |
141 | d_max = ACPI_STATE_D3; | |
142 | ||
143 | /* | |
144 | * If present, _SxD methods return the minimum D-state (highest power | |
145 | * state) we can use for the corresponding S-states. Otherwise, the | |
146 | * minimum D-state is D0 (ACPI 3.x). | |
147 | * | |
148 | * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer | |
149 | * provided -- that's our fault recovery, we ignore retval. | |
150 | */ | |
151 | if (target_state > ACPI_STATE_S0) { | |
152 | acpi_evaluate_integer(adev->handle, acpi_method, NULL, &d_min); | |
153 | wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid | |
154 | && adev->wakeup.sleep_state >= target_state; | |
155 | } else if (dev_pm_qos_flags(dev, PM_QOS_FLAG_REMOTE_WAKEUP) != | |
156 | PM_QOS_FLAGS_NONE) { | |
157 | wakeup = adev->wakeup.flags.valid; | |
158 | } | |
159 | ||
160 | /* | |
161 | * If _PRW says we can wake up the system from the target sleep state, | |
162 | * the D-state returned by _SxD is sufficient for that (we assume a | |
163 | * wakeup-aware driver if wake is set). Still, if _SxW exists | |
164 | * (ACPI 3.x), it should return the maximum (lowest power) D-state that | |
165 | * can wake the system. _S0W may be valid, too. | |
166 | */ | |
167 | if (wakeup) { | |
168 | acpi_status status; | |
169 | ||
170 | acpi_method[3] = 'W'; | |
171 | status = acpi_evaluate_integer(adev->handle, acpi_method, NULL, | |
172 | &d_max); | |
173 | if (ACPI_FAILURE(status)) { | |
174 | if (target_state != ACPI_STATE_S0 || | |
175 | status != AE_NOT_FOUND) | |
176 | d_max = d_min; | |
177 | } else if (d_max < d_min) { | |
178 | /* Warn the user of the broken DSDT */ | |
179 | printk(KERN_WARNING "ACPI: Wrong value from %s\n", | |
180 | acpi_method); | |
181 | /* Sanitize it */ | |
182 | d_min = d_max; | |
183 | } | |
184 | } | |
185 | ||
186 | if (d_max_in < d_min) | |
187 | return -EINVAL; | |
188 | if (d_min_p) | |
189 | *d_min_p = d_min; | |
190 | /* constrain d_max with specified lowest limit (max number) */ | |
191 | if (d_max > d_max_in) { | |
192 | for (d_max = d_max_in; d_max > d_min; d_max--) { | |
193 | if (adev->power.states[d_max].flags.valid) | |
194 | break; | |
195 | } | |
196 | } | |
197 | return d_max; | |
198 | } | |
199 | EXPORT_SYMBOL_GPL(acpi_device_power_state); | |
cd7bd02d | 200 | |
a6ae7594 RW |
201 | /** |
202 | * acpi_pm_device_sleep_state - Get preferred power state of ACPI device. | |
203 | * @dev: Device whose preferred target power state to return. | |
204 | * @d_min_p: Location to store the upper limit of the allowed states range. | |
205 | * @d_max_in: Deepest low-power state to take into consideration. | |
206 | * Return value: Preferred power state of the device on success, -ENODEV | |
207 | * (if there's no 'struct acpi_device' for @dev) or -EINVAL on failure | |
208 | * | |
209 | * The caller must ensure that @dev is valid before using this function. | |
210 | */ | |
211 | int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in) | |
212 | { | |
213 | acpi_handle handle = DEVICE_ACPI_HANDLE(dev); | |
214 | struct acpi_device *adev; | |
215 | ||
216 | if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) { | |
217 | dev_dbg(dev, "ACPI handle without context in %s!\n", __func__); | |
218 | return -ENODEV; | |
219 | } | |
220 | ||
221 | return acpi_device_power_state(dev, adev, acpi_target_system_state(), | |
222 | d_max_in, d_min_p); | |
223 | } | |
224 | EXPORT_SYMBOL(acpi_pm_device_sleep_state); | |
225 | ||
cd7bd02d RW |
226 | #ifdef CONFIG_PM_RUNTIME |
227 | /** | |
dee8370c RW |
228 | * __acpi_device_run_wake - Enable/disable runtime remote wakeup for device. |
229 | * @adev: ACPI device to enable/disable the remote wakeup for. | |
cd7bd02d RW |
230 | * @enable: Whether to enable or disable the wakeup functionality. |
231 | * | |
dee8370c RW |
232 | * Enable/disable the GPE associated with @adev so that it can generate |
233 | * wakeup signals for the device in response to external (remote) events and | |
234 | * enable/disable device wakeup power. | |
235 | * | |
236 | * Callers must ensure that @adev is a valid ACPI device node before executing | |
237 | * this function. | |
238 | */ | |
239 | int __acpi_device_run_wake(struct acpi_device *adev, bool enable) | |
240 | { | |
241 | struct acpi_device_wakeup *wakeup = &adev->wakeup; | |
242 | ||
243 | if (enable) { | |
244 | acpi_status res; | |
245 | int error; | |
246 | ||
247 | error = acpi_enable_wakeup_device_power(adev, ACPI_STATE_S0); | |
248 | if (error) | |
249 | return error; | |
250 | ||
251 | res = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number); | |
252 | if (ACPI_FAILURE(res)) { | |
253 | acpi_disable_wakeup_device_power(adev); | |
254 | return -EIO; | |
255 | } | |
256 | } else { | |
257 | acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number); | |
258 | acpi_disable_wakeup_device_power(adev); | |
259 | } | |
260 | return 0; | |
261 | } | |
262 | ||
263 | /** | |
264 | * acpi_pm_device_run_wake - Enable/disable remote wakeup for given device. | |
265 | * @dev: Device to enable/disable the platform to wake up. | |
266 | * @enable: Whether to enable or disable the wakeup functionality. | |
cd7bd02d RW |
267 | */ |
268 | int acpi_pm_device_run_wake(struct device *phys_dev, bool enable) | |
269 | { | |
dee8370c | 270 | struct acpi_device *adev; |
cd7bd02d RW |
271 | acpi_handle handle; |
272 | ||
273 | if (!device_run_wake(phys_dev)) | |
274 | return -EINVAL; | |
275 | ||
276 | handle = DEVICE_ACPI_HANDLE(phys_dev); | |
dee8370c RW |
277 | if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) { |
278 | dev_dbg(phys_dev, "ACPI handle without context in %s!\n", | |
cd7bd02d RW |
279 | __func__); |
280 | return -ENODEV; | |
281 | } | |
282 | ||
dee8370c | 283 | return __acpi_device_run_wake(adev, enable); |
cd7bd02d RW |
284 | } |
285 | EXPORT_SYMBOL(acpi_pm_device_run_wake); | |
286 | #endif /* CONFIG_PM_RUNTIME */ | |
dee8370c RW |
287 | |
288 | #ifdef CONFIG_PM_SLEEP | |
289 | /** | |
290 | * __acpi_device_sleep_wake - Enable or disable device to wake up the system. | |
291 | * @dev: Device to enable/desible to wake up the system. | |
292 | * @target_state: System state the device is supposed to wake up from. | |
293 | * @enable: Whether to enable or disable @dev to wake up the system. | |
294 | */ | |
295 | int __acpi_device_sleep_wake(struct acpi_device *adev, u32 target_state, | |
296 | bool enable) | |
297 | { | |
298 | return enable ? | |
299 | acpi_enable_wakeup_device_power(adev, target_state) : | |
300 | acpi_disable_wakeup_device_power(adev); | |
301 | } | |
a6ae7594 RW |
302 | |
303 | /** | |
304 | * acpi_pm_device_sleep_wake - Enable or disable device to wake up the system. | |
305 | * @dev: Device to enable/desible to wake up the system from sleep states. | |
306 | * @enable: Whether to enable or disable @dev to wake up the system. | |
307 | */ | |
308 | int acpi_pm_device_sleep_wake(struct device *dev, bool enable) | |
309 | { | |
310 | acpi_handle handle; | |
311 | struct acpi_device *adev; | |
312 | int error; | |
313 | ||
314 | if (!device_can_wakeup(dev)) | |
315 | return -EINVAL; | |
316 | ||
317 | handle = DEVICE_ACPI_HANDLE(dev); | |
318 | if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) { | |
319 | dev_dbg(dev, "ACPI handle without context in %s!\n", __func__); | |
320 | return -ENODEV; | |
321 | } | |
322 | ||
323 | error = __acpi_device_sleep_wake(adev, acpi_target_system_state(), | |
324 | enable); | |
325 | if (!error) | |
326 | dev_info(dev, "System wakeup %s by ACPI\n", | |
327 | enable ? "enabled" : "disabled"); | |
328 | ||
329 | return error; | |
330 | } | |
dee8370c | 331 | #endif /* CONFIG_PM_SLEEP */ |