hibernate.c 26 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115
  1. /*
  2. * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
  3. *
  4. * Copyright (c) 2003 Patrick Mochel
  5. * Copyright (c) 2003 Open Source Development Lab
  6. * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
  7. * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
  8. *
  9. * This file is released under the GPLv2.
  10. */
  11. #include <linux/export.h>
  12. #include <linux/suspend.h>
  13. #include <linux/syscalls.h>
  14. #include <linux/reboot.h>
  15. #include <linux/string.h>
  16. #include <linux/device.h>
  17. #include <linux/async.h>
  18. #include <linux/kmod.h>
  19. #include <linux/delay.h>
  20. #include <linux/fs.h>
  21. #include <linux/mount.h>
  22. #include <linux/pm.h>
  23. #include <linux/console.h>
  24. #include <linux/cpu.h>
  25. #include <linux/freezer.h>
  26. #include <linux/gfp.h>
  27. #include <linux/syscore_ops.h>
  28. #include <scsi/scsi_scan.h>
  29. #include "power.h"
  30. static int nocompress;
  31. static int noresume;
  32. static int resume_wait;
  33. static int resume_delay;
  34. static char resume_file[256] = CONFIG_PM_STD_PARTITION;
  35. dev_t swsusp_resume_device;
  36. sector_t swsusp_resume_block;
  37. int in_suspend __nosavedata;
  38. enum {
  39. HIBERNATION_INVALID,
  40. HIBERNATION_PLATFORM,
  41. HIBERNATION_TEST,
  42. HIBERNATION_TESTPROC,
  43. HIBERNATION_SHUTDOWN,
  44. HIBERNATION_REBOOT,
  45. /* keep last */
  46. __HIBERNATION_AFTER_LAST
  47. };
  48. #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
  49. #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
  50. static int hibernation_mode = HIBERNATION_SHUTDOWN;
  51. static bool freezer_test_done;
  52. static const struct platform_hibernation_ops *hibernation_ops;
  53. /**
  54. * hibernation_set_ops - Set the global hibernate operations.
  55. * @ops: Hibernation operations to use in subsequent hibernation transitions.
  56. */
  57. void hibernation_set_ops(const struct platform_hibernation_ops *ops)
  58. {
  59. if (ops && !(ops->begin && ops->end && ops->pre_snapshot
  60. && ops->prepare && ops->finish && ops->enter && ops->pre_restore
  61. && ops->restore_cleanup && ops->leave)) {
  62. WARN_ON(1);
  63. return;
  64. }
  65. mutex_lock(&pm_mutex);
  66. hibernation_ops = ops;
  67. if (ops)
  68. hibernation_mode = HIBERNATION_PLATFORM;
  69. else if (hibernation_mode == HIBERNATION_PLATFORM)
  70. hibernation_mode = HIBERNATION_SHUTDOWN;
  71. mutex_unlock(&pm_mutex);
  72. }
  73. static bool entering_platform_hibernation;
  74. bool system_entering_hibernation(void)
  75. {
  76. return entering_platform_hibernation;
  77. }
  78. EXPORT_SYMBOL(system_entering_hibernation);
  79. #ifdef CONFIG_PM_DEBUG
  80. static void hibernation_debug_sleep(void)
  81. {
  82. printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
  83. mdelay(5000);
  84. }
  85. static int hibernation_testmode(int mode)
  86. {
  87. if (hibernation_mode == mode) {
  88. hibernation_debug_sleep();
  89. return 1;
  90. }
  91. return 0;
  92. }
  93. static int hibernation_test(int level)
  94. {
  95. if (pm_test_level == level) {
  96. hibernation_debug_sleep();
  97. return 1;
  98. }
  99. return 0;
  100. }
  101. #else /* !CONFIG_PM_DEBUG */
  102. static int hibernation_testmode(int mode) { return 0; }
  103. static int hibernation_test(int level) { return 0; }
  104. #endif /* !CONFIG_PM_DEBUG */
  105. /**
  106. * platform_begin - Call platform to start hibernation.
  107. * @platform_mode: Whether or not to use the platform driver.
  108. */
  109. static int platform_begin(int platform_mode)
  110. {
  111. return (platform_mode && hibernation_ops) ?
  112. hibernation_ops->begin() : 0;
  113. }
  114. /**
  115. * platform_end - Call platform to finish transition to the working state.
  116. * @platform_mode: Whether or not to use the platform driver.
  117. */
  118. static void platform_end(int platform_mode)
  119. {
  120. if (platform_mode && hibernation_ops)
  121. hibernation_ops->end();
  122. }
  123. /**
  124. * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
  125. * @platform_mode: Whether or not to use the platform driver.
  126. *
  127. * Use the platform driver to prepare the system for creating a hibernate image,
  128. * if so configured, and return an error code if that fails.
  129. */
  130. static int platform_pre_snapshot(int platform_mode)
  131. {
  132. return (platform_mode && hibernation_ops) ?
  133. hibernation_ops->pre_snapshot() : 0;
  134. }
  135. /**
  136. * platform_leave - Call platform to prepare a transition to the working state.
  137. * @platform_mode: Whether or not to use the platform driver.
  138. *
  139. * Use the platform driver prepare to prepare the machine for switching to the
  140. * normal mode of operation.
  141. *
  142. * This routine is called on one CPU with interrupts disabled.
  143. */
  144. static void platform_leave(int platform_mode)
  145. {
  146. if (platform_mode && hibernation_ops)
  147. hibernation_ops->leave();
  148. }
  149. /**
  150. * platform_finish - Call platform to switch the system to the working state.
  151. * @platform_mode: Whether or not to use the platform driver.
  152. *
  153. * Use the platform driver to switch the machine to the normal mode of
  154. * operation.
  155. *
  156. * This routine must be called after platform_prepare().
  157. */
  158. static void platform_finish(int platform_mode)
  159. {
  160. if (platform_mode && hibernation_ops)
  161. hibernation_ops->finish();
  162. }
  163. /**
  164. * platform_pre_restore - Prepare for hibernate image restoration.
  165. * @platform_mode: Whether or not to use the platform driver.
  166. *
  167. * Use the platform driver to prepare the system for resume from a hibernation
  168. * image.
  169. *
  170. * If the restore fails after this function has been called,
  171. * platform_restore_cleanup() must be called.
  172. */
  173. static int platform_pre_restore(int platform_mode)
  174. {
  175. return (platform_mode && hibernation_ops) ?
  176. hibernation_ops->pre_restore() : 0;
  177. }
  178. /**
  179. * platform_restore_cleanup - Switch to the working state after failing restore.
  180. * @platform_mode: Whether or not to use the platform driver.
  181. *
  182. * Use the platform driver to switch the system to the normal mode of operation
  183. * after a failing restore.
  184. *
  185. * If platform_pre_restore() has been called before the failing restore, this
  186. * function must be called too, regardless of the result of
  187. * platform_pre_restore().
  188. */
  189. static void platform_restore_cleanup(int platform_mode)
  190. {
  191. if (platform_mode && hibernation_ops)
  192. hibernation_ops->restore_cleanup();
  193. }
  194. /**
  195. * platform_recover - Recover from a failure to suspend devices.
  196. * @platform_mode: Whether or not to use the platform driver.
  197. */
  198. static void platform_recover(int platform_mode)
  199. {
  200. if (platform_mode && hibernation_ops && hibernation_ops->recover)
  201. hibernation_ops->recover();
  202. }
  203. /**
  204. * swsusp_show_speed - Print time elapsed between two events during hibernation.
  205. * @start: Starting event.
  206. * @stop: Final event.
  207. * @nr_pages: Number of memory pages processed between @start and @stop.
  208. * @msg: Additional diagnostic message to print.
  209. */
  210. void swsusp_show_speed(struct timeval *start, struct timeval *stop,
  211. unsigned nr_pages, char *msg)
  212. {
  213. s64 elapsed_centisecs64;
  214. int centisecs;
  215. int k;
  216. int kps;
  217. elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
  218. do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
  219. centisecs = elapsed_centisecs64;
  220. if (centisecs == 0)
  221. centisecs = 1; /* avoid div-by-zero */
  222. k = nr_pages * (PAGE_SIZE / 1024);
  223. kps = (k * 100) / centisecs;
  224. printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
  225. msg, k,
  226. centisecs / 100, centisecs % 100,
  227. kps / 1000, (kps % 1000) / 10);
  228. }
  229. /**
  230. * create_image - Create a hibernation image.
  231. * @platform_mode: Whether or not to use the platform driver.
  232. *
  233. * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
  234. * and execute the drivers' .thaw_noirq() callbacks.
  235. *
  236. * Control reappears in this routine after the subsequent restore.
  237. */
  238. static int create_image(int platform_mode)
  239. {
  240. int error;
  241. error = dpm_suspend_noirq(PMSG_FREEZE);
  242. if (error) {
  243. printk(KERN_ERR "PM: Some devices failed to power down, "
  244. "aborting hibernation\n");
  245. return error;
  246. }
  247. error = platform_pre_snapshot(platform_mode);
  248. if (error || hibernation_test(TEST_PLATFORM))
  249. goto Platform_finish;
  250. error = disable_nonboot_cpus();
  251. if (error || hibernation_test(TEST_CPUS)
  252. || hibernation_testmode(HIBERNATION_TEST))
  253. goto Enable_cpus;
  254. local_irq_disable();
  255. error = syscore_suspend();
  256. if (error) {
  257. printk(KERN_ERR "PM: Some system devices failed to power down, "
  258. "aborting hibernation\n");
  259. goto Enable_irqs;
  260. }
  261. if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
  262. goto Power_up;
  263. in_suspend = 1;
  264. save_processor_state();
  265. error = swsusp_arch_suspend();
  266. if (error)
  267. printk(KERN_ERR "PM: Error %d creating hibernation image\n",
  268. error);
  269. /* Restore control flow magically appears here */
  270. restore_processor_state();
  271. if (!in_suspend) {
  272. events_check_enabled = false;
  273. platform_leave(platform_mode);
  274. }
  275. Power_up:
  276. syscore_resume();
  277. Enable_irqs:
  278. local_irq_enable();
  279. Enable_cpus:
  280. enable_nonboot_cpus();
  281. Platform_finish:
  282. platform_finish(platform_mode);
  283. dpm_resume_noirq(in_suspend ?
  284. (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
  285. return error;
  286. }
  287. /**
  288. * hibernation_snapshot - Quiesce devices and create a hibernation image.
  289. * @platform_mode: If set, use platform driver to prepare for the transition.
  290. *
  291. * This routine must be called with pm_mutex held.
  292. */
  293. int hibernation_snapshot(int platform_mode)
  294. {
  295. pm_message_t msg = PMSG_RECOVER;
  296. int error;
  297. error = platform_begin(platform_mode);
  298. if (error)
  299. goto Close;
  300. /* Preallocate image memory before shutting down devices. */
  301. error = hibernate_preallocate_memory();
  302. if (error)
  303. goto Close;
  304. error = freeze_kernel_threads();
  305. if (error)
  306. goto Close;
  307. if (hibernation_test(TEST_FREEZER) ||
  308. hibernation_testmode(HIBERNATION_TESTPROC)) {
  309. /*
  310. * Indicate to the caller that we are returning due to a
  311. * successful freezer test.
  312. */
  313. freezer_test_done = true;
  314. goto Close;
  315. }
  316. error = dpm_prepare(PMSG_FREEZE);
  317. if (error)
  318. goto Complete_devices;
  319. suspend_console();
  320. pm_restrict_gfp_mask();
  321. error = dpm_suspend(PMSG_FREEZE);
  322. if (error)
  323. goto Recover_platform;
  324. if (hibernation_test(TEST_DEVICES))
  325. goto Recover_platform;
  326. error = create_image(platform_mode);
  327. /*
  328. * Control returns here (1) after the image has been created or the
  329. * image creation has failed and (2) after a successful restore.
  330. */
  331. Resume_devices:
  332. /* We may need to release the preallocated image pages here. */
  333. if (error || !in_suspend)
  334. swsusp_free();
  335. msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
  336. dpm_resume(msg);
  337. if (error || !in_suspend)
  338. pm_restore_gfp_mask();
  339. resume_console();
  340. Complete_devices:
  341. dpm_complete(msg);
  342. Close:
  343. platform_end(platform_mode);
  344. return error;
  345. Recover_platform:
  346. platform_recover(platform_mode);
  347. goto Resume_devices;
  348. }
  349. /**
  350. * resume_target_kernel - Restore system state from a hibernation image.
  351. * @platform_mode: Whether or not to use the platform driver.
  352. *
  353. * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
  354. * highmem that have not been restored yet from the image and run the low-level
  355. * code that will restore the remaining contents of memory and switch to the
  356. * just restored target kernel.
  357. */
  358. static int resume_target_kernel(bool platform_mode)
  359. {
  360. int error;
  361. error = dpm_suspend_noirq(PMSG_QUIESCE);
  362. if (error) {
  363. printk(KERN_ERR "PM: Some devices failed to power down, "
  364. "aborting resume\n");
  365. return error;
  366. }
  367. error = platform_pre_restore(platform_mode);
  368. if (error)
  369. goto Cleanup;
  370. error = disable_nonboot_cpus();
  371. if (error)
  372. goto Enable_cpus;
  373. local_irq_disable();
  374. error = syscore_suspend();
  375. if (error)
  376. goto Enable_irqs;
  377. save_processor_state();
  378. error = restore_highmem();
  379. if (!error) {
  380. error = swsusp_arch_resume();
  381. /*
  382. * The code below is only ever reached in case of a failure.
  383. * Otherwise, execution continues at the place where
  384. * swsusp_arch_suspend() was called.
  385. */
  386. BUG_ON(!error);
  387. /*
  388. * This call to restore_highmem() reverts the changes made by
  389. * the previous one.
  390. */
  391. restore_highmem();
  392. }
  393. /*
  394. * The only reason why swsusp_arch_resume() can fail is memory being
  395. * very tight, so we have to free it as soon as we can to avoid
  396. * subsequent failures.
  397. */
  398. swsusp_free();
  399. restore_processor_state();
  400. touch_softlockup_watchdog();
  401. syscore_resume();
  402. Enable_irqs:
  403. local_irq_enable();
  404. Enable_cpus:
  405. enable_nonboot_cpus();
  406. Cleanup:
  407. platform_restore_cleanup(platform_mode);
  408. dpm_resume_noirq(PMSG_RECOVER);
  409. return error;
  410. }
  411. /**
  412. * hibernation_restore - Quiesce devices and restore from a hibernation image.
  413. * @platform_mode: If set, use platform driver to prepare for the transition.
  414. *
  415. * This routine must be called with pm_mutex held. If it is successful, control
  416. * reappears in the restored target kernel in hibernation_snapshot().
  417. */
  418. int hibernation_restore(int platform_mode)
  419. {
  420. int error;
  421. pm_prepare_console();
  422. suspend_console();
  423. pm_restrict_gfp_mask();
  424. error = dpm_suspend_start(PMSG_QUIESCE);
  425. if (!error) {
  426. error = resume_target_kernel(platform_mode);
  427. dpm_resume_end(PMSG_RECOVER);
  428. }
  429. pm_restore_gfp_mask();
  430. resume_console();
  431. pm_restore_console();
  432. return error;
  433. }
  434. /**
  435. * hibernation_platform_enter - Power off the system using the platform driver.
  436. */
  437. int hibernation_platform_enter(void)
  438. {
  439. int error;
  440. if (!hibernation_ops)
  441. return -ENOSYS;
  442. /*
  443. * We have cancelled the power transition by running
  444. * hibernation_ops->finish() before saving the image, so we should let
  445. * the firmware know that we're going to enter the sleep state after all
  446. */
  447. error = hibernation_ops->begin();
  448. if (error)
  449. goto Close;
  450. entering_platform_hibernation = true;
  451. suspend_console();
  452. error = dpm_suspend_start(PMSG_HIBERNATE);
  453. if (error) {
  454. if (hibernation_ops->recover)
  455. hibernation_ops->recover();
  456. goto Resume_devices;
  457. }
  458. error = dpm_suspend_noirq(PMSG_HIBERNATE);
  459. if (error)
  460. goto Resume_devices;
  461. error = hibernation_ops->prepare();
  462. if (error)
  463. goto Platform_finish;
  464. error = disable_nonboot_cpus();
  465. if (error)
  466. goto Platform_finish;
  467. local_irq_disable();
  468. syscore_suspend();
  469. if (pm_wakeup_pending()) {
  470. error = -EAGAIN;
  471. goto Power_up;
  472. }
  473. hibernation_ops->enter();
  474. /* We should never get here */
  475. while (1);
  476. Power_up:
  477. syscore_resume();
  478. local_irq_enable();
  479. enable_nonboot_cpus();
  480. Platform_finish:
  481. hibernation_ops->finish();
  482. dpm_resume_noirq(PMSG_RESTORE);
  483. Resume_devices:
  484. entering_platform_hibernation = false;
  485. dpm_resume_end(PMSG_RESTORE);
  486. resume_console();
  487. Close:
  488. hibernation_ops->end();
  489. return error;
  490. }
  491. /**
  492. * power_down - Shut the machine down for hibernation.
  493. *
  494. * Use the platform driver, if configured, to put the system into the sleep
  495. * state corresponding to hibernation, or try to power it off or reboot,
  496. * depending on the value of hibernation_mode.
  497. */
  498. static void power_down(void)
  499. {
  500. switch (hibernation_mode) {
  501. case HIBERNATION_TEST:
  502. case HIBERNATION_TESTPROC:
  503. break;
  504. case HIBERNATION_REBOOT:
  505. kernel_restart(NULL);
  506. break;
  507. case HIBERNATION_PLATFORM:
  508. hibernation_platform_enter();
  509. case HIBERNATION_SHUTDOWN:
  510. kernel_power_off();
  511. break;
  512. }
  513. kernel_halt();
  514. /*
  515. * Valid image is on the disk, if we continue we risk serious data
  516. * corruption after resume.
  517. */
  518. printk(KERN_CRIT "PM: Please power down manually\n");
  519. while(1);
  520. }
  521. static int prepare_processes(void)
  522. {
  523. int error = 0;
  524. if (freeze_processes()) {
  525. error = -EBUSY;
  526. thaw_processes();
  527. }
  528. return error;
  529. }
  530. /**
  531. * hibernate - Carry out system hibernation, including saving the image.
  532. */
  533. int hibernate(void)
  534. {
  535. int error;
  536. mutex_lock(&pm_mutex);
  537. /* The snapshot device should not be opened while we're running */
  538. if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
  539. error = -EBUSY;
  540. goto Unlock;
  541. }
  542. pm_prepare_console();
  543. error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
  544. if (error)
  545. goto Exit;
  546. error = usermodehelper_disable();
  547. if (error)
  548. goto Exit;
  549. /* Allocate memory management structures */
  550. error = create_basic_memory_bitmaps();
  551. if (error)
  552. goto Exit;
  553. printk(KERN_INFO "PM: Syncing filesystems ... ");
  554. sys_sync();
  555. printk("done.\n");
  556. error = prepare_processes();
  557. if (error)
  558. goto Finish;
  559. error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
  560. if (error)
  561. goto Thaw;
  562. if (freezer_test_done) {
  563. freezer_test_done = false;
  564. goto Thaw;
  565. }
  566. if (in_suspend) {
  567. unsigned int flags = 0;
  568. if (hibernation_mode == HIBERNATION_PLATFORM)
  569. flags |= SF_PLATFORM_MODE;
  570. if (nocompress)
  571. flags |= SF_NOCOMPRESS_MODE;
  572. else
  573. flags |= SF_CRC32_MODE;
  574. pr_debug("PM: writing image.\n");
  575. error = swsusp_write(flags);
  576. swsusp_free();
  577. if (!error)
  578. power_down();
  579. in_suspend = 0;
  580. pm_restore_gfp_mask();
  581. } else {
  582. pr_debug("PM: Image restored successfully.\n");
  583. }
  584. Thaw:
  585. thaw_processes();
  586. Finish:
  587. free_basic_memory_bitmaps();
  588. usermodehelper_enable();
  589. Exit:
  590. pm_notifier_call_chain(PM_POST_HIBERNATION);
  591. pm_restore_console();
  592. atomic_inc(&snapshot_device_available);
  593. Unlock:
  594. mutex_unlock(&pm_mutex);
  595. return error;
  596. }
  597. /**
  598. * software_resume - Resume from a saved hibernation image.
  599. *
  600. * This routine is called as a late initcall, when all devices have been
  601. * discovered and initialized already.
  602. *
  603. * The image reading code is called to see if there is a hibernation image
  604. * available for reading. If that is the case, devices are quiesced and the
  605. * contents of memory is restored from the saved image.
  606. *
  607. * If this is successful, control reappears in the restored target kernel in
  608. * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
  609. * attempts to recover gracefully and make the kernel return to the normal mode
  610. * of operation.
  611. */
  612. static int software_resume(void)
  613. {
  614. int error;
  615. unsigned int flags;
  616. /*
  617. * If the user said "noresume".. bail out early.
  618. */
  619. if (noresume)
  620. return 0;
  621. /*
  622. * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
  623. * is configured into the kernel. Since the regular hibernate
  624. * trigger path is via sysfs which takes a buffer mutex before
  625. * calling hibernate functions (which take pm_mutex) this can
  626. * cause lockdep to complain about a possible ABBA deadlock
  627. * which cannot happen since we're in the boot code here and
  628. * sysfs can't be invoked yet. Therefore, we use a subclass
  629. * here to avoid lockdep complaining.
  630. */
  631. mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
  632. if (swsusp_resume_device)
  633. goto Check_image;
  634. if (!strlen(resume_file)) {
  635. error = -ENOENT;
  636. goto Unlock;
  637. }
  638. pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
  639. if (resume_delay) {
  640. printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
  641. resume_delay);
  642. ssleep(resume_delay);
  643. }
  644. /* Check if the device is there */
  645. swsusp_resume_device = name_to_dev_t(resume_file);
  646. if (!swsusp_resume_device) {
  647. /*
  648. * Some device discovery might still be in progress; we need
  649. * to wait for this to finish.
  650. */
  651. wait_for_device_probe();
  652. if (resume_wait) {
  653. while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
  654. msleep(10);
  655. async_synchronize_full();
  656. }
  657. /*
  658. * We can't depend on SCSI devices being available after loading
  659. * one of their modules until scsi_complete_async_scans() is
  660. * called and the resume device usually is a SCSI one.
  661. */
  662. scsi_complete_async_scans();
  663. swsusp_resume_device = name_to_dev_t(resume_file);
  664. if (!swsusp_resume_device) {
  665. error = -ENODEV;
  666. goto Unlock;
  667. }
  668. }
  669. Check_image:
  670. pr_debug("PM: Hibernation image partition %d:%d present\n",
  671. MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
  672. pr_debug("PM: Looking for hibernation image.\n");
  673. error = swsusp_check();
  674. if (error)
  675. goto Unlock;
  676. /* The snapshot device should not be opened while we're running */
  677. if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
  678. error = -EBUSY;
  679. swsusp_close(FMODE_READ);
  680. goto Unlock;
  681. }
  682. pm_prepare_console();
  683. error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
  684. if (error)
  685. goto close_finish;
  686. error = usermodehelper_disable();
  687. if (error)
  688. goto close_finish;
  689. error = create_basic_memory_bitmaps();
  690. if (error)
  691. goto close_finish;
  692. pr_debug("PM: Preparing processes for restore.\n");
  693. error = prepare_processes();
  694. if (error) {
  695. swsusp_close(FMODE_READ);
  696. goto Done;
  697. }
  698. pr_debug("PM: Loading hibernation image.\n");
  699. error = swsusp_read(&flags);
  700. swsusp_close(FMODE_READ);
  701. if (!error)
  702. hibernation_restore(flags & SF_PLATFORM_MODE);
  703. printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
  704. swsusp_free();
  705. thaw_processes();
  706. Done:
  707. free_basic_memory_bitmaps();
  708. usermodehelper_enable();
  709. Finish:
  710. pm_notifier_call_chain(PM_POST_RESTORE);
  711. pm_restore_console();
  712. atomic_inc(&snapshot_device_available);
  713. /* For success case, the suspend path will release the lock */
  714. Unlock:
  715. mutex_unlock(&pm_mutex);
  716. pr_debug("PM: Hibernation image not present or could not be loaded.\n");
  717. return error;
  718. close_finish:
  719. swsusp_close(FMODE_READ);
  720. goto Finish;
  721. }
  722. late_initcall(software_resume);
  723. static const char * const hibernation_modes[] = {
  724. [HIBERNATION_PLATFORM] = "platform",
  725. [HIBERNATION_SHUTDOWN] = "shutdown",
  726. [HIBERNATION_REBOOT] = "reboot",
  727. [HIBERNATION_TEST] = "test",
  728. [HIBERNATION_TESTPROC] = "testproc",
  729. };
  730. /*
  731. * /sys/power/disk - Control hibernation mode.
  732. *
  733. * Hibernation can be handled in several ways. There are a few different ways
  734. * to put the system into the sleep state: using the platform driver (e.g. ACPI
  735. * or other hibernation_ops), powering it off or rebooting it (for testing
  736. * mostly), or using one of the two available test modes.
  737. *
  738. * The sysfs file /sys/power/disk provides an interface for selecting the
  739. * hibernation mode to use. Reading from this file causes the available modes
  740. * to be printed. There are 5 modes that can be supported:
  741. *
  742. * 'platform'
  743. * 'shutdown'
  744. * 'reboot'
  745. * 'test'
  746. * 'testproc'
  747. *
  748. * If a platform hibernation driver is in use, 'platform' will be supported
  749. * and will be used by default. Otherwise, 'shutdown' will be used by default.
  750. * The selected option (i.e. the one corresponding to the current value of
  751. * hibernation_mode) is enclosed by a square bracket.
  752. *
  753. * To select a given hibernation mode it is necessary to write the mode's
  754. * string representation (as returned by reading from /sys/power/disk) back
  755. * into /sys/power/disk.
  756. */
  757. static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
  758. char *buf)
  759. {
  760. int i;
  761. char *start = buf;
  762. for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
  763. if (!hibernation_modes[i])
  764. continue;
  765. switch (i) {
  766. case HIBERNATION_SHUTDOWN:
  767. case HIBERNATION_REBOOT:
  768. case HIBERNATION_TEST:
  769. case HIBERNATION_TESTPROC:
  770. break;
  771. case HIBERNATION_PLATFORM:
  772. if (hibernation_ops)
  773. break;
  774. /* not a valid mode, continue with loop */
  775. continue;
  776. }
  777. if (i == hibernation_mode)
  778. buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
  779. else
  780. buf += sprintf(buf, "%s ", hibernation_modes[i]);
  781. }
  782. buf += sprintf(buf, "\n");
  783. return buf-start;
  784. }
  785. static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
  786. const char *buf, size_t n)
  787. {
  788. int error = 0;
  789. int i;
  790. int len;
  791. char *p;
  792. int mode = HIBERNATION_INVALID;
  793. p = memchr(buf, '\n', n);
  794. len = p ? p - buf : n;
  795. mutex_lock(&pm_mutex);
  796. for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
  797. if (len == strlen(hibernation_modes[i])
  798. && !strncmp(buf, hibernation_modes[i], len)) {
  799. mode = i;
  800. break;
  801. }
  802. }
  803. if (mode != HIBERNATION_INVALID) {
  804. switch (mode) {
  805. case HIBERNATION_SHUTDOWN:
  806. case HIBERNATION_REBOOT:
  807. case HIBERNATION_TEST:
  808. case HIBERNATION_TESTPROC:
  809. hibernation_mode = mode;
  810. break;
  811. case HIBERNATION_PLATFORM:
  812. if (hibernation_ops)
  813. hibernation_mode = mode;
  814. else
  815. error = -EINVAL;
  816. }
  817. } else
  818. error = -EINVAL;
  819. if (!error)
  820. pr_debug("PM: Hibernation mode set to '%s'\n",
  821. hibernation_modes[mode]);
  822. mutex_unlock(&pm_mutex);
  823. return error ? error : n;
  824. }
  825. power_attr(disk);
  826. static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
  827. char *buf)
  828. {
  829. return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
  830. MINOR(swsusp_resume_device));
  831. }
  832. static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
  833. const char *buf, size_t n)
  834. {
  835. unsigned int maj, min;
  836. dev_t res;
  837. int ret = -EINVAL;
  838. if (sscanf(buf, "%u:%u", &maj, &min) != 2)
  839. goto out;
  840. res = MKDEV(maj,min);
  841. if (maj != MAJOR(res) || min != MINOR(res))
  842. goto out;
  843. mutex_lock(&pm_mutex);
  844. swsusp_resume_device = res;
  845. mutex_unlock(&pm_mutex);
  846. printk(KERN_INFO "PM: Starting manual resume from disk\n");
  847. noresume = 0;
  848. software_resume();
  849. ret = n;
  850. out:
  851. return ret;
  852. }
  853. power_attr(resume);
  854. static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
  855. char *buf)
  856. {
  857. return sprintf(buf, "%lu\n", image_size);
  858. }
  859. static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
  860. const char *buf, size_t n)
  861. {
  862. unsigned long size;
  863. if (sscanf(buf, "%lu", &size) == 1) {
  864. image_size = size;
  865. return n;
  866. }
  867. return -EINVAL;
  868. }
  869. power_attr(image_size);
  870. static ssize_t reserved_size_show(struct kobject *kobj,
  871. struct kobj_attribute *attr, char *buf)
  872. {
  873. return sprintf(buf, "%lu\n", reserved_size);
  874. }
  875. static ssize_t reserved_size_store(struct kobject *kobj,
  876. struct kobj_attribute *attr,
  877. const char *buf, size_t n)
  878. {
  879. unsigned long size;
  880. if (sscanf(buf, "%lu", &size) == 1) {
  881. reserved_size = size;
  882. return n;
  883. }
  884. return -EINVAL;
  885. }
  886. power_attr(reserved_size);
  887. static struct attribute * g[] = {
  888. &disk_attr.attr,
  889. &resume_attr.attr,
  890. &image_size_attr.attr,
  891. &reserved_size_attr.attr,
  892. NULL,
  893. };
  894. static struct attribute_group attr_group = {
  895. .attrs = g,
  896. };
  897. static int __init pm_disk_init(void)
  898. {
  899. return sysfs_create_group(power_kobj, &attr_group);
  900. }
  901. core_initcall(pm_disk_init);
  902. static int __init resume_setup(char *str)
  903. {
  904. if (noresume)
  905. return 1;
  906. strncpy( resume_file, str, 255 );
  907. return 1;
  908. }
  909. static int __init resume_offset_setup(char *str)
  910. {
  911. unsigned long long offset;
  912. if (noresume)
  913. return 1;
  914. if (sscanf(str, "%llu", &offset) == 1)
  915. swsusp_resume_block = offset;
  916. return 1;
  917. }
  918. static int __init hibernate_setup(char *str)
  919. {
  920. if (!strncmp(str, "noresume", 8))
  921. noresume = 1;
  922. else if (!strncmp(str, "nocompress", 10))
  923. nocompress = 1;
  924. return 1;
  925. }
  926. static int __init noresume_setup(char *str)
  927. {
  928. noresume = 1;
  929. return 1;
  930. }
  931. static int __init resumewait_setup(char *str)
  932. {
  933. resume_wait = 1;
  934. return 1;
  935. }
  936. static int __init resumedelay_setup(char *str)
  937. {
  938. resume_delay = simple_strtoul(str, NULL, 0);
  939. return 1;
  940. }
  941. __setup("noresume", noresume_setup);
  942. __setup("resume_offset=", resume_offset_setup);
  943. __setup("resume=", resume_setup);
  944. __setup("hibernate=", hibernate_setup);
  945. __setup("resumewait", resumewait_setup);
  946. __setup("resumedelay=", resumedelay_setup);