Refactor pwm driver; add documentation.
[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  *
37  * \author Daniele Basile <asterix@develer.com>
38  */
39
40 #ifndef DRV_PWM_AT91_H
41 #define DRV_PWM_AT91_H
42
43 #include <cfg/compiler.h>
44 #include <cfg/macros.h>
45
46 #include "cfg/cfg_pwm.h"
47
48 #include <io/arm.h>
49
50 #if CFG_PWM_ENABLE_OLD_API
51
52         #include "hw/pwm_map.h"
53
54         /**
55          * Type definition for pwm period.
56          */
57         typedef uint16_t pwm_period_t;
58
59         /**
60          * Structur definition for pwm driver.
61          */
62         typedef struct PwmChannel
63         {
64                 bool duty_zero;         ///< True if duty cyle is zero, false otherwise.
65                 bool pol;               ///< PWM polarty flag.
66                 int pwm_pin;            ///< PWM pin.
67                 reg32_t *mode_reg;      ///< PWM mode register.
68                 reg32_t *duty_reg;      ///< PWM duty cycle register.
69                 reg32_t *period_reg;    ///< PWM periodic register.
70                 reg32_t *update_reg;    ///< Update setting register for PWM.
71
72         } PwmChannel;
73
74
75         void pwm_hw_init(void);
76         void pwm_hw_setFrequency(PwmDev dev, uint32_t freq);
77         void pwm_hw_setDutyUnlock(PwmDev dev, uint16_t duty);
78         void pwm_hw_disable(PwmDev dev);
79         void pwm_hw_enable(PwmDev dev);
80         void pwm_hw_setPolarity(PwmDev dev, bool pol);
81         pwm_period_t pwm_hw_getPeriod(PwmDev dev);
82
83 #else
84         #include <drv/pwm.h>
85
86         typedef uint16_t pwm_hwreg_t;
87
88         struct PwmChannelRegs; //fwd decl
89
90         typedef struct PwmHardware
91         {
92                 uint32_t pwm_pin;       ///< PWM pin.
93                 volatile struct PwmChannelRegs *base;
94         } PwmHardware;
95
96         pwm_hwreg_t pwm_hw_getPeriod(Pwm *ctx);
97         void pwm_hw_setFrequency(struct Pwm *ctx, pwm_freq_t freq);
98         void pwm_hw_setDuty(Pwm *ctx, pwm_hwreg_t duty);
99         void pwm_hw_init(struct Pwm *ctx, unsigned ch);
100
101 #endif
102
103 #endif /* DRV_ADC_AT91_H */