Update preset.
[bertos.git] / bertos / drv / phase.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 Phase partialization driver with TRIACs.
34  *
35  * \author Francesco Sacchi <batt@develer.com>
36  *
37  * $WIZ$ module_name = "phase"
38  * $WIZ$ module_depends = "timer"
39  * $WIZ$ module_configuration = "bertos/cfg/cfg_phase.h"
40  * $WIZ$ module_hw = "bertos/hw/hw_phase.h", "bertos/hw/phase_map.h", "bertos/hw/hw_phase.c"
41  */
42
43 #ifndef DRV_PHASE_H
44 #define DRV_PHASE_H
45
46 #include "hw/phase_map.h"
47
48 #include "cfg/cfg_phase.h"
49
50 #include <drv/timer.h>
51
52 #define TRIAC_POWER_K   CONFIG_TRIAC_MAX_DUTY * (1 / sqrt(2 * CONFIG_TRIAC_MAX_POWER))
53
54 /**
55  * \name Types for duty and power.
56  * \{
57  */
58 typedef uint16_t triac_duty_t;
59 typedef uint16_t triac_power_t;
60 /* \} */
61
62
63 DB(extern bool phase_initialized;)
64
65 /**
66  * \name Type for triac control.
67  * \{
68  */
69 typedef struct Triac
70 {
71         Timer  timer;      /**< Timer for phase control. */
72         triac_duty_t duty; /**< Duty cycle of the channel. */
73         bool   running;    /**< True when the timer is active. */
74 } Triac;
75 /* \} */
76
77 void phase_setDutyUnlock(TriacDev dev, triac_duty_t duty);
78 void phase_setDuty(TriacDev dev, triac_duty_t duty);
79 void phase_setPower(TriacDev dev, triac_power_t power);
80
81 void phase_init(void);
82
83
84 #endif /* DRV_PHASE_H */