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  * \version $Id$
  33  *
  34  * \brief Phase control driver (interface)
  35  *
  36  * \version $Id$
  37  * \author Francesco Sacchi <batt@develer.com>
  38  */
  39
  40 /*#*
  41  *#* $Log$
  42  *#* Revision 1.2  2006/07/19 12:56:26  bernie
  43  *#* Convert to new Doxygen style.
  44  *#*
  45  *#* Revision 1.1  2005/11/04 18:06:44  bernie
  46  *#* Import into DevLib.
  47  *#*
  48  *#* Revision 1.1  2005/05/24 09:17:58  batt
  49  *#* Move drivers to top-level.
  50  *#*
  51  *#* Revision 1.9  2005/05/09 16:34:14  batt
  52  *#* Change some function names to accomplish coding standard; Add debug phase_initialized; Change duty_t and power_t to uint16_t.
  53  *#*
  54  *#* Revision 1.8  2005/05/02 12:37:33  batt
  55  *#* Split hw triac map in phase_map.h.
  56  *#*
  57  *#* Revision 1.7  2005/05/02 09:05:03  batt
  58  *#* Rename duty_t and power_t in triac_duty_t and triac_power_t
  59  *#*
  60  *#* Revision 1.6  2005/04/28 15:10:11  batt
  61  *#* Use timer API to add and set events.
  62  *#*
  63  *#* Revision 1.5  2005/04/28 12:04:46  batt
  64  *#* Add some comments.
  65  *#*
  66  *#* Revision 1.4  2005/04/28 10:35:45  batt
  67  *#* Complete phase_setpower.
  68  *#*
  69  *#* Revision 1.3  2005/04/27 19:23:40  batt
  70  *#* Reformat.
  71  *#*
  72  *#* Revision 1.1  2005/04/27 17:13:56  batt
  73  *#* Add triac phase control driver.
  74  *#*
  75  *#*/
  76
  77
  78 #ifndef DRV_PHASE_H
  79 #define DRV_PHASE_H
  80
  81 #include <drv/timer.h>
  82 #include <phase_map.h>
  83 #include <cfg/debug.h>
  84
  85 #define TRIAC_MAX_DUTY  100
  86 #define TRIAC_MAX_POWER 100
  87 #define TRIAC_POWER_K   TRIAC_MAX_DUTY * (1 / sqrt(2 * TRIAC_MAX_POWER))
  88
  89 /**
  90  * \name Types for duty and power.
  91  * \{
  92  */
  93 typedef uint16_t triac_duty_t;
  94 typedef uint16_t triac_power_t;
  95 /* \} */
  96
  97
  98 DB(extern bool phase_initialized;)
  99
 100 /**
 101  * \name Type for triac control.
 102  * \{
 103  */
 104 typedef struct Triac
 105 {
 106         Timer  timer;      /**< Timer for phase control. */
 107         triac_duty_t duty; /**< Duty cycle of the channel. */
 108         bool   running;    /**< True when the timer is active. */
 109 } Triac;
 110 /* \} */
 111
 112 void phase_setDutyUnlock(TriacDev dev, triac_duty_t duty);
 113 void phase_setDuty(TriacDev dev, triac_duty_t duty);
 114 void phase_setPower(TriacDev dev, triac_power_t power);
 115
 116 void phase_init(void);
 117
 118
 119 #endif /* DRV_PHASE_H */