Keep doc/ directory around for Doxygen.
[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  * \para Working with multiple applications
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  * \para Configuration style
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.1  2004/07/29 23:34:32  bernie
50  * Add template configuration file.
51  *
52  */
53
54 #ifndef CONFIG_COMMON_H
55 #define CONFIG_COMMON_H
56
57 /*! Baud-rate for the kdebug console */
58 #define CONFIG_KDEBUG_BAUDRATE  19200
59
60 /*!
61  * printf()-style formatter configuration.
62  *
63  * \sa PRINTF_DISABLED
64  * \sa PRINTF_NOMODIFIERS
65  * \sa PRINTF_REDUCED
66  * \sa PRINTF_NOFLOAT
67  * \sa PRINTF_FULL
68  */
69 #define CONFIG_PRINTF PRINTF_FULL
70
71 /*!
72  * Multithreading kernel
73  *
74  * /sa config_kernel.h
75  */
76 #define CONFIG_KERNEL 0
77
78 /*!
79  * \name Serial driver parameters
80  * \{
81  */
82         /*! Size of the outbound FIFO buffer for all ports (bytes) */
83         #define CONFIG_SER_TXBUFSIZE  32
84         /*! Size of the inbound FIFO buffer for all ports (bytes) */
85         #define CONFIG_SER_RXBUFSIZE  64
86
87         /*! Default transmit timeout (ms). Set to -1 to disable timeout support */
88         #define CONFIG_SER_TXTIMEOUT    -1
89         /*! Default receive timeout (ms). Set to -1 to disable timeout support */
90         #define CONFIG_SER_RXTIMEOUT    -1
91
92         /*! Use RTS/CTS handshake */
93         #define CONFIG_SER_HWHANDSHAKE   0
94
95         /*! Default baud rate (set to 0 to disable) */
96         #define CONFIG_SER_DEFBAUDRATE   0
97
98         /*! Enable ser_gets() and ser_gets_echo() */
99         #define CONFIG_SER_GETS          0
100
101         /*!
102          * Transmit always something on serial port 0 TX
103          * to avoid interference when sending burst of data,
104          * using AVR multiprocessor serial mode
105          */
106         #define CONFIG_SER_TXFILL        0
107 /*\}*/
108
109 /*!
110  * \name KBus configuration
111  * \{
112  */
113         /*! Board address for KBus */
114         #define CONFIG_KBUS_ADDR KBUS_ADDR_FOOBAR
115
116         /*! Disable KBUS escaping support */
117         #define CONFIG_KBUS_ESCAPE  0
118
119         /*! Serial port for internal KBUS communication */
120         #define CONFIG_KBUS_PORT  0
121
122         /*! Serial port speed for KBus communication */
123         #define CONFIG_KBUS_BAUDRATE  19200
124 /*\}*/
125
126 //! EEPROM type for drv/eeprom.c
127 #define CONFIG_EEPROM_TYPE EEPROM_24XX256
128
129 #endif /* CONFIG_COMMON_H */