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