summaryrefslogtreecommitdiff
path: root/drivers/devfreq
diff options
context:
space:
mode:
authorMyungJoo Ham <myungjoo.ham@samsung.com>2013-02-05 09:40:17 +0000
committerJonghwa Lee <jonghwa3.lee@samsung.com>2014-05-15 18:59:11 +0900
commite94b287efc0ef62ce72f6a83c71daaeef5fdc25d (patch)
treee98a371e3fc65bd5d0e6ab36977afefadfee346c /drivers/devfreq
parent48eac23b608c6d8d65cb7a03cb64fff8c418dca1 (diff)
downloadlinux-3.10-e94b287efc0ef62ce72f6a83c71daaeef5fdc25d.tar.gz
linux-3.10-e94b287efc0ef62ce72f6a83c71daaeef5fdc25d.tar.bz2
linux-3.10-e94b287efc0ef62ce72f6a83c71daaeef5fdc25d.zip
PM / devfreq: add comments and Documentation
- Added missing ABI documents - Added comments to clarify the objectives of functions Change-Id: Ic2206ad6671156eedb28d450046e8e2ea876b18c Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com> Acked-by: Nishanth Menon <nm@ti.com> Acked-by: Rajagopal Venkat <rajagopal.venkat@linaro.org>
Diffstat (limited to 'drivers/devfreq')
-rw-r--r--drivers/devfreq/devfreq.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
index abfa14dd8b4..44c407986f6 100644
--- a/drivers/devfreq/devfreq.c
+++ b/drivers/devfreq/devfreq.c
@@ -527,6 +527,8 @@ EXPORT_SYMBOL(devfreq_add_device);
/**
* devfreq_remove_device() - Remove devfreq feature from a device.
* @devfreq: the devfreq instance to be removed
+ *
+ * The opposite of devfreq_add_device().
*/
int devfreq_remove_device(struct devfreq *devfreq)
{
@@ -542,6 +544,10 @@ EXPORT_SYMBOL(devfreq_remove_device);
/**
* devfreq_suspend_device() - Suspend devfreq of a device.
* @devfreq: the devfreq instance to be suspended
+ *
+ * This function is intended to be called by the pm callbacks
+ * (e.g., runtime_suspend, suspend) of the device driver that
+ * holds the devfreq.
*/
int devfreq_suspend_device(struct devfreq *devfreq)
{
@@ -559,6 +565,10 @@ EXPORT_SYMBOL(devfreq_suspend_device);
/**
* devfreq_resume_device() - Resume devfreq of a device.
* @devfreq: the devfreq instance to be resumed
+ *
+ * This function is intended to be called by the pm callbacks
+ * (e.g., runtime_resume, resume) of the device driver that
+ * holds the devfreq.
*/
int devfreq_resume_device(struct devfreq *devfreq)
{