Remove test function and move it in separate file. Reformat.
[bertos.git] / bertos / drv / pwm.h
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  * \version $Id$
33  *
34  * \brief PWM driver (interface)
35  *
36  * \version $Id$
37  * \author Francesco Sacchi <batt@develer.com>
38  * \author Daniele Basile <asterix@develer.com>
39  */
40
41 #ifndef DRV_PWM_H
42 #define DRV_PWM_H
43
44 #include <pwm_map.h>
45 #include <cfg/compiler.h>
46
47 #define PWM_MAX_DUTY              ((pwm_duty_t)0xFFFF)
48 #define PWM_MAX_PERIOD            0xFFFF
49 #define PWM_MAX_PERIOD_LOG2           16
50
51 typedef uint16_t pwm_duty_t;
52 typedef uint32_t pwm_freq_t;
53
54 void pwm_setDuty(PwmDev dev, pwm_duty_t duty);
55 void pwm_setFrequency(PwmDev dev, pwm_freq_t freq);
56 void pwm_enable(PwmDev dev, bool state);
57 void pwm_init(void);
58
59 void pwm_test(void);
60
61 #endif /* DRV_PWM_H */