Skip to content

Commit c46de2f

Browse files
Mani-Sadhasivamchanwoochoi
authored andcommitted
PM / devfreq: Reword the kernel-doc comment for devfreq_monitor_start() API
Current kernel-doc comment doesn't specify the default timer used for the load monitoring. Also, it uses the term "default delayed work" which could be misunderstood as "default delayer timer". So reword the comment to clearly specify the default timer and also reword the last sentence to make it more understandable. Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org> Signed-off-by: Chanwoo Choi <cw00.choi@samsung.com>
1 parent 9027f2e commit c46de2f

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

drivers/devfreq/devfreq.c

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -472,10 +472,11 @@ static void devfreq_monitor(struct work_struct *work)
472472
* devfreq_monitor_start() - Start load monitoring of devfreq instance
473473
* @devfreq: the devfreq instance.
474474
*
475-
* Helper function for starting devfreq device load monitoring. By
476-
* default delayed work based monitoring is supported. Function
477-
* to be called from governor in response to DEVFREQ_GOV_START
478-
* event when device is added to devfreq framework.
475+
* Helper function for starting devfreq device load monitoring. By default,
476+
* deferrable timer is used for load monitoring. But the users can change this
477+
* behavior using the "timer" type in devfreq_dev_profile. This function will be
478+
* called by devfreq governor in response to the DEVFREQ_GOV_START event
479+
* generated while adding a device to the devfreq framework.
479480
*/
480481
void devfreq_monitor_start(struct devfreq *devfreq)
481482
{

0 commit comments

Comments
 (0)