diff options
Diffstat (limited to 'macros/Hardware/AVR/AVRTimerSetup.sci')
| -rw-r--r-- | macros/Hardware/AVR/AVRTimerSetup.sci | 45 |
1 files changed, 26 insertions, 19 deletions
diff --git a/macros/Hardware/AVR/AVRTimerSetup.sci b/macros/Hardware/AVR/AVRTimerSetup.sci index 7c5dd1d..55fd55f 100644 --- a/macros/Hardware/AVR/AVRTimerSetup.sci +++ b/macros/Hardware/AVR/AVRTimerSetup.sci @@ -10,37 +10,44 @@ function AVRTimerSetup(timer,prescaler,clock_source) //Function to setup Timers in ATmega16 +// +//Parameters: +// timer : integer, from 0 to 2 +// prescaler : integer. +// clock_source : integer, 0 (for internal) or 1 (for external) +// //Descrpition: // This function tells the micro controller which clock source you will be using. // The timer value and prescaler value passed in this function setup the timer as per // your requirement. // -//Parameters: -// timer : It is an integer value. -// 0 to setup timer0 -// 1 to setup timer1 -// 2 to setup timer2 -// prescaler : It is an integer value. -// 1 for no prescaling i.e clock will run at max 16Hz frequency -// 8 for prescaling clock by 8 i.e new clock frequency will be (clk/8) -// 64 for prescaling clock by 64 i.e new clock frequency will be (clk/64) -// 256 for prescaling clock by 256 i.e new clock frequency will be (clk/256) -// 1024 for prescaling clock by 1024 i.e new clock frequency will be (clk/1024) -// clock_source : It is an integer value. -// 0 if you are using internal clock source -// 1 if you are using external clock source +// timer can take values- +// <itemizedlist> +// <listitem><para>0 -> for timer0</para></listitem> +// <listitem><para>1 -> for timer1</para></listitem> +// <listitem><para>2 -> for timer2</para></listitem> +// </itemizedlist> +// +// prescaler can take values- +// <itemizedlist> +// <listitem><para>1 for no prescaling i.e clock will run at max 16Hz frequency</para></listitem> +// <listitem><para>8 for prescaling clock by 8 i.e new clock frequency will be (clk/8)</para></listitem> +// <listitem><para>64 for prescaling clock by 64 i.e new clock frequency will be (clk/64)</para></listitem> +// <listitem><para>256 for prescaling clock by 256 i.e new clock frequency will be (clk/256)</para></listitem> +// <listitem><para>1024 for prescaling clock by 1024 i.e new clock frequency will be (clk/1024)</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 -// AVRTimerSetup(0,64,0); //This function will select timer0 with timer running as per -// internal clock source and prescaled by 64. -// +// AVRTimerSetup(0,64,0); //This function will select timer0 with timer running as per internal clock source and prescaled by 64. //See also // AVRGetTimerValues // //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(timer>=3) then disp("Error : Invalid input argument ''timer'' in AVRTimerSetup function."); |