Add wizard info and fix some comments.
[bertos.git] / bertos / cfg / cfg_ser.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 2008 Develer S.r.l. (http://www.develer.com/)
30  * All Rights Reserved.
31  * -->
32  *
33  * \brief Configuration file for serial module.
34  *
35  * \version $Id$
36  *
37  * \author Daniele Basile <asterix@develer.com>
38  */
39
40 #ifndef CFG_SER_H
41 #define CFG_SER_H
42
43 /**
44  * Example of setting for serial port and
45  * spi port.
46  * Edit these define for your project.
47  */
48
49 /// Serial port settings. $WIZARD = { "type" : "int" }
50 #define CONFIG_SER_PORT      0
51 /// Serial port baudrate. $WIZARD = { "type" : "int" }
52 #define CONFIG_SER_BAUDRATE  115200
53
54 /// Spi port settings. $WIZARD = { "type" : "int" }
55 #define CONFIG_SPI_PORT      0
56 /// Spi port baudrate. $WIZARD = { "type" : "int" }
57 #define CONFIG_SPI_BAUDRATE  5000000UL
58
59
60 /// [bytes] Size of the outbound FIFO buffer for port 0. $WIZARD = { "type" : "int" }
61 #define CONFIG_UART0_TXBUFSIZE  32
62
63 /// [bytes] Size of the inbound FIFO buffer for port 0. $WIZARD = { "type" : "int" }
64 #define CONFIG_UART0_RXBUFSIZE  32
65
66 /// [bytes] Size of the outbound FIFO buffer for port 1. $WIZARD = { "type" : "int" }
67 #define CONFIG_UART1_TXBUFSIZE  32
68
69 /// [bytes] Size of the inbound FIFO buffer for port 1. $WIZARD = { "type" : "int" }
70 #define CONFIG_UART1_RXBUFSIZE  32
71
72
73 /// [bytes] Size of the outbound FIFO buffer for SPI port (AVR only). $WIZARD = { "type" : "int" }
74 #define CONFIG_SPI_TXBUFSIZE    32
75
76 /// [bytes] Size of the inbound FIFO buffer for SPI port (AVR only). $WIZARD = { "type" : "int" }
77 #define CONFIG_SPI_RXBUFSIZE    32
78
79 /// [bytes] Size of the outbound FIFO buffer for SPI port 0. $WIZARD = { "type" : "int" }
80 #define CONFIG_SPI0_TXBUFSIZE   32
81
82 /// [bytes] Size of the inbound FIFO buffer for SPI port 0. $WIZARD = { "type" : "int" }
83 #define CONFIG_SPI0_RXBUFSIZE   32
84
85 /// [bytes] Size of the outbound FIFO buffer for SPI port 1. $WIZARD = { "type" : "int" }
86 #define CONFIG_SPI1_TXBUFSIZE   32
87
88 /// [bytes] Size of the inbound FIFO buffer for SPI port 1. $WIZARD = { "type" : "int" }
89 #define CONFIG_SPI1_RXBUFSIZE   32
90
91 /**
92  * SPI data order (AVR only).
93  *
94  * $WIZARD = {
95  * "type" : "enum",
96  * "value_list" : "ser_order_bit"
97  * }
98  */
99 #define CONFIG_SPI_DATA_ORDER   SER_MSB_FIRST
100
101 /// SPI clock division factor (AVR only). $WIZARD = { "type" : "int" }
102 #define CONFIG_SPI_CLOCK_DIV    16
103 /**
104  * SPI clock polarity: normal low or normal high (AVR only).
105  * $WIZARD = {
106  * "type" : "enum",
107  * "value_list" : "ser_spi_pol"
108  * }
109  */
110 #define CONFIG_SPI_CLOCK_POL        SPI_NORMAL_LOW
111
112 /**
113  * SPI clock phase you can choose sample on first edge or
114  * sample on second clock edge (AVR only)
115  * $WIZARD = {
116  * "type" : "enum",
117  * "value_list" : "ser_spi_phase"
118  * }
119  */
120 #define CONFIG_SPI_CLOCK_PHASE      SPI_SAMPLE_ON_FIRST_EDGE
121
122 /// Default transmit timeout (ms). Set to -1 to disable timeout support. $WIZARD = { "type" : "int" }
123 #define CONFIG_SER_TXTIMEOUT    -1
124
125 /// Default receive timeout (ms). Set to -1 to disable timeout support. $WIZARD = { "type" : "int" }
126 #define CONFIG_SER_RXTIMEOUT    -1
127
128 /// Use RTS/CTS handshake. $WIZARD = { "type" : "boolean" }
129 #define CONFIG_SER_HWHANDSHAKE   0
130
131 /// Default baud rate (set to 0 to disable). $WIZARD = { "type" : "boolean" }
132 #define CONFIG_SER_DEFBAUDRATE   0
133
134 /// Enable ser_gets() and ser_gets_echo(). $WIZARD = { "type" : "boolean" }
135 #define CONFIG_SER_GETS          0
136
137 /// Enable second serial port in emulator. $WIZARD = { "type" : "boolean" }
138 #define CONFIG_EMUL_UART1        0
139
140 /// For serial debug. $WIZARD = { "type" : "boolean" }
141 #define CONFIG_SER_STROBE        0
142
143 #endif /* CFG_SER_H */