diff options
author | Rafael J. Wysocki <rjw@sisk.pl> | 2011-07-06 04:52:13 -0400 |
---|---|---|
committer | Rafael J. Wysocki <rjw@sisk.pl> | 2011-07-06 04:52:13 -0400 |
commit | 62052ab1d1a456f5f62f8b753e12d10ca1a83604 (patch) | |
tree | 0a4bca617dbec22b82f9261c0b99ff40ef7fc5b9 /drivers/base | |
parent | e358bad75ff13210f5211cac9f93d76170d43f89 (diff) |
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>
Diffstat (limited to 'drivers/base')
-rw-r--r-- | drivers/base/power/runtime.c | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c index ee99025be6b3..be7b982d252e 100644 --- a/drivers/base/power/runtime.c +++ b/drivers/base/power/runtime.c | |||
@@ -1,5 +1,5 @@ | |||
1 | /* | 1 | /* |
2 | * drivers/base/power/runtime.c - Helper functions for device run-time PM | 2 | * drivers/base/power/runtime.c - Helper functions for device runtime PM |
3 | * | 3 | * |
4 | * Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc. | 4 | * Copyright (c) 2009 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc. |
5 | * Copyright (C) 2010 Alan Stern <stern@rowland.harvard.edu> | 5 | * Copyright (C) 2010 Alan Stern <stern@rowland.harvard.edu> |
@@ -159,7 +159,7 @@ static int rpm_check_suspend_allowed(struct device *dev) | |||
159 | * @dev: Device to notify the bus type about. | 159 | * @dev: Device to notify the bus type about. |
160 | * @rpmflags: Flag bits. | 160 | * @rpmflags: Flag bits. |
161 | * | 161 | * |
162 | * Check if the device's run-time PM status allows it to be suspended. If | 162 | * Check if the device's runtime PM status allows it to be suspended. If |
163 | * another idle notification has been started earlier, return immediately. If | 163 | * another idle notification has been started earlier, return immediately. If |
164 | * the RPM_ASYNC flag is set then queue an idle-notification request; otherwise | 164 | * the RPM_ASYNC flag is set then queue an idle-notification request; otherwise |
165 | * run the ->runtime_idle() callback directly. | 165 | * run the ->runtime_idle() callback directly. |
@@ -267,11 +267,11 @@ static int rpm_callback(int (*cb)(struct device *), struct device *dev) | |||
267 | } | 267 | } |
268 | 268 | ||
269 | /** | 269 | /** |
270 | * rpm_suspend - Carry out run-time suspend of given device. | 270 | * rpm_suspend - Carry out runtime suspend of given device. |
271 | * @dev: Device to suspend. | 271 | * @dev: Device to suspend. |
272 | * @rpmflags: Flag bits. | 272 | * @rpmflags: Flag bits. |
273 | * | 273 | * |
274 | * Check if the device's run-time PM status allows it to be suspended. If | 274 | * Check if the device's runtime PM status allows it to be suspended. If |
275 | * another suspend has been started earlier, either return immediately or wait | 275 | * another suspend has been started earlier, either return immediately or wait |
276 | * for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC flags. Cancel a | 276 | * for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC flags. Cancel a |
277 | * pending idle notification. If the RPM_ASYNC flag is set then queue a | 277 | * 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) | |||
430 | } | 430 | } |
431 | 431 | ||
432 | /** | 432 | /** |
433 | * rpm_resume - Carry out run-time resume of given device. | 433 | * rpm_resume - Carry out runtime resume of given device. |
434 | * @dev: Device to resume. | 434 | * @dev: Device to resume. |
435 | * @rpmflags: Flag bits. | 435 | * @rpmflags: Flag bits. |
436 | * | 436 | * |
437 | * Check if the device's run-time PM status allows it to be resumed. Cancel | 437 | * Check if the device's runtime PM status allows it to be resumed. Cancel |
438 | * any scheduled or pending requests. If another resume has been started | 438 | * any scheduled or pending requests. If another resume has been started |
439 | * earlier, either return immediately or wait for it to finish, depending on the | 439 | * earlier, either return immediately or wait for it to finish, depending on the |
440 | * RPM_NOWAIT and RPM_ASYNC flags. Similarly, if there's a suspend running in | 440 | * 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) | |||
551 | 551 | ||
552 | spin_lock(&parent->power.lock); | 552 | spin_lock(&parent->power.lock); |
553 | /* | 553 | /* |
554 | * We can resume if the parent's run-time PM is disabled or it | 554 | * We can resume if the parent's runtime PM is disabled or it |
555 | * is set to ignore children. | 555 | * is set to ignore children. |
556 | */ | 556 | */ |
557 | if (!parent->power.disable_depth | 557 | if (!parent->power.disable_depth |
@@ -615,11 +615,11 @@ static int rpm_resume(struct device *dev, int rpmflags) | |||
615 | } | 615 | } |
616 | 616 | ||
617 | /** | 617 | /** |
618 | * pm_runtime_work - Universal run-time PM work function. | 618 | * pm_runtime_work - Universal runtime PM work function. |
619 | * @work: Work structure used for scheduling the execution of this function. | 619 | * @work: Work structure used for scheduling the execution of this function. |
620 | * | 620 | * |
621 | * Use @work to get the device object the work is to be done for, determine what | 621 | * Use @work to get the device object the work is to be done for, determine what |
622 | * is to be done and execute the appropriate run-time PM function. | 622 | * is to be done and execute the appropriate runtime PM function. |
623 | */ | 623 | */ |
624 | static void pm_runtime_work(struct work_struct *work) | 624 | static void pm_runtime_work(struct work_struct *work) |
625 | { | 625 | { |
@@ -718,7 +718,7 @@ int pm_schedule_suspend(struct device *dev, unsigned int delay) | |||
718 | EXPORT_SYMBOL_GPL(pm_schedule_suspend); | 718 | EXPORT_SYMBOL_GPL(pm_schedule_suspend); |
719 | 719 | ||
720 | /** | 720 | /** |
721 | * __pm_runtime_idle - Entry point for run-time idle operations. | 721 | * __pm_runtime_idle - Entry point for runtime idle operations. |
722 | * @dev: Device to send idle notification for. | 722 | * @dev: Device to send idle notification for. |
723 | * @rpmflags: Flag bits. | 723 | * @rpmflags: Flag bits. |
724 | * | 724 | * |
@@ -747,7 +747,7 @@ int __pm_runtime_idle(struct device *dev, int rpmflags) | |||
747 | EXPORT_SYMBOL_GPL(__pm_runtime_idle); | 747 | EXPORT_SYMBOL_GPL(__pm_runtime_idle); |
748 | 748 | ||
749 | /** | 749 | /** |
750 | * __pm_runtime_suspend - Entry point for run-time put/suspend operations. | 750 | * __pm_runtime_suspend - Entry point for runtime put/suspend operations. |
751 | * @dev: Device to suspend. | 751 | * @dev: Device to suspend. |
752 | * @rpmflags: Flag bits. | 752 | * @rpmflags: Flag bits. |
753 | * | 753 | * |
@@ -776,7 +776,7 @@ int __pm_runtime_suspend(struct device *dev, int rpmflags) | |||
776 | EXPORT_SYMBOL_GPL(__pm_runtime_suspend); | 776 | EXPORT_SYMBOL_GPL(__pm_runtime_suspend); |
777 | 777 | ||
778 | /** | 778 | /** |
779 | * __pm_runtime_resume - Entry point for run-time resume operations. | 779 | * __pm_runtime_resume - Entry point for runtime resume operations. |
780 | * @dev: Device to resume. | 780 | * @dev: Device to resume. |
781 | * @rpmflags: Flag bits. | 781 | * @rpmflags: Flag bits. |
782 | * | 782 | * |
@@ -802,11 +802,11 @@ int __pm_runtime_resume(struct device *dev, int rpmflags) | |||
802 | EXPORT_SYMBOL_GPL(__pm_runtime_resume); | 802 | EXPORT_SYMBOL_GPL(__pm_runtime_resume); |
803 | 803 | ||
804 | /** | 804 | /** |
805 | * __pm_runtime_set_status - Set run-time PM status of a device. | 805 | * __pm_runtime_set_status - Set runtime PM status of a device. |
806 | * @dev: Device to handle. | 806 | * @dev: Device to handle. |
807 | * @status: New run-time PM status of the device. | 807 | * @status: New runtime PM status of the device. |
808 | * | 808 | * |
809 | * If run-time PM of the device is disabled or its power.runtime_error field is | 809 | * If runtime PM of the device is disabled or its power.runtime_error field is |
810 | * different from zero, the status may be changed either to RPM_ACTIVE, or to | 810 | * different from zero, the status may be changed either to RPM_ACTIVE, or to |
811 | * RPM_SUSPENDED, as long as that reflects the actual state of the device. | 811 | * RPM_SUSPENDED, as long as that reflects the actual state of the device. |
812 | * However, if the device has a parent and the parent is not active, and the | 812 | * 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) | |||
852 | 852 | ||
853 | /* | 853 | /* |
854 | * It is invalid to put an active child under a parent that is | 854 | * It is invalid to put an active child under a parent that is |
855 | * not active, has run-time PM enabled and the | 855 | * not active, has runtime PM enabled and the |
856 | * 'power.ignore_children' flag unset. | 856 | * 'power.ignore_children' flag unset. |
857 | */ | 857 | */ |
858 | if (!parent->power.disable_depth | 858 | if (!parent->power.disable_depth |
@@ -886,7 +886,7 @@ EXPORT_SYMBOL_GPL(__pm_runtime_set_status); | |||
886 | * @dev: Device to handle. | 886 | * @dev: Device to handle. |
887 | * | 887 | * |
888 | * Flush all pending requests for the device from pm_wq and wait for all | 888 | * Flush all pending requests for the device from pm_wq and wait for all |
889 | * run-time PM operations involving the device in progress to complete. | 889 | * runtime PM operations involving the device in progress to complete. |
890 | * | 890 | * |
891 | * Should be called under dev->power.lock with interrupts disabled. | 891 | * Should be called under dev->power.lock with interrupts disabled. |
892 | */ | 892 | */ |
@@ -934,7 +934,7 @@ static void __pm_runtime_barrier(struct device *dev) | |||
934 | * Prevent the device from being suspended by incrementing its usage counter and | 934 | * Prevent the device from being suspended by incrementing its usage counter and |
935 | * if there's a pending resume request for the device, wake the device up. | 935 | * if there's a pending resume request for the device, wake the device up. |
936 | * Next, make sure that all pending requests for the device have been flushed | 936 | * Next, make sure that all pending requests for the device have been flushed |
937 | * from pm_wq and wait for all run-time PM operations involving the device in | 937 | * from pm_wq and wait for all runtime PM operations involving the device in |
938 | * progress to complete. | 938 | * progress to complete. |
939 | * | 939 | * |
940 | * Return value: | 940 | * Return value: |
@@ -964,18 +964,18 @@ int pm_runtime_barrier(struct device *dev) | |||
964 | EXPORT_SYMBOL_GPL(pm_runtime_barrier); | 964 | EXPORT_SYMBOL_GPL(pm_runtime_barrier); |
965 | 965 | ||
966 | /** | 966 | /** |
967 | * __pm_runtime_disable - Disable run-time PM of a device. | 967 | * __pm_runtime_disable - Disable runtime PM of a device. |
968 | * @dev: Device to handle. | 968 | * @dev: Device to handle. |
969 | * @check_resume: If set, check if there's a resume request for the device. | 969 | * @check_resume: If set, check if there's a resume request for the device. |
970 | * | 970 | * |
971 | * Increment power.disable_depth for the device and if was zero previously, | 971 | * Increment power.disable_depth for the device and if was zero previously, |
972 | * cancel all pending run-time PM requests for the device and wait for all | 972 | * cancel all pending runtime PM requests for the device and wait for all |
973 | * operations in progress to complete. The device can be either active or | 973 | * operations in progress to complete. The device can be either active or |
974 | * suspended after its run-time PM has been disabled. | 974 | * suspended after its runtime PM has been disabled. |
975 | * | 975 | * |
976 | * If @check_resume is set and there's a resume request pending when | 976 | * If @check_resume is set and there's a resume request pending when |
977 | * __pm_runtime_disable() is called and power.disable_depth is zero, the | 977 | * __pm_runtime_disable() is called and power.disable_depth is zero, the |
978 | * function will wake up the device before disabling its run-time PM. | 978 | * function will wake up the device before disabling its runtime PM. |
979 | */ | 979 | */ |
980 | void __pm_runtime_disable(struct device *dev, bool check_resume) | 980 | void __pm_runtime_disable(struct device *dev, bool check_resume) |
981 | { | 981 | { |
@@ -988,7 +988,7 @@ void __pm_runtime_disable(struct device *dev, bool check_resume) | |||
988 | 988 | ||
989 | /* | 989 | /* |
990 | * Wake up the device if there's a resume request pending, because that | 990 | * Wake up the device if there's a resume request pending, because that |
991 | * means there probably is some I/O to process and disabling run-time PM | 991 | * means there probably is some I/O to process and disabling runtime PM |
992 | * shouldn't prevent the device from processing the I/O. | 992 | * shouldn't prevent the device from processing the I/O. |
993 | */ | 993 | */ |
994 | if (check_resume && dev->power.request_pending | 994 | if (check_resume && dev->power.request_pending |
@@ -1013,7 +1013,7 @@ void __pm_runtime_disable(struct device *dev, bool check_resume) | |||
1013 | EXPORT_SYMBOL_GPL(__pm_runtime_disable); | 1013 | EXPORT_SYMBOL_GPL(__pm_runtime_disable); |
1014 | 1014 | ||
1015 | /** | 1015 | /** |
1016 | * pm_runtime_enable - Enable run-time PM of a device. | 1016 | * pm_runtime_enable - Enable runtime PM of a device. |
1017 | * @dev: Device to handle. | 1017 | * @dev: Device to handle. |
1018 | */ | 1018 | */ |
1019 | void pm_runtime_enable(struct device *dev) | 1019 | void pm_runtime_enable(struct device *dev) |
@@ -1032,7 +1032,7 @@ void pm_runtime_enable(struct device *dev) | |||
1032 | EXPORT_SYMBOL_GPL(pm_runtime_enable); | 1032 | EXPORT_SYMBOL_GPL(pm_runtime_enable); |
1033 | 1033 | ||
1034 | /** | 1034 | /** |
1035 | * pm_runtime_forbid - Block run-time PM of a device. | 1035 | * pm_runtime_forbid - Block runtime PM of a device. |
1036 | * @dev: Device to handle. | 1036 | * @dev: Device to handle. |
1037 | * | 1037 | * |
1038 | * Increase the device's usage count and clear its power.runtime_auto flag, | 1038 | * Increase the device's usage count and clear its power.runtime_auto flag, |
@@ -1055,7 +1055,7 @@ void pm_runtime_forbid(struct device *dev) | |||
1055 | EXPORT_SYMBOL_GPL(pm_runtime_forbid); | 1055 | EXPORT_SYMBOL_GPL(pm_runtime_forbid); |
1056 | 1056 | ||
1057 | /** | 1057 | /** |
1058 | * pm_runtime_allow - Unblock run-time PM of a device. | 1058 | * pm_runtime_allow - Unblock runtime PM of a device. |
1059 | * @dev: Device to handle. | 1059 | * @dev: Device to handle. |
1060 | * | 1060 | * |
1061 | * Decrease the device's usage count and set its power.runtime_auto flag. | 1061 | * Decrease the device's usage count and set its power.runtime_auto flag. |
@@ -1076,12 +1076,12 @@ void pm_runtime_allow(struct device *dev) | |||
1076 | EXPORT_SYMBOL_GPL(pm_runtime_allow); | 1076 | EXPORT_SYMBOL_GPL(pm_runtime_allow); |
1077 | 1077 | ||
1078 | /** | 1078 | /** |
1079 | * pm_runtime_no_callbacks - Ignore run-time PM callbacks for a device. | 1079 | * pm_runtime_no_callbacks - Ignore runtime PM callbacks for a device. |
1080 | * @dev: Device to handle. | 1080 | * @dev: Device to handle. |
1081 | * | 1081 | * |
1082 | * Set the power.no_callbacks flag, which tells the PM core that this | 1082 | * Set the power.no_callbacks flag, which tells the PM core that this |
1083 | * device is power-managed through its parent and has no run-time PM | 1083 | * device is power-managed through its parent and has no runtime PM |
1084 | * callbacks of its own. The run-time sysfs attributes will be removed. | 1084 | * callbacks of its own. The runtime sysfs attributes will be removed. |
1085 | */ | 1085 | */ |
1086 | void pm_runtime_no_callbacks(struct device *dev) | 1086 | void pm_runtime_no_callbacks(struct device *dev) |
1087 | { | 1087 | { |
@@ -1157,8 +1157,8 @@ static void update_autosuspend(struct device *dev, int old_delay, int old_use) | |||
1157 | * @delay: Value of the new delay in milliseconds. | 1157 | * @delay: Value of the new delay in milliseconds. |
1158 | * | 1158 | * |
1159 | * Set the device's power.autosuspend_delay value. If it changes to negative | 1159 | * Set the device's power.autosuspend_delay value. If it changes to negative |
1160 | * and the power.use_autosuspend flag is set, prevent run-time suspends. If it | 1160 | * and the power.use_autosuspend flag is set, prevent runtime suspends. If it |
1161 | * changes the other way, allow run-time suspends. | 1161 | * changes the other way, allow runtime suspends. |
1162 | */ | 1162 | */ |
1163 | void pm_runtime_set_autosuspend_delay(struct device *dev, int delay) | 1163 | void pm_runtime_set_autosuspend_delay(struct device *dev, int delay) |
1164 | { | 1164 | { |
@@ -1178,7 +1178,7 @@ EXPORT_SYMBOL_GPL(pm_runtime_set_autosuspend_delay); | |||
1178 | * @dev: Device to handle. | 1178 | * @dev: Device to handle. |
1179 | * @use: New value for use_autosuspend. | 1179 | * @use: New value for use_autosuspend. |
1180 | * | 1180 | * |
1181 | * Set the device's power.use_autosuspend flag, and allow or prevent run-time | 1181 | * Set the device's power.use_autosuspend flag, and allow or prevent runtime |
1182 | * suspends as needed. | 1182 | * suspends as needed. |
1183 | */ | 1183 | */ |
1184 | void __pm_runtime_use_autosuspend(struct device *dev, bool use) | 1184 | void __pm_runtime_use_autosuspend(struct device *dev, bool use) |
@@ -1195,7 +1195,7 @@ void __pm_runtime_use_autosuspend(struct device *dev, bool use) | |||
1195 | EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend); | 1195 | EXPORT_SYMBOL_GPL(__pm_runtime_use_autosuspend); |
1196 | 1196 | ||
1197 | /** | 1197 | /** |
1198 | * pm_runtime_init - Initialize run-time PM fields in given device object. | 1198 | * pm_runtime_init - Initialize runtime PM fields in given device object. |
1199 | * @dev: Device object to initialize. | 1199 | * @dev: Device object to initialize. |
1200 | */ | 1200 | */ |
1201 | void pm_runtime_init(struct device *dev) | 1201 | void pm_runtime_init(struct device *dev) |