PM / devfreq: comments for get_dev_status usage updated

With the introduction of devfreq_update_stats(), governors
are not recommended to use get_dev_status() directly.

Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>
This commit is contained in:
MyungJoo Ham 2015-08-18 13:45:49 +09:00
parent d3b7e1745c
commit d54cdf3fc9

View file

@ -65,7 +65,10 @@ struct devfreq_dev_status {
* The "flags" parameter's possible values are * The "flags" parameter's possible values are
* explained above with "DEVFREQ_FLAG_*" macros. * explained above with "DEVFREQ_FLAG_*" macros.
* @get_dev_status: The device should provide the current performance * @get_dev_status: The device should provide the current performance
* status to devfreq, which is used by governors. * status to devfreq. Governors are recommended not to
* use this directly. Instead, governors are recommended
* to use devfreq_update_stats() along with
* devfreq.last_status.
* @get_cur_freq: The device should provide the current frequency * @get_cur_freq: The device should provide the current frequency
* at which it is operating. * at which it is operating.
* @exit: An optional callback that is called when devfreq * @exit: An optional callback that is called when devfreq
@ -208,6 +211,10 @@ extern void devm_devfreq_unregister_opp_notifier(struct device *dev,
/** /**
* devfreq_update_stats() - update the last_status pointer in struct devfreq * devfreq_update_stats() - update the last_status pointer in struct devfreq
* @df: the devfreq instance whose status needs updating * @df: the devfreq instance whose status needs updating
*
* Governors are recommended to use this function along with last_status,
* which allows other entities to reuse the last_status without affecting
* the values fetched later by governors.
*/ */
static inline int devfreq_update_stats(struct devfreq *df) static inline int devfreq_update_stats(struct devfreq *df)
{ {