linux-kernel - [PATCH] thermal/ti-soc-thermal: fix spelling and kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [day] [month] [year] [list]
Message-ID: <20240111050205.2941-1-rdunlap@infradead.org>
Date: Wed, 10 Jan 2024 21:02:05 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Eduardo Valentin <edubezval@...il.com>,
	Keerthy <j-keerthy@...com>,
	linux-omap@...r.kernel.org,
	"Rafael J . Wysocki" <rafael@...nel.org>,
	Daniel Lezcano <daniel.lezcano@...aro.org>,
	linux-pm@...r.kernel.org
Subject: [PATCH] thermal/ti-soc-thermal: fix spelling and kernel-doc

Fix spelling mistakes as reported by codespell.
Fix all kernel-doc warnings.

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Eduardo Valentin <edubezval@...il.com>
Cc: Keerthy <j-keerthy@...com>
Cc: linux-omap@...r.kernel.org
Cc: Rafael J. Wysocki <rafael@...nel.org>
Cc: Daniel Lezcano <daniel.lezcano@...aro.org>
Cc: linux-pm@...r.kernel.org
---
 drivers/thermal/ti-soc-thermal/ti-bandgap.c |   14 +++++++-------
 drivers/thermal/ti-soc-thermal/ti-bandgap.h |    6 ++++--
 2 files changed, 11 insertions(+), 9 deletions(-)

diff -- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
--- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c
+++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
@@ -332,7 +332,7 @@ static inline int ti_bandgap_validate(st
  * ti_bandgap_read_counter() - read the sensor counter
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: resulting update interval in miliseconds
+ * @interval: resulting update interval in milliseconds
  */
 static void ti_bandgap_read_counter(struct ti_bandgap *bgp, int id,
 				    int *interval)
@@ -352,7 +352,7 @@ static void ti_bandgap_read_counter(stru
  * ti_bandgap_read_counter_delay() - read the sensor counter delay
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: resulting update interval in miliseconds
+ * @interval: resulting update interval in milliseconds
  */
 static void ti_bandgap_read_counter_delay(struct ti_bandgap *bgp, int id,
 					  int *interval)
@@ -394,7 +394,7 @@ static void ti_bandgap_read_counter_dela
  * ti_bandgap_read_update_interval() - read the sensor update interval
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: resulting update interval in miliseconds
+ * @interval: resulting update interval in milliseconds
  *
  * Return: 0 on success or the proper error code
  */
@@ -427,7 +427,7 @@ exit:
  * ti_bandgap_write_counter_delay() - set the counter_delay
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: desired update interval in miliseconds
+ * @interval: desired update interval in milliseconds
  *
  * Return: 0 on success or the proper error code
  */
@@ -471,7 +471,7 @@ static int ti_bandgap_write_counter_dela
  * ti_bandgap_write_counter() - set the bandgap sensor counter
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: desired update interval in miliseconds
+ * @interval: desired update interval in milliseconds
  */
 static void ti_bandgap_write_counter(struct ti_bandgap *bgp, int id,
 				     u32 interval)
@@ -486,7 +486,7 @@ static void ti_bandgap_write_counter(str
  * ti_bandgap_write_update_interval() - set the update interval
  * @bgp: pointer to bandgap instance
  * @id: sensor id
- * @interval: desired update interval in miliseconds
+ * @interval: desired update interval in milliseconds
  *
  * Return: 0 on success or the proper error code
  */
@@ -871,7 +871,7 @@ static struct ti_bandgap *ti_bandgap_bui
 }
 
 /*
- * List of SoCs on which the CPU PM notifier can cause erros on the DTEMP
+ * List of SoCs on which the CPU PM notifier can cause errors on the DTEMP
  * readout.
  * Enabled notifier on these machines results in erroneous, random values which
  * could trigger unexpected thermal shutdown.
diff -- a/drivers/thermal/ti-soc-thermal/ti-bandgap.h b/drivers/thermal/ti-soc-thermal/ti-bandgap.h
--- a/drivers/thermal/ti-soc-thermal/ti-bandgap.h
+++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.h
@@ -189,8 +189,10 @@ struct temp_sensor_regval {
  * @div_clk: pointer to divider clock of temperature sensor fclk
  * @lock: spinlock for ti_bandgap structure
  * @irq: MPU IRQ number for thermal alert
- * @tshut_gpio: GPIO where Tshut signal is routed
+ * @tshut_gpiod: GPIO where Tshut signal is routed
  * @clk_rate: Holds current clock rate
+ * @nb: notifier block
+ * @is_suspended: set if the bandgap device is suspended
  *
  * The bandgap device structure representing the bandgap device instance.
  * It holds most of the dynamic stuff. Configurations and sensor specific
@@ -276,7 +278,7 @@ struct ti_temp_sensor {
  * TI_BANDGAP_FEATURE_HISTORY_BUFFER - used when the bandgap device features
  *	a history buffer of temperatures.
  *
- * TI_BANDGAP_FEATURE_ERRATA_814 - used to workaorund when the bandgap device
+ * TI_BANDGAP_FEATURE_ERRATA_814 - used to workaround when the bandgap device
  *	has Errata 814
  * TI_BANDGAP_FEATURE_UNRELIABLE - used when the sensor readings are too
  *	inaccurate.