Use int numbers; fix some min and max values.
[bertos.git] / bertos / cfg / cfg_adc.h
index 26254a41573899b5b6834a8829e81b8566172514..dd65e134e8f0ac3711f0bd8a929ee2b2c53089bc 100644 (file)
  * the GNU General Public License.
  *
  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
- * All Rights Reserved.
+ *
  * -->
  *
- * \brief Configuration file for ADC module.
+ * \brief Configuration file for the ADC module.
  *
  * \version $Id$
- *
  * \author Daniele Basile <asterix@develer.com>
  */
 
 #define CFG_ADC_H
 
 /**
- * Logging level definition.
+ * Module logging level.
+ *
+ * $WIZ$ type = "enum"
+ * $WIZ$ value_list = "log_level"
+ */
+#define ADC_LOG_LEVEL      LOG_LVL_INFO
+
+/**
+ * Module logging format.
+ *
+ * $WIZ$ type = "enum"
+ * $WIZ$ value_list = "log_format"
+ */
+#define ADC_LOG_FORMAT     LOG_FMT_VERBOSE
+
+/**
+ * Clock Frequency for ADC conversion.
  *
- * Use 0 to log only the error messages
- * Use 1 to log the error and warning messages
- * Use 2 to log all messages
+ * $WIZ$ type = "int"
+ * $WIZ$ supports = "at91"
  */
-#define ADC_LOG_LEVEL      2
+#define CONFIG_ADC_CLOCK        4800000UL
 
 /**
- * Set logging verbosity.
+ * Minimum time for starting up a conversion [us].
  *
- * If verbosity is zero print short log messages.
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 0
+ * $WIZ$ supports = "at91"
  */
-#define ADC_LOG_VERBOSITY    1
+#define CONFIG_ADC_STARTUP_TIME 20
 
+/**
+ * Minimum time for sample and hold [us].
+ *
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 0
+ * $WIZ$ supports = "at91"
+ */
+#define CONFIG_ADC_SHTIME       834
 
 /**
- * ADC timing setting parameter
+ * ADC Voltage Reference.
  *
- * - CONFIG_ADC_CLOCK is frequency clock for ADC conversion.
- * - CONFIG_ADC_STARTUP_TIME  minimum time for startup a conversion in micro second.
- * - CONFIG_ADC_SHTIME minimum time for sample and hold in nano second.
- * \{
+ * $WIZ$ type = "enum"
+ * $WIZ$ value_list = "avr_adc_refs"
+ * $WIZ$ supports = "avr"
  */
-#define CONFIG_ADC_CLOCK          4800000UL
-#define CONFIG_ADC_STARTUP_TIME        20
-#define CONFIG_ADC_SHTIME             834
-/* \ * } */
+#define CONFIG_ADC_AVR_REF      ADC_AVR_AVCC
 
-/// ADC setting for AVR target
-#define CONFIG_ADC_AVR_REF      1
+/**
+ * ADC clock divisor from main crystal.
+ *
+ * $WIZ$ type = "int"
+ * $WIZ$ min = 2
+ * $WIZ$ max = 128
+ * $WIZ$ supports = "avr"
+ */
 #define CONFIG_ADC_AVR_DIVISOR  2
 
-/// Enable ADS strobe.
+/**
+ * Enable ADC strobe for debugging ADC ISR.
+ *
+ * $WIZ$ type = "boolean"
+ */
 #define CONFIG_ADC_STROBE  0
 
 #endif /* CFG_ADC_H */
-