summaryrefslogtreecommitdiff
path: root/2.3-1/macros/Hardware/AVR/AVRADCSetup.sci
blob: 603873b32f6ab737364bf22c63ad9658788c96ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// Copyright (C) 2017 - IIT Bombay - FOSSEE
//
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
// Organization: FOSSEE, IIT Bombay
// Email: toolbox@scilab.in

function AVRADCSetup(prescaler,adc_ref)
// Function to initialise ADC of AVR
//
// Calling Sequence
//     AVRADCSetup(uint8 prescaler, uint8 adc_ref)
//
// Parameters
//     prescaler: prescaler to be used for generating ADC clock (0-7)
//     adc_ref	: reference voltage to be used for ADC conversion
//
// Description
//     This function initialises ADc of AVR with given parameters. 'prescaler' is needed for deciding ADC clock. ADC clock should be between 50KHz and 200KHz and it given as (MCU clock/2^prescaler). Select appropriate prescaler depending on MCU clock. 'adc_ref' selects one of the available reference voltage sources available.
//
//     The adc_ref can take the following values-
//     <itemizedlist>
//     <listitem><para>0   -> Voltage on VREF pin</para></listitem>
//     <listitem><para>1   -> Voltage on AVCC pin</para></listitem>
//     <listitem><para>2   -> Internal 2.56 reference voltage</para></listitem>
//     </itemizedlist>
//
//     This is curretly dummy function. It provides no functionality but is required for providing support for generating C code for AVR.
//
// Examples
//     AVRADCSetup(128,0)
// See also
//     AVRReadADC
//
// Authors
//     Siddhesh Wani 
//     Ashish Kamble
//

if(prescaler>=8)
disp("Error : Invalid input argument ''prescaler'' in AVRADCSetup function.");
end
if(adc_ref>=3) then 
disp("Error : Invalid input argument ''adc_ref'' in AVRADCSetup function.");
end
endfunction