rmslog/hw/hw_thermo.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  * All Rights Reserved.
  31  * -->
  32  *
  33  * \brief thermo hardware-specific control functions.
  34  *
  35  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  */
  38
  39 #ifndef HW_THERMO_H
  40 #define HW_THERMO_H
  41
  42 #include "thermo_map.h"
  43 #include "ntc_map.h"
  44
  45 #include <drv/phase.h>
  46 #include <drv/ntc.h>
  47
  48 #include <cfg/debug.h>
  49 #include <cfg/compiler.h>
  50
  51 #warning TODO:This is an example implentation, you must implement it!
  52
  53 /*!
  54  * This function should return the temperature set tolerance.
  55  */
  56 INLINE deg_t thermo_hw_tolerance(ThermoDev dev)
  57 {
  58         ASSERT(dev < THERMO_CNT);
  59
  60         switch (dev)
  61         {
  62         case THERMO_TEST:
  63                 /* Put here convertion function to temperature size */
  64                 break;
  65
  66         /* Put here your thermo device */
  67
  68         default:
  69                 ASSERT(0);
  70         }
  71
  72         return 0;
  73 }
  74
  75
  76 /*!
  77  * This function should return the timeout for reaching the
  78  * target temperature.
  79  */
  80 INLINE ticks_t thermo_hw_timeout(ThermoDev dev)
  81 {
  82         ASSERT(dev < THERMO_CNT);
  83
  84         switch (dev)
  85         {
  86         case THERMO_TEST:
  87                 /* return ms_to_ticks(60000); */
  88                 break;
  89
  90         /* Put here a time out for select thermo device */
  91
  92         default:
  93                 ASSERT(0);
  94         }
  95
  96         return 0;
  97 }
  98
  99
 100
 101 /*!
 102  * Read the temperature of the hw device \a dev.
 103  */
 104 INLINE deg_t thermo_hw_read(ThermoDev dev)
 105 {
 106         return ntc_read(dev);
 107 }
 108
 109
 110 /*!
 111  * Turns off a specific device.
 112  * This function is usefull to handle errors.
 113  */
 114 INLINE void thermo_hw_off(ThermoDev dev)
 115 {
 116         ASSERT(dev < THERMO_CNT);
 117
 118         switch (dev)
 119         {
 120         case THERMO_TEST:
 121                 phase_setPower(TRIAC_TEST, 0);
 122                 break;
 123
 124         /* Put here a thermo device to turn off */
 125
 126         default:
 127                 ASSERT(0);
 128         }
 129
 130 }
 131
 132
 133 /*!
 134  * Based on the current temperature \a cur_temp and the target temperature \a target, this function turns on and off specific
 135  * triac channel and handles the freezer alarm.
 136  * It may use also PID control for thermo-regolations.
 137  */
 138 INLINE void thermo_hw_set(ThermoDev dev, deg_t target, deg_t cur_temp)
 139 {
 140         ASSERT(dev < THERMO_CNT);
 141
 142         deg_t dist = target - cur_temp;
 143         //kprintf("dev[%d], dist[%d]\n", dev, dist);
 144
 145         switch(dev)
 146         {
 147         case THERMO_TEST:
 148                 if (dist > 0)
 149                 {
 150                         /*      phase_setPower(TRIAC_TEST, dist * PID_TEST_K); */
 151                 }
 152                 else
 153                 {
 154                         /* phase_setPower(TRIAC_TEST, 0); */
 155                 }
 156                 break;
 157
 158         /* Put here an other thermo device */
 159
 160         default:
 161                 ASSERT(0);
 162         }
 163 }
 164
 165
 166 #define THERMO_HW_INIT  _thermo_hw_init()
 167
 168 /*!
 169  * Init hw associated with thermo-control.
 170  */
 171 INLINE void _thermo_hw_init(void)
 172 {
 173         ASSERT(phase_initialized);
 174         ASSERT(ntc_initialized);
 175
 176         phase_setPower(TRIAC_TEST, 0);
 177
 178         /* Add here the other thermo device */
 179 }
 180
 181 #endif /* HW_THERMO_H */