lm3s1968: generic UART driver.
[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 /**
50  * Size of the outbound FIFO buffer for port 0 [bytes].
51  * $WIZ$ type = "int"
52  * $WIZ$ min = 2
53  */
54 #define CONFIG_UART0_TXBUFSIZE  32
55
56 /**
57  * Size of the inbound FIFO buffer for port 0 [bytes].
58  * $WIZ$ type = "int"
59  * $WIZ$ min = 2
60  */
61 #define CONFIG_UART0_RXBUFSIZE  32
62
63 /**
64  * Size of the outbound FIFO buffer for port 1 [bytes].
65  * $WIZ$ type = "int"
66  * $WIZ$ min = 2
67  * $WIZ$ supports = "at91 and not atmega8 and not atmega168 and not atmega32"
68  */
69 #define CONFIG_UART1_TXBUFSIZE  32
70
71 /**
72  * Size of the inbound FIFO buffer for port 1 [bytes].
73  * $WIZ$ type = "int"
74  * $WIZ$ min = 2
75  * $WIZ$ supports = "at91 and not atmega8 and not atmega168 and not atmega32"
76  */
77 #define CONFIG_UART1_RXBUFSIZE  32
78
79 /**
80  * Size of the outbound FIFO buffer for port 2 [bytes].
81  * $WIZ$ type = "int"
82  * $WIZ$ min = 2
83  * $WIZ$ supports = "lm3s"
84  */
85 #define CONFIG_UART2_TXBUFSIZE  32
86
87 /**
88  * Size of the inbound FIFO buffer for port 2 [bytes].
89  * $WIZ$ type = "int"
90  * $WIZ$ min = 2
91  * $WIZ$ supports = "lm3s"
92  */
93 #define CONFIG_UART2_RXBUFSIZE  32
94
95
96 /**
97  * Size of the outbound FIFO buffer for SPI port [bytes].
98  * $WIZ$ type = "int"
99  * $WIZ$ min = 2
100  * $WIZ$ supports = "avr"
101  */
102 #define CONFIG_SPI_TXBUFSIZE    32
103
104 /**
105  * Size of the inbound FIFO buffer for SPI port [bytes].
106  * $WIZ$ type = "int"
107  * $WIZ$ min = 2
108  * $WIZ$ supports = "avr"
109  */
110 #define CONFIG_SPI_RXBUFSIZE    32
111
112 /**
113  * Size of the outbound FIFO buffer for SPI port 0 [bytes].
114  * $WIZ$ type = "int"
115  * $WIZ$ min = 2
116  * $WIZ$ supports = "at91"
117  */
118 #define CONFIG_SPI0_TXBUFSIZE   32
119
120 /**
121  * Size of the inbound FIFO buffer for SPI port 0 [bytes].
122  * $WIZ$ type = "int"
123  * $WIZ$ min = 2
124  * $WIZ$ supports = "at91"
125  */
126 #define CONFIG_SPI0_RXBUFSIZE   32
127
128 /**
129  * Size of the outbound FIFO buffer for SPI port 1 [bytes].
130  * $WIZ$ type = "int"
131  * $WIZ$ min = 2
132  * $WIZ$ supports = "at91"
133  */
134 #define CONFIG_SPI1_TXBUFSIZE   32
135
136 /**
137  * Size of the inbound FIFO buffer for SPI port 1 [bytes].
138  * $WIZ$ type = "int"
139  * $WIZ$ min = 2
140  * $WIZ$ supports = "at91"
141  */
142 #define CONFIG_SPI1_RXBUFSIZE   32
143
144 /**
145  * SPI data order.
146  *
147  * $WIZ$ type = "enum"
148  * $WIZ$ value_list = "ser_order_bit"
149  * $WIZ$ supports = "avr"
150  */
151 #define CONFIG_SPI_DATA_ORDER   SER_MSB_FIRST
152
153 /**
154  * SPI clock division factor.
155  * $WIZ$ type = "int"
156  * $WIZ$ supports = "avr"
157  */
158 #define CONFIG_SPI_CLOCK_DIV    16
159
160 /**
161  * SPI clock polarity: normal low or normal high.
162  * $WIZ$ type = "enum"
163  * $WIZ$ value_list = "ser_spi_pol"
164  * $WIZ$ supports = "avr"
165  */
166 #define CONFIG_SPI_CLOCK_POL        SPI_NORMAL_LOW
167
168 /**
169  * SPI clock phase you can choose sample on first edge or
170  * sample on second clock edge.
171  * $WIZ$ type = "enum"
172  * $WIZ$ value_list = "ser_spi_phase"
173  * $WIZ$ supports = "avr"
174  */
175 #define CONFIG_SPI_CLOCK_PHASE      SPI_SAMPLE_ON_FIRST_EDGE
176
177 /**
178  * Default transmit timeout (ms). Set to -1 to disable timeout support.
179  * $WIZ$ type = "int"
180  * $WIZ$ min = -1
181  */
182 #define CONFIG_SER_TXTIMEOUT    -1
183
184 /**
185  * Default receive timeout (ms). Set to -1 to disable timeout support.
186  * $WIZ$ type = "int"
187  * $WIZ$ min = -1
188  */
189 #define CONFIG_SER_RXTIMEOUT    -1
190
191 /**
192  * Use RTS/CTS handshake.
193  * $WIZ$ type = "boolean"
194  * $WIZ$ supports = "False"
195  */
196 #define CONFIG_SER_HWHANDSHAKE   0
197
198 /**
199  * Default baudrate for all serial ports (set to 0 to disable).
200  * $WIZ$ type = "int"
201  * $WIZ$ min = 0
202  */
203 #define CONFIG_SER_DEFBAUDRATE   0UL
204
205 /// Enable strobe pin for debugging serial interrupt. $WIZ$ type = "boolean"
206 #define CONFIG_SER_STROBE        0
207
208 #endif /* CFG_SER_H */