summaryrefslogtreecommitdiff
path: root/macros/Hardware/AVR/AVRPWM1Setup.sci
blob: fbd96ce3efae8ad22ac5ca5c9781521fad8ab2e1 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// 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 AVRPWM1Setup(waveform_mode,output_mode,output_pin)
//Function to Setup OC1A or OC1B pin for required PWM mode
//
//Parameters
//	waveform_mode: integer, from 0 to 2
//      output_mode: integer, from 0 to 1 (or 2) depending on the waveform_mode
//      output_pin: 0 (for OC1A) or 1 for (OC1B)
//
//Description
//	Every Micro controller has PWM pins which can generate varying voltages
//	from 0V-5V.This function helps to use OC1A or OC1B pin to produces required 
//	output waveform by setting the waveform mode and otput mode.
//
//	waveform_mode can take values-
//	<itemizedlist>
//      <listitem><para>0   -> for Phase correct PWM Mode</para></listitem>
//      <listitem><para>1   -> for Fast PWM Mode</para></listitem>
//      <listitem><para>2   -> for CTC Mode</para></listitem>
//      </itemizedlist>
//
//	output_mode can take values-
//      <itemizedlist>
//      For Phase correct PWM Mode:
//	<listitem><para>0 for Clear OC1A or OC1B on compare match when up-counting. Set OC1A or OC1B on compare match when down-counting.</para></listitem>
//	<listitem><para>1 for Set OC1A or OC1B on compare match when up-counting. Clear OC1A or OC1B on compare match when down-counting.</para></listitem>
//      For Fast PWM Mode:
//	<listitem><para>0 for non-inverted output i.e Clear OC1A or OC1B on compare match, set OC1A or OC1B at BOTTOM.</para></listitem>
//	<listitem><para>1 for inverted output i.e Set OC1A or OC1B on compare match, clear OC1A or OC1B at BOTTOM.</para></listitem>
//      For CTC Mode:
//	<listitem><para>0 to Clear OC1A or OC1B on compare match</para></listitem>
//	<listitem><para>1 to Set OC1A or OC1B on compare match</para></listitem>
//	<listitem><para>2 to toggle OC1A or OC1B on compare match</para></listitem>
//      </itemizedlist>
//
// This is curretly dummy function. It provides no functionality but is required 
// for providing support for generating C code for AVR.
//
//Example
//    AVRPWM1Setup(2,0,0);  //This function will select CTC mode and will clear OC1A or OC1B 
//                            on compare match.Also as defined the output will be produced at 
//                            0C1A pin.
//See also
//     AVRPWM1SetDuty
//
//Authors
//     Ashish Kamble
//

if(waveform_mode>=3) then 
disp("Error : Invalid input argument ''waveform_mode'' in AVRPWM1Setup function.");
end
if(waveform_mode==0|waveform_mode==1) then
{
 //if((type(output_mode)~=8)|(output_mode>=2)) then
 //disp("Error : Invalid input argument ''output_mode'' in AVRPWM1Setup function.");
 //end 
}
end
if(waveform_mode==2) then
{
 if((type(output_mode)~=8)|(output_mode>=3)) then
 disp("Error : Invalid input argument ''output_mode'' in AVRPWM1Setup function.");
 end
}
end
if(output_pin>=2) then 
disp("Error : Invalid input argument ''output_pin'' in AVRPWM1Setup function.");
end
endfunction