PM / Runtime: Replace "run-time" with "runtime" in documentation
The runtime PM documentation and kerneldoc comments sometimes spell "runtime" with a dash (i.e. "run-time"). Replace all of those instances with "runtime" to make the naming consistent. Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* drivers/base/power/runtime.c - Helper functions for device run-time PM
|
||||
* drivers/base/power/runtime.c - Helper functions for device runtime PM
|
||||
*
|
||||
* Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
|
||||
* Copyright (C) 2010 Alan Stern <stern@rowland.harvard.edu>
|
||||
@@ -159,7 +159,7 @@ static int rpm_check_suspend_allowed(struct device *dev)
|
||||
* @dev: Device to notify the bus type about.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
* Check if the device's run-time PM status allows it to be suspended. If
|
||||
* Check if the device's runtime PM status allows it to be suspended. If
|
||||
* another idle notification has been started earlier, return immediately. If
|
||||
* the RPM_ASYNC flag is set then queue an idle-notification request; otherwise
|
||||
* run the ->runtime_idle() callback directly.
|
||||
@@ -267,11 +267,11 @@ static int rpm_callback(int (*cb)(struct device *), struct device *dev)
|
||||
}
|
||||
|
||||
/**
|
||||
* rpm_suspend - Carry out run-time suspend of given device.
|
||||
* rpm_suspend - Carry out runtime suspend of given device.
|
||||
* @dev: Device to suspend.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
* Check if the device's run-time PM status allows it to be suspended. If
|
||||
* Check if the device's runtime PM status allows it to be suspended. If
|
||||
* another suspend has been started earlier, either return immediately or wait
|
||||
* for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC flags. Cancel a
|
||||
* pending idle notification. If the RPM_ASYNC flag is set then queue a
|
||||
@@ -430,11 +430,11 @@ static int rpm_suspend(struct device *dev, int rpmflags)
|
||||
}
|
||||
|
||||
/**
|
||||
* rpm_resume - Carry out run-time resume of given device.
|
||||
* rpm_resume - Carry out runtime resume of given device.
|
||||
* @dev: Device to resume.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
* Check if the device's run-time PM status allows it to be resumed. Cancel
|
||||
* Check if the device's runtime PM status allows it to be resumed. Cancel
|
||||
* any scheduled or pending requests. If another resume has been started
|
||||
* earlier, either return immediately or wait for it to finish, depending on the
|
||||
* RPM_NOWAIT and RPM_ASYNC flags. Similarly, if there's a suspend running in
|
||||
@@ -551,7 +551,7 @@ static int rpm_resume(struct device *dev, int rpmflags)
|
||||
|
||||
spin_lock(&parent->power.lock);
|
||||
/*
|
||||
* We can resume if the parent's run-time PM is disabled or it
|
||||
* We can resume if the parent's runtime PM is disabled or it
|
||||
* is set to ignore children.
|
||||
*/
|
||||
if (!parent->power.disable_depth
|
||||
@@ -615,11 +615,11 @@ static int rpm_resume(struct device *dev, int rpmflags)
|
||||
}
|
||||
|
||||
/**
|
||||
* pm_runtime_work - Universal run-time PM work function.
|
||||
* pm_runtime_work - Universal runtime PM work function.
|
||||
* @work: Work structure used for scheduling the execution of this function.
|
||||
*
|
||||
* Use @work to get the device object the work is to be done for, determine what
|
||||
* is to be done and execute the appropriate run-time PM function.
|
||||
* is to be done and execute the appropriate runtime PM function.
|
||||
*/
|
||||
static void pm_runtime_work(struct work_struct *work)
|
||||
{
|
||||
@@ -718,7 +718,7 @@ int pm_schedule_suspend(struct device *dev, unsigned int delay)
|
||||
EXPORT_SYMBOL_GPL(pm_schedule_suspend);
|
||||
|
||||
/**
|
||||
* __pm_runtime_idle - Entry point for run-time idle operations.
|
||||
* __pm_runtime_idle - Entry point for runtime idle operations.
|
||||
* @dev: Device to send idle notification for.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
@@ -747,7 +747,7 @@ int __pm_runtime_idle(struct device *dev, int rpmflags)
|
||||
EXPORT_SYMBOL_GPL(__pm_runtime_idle);
|
||||
|
||||
/**
|
||||
* __pm_runtime_suspend - Entry point for run-time put/suspend operations.
|
||||
* __pm_runtime_suspend - Entry point for runtime put/suspend operations.
|
||||
* @dev: Device to suspend.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
@@ -776,7 +776,7 @@ int __pm_runtime_suspend(struct device *dev, int rpmflags)
|
||||
EXPORT_SYMBOL_GPL(__pm_runtime_suspend);
|
||||
|
||||
/**
|
||||
* __pm_runtime_resume - Entry point for run-time resume operations.
|
||||
* __pm_runtime_resume - Entry point for runtime resume operations.
|
||||
* @dev: Device to resume.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
@@ -802,11 +802,11 @@ int __pm_runtime_resume(struct device *dev, int rpmflags)
|
||||
EXPORT_SYMBOL_GPL(__pm_runtime_resume);
|
||||
|
||||
/**
|
||||
* __pm_runtime_set_status - Set run-time PM status of a device.
|
||||
* __pm_runtime_set_status - Set runtime PM status of a device.
|
||||
* @dev: Device to handle.
|
||||
* @status: New run-time PM status of the device.
|
||||
* @status: New runtime PM status of the device.
|
||||
*
|
||||
* If run-time PM of the device is disabled or its power.runtime_error field is
|
||||
* If runtime PM of the device is disabled or its power.runtime_error field is
|
||||
* different from zero, the status may be changed either to RPM_ACTIVE, or to
|
||||
* RPM_SUSPENDED, as long as that reflects the actual state of the device.
|
||||
* However, if the device has a parent and the parent is not active, and the
|
||||
@@ -852,7 +852,7 @@ int __pm_runtime_set_status(struct device *dev, unsigned int status)
|
||||
|
||||
/*
|
||||
* It is invalid to put an active child under a parent that is
|
||||
* not active, has run-time PM enabled and the
|
||||
* not active, has runtime PM enabled and the
|
||||
* 'power.ignore_children' flag unset.
|
||||
*/
|
||||
if (!parent->power.disable_depth
|
||||
@@ -886,7 +886,7 @@ EXPORT_SYMBOL_GPL(__pm_runtime_set_status);
|
||||
* @dev: Device to handle.
|
||||
*
|
||||
* Flush all pending requests for the device from pm_wq and wait for all
|
||||
* run-time PM operations involving the device in progress to complete.
|
||||
* runtime PM operations involving the device in progress to complete.
|
||||
*
|
||||
* Should be called under dev->power.lock with interrupts disabled.
|
||||
*/
|
||||
@@ -934,7 +934,7 @@ static void __pm_runtime_barrier(struct device *dev)
|
||||
* Prevent the device from being suspended by incrementing its usage counter and
|
||||
* if there's a pending resume request for the device, wake the device up.
|
||||
* Next, make sure that all pending requests for the device have been flushed
|
||||
* from pm_wq and wait for all run-time PM operations involving the device in
|
||||
* from pm_wq and wait for all runtime PM operations involving the device in
|
||||
* progress to complete.
|
||||
*
|
||||
* Return value:
|
||||
@@ -964,18 +964,18 @@ int pm_runtime_barrier(struct device *dev)
|
||||
EXPORT_SYMBOL_GPL(pm_runtime_barrier);
|
||||
|
||||
/**
|
||||
* __pm_runtime_disable - Disable run-time PM of a device.
|
||||
* __pm_runtime_disable - Disable runtime PM of a device.
|
||||
* @dev: Device to handle.
|
||||
* @check_resume: If set, check if there's a resume request for the device.
|
||||
*
|
||||
* Increment power.disable_depth for the device and if was zero previously,
|
||||
* cancel all pending run-time PM requests for the device and wait for all
|
||||
* cancel all pending runtime PM requests for the device and wait for all
|
||||
* operations in progress to complete. The device can be either active or
|
||||
* suspended after its run-time PM has been disabled.
|
||||
* suspended after its runtime PM has been disabled.
|
||||
*
|
||||
* If @check_resume is set and there's a resume request pending when
|
||||
* __pm_runtime_disable() is called and power.disable_depth is zero, the
|
||||
* function will wake up the device before disabling its run-time PM.
|
||||
* function will wake up the device before disabling its runtime PM.
|
||||
*/
|
||||
void __pm_runtime_disable(struct device *dev, bool check_resume)
|
||||
{
|
||||
@@ -988,7 +988,7 @@ void __pm_runtime_disable(struct device *dev, bool check_resume)
|
||||
|
||||
/*
|
||||
* Wake up the device if there's a resume request pending, because that
|
||||
* means there probably is some I/O to process and disabling run-time PM
|
||||
* means there probably is some I/O to process and disabling runtime PM
|
||||
* shouldn't prevent the device from processing the I/O.
|
||||
*/
|
||||
if (check_resume && dev->power.request_pending
|
||||
@@ -1013,7 +1013,7 @@ void __pm_runtime_disable(struct device *dev, bool check_resume)
|
||||
EXPORT_SYMBOL_GPL(__pm_runtime_disable);
|
||||
|
||||
/**
|
||||
* pm_runtime_enable - Enable run-time PM of a device.
|
||||
* pm_runtime_enable - Enable runtime PM of a device.
|
||||
* @dev: Device to handle.
|
||||
*/
|
||||
void pm_runtime_enable(struct device *dev)
|
||||
@@ -1032,7 +1032,7 @@ void pm_runtime_enable(struct device *dev)
|
||||
EXPORT_SYMBOL_GPL(pm_runtime_enable);
|
||||
|
||||
/**
|
||||
* pm_runtime_forbid - Block run-time PM of a device.
|
||||
* pm_runtime_forbid - Block runtime PM of a device.
|
||||
* @dev: Device to handle.
|
||||
*
|
||||
* Increase the device's usage count and clear its power.runtime_auto flag,
|
||||
@@ -1055,7 +1055,7 @@ void pm_runtime_forbid(struct device *dev)
|
||||
EXPORT_SYMBOL_GPL(pm_runtime_forbid);
|
||||
|
||||
/**
|
||||
* pm_runtime_allow - Unblock run-time PM of a device.
|
||||
* pm_runtime_allow - Unblock runtime PM of a device.
|
||||
* @dev: Device to handle.
|
||||
*
|
||||
* Decrease the device's usage count and set its power.runtime_auto flag.
|
||||
@@ -1076,12 +1076,12 @@ void pm_runtime_allow(struct device *dev)
|
||||
EXPORT_SYMBOL_GPL(pm_runtime_allow);
|
||||
|
||||
/**
|
||||
* pm_runtime_no_callbacks - Ignore run-time PM callbacks for a device.
|
||||
* pm_runtime_no_callbacks - Ignore runtime PM callbacks for a device.
|
||||
* @dev: Device to handle.
|
||||
*
|
||||
* Set the power.no_callbacks flag, which tells the PM core that this
|
||||
* device is power-managed through its parent and has no run-time PM
|
||||
* callbacks of its own. The run-time sysfs attributes will be removed.
|
||||
* device is power-managed through its parent and has no runtime PM
|
||||
* callbacks of its own. The runtime sysfs attributes will be removed.
|
||||
*/
|
||||
void pm_runtime_no_callbacks(struct device *dev)
|
||||
{
|
||||
@@ -1157,8 +1157,8 @@ static void update_autosuspend(struct device *dev, int old_delay, int old_use)
|
||||
* @delay: Value of the new delay in milliseconds.
|
||||
*
|
||||
* Set the device's power.autosuspend_delay value. If it changes to negative
|
||||
* and the power.use_autosuspend flag is set, prevent run-time suspends. If it
|
||||
* changes the other way, allow run-time suspends.
|
||||
* and the power.use_autosuspend flag is set, prevent runtime suspends. If it
|
||||
* changes the other way, allow runtime suspends.
|
||||
*/
|
||||
void pm_runtime_set_autosuspend_delay(struct device *dev, int delay)
|
||||
{
|
||||
@@ -1178,7 +1178,7 @@ EXPORT_SYMBOL_GPL(pm_runtime_set_autosuspend_delay);
|
||||
* @dev: Device to handle.
|
||||
* @use: New value for use_autosuspend.
|
||||
*
|
||||
* Set the device's power.use_autosuspend flag, and allow or prevent run-time
|
||||
* Set the device's power.use_autosuspend flag, and allow or prevent runtime
|
||||
* suspends as needed.
|
||||
*/
|
||||
void __pm_runtime_use_autosuspend(struct device *dev, bool use)
|
||||
@@ -1195,7 +1195,7 @@ void __pm_runtime_use_autosuspend(struct device *dev, bool use)
|
||||
EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend);
|
||||
|
||||
/**
|
||||
* pm_runtime_init - Initialize run-time PM fields in given device object.
|
||||
* pm_runtime_init - Initialize runtime PM fields in given device object.
|
||||
* @dev: Device object to initialize.
|
||||
*/
|
||||
void pm_runtime_init(struct device *dev)
|
||||
|
Reference in New Issue
Block a user