summaryrefslogtreecommitdiff
path: root/macros/Hardware/AVR/AVRADCSetup.sci
diff options
context:
space:
mode:
Diffstat (limited to 'macros/Hardware/AVR/AVRADCSetup.sci')
-rw-r--r--macros/Hardware/AVR/AVRADCSetup.sci32
1 files changed, 32 insertions, 0 deletions
diff --git a/macros/Hardware/AVR/AVRADCSetup.sci b/macros/Hardware/AVR/AVRADCSetup.sci
new file mode 100644
index 0000000..d9897fc
--- /dev/null
+++ b/macros/Hardware/AVR/AVRADCSetup.sci
@@ -0,0 +1,32 @@
+function AVRADCSetup(prescalar,adc_ref)
+// Function to initialise ADC of AVR
+//
+// Calling Sequence
+// AVRSetupADC(uint8 prescalar, uint8 adc_ref)
+//
+// Parameters
+// prescalar: prescalar to be used for generating ADC clock (0-7)
+// adc_ref : reference voltage to be used for ADC conversion
+// 0 -> Voltage on VREF pin
+// 1 -> Voltage on AVCC pin
+// 2 -> Internal 2.56 reference voltage
+//
+// Description
+// This function initialises ADc of AVR with given parameters. 'prescalar' is
+// needed for deciding ADC clock. ADC clock should be between 50KHz and 200KHz
+// and it given as (MCU clock/2^prescalar). Select appropriate prescalar depending
+// on MCU clock. 'adc_ref' selects one of the available reference voltage sources
+// available
+// Examples
+// AVRADCSetup(128,0)
+
+// See also
+// AVRReadADC
+//
+// Authors
+// Siddhesh Wani
+//
+
+// This is curretly dummy function. It provides no functionality but is required
+// for providing support for generating C code for AVR.
+endfunction