diff options
| author | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2017-01-30 03:00:02 -0500 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2017-01-30 03:00:02 -0500 |
| commit | 858a0d7eb5300b5f620d98ab3c4b96c9d5f19131 (patch) | |
| tree | 79ad2ecb357183384b172155e44df71c86e24e49 /Documentation/power | |
| parent | e326ce013a8e851193eb337aafb1aa396c533a61 (diff) | |
| parent | 47087eeb744c83482774e8f6dc20cf2b11fff53f (diff) | |
Merge back earlier suspend/hibernation changes for v4.11.
Diffstat (limited to 'Documentation/power')
| -rw-r--r-- | Documentation/power/00-INDEX | 2 | ||||
| -rw-r--r-- | Documentation/power/devices.txt | 14 | ||||
| -rw-r--r-- | Documentation/power/pci.txt | 10 | ||||
| -rw-r--r-- | Documentation/power/runtime_pm.txt | 2 | ||||
| -rw-r--r-- | Documentation/power/swsusp-dmcrypt.txt | 2 |
5 files changed, 21 insertions, 9 deletions
diff --git a/Documentation/power/00-INDEX b/Documentation/power/00-INDEX index ad04cc8097ed..7cb6085839f3 100644 --- a/Documentation/power/00-INDEX +++ b/Documentation/power/00-INDEX | |||
| @@ -6,7 +6,7 @@ basic-pm-debugging.txt | |||
| 6 | - Debugging suspend and resume | 6 | - Debugging suspend and resume |
| 7 | charger-manager.txt | 7 | charger-manager.txt |
| 8 | - Battery charger management. | 8 | - Battery charger management. |
| 9 | devices.txt | 9 | admin-guide/devices.rst |
| 10 | - How drivers interact with system-wide power management | 10 | - How drivers interact with system-wide power management |
| 11 | drivers-testing.txt | 11 | drivers-testing.txt |
| 12 | - Testing suspend and resume support in device drivers | 12 | - Testing suspend and resume support in device drivers |
diff --git a/Documentation/power/devices.txt b/Documentation/power/devices.txt index 8ba6625fdd63..73ddea39a9ce 100644 --- a/Documentation/power/devices.txt +++ b/Documentation/power/devices.txt | |||
| @@ -607,7 +607,9 @@ individually. Instead, a set of devices sharing a power resource can be put | |||
| 607 | into a low-power state together at the same time by turning off the shared | 607 | into a low-power state together at the same time by turning off the shared |
| 608 | power resource. Of course, they also need to be put into the full-power state | 608 | power resource. Of course, they also need to be put into the full-power state |
| 609 | together, by turning the shared power resource on. A set of devices with this | 609 | together, by turning the shared power resource on. A set of devices with this |
| 610 | property is often referred to as a power domain. | 610 | property is often referred to as a power domain. A power domain may also be |
| 611 | nested inside another power domain. The nested domain is referred to as the | ||
| 612 | sub-domain of the parent domain. | ||
| 611 | 613 | ||
| 612 | Support for power domains is provided through the pm_domain field of struct | 614 | Support for power domains is provided through the pm_domain field of struct |
| 613 | device. This field is a pointer to an object of type struct dev_pm_domain, | 615 | device. This field is a pointer to an object of type struct dev_pm_domain, |
| @@ -629,6 +631,16 @@ support for power domains into subsystem-level callbacks, for example by | |||
| 629 | modifying the platform bus type. Other platforms need not implement it or take | 631 | modifying the platform bus type. Other platforms need not implement it or take |
| 630 | it into account in any way. | 632 | it into account in any way. |
| 631 | 633 | ||
| 634 | Devices may be defined as IRQ-safe which indicates to the PM core that their | ||
| 635 | runtime PM callbacks may be invoked with disabled interrupts (see | ||
| 636 | Documentation/power/runtime_pm.txt for more information). If an IRQ-safe | ||
| 637 | device belongs to a PM domain, the runtime PM of the domain will be | ||
| 638 | disallowed, unless the domain itself is defined as IRQ-safe. However, it | ||
| 639 | makes sense to define a PM domain as IRQ-safe only if all the devices in it | ||
| 640 | are IRQ-safe. Moreover, if an IRQ-safe domain has a parent domain, the runtime | ||
| 641 | PM of the parent is only allowed if the parent itself is IRQ-safe too with the | ||
| 642 | additional restriction that all child domains of an IRQ-safe parent must also | ||
| 643 | be IRQ-safe. | ||
| 632 | 644 | ||
| 633 | Device Low Power (suspend) States | 645 | Device Low Power (suspend) States |
| 634 | --------------------------------- | 646 | --------------------------------- |
diff --git a/Documentation/power/pci.txt b/Documentation/power/pci.txt index 44558882aa60..85c746cbab2c 100644 --- a/Documentation/power/pci.txt +++ b/Documentation/power/pci.txt | |||
| @@ -8,7 +8,7 @@ management. Based on previous work by Patrick Mochel <mochel@transmeta.com> | |||
| 8 | 8 | ||
| 9 | This document only covers the aspects of power management specific to PCI | 9 | This document only covers the aspects of power management specific to PCI |
| 10 | devices. For general description of the kernel's interfaces related to device | 10 | devices. For general description of the kernel's interfaces related to device |
| 11 | power management refer to Documentation/power/devices.txt and | 11 | power management refer to Documentation/power/admin-guide/devices.rst and |
| 12 | Documentation/power/runtime_pm.txt. | 12 | Documentation/power/runtime_pm.txt. |
| 13 | 13 | ||
| 14 | --------------------------------------------------------------------------- | 14 | --------------------------------------------------------------------------- |
| @@ -417,7 +417,7 @@ pm->runtime_idle() callback. | |||
| 417 | 2.4. System-Wide Power Transitions | 417 | 2.4. System-Wide Power Transitions |
| 418 | ---------------------------------- | 418 | ---------------------------------- |
| 419 | There are a few different types of system-wide power transitions, described in | 419 | There are a few different types of system-wide power transitions, described in |
| 420 | Documentation/power/devices.txt. Each of them requires devices to be handled | 420 | Documentation/power/admin-guide/devices.rst. Each of them requires devices to be handled |
| 421 | in a specific way and the PM core executes subsystem-level power management | 421 | in a specific way and the PM core executes subsystem-level power management |
| 422 | callbacks for this purpose. They are executed in phases such that each phase | 422 | callbacks for this purpose. They are executed in phases such that each phase |
| 423 | involves executing the same subsystem-level callback for every device belonging | 423 | involves executing the same subsystem-level callback for every device belonging |
| @@ -623,7 +623,7 @@ System restore requires a hibernation image to be loaded into memory and the | |||
| 623 | pre-hibernation memory contents to be restored before the pre-hibernation system | 623 | pre-hibernation memory contents to be restored before the pre-hibernation system |
| 624 | activity can be resumed. | 624 | activity can be resumed. |
| 625 | 625 | ||
| 626 | As described in Documentation/power/devices.txt, the hibernation image is loaded | 626 | As described in Documentation/power/admin-guide/devices.rst, the hibernation image is loaded |
| 627 | into memory by a fresh instance of the kernel, called the boot kernel, which in | 627 | into memory by a fresh instance of the kernel, called the boot kernel, which in |
| 628 | turn is loaded and run by a boot loader in the usual way. After the boot kernel | 628 | turn is loaded and run by a boot loader in the usual way. After the boot kernel |
| 629 | has loaded the image, it needs to replace its own code and data with the code | 629 | has loaded the image, it needs to replace its own code and data with the code |
| @@ -677,7 +677,7 @@ controlling the runtime power management of their devices. | |||
| 677 | 677 | ||
| 678 | At the time of this writing there are two ways to define power management | 678 | At the time of this writing there are two ways to define power management |
| 679 | callbacks for a PCI device driver, the recommended one, based on using a | 679 | callbacks for a PCI device driver, the recommended one, based on using a |
| 680 | dev_pm_ops structure described in Documentation/power/devices.txt, and the | 680 | dev_pm_ops structure described in Documentation/power/admin-guide/devices.rst, and the |
| 681 | "legacy" one, in which the .suspend(), .suspend_late(), .resume_early(), and | 681 | "legacy" one, in which the .suspend(), .suspend_late(), .resume_early(), and |
| 682 | .resume() callbacks from struct pci_driver are used. The legacy approach, | 682 | .resume() callbacks from struct pci_driver are used. The legacy approach, |
| 683 | however, doesn't allow one to define runtime power management callbacks and is | 683 | however, doesn't allow one to define runtime power management callbacks and is |
| @@ -1046,5 +1046,5 @@ PCI Local Bus Specification, Rev. 3.0 | |||
| 1046 | PCI Bus Power Management Interface Specification, Rev. 1.2 | 1046 | PCI Bus Power Management Interface Specification, Rev. 1.2 |
| 1047 | Advanced Configuration and Power Interface (ACPI) Specification, Rev. 3.0b | 1047 | Advanced Configuration and Power Interface (ACPI) Specification, Rev. 3.0b |
| 1048 | PCI Express Base Specification, Rev. 2.0 | 1048 | PCI Express Base Specification, Rev. 2.0 |
| 1049 | Documentation/power/devices.txt | 1049 | Documentation/power/admin-guide/devices.rst |
| 1050 | Documentation/power/runtime_pm.txt | 1050 | Documentation/power/runtime_pm.txt |
diff --git a/Documentation/power/runtime_pm.txt b/Documentation/power/runtime_pm.txt index 1fd1fbe9ce95..4870980e967e 100644 --- a/Documentation/power/runtime_pm.txt +++ b/Documentation/power/runtime_pm.txt | |||
| @@ -674,7 +674,7 @@ left in runtime suspend. If that happens, the PM core will not execute any | |||
| 674 | system suspend and resume callbacks for all of those devices, except for the | 674 | system suspend and resume callbacks for all of those devices, except for the |
| 675 | complete callback, which is then entirely responsible for handling the device | 675 | complete callback, which is then entirely responsible for handling the device |
| 676 | as appropriate. This only applies to system suspend transitions that are not | 676 | as appropriate. This only applies to system suspend transitions that are not |
| 677 | related to hibernation (see Documentation/power/devices.txt for more | 677 | related to hibernation (see Documentation/power/admin-guide/devices.rst for more |
| 678 | information). | 678 | information). |
| 679 | 679 | ||
| 680 | The PM core does its best to reduce the probability of race conditions between | 680 | The PM core does its best to reduce the probability of race conditions between |
diff --git a/Documentation/power/swsusp-dmcrypt.txt b/Documentation/power/swsusp-dmcrypt.txt index 59931b46ff7e..b802fbfd95ef 100644 --- a/Documentation/power/swsusp-dmcrypt.txt +++ b/Documentation/power/swsusp-dmcrypt.txt | |||
| @@ -8,7 +8,7 @@ Some prerequisites: | |||
| 8 | You know how dm-crypt works. If not, visit the following web page: | 8 | You know how dm-crypt works. If not, visit the following web page: |
| 9 | http://www.saout.de/misc/dm-crypt/ | 9 | http://www.saout.de/misc/dm-crypt/ |
| 10 | You have read Documentation/power/swsusp.txt and understand it. | 10 | You have read Documentation/power/swsusp.txt and understand it. |
| 11 | You did read Documentation/initrd.txt and know how an initrd works. | 11 | You did read Documentation/admin-guide/initrd.rst and know how an initrd works. |
| 12 | You know how to create or how to modify an initrd. | 12 | You know how to create or how to modify an initrd. |
| 13 | 13 | ||
| 14 | Now your system is properly set up, your disk is encrypted except for | 14 | Now your system is properly set up, your disk is encrypted except for |
