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

Configure Feed

Select the types of activity you want to include in your feed.

firmware: arm_scmi: Fix kernel doc warnings

Kernel doc validation script is unhappy and complains with the below set
of warnings.

| Function parameter or member 'fast_switch_possible' not described in 'scmi_perf_proto_ops'
| Function parameter or member 'power_scale_mw_get' not described in 'scmi_perf_proto_ops'
| cannot understand function prototype: 'struct scmi_sensor_reading '
| cannot understand function prototype: 'struct scmi_range_attrs '
| cannot understand function prototype: 'struct scmi_sensor_axis_info '
| cannot understand function prototype: 'struct scmi_sensor_intervals_info '

Fix them adding appropriate documents or missing keywords.

Link: https://lore.kernel.org/r/20210712130801.2436492-2-sudeep.holla@arm.com
Reviewed-by: Cristian Marussi <cristian.marussi@arm.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>

Sudeep Holla 52f83955 7a691f16

+9 -5
+9 -5
include/linux/scmi_protocol.h
··· 101 101 * to sustained performance level mapping 102 102 * @est_power_get: gets the estimated power cost for a given performance domain 103 103 * at a given frequency 104 + * @fast_switch_possible: indicates if fast DVFS switching is possible or not 105 + * for a given device 106 + * @power_scale_mw_get: indicates if the power values provided are in milliWatts 107 + * or in some other (abstract) scale 104 108 */ 105 109 struct scmi_perf_proto_ops { 106 110 int (*limits_set)(const struct scmi_protocol_handle *ph, u32 domain, ··· 157 153 }; 158 154 159 155 /** 160 - * scmi_sensor_reading - represent a timestamped read 156 + * struct scmi_sensor_reading - represent a timestamped read 161 157 * 162 158 * Used by @reading_get_timestamped method. 163 159 * ··· 171 167 }; 172 168 173 169 /** 174 - * scmi_range_attrs - specifies a sensor or axis values' range 170 + * struct scmi_range_attrs - specifies a sensor or axis values' range 175 171 * @min_range: The minimum value which can be represented by the sensor/axis. 176 172 * @max_range: The maximum value which can be represented by the sensor/axis. 177 173 */ ··· 181 177 }; 182 178 183 179 /** 184 - * scmi_sensor_axis_info - describes one sensor axes 180 + * struct scmi_sensor_axis_info - describes one sensor axes 185 181 * @id: The axes ID. 186 182 * @type: Axes type. Chosen amongst one of @enum scmi_sensor_class. 187 183 * @scale: Power-of-10 multiplier applied to the axis unit. ··· 209 205 }; 210 206 211 207 /** 212 - * scmi_sensor_intervals_info - describes number and type of available update 213 - * intervals 208 + * struct scmi_sensor_intervals_info - describes number and type of available 209 + * update intervals 214 210 * @segmented: Flag for segmented intervals' representation. When True there 215 211 * will be exactly 3 intervals in @desc, with each entry 216 212 * representing a member of a segment in this order: