Mercurial > ecos

annotate packages/io/serial/current/include/serialio.h @ 66:bf00f99aec69 ecos-sw-2000-02-02

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
author jlarmour
date Wed, 02 Feb 2000 19:57:02 +0000
parents c38311975d4f
children 435cced73e2f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
1 #ifndef CYGONCE_SERIALIO_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
2 #define CYGONCE_SERIALIO_H
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
3 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
4 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
5 // serialio.h
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
6 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
7 // Device I/O
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
8 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
9 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
10 //####COPYRIGHTBEGIN####
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
11 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
12 // -------------------------------------------
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
13 // The contents of this file are subject to the Red Hat eCos Public License
66
bf00f99aec69 Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents: 64
diff changeset
14 // Version 1.1 (the "License"); you may not use this file except in
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
15 // compliance with the License. You may obtain a copy of the License at
66
bf00f99aec69 Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents: 64
diff changeset
16 // http://www.redhat.com/
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
17 //
66
bf00f99aec69 Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents: 64
diff changeset
18 // Software distributed under the License is distributed on an "AS IS"
64
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
19 // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
20 // License for the specific language governing rights and limitations under
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
21 // the License.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
22 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
23 // The Original Code is eCos - Embedded Configurable Operating System,
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
24 // released September 30, 1998.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
25 //
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
26 // The Initial Developer of the Original Code is Red Hat.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
27 // Portions created by Red Hat are
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
28 // Copyright (C) 1998, 1999, 2000 Red Hat, Inc.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
29 // All Rights Reserved.
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
30 // -------------------------------------------
c38311975d4f Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents: 2
diff changeset
31 //
2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
32 //####COPYRIGHTEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
33 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
34 //#####DESCRIPTIONBEGIN####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
35 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
36 // Author(s): gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
37 // Contributors: gthomas
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
38 // Date: 1999-02-04
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
39 // Purpose: Special support for serial I/O devices
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
40 // Description:
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
41 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
42 //####DESCRIPTIONEND####
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
43 //
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
44 // ====================================================================
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
45
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
46 // This file contains the user-level visible I/O interfaces
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
47
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
48 #include <pkgconf/hal.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
49 #include <cyg/infra/cyg_type.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
50 #include <cyg/io/config_keys.h>
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
51
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
52 #ifdef __cplusplus
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
53 extern "C" {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
54 #endif
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
55
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
56 // Supported baud rates
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
57 typedef enum {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
58 CYGNUM_SERIAL_BAUD_50 = 1,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
59 CYGNUM_SERIAL_BAUD_75,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
60 CYGNUM_SERIAL_BAUD_110,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
61 CYGNUM_SERIAL_BAUD_134_5,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
62 CYGNUM_SERIAL_BAUD_150,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
63 CYGNUM_SERIAL_BAUD_200,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
64 CYGNUM_SERIAL_BAUD_300,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
65 CYGNUM_SERIAL_BAUD_600,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
66 CYGNUM_SERIAL_BAUD_1200,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
67 CYGNUM_SERIAL_BAUD_1800,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
68 CYGNUM_SERIAL_BAUD_2400,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
69 CYGNUM_SERIAL_BAUD_3600,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
70 CYGNUM_SERIAL_BAUD_4800,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
71 CYGNUM_SERIAL_BAUD_7200,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
72 CYGNUM_SERIAL_BAUD_9600,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
73 CYGNUM_SERIAL_BAUD_14400,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
74 CYGNUM_SERIAL_BAUD_19200,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
75 CYGNUM_SERIAL_BAUD_38400,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
76 CYGNUM_SERIAL_BAUD_57600,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
77 CYGNUM_SERIAL_BAUD_115200,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
78 CYGNUM_SERIAL_BAUD_234000
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
79 } cyg_serial_baud_rate_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
80 #define CYGNUM_SERIAL_BAUD_MIN CYGNUM_SERIAL_BAUD_50
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
81 #define CYGNUM_SERIAL_BAUD_MAX CYGNUM_SERIAL_BAUD_234000
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
82
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
83 // Note: two levels of macro are required to get proper expansion.
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
84 #define _CYG_SERIAL_BAUD_RATE(n) CYGNUM_SERIAL_BAUD_##n
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
85 #define CYG_SERIAL_BAUD_RATE(n) _CYG_SERIAL_BAUD_RATE(n)
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
86
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
87 // Stop bit selections
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
88 typedef enum {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
89 CYGNUM_SERIAL_STOP_1 = 1,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
90 CYGNUM_SERIAL_STOP_1_5,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
91 CYGNUM_SERIAL_STOP_2
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
92 } cyg_serial_stop_bits_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
93
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
94 // Parity modes
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
95 typedef enum {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
96 CYGNUM_SERIAL_PARITY_NONE = 0,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
97 CYGNUM_SERIAL_PARITY_EVEN,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
98 CYGNUM_SERIAL_PARITY_ODD,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
99 CYGNUM_SERIAL_PARITY_MARK,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
100 CYGNUM_SERIAL_PARITY_SPACE
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
101 } cyg_serial_parity_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
102
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
103 // Word length
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
104 typedef enum {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
105 CYGNUM_SERIAL_WORD_LENGTH_5 = 5,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
106 CYGNUM_SERIAL_WORD_LENGTH_6,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
107 CYGNUM_SERIAL_WORD_LENGTH_7,
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
108 CYGNUM_SERIAL_WORD_LENGTH_8
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
109 } cyg_serial_word_length_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
110
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
111 typedef struct {
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
112 cyg_serial_baud_rate_t baud;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
113 cyg_serial_stop_bits_t stop;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
114 cyg_serial_parity_t parity;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
115 cyg_serial_word_length_t word_length;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
116 cyg_uint32 flags;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
117 } cyg_serial_info_t;
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
118
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
119 #define CYG_SERIAL_INFO_INIT(_baud,_stop,_parity,_word_length,_flags) \
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
120 { _baud, _stop, _parity, _word_length, _flags}
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
121
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
122 // Control flags
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
123 #define CYG_SERIAL_FLAGS_RTSCTS 0x0001
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
124
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
125 // Default configuration
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
126 #define CYG_SERIAL_BAUD_DEFAULT CYGNUM_SERIAL_BAUD_38400
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
127 #define CYG_SERIAL_STOP_DEFAULT CYGNUM_SERIAL_STOP_1
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
128 #define CYG_SERIAL_PARITY_DEFAULT CYGNUM_SERIAL_PARITY_NONE
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
129 #define CYG_SERIAL_WORD_LENGTH_DEFAULT CYGNUM_SERIAL_WORD_LENGTH_8
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
130 #define CYG_SERIAL_FLAGS_DEFAULT 0
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
131
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
132 #ifdef __cplusplus
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
133 }
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
134 #endif
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
135
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
136 #endif /* CYGONCE_SERIALIO_H */
443894e2e912 Block commit of eCos version 1.2.1
jlarmour
parents:
diff changeset
137 /* EOF serialio.h */