1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/********************************************************************************************
* include/nuttx/serial/tioctl.h
*
* Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
********************************************************************************************/
/* This function should not be included directly. Rather, it should be included indirectly
* via include/nuttx/fs/ioctl.h.
*/
#ifndef __INCLUDE_NUTTX_SERIAL_TIOCTL_H
#define __INCLUDE_NUTTX_SERIAL_TIOCTL_H
/********************************************************************************************
* Included Files
********************************************************************************************/
#include <stdint.h>
/********************************************************************************************
* Pre-Processor Definitions
********************************************************************************************/
/* Get and Set Terminal Attributes (see termios.h) */
#define TCGETS _TIOC(0x0001) /* Get serial port settings: FAR struct termios* */
#define TCSETS _TIOC(0x0002) /* Set serial port settings: FAR const struct termios* */
#define TCSETSW _TIOC(0x0003) /* Drain output and set serial port settings: FAR const struct termios* */
#define TCSETSF _TIOC(0x0004) /* Drain output, discard intput, and set serial port settings: FAR const struct termios* */
#define TCGETA _TIOC(0x0005) /* See TCGETS: FAR struct termio* */
#define TCSETA _TIOC(0x0006) /* See TCSETS: FAR const struct termio* */
#define TCSETAW _TIOC(0x0007) /* See TCSETSF: FAR const struct termio* */
#define TCSETAF _TIOC(0x0008) /* See TCSETSF: FAR const struct termio* */
/* Locking the termios structure */
#define TIOCGLCKTRMIOS _TIOC(0x0009) /* Get termios lock status: FAR struct termios* */
#define TIOCSLCKTRMIOS _TIOC(0x000a) /* Set termios lock status: FAR const struct termios* */
/* Get and Set Window Size */
#define TIOCGWINSZ _TIOC(0x000b) /* Get window size: FAR struct winsize */
#define TIOCSWINSZ _TIOC(0x000c) /* Set window size: FAR const struct winsize */
/* Send a break */
#define TCSBRK _TIOC(0x000d) /* Send a break: int */
#define TCSBRKP _TIOC(0x000e) /* Send a POSIX break: int */
#define TIOCSBRK _TIOC(0x000f) /* Turn break on: void */
#define TIOCCBRK _TIOC(0x0010) /* Turn break off: void */
/* Software flow control */
#define TCXONC _TIOC(0x0011) /* Control flow control: int */
/* Buffer count and flushing */
#define TIOCINQ _TIOC(0x0012) /* Bytes in input buffer: int */
#define TIOCOUTQ _TIOC(0x0013) /* Bytes in output buffer: int */
#define TCFLSH _TIOC(0x0014) /* Flush: int */
/* Faking input */
#define TIOCSTI _TIOC(0x0015) /* Insert into input: const char */
/* Re-directing console output */
#define TIOCCONS _TIOC(0x0016) /* Re-direct console output to device: void */
/* Controlling TTY */
#define TIOCSCTTY _TIOC(0x0017) /* Make controlling TTY: int */
#define TIOCNOTTY _TIOC(0x0018) /* Give up controllinog TTY: void */
/* Exclusive mode */
#define TIOCEXCL _TIOC(0x0019) /* Put TTY in exclusive mode: void */
#define TIOCNXCL _TIOC(0x001a) /* Disable exclusive mode: void */
/* Line discipline */
#define TIOCGETD _TIOC(0x001b) /* Get line discipline: FAR int */
#define TIOCSETD _TIOC(0x001c) /* Set line discipline: FAR const int */
/* Packet mode */
#define TIOCPKT _TIOC(0x001d) /* Control packet mode: FAR const int */
# define TIOCPKT_FLUSHREAD (1 << 0) /* The read queue for the terminal is flushed */
# define TIOCPKT_FLUSHWRITE (1 << 1) /* The write queue for the terminal is flushed */
# define TIOCPKT_STOP (1 << 2) /* Output to the terminal is stopped */
# define TIOCPKT_START (1 << 3) /* Output to the terminal is restarted */
# define TIOCPKT_DOSTOP (1 << 4) /* t_stopc is '^S' and t_startc is '^Q' */
# define TIOCPKT_NOSTOP (1 << 5) /* The start and stop characters are not '^S/^Q' */
/* Modem control */
#define TIOCMGET _TIOC(0x001e) /* Get modem status bits: FAR int */
#define TIOCMSET _TIOC(0x001f) /* Set modem status bits: FAR const int */
#define TIOCMBIC _TIOC(0x0020) /* Clear modem bits: FAR const int */
#define TIOCMBIS _TIOC(0x0021) /* Set modem bits: FAR const int */
# define TIOCM_LE (1 << 0) /* DSR (data set ready/line enable) */
# define TIOCM_DTR (1 << 1) /* DTR (data terminal ready) */
# define TIOCM_RTS (1 << 2) /* RTS (request to send) */
# define TIOCM_ST (1 << 3) /* Secondary TXD (transmit) */
# define TIOCM_SR (1 << 4) /* Secondary RXD (receive) */
# define TIOCM_CTS (1 << 5) /* CTS (clear to send) */
# define TIOCM_CAR (1 << 6) /* DCD (data carrier detect) */
# define TIOCM_CD TIOCM_CAR
# define TIOCM_RNG (1 << 7) /* RNG (ring) */
# define TIOCM_RI TIOCM_RNG
# define TIOCM_DSR (1 << 8) /* DSR (data set ready) */
/* TTY shutdown */
#define TIOCVHANGUP _TIOC(0x0022) /* Shutdown TTY: void */
/* Marking a line as local */
#define TIOCGSOFTCAR _TIOC(0x0023) /* Get software carrier flag: FAR int */
#define TIOCSSOFTCAR _TIOC(0x0024) /* Set software carrier flag: FAR const int */
/* Get/set serial line info */
#define TIOCGSERIAL _TIOC(0x0025) /* Get serial line info: FAR struct serial_struct */
#define TIOCSSERIAL _TIOC(0x0026) /* Set serial line info: FAR const struct serial_struct */
#define TIOCSERGETLSR _TIOC(0x0027) /* Get line status register: FAR int */
/* Serial events */
#define TIOCMIWAIT _TIOC(0x0028) /* Wait for a change on serial input line(s): void */
#define TIOCGICOUNT _TIOC(0x0029) /* Read serial port interrupt count: FAR struct serial_icounter_struct */
/* RS-485 Support */
#define TIOCSRS485 _TIOC(0x002a) /* Set RS485 mode, arg: pointer to struct serial_rs485 */
#define TIOCGRS485 _TIOC(0x002b) /* Get RS485 mode, arg: pointer to struct serial_rs485 */
/* Debugging */
#define TIOCSERGSTRUCT _TIOC(0x002c) /* Get device TTY structure */
/* Definitions used in struct serial_rs485 (Linux compatible) */
#define SER_RS485_ENABLED (1 << 0) /* Enable/disble RS-485 support */
#define SER_RS485_RTS_ON_SEND (1 << 1) /* Logic level for RTS pin when sending */
#define SER_RS485_RTS_AFTER_SEND (1 << 2) /* Logic level for RTS pin after sent */
#define SER_RS485_RX_DURING_TX (1 << 4)
/********************************************************************************************
* Public Type Definitions
********************************************************************************************/
/* Used with TTY ioctls */
struct winsize
{
uint16_t ws_row;
uint16_t ws_col;
/* uint16_t ws_xpixel; unused */
/* uint16_t ws_ypixel; unused */
};
/* Structure used with TIOCSRS485 and TIOCGRS485 (Linux compatible) */
struct serial_rs485
{
uint32_t flags; /* See SER_RS485_* definitions */
uint32_t delay_rts_before_send; /* Delay before send (milliseconds) */
uint32_t delay_rts_after_send; /* Delay after send (milliseconds) */
};
/********************************************************************************************
* Public Function Prototypes
********************************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_NUTTX_SERIAL_TIOCTL_H */
|
