Remove \version svn tag.
[bertos.git] / bertos / cpu / avr / drv / pwm_avr.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 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief Low-level PWM module for AVR (interface).
34  *
35  *
36  * \author Daniele Basile <asterix@develer.com>
37  *
38  */
39
40 #ifndef DRV_PWM_AVR_H
41 #define DRV_PWM_AVR_H
42
43 #include "hw/pwm_map.h"
44
45 #include <cpu/types.h>
46
47 #define PWM_HW_MAX_PRESCALER_STEP         10
48 #define PWM_HW_MAX_PERIOD             0xFFFF
49
50 /**
51  * Type definition for pwm period.
52  */
53 typedef uint16_t pwm_period_t;
54
55 /**
56  * Structur definition for pwm driver.
57  */
58 typedef struct PwmChannel
59 {
60         /*  */
61 } PwmChannel;
62
63
64 void pwm_hw_init(void);
65 void pwm_hw_setFrequency(PwmDev dev, uint32_t freq);
66 void pwm_hw_setDutyUnlock(PwmDev dev, uint16_t duty);
67 void pwm_hw_disable(PwmDev dev);
68 void pwm_hw_enable(PwmDev dev);
69 void pwm_hw_setPolarity(PwmDev dev, bool pol);
70 pwm_period_t pwm_hw_getPeriod(PwmDev dev);
71
72 #endif /* DRV_ADC_AT91_H */