]> git.karo-electronics.de Git - linux-beck.git/commitdiff
staging: omap-thermal: document _omap_bandgap_read_threshold function
authorEduardo Valentin <eduardo.valentin@ti.com>
Fri, 15 Mar 2013 13:00:29 +0000 (09:00 -0400)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 15 Mar 2013 16:02:24 +0000 (09:02 -0700)
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>
drivers/staging/omap-thermal/omap-bandgap.c

index 4cacfc1c546b41f1264131c11b30dbafbc0ebc70..aa90539f20ca906a3045d9cf05959ae80e416155 100644 (file)
@@ -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)
 {