Generalize pwm test for all target.
[bertos.git] / bertos / drv / pwm_test.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
30  * -->
31  *
32  *
33  * \brief Test for PWM driver (implementation)
34  *
35  * This is a simple test for PWM driver. This module
36  * is target independent, so you can test all target that
37  * BeRTOS support.
38  * To use this test you should include a pwm_map.h header where
39  * are defined the PWM channels for your target. Then you should add
40  * or remove a test setting in pwm_test_cfg array, and edit a value for
41  * your specific test.
42  * Afther this, all is ready and you can test PWM driver.
43  *
44  * The test check first if all PWM channel starts, and then try
45  * to change a PWM duty cicle for all channel.
46  * The change of duty cycle is operate when a PWM channel is enable,
47  * in this way you can see if a pwm signal is clean and work properly.
48  * The duty value is change incrementaly, and when it arrive to 100% or 0%,
49  * we reset the duty value and restart the test.
50  * Further the duty test, we check also a PWM polarity, infact when we
51  * reach a reset duty value, we invert a polary of PWM wavform.
52  * So you can see if the hardware manage correctly this situation.
53  *
54  * Note: To be simple and target independently we not use a timer module,
55  * and so the delay is do with a for cicle.
56  *
57  * \version $Id$
58  *
59  * \author Daniele Basile <asterix@develer.com>
60  */
61
62 #include "hw/pwm_map.h" // For PwmDev and channel avaible on thi target
63
64 #include <cfg/macros.h>
65 #include <cfg/debug.h>
66
67 #include <cpu/types.h>
68 #include <cpu/irq.h>
69
70 #include <drv/pwm.h>
71 #include CPU_HEADER(pwm)
72
73 #define DELAY_TIME   10000  // This is a number of for cycle before to set a new value of duty
74 #define PWM_DUTY_INC   200  // Incremental value for duty
75
76
77 /**
78  * Simple struct to store
79  * the testing value.
80  */
81 typedef struct PwmTest
82 {
83         int ch;
84         bool pol;
85         pwm_freq_t freq;
86         pwm_duty_t duty;
87 } PwmTest;
88
89 /*
90  * Test settings for each channel.
91  *
92  * Frequency value is in Hz.
93  *
94  * Esample of value for duty cycle"
95  *
96  * - 100% => 0xFFFFFFFF
97  * - 80%  => 0xCCCCCCCC
98  * - 75%  => 0xBFFFFFFF
99  * - 50%  => 0x7FFFFFFF
100  * - 25%  => 0x3FFFFFFF
101  * - 33%  => 0x55555555
102  * - 16%  => 0x2AAAAAAA
103  */
104 static PwmTest pwm_test_cfg[PWM_CNT] =
105 {
106         /* Channel, polarity, frequecy,   duty */
107         {        0,    false,    100UL,      0 }, /*     100Hz,  0% duty */
108         {        1,    false,   1000UL, 0x7FFF }, /*      1KHz, 50% duty */
109         {        2,    false,  12356UL, 0x5555 }, /* 12,356KHz, 33% duty */
110         {        3,    false, 100000UL, 0xCCCC }  /*    100KHz, 80% duty */
111 };
112
113 /**
114  * Setup all needed to test PWM on AT91
115  *
116  */
117 int pwm_testSetup(void)
118 {
119         kputs("Init pwm..");
120         pwm_init();
121         kputs("done.\n");
122
123         return 0;
124 }
125
126
127 /**
128  * Test suit for genation of pwm waveform.
129  *
130  */
131 int pwm_testRun(void)
132 {
133         int duty = 0;
134         int delay = 0;
135
136         pwm_testSetup();
137
138         kputs("\n\n===== BeRTOS PWM test =====\n\n");
139
140         for (int i = 0; i < PWM_CNT; i++)
141         {
142                 kprintf("PWM test ch[%d]\n", pwm_test_cfg[i].ch);
143
144                 kprintf("--> set pol[%d]", pwm_test_cfg[i].pol);
145                 kputs(" (Note: if polarity is false the output waveform start at high level,\n see low level implentation for detail)");
146                 pwm_setPolarity(pwm_test_cfg[i].ch, pwm_test_cfg[i].pol);
147                 kputs("..ok\n");
148
149                 kprintf("--> set freq[%ld]", pwm_test_cfg[i].freq);
150                 pwm_setFrequency(pwm_test_cfg[i].ch, pwm_test_cfg[i].freq);
151                 kputs("..ok\n");
152
153                 kprintf("--> set duty[%d]", pwm_test_cfg[i].duty);
154                 pwm_setDuty(pwm_test_cfg[i].ch, pwm_test_cfg[i].duty);
155                 kputs("..ok\n");
156
157                 kputs("--> Enable pwm");
158                 pwm_enable(pwm_test_cfg[i].ch, true);
159                 kputs("..ok\n");
160         }
161
162         kputs("\n-------------------------- Dinamic PWM test --------------------------\n");
163         kputs("We test if driver change correctly the duty cycle durind it working.\n");
164         kputs("On your oscilloscope you should see the pwm singal that increase until\n");
165         kputs("the duty value is 100%. After this value we invert a polarity of pwm,\n");
166         kputs("and repeat the test. But now you should see that pwm duty decreasing until\n");
167         kputs("0% duty value.\nAfter that, we repeat the test from beginning.\n\n");
168
169         for (;;)
170         {
171                 if (delay == DELAY_TIME)
172                 {
173                         for (int i = 0; i < PWM_CNT; i++)
174                         {
175                                 kprintf("PWM test ch[%d]\n", pwm_test_cfg[i].ch);
176                                 kprintf("--> set duty[%d]", duty);
177                                 pwm_setDuty(pwm_test_cfg[i].ch, duty);
178                                 kputs("..ok\n");
179                         }
180                         kputs("\n++++++++++++++++++++\n");
181                         duty += PWM_DUTY_INC;
182                         delay = 0;
183                 }
184
185                 //Reset duty cycle overflow
186                 if (duty >= 0xFFFF)
187                 {
188                         duty = 0;
189                         for (int i = 0; i < PWM_CNT; i++)
190                         {
191                                 kputs("Duty reset, swap polarity:\n");
192                                 kprintf("--> pol from [%d] to [%d]", pwm_test_cfg[i].pol, !pwm_test_cfg[i].pol);
193
194                                 pwm_test_cfg[i].pol = !pwm_test_cfg[i].pol;
195                                 pwm_setPolarity(pwm_test_cfg[i].ch, pwm_test_cfg[i].pol);
196
197                                 kputs("..ok\n");
198                         }
199                         kputs("\n++++++++++++++++++++\n");
200                 }
201                 delay++;
202         }
203
204         return 0;
205 }
206
207 /**
208  * End a PWM Test.
209  * (Unused)
210  */
211 int pwm_testTearDown(void)
212 {
213         /*    */
214         return 0;
215 }
216
217 /*
218  * Empty main.
219  *
220  * Look it as exmple or use it if
221  * you want test a PWM driver stand alone.
222  */
223  #if 0
224 int main(void)
225 {
226         IRQ_ENABLE;
227         kdbg_init();
228
229         pwm_testRun();
230
231         for(;;)
232         {
233         }
234
235 }
236 #endif
237
238