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>
This commit is contained in:
Eduardo Valentin 2013-03-15 09:00:38 -04:00 committed by Greg Kroah-Hartman
parent ff4a44ce32
commit e72b7bbd17
1 changed files with 8 additions and 0 deletions

View File

@ -437,6 +437,14 @@ exit:
return err; 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) static inline int omap_bandgap_validate(struct omap_bandgap *bg_ptr, int id)
{ {
int ret = 0; int ret = 0;