b2524ccbeb1818fe0bbee76935216b20f6d70f57
[rmslog.git] / rmslog / 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  * \author Daniele Basile <asterix@develer.com>
36  */
37
38 #ifndef CFG_SER_H
39 #define CFG_SER_H
40
41 /**
42  * Example of setting for serial port and
43  * spi port.
44  * Edit these define for your project.
45  */
46
47 /**
48  * Size of the outbound FIFO buffer for port 0 [bytes].
49  * $WIZ$ type = "int"
50  * $WIZ$ min = 2
51  */
52 #define CONFIG_UART0_TXBUFSIZE  16
53
54 /**
55  * Size of the inbound FIFO buffer for port 0 [bytes].
56  * $WIZ$ type = "int"
57  * $WIZ$ min = 2
58  */
59 #define CONFIG_UART0_RXBUFSIZE  512
60
61 /**
62  * Size of the outbound FIFO buffer for SPI port [bytes].
63  * $WIZ$ type = "int"
64  * $WIZ$ min = 2
65  * $WIZ$ supports = "avr"
66  */
67 #define CONFIG_SPI_TXBUFSIZE    0
68
69 /**
70  * Size of the inbound FIFO buffer for SPI port [bytes].
71  * $WIZ$ type = "int"
72  * $WIZ$ min = 2
73  * $WIZ$ supports = "avr"
74  */
75 #define CONFIG_SPI_RXBUFSIZE    0
76
77 /**
78  * SPI data order.
79  *
80  * $WIZ$ type = "enum"
81  * $WIZ$ value_list = "ser_order_bit"
82  * $WIZ$ supports = "avr"
83  */
84 #define CONFIG_SPI_DATA_ORDER   SER_MSB_FIRST
85
86 /**
87  * SPI clock division factor.
88  * $WIZ$ type = "int"
89  * $WIZ$ supports = "avr"
90  */
91 #define CONFIG_SPI_CLOCK_DIV    128
92
93 /**
94  * SPI clock polarity: normal low or normal high.
95  * $WIZ$ type = "enum"
96  * $WIZ$ value_list = "ser_spi_pol"
97  * $WIZ$ supports = "avr"
98  */
99 #define CONFIG_SPI_CLOCK_POL        SPI_NORMAL_LOW
100
101 /**
102  * SPI clock phase you can choose sample on first edge or
103  * sample on second clock edge.
104  * $WIZ$ type = "enum"
105  * $WIZ$ value_list = "ser_spi_phase"
106  * $WIZ$ supports = "avr"
107  */
108 #define CONFIG_SPI_CLOCK_PHASE      SPI_SAMPLE_ON_FIRST_EDGE
109
110 /**
111  * Default transmit timeout (ms). Set to -1 to disable timeout support.
112  * $WIZ$ type = "int"
113  * $WIZ$ min = -1
114  */
115 #define CONFIG_SER_TXTIMEOUT    -1
116
117 /**
118  * Default receive timeout (ms). Set to -1 to disable timeout support.
119  * $WIZ$ type = "int"
120  * $WIZ$ min = -1
121  */
122 #define CONFIG_SER_RXTIMEOUT    200
123
124 /**
125  * Use RTS/CTS handshake.
126  * $WIZ$ type = "boolean"
127  * $WIZ$ supports = "False"
128  */
129 #define CONFIG_SER_HWHANDSHAKE   0
130
131 /**
132  * Default baudrate for all serial ports (set to 0 to disable).
133  * $WIZ$ type = "int"
134  * $WIZ$ min = 0
135  */
136 #define CONFIG_SER_DEFBAUDRATE   0UL
137
138 /// Enable strobe pin for debugging serial interrupt. $WIZ$ type = "boolean"
139 #define CONFIG_SER_STROBE        0
140
141 #endif /* CFG_SER_H */