Update to Doxygen 1.4.1.
[bertos.git] / config_template.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5  * All Rights Reserved.
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.5  2004/12/08 08:04:28  bernie
50  *#* Add missing config options.
51  *#*
52  *#* Revision 1.4  2004/08/25 14:12:08  rasky
53  *#* Aggiornato il comment block dei log RCS
54  *#*
55  *#* Revision 1.3  2004/08/24 14:30:11  bernie
56  *#* Use new-style config macros for drv/timer.c
57  *#*
58  *#* Revision 1.2  2004/08/05 18:46:52  bernie
59  *#* Documentation improvements.
60  *#*
61  *#* Revision 1.1  2004/07/29 23:34:32  bernie
62  *#* Add template configuration file.
63  *#*
64  *#*/
65
66 #ifndef CONFIG_COMMON_H
67 #define CONFIG_COMMON_H
68
69 /*! Baud-rate for the kdebug console */
70 #define CONFIG_KDEBUG_BAUDRATE  19200
71
72 /*!
73  * printf()-style formatter configuration.
74  *
75  * \sa PRINTF_DISABLED
76  * \sa PRINTF_NOMODIFIERS
77  * \sa PRINTF_REDUCED
78  * \sa PRINTF_NOFLOAT
79  * \sa PRINTF_FULL
80  */
81 #define CONFIG_PRINTF PRINTF_FULL
82
83 /*!
84  * Multithreading kernel
85  *
86  * /sa config_kernel.h
87  */
88 #define CONFIG_KERNEL 0
89
90 /*!
91  * \name Serial driver parameters
92  * \{
93  */
94         /*! Size of the outbound FIFO buffer for all ports (bytes) */
95         #define CONFIG_SER_TXBUFSIZE  32
96         /*! Size of the inbound FIFO buffer for all ports (bytes) */
97         #define CONFIG_SER_RXBUFSIZE  64
98
99         /*! Default transmit timeout (ms). Set to -1 to disable timeout support */
100         #define CONFIG_SER_TXTIMEOUT    -1
101         /*! Default receive timeout (ms). Set to -1 to disable timeout support */
102         #define CONFIG_SER_RXTIMEOUT    -1
103
104         /*! Use RTS/CTS handshake */
105         #define CONFIG_SER_HWHANDSHAKE   0
106
107         /*! Default baud rate (set to 0 to disable) */
108         #define CONFIG_SER_DEFBAUDRATE   0
109
110         /*! Enable ser_gets() and ser_gets_echo() */
111         #define CONFIG_SER_GETS          0
112
113         /*!
114          * Transmit always something on serial port 0 TX
115          * to avoid interference when sending burst of data,
116          * using AVR multiprocessor serial mode
117          */
118         #define CONFIG_SER_TXFILL        0
119
120         #define CONFIG_SER_STROBE        0
121 /*\}*/
122
123 /*!
124  * \name KBus configuration
125  * \{
126  */
127         /*! Board address for KBus */
128         #define CONFIG_KBUS_ADDR KBUS_ADDR_FOOBAR
129
130         /*! Disable KBUS escaping support */
131         #define CONFIG_KBUS_ESCAPE  0
132
133         /*! Serial port for internal KBUS communication */
134         #define CONFIG_KBUS_PORT  0
135
136         /*! Serial port speed for KBus communication */
137         #define CONFIG_KBUS_BAUDRATE  19200
138 /*\}*/
139
140 //! Hardware timer selection for drv/timer.c
141 #define CONFIG_TIMER  TIMER_ON_OUTPUT_COMPARE2
142
143 #define CONFIG_TIMER_STROBE  0
144
145 //! EEPROM type for drv/eeprom.c
146 #define CONFIG_EEPROM_TYPE EEPROM_24XX256
147
148 #endif /* CONFIG_COMMON_H */