summaryrefslogtreecommitdiff
path: root/2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci
diff options
context:
space:
mode:
Diffstat (limited to '2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci')
-rw-r--r--2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci57
1 files changed, 26 insertions, 31 deletions
diff --git a/2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci b/2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci
index c391f71e..39861c86 100644
--- a/2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci
+++ b/2.3-1/macros/Hardware/AVR/AVRPWM0Setup.sci
@@ -10,48 +10,43 @@
function AVRPWM0Setup(waveform_mode,output_mode)
//Function to Setup OC0 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
-//
//Description
// Every Micro controller has PWM pins which can generate varying voltages
// from 0V-5V.This function helps to use OC0 pin to produce 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 OC0 on compare match when up-counting. Set OC0 on compare match when down-counting.</para></listitem>
-// <listitem><para>1 for Set OC0 on compare match when up-counting. Clear OC0 on compare match when down-counting.</para></listitem>
-// For Fast PWM Mode:
-// <listitem><para>0 for non-inverted output i.e Clear OC0 on compare match, set OC0 at BOTTOM.</para></listitem>
-// <listitem><para>1 for inverted output i.e Set OC0 on compare match, clear OC0 at BOTTOM.</para></listitem>
-// For CTC Mode:
-// <listitem><para>0 to Clear OC0 on compare match</para></listitem>
-// <listitem><para>1 to Set OC0 on compare match</para></listitem>
-// <listitem><para>2 to toggle OC0 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.
-//
-//Examples
-// AVRPWM0Setup(2,0); //This function will select CTC waveform mode and will clear OC0 on compare match
+//Parameters
+// waveform_mode:
+// 0 for Phase correct PWM Mode
+// 1 for Fast PWM Mode
+// 2 for CTC Mode
+// output_mode:
+// For Phase Correct PWM Mode:
+// 0 for Clear OC0 on compare match when up-counting. Set OC0 on compare
+// match when down-counting.
+// 1 for Set OC0 on compare match when up-counting. Clear OC0 on compare
+// match when down-counting.
+//
+// For Fast PWM Mode:
+// 0 for non-inverted output i.e Clear OC0 on compare match, set OC0 at BOTTOM.
+// 1 for inverted output i.e Set OC0 on compare match, clear OC0 at BOTTOM.
+//
+// For CTC Mode:
+// 0 to Clear OC0 on compare match
+// 1 to Set OC0 on compare match
+// 2 to toggle OC0 on compare match
+//
+//Example
+// AVRPWM0Setup(2,0); //This function will select CTC waveform mode and will clear OC0 on
+// compare match
//See also
// AVRPWM0SetDuty
//
//Authors
// Ashish Kamble
//
+//This is curretly dummy function. It provides no functionality but is required
+//for providing support for generating C code for AVR.
if(waveform_mode>=3) then
disp("Error : Invalid input argument ''waveform_mode'' in AVRPWM0Setup function.");