Fix the bug related to the empty version list
[bertos.git] / bertos / drv / pwm_hwtest.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 cycle.
56  *
57  * \version $Id$
58  * \author Daniele Basile <asterix@develer.com>
59  */
60
61 #include "hw/pwm_map.h" // For PwmDev and channel avaible on thi target
62 #include "cfg/cfg_pwm.h"
63 #include <cfg/macros.h>
64 #include <cfg/debug.h>
65
66 // Define logging setting (for cfg/log.h module).
67 #define LOG_LEVEL         PWM_LOG_LEVEL
68 #define LOG_FORMAT        PWM_LOG_FORMAT
69 #include <cfg/log.h>   // for logging system
70
71 #include <cpu/types.h>
72 #include <cpu/irq.h>
73
74 #include <drv/pwm.h>
75 #include CPU_HEADER(pwm)
76
77 #define DELAY_TIME   10000  // This is a number of for cycle before to set a new value of duty
78 #define PWM_DUTY_INC   200  // Incremental value for duty
79
80
81 /**
82  * Simple struct to store
83  * the testing value.
84  */
85 typedef struct PwmTest
86 {
87         int ch;
88         bool pol;
89         pwm_freq_t freq;
90         pwm_duty_t duty;
91 } PwmTest;
92
93 /*
94  * Test settings for each channel.
95  *
96  * Frequency value is in Hz.
97  *
98  * Esample of value for duty cycle"
99  *
100  * - 100% => 0xFFFFFFFF
101  * - 80%  => 0xCCCCCCCC
102  * - 75%  => 0xBFFFFFFF
103  * - 50%  => 0x7FFFFFFF
104  * - 25%  => 0x3FFFFFFF
105  * - 33%  => 0x55555555
106  * - 16%  => 0x2AAAAAAA
107  */
108 static PwmTest pwm_test_cfg[PWM_CNT] =
109 {
110         /* Channel, polarity, frequecy,   duty */
111         {        0,    false,    100UL,      0 }, /*     100Hz,  0% duty */
112         {        1,    false,   1000UL, 0x7FFF }, /*      1KHz, 50% duty */
113         {        2,    false,  12356UL, 0x5555 }, /* 12,356KHz, 33% duty */
114         {        3,    false, 100000UL, 0xCCCC }  /*    100KHz, 80% duty */
115 };
116
117 /**
118  * Setup all needed to test PWM on AT91
119  *
120  */
121 int pwm_testSetup(void)
122 {
123         LOG_INFO("Init pwm..");
124         pwm_init();
125         LOG_INFO("done.\n");
126
127         return 0;
128 }
129
130
131 /**
132  * Test suit for genation of pwm waveform.
133  *
134  */
135 void NORETURN pwm_testRun(void)
136 {
137         pwm_duty_t duty = 0;
138         int delay = 0;
139
140         pwm_testSetup();
141
142         LOG_INFO("\n\n===== BeRTOS PWM test =====\n\n");
143
144         for (int i = 0; i < PWM_CNT; i++)
145         {
146                 LOG_INFO("PWM test ch[%d]\n", pwm_test_cfg[i].ch);
147                 LOG_INFO("--> set pol[%d]", pwm_test_cfg[i].pol);
148                 LOG_INFO("\n(Note: if polarity is false the output waveform start at high level,\n see low level implentation for detail)i\n");
149                 pwm_setPolarity(pwm_test_cfg[i].ch, pwm_test_cfg[i].pol);
150                 LOG_INFO("..ok\n");
151
152                 LOG_INFO("--> set freq[%ld]", pwm_test_cfg[i].freq);
153                 pwm_setFrequency(pwm_test_cfg[i].ch, pwm_test_cfg[i].freq);
154                 LOG_INFO("..ok\n");
155
156                 LOG_INFO("--> set duty[%d]", pwm_test_cfg[i].duty);
157                 pwm_setDuty(pwm_test_cfg[i].ch, pwm_test_cfg[i].duty);
158                 LOG_INFO("..ok\n");
159
160                 LOG_INFO("--> Enable pwm");
161                 pwm_enable(pwm_test_cfg[i].ch, true);
162                 LOG_INFO("..ok\n");
163         }
164
165         LOG_INFO("\n-------------------------- Dinamic PWM test --------------------------\n");
166         LOG_INFO("We test if driver change correctly the duty cycle durind it working.\n");
167         LOG_INFO("On your oscilloscope you should see the pwm singal that increase until\n");
168         LOG_INFO("the duty value is 100%%. After this value we invert a polarity of pwm,\n");
169         LOG_INFO("and repeat the test. But now you should see that pwm duty decreasing until\n");
170         LOG_INFO("0%% duty value.\nAfter that, we repeat the test from beginning.\n\n");
171
172         for (;;)
173         {
174                 if (delay == DELAY_TIME)
175                 {
176                         for (int i = 0; i < PWM_CNT; i++)
177                         {
178                                 LOG_INFO("PWM test ch[%d]\n", pwm_test_cfg[i].ch);
179                                 LOG_INFO("--> set duty[%d]", duty);
180                                 pwm_setDuty(pwm_test_cfg[i].ch, duty);
181                                 LOG_INFO("..ok\n");
182                         }
183                         LOG_INFO("\n++++++++++++++++++++\n");
184                         duty += PWM_DUTY_INC;
185                         delay = 0;
186                 }
187
188                 //Reset duty cycle overflow
189                 if (duty >= (pwm_duty_t)0xFFFF)
190                 {
191                         duty = 0;
192                         for (int i = 0; i < PWM_CNT; i++)
193                         {
194                                 LOG_INFO("Duty reset, swap polarity:\n");
195                                 LOG_INFO("--> pol from [%d] to [%d]", pwm_test_cfg[i].pol, !pwm_test_cfg[i].pol);
196
197                                 pwm_test_cfg[i].pol = !pwm_test_cfg[i].pol;
198                                 pwm_setPolarity(pwm_test_cfg[i].ch, pwm_test_cfg[i].pol);
199
200                                 LOG_INFO("..ok\n");
201                         }
202                         LOG_INFO("\n++++++++++++++++++++\n");
203                 }
204                 delay++;
205         }
206 }
207
208 /**
209  * End a PWM Test.
210  * (Unused)
211  */
212 int pwm_testTearDown(void)
213 {
214         /*    */
215         return 0;
216 }
217
218 /*
219  * Empty main.
220  *
221  * Look it as exmple or use it if
222  * you want test a PWM driver stand alone.
223  */
224 #if 0
225 int main(void)
226 {
227         IRQ_ENABLE;
228         kdbg_init();
229
230         pwm_testRun();
231
232         for(;;)
233         {
234         }
235
236 }
237 #endif
238
239