sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget'/translations/zh_CN/driver-api/pm/typesmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/zh_TW/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/it_IT/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ja_JP/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ko_KR/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/pt_BR/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/sp_SP/driver-api/pm/typesmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhA/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types.rsthKubhsection)}(hhh](htitle)}(h"Device Power Management Data Typesh]h"Device Power Management Data Types}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singledev_pm_ops (C struct) c.dev_pm_opshNtauh1hhhhhhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhNubhdesc)}(hhh](hdesc_signature)}(h dev_pm_opsh]hdesc_signature_line)}(hstruct dev_pm_opsh](hdesc_sig_keyword)}(hstructh]hstruct}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhhhhhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhhhhhjhKubh desc_name)}(h dev_pm_opsh]h desc_sig_name)}(hhh]h dev_pm_ops}(hj+hhhNhNubah}(h]h ]nah"]h$]h&]uh1j)hj%ubah}(h]h ](sig-namedescnameeh"]h$]h&]hhuh1j#hhhhhjhKubeh}(h]h ]h"]h$]h&]hhƌ add_permalinkuh1hsphinx_line_type declaratorhhhhhjhKubah}(h]hah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1hhjhKhhhhubh desc_content)}(hhh]h paragraph)}(hdevice PM callbacks.h]hdevice PM callbacks.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKAhjWhhubah}(h]h ]h"]h$]h&]uh1jUhhhhhjhKubeh}(h]h ](cstructeh"]h$]h&]domainjtobjtypejudesctypejunoindex noindexentrynocontentsentryuh1hhhhhhhhNubh container)}(hX.**Definition**:: struct dev_pm_ops { int (*prepare)(struct device *dev); void (*complete)(struct device *dev); int (*suspend)(struct device *dev); int (*resume)(struct device *dev); int (*freeze)(struct device *dev); int (*thaw)(struct device *dev); int (*poweroff)(struct device *dev); int (*restore)(struct device *dev); int (*suspend_late)(struct device *dev); int (*resume_early)(struct device *dev); int (*freeze_late)(struct device *dev); int (*thaw_early)(struct device *dev); int (*poweroff_late)(struct device *dev); int (*restore_early)(struct device *dev); int (*suspend_noirq)(struct device *dev); int (*resume_noirq)(struct device *dev); int (*freeze_noirq)(struct device *dev); int (*thaw_noirq)(struct device *dev); int (*poweroff_noirq)(struct device *dev); int (*restore_noirq)(struct device *dev); int (*runtime_suspend)(struct device *dev); int (*runtime_resume)(struct device *dev); int (*runtime_idle)(struct device *dev); }; **Members** ``prepare`` The principal role of this callback is to prevent new children of the device from being registered after it has returned (the driver's subsystem and generally the rest of the kernel is supposed to prevent new calls to the probe method from being made too once **prepare\(\)** has succeeded). If **prepare\(\)** detects a situation it cannot handle (e.g. registration of a child already in progress), it may return -EAGAIN, so that the PM core can execute it once again (e.g. after a new child has been registered) to recover from the race condition. This method is executed for all kinds of suspend transitions and is followed by one of the suspend callbacks: **suspend\(\)**, **freeze\(\)**, or **poweroff\(\)**. If the transition is a suspend to memory or standby (that is, not related to hibernation), the return value of **prepare\(\)** may be used to indicate to the PM core to leave the device in runtime suspend if applicable. Namely, if **prepare\(\)** returns a positive number, the PM core will understand that as a declaration that the device appears to be runtime-suspended and it may be left in that state during the entire transition and during the subsequent resume if all of its descendants are left in runtime suspend too. If that happens, **complete\(\)** will be executed directly after **prepare\(\)** and it must ensure the proper functioning of the device after the system resume. The PM core executes subsystem-level **prepare\(\)** for all devices before starting to invoke suspend callbacks for any of them, so generally devices may be assumed to be functional or to respond to runtime resume requests while **prepare\(\)** is being executed. However, device drivers may NOT assume anything about the availability of user space at that time and it is NOT valid to request firmware from within **prepare\(\)** (it's too late to do that). It also is NOT valid to allocate substantial amounts of memory from **prepare\(\)** in the GFP_KERNEL mode. [To work around these limitations, drivers may register suspend and hibernation notifiers to be executed before the freezing of tasks.] ``complete`` Undo the changes made by **prepare\(\)**. This method is executed for all kinds of resume transitions, following one of the resume callbacks: **resume\(\)**, **thaw\(\)**, **restore\(\)**. Also called if the state transition fails before the driver's suspend callback: **suspend\(\)**, **freeze\(\)** or **poweroff\(\)**, can be executed (e.g. if the suspend callback fails for one of the other devices that the PM core has unsuccessfully attempted to suspend earlier). The PM core executes subsystem-level **complete\(\)** after it has executed the appropriate resume callbacks for all devices. If the corresponding **prepare\(\)** at the beginning of the suspend transition returned a positive number and the device was left in runtime suspend (without executing any suspend and resume callbacks for it), **complete\(\)** will be the only callback executed for the device during resume. In that case, **complete\(\)** must be prepared to do whatever is necessary to ensure the proper functioning of the device after the system resume. To this end, **complete\(\)** can check the power.direct_complete flag of the device to learn whether (unset) or not (set) the previous suspend and resume callbacks have been executed for it. ``suspend`` Executed before putting the system into a sleep state in which the contents of main memory are preserved. The exact action to perform depends on the device's subsystem (PM domain, device type, class or bus type), but generally the device must be quiescent after subsystem-level **suspend\(\)** has returned, so that it doesn't do any I/O or DMA. Subsystem-level **suspend\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. ``resume`` Executed after waking the system up from a sleep state in which the contents of main memory were preserved. The exact action to perform depends on the device's subsystem, but generally the driver is expected to start working again, responding to hardware events and software requests (the device itself may be left in a low-power state, waiting for a runtime resume to occur). The state of the device at the time its driver's **resume\(\)** callback is run depends on the platform and subsystem the device belongs to. On most platforms, there are no restrictions on availability of resources like clocks during **resume\(\)**. Subsystem-level **resume\(\)** is executed for all devices after invoking subsystem-level **resume_noirq\(\)** for all of them. ``freeze`` Hibernation-specific, executed before creating a hibernation image. Analogous to **suspend\(\)**, but it should not enable the device to signal wakeup events or change its power state. The majority of subsystems (with the notable exception of the PCI bus type) expect the driver-level **freeze\(\)** to save the device settings in memory to be used by **restore\(\)** during the subsequent resume from hibernation. Subsystem-level **freeze\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. ``thaw`` Hibernation-specific, executed after creating a hibernation image OR if the creation of an image has failed. Also executed after a failing attempt to restore the contents of main memory from such an image. Undo the changes made by the preceding **freeze\(\)**, so the device can be operated in the same way as immediately before the call to **freeze\(\)**. Subsystem-level **thaw\(\)** is executed for all devices after invoking subsystem-level **thaw_noirq\(\)** for all of them. It also may be executed directly after **freeze\(\)** in case of a transition error. ``poweroff`` Hibernation-specific, executed after saving a hibernation image. Analogous to **suspend\(\)**, but it need not save the device's settings in memory. Subsystem-level **poweroff\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. ``restore`` Hibernation-specific, executed after restoring the contents of main memory from a hibernation image, analogous to **resume\(\)**. ``suspend_late`` Continue operations started by **suspend\(\)**. For a number of devices **suspend_late\(\)** may point to the same callback routine as the runtime suspend callback. ``resume_early`` Prepare to execute **resume\(\)**. For a number of devices **resume_early\(\)** may point to the same callback routine as the runtime resume callback. ``freeze_late`` Continue operations started by **freeze\(\)**. Analogous to **suspend_late\(\)**, but it should not enable the device to signal wakeup events or change its power state. ``thaw_early`` Prepare to execute **thaw\(\)**. Undo the changes made by the preceding **freeze_late\(\)**. ``poweroff_late`` Continue operations started by **poweroff\(\)**. Analogous to **suspend_late\(\)**, but it need not save the device's settings in memory. ``restore_early`` Prepare to execute **restore\(\)**, analogous to **resume_early\(\)**. ``suspend_noirq`` Complete the actions started by **suspend\(\)**. Carry out any additional operations required for suspending the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **suspend_noirq\(\)** is being executed. It generally is expected that the device will be in a low-power state (appropriate for the target system sleep state) after subsystem-level **suspend_noirq\(\)** has returned successfully. If the device can generate system wakeup signals and is enabled to wake up the system, it should be configured to do so at that time. However, depending on the platform and device's subsystem, **suspend\(\)** or **suspend_late\(\)** may be allowed to put the device into the low-power state and configure it to generate wakeup signals, in which case it generally is not necessary to define **suspend_noirq\(\)**. ``resume_noirq`` Prepare for the execution of **resume\(\)** by carrying out any operations required for resuming the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **resume_noirq\(\)** is being executed. ``freeze_noirq`` Complete the actions started by **freeze\(\)**. Carry out any additional operations required for freezing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **freeze_noirq\(\)** is being executed. The power state of the device should not be changed by either **freeze\(\)**, or **freeze_late\(\)**, or **freeze_noirq\(\)** and it should not be configured to signal system wakeup by any of these callbacks. ``thaw_noirq`` Prepare for the execution of **thaw\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **thaw_noirq\(\)** is being executed. ``poweroff_noirq`` Complete the actions started by **poweroff\(\)**. Analogous to **suspend_noirq\(\)**, but it need not save the device's settings in memory. ``restore_noirq`` Prepare for the execution of **restore\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **restore_noirq\(\)** is being executed. Analogous to **resume_noirq\(\)**. ``runtime_suspend`` Prepare the device for a condition in which it won't be able to communicate with the CPU(s) and RAM due to power management. This need not mean that the device should be put into a low-power state. For example, if the device is behind a link which is about to be turned off, the device may remain at full power. If the device does go to low power and is capable of generating runtime wakeup events, remote wakeup (i.e., a hardware mechanism allowing the device to request a change of its power state via an interrupt) should be enabled for it. ``runtime_resume`` Put the device into the fully active state in response to a wakeup event generated by hardware or at the request of software. If necessary, put the device into the full-power state and restore its registers, so that it is fully operational. ``runtime_idle`` Device appears to be inactive and it might be put into a low-power state if all of the necessary conditions are satisfied. Check these conditions, and return 0 if it's appropriate to let the PM core queue a suspend request for the device.h](j[)}(h**Definition**::h](hstrong)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKEhjubh literal_block)}(hXstruct dev_pm_ops { int (*prepare)(struct device *dev); void (*complete)(struct device *dev); int (*suspend)(struct device *dev); int (*resume)(struct device *dev); int (*freeze)(struct device *dev); int (*thaw)(struct device *dev); int (*poweroff)(struct device *dev); int (*restore)(struct device *dev); int (*suspend_late)(struct device *dev); int (*resume_early)(struct device *dev); int (*freeze_late)(struct device *dev); int (*thaw_early)(struct device *dev); int (*poweroff_late)(struct device *dev); int (*restore_early)(struct device *dev); int (*suspend_noirq)(struct device *dev); int (*resume_noirq)(struct device *dev); int (*freeze_noirq)(struct device *dev); int (*thaw_noirq)(struct device *dev); int (*poweroff_noirq)(struct device *dev); int (*restore_noirq)(struct device *dev); int (*runtime_suspend)(struct device *dev); int (*runtime_resume)(struct device *dev); int (*runtime_idle)(struct device *dev); };h]hXstruct dev_pm_ops { int (*prepare)(struct device *dev); void (*complete)(struct device *dev); int (*suspend)(struct device *dev); int (*resume)(struct device *dev); int (*freeze)(struct device *dev); int (*thaw)(struct device *dev); int (*poweroff)(struct device *dev); int (*restore)(struct device *dev); int (*suspend_late)(struct device *dev); int (*resume_early)(struct device *dev); int (*freeze_late)(struct device *dev); int (*thaw_early)(struct device *dev); int (*poweroff_late)(struct device *dev); int (*restore_early)(struct device *dev); int (*suspend_noirq)(struct device *dev); int (*resume_noirq)(struct device *dev); int (*freeze_noirq)(struct device *dev); int (*thaw_noirq)(struct device *dev); int (*poweroff_noirq)(struct device *dev); int (*restore_noirq)(struct device *dev); int (*runtime_suspend)(struct device *dev); int (*runtime_resume)(struct device *dev); int (*runtime_idle)(struct device *dev); };}hjsbah}(h]h ]h"]h$]h&]hhuh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKGhjubj[)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKahjubhdefinition_list)}(hhh](hdefinition_list_item)}(hXL``prepare`` The principal role of this callback is to prevent new children of the device from being registered after it has returned (the driver's subsystem and generally the rest of the kernel is supposed to prevent new calls to the probe method from being made too once **prepare\(\)** has succeeded). If **prepare\(\)** detects a situation it cannot handle (e.g. registration of a child already in progress), it may return -EAGAIN, so that the PM core can execute it once again (e.g. after a new child has been registered) to recover from the race condition. This method is executed for all kinds of suspend transitions and is followed by one of the suspend callbacks: **suspend\(\)**, **freeze\(\)**, or **poweroff\(\)**. If the transition is a suspend to memory or standby (that is, not related to hibernation), the return value of **prepare\(\)** may be used to indicate to the PM core to leave the device in runtime suspend if applicable. Namely, if **prepare\(\)** returns a positive number, the PM core will understand that as a declaration that the device appears to be runtime-suspended and it may be left in that state during the entire transition and during the subsequent resume if all of its descendants are left in runtime suspend too. If that happens, **complete\(\)** will be executed directly after **prepare\(\)** and it must ensure the proper functioning of the device after the system resume. The PM core executes subsystem-level **prepare\(\)** for all devices before starting to invoke suspend callbacks for any of them, so generally devices may be assumed to be functional or to respond to runtime resume requests while **prepare\(\)** is being executed. However, device drivers may NOT assume anything about the availability of user space at that time and it is NOT valid to request firmware from within **prepare\(\)** (it's too late to do that). It also is NOT valid to allocate substantial amounts of memory from **prepare\(\)** in the GFP_KERNEL mode. [To work around these limitations, drivers may register suspend and hibernation notifiers to be executed before the freezing of tasks.] h](hterm)}(h ``prepare``h]hliteral)}(hjh]hprepare}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKahjubh definition)}(hhh]j[)}(hX?The principal role of this callback is to prevent new children of the device from being registered after it has returned (the driver's subsystem and generally the rest of the kernel is supposed to prevent new calls to the probe method from being made too once **prepare\(\)** has succeeded). If **prepare\(\)** detects a situation it cannot handle (e.g. registration of a child already in progress), it may return -EAGAIN, so that the PM core can execute it once again (e.g. after a new child has been registered) to recover from the race condition. This method is executed for all kinds of suspend transitions and is followed by one of the suspend callbacks: **suspend\(\)**, **freeze\(\)**, or **poweroff\(\)**. If the transition is a suspend to memory or standby (that is, not related to hibernation), the return value of **prepare\(\)** may be used to indicate to the PM core to leave the device in runtime suspend if applicable. Namely, if **prepare\(\)** returns a positive number, the PM core will understand that as a declaration that the device appears to be runtime-suspended and it may be left in that state during the entire transition and during the subsequent resume if all of its descendants are left in runtime suspend too. If that happens, **complete\(\)** will be executed directly after **prepare\(\)** and it must ensure the proper functioning of the device after the system resume. The PM core executes subsystem-level **prepare\(\)** for all devices before starting to invoke suspend callbacks for any of them, so generally devices may be assumed to be functional or to respond to runtime resume requests while **prepare\(\)** is being executed. However, device drivers may NOT assume anything about the availability of user space at that time and it is NOT valid to request firmware from within **prepare\(\)** (it's too late to do that). It also is NOT valid to allocate substantial amounts of memory from **prepare\(\)** in the GFP_KERNEL mode. [To work around these limitations, drivers may register suspend and hibernation notifiers to be executed before the freezing of tasks.]h](hXThe principal role of this callback is to prevent new children of the device from being registered after it has returned (the driver’s subsystem and generally the rest of the kernel is supposed to prevent new calls to the probe method from being made too once }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh has succeeded). If }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX^ detects a situation it cannot handle (e.g. registration of a child already in progress), it may return -EAGAIN, so that the PM core can execute it once again (e.g. after a new child has been registered) to recover from the race condition. This method is executed for all kinds of suspend transitions and is followed by one of the suspend callbacks: }(hjhhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, or }(hjhhhNhNubj)}(h**poweroff\(\)**h]h poweroff()}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhr. If the transition is a suspend to memory or standby (that is, not related to hibernation), the return value of }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhj may be used to indicate to the PM core to leave the device in runtime suspend if applicable. Namely, if }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX* returns a positive number, the PM core will understand that as a declaration that the device appears to be runtime-suspended and it may be left in that state during the entire transition and during the subsequent resume if all of its descendants are left in runtime suspend too. If that happens, }(hjhhhNhNubj)}(h**complete\(\)**h]h complete()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh! will be executed directly after }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhw and it must ensure the proper functioning of the device after the system resume. The PM core executes subsystem-level }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh for all devices before starting to invoke suspend callbacks for any of them, so generally devices may be assumed to be functional or to respond to runtime resume requests while }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh is being executed. However, device drivers may NOT assume anything about the availability of user space at that time and it is NOT valid to request firmware from within }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhd (it’s too late to do that). It also is NOT valid to allocate substantial amounts of memory from }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh in the GFP_KERNEL mode. [To work around these limitations, drivers may register suspend and hibernation notifiers to be executed before the freezing of tasks.]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKDhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKahjubj)}(hX``complete`` Undo the changes made by **prepare\(\)**. This method is executed for all kinds of resume transitions, following one of the resume callbacks: **resume\(\)**, **thaw\(\)**, **restore\(\)**. Also called if the state transition fails before the driver's suspend callback: **suspend\(\)**, **freeze\(\)** or **poweroff\(\)**, can be executed (e.g. if the suspend callback fails for one of the other devices that the PM core has unsuccessfully attempted to suspend earlier). The PM core executes subsystem-level **complete\(\)** after it has executed the appropriate resume callbacks for all devices. If the corresponding **prepare\(\)** at the beginning of the suspend transition returned a positive number and the device was left in runtime suspend (without executing any suspend and resume callbacks for it), **complete\(\)** will be the only callback executed for the device during resume. In that case, **complete\(\)** must be prepared to do whatever is necessary to ensure the proper functioning of the device after the system resume. To this end, **complete\(\)** can check the power.direct_complete flag of the device to learn whether (unset) or not (set) the previous suspend and resume callbacks have been executed for it. h](j)}(h ``complete``h]j)}(hjh]hcomplete}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKthjubj)}(hhh]j[)}(hXUndo the changes made by **prepare\(\)**. This method is executed for all kinds of resume transitions, following one of the resume callbacks: **resume\(\)**, **thaw\(\)**, **restore\(\)**. Also called if the state transition fails before the driver's suspend callback: **suspend\(\)**, **freeze\(\)** or **poweroff\(\)**, can be executed (e.g. if the suspend callback fails for one of the other devices that the PM core has unsuccessfully attempted to suspend earlier). The PM core executes subsystem-level **complete\(\)** after it has executed the appropriate resume callbacks for all devices. If the corresponding **prepare\(\)** at the beginning of the suspend transition returned a positive number and the device was left in runtime suspend (without executing any suspend and resume callbacks for it), **complete\(\)** will be the only callback executed for the device during resume. In that case, **complete\(\)** must be prepared to do whatever is necessary to ensure the proper functioning of the device after the system resume. To this end, **complete\(\)** can check the power.direct_complete flag of the device to learn whether (unset) or not (set) the previous suspend and resume callbacks have been executed for it.h](hUndo the changes made by }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhg. This method is executed for all kinds of resume transitions, following one of the resume callbacks: }(hjhhhNhNubj)}(h**resume\(\)**h]h resume()}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }(hjhhhNhNubj)}(h **thaw\(\)**h]hthaw()}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h**restore\(\)**h]h restore()}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhU. Also called if the state transition fails before the driver’s suspend callback: }(hjhhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, }hjsbj)}(h**freeze\(\)**h]h freeze()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh or }(hjhhhNhNubj)}(h**poweroff\(\)**h]h poweroff()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, can be executed (e.g. if the suspend callback fails for one of the other devices that the PM core has unsuccessfully attempted to suspend earlier). The PM core executes subsystem-level }(hjhhhNhNubj)}(h**complete\(\)**h]h complete()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh_ after it has executed the appropriate resume callbacks for all devices. If the corresponding }(hjhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh at the beginning of the suspend transition returned a positive number and the device was left in runtime suspend (without executing any suspend and resume callbacks for it), }(hjhhhNhNubj)}(h**complete\(\)**h]h complete()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhQ will be the only callback executed for the device during resume. In that case, }(hjhhhNhNubj)}(h**complete\(\)**h]h complete()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh must be prepared to do whatever is necessary to ensure the proper functioning of the device after the system resume. To this end, }(hjhhhNhNubj)}(h**complete\(\)**h]h complete()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh can check the power.direct_complete flag of the device to learn whether (unset) or not (set) the previous suspend and resume callbacks have been executed for it.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKchjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKthjubj)}(hX``suspend`` Executed before putting the system into a sleep state in which the contents of main memory are preserved. The exact action to perform depends on the device's subsystem (PM domain, device type, class or bus type), but generally the device must be quiescent after subsystem-level **suspend\(\)** has returned, so that it doesn't do any I/O or DMA. Subsystem-level **suspend\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. h](j)}(h ``suspend``h]j)}(hjh]hsuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhK|hjubj)}(hhh]j[)}(hXExecuted before putting the system into a sleep state in which the contents of main memory are preserved. The exact action to perform depends on the device's subsystem (PM domain, device type, class or bus type), but generally the device must be quiescent after subsystem-level **suspend\(\)** has returned, so that it doesn't do any I/O or DMA. Subsystem-level **suspend\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them.h](hXExecuted before putting the system into a sleep state in which the contents of main memory are preserved. The exact action to perform depends on the device’s subsystem (PM domain, device type, class or bus type), but generally the device must be quiescent after subsystem-level }(hj/hhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubhG has returned, so that it doesn’t do any I/O or DMA. Subsystem-level }(hj/hhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubh< is executed for all devices after invoking subsystem-level }(hj/hhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubh for all of them.}(hj/hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKvhj,ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj+hK|hjubj)}(hX``resume`` Executed after waking the system up from a sleep state in which the contents of main memory were preserved. The exact action to perform depends on the device's subsystem, but generally the driver is expected to start working again, responding to hardware events and software requests (the device itself may be left in a low-power state, waiting for a runtime resume to occur). The state of the device at the time its driver's **resume\(\)** callback is run depends on the platform and subsystem the device belongs to. On most platforms, there are no restrictions on availability of resources like clocks during **resume\(\)**. Subsystem-level **resume\(\)** is executed for all devices after invoking subsystem-level **resume_noirq\(\)** for all of them. h](j)}(h ``resume``h]j)}(hjh]hresume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hXExecuted after waking the system up from a sleep state in which the contents of main memory were preserved. The exact action to perform depends on the device's subsystem, but generally the driver is expected to start working again, responding to hardware events and software requests (the device itself may be left in a low-power state, waiting for a runtime resume to occur). The state of the device at the time its driver's **resume\(\)** callback is run depends on the platform and subsystem the device belongs to. On most platforms, there are no restrictions on availability of resources like clocks during **resume\(\)**. Subsystem-level **resume\(\)** is executed for all devices after invoking subsystem-level **resume_noirq\(\)** for all of them.h](hXExecuted after waking the system up from a sleep state in which the contents of main memory were preserved. The exact action to perform depends on the device’s subsystem, but generally the driver is expected to start working again, responding to hardware events and software requests (the device itself may be left in a low-power state, waiting for a runtime resume to occur). The state of the device at the time its driver’s }(hjhhhNhNubj)}(h**resume\(\)**h]h resume()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh callback is run depends on the platform and subsystem the device belongs to. On most platforms, there are no restrictions on availability of resources like clocks during }(hjhhhNhNubj)}(h**resume\(\)**h]h resume()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. Subsystem-level }(hjhhhNhNubj)}(h**resume\(\)**h]h resume()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh< is executed for all devices after invoking subsystem-level }(hjhhhNhNubj)}(h**resume_noirq\(\)**h]hresume_noirq()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh for all of them.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hX&``freeze`` Hibernation-specific, executed before creating a hibernation image. Analogous to **suspend\(\)**, but it should not enable the device to signal wakeup events or change its power state. The majority of subsystems (with the notable exception of the PCI bus type) expect the driver-level **freeze\(\)** to save the device settings in memory to be used by **restore\(\)** during the subsequent resume from hibernation. Subsystem-level **freeze\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. h](j)}(h ``freeze``h]j)}(hjh]hfreeze}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hXHibernation-specific, executed before creating a hibernation image. Analogous to **suspend\(\)**, but it should not enable the device to signal wakeup events or change its power state. The majority of subsystems (with the notable exception of the PCI bus type) expect the driver-level **freeze\(\)** to save the device settings in memory to be used by **restore\(\)** during the subsequent resume from hibernation. Subsystem-level **freeze\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them.h](hQHibernation-specific, executed before creating a hibernation image. Analogous to }(hj!hhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh, but it should not enable the device to signal wakeup events or change its power state. The majority of subsystems (with the notable exception of the PCI bus type) expect the driver-level }(hj!hhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh5 to save the device settings in memory to be used by }(hj!hhhNhNubj)}(h**restore\(\)**h]h restore()}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh@ during the subsequent resume from hibernation. Subsystem-level }(hj!hhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh< is executed for all devices after invoking subsystem-level }(hj!hhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh for all of them.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hXA``thaw`` Hibernation-specific, executed after creating a hibernation image OR if the creation of an image has failed. Also executed after a failing attempt to restore the contents of main memory from such an image. Undo the changes made by the preceding **freeze\(\)**, so the device can be operated in the same way as immediately before the call to **freeze\(\)**. Subsystem-level **thaw\(\)** is executed for all devices after invoking subsystem-level **thaw_noirq\(\)** for all of them. It also may be executed directly after **freeze\(\)** in case of a transition error. h](j)}(h``thaw``h]j)}(hjh]hthaw}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hX7Hibernation-specific, executed after creating a hibernation image OR if the creation of an image has failed. Also executed after a failing attempt to restore the contents of main memory from such an image. Undo the changes made by the preceding **freeze\(\)**, so the device can be operated in the same way as immediately before the call to **freeze\(\)**. Subsystem-level **thaw\(\)** is executed for all devices after invoking subsystem-level **thaw_noirq\(\)** for all of them. It also may be executed directly after **freeze\(\)** in case of a transition error.h](hHibernation-specific, executed after creating a hibernation image OR if the creation of an image has failed. Also executed after a failing attempt to restore the contents of main memory from such an image. Undo the changes made by the preceding }(hjhhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhR, so the device can be operated in the same way as immediately before the call to }(hjhhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. Subsystem-level }(hjhhhNhNubj)}(h **thaw\(\)**h]hthaw()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh< is executed for all devices after invoking subsystem-level }(hjhhhNhNubj)}(h**thaw_noirq\(\)**h]hthaw_noirq()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh: for all of them. It also may be executed directly after }(hjhhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh in case of a transition error.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hX``poweroff`` Hibernation-specific, executed after saving a hibernation image. Analogous to **suspend\(\)**, but it need not save the device's settings in memory. Subsystem-level **poweroff\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them. h](j)}(h ``poweroff``h]j)}(hj0h]hpoweroff}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj*ubj)}(hhh]j[)}(hXHibernation-specific, executed after saving a hibernation image. Analogous to **suspend\(\)**, but it need not save the device's settings in memory. Subsystem-level **poweroff\(\)** is executed for all devices after invoking subsystem-level **prepare\(\)** for all of them.h](hNHibernation-specific, executed after saving a hibernation image. Analogous to }(hjIhhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubhJ, but it need not save the device’s settings in memory. Subsystem-level }(hjIhhhNhNubj)}(h**poweroff\(\)**h]h poweroff()}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubh< is executed for all devices after invoking subsystem-level }(hjIhhhNhNubj)}(h**prepare\(\)**h]h prepare()}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIubh for all of them.}(hjIhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjFubah}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]uh1jhjEhKhjubj)}(h``restore`` Hibernation-specific, executed after restoring the contents of main memory from a hibernation image, analogous to **resume\(\)**. h](j)}(h ``restore``h]j)}(hjh]hrestore}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hHibernation-specific, executed after restoring the contents of main memory from a hibernation image, analogous to **resume\(\)**.h](hrHibernation-specific, executed after restoring the contents of main memory from a hibernation image, analogous to }(hjhhhNhNubj)}(h**resume\(\)**h]h resume()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h``suspend_late`` Continue operations started by **suspend\(\)**. For a number of devices **suspend_late\(\)** may point to the same callback routine as the runtime suspend callback. h](j)}(h``suspend_late``h]j)}(hjh]h suspend_late}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hContinue operations started by **suspend\(\)**. For a number of devices **suspend_late\(\)** may point to the same callback routine as the runtime suspend callback.h](hContinue operations started by }(hjhhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. For a number of devices }(hjhhhNhNubj)}(h**suspend_late\(\)**h]hsuspend_late()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhH may point to the same callback routine as the runtime suspend callback.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhK~hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h``resume_early`` Prepare to execute **resume\(\)**. For a number of devices **resume_early\(\)** may point to the same callback routine as the runtime resume callback. h](j)}(h``resume_early``h]j)}(hjJh]h resume_early}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjHubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjDubj)}(hhh]j[)}(hPrepare to execute **resume\(\)**. For a number of devices **resume_early\(\)** may point to the same callback routine as the runtime resume callback.h](hPrepare to execute }(hjchhhNhNubj)}(h**resume\(\)**h]h resume()}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubh. For a number of devices }(hjchhhNhNubj)}(h**resume_early\(\)**h]hresume_early()}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjcubhG may point to the same callback routine as the runtime resume callback.}(hjchhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj`ubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jhj_hKhjubj)}(h``freeze_late`` Continue operations started by **freeze\(\)**. Analogous to **suspend_late\(\)**, but it should not enable the device to signal wakeup events or change its power state. h](j)}(h``freeze_late``h]j)}(hjh]h freeze_late}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hContinue operations started by **freeze\(\)**. Analogous to **suspend_late\(\)**, but it should not enable the device to signal wakeup events or change its power state.h](hContinue operations started by }(hjhhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh. Analogous to }(hjhhhNhNubj)}(h**suspend_late\(\)**h]hsuspend_late()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhX, but it should not enable the device to signal wakeup events or change its power state.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hm``thaw_early`` Prepare to execute **thaw\(\)**. Undo the changes made by the preceding **freeze_late\(\)**. h](j)}(h``thaw_early``h]j)}(hjh]h thaw_early}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(h]Prepare to execute **thaw\(\)**. Undo the changes made by the preceding **freeze_late\(\)**.h](hPrepare to execute }(hjhhhNhNubj)}(h **thaw\(\)**h]hthaw()}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh*. Undo the changes made by the preceding }(hjhhhNhNubj)}(h**freeze_late\(\)**h]hfreeze_late()}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h``poweroff_late`` Continue operations started by **poweroff\(\)**. Analogous to **suspend_late\(\)**, but it need not save the device's settings in memory. h](j)}(h``poweroff_late``h]j)}(hjdh]h poweroff_late}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjbubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj^ubj)}(hhh]j[)}(hContinue operations started by **poweroff\(\)**. Analogous to **suspend_late\(\)**, but it need not save the device's settings in memory.h](hContinue operations started by }(hj}hhhNhNubj)}(h**poweroff\(\)**h]h poweroff()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubh. Analogous to }(hj}hhhNhNubj)}(h**suspend_late\(\)**h]hsuspend_late()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubh9, but it need not save the device’s settings in memory.}(hj}hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjzubah}(h]h ]h"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]uh1jhjyhKhjubj)}(hY``restore_early`` Prepare to execute **restore\(\)**, analogous to **resume_early\(\)**. h](j)}(h``restore_early``h]j)}(hjh]h restore_early}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjubj)}(hhh]j[)}(hFPrepare to execute **restore\(\)**, analogous to **resume_early\(\)**.h](hPrepare to execute }(hjhhhNhNubj)}(h**restore\(\)**h]h restore()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh, analogous to }(hjhhhNhNubj)}(h**resume_early\(\)**h]hresume_early()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hXo``suspend_noirq`` Complete the actions started by **suspend\(\)**. Carry out any additional operations required for suspending the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **suspend_noirq\(\)** is being executed. It generally is expected that the device will be in a low-power state (appropriate for the target system sleep state) after subsystem-level **suspend_noirq\(\)** has returned successfully. If the device can generate system wakeup signals and is enabled to wake up the system, it should be configured to do so at that time. However, depending on the platform and device's subsystem, **suspend\(\)** or **suspend_late\(\)** may be allowed to put the device into the low-power state and configure it to generate wakeup signals, in which case it generally is not necessary to define **suspend_noirq\(\)**. h](j)}(h``suspend_noirq``h]j)}(hj h]h suspend_noirq}(hj! hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hX\Complete the actions started by **suspend\(\)**. Carry out any additional operations required for suspending the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **suspend_noirq\(\)** is being executed. It generally is expected that the device will be in a low-power state (appropriate for the target system sleep state) after subsystem-level **suspend_noirq\(\)** has returned successfully. If the device can generate system wakeup signals and is enabled to wake up the system, it should be configured to do so at that time. However, depending on the platform and device's subsystem, **suspend\(\)** or **suspend_late\(\)** may be allowed to put the device into the low-power state and configure it to generate wakeup signals, in which case it generally is not necessary to define **suspend_noirq\(\)**.h](h Complete the actions started by }(hj8 hhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh. Carry out any additional operations required for suspending the device that might be racing with its driver’s interrupt handler, which is guaranteed not to run while }(hj8 hhhNhNubj)}(h**suspend_noirq\(\)**h]hsuspend_noirq()}(hjR hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh is being executed. It generally is expected that the device will be in a low-power state (appropriate for the target system sleep state) after subsystem-level }(hj8 hhhNhNubj)}(h**suspend_noirq\(\)**h]hsuspend_noirq()}(hjd hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh has returned successfully. If the device can generate system wakeup signals and is enabled to wake up the system, it should be configured to do so at that time. However, depending on the platform and device’s subsystem, }(hj8 hhhNhNubj)}(h**suspend\(\)**h]h suspend()}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh or }(hj8 hhhNhNubj)}(h**suspend_late\(\)**h]hsuspend_late()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh may be allowed to put the device into the low-power state and configure it to generate wakeup signals, in which case it generally is not necessary to define }(hj8 hhhNhNubj)}(h**suspend_noirq\(\)**h]hsuspend_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj8 ubh.}(hj8 hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj5 ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj4 hKhjubj)}(hX``resume_noirq`` Prepare for the execution of **resume\(\)** by carrying out any operations required for resuming the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **resume_noirq\(\)** is being executed. h](j)}(h``resume_noirq``h]j)}(hj h]h resume_noirq}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hPrepare for the execution of **resume\(\)** by carrying out any operations required for resuming the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **resume_noirq\(\)** is being executed.h](hPrepare for the execution of }(hj hhhNhNubj)}(h**resume\(\)**h]h resume()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh by carrying out any operations required for resuming the device that might be racing with its driver’s interrupt handler, which is guaranteed not to run while }(hj hhhNhNubj)}(h**resume_noirq\(\)**h]hresume_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh is being executed.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(hX``freeze_noirq`` Complete the actions started by **freeze\(\)**. Carry out any additional operations required for freezing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **freeze_noirq\(\)** is being executed. The power state of the device should not be changed by either **freeze\(\)**, or **freeze_late\(\)**, or **freeze_noirq\(\)** and it should not be configured to signal system wakeup by any of these callbacks. h](j)}(h``freeze_noirq``h]j)}(hj# h]h freeze_noirq}(hj% hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj! ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hXComplete the actions started by **freeze\(\)**. Carry out any additional operations required for freezing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **freeze_noirq\(\)** is being executed. The power state of the device should not be changed by either **freeze\(\)**, or **freeze_late\(\)**, or **freeze_noirq\(\)** and it should not be configured to signal system wakeup by any of these callbacks.h](h Complete the actions started by }(hj< hhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjD hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubh. Carry out any additional operations required for freezing the device that might be racing with its driver’s interrupt handler, which is guaranteed not to run while }(hj< hhhNhNubj)}(h**freeze_noirq\(\)**h]hfreeze_noirq()}(hjV hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubhR is being executed. The power state of the device should not be changed by either }(hj< hhhNhNubj)}(h**freeze\(\)**h]h freeze()}(hjh hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubh, or }(hj< hhhNhNubj)}(h**freeze_late\(\)**h]hfreeze_late()}(hjz hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubh, or }(hj< hhhNhNubj)}(h**freeze_noirq\(\)**h]hfreeze_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj< ubhS and it should not be configured to signal system wakeup by any of these callbacks.}(hj< hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj9 ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj8 hKhjubj)}(h``thaw_noirq`` Prepare for the execution of **thaw\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **thaw_noirq\(\)** is being executed. h](j)}(h``thaw_noirq``h]j)}(hj h]h thaw_noirq}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hPrepare for the execution of **thaw\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **thaw_noirq\(\)** is being executed.h](hPrepare for the execution of }(hj hhhNhNubj)}(h **thaw\(\)**h]hthaw()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh by carrying out any operations required for thawing the device that might be racing with its driver’s interrupt handler, which is guaranteed not to run while }(hj hhhNhNubj)}(h**thaw_noirq\(\)**h]hthaw_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhoj ubh is being executed.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h``poweroff_noirq`` Complete the actions started by **poweroff\(\)**. Analogous to **suspend_noirq\(\)**, but it need not save the device's settings in memory. h](j)}(h``poweroff_noirq``h]j)}(hj h]hpoweroff_noirq}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hComplete the actions started by **poweroff\(\)**. Analogous to **suspend_noirq\(\)**, but it need not save the device's settings in memory.h](h Complete the actions started by }(hj. hhhNhNubj)}(h**poweroff\(\)**h]h poweroff()}(hj6 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj. ubh. Analogous to }(hj. hhhNhNubj)}(h**suspend_noirq\(\)**h]hsuspend_noirq()}(hjH hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj. ubh9, but it need not save the device’s settings in memory.}(hj. hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj+ ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj* hKhjubj)}(hX*``restore_noirq`` Prepare for the execution of **restore\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **restore_noirq\(\)** is being executed. Analogous to **resume_noirq\(\)**. h](j)}(h``restore_noirq``h]j)}(hjs h]h restore_noirq}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjq ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjm ubj)}(hhh]j[)}(hXPrepare for the execution of **restore\(\)** by carrying out any operations required for thawing the device that might be racing with its driver's interrupt handler, which is guaranteed not to run while **restore_noirq\(\)** is being executed. Analogous to **resume_noirq\(\)**.h](hPrepare for the execution of }(hj hhhNhNubj)}(h**restore\(\)**h]h restore()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh by carrying out any operations required for thawing the device that might be racing with its driver’s interrupt handler, which is guaranteed not to run while }(hj hhhNhNubj)}(h**restore_noirq\(\)**h]hrestore_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh" is being executed. Analogous to }(hj hhhNhNubj)}(h**resume_noirq\(\)**h]hresume_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhjm ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(hX5``runtime_suspend`` Prepare the device for a condition in which it won't be able to communicate with the CPU(s) and RAM due to power management. This need not mean that the device should be put into a low-power state. For example, if the device is behind a link which is about to be turned off, the device may remain at full power. If the device does go to low power and is capable of generating runtime wakeup events, remote wakeup (i.e., a hardware mechanism allowing the device to request a change of its power state via an interrupt) should be enabled for it. h](j)}(h``runtime_suspend``h]j)}(hj h]hruntime_suspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hX Prepare the device for a condition in which it won't be able to communicate with the CPU(s) and RAM due to power management. This need not mean that the device should be put into a low-power state. For example, if the device is behind a link which is about to be turned off, the device may remain at full power. If the device does go to low power and is capable of generating runtime wakeup events, remote wakeup (i.e., a hardware mechanism allowing the device to request a change of its power state via an interrupt) should be enabled for it.h]hX"Prepare the device for a condition in which it won’t be able to communicate with the CPU(s) and RAM due to power management. This need not mean that the device should be put into a low-power state. For example, if the device is behind a link which is about to be turned off, the device may remain at full power. If the device does go to low power and is capable of generating runtime wakeup events, remote wakeup (i.e., a hardware mechanism allowing the device to request a change of its power state via an interrupt) should be enabled for it.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(hX``runtime_resume`` Put the device into the fully active state in response to a wakeup event generated by hardware or at the request of software. If necessary, put the device into the full-power state and restore its registers, so that it is fully operational. h](j)}(h``runtime_resume``h]j)}(hj h]hruntime_resume}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj ubj)}(hhh]j[)}(hPut the device into the fully active state in response to a wakeup event generated by hardware or at the request of software. If necessary, put the device into the full-power state and restore its registers, so that it is fully operational.h]hPut the device into the fully active state in response to a wakeup event generated by hardware or at the request of software. If necessary, put the device into the full-power state and restore its registers, so that it is fully operational.}(hj6 hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhj3 ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj2 hKhjubj)}(h``runtime_idle`` Device appears to be inactive and it might be put into a low-power state if all of the necessary conditions are satisfied. Check these conditions, and return 0 if it's appropriate to let the PM core queue a suspend request for the device.h](j)}(h``runtime_idle``h]j)}(hjW h]h runtime_idle}(hjY hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjU ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjQ ubj)}(hhh]j[)}(hDevice appears to be inactive and it might be put into a low-power state if all of the necessary conditions are satisfied. Check these conditions, and return 0 if it's appropriate to let the PM core queue a suspend request for the device.h]hDevice appears to be inactive and it might be put into a low-power state if all of the necessary conditions are satisfied. Check these conditions, and return 0 if it’s appropriate to let the PM core queue a suspend request for the device.}(hjp hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhjm ubah}(h]h ]h"]h$]h&]uh1jhjQ ubeh}(h]h ]h"]h$]h&]uh1jhjl hKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jhhhhhhhNubj[)}(h**Description**h]j)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhhhhubj[)}(hXSeveral device power state transitions are externally visible, affecting the state of pending I/O queues and (for drivers that touch hardware) interrupts, wakeups, DMA, and other hardware state. There may also be internal transitions to various low-power modes which are transparent to the rest of the driver stack (such as a driver that's ON gating off clocks which are not in active use).h]hXSeveral device power state transitions are externally visible, affecting the state of pending I/O queues and (for drivers that touch hardware) interrupts, wakeups, DMA, and other hardware state. There may also be internal transitions to various low-power modes which are transparent to the rest of the driver stack (such as a driver that’s ON gating off clocks which are not in active use).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhhhhubj[)}(hX}The externally visible transitions are handled with the help of callbacks included in this structure in such a way that, typically, two levels of callbacks are involved. First, the PM core executes callbacks provided by PM domains, device types, classes and bus types. They are the subsystem-level callbacks expected to execute callbacks provided by device drivers, although they may choose not to do that. If the driver callbacks are executed, they have to collaborate with the subsystem-level callbacks to achieve the goals appropriate for the given system transition, given transition phase and the subsystem the device belongs to.h]hX}The externally visible transitions are handled with the help of callbacks included in this structure in such a way that, typically, two levels of callbacks are involved. First, the PM core executes callbacks provided by PM domains, device types, classes and bus types. They are the subsystem-level callbacks expected to execute callbacks provided by device drivers, although they may choose not to do that. If the driver callbacks are executed, they have to collaborate with the subsystem-level callbacks to achieve the goals appropriate for the given system transition, given transition phase and the subsystem the device belongs to.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhKhhhhubj[)}(hXAll of the above callbacks, except for **complete\(\)**, return error codes. However, the error codes returned by **resume\(\)**, **thaw\(\)**, **restore\(\)**, **resume_noirq\(\)**, **thaw_noirq\(\)**, and **restore_noirq\(\)**, do not cause the PM core to abort the resume transition during which they are returned. The error codes returned in those cases are only printed to the system logs for debugging purposes. Still, it is recommended that drivers only return error codes from their resume methods in case of an unrecoverable failure (i.e. when the device being handled refuses to resume and becomes unusable) to allow the PM core to be modified in the future, so that it can avoid attempting to handle devices that failed to resume and their children.h](h'All of the above callbacks, except for }(hj hhhNhNubj)}(h**complete\(\)**h]h complete()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh;, return error codes. However, the error codes returned by }(hj hhhNhNubj)}(h**resume\(\)**h]h resume()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, }(hj hhhNhNubj)}(h **thaw\(\)**h]hthaw()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, }hj sbj)}(h**restore\(\)**h]h restore()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, }(hj hhhNhNubj)}(h**resume_noirq\(\)**h]hresume_noirq()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, }hj sbj)}(h**thaw_noirq\(\)**h]hthaw_noirq()}(hj0 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh, and }(hj hhhNhNubj)}(h**restore_noirq\(\)**h]hrestore_noirq()}(hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubhX, do not cause the PM core to abort the resume transition during which they are returned. The error codes returned in those cases are only printed to the system logs for debugging purposes. Still, it is recommended that drivers only return error codes from their resume methods in case of an unrecoverable failure (i.e. when the device being handled refuses to resume and becomes unusable) to allow the PM core to be modified in the future, so that it can avoid attempting to handle devices that failed to resume and their children.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhhhhubj[)}(hX/It is allowed to unregister devices while the above callbacks are being executed. However, a callback routine MUST NOT try to unregister the device it was called for, although it may unregister children of that device (for example, if it detects that a child was unplugged while the system was asleep).h]hX/It is allowed to unregister devices while the above callbacks are being executed. However, a callback routine MUST NOT try to unregister the device it was called for, although it may unregister children of that device (for example, if it detects that a child was unplugged while the system was asleep).}(hj[ hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhhhhubj[)}(hXThere also are callbacks related to runtime power management of devices. Again, as a rule these callbacks are executed by the PM core for subsystems (PM domains, device types, classes and bus types) and the subsystem-level callbacks are expected to invoke the driver callbacks. Moreover, the exact actions to be performed by a device driver's callbacks generally depend on the platform and subsystem the device belongs to.h]hXThere also are callbacks related to runtime power management of devices. Again, as a rule these callbacks are executed by the PM core for subsystems (PM domains, device types, classes and bus types) and the subsystem-level callbacks are expected to invoke the driver callbacks. Moreover, the exact actions to be performed by a device driver’s callbacks generally depend on the platform and subsystem the device belongs to.}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhhhhubj[)}(hRefer to Documentation/power/runtime_pm.rst for more information about the role of the **runtime_suspend\(\)**, **runtime_resume\(\)** and **runtime_idle\(\)** callbacks in device runtime power management.h](hWRefer to Documentation/power/runtime_pm.rst for more information about the role of the }(hjy hhhNhNubj)}(h**runtime_suspend\(\)**h]hruntime_suspend()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy ubh, }(hjy hhhNhNubj)}(h**runtime_resume\(\)**h]hruntime_resume()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy ubh and }(hjy hhhNhNubj)}(h**runtime_idle\(\)**h]hruntime_idle()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjy ubh. callbacks in device runtime power management.}(hjy hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhhhhubh)}(hhh]h}(h]h ]h"]h$]h&]entries](hdev_pm_domain (C struct)c.dev_pm_domainhNtauh1hhhhhhhhNubh)}(hhh](h)}(h dev_pm_domainh]h)}(hstruct dev_pm_domainh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj hhhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhM"ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhj hM"ubj$)}(h dev_pm_domainh]j*)}(hj h]h dev_pm_domain}(hj hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj ubah}(h]h ](j<j=eh"]h$]h&]hhuh1j#hj hhhj hM"ubeh}(h]h ]h"]h$]h&]hhjGuh1hjHjIhj hhhj hM"ubah}(h]j ah ](jMjNeh"]h$]h&]jRjS)jThuh1hhj hM"hj hhubjV)}(hhh]j[)}(h'power management domain representation.h]h'power management domain representation.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhjhhubah}(h]h ]h"]h$]h&]uh1jUhj hhhj hM"ubeh}(h]h ](jtstructeh"]h$]h&]jyjtjzj1j{j1j|j}j~uh1hhhhhhhhNubj)}(hXr**Definition**:: struct dev_pm_domain { struct dev_pm_ops ops; int (*start)(struct device *dev); void (*detach)(struct device *dev, bool power_off); int (*activate)(struct device *dev); void (*sync)(struct device *dev); void (*dismiss)(struct device *dev); int (*set_performance_state)(struct device *dev, unsigned int state); }; **Members** ``ops`` Power management operations associated with this domain. ``start`` Called when a user needs to start the device via the domain. ``detach`` Called when removing a device from the domain. ``activate`` Called before executing probe routines for bus types and drivers. ``sync`` Called after successful driver probe. ``dismiss`` Called after unsuccessful driver probe and after driver removal. ``set_performance_state`` Called to request a new performance state.h](j[)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9ubh:}(hj9hhhNhNubeh}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhj5ubj)}(hXZstruct dev_pm_domain { struct dev_pm_ops ops; int (*start)(struct device *dev); void (*detach)(struct device *dev, bool power_off); int (*activate)(struct device *dev); void (*sync)(struct device *dev); void (*dismiss)(struct device *dev); int (*set_performance_state)(struct device *dev, unsigned int state); };h]hXZstruct dev_pm_domain { struct dev_pm_ops ops; int (*start)(struct device *dev); void (*detach)(struct device *dev, bool power_off); int (*activate)(struct device *dev); void (*sync)(struct device *dev); void (*dismiss)(struct device *dev); int (*set_performance_state)(struct device *dev, unsigned int state); };}hjVsbah}(h]h ]h"]h$]h&]hhuh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhj5ubj[)}(h **Members**h]j)}(hjgh]hMembers}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&]uh1jZhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhj5ubj)}(hhh](j)}(hA``ops`` Power management operations associated with this domain. h](j)}(h``ops``h]j)}(hjh]hops}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhjubj)}(hhh]j[)}(h8Power management operations associated with this domain.h]h8Power management operations associated with this domain.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jZhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhj}ubj)}(hG``start`` Called when a user needs to start the device via the domain. h](j)}(h ``start``h]j)}(hjh]hstart}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/driver-api/pm/types:7: ./include/linux/pm.hhMhjubj)}(hhh]j[)}(h