Recreate 2.6 branch.
[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  *
33  * \brief Pulse Width Modulation (PWM) driver.
34  *
35  * \author Francesco Sacchi <batt@develer.com>
36  * \author Daniele Basile <asterix@develer.com>
37  *
38  * $WIZ$ module_name = "pwm"
39  * $WIZ$ module_configuration = "bertos/cfg/cfg_pwm.h"
40  * $WIZ$ module_hw = "bertos/hw/pwm_map.h"
41  * $WIZ$ module_supports = "not avr and not cm3"
42  */
43
44 #ifndef DRV_PWM_H
45 #define DRV_PWM_H
46
47 #include "hw/pwm_map.h"
48
49 #include <cpu/attr.h>
50
51 #include CPU_HEADER(pwm)
52
53 #include <cfg/compiler.h>
54
55 #define PWM_MAX_DUTY              ((pwm_duty_t)0xFFFF)
56 #define PWM_MAX_PERIOD                         0xFFFF
57 #define PWM_MAX_PERIOD_LOG2                        16
58
59 /**
60  * PWM type define.
61  */
62 typedef uint16_t pwm_duty_t;
63 typedef uint32_t pwm_freq_t;
64
65
66
67 /**
68  * Set PWM polarity of pwm \p dev.
69  */
70 INLINE void pwm_setPolarity(PwmDev dev, bool pol)
71 {
72     pwm_hw_setPolarity(dev, pol);
73 }
74
75 void pwm_setDuty(PwmDev dev, pwm_duty_t duty);
76 void pwm_setFrequency(PwmDev dev, pwm_freq_t freq);
77 void pwm_setPolarity(PwmDev dev, bool pol);
78 void pwm_enable(PwmDev dev, bool state);
79 void pwm_init(void);
80
81 /*
82  * Test function prototypes.
83  *
84  * See pwm_test.c for implemntation of these functions.
85  */
86 void pwm_testRun(void);
87 int pwm_testSetup(void);
88 /* For backward compatibility */
89 #define pwm_testSetUp() pwm_testSetup()
90 int pwm_testTearDown(void);
91
92 #endif /* DRV_PWM_H */