[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <1363352438-15935-24-git-send-email-eduardo.valentin@ti.com>
Date: Fri, 15 Mar 2013 09:00:11 -0400
From: Eduardo Valentin <eduardo.valentin@...com>
To: <gregkh@...uxfoundation.org>
CC: <devel@...verdev.osuosl.org>, <linux-omap@...r.kernel.org>,
<linux-kernel@...r.kernel.org>, <linux-pm@...r.kernel.org>,
Eduardo Valentin <eduardo.valentin@...com>
Subject: [PATCH 23/50] staging: omap-thermal: add documentation for omap_bandgap_adc_to_mcelsius
Document the conversion function.
Signed-off-by: Eduardo Valentin <eduardo.valentin@...com>
---
drivers/staging/omap-thermal/omap-bandgap.c | 11 +++++++++++
1 files changed, 11 insertions(+), 0 deletions(-)
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 0068c66..8279cca 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -233,6 +233,17 @@ static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data)
/*** Helper functions which manipulate conversion ADC <-> mi Celsius ***/
+/**
+ * omap_bandgap_adc_to_mcelsius() - converts an ADC value to mCelsius scale
+ * @bg_ptr: struct omap_bandgap pointer
+ * @id: sensor id
+ * @adc_val: value in ADC representation
+ * @t: address where to write the resulting temperature in mCelsius
+ *
+ * Simple conversion from ADC representation to mCelsius. In case the ADC value
+ * is out of the ADC conv table range, it returns -ERANGE, 0 on success.
+ * The conversion table is indexed by the ADC values.
+ */
static
int omap_bandgap_adc_to_mcelsius(struct omap_bandgap *bg_ptr, int id,
int adc_val, int *t)
--
1.7.7.1.488.ge8e1c
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists