[PATCH 50/50] staging: omap-thermal: add documentation for omap_bandgap_validate
Eduardo Valentin
eduardo.valentin at ti.com
Fri Mar 15 13:00:38 UTC 2013
Document the helper to validate a struct omap_bandgap and a sensor id.
Signed-off-by: Eduardo Valentin <eduardo.valentin at ti.com>
---
drivers/staging/omap-thermal/omap-bandgap.c | 8 ++++++++
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;
--
1.7.7.1.488.ge8e1c
More information about the devel
mailing list