Reorder includes.
[bertos.git] / bertos / cpu / arm / drv / pwm_at91.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 2008 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  *
34  * \brief PWM hardware-specific definition
35  *
36  * \version $Id$
37  *
38  * \author Daniele Basile <asterix@develer.com>
39  */
40
41 #ifndef DRV_PWM_AT91_H
42 #define DRV_PWM_AT91_H
43
44 #include "hw/pwm_map.h"
45
46 #include <cfg/compiler.h>
47 #include <cfg/macros.h>
48
49 #include <io/arm.h>
50
51
52 #define PWM_HW_MAX_PRESCALER_STEP         10
53 #define PWM_HW_MAX_PERIOD             0xFFFF
54
55 /**
56  * Type definition for pwm period.
57  */
58 typedef uint16_t pwm_period_t;
59
60 /**
61  * Structur definition for pwm driver.
62  */
63 typedef struct PwmChannel
64 {
65         bool duty_zero;         ///< True if duty cyle is zero, false otherwise.
66         bool pol;               ///< PWM polarty flag.
67         int pwm_pin;            ///< PWM pin.
68         reg32_t *mode_reg;      ///< PWM mode register.
69         reg32_t *duty_reg;      ///< PWM duty cycle register.
70         reg32_t *period_reg;    ///< PWM periodic register.
71         reg32_t *update_reg;    ///< Update setting register for PWM.
72
73 } PwmChannel;
74
75
76 void pwm_hw_init(void);
77 void pwm_hw_setFrequency(PwmDev dev, uint32_t freq);
78 void pwm_hw_setDutyUnlock(PwmDev dev, uint16_t duty);
79 void pwm_hw_disable(PwmDev dev);
80 void pwm_hw_enable(PwmDev dev);
81 void pwm_hw_setPolarity(PwmDev dev, bool pol);
82 pwm_period_t pwm_hw_getPeriod(PwmDev dev);
83
84 #endif /* DRV_ADC_AT91_H */