From: Eduardo Valentin Date: Fri, 15 Mar 2013 13:00:38 +0000 (-0400) Subject: staging: omap-thermal: add documentation for omap_bandgap_validate X-Git-Tag: v3.10-rc1~192^2~595 X-Git-Url: https://openfabrics.org/gitweb/?a=commitdiff_plain;h=e72b7bbd178bf0081b5f62f1daaf86a7daf13f3e;p=~emulex%2Finfiniband.git 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 Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 846ced66d10..33bfe3bbc36 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;