From: Eduardo Valentin Date: Fri, 15 Mar 2013 12:59:59 +0000 (-0400) Subject: staging: omap-thermal: add documentation for omap_bandgap_read_temp X-Git-Tag: firefly_0821_release~3680^2~674^2~634 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=4a6554ed29906be67082e26ac99cbbca9d2f9060;p=firefly-linux-kernel-4.4.55.git 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 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 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;