diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 08:59:59 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 09:02:09 -0700 |
| commit | 4a6554ed29906be67082e26ac99cbbca9d2f9060 (patch) | |
| tree | caf79220042e4ef9fb73fb5f88552df4cc511fe7 | |
| parent | 7a556e6a4a8333ea0ddf9cffc9ef42c9a912925d (diff) | |
staging: omap-thermal: add documentation for omap_bandgap_read_temp
Document function which reads temperature register, depending on
bandgap device version.
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 | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 62a5fb9623b2..02817b54b456 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -109,6 +109,16 @@ exit: return 0; } +/** + * omap_bandgap_read_temp() - helper function to read sensor temperature + * @bg_ptr: pointer to omap_bandgap structure + * @id: bandgap sensor id + * + * Function to concentrate the steps to read sensor temperature register. + * This function is desired because, depending on bandgap device version, + * it might be needed to freeze the bandgap state machine, before fetching + * the register value. + */ static u32 omap_bandgap_read_temp(struct omap_bandgap *bg_ptr, int id) { struct temp_sensor_registers *tsr; |