summaryrefslogtreecommitdiff
path: root/chip/stm32/adc_chip.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 /chip/stm32/adc_chip.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 'chip/stm32/adc_chip.h')
-rw-r--r--chip/stm32/adc_chip.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/chip/stm32/adc_chip.h b/chip/stm32/adc_chip.h
index 98141ea2d2..bc493ea75b 100644
--- a/chip/stm32/adc_chip.h
+++ b/chip/stm32/adc_chip.h
@@ -5,8 +5,8 @@
/* STM32-specific ADC module for Chrome EC */
-#ifndef __CROS_EC_STM32_ADC_H
-#define __CROS_EC_STM32_ADC_H
+#ifndef __CROS_EC_ADC_CHIP_H
+#define __CROS_EC_ADC_CHIP_H
/* Data structure to define ADC channels. */
struct adc_t {
@@ -17,6 +17,10 @@ struct adc_t {
int channel;
};
+/*
+ * Boards must provide this list of ADC channel definitions. This must match
+ * the enum adc_channel list provided by the board.
+ */
extern const struct adc_t adc_channels[];
/* Minimum and maximum values returned by adc_read_channel(). */
@@ -26,4 +30,4 @@ extern const struct adc_t adc_channels[];
/* Just plain id mapping for code readability */
#define STM32_AIN(x) (x)
-#endif /* __CROS_EC_STM32_ADC_H */
+#endif /* __CROS_EC_ADC_CHIP_H */