diff mbox series

[v5,7/8] drivers: thermal: tsens: kernel-doc fixup

Message ID 8990f5cd5ec2bc2aa0f13c0ad5cd41b8d1a5632e.1582048155.git.amit.kucheria@linaro.org (mailing list archive)
State Superseded
Headers show
Series thermal: tsens: Handle critical interrupts | expand

Commit Message

Amit Kucheria Feb. 18, 2020, 6:12 p.m. UTC 
Document ul_lock, threshold and control structure members and make
the following kernel-doc invocation happy:

$ scripts/kernel-doc -v -none drivers/thermal/qcom/*

drivers/thermal/qcom/qcom-spmi-temp-alarm.c:105: info: Scanning doc for qpnp_tm_get_temp_stage
drivers/thermal/qcom/tsens-common.c:18: info: Scanning doc for struct tsens_irq_data
drivers/thermal/qcom/tsens-common.c:130: info: Scanning doc for tsens_hw_to_mC
drivers/thermal/qcom/tsens-common.c:163: info: Scanning doc for tsens_mC_to_hw
drivers/thermal/qcom/tsens-common.c:245: info: Scanning doc for tsens_set_interrupt
drivers/thermal/qcom/tsens-common.c:268: info: Scanning doc for tsens_threshold_violated
drivers/thermal/qcom/tsens-common.c:362: info: Scanning doc for tsens_critical_irq_thread
drivers/thermal/qcom/tsens-common.c:438: info: Scanning doc for tsens_irq_thread
drivers/thermal/qcom/tsens.h:41: info: Scanning doc for struct tsens_sensor
drivers/thermal/qcom/tsens.h:59: info: Scanning doc for struct tsens_ops
drivers/thermal/qcom/tsens.h:494: info: Scanning doc for struct tsens_features
drivers/thermal/qcom/tsens.h:513: info: Scanning doc for struct tsens_plat_data
drivers/thermal/qcom/tsens.h:529: info: Scanning doc for struct tsens_context

Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
---
 drivers/thermal/qcom/tsens.h | 3 +++
 1 file changed, 3 insertions(+)

Comments

Stephen Boyd Feb. 19, 2020, 10:51 p.m. UTC | #1 
Quoting Amit Kucheria (2020-02-18 10:12:11)
> Document ul_lock, threshold and control structure members and make
> the following kernel-doc invocation happy:
> 
> $ scripts/kernel-doc -v -none drivers/thermal/qcom/*
> 
> drivers/thermal/qcom/qcom-spmi-temp-alarm.c:105: info: Scanning doc for qpnp_tm_get_temp_stage
> drivers/thermal/qcom/tsens-common.c:18: info: Scanning doc for struct tsens_irq_data
> drivers/thermal/qcom/tsens-common.c:130: info: Scanning doc for tsens_hw_to_mC
> drivers/thermal/qcom/tsens-common.c:163: info: Scanning doc for tsens_mC_to_hw
> drivers/thermal/qcom/tsens-common.c:245: info: Scanning doc for tsens_set_interrupt
> drivers/thermal/qcom/tsens-common.c:268: info: Scanning doc for tsens_threshold_violated
> drivers/thermal/qcom/tsens-common.c:362: info: Scanning doc for tsens_critical_irq_thread
> drivers/thermal/qcom/tsens-common.c:438: info: Scanning doc for tsens_irq_thread
> drivers/thermal/qcom/tsens.h:41: info: Scanning doc for struct tsens_sensor
> drivers/thermal/qcom/tsens.h:59: info: Scanning doc for struct tsens_ops
> drivers/thermal/qcom/tsens.h:494: info: Scanning doc for struct tsens_features
> drivers/thermal/qcom/tsens.h:513: info: Scanning doc for struct tsens_plat_data
> drivers/thermal/qcom/tsens.h:529: info: Scanning doc for struct tsens_context
> 
> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
> ---

Reviewed-by: Stephen Boyd <swboyd@chromium.org>
diff mbox series

Patch

diff --git a/drivers/thermal/qcom/tsens.h b/drivers/thermal/qcom/tsens.h
index ad7574fe0811..f49e516b3458 100644
--- a/drivers/thermal/qcom/tsens.h
+++ b/drivers/thermal/qcom/tsens.h
@@ -526,6 +526,8 @@  struct tsens_plat_data {
 
 /**
  * struct tsens_context - Registers to be saved/restored across a context loss
+ * @threshold: Threshold register value
+ * @control: Control register value
  */
 struct tsens_context {
 	int	threshold;
@@ -540,6 +542,7 @@  struct tsens_context {
  * @srot_map: pointer to SROT register address space
  * @tm_offset: deal with old device trees that don't address TM and SROT
  *             address space separately
+ * @ul_lock: lock while processing upper/lower threshold interrupts
  * @crit_lock: lock while processing critical threshold interrupts
  * @rf: array of regmap_fields used to store value of the field
  * @ctx: registers to be saved and restored during suspend/resume