From: Eduardo Valentin <eduardo.valentin@ti.com>
Date: Fri, 15 Mar 2013 13:00:29 +0000 (-0400)
Subject: staging: omap-thermal: document _omap_bandgap_read_threshold function
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=7a681a50ed97c7db60fdde608d885533b9f98acb;p=deliverable%2Flinux.git

staging: omap-thermal: document _omap_bandgap_read_threshold function

Add documentation of the function for reading alert thresholds

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---

diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 4cacfc1c546b..aa90539f20ca 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -510,6 +510,18 @@ exit:
 	return ret;
 }
 
+/**
+ * _omap_bandgap_read_threshold() - helper to read TALERT t_cold or t_hot
+ * @bg_ptr: struct omap_bandgap pointer
+ * @id: bandgap sensor id
+ * @val: value (mCelsius) of a threshold
+ * @hot: desired threshold to be read. true if threshold hot, false if
+ *       threshold cold
+ *
+ * It will fetch the required thresholds (hot and cold) for TALERT signal.
+ * This function can be used to read t_hot or t_cold, depending on @hot value.
+ * Call this function only if bandgap features HAS(TALERT).
+ */
 int _omap_bandgap_read_threshold(struct omap_bandgap *bg_ptr, int id,
 				 int *val, bool hot)
 {