diff options
Diffstat (limited to '2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci')
| -rw-r--r-- | 2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci | 48 |
1 files changed, 27 insertions, 21 deletions
diff --git a/2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci b/2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci index d4bc74a6..11d9b019 100644 --- a/2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci +++ b/2.3-1/macros/Hardware/AVR/AVRPWM2Setup.sci @@ -10,32 +10,40 @@ function AVRPWM2Setup(waveform_mode,output_mode) //Function to Setup OC2 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 OC2 pin to produces required // output waveform by setting the waveform mode and otput mode. // -//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 OC2 on compare match when up-counting. Set OC2 on compare -// match when down-counting. -// 1 for Set OC2 on compare match when up-counting. Clear OC2 on compare -// match when down-counting. -// +// 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 OC2 on compare match when up-counting. Set OC2 on compare match when down-counting.</para></listitem> +// <listitem><para>1 for Set OC2 on compare match when up-counting. Clear OC2 on compare match when down-counting.</para></listitem> // For Fast PWM Mode: -// 0 for non-inverted output i.e Clear OC2 on compare match, set OC2 at BOTTOM. -// 1 for inverted output i.e Set OC2 on compare match, clear OC2 at BOTTOM. -// +// <listitem><para>0 for non-inverted output i.e Clear OC2 on compare match, set OC2 at BOTTOM.</para></listitem> +// <listitem><para>1 for inverted output i.e Set OC2 on compare match, clear OC2 at BOTTOM.</para></listitem> // For CTC Mode: -// 0 to Clear OC2 on compare match -// 1 to Set OC2 on compare match -// 2 to toggle OC2 on compare match -// +// <listitem><para>0 to Clear OC2 on compare match</para></listitem> +// <listitem><para>1 to Set OC2 on compare match</para></listitem> +// <listitem><para>2 to toggle OC2 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 // AVRPWM2Setup(2,0); //This function will select CTC waveform mode and will clear OC2 on // compare match @@ -45,8 +53,6 @@ function AVRPWM2Setup(waveform_mode,output_mode) //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 AVRPWM2Setup function."); |