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