summaryrefslogtreecommitdiff
path: root/include/adc.h
diff options
context:
space:
mode:
authorRandall Spangler <rspangler@chromium.org>2013-10-24 09:46:34 -0700
committerchrome-internal-fetch <chrome-internal-fetch@google.com>2013-10-25 20:12:54 +0000
commit685c45ef46efe4a3e0b099ce43dddc65bbe2f672 (patch)
tree73b1649af54099f62706ee94789ac8f2e0ac6d0a /include/adc.h
parent17ea6d50f04dc3e287ab8a160d5db505377d57d5 (diff)
downloadchrome-ec-685c45ef46efe4a3e0b099ce43dddc65bbe2f672.tar.gz
cleanup: comments in adc modules
No code changes, other than renaming a couple of static functions. BUG=none BRANCH=none TEST=build falco Change-Id: I29b835d273aa1aba66d9d40536eae2eb12207f66 Signed-off-by: Randall Spangler <rspangler@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/174530
Diffstat (limited to 'include/adc.h')
-rw-r--r--include/adc.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/include/adc.h b/include/adc.h
index 8c5dda02d5..3ff88b77f9 100644
--- a/include/adc.h
+++ b/include/adc.h
@@ -10,7 +10,13 @@
#include "common.h"
-#define ADC_READ_ERROR -1
+#define ADC_READ_ERROR -1 /* Value returned by adc_read_channel() on error */
+
+/*
+ * Boards which use the ADC interface must provide enum adc_channel in the
+ * board.h file. See chip/$CHIP/adc_chip.h for additional chip-specific
+ * requirements.
+ */
/**
* Read an ADC channel.