77a6e24513af0e5c12df49a663df73ee3a108e12
[bertos.git] / bertos / 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  * \version $Id$
36  *
37  * \author Daniele Basile <asterix@develer.com>
38  */
39
40 #ifndef HW_DC_MOTOR_H
41 #define HW_DC_MOTOR_H
42
43 #warning TODO:This is example implemetantion, you must implement it! 
44
45 //DC motor 0
46 #define DC_MOTOR0_EN_PIN      /* Implement me! */
47 #define DC_MOTOR0_DIR_PIN     /* Implement me! */
48 #define DC_MOTOR0_CLEAR       /* Implement me! */
49 #define DC_MOTOR0_SET         /* Implement me! */
50
51 /* Add other motor here */
52
53
54 #define DC_MOTOR_PIN_INIT_MACRO(port, index) \
55     do { \
56         /* put here code to init pins */ \
57         } while (0)
58
59
60 #define DC_MOTOR_SET_ENABLE(index)     do { /* Implement me! */ } while (0)
61 #define DC_MOTOR_SET_DISABLE(index)    do { /* Implement me! */ } while (0)
62 #define DC_MOTOR_DIR_CW_MACRO(index)   do { /* Implement me! */ } while (0)
63 #define DC_MOTOR_DIR_CCW_MACRO(index)  do { /* Implement me! */ } while (0)
64
65
66 #define DC_MOTOR_ENABLE(index) \
67    do {  \
68         switch (index) \
69         { \
70         case 0:\
71             DC_MOTOR_SET_ENABLE(0); \
72             break; \
73                 /* Add other motor here */ \
74         } \
75     } while(0)
76
77 #define DC_MOTOR_DISABLE(index) \
78    do {  \
79         switch (index) \
80         { \
81         case 0:\
82             DC_MOTOR_SET_DISABLE(0); \
83             break; \
84                 /* Add other motor here */ \
85         } \
86     } while(0)
87
88
89 #define DC_MOTOR_DIR_CW(index) \
90    do {  \
91         switch (index) \
92         { \
93         case 0:\
94             DC_MOTOR_DIR_CW_MACRO(0); \
95             break; \
96                 /* Add other motor here */ \
97         } \
98     } while(0)
99
100  #define DC_MOTOR_DIR_CCW(index) \
101    do {  \
102         switch (index) \
103         { \
104         case 0:\
105             DC_MOTOR_DIR_CCW_MACRO(0); \
106             break; \
107                 /* Add other motor here */ \
108         } \
109     } while(0)
110
111
112
113 #define DC_MOTOR_SET_DIR(index, dir) \
114     do { \
115         if (dir) \
116             DC_MOTOR_DIR_CW(index); \
117         else \
118             DC_MOTOR_DIR_CCW(index); \
119     } while (0)
120
121 #define DC_MOTOR_INIT(index) \
122     do { \
123         switch (index) \
124         { \
125         case 0: \
126             DC_MOTOR_PIN_INIT_MACRO(A, 0); \
127             break; \
128         case 1: \
129             DC_MOTOR_PIN_INIT_MACRO(A, 1); \
130             break; \
131         } \
132     } while (0)
133
134 #endif /* HW_DC_MOTOR_H */