diff options
| author | Sudeep Holla <sudeep.holla@arm.com> | 2021-07-12 12:27:48 +0200 |
|---|---|---|
| committer | Sudeep Holla <sudeep.holla@arm.com> | 2021-07-13 12:39:48 +0200 |
| commit | 5ff6319d46cee22c9cd6f39a377e32c444f9a7b0 (patch) | |
| tree | aba2cb1ad513dfbbdb7b91c40331fac44e3171f5 /include | |
| parent | firmware: arm_scmi: Fix kernel doc warnings (diff) | |
| download | linux-5ff6319d46cee22c9cd6f39a377e32c444f9a7b0.tar.xz linux-5ff6319d46cee22c9cd6f39a377e32c444f9a7b0.zip | |
firmware: arm_scpi: Fix kernel doc warnings
Kernel doc validation script is unhappy and complains with the below set
of warnings.
| Function parameter or member 'device_domain_id' not described in 'scpi_ops'
| Function parameter or member 'get_transition_latency' not described in 'scpi_ops'
| Function parameter or member 'add_opps_to_device' not described in 'scpi_ops'
| Function parameter or member 'sensor_get_capability' not described in 'scpi_ops'
| Function parameter or member 'sensor_get_info' not described in 'scpi_ops'
| Function parameter or member 'sensor_get_value' not described in 'scpi_ops'
| Function parameter or member 'device_get_power_state' not described in 'scpi_ops'
| Function parameter or member 'device_set_power_state' not described in 'scpi_ops'
Fix them adding appropriate documents or missing keywords.
Link: https://lore.kernel.org/r/20210712130801.2436492-1-sudeep.holla@arm.com
Reviewed-by: Cristian Marussi <cristian.marussi@arm.com>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/linux/scpi_protocol.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/include/linux/scpi_protocol.h b/include/linux/scpi_protocol.h index afbf8037d8db..d2176a56828a 100644 --- a/include/linux/scpi_protocol.h +++ b/include/linux/scpi_protocol.h @@ -51,6 +51,14 @@ struct scpi_sensor_info { * OPP is an index to the list return by @dvfs_get_info * @dvfs_get_info: returns the DVFS capabilities of the given power * domain. It includes the OPP list and the latency information + * @device_domain_id: gets the scpi domain id for a given device + * @get_transition_latency: gets the DVFS transition latency for a given device + * @add_opps_to_device: adds all the OPPs for a given device + * @sensor_get_capability: get the list of capabilities for the sensors + * @sensor_get_info: get the information of the specified sensor + * @sensor_get_value: gets the current value of the sensor + * @device_get_power_state: gets the power state of a power domain + * @device_set_power_state: sets the power state of a power domain */ struct scpi_ops { u32 (*get_version)(void); |