doc: Add clarifications for doxygen generated documentation
[bertos.git] / boards / triface / 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 "hw/thermo_map.h"
43
44 #include <cfg/debug.h>
45
46 #include <drv/ntc.h>
47
48
49 INLINE ticks_t thermo_hw_timeout(ThermoDev dev)
50 {
51         (void)dev;
52         return 0;
53 }
54
55 /**
56  * This function should return the temperature set tolerance.
57  */
58 INLINE deg_t thermo_hw_tolerance(ThermoDev dev)
59 {
60         (void)dev;
61         return 0;
62 }
63
64 /**
65  * Read the temperature of the hw device \a dev.
66  */
67 INLINE deg_t thermo_hw_read(ThermoDev dev)
68 {
69         ASSERT(dev < THERMO_CNT);
70         /* Put here the code to read current temperature */
71         return 0;
72 }
73
74
75 /**
76  * Turns off a specific device.
77  * This function is usefull to handle errors.
78  */
79 INLINE void thermo_hw_off(ThermoDev dev)
80 {
81         ASSERT(dev < THERMO_CNT);
82         /* Put here the code to turn off the thermo device */
83 }
84
85 /**
86  * Based on the current temperature \a cur_temp and the target temperature \a target,
87  * this function turns on and off specific thermo device.
88  * It may use also PID control for thermo-regolations.
89  */
90 INLINE void thermo_hw_set(ThermoDev dev, deg_t target, deg_t cur_temp)
91 {
92         ASSERT(dev < THERMO_CNT);
93
94         if (target - cur_temp > 0)
95         {
96                 /*
97                  * We are leveaving the target temperature, so
98                  * turn on the thermo device!
99                  */
100         }
101         else
102         {
103                 /*
104                  * Ok, we are near the target temperature, so
105                  * turn off the thermo device!
106                  */
107         }
108
109 }
110
111 #define THERMO_HW_INIT  _thermo_hw_init()
112
113 /**
114  * Init hw associated with thermo-control.
115  */
116 INLINE void _thermo_hw_init(void)
117 {
118         /* Init your devices here! */
119 }
120
121 #endif /* HW_THERMO_H */