doc: Add clarifications for doxygen generated documentation
[bertos.git] / boards / triface / hw / hw_dc_motor.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 2006 Develer S.r.l. (http://www.develer.com/)
30  * All Rights Reserved.
31  * -->
32  *
33  * \brief DC motor hardware-specific definitions
34  *
35  * \author Daniele Basile <asterix@develer.com>
36  */
37
38 #ifndef HW_DC_MOTOR_H
39 #define HW_DC_MOTOR_H
40
41 #warning TODO:This is an example implementation, you must implement it!
42
43 /**
44  * Define fuctions which read  adc value from specific device
45  */
46  #define HW_DC_MOTOR_READ_VALUE(dev, min, max) \
47         ({ \
48                  /* Put here the fuction that read from ADC */ \
49                 (void)(dev); \
50                 (void)(min); \
51                 (void)(max); \
52                 (0); \
53         })
54
55 // Macro that enable the select DC motor
56 #define DC_MOTOR_ENABLE(dev)    /* Implement me! */
57 // Macro that disable the select DC motor
58 #define DC_MOTOR_DISABLE(dev)   /* Implement me! */
59
60 // Macro that left the DC motor rotor float
61 #define DC_MOTOR_STOP_FLOAT(dev)    DC_MOTOR_DISABLE(dev)
62 // Macro that put in short circuit DC motor supply pins
63 #define DC_MOTOR_STOP_BRAKED(dev)   do { /* Implement me! */ } while (0)
64
65 // Macro that set motor direction
66 #define DC_MOTOR_SET_DIR(dev, dir)  do { /* Implement me! */ } while (0)
67
68 #define MOTOR_DC_INIT()             do { /* Implement me! */ } while (0)
69
70
71 #endif /* HW_DC_MOTOR_H */