4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
33 * \brief Thermo-control driver
37 * \author Giovanni Bajo <rasky@develer.com>
38 * \author Francesco Sacchi <batt@develer.com>
43 *#* Revision 1.3 2006/09/20 20:12:41 marco
44 *#* Names convention, MOD_* macros.
46 *#* Revision 1.2 2006/07/19 12:56:26 bernie
47 *#* Convert to new Doxygen style.
49 *#* Revision 1.1 2005/11/04 17:59:47 bernie
50 *#* Import into DevLib.
53 #include <thermo_map.h>
54 #include <hw_thermo.h>
56 #include <drv/thermo.h>
57 #include <drv/timer.h>
60 #include <cfg/macros.h>
61 #include <cfg/debug.h>
64 /** Interval at which thermo control is performed. */
65 #define THERMO_INTERVAL_MS 100
67 /** Number of different samples we interpolate over to get the hifi temperature. */
68 #define THERMO_HIFI_NUM_SAMPLES 10
70 /** Timer for thermo-regulation. */
71 static Timer thermo_timer;
73 typedef struct ThermoControlDev
75 deg_t hifi_samples[THERMO_HIFI_NUM_SAMPLES];
76 deg_t cur_hifi_sample;
78 thermostatus_t status;
82 /** Array of thermo-devices. */
83 ThermoControlDev devs[THERMO_CNT];
87 * Return the status of the specific \a dev thermo-device.
89 thermostatus_t thermo_status(ThermoDev dev)
91 return devs[dev].status;
96 * Do a single thermo control for device \a dev.
98 static void thermo_do(ThermoDev index)
100 ThermoControlDev* dev = &devs[index];
102 deg_t tolerance = thermo_hw_tolerance(index);
104 cur_temp = thermo_hw_read(index);
106 // Store the sample into the hifi FIFO buffer for later interpolation
107 dev->hifi_samples[dev->cur_hifi_sample] = cur_temp;
108 if (++dev->cur_hifi_sample == THERMO_HIFI_NUM_SAMPLES)
109 dev->cur_hifi_sample = 0;
111 cur_temp = thermo_readTemperature(index);
113 if (cur_temp == NTC_SHORT_CIRCUIT || cur_temp == NTC_OPEN_CIRCUIT)
115 if (cur_temp == NTC_SHORT_CIRCUIT)
118 if (!(dev->status & THERMOERRF_NTCSHORT))
119 kprintf("dev[%d], thermo_do: NTC_SHORT\n",index);
121 dev->status |= THERMOERRF_NTCSHORT;
126 if (!(dev->status & THERMOERRF_NTCOPEN))
127 kprintf("dev[%d], thermo_do: NTC_OPEN\n", index);
129 dev->status |= THERMOERRF_NTCOPEN;
132 /* Reset timeout when there is an ntc error */
133 dev->expire = thermo_hw_timeout(index) + timer_clock();
134 thermo_hw_off(index);
137 dev->status &= ~(THERMOERRF_NTCOPEN | THERMOERRF_NTCSHORT);
139 if ((cur_temp < dev->target - tolerance) || (cur_temp > dev->target + tolerance))
141 dev->status &= ~THERMO_TGT_REACH;
143 /* Check for timeout */
144 if (timer_clock() - dev->expire > 0)
146 dev->status |= THERMOERRF_TIMEOUT;
147 kprintf("dev[%d], thermo_do: TIMEOUT\n", index);
153 dev->status &= ~THERMO_ERRMASK;
154 dev->status |= THERMO_TGT_REACH;
156 /* Reset timeout in case we go out of target in the future */
157 dev->expire = thermo_hw_timeout(index) + timer_clock();
160 if (cur_temp < dev->target)
161 dev->status = (dev->status | THERMO_HEATING) & ~THERMO_FREEZING;
163 dev->status = (dev->status & ~THERMO_HEATING) | THERMO_FREEZING;
165 thermo_hw_set(index, dev->target, cur_temp);
171 * Thermo soft interrupt.
173 static void thermo_softint(void)
176 for (i = 0; i < THERMO_CNT; ++i)
177 if (devs[i].status & THERMO_ACTIVE)
178 thermo_do((ThermoDev)i);
180 timer_add(&thermo_timer);
185 * Set the target temperature \a temperature for a specific \a dev thermo-device.
187 void thermo_setTarget(ThermoDev dev, deg_t temperature)
189 ASSERT(dev < THERMO_CNT);
190 devs[dev].target = temperature;
191 devs[dev].expire = timer_clock() + thermo_hw_timeout(dev);
193 kprintf("setTarget dev[%d], T[%d.%d]\n", dev, temperature / 10, temperature % 10);
197 * Starts a thermo-regulation for channel \a dev.
199 void thermo_start(ThermoDev dev)
204 ASSERT(dev < THERMO_CNT);
206 devs[dev].status |= THERMO_ACTIVE;
208 /* Initialize the hifi FIFO with a constant value (the current temperature) */
209 temp = thermo_hw_read(dev);
210 for (i = 0; i < THERMO_HIFI_NUM_SAMPLES; ++i)
211 devs[dev].hifi_samples[i] = temp;
212 devs[dev].cur_hifi_sample = 0;
215 devs[dev].expire = timer_clock() + thermo_hw_timeout(dev);
219 * Stops a thermo-regulation for channel \a dev.
221 void thermo_stop(ThermoDev dev)
223 ASSERT(dev < THERMO_CNT);
225 devs[dev].status &= ~THERMO_ACTIVE;
231 * Clear errors for channel \a dev.
233 void thermo_clearErrors(ThermoDev dev)
235 ASSERT(dev < THERMO_CNT);
236 devs[dev].status &= ~(THERMO_ERRMASK);
241 * Read the temperature of the thermo-device \a dev using mobile mean.
243 deg_t thermo_readTemperature(ThermoDev dev)
250 for (i = 0; i < THERMO_HIFI_NUM_SAMPLES; i++)
251 accum += devs[dev].hifi_samples[i];
253 return (deg_t)(accum / THERMO_HIFI_NUM_SAMPLES);
259 * Init thermo-control and associated hw.
261 void thermo_init(void)
265 /* Set all status to off */
266 for (int i = 0; i < THERMO_CNT; i++)
267 devs[i].status = THERMO_OFF;
271 timer_setDelay(&thermo_timer, ms_to_ticks(THERMO_INTERVAL_MS));
272 timer_set_event_softint(&thermo_timer, (Hook)thermo_softint, 0);
273 timer_add(&thermo_timer);