Updated copiright notice.
[bertos.git] / appconfig_common.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 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
30  * This file is part of DevLib - See README.devlib for information.
31  * -->
32  *
33  * \brief DevLib configuration options
34  *
35  * You should copy this header in your project and rename it to
36  * "config.h" and delete the CONFIG_ macros for the modules
37  * you're not using.
38  *
39  * <h2>Working with multiple applications</h2>
40  *
41  * If your project is made of multiple DevLib-based applications,
42  * create a custom "config.h" file in each application subdirectory
43  * and play with the compiler include path to get the desired result.
44  * You can share common options by creationg a "config_common.h" header
45  * and including it from all your "config.h" copies.
46  *
47  * <h2>Configuration style</h2>
48  *
49  * For improved compile-time checking of configuration options,
50  * the preferred way to use a \c CONFIG_ symbol is keeping it
51  * always defined with a value of either 0 or 1.  This lets
52  * you write tests like this:
53  *
54  * \code
55  *  #if CONFIG_FOO
56  *  void foo(void)
57  *  {
58  *      if (CONFIG_BAR)
59  *          bar();
60  *  }
61  *  #endif // CONFIG_FOO
62  * \endcode
63  *
64  * In most cases, we rely on the optimizer to discard checks
65  * on constant values and performing dead-code elimination.
66  *
67  * \version $Id$
68  * \author Bernardo Innocenti <bernie@develer.com>
69  * \author Stefano Fedrigo <aleph@develer.com>
70  */
71
72 /*#*
73  *#* $Log$
74  *#* Revision 1.4  2007/09/18 10:16:59  batt
75  *#* Merge from triface.
76  *#*
77  *#* Revision 1.3  2006/09/13 18:29:22  bernie
78  *#* Add a few missing CONFIG_ definitions.
79  *#*
80  *#* Revision 1.2  2006/07/19 12:56:24  bernie
81  *#* Convert to new Doxygen style.
82  *#*
83  *#* Revision 1.1  2006/05/18 00:40:43  bernie
84  *#* Rename appconfig.h to appconfig_common.h.
85  *#*
86  *#* Revision 1.11  2006/04/11 00:08:53  bernie
87  *#* Add smooth scrolling for menus.
88  *#*
89  *#* Revision 1.10  2006/03/22 09:48:51  bernie
90  *#* Add a few more config options.
91  *#*
92  *#* Revision 1.9  2006/02/24 00:27:35  bernie
93  *#* Enable kernel and fix Doxygen markup.
94  *#*
95  *#* Revision 1.8  2006/02/21 16:06:05  bernie
96  *#* Update copyright info.
97  *#*
98  *#* Revision 1.7  2006/02/17 22:28:19  bernie
99  *#* Add missing UART definitions.
100  *#*
101  *#* Revision 1.6  2006/02/15 09:12:56  bernie
102  *#* Switch to BITMAP_FMT_PLANAR_V_LSB.
103  *#*
104  *#* Revision 1.5  2006/02/10 12:34:33  bernie
105  *#* Add missing config options for gfx and kbd.
106  *#*
107  *#* Revision 1.4  2006/01/23 23:12:27  bernie
108  *#* Enable CONFIG_GFX_VCOORDS.
109  *#*
110  *#* Revision 1.3  2006/01/17 02:30:06  bernie
111  *#* Add new config vars.
112  *#*
113  *#* Revision 1.2  2005/11/27 03:04:57  bernie
114  *#* CONFIG_WATCHDOG: New config option.
115  *#*
116  *#* Revision 1.1  2005/11/04 17:42:12  bernie
117  *#* Move cfg/config.h to appconfig.h.
118  *#*/
119
120 #ifndef APPCONFIG_COMMON_H
121 #define APPCONFIG_COMMON_H
122
123 /** Baud-rate for the kdebug console */
124 #define CONFIG_KDEBUG_BAUDRATE  19200
125
126 /**
127  * printf()-style formatter configuration.
128  *
129  * \sa PRINTF_DISABLED
130  * \sa PRINTF_NOMODIFIERS
131  * \sa PRINTF_REDUCED
132  * \sa PRINTF_NOFLOAT
133  * \sa PRINTF_FULL
134  */
135 #define CONFIG_PRINTF PRINTF_FULL
136
137 /**
138  * Multithreading kernel.
139  *
140  * \sa config_kern.h
141  */
142 #define CONFIG_KERNEL 0
143
144 /**
145  * \name Serial driver parameters
146  * \{
147  */
148         /** [bytes] Size of the outbound FIFO buffer for port 0. */
149         #define CONFIG_UART0_TXBUFSIZE  32
150
151         /** [bytes] Size of the inbound FIFO buffer for port 0. */
152         #define CONFIG_UART0_RXBUFSIZE  64
153
154         /** [bytes] Size of the outbound FIFO buffer for port 1. */
155         #define CONFIG_UART1_TXBUFSIZE  32
156
157         /** [bytes] Size of the inbound FIFO buffer for port 1. */
158         #define CONFIG_UART1_RXBUFSIZE  64
159
160         /** [bytes] Size of the outbound FIFO buffer for SPI port (AVR only). */
161         #define CONFIG_SPI_TXBUFSIZE    16
162
163         /** [bytes] Size of the inbound FIFO buffer for SPI port (AVR only). */
164         #define CONFIG_SPI_RXBUFSIZE    32
165
166         /** SPI data order (AVR only). */
167         #define CONFIG_SPI_DATA_ORDER   SER_MSB_FIRST
168
169         /** SPI clock division factor (AVR only). */
170         #define CONFIG_SPI_CLOCK_DIV    16
171
172         /** SPI clock polarity: 0 = normal low, 1 = normal high (AVR only). */
173         #define CONFIG_SPI_CLOCK_POL    0
174
175         /** SPI clock phase: 0 = sample on first edge, 1 = sample on second clock edge (AVR only). */
176         #define CONFIG_SPI_CLOCK_PHASE  0
177
178         /** Default transmit timeout (ms). Set to -1 to disable timeout support */
179         #define CONFIG_SER_TXTIMEOUT    -1
180
181         /** Default receive timeout (ms). Set to -1 to disable timeout support */
182         #define CONFIG_SER_RXTIMEOUT    -1
183
184         /** Use RTS/CTS handshake */
185         #define CONFIG_SER_HWHANDSHAKE   0
186
187         /** Default baud rate (set to 0 to disable) */
188         #define CONFIG_SER_DEFBAUDRATE   0
189
190         /** Enable ser_gets() and ser_gets_echo() */
191         #define CONFIG_SER_GETS          0
192
193         /** Enable second serial port in emulator. */
194         #define CONFIG_EMUL_UART1        0
195
196         /**
197          * Transmit always something on serial port 0 TX
198          * to avoid interference when sending burst of data,
199          * using AVR multiprocessor serial mode
200          */
201         #define CONFIG_SER_TXFILL        0
202
203         #define CONFIG_SER_STROBE        0
204 /*\}*/
205
206 /// Hardware timer selection for drv/timer.c
207 #define CONFIG_TIMER  TIMER_ON_OUTPUT_COMPARE2
208
209 /// Debug timer interrupt using a strobe pin.
210 #define CONFIG_TIMER_STROBE  0
211
212 /// Enable ADS strobe.
213 #define CONFIG_ADC_STROBE  0
214
215 /// Enable watchdog timer.
216 #define CONFIG_WATCHDOG  1
217
218 /// EEPROM type for drv/eeprom.c
219 #define CONFIG_EEPROM_TYPE EEPROM_24XX256
220
221 /// Select bitmap pixel format.
222 #define CONFIG_BITMAP_FMT  BITMAP_FMT_PLANAR_V_LSB
223
224 /// Enable line clipping algorithm.
225 #define CONFIG_GFX_CLIPPING  1
226
227 /// Enable text rendering in bitmaps.
228 #define CONFIG_GFX_TEXT  1
229
230 /// Enable virtual coordinate system.
231 #define CONFIG_GFX_VCOORDS  1
232
233 /// Keyboard polling method
234 #define CONFIG_KBD_POLL  KBD_POLL_SOFTINT
235
236 /// Enable keyboard event delivery to observers
237 #define CONFIG_KBD_OBSERVER  0
238
239 /// Enable key beeps
240 #define CONFIG_KBD_BEEP  1
241
242 /// Enable long pression handler for keys
243 #define CONFIG_KBD_LONGPRESS  1
244
245 /**
246  * \name Type for the chart dataset
247  * \{
248  */
249 #define CONFIG_CHART_TYPE_X uint8_t
250 #define CONFIG_CHART_TYPE_Y uint8_t
251 /*\}*/
252
253 /// Enable button bar behind menus
254 #define CONFIG_MENU_MENUBAR  0
255
256 /// Enable smooth scrolling in menus
257 #define CONFIG_MENU_SMOOTH  1
258
259 #endif /* APPCONFIG_COMMON_H */