2adb55eaa382e182f1d06dc738539344e657c9c4
[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 /// [bytes] Size of the outbound FIFO buffer for port 0. $WIZ$ type = "int"
50 #define CONFIG_UART0_TXBUFSIZE  32
51
52 /// [bytes] Size of the inbound FIFO buffer for port 0. $WIZ$ type = "int"
53 #define CONFIG_UART0_RXBUFSIZE  32
54
55 /// [bytes] Size of the outbound FIFO buffer for port 1. $WIZ$ type = "int"
56 #define CONFIG_UART1_TXBUFSIZE  32
57
58 /// [bytes] Size of the inbound FIFO buffer for port 1. $WIZ$ type = "int"
59 #define CONFIG_UART1_RXBUFSIZE  32
60
61
62 /**
63  * [bytes] Size of the outbound FIFO buffer for SPI port.
64  * $WIZ$ type = "int"
65  * $WIZ$ supports = "avr"
66  */
67 #define CONFIG_SPI_TXBUFSIZE    32
68
69 /**
70  * [bytes] Size of the inbound FIFO buffer for SPI port.
71  * $WIZ$ type = "int"
72  * $WIZ$ supports = "avr"
73  */
74 #define CONFIG_SPI_RXBUFSIZE    32
75
76 /// [bytes] Size of the outbound FIFO buffer for SPI port 0. $WIZ$ type = "int"
77 #define CONFIG_SPI0_TXBUFSIZE   32
78
79 /// [bytes] Size of the inbound FIFO buffer for SPI port 0. $WIZ$ type = "int"
80 #define CONFIG_SPI0_RXBUFSIZE   32
81
82 /// [bytes] Size of the outbound FIFO buffer for SPI port 1. $WIZ$ type = "int"
83 #define CONFIG_SPI1_TXBUFSIZE   32
84
85 /// [bytes] Size of the inbound FIFO buffer for SPI port 1. $WIZ$ type = "int"
86 #define CONFIG_SPI1_RXBUFSIZE   32
87
88 /**
89  * SPI data order.
90  *
91  * $WIZ$ type = "enum"
92  * $WIZ$ value_list = "ser_order_bit"
93  * $WIZ$ supports = "avr"
94  */
95 #define CONFIG_SPI_DATA_ORDER   SER_MSB_FIRST
96
97 /**
98  * SPI clock division factor.
99  * $WIZ$ type = "int"
100  * $WIZ$ supports = "avr"
101  */
102 #define CONFIG_SPI_CLOCK_DIV    16
103
104 /**
105  * SPI clock polarity: normal low or normal high.
106  * $WIZ$ type = "enum"
107  * $WIZ$ value_list = "ser_spi_pol"
108  * $WIZ$ supports = "avr"
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.
115  * $WIZ$ type = "enum"
116  * $WIZ$ value_list = "ser_spi_phase"
117  * $WIZ$ supports = "avr"
118  */
119 #define CONFIG_SPI_CLOCK_PHASE      SPI_SAMPLE_ON_FIRST_EDGE
120
121 /// Default transmit timeout (ms). Set to -1 to disable timeout support. $WIZ$ type = "int"
122 #define CONFIG_SER_TXTIMEOUT    -1
123
124 /// Default receive timeout (ms). Set to -1 to disable timeout support. $WIZ$ type = "int"
125 #define CONFIG_SER_RXTIMEOUT    -1
126
127 /// Use RTS/CTS handshake. $WIZ$ type = "boolean"
128 #define CONFIG_SER_HWHANDSHAKE   0
129
130 /// Default baud rate (set to 0 to disable). $WIZ$ type = "boolean"
131 #define CONFIG_SER_DEFBAUDRATE   0
132
133 /// Enable ser_gets() and ser_gets_echo(). $WIZ$ type = "boolean"
134 #define CONFIG_SER_GETS          0
135
136 /// Enable second serial port in emulator. $WIZ$ type = "boolean"
137 #define CONFIG_EMUL_UART1        0
138
139 /// For serial debug. $WIZ$ type = "boolean"
140 #define CONFIG_SER_STROBE        0
141
142 #endif /* CFG_SER_H */