Browse Source

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>
Eduardo Valentin 12 years ago
parent
commit
e72b7bbd17
1 changed files with 8 additions and 0 deletions
  1. 8 0
      drivers/staging/omap-thermal/omap-bandgap.c

+ 8 - 0
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;