summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEduardo Valentin <eduardo.valentin@ti.com>2013-03-15 13:00:38 (GMT)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2013-03-15 16:02:25 (GMT)
commite72b7bbd178bf0081b5f62f1daaf86a7daf13f3e (patch)
treea539c2a85703626e6aaf38778c8a64aaa59b865c
parentff4a44ce327567b83cae846c662c732758280bc6 (diff)
downloadlinux-fsl-qoriq-e72b7bbd178bf0081b5f62f1daaf86a7daf13f3e.tar.xz
staging: omap-thermal: add documentation for omap_bandgap_validate
Document the helper to validate a struct omap_bandgap and a sensor id. Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r--drivers/staging/omap-thermal/omap-bandgap.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 846ced6..33bfe3b 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -437,6 +437,14 @@ exit:
return err;
}
+/**
+ * omap_bandgap_validate() - helper to check the sanity of a struct omap_bandgap
+ * @bg_ptr: struct omap_bandgap pointer
+ * @id: bandgap sensor id
+ *
+ * Checks if the bandgap pointer is valid and if the sensor id is also
+ * applicable.
+ */
static inline int omap_bandgap_validate(struct omap_bandgap *bg_ptr, int id)
{
int ret = 0;