aboutsummaryrefslogtreecommitdiffstats
path: root/src/gadc/sys_options.h
diff options
context:
space:
mode:
authorinmarket <andrewh@inmarket.com.au>2014-02-19 00:36:52 +1000
committerinmarket <andrewh@inmarket.com.au>2014-02-19 00:36:52 +1000
commit37966ff16d923bbca53c9464815cb49cbd7fc3be (patch)
treed92db57067ffadd50cadf3ccf70efba3ac16e114 /src/gadc/sys_options.h
parent1e131851d6732e22f055c893face6b473a26f111 (diff)
downloaduGFX-37966ff16d923bbca53c9464815cb49cbd7fc3be.tar.gz
uGFX-37966ff16d923bbca53c9464815cb49cbd7fc3be.tar.bz2
uGFX-37966ff16d923bbca53c9464815cb49cbd7fc3be.zip
Integrate the include files with each module. Simplifies structure of code.
Diffstat (limited to 'src/gadc/sys_options.h')
-rw-r--r--src/gadc/sys_options.h42
1 files changed, 42 insertions, 0 deletions
diff --git a/src/gadc/sys_options.h b/src/gadc/sys_options.h
new file mode 100644
index 00000000..d9519c39
--- /dev/null
+++ b/src/gadc/sys_options.h
@@ -0,0 +1,42 @@
+/*
+ * This file is subject to the terms of the GFX License. If a copy of
+ * the license was not distributed with this file, you can obtain one at:
+ *
+ * http://ugfx.org/license.html
+ */
+
+/**
+ * @file src/gadc/sys_options.h
+ * @brief GADC - Periodic ADC subsystem options header file.
+ *
+ * @addtogroup GADC
+ * @{
+ */
+
+#ifndef _GADC_OPTIONS_H
+#define _GADC_OPTIONS_H
+
+/**
+ * @name GADC Functionality to be included
+ * @{
+ */
+/**
+ * @}
+ *
+ * @name GADC Optional Sizing Parameters
+ * @{
+ */
+ /**
+ * @brief The maximum GADC sample rate
+ * @details Defaults to 44000
+ * @note This value must be less than half the maximum sample rate allowed by the CPU.
+ * This is to ensure there is time between high speed samples to perform low
+ * speed device sampling.
+ */
+ #ifndef GADC_MAX_HIGH_SPEED_SAMPLERATE
+ #define GADC_MAX_HIGH_SPEED_SAMPLERATE 44000
+ #endif
+/** @} */
+
+#endif /* _GADC_OPTIONS_H */
+/** @} */