Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

PM / devfreq: documentation cleanups for devfreq header

struct parameters need to have ':' in documentation for
scripts/kernel-doc to parse appropriately.

Fix the errors reported by:
./scripts/kernel-doc include/linux/devfreq.h >/dev/null

Cc: Rajagopal Venkat <rajagopal.venkat@linaro.org>
Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: "Rafael J. Wysocki" <rjw@sisk.pl>
Cc: Kevin Hilman <khilman@ti.com>
Cc: linux-pm@vger.kernel.org
Cc: linux-kernel@vger.kernel.org

Signed-off-by: Nishanth Menon <nm@ti.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Acked-by: MyungJoo Ham <myungjoo.ham@samsung.com>
Signed-off-by: MyungJoo Ham <myungjoo.ham@samsung.com>

authored by

Nishanth Menon and committed by
MyungJoo Ham
e09651fc d7895052

+27 -27
+27 -27
include/linux/devfreq.h
··· 25 25 * struct devfreq_dev_status - Data given from devfreq user device to 26 26 * governors. Represents the performance 27 27 * statistics. 28 - * @total_time The total time represented by this instance of 28 + * @total_time: The total time represented by this instance of 29 29 * devfreq_dev_status 30 - * @busy_time The time that the device was working among the 30 + * @busy_time: The time that the device was working among the 31 31 * total_time. 32 - * @current_frequency The operating frequency. 33 - * @private_data An entry not specified by the devfreq framework. 32 + * @current_frequency: The operating frequency. 33 + * @private_data: An entry not specified by the devfreq framework. 34 34 * A device and a specific governor may have their 35 35 * own protocol with private_data. However, because 36 36 * this is governor-specific, a governor using this ··· 54 54 55 55 /** 56 56 * struct devfreq_dev_profile - Devfreq's user device profile 57 - * @initial_freq The operating frequency when devfreq_add_device() is 57 + * @initial_freq: The operating frequency when devfreq_add_device() is 58 58 * called. 59 - * @polling_ms The polling interval in ms. 0 disables polling. 60 - * @target The device should set its operating frequency at 59 + * @polling_ms: The polling interval in ms. 0 disables polling. 60 + * @target: The device should set its operating frequency at 61 61 * freq or lowest-upper-than-freq value. If freq is 62 62 * higher than any operable frequency, set maximum. 63 63 * Before returning, target function should set 64 64 * freq at the current frequency. 65 65 * The "flags" parameter's possible values are 66 66 * explained above with "DEVFREQ_FLAG_*" macros. 67 - * @get_dev_status The device should provide the current performance 67 + * @get_dev_status: The device should provide the current performance 68 68 * status to devfreq, which is used by governors. 69 - * @get_cur_freq The device should provide the current frequency 69 + * @get_cur_freq: The device should provide the current frequency 70 70 * at which it is operating. 71 - * @exit An optional callback that is called when devfreq 71 + * @exit: An optional callback that is called when devfreq 72 72 * is removing the devfreq object due to error or 73 73 * from devfreq_remove_device() call. If the user 74 74 * has registered devfreq->nb at a notifier-head, ··· 87 87 88 88 /** 89 89 * struct devfreq_governor - Devfreq policy governor 90 - * @name Governor's name 91 - * @get_target_freq Returns desired operating frequency for the device. 90 + * @name: Governor's name 91 + * @get_target_freq: Returns desired operating frequency for the device. 92 92 * Basically, get_target_freq will run 93 93 * devfreq_dev_profile.get_dev_status() to get the 94 94 * status of the device (load = busy_time / total_time). 95 95 * If no_central_polling is set, this callback is called 96 96 * only with update_devfreq() notified by OPP. 97 - * @event_handler Callback for devfreq core framework to notify events 97 + * @event_handler: Callback for devfreq core framework to notify events 98 98 * to governors. Events include per device governor 99 99 * init and exit, opp changes out of devfreq, suspend 100 100 * and resume of per device devfreq during device idle. ··· 110 110 111 111 /** 112 112 * struct devfreq - Device devfreq structure 113 - * @node list node - contains the devices with devfreq that have been 113 + * @node: list node - contains the devices with devfreq that have been 114 114 * registered. 115 - * @lock a mutex to protect accessing devfreq. 116 - * @dev device registered by devfreq class. dev.parent is the device 115 + * @lock: a mutex to protect accessing devfreq. 116 + * @dev: device registered by devfreq class. dev.parent is the device 117 117 * using devfreq. 118 - * @profile device-specific devfreq profile 119 - * @governor method how to choose frequency based on the usage. 120 - * @nb notifier block used to notify devfreq object that it should 118 + * @profile: device-specific devfreq profile 119 + * @governor: method how to choose frequency based on the usage. 120 + * @nb: notifier block used to notify devfreq object that it should 121 121 * reevaluate operable frequencies. Devfreq users may use 122 122 * devfreq.nb to the corresponding register notifier call chain. 123 - * @work delayed work for load monitoring. 124 - * @previous_freq previously configured frequency value. 125 - * @data Private data of the governor. The devfreq framework does not 123 + * @work: delayed work for load monitoring. 124 + * @previous_freq: previously configured frequency value. 125 + * @data: Private data of the governor. The devfreq framework does not 126 126 * touch this. 127 - * @min_freq Limit minimum frequency requested by user (0: none) 128 - * @max_freq Limit maximum frequency requested by user (0: none) 129 - * @stop_polling devfreq polling status of a device. 127 + * @min_freq: Limit minimum frequency requested by user (0: none) 128 + * @max_freq: Limit maximum frequency requested by user (0: none) 129 + * @stop_polling: devfreq polling status of a device. 130 130 * 131 131 * This structure stores the devfreq information for a give device. 132 132 * ··· 186 186 /** 187 187 * struct devfreq_simple_ondemand_data - void *data fed to struct devfreq 188 188 * and devfreq_add_device 189 - * @ upthreshold If the load is over this value, the frequency jumps. 189 + * @upthreshold: If the load is over this value, the frequency jumps. 190 190 * Specify 0 to use the default. Valid value = 0 to 100. 191 - * @ downdifferential If the load is under upthreshold - downdifferential, 191 + * @downdifferential: If the load is under upthreshold - downdifferential, 192 192 * the governor may consider slowing the frequency down. 193 193 * Specify 0 to use the default. Valid value = 0 to 100. 194 194 * downdifferential < upthreshold must hold.