diff options
| author |   Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 09:00:38 -0400 |
|---|---|---|
| committer |   Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 09:02:25 -0700 |
| commit | e72b7bbd178bf0081b5f62f1daaf86a7daf13f3e (patch) | |
| tree | a539c2a85703626e6aaf38778c8a64aaa59b865c | |
| parent | staging: omap-thermal: remove TODO entry for exposed APIs (diff) | |
| download | linux-dev-e72b7bbd178bf0081b5f62f1daaf86a7daf13f3e.tar.xz linux-dev-e72b7bbd178bf0081b5f62f1daaf86a7daf13f3e.zip | |
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.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 846ced66d10c..33bfe3bbc367 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; |