• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * sleep.c - ACPI sleep support.
3  *
4  * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
5  * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
6  * Copyright (c) 2000-2003 Patrick Mochel
7  * Copyright (c) 2003 Open Source Development Lab
8  *
9  * This file is released under the GPLv2.
10  *
11  */
12 
13 #include <linux/delay.h>
14 #include <linux/irq.h>
15 #include <linux/dmi.h>
16 #include <linux/device.h>
17 #include <linux/interrupt.h>
18 #include <linux/suspend.h>
19 #include <linux/reboot.h>
20 #include <linux/acpi.h>
21 #include <linux/module.h>
22 #include <linux/syscore_ops.h>
23 #include <asm/io.h>
24 #include <trace/events/power.h>
25 
26 #include "internal.h"
27 #include "sleep.h"
28 
29 /*
30  * Some HW-full platforms do not have _S5, so they may need
31  * to leverage efi power off for a shutdown.
32  */
33 bool acpi_no_s5;
34 static u8 sleep_states[ACPI_S_STATE_COUNT];
35 
acpi_sleep_tts_switch(u32 acpi_state)36 static void acpi_sleep_tts_switch(u32 acpi_state)
37 {
38 	acpi_status status;
39 
40 	status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state);
41 	if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
42 		/*
43 		 * OS can't evaluate the _TTS object correctly. Some warning
44 		 * message will be printed. But it won't break anything.
45 		 */
46 		printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
47 	}
48 }
49 
tts_notify_reboot(struct notifier_block * this,unsigned long code,void * x)50 static int tts_notify_reboot(struct notifier_block *this,
51 			unsigned long code, void *x)
52 {
53 	acpi_sleep_tts_switch(ACPI_STATE_S5);
54 	return NOTIFY_DONE;
55 }
56 
57 static struct notifier_block tts_notifier = {
58 	.notifier_call	= tts_notify_reboot,
59 	.next		= NULL,
60 	.priority	= 0,
61 };
62 
acpi_sleep_prepare(u32 acpi_state)63 static int acpi_sleep_prepare(u32 acpi_state)
64 {
65 #ifdef CONFIG_ACPI_SLEEP
66 	/* do we have a wakeup address for S2 and S3? */
67 	if (acpi_state == ACPI_STATE_S3) {
68 		if (!acpi_wakeup_address)
69 			return -EFAULT;
70 		acpi_set_waking_vector(acpi_wakeup_address);
71 
72 	}
73 	ACPI_FLUSH_CPU_CACHE();
74 #endif
75 	printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
76 		acpi_state);
77 	acpi_enable_wakeup_devices(acpi_state);
78 	acpi_enter_sleep_state_prep(acpi_state);
79 	return 0;
80 }
81 
acpi_sleep_state_supported(u8 sleep_state)82 static bool acpi_sleep_state_supported(u8 sleep_state)
83 {
84 	acpi_status status;
85 	u8 type_a, type_b;
86 
87 	status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
88 	return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
89 		|| (acpi_gbl_FADT.sleep_control.address
90 			&& acpi_gbl_FADT.sleep_status.address));
91 }
92 
93 #ifdef CONFIG_ACPI_SLEEP
94 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
95 
acpi_target_system_state(void)96 u32 acpi_target_system_state(void)
97 {
98 	return acpi_target_sleep_state;
99 }
100 EXPORT_SYMBOL_GPL(acpi_target_system_state);
101 
102 static bool pwr_btn_event_pending;
103 
104 /*
105  * The ACPI specification wants us to save NVS memory regions during hibernation
106  * and to restore them during the subsequent resume.  Windows does that also for
107  * suspend to RAM.  However, it is known that this mechanism does not work on
108  * all machines, so we allow the user to disable it with the help of the
109  * 'acpi_sleep=nonvs' kernel command line option.
110  */
111 static bool nvs_nosave;
112 
acpi_nvs_nosave(void)113 void __init acpi_nvs_nosave(void)
114 {
115 	nvs_nosave = true;
116 }
117 
118 /*
119  * The ACPI specification wants us to save NVS memory regions during hibernation
120  * but says nothing about saving NVS during S3.  Not all versions of Windows
121  * save NVS on S3 suspend either, and it is clear that not all systems need
122  * NVS to be saved at S3 time.  To improve suspend/resume time, allow the
123  * user to disable saving NVS on S3 if their system does not require it, but
124  * continue to save/restore NVS for S4 as specified.
125  */
126 static bool nvs_nosave_s3;
127 
acpi_nvs_nosave_s3(void)128 void __init acpi_nvs_nosave_s3(void)
129 {
130 	nvs_nosave_s3 = true;
131 }
132 
init_nvs_save_s3(const struct dmi_system_id * d)133 static int __init init_nvs_save_s3(const struct dmi_system_id *d)
134 {
135 	nvs_nosave_s3 = false;
136 	return 0;
137 }
138 
139 /*
140  * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
141  * user to request that behavior by using the 'acpi_old_suspend_ordering'
142  * kernel command line option that causes the following variable to be set.
143  */
144 static bool old_suspend_ordering;
145 
acpi_old_suspend_ordering(void)146 void __init acpi_old_suspend_ordering(void)
147 {
148 	old_suspend_ordering = true;
149 }
150 
init_old_suspend_ordering(const struct dmi_system_id * d)151 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
152 {
153 	acpi_old_suspend_ordering();
154 	return 0;
155 }
156 
init_nvs_nosave(const struct dmi_system_id * d)157 static int __init init_nvs_nosave(const struct dmi_system_id *d)
158 {
159 	acpi_nvs_nosave();
160 	return 0;
161 }
162 
163 static struct dmi_system_id acpisleep_dmi_table[] __initdata = {
164 	{
165 	.callback = init_old_suspend_ordering,
166 	.ident = "Abit KN9 (nForce4 variant)",
167 	.matches = {
168 		DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
169 		DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
170 		},
171 	},
172 	{
173 	.callback = init_old_suspend_ordering,
174 	.ident = "HP xw4600 Workstation",
175 	.matches = {
176 		DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
177 		DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
178 		},
179 	},
180 	{
181 	.callback = init_old_suspend_ordering,
182 	.ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
183 	.matches = {
184 		DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
185 		DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
186 		},
187 	},
188 	{
189 	.callback = init_old_suspend_ordering,
190 	.ident = "Panasonic CF51-2L",
191 	.matches = {
192 		DMI_MATCH(DMI_BOARD_VENDOR,
193 				"Matsushita Electric Industrial Co.,Ltd."),
194 		DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
195 		},
196 	},
197 	{
198 	.callback = init_nvs_nosave,
199 	.ident = "Sony Vaio VGN-FW41E_H",
200 	.matches = {
201 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
202 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
203 		},
204 	},
205 	{
206 	.callback = init_nvs_nosave,
207 	.ident = "Sony Vaio VGN-FW21E",
208 	.matches = {
209 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
210 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
211 		},
212 	},
213 	{
214 	.callback = init_nvs_nosave,
215 	.ident = "Sony Vaio VGN-FW21M",
216 	.matches = {
217 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
218 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
219 		},
220 	},
221 	{
222 	.callback = init_nvs_nosave,
223 	.ident = "Sony Vaio VPCEB17FX",
224 	.matches = {
225 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
226 		DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
227 		},
228 	},
229 	{
230 	.callback = init_nvs_nosave,
231 	.ident = "Sony Vaio VGN-SR11M",
232 	.matches = {
233 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
234 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
235 		},
236 	},
237 	{
238 	.callback = init_nvs_nosave,
239 	.ident = "Everex StepNote Series",
240 	.matches = {
241 		DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
242 		DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
243 		},
244 	},
245 	{
246 	.callback = init_nvs_nosave,
247 	.ident = "Sony Vaio VPCEB1Z1E",
248 	.matches = {
249 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
250 		DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
251 		},
252 	},
253 	{
254 	.callback = init_nvs_nosave,
255 	.ident = "Sony Vaio VGN-NW130D",
256 	.matches = {
257 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
258 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
259 		},
260 	},
261 	{
262 	.callback = init_nvs_nosave,
263 	.ident = "Sony Vaio VPCCW29FX",
264 	.matches = {
265 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
266 		DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
267 		},
268 	},
269 	{
270 	.callback = init_nvs_nosave,
271 	.ident = "Averatec AV1020-ED2",
272 	.matches = {
273 		DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
274 		DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
275 		},
276 	},
277 	{
278 	.callback = init_old_suspend_ordering,
279 	.ident = "Asus A8N-SLI DELUXE",
280 	.matches = {
281 		DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
282 		DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
283 		},
284 	},
285 	{
286 	.callback = init_old_suspend_ordering,
287 	.ident = "Asus A8N-SLI Premium",
288 	.matches = {
289 		DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
290 		DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
291 		},
292 	},
293 	{
294 	.callback = init_nvs_nosave,
295 	.ident = "Sony Vaio VGN-SR26GN_P",
296 	.matches = {
297 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
298 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
299 		},
300 	},
301 	{
302 	.callback = init_nvs_nosave,
303 	.ident = "Sony Vaio VPCEB1S1E",
304 	.matches = {
305 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
306 		DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
307 		},
308 	},
309 	{
310 	.callback = init_nvs_nosave,
311 	.ident = "Sony Vaio VGN-FW520F",
312 	.matches = {
313 		DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
314 		DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
315 		},
316 	},
317 	{
318 	.callback = init_nvs_nosave,
319 	.ident = "Asus K54C",
320 	.matches = {
321 		DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
322 		DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
323 		},
324 	},
325 	{
326 	.callback = init_nvs_nosave,
327 	.ident = "Asus K54HR",
328 	.matches = {
329 		DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
330 		DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
331 		},
332 	},
333 	/*
334 	 * https://bugzilla.kernel.org/show_bug.cgi?id=189431
335 	 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory
336 	 * saving during S3.
337 	 */
338 	{
339 	.callback = init_nvs_save_s3,
340 	.ident = "Lenovo G50-45",
341 	.matches = {
342 		DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
343 		DMI_MATCH(DMI_PRODUCT_NAME, "80E3"),
344 		},
345 	},
346 	{},
347 };
348 
acpi_sleep_dmi_check(void)349 static void __init acpi_sleep_dmi_check(void)
350 {
351 	int year;
352 
353 	if (dmi_get_date(DMI_BIOS_DATE, &year, NULL, NULL) && year >= 2012)
354 		acpi_nvs_nosave_s3();
355 
356 	dmi_check_system(acpisleep_dmi_table);
357 }
358 
359 /**
360  * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
361  */
acpi_pm_freeze(void)362 static int acpi_pm_freeze(void)
363 {
364 	acpi_disable_all_gpes();
365 	acpi_os_wait_events_complete();
366 	acpi_ec_block_transactions();
367 	return 0;
368 }
369 
370 /**
371  * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
372  */
acpi_pm_pre_suspend(void)373 static int acpi_pm_pre_suspend(void)
374 {
375 	acpi_pm_freeze();
376 	return suspend_nvs_save();
377 }
378 
379 /**
380  *	__acpi_pm_prepare - Prepare the platform to enter the target state.
381  *
382  *	If necessary, set the firmware waking vector and do arch-specific
383  *	nastiness to get the wakeup code to the waking vector.
384  */
__acpi_pm_prepare(void)385 static int __acpi_pm_prepare(void)
386 {
387 	int error = acpi_sleep_prepare(acpi_target_sleep_state);
388 	if (error)
389 		acpi_target_sleep_state = ACPI_STATE_S0;
390 
391 	return error;
392 }
393 
394 /**
395  *	acpi_pm_prepare - Prepare the platform to enter the target sleep
396  *		state and disable the GPEs.
397  */
acpi_pm_prepare(void)398 static int acpi_pm_prepare(void)
399 {
400 	int error = __acpi_pm_prepare();
401 	if (!error)
402 		error = acpi_pm_pre_suspend();
403 
404 	return error;
405 }
406 
find_powerf_dev(struct device * dev,void * data)407 static int find_powerf_dev(struct device *dev, void *data)
408 {
409 	struct acpi_device *device = to_acpi_device(dev);
410 	const char *hid = acpi_device_hid(device);
411 
412 	return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
413 }
414 
415 /**
416  *	acpi_pm_finish - Instruct the platform to leave a sleep state.
417  *
418  *	This is called after we wake back up (or if entering the sleep state
419  *	failed).
420  */
acpi_pm_finish(void)421 static void acpi_pm_finish(void)
422 {
423 	struct device *pwr_btn_dev;
424 	u32 acpi_state = acpi_target_sleep_state;
425 
426 	acpi_ec_unblock_transactions();
427 	suspend_nvs_free();
428 
429 	if (acpi_state == ACPI_STATE_S0)
430 		return;
431 
432 	printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
433 		acpi_state);
434 	acpi_disable_wakeup_devices(acpi_state);
435 	acpi_leave_sleep_state(acpi_state);
436 
437 	/* reset firmware waking vector */
438 	acpi_set_waking_vector(0);
439 
440 	acpi_target_sleep_state = ACPI_STATE_S0;
441 
442 	acpi_resume_power_resources();
443 
444 	/* If we were woken with the fixed power button, provide a small
445 	 * hint to userspace in the form of a wakeup event on the fixed power
446 	 * button device (if it can be found).
447 	 *
448 	 * We delay the event generation til now, as the PM layer requires
449 	 * timekeeping to be running before we generate events. */
450 	if (!pwr_btn_event_pending)
451 		return;
452 
453 	pwr_btn_event_pending = false;
454 	pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
455 				      find_powerf_dev);
456 	if (pwr_btn_dev) {
457 		pm_wakeup_event(pwr_btn_dev, 0);
458 		put_device(pwr_btn_dev);
459 	}
460 }
461 
462 /**
463  * acpi_pm_start - Start system PM transition.
464  */
acpi_pm_start(u32 acpi_state)465 static void acpi_pm_start(u32 acpi_state)
466 {
467 	acpi_target_sleep_state = acpi_state;
468 	acpi_sleep_tts_switch(acpi_target_sleep_state);
469 	acpi_scan_lock_acquire();
470 }
471 
472 /**
473  * acpi_pm_end - Finish up system PM transition.
474  */
acpi_pm_end(void)475 static void acpi_pm_end(void)
476 {
477 	acpi_turn_off_unused_power_resources();
478 	acpi_scan_lock_release();
479 	/*
480 	 * This is necessary in case acpi_pm_finish() is not called during a
481 	 * failing transition to a sleep state.
482 	 */
483 	acpi_target_sleep_state = ACPI_STATE_S0;
484 	acpi_sleep_tts_switch(acpi_target_sleep_state);
485 }
486 #else /* !CONFIG_ACPI_SLEEP */
487 #define acpi_target_sleep_state	ACPI_STATE_S0
acpi_sleep_dmi_check(void)488 static inline void acpi_sleep_dmi_check(void) {}
489 #endif /* CONFIG_ACPI_SLEEP */
490 
491 #ifdef CONFIG_SUSPEND
492 static u32 acpi_suspend_states[] = {
493 	[PM_SUSPEND_ON] = ACPI_STATE_S0,
494 	[PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
495 	[PM_SUSPEND_MEM] = ACPI_STATE_S3,
496 	[PM_SUSPEND_MAX] = ACPI_STATE_S5
497 };
498 
499 /**
500  *	acpi_suspend_begin - Set the target system sleep state to the state
501  *		associated with given @pm_state, if supported.
502  */
acpi_suspend_begin(suspend_state_t pm_state)503 static int acpi_suspend_begin(suspend_state_t pm_state)
504 {
505 	u32 acpi_state = acpi_suspend_states[pm_state];
506 	int error;
507 
508 	error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
509 	if (error)
510 		return error;
511 
512 	if (!sleep_states[acpi_state]) {
513 		pr_err("ACPI does not support sleep state S%u\n", acpi_state);
514 		return -ENOSYS;
515 	}
516 	if (acpi_state > ACPI_STATE_S1)
517 		pm_set_suspend_via_firmware();
518 
519 	acpi_pm_start(acpi_state);
520 	return 0;
521 }
522 
523 /**
524  *	acpi_suspend_enter - Actually enter a sleep state.
525  *	@pm_state: ignored
526  *
527  *	Flush caches and go to sleep. For STR we have to call arch-specific
528  *	assembly, which in turn call acpi_enter_sleep_state().
529  *	It's unfortunate, but it works. Please fix if you're feeling frisky.
530  */
acpi_suspend_enter(suspend_state_t pm_state)531 static int acpi_suspend_enter(suspend_state_t pm_state)
532 {
533 	acpi_status status = AE_OK;
534 	u32 acpi_state = acpi_target_sleep_state;
535 	int error;
536 
537 	ACPI_FLUSH_CPU_CACHE();
538 
539 	trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
540 	switch (acpi_state) {
541 	case ACPI_STATE_S1:
542 		barrier();
543 		status = acpi_enter_sleep_state(acpi_state);
544 		break;
545 
546 	case ACPI_STATE_S3:
547 		if (!acpi_suspend_lowlevel)
548 			return -ENOSYS;
549 		error = acpi_suspend_lowlevel();
550 		if (error)
551 			return error;
552 		pr_info(PREFIX "Low-level resume complete\n");
553 		pm_set_resume_via_firmware();
554 		break;
555 	}
556 	trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
557 
558 	/* This violates the spec but is required for bug compatibility. */
559 	acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
560 
561 	/* Reprogram control registers */
562 	acpi_leave_sleep_state_prep(acpi_state);
563 
564 	/* ACPI 3.0 specs (P62) says that it's the responsibility
565 	 * of the OSPM to clear the status bit [ implying that the
566 	 * POWER_BUTTON event should not reach userspace ]
567 	 *
568 	 * However, we do generate a small hint for userspace in the form of
569 	 * a wakeup event. We flag this condition for now and generate the
570 	 * event later, as we're currently too early in resume to be able to
571 	 * generate wakeup events.
572 	 */
573 	if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
574 		acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
575 
576 		acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
577 
578 		if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
579 			acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
580 			/* Flag for later */
581 			pwr_btn_event_pending = true;
582 		}
583 	}
584 
585 	/*
586 	 * Disable and clear GPE status before interrupt is enabled. Some GPEs
587 	 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
588 	 * acpi_leave_sleep_state will reenable specific GPEs later
589 	 */
590 	acpi_disable_all_gpes();
591 	/* Allow EC transactions to happen. */
592 	acpi_ec_unblock_transactions();
593 
594 	suspend_nvs_restore();
595 
596 	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
597 }
598 
acpi_suspend_state_valid(suspend_state_t pm_state)599 static int acpi_suspend_state_valid(suspend_state_t pm_state)
600 {
601 	u32 acpi_state;
602 
603 	switch (pm_state) {
604 	case PM_SUSPEND_ON:
605 	case PM_SUSPEND_STANDBY:
606 	case PM_SUSPEND_MEM:
607 		acpi_state = acpi_suspend_states[pm_state];
608 
609 		return sleep_states[acpi_state];
610 	default:
611 		return 0;
612 	}
613 }
614 
615 static const struct platform_suspend_ops acpi_suspend_ops = {
616 	.valid = acpi_suspend_state_valid,
617 	.begin = acpi_suspend_begin,
618 	.prepare_late = acpi_pm_prepare,
619 	.enter = acpi_suspend_enter,
620 	.wake = acpi_pm_finish,
621 	.end = acpi_pm_end,
622 };
623 
624 /**
625  *	acpi_suspend_begin_old - Set the target system sleep state to the
626  *		state associated with given @pm_state, if supported, and
627  *		execute the _PTS control method.  This function is used if the
628  *		pre-ACPI 2.0 suspend ordering has been requested.
629  */
acpi_suspend_begin_old(suspend_state_t pm_state)630 static int acpi_suspend_begin_old(suspend_state_t pm_state)
631 {
632 	int error = acpi_suspend_begin(pm_state);
633 	if (!error)
634 		error = __acpi_pm_prepare();
635 
636 	return error;
637 }
638 
639 /*
640  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
641  * been requested.
642  */
643 static const struct platform_suspend_ops acpi_suspend_ops_old = {
644 	.valid = acpi_suspend_state_valid,
645 	.begin = acpi_suspend_begin_old,
646 	.prepare_late = acpi_pm_pre_suspend,
647 	.enter = acpi_suspend_enter,
648 	.wake = acpi_pm_finish,
649 	.end = acpi_pm_end,
650 	.recover = acpi_pm_finish,
651 };
652 
acpi_freeze_begin(void)653 static int acpi_freeze_begin(void)
654 {
655 	acpi_scan_lock_acquire();
656 	return 0;
657 }
658 
acpi_freeze_prepare(void)659 static int acpi_freeze_prepare(void)
660 {
661 	acpi_enable_wakeup_devices(ACPI_STATE_S0);
662 	acpi_enable_all_wakeup_gpes();
663 	acpi_os_wait_events_complete();
664 	if (acpi_sci_irq_valid())
665 		enable_irq_wake(acpi_sci_irq);
666 	return 0;
667 }
668 
acpi_freeze_restore(void)669 static void acpi_freeze_restore(void)
670 {
671 	acpi_disable_wakeup_devices(ACPI_STATE_S0);
672 	if (acpi_sci_irq_valid())
673 		disable_irq_wake(acpi_sci_irq);
674 	acpi_enable_all_runtime_gpes();
675 }
676 
acpi_freeze_end(void)677 static void acpi_freeze_end(void)
678 {
679 	acpi_scan_lock_release();
680 }
681 
682 static const struct platform_freeze_ops acpi_freeze_ops = {
683 	.begin = acpi_freeze_begin,
684 	.prepare = acpi_freeze_prepare,
685 	.restore = acpi_freeze_restore,
686 	.end = acpi_freeze_end,
687 };
688 
acpi_sleep_suspend_setup(void)689 static void acpi_sleep_suspend_setup(void)
690 {
691 	int i;
692 
693 	for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
694 		if (acpi_sleep_state_supported(i))
695 			sleep_states[i] = 1;
696 
697 	suspend_set_ops(old_suspend_ordering ?
698 		&acpi_suspend_ops_old : &acpi_suspend_ops);
699 	freeze_set_ops(&acpi_freeze_ops);
700 }
701 
702 #else /* !CONFIG_SUSPEND */
acpi_sleep_suspend_setup(void)703 static inline void acpi_sleep_suspend_setup(void) {}
704 #endif /* !CONFIG_SUSPEND */
705 
706 #ifdef CONFIG_PM_SLEEP
707 static u32 saved_bm_rld;
708 
acpi_save_bm_rld(void)709 static int  acpi_save_bm_rld(void)
710 {
711 	acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
712 	return 0;
713 }
714 
acpi_restore_bm_rld(void)715 static void  acpi_restore_bm_rld(void)
716 {
717 	u32 resumed_bm_rld = 0;
718 
719 	acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
720 	if (resumed_bm_rld == saved_bm_rld)
721 		return;
722 
723 	acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
724 }
725 
726 static struct syscore_ops acpi_sleep_syscore_ops = {
727 	.suspend = acpi_save_bm_rld,
728 	.resume = acpi_restore_bm_rld,
729 };
730 
acpi_sleep_syscore_init(void)731 void acpi_sleep_syscore_init(void)
732 {
733 	register_syscore_ops(&acpi_sleep_syscore_ops);
734 }
735 #else
acpi_sleep_syscore_init(void)736 static inline void acpi_sleep_syscore_init(void) {}
737 #endif /* CONFIG_PM_SLEEP */
738 
739 #ifdef CONFIG_HIBERNATION
740 static unsigned long s4_hardware_signature;
741 static struct acpi_table_facs *facs;
742 static bool nosigcheck;
743 
acpi_no_s4_hw_signature(void)744 void __init acpi_no_s4_hw_signature(void)
745 {
746 	nosigcheck = true;
747 }
748 
acpi_hibernation_begin(void)749 static int acpi_hibernation_begin(void)
750 {
751 	int error;
752 
753 	error = nvs_nosave ? 0 : suspend_nvs_alloc();
754 	if (!error)
755 		acpi_pm_start(ACPI_STATE_S4);
756 
757 	return error;
758 }
759 
acpi_hibernation_enter(void)760 static int acpi_hibernation_enter(void)
761 {
762 	acpi_status status = AE_OK;
763 
764 	ACPI_FLUSH_CPU_CACHE();
765 
766 	/* This shouldn't return.  If it returns, we have a problem */
767 	status = acpi_enter_sleep_state(ACPI_STATE_S4);
768 	/* Reprogram control registers */
769 	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
770 
771 	return ACPI_SUCCESS(status) ? 0 : -EFAULT;
772 }
773 
acpi_hibernation_leave(void)774 static void acpi_hibernation_leave(void)
775 {
776 	pm_set_resume_via_firmware();
777 	/*
778 	 * If ACPI is not enabled by the BIOS and the boot kernel, we need to
779 	 * enable it here.
780 	 */
781 	acpi_enable();
782 	/* Reprogram control registers */
783 	acpi_leave_sleep_state_prep(ACPI_STATE_S4);
784 	/* Check the hardware signature */
785 	if (facs && s4_hardware_signature != facs->hardware_signature)
786 		pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
787 	/* Restore the NVS memory area */
788 	suspend_nvs_restore();
789 	/* Allow EC transactions to happen. */
790 	acpi_ec_unblock_transactions();
791 }
792 
acpi_pm_thaw(void)793 static void acpi_pm_thaw(void)
794 {
795 	acpi_ec_unblock_transactions();
796 	acpi_enable_all_runtime_gpes();
797 }
798 
799 static const struct platform_hibernation_ops acpi_hibernation_ops = {
800 	.begin = acpi_hibernation_begin,
801 	.end = acpi_pm_end,
802 	.pre_snapshot = acpi_pm_prepare,
803 	.finish = acpi_pm_finish,
804 	.prepare = acpi_pm_prepare,
805 	.enter = acpi_hibernation_enter,
806 	.leave = acpi_hibernation_leave,
807 	.pre_restore = acpi_pm_freeze,
808 	.restore_cleanup = acpi_pm_thaw,
809 };
810 
811 /**
812  *	acpi_hibernation_begin_old - Set the target system sleep state to
813  *		ACPI_STATE_S4 and execute the _PTS control method.  This
814  *		function is used if the pre-ACPI 2.0 suspend ordering has been
815  *		requested.
816  */
acpi_hibernation_begin_old(void)817 static int acpi_hibernation_begin_old(void)
818 {
819 	int error;
820 	/*
821 	 * The _TTS object should always be evaluated before the _PTS object.
822 	 * When the old_suspended_ordering is true, the _PTS object is
823 	 * evaluated in the acpi_sleep_prepare.
824 	 */
825 	acpi_sleep_tts_switch(ACPI_STATE_S4);
826 
827 	error = acpi_sleep_prepare(ACPI_STATE_S4);
828 
829 	if (!error) {
830 		if (!nvs_nosave)
831 			error = suspend_nvs_alloc();
832 		if (!error) {
833 			acpi_target_sleep_state = ACPI_STATE_S4;
834 			acpi_scan_lock_acquire();
835 		}
836 	}
837 	return error;
838 }
839 
840 /*
841  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
842  * been requested.
843  */
844 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
845 	.begin = acpi_hibernation_begin_old,
846 	.end = acpi_pm_end,
847 	.pre_snapshot = acpi_pm_pre_suspend,
848 	.prepare = acpi_pm_freeze,
849 	.finish = acpi_pm_finish,
850 	.enter = acpi_hibernation_enter,
851 	.leave = acpi_hibernation_leave,
852 	.pre_restore = acpi_pm_freeze,
853 	.restore_cleanup = acpi_pm_thaw,
854 	.recover = acpi_pm_finish,
855 };
856 
acpi_sleep_hibernate_setup(void)857 static void acpi_sleep_hibernate_setup(void)
858 {
859 	if (!acpi_sleep_state_supported(ACPI_STATE_S4))
860 		return;
861 
862 	hibernation_set_ops(old_suspend_ordering ?
863 			&acpi_hibernation_ops_old : &acpi_hibernation_ops);
864 	sleep_states[ACPI_STATE_S4] = 1;
865 	if (nosigcheck)
866 		return;
867 
868 	acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
869 	if (facs)
870 		s4_hardware_signature = facs->hardware_signature;
871 }
872 #else /* !CONFIG_HIBERNATION */
acpi_sleep_hibernate_setup(void)873 static inline void acpi_sleep_hibernate_setup(void) {}
874 #endif /* !CONFIG_HIBERNATION */
875 
acpi_power_off_prepare(void)876 static void acpi_power_off_prepare(void)
877 {
878 	/* Prepare to power off the system */
879 	acpi_sleep_prepare(ACPI_STATE_S5);
880 	acpi_disable_all_gpes();
881 	acpi_os_wait_events_complete();
882 }
883 
acpi_power_off(void)884 static void acpi_power_off(void)
885 {
886 	/* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
887 	printk(KERN_DEBUG "%s called\n", __func__);
888 	local_irq_disable();
889 	acpi_enter_sleep_state(ACPI_STATE_S5);
890 }
891 
acpi_sleep_init(void)892 int __init acpi_sleep_init(void)
893 {
894 	char supported[ACPI_S_STATE_COUNT * 3 + 1];
895 	char *pos = supported;
896 	int i;
897 
898 	acpi_sleep_dmi_check();
899 
900 	sleep_states[ACPI_STATE_S0] = 1;
901 
902 	acpi_sleep_syscore_init();
903 	acpi_sleep_suspend_setup();
904 	acpi_sleep_hibernate_setup();
905 
906 	if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
907 		sleep_states[ACPI_STATE_S5] = 1;
908 		pm_power_off_prepare = acpi_power_off_prepare;
909 		pm_power_off = acpi_power_off;
910 	} else {
911 		acpi_no_s5 = true;
912 	}
913 
914 	supported[0] = 0;
915 	for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
916 		if (sleep_states[i])
917 			pos += sprintf(pos, " S%d", i);
918 	}
919 	pr_info(PREFIX "(supports%s)\n", supported);
920 
921 	/*
922 	 * Register the tts_notifier to reboot notifier list so that the _TTS
923 	 * object can also be evaluated when the system enters S5.
924 	 */
925 	register_reboot_notifier(&tts_notifier);
926 	return 0;
927 }
928