xref: /DragonOS/kernel/src/driver/tty/termios.rs (revision 4b0170bd6bb374d0e9699a0076cc23b976ad6db7)
1 use super::tty_ldisc::LineDisciplineType;
2 
3 /// ## 窗口大小
4 #[repr(C)]
5 #[derive(Debug, Default, Clone, Copy)]
6 pub struct WindowSize {
7     /// 行
8     pub row: u16,
9     /// 列
10     pub col: u16,
11     /// x方向像素数
12     pub xpixel: u16,
13     /// y方向像素数
14     pub ypixel: u16,
15 }
16 
17 #[derive(Debug, Clone, Copy)]
18 pub struct Termios {
19     pub input_mode: InputMode,
20     pub output_mode: OutputMode,
21     pub control_mode: ControlMode,
22     pub local_mode: LocalMode,
23     pub control_characters: [u8; CONTORL_CHARACTER_NUM],
24     pub line: LineDisciplineType,
25     pub input_speed: u32,
26     pub output_speed: u32,
27 }
28 
29 #[derive(Clone, Copy, Default)]
30 pub struct PosixTermios {
31     pub c_iflag: u32,
32     pub c_oflag: u32,
33     pub c_cflag: u32,
34     pub c_lflag: u32,
35     pub c_cc: [u8; CONTORL_CHARACTER_NUM],
36     pub c_line: u8,
37     pub c_ispeed: u32,
38     pub c_ospeed: u32,
39 }
40 
41 impl PosixTermios {
42     pub fn from_kernel_termios(termios: Termios) -> Self {
43         Self {
44             c_iflag: termios.input_mode.bits,
45             c_oflag: termios.output_mode.bits,
46             c_cflag: termios.control_mode.bits,
47             c_lflag: termios.local_mode.bits,
48             c_cc: termios.control_characters,
49             c_line: termios.line as u8,
50             c_ispeed: termios.input_speed,
51             c_ospeed: termios.output_speed,
52         }
53     }
54 
55     #[allow(dead_code)]
56     pub fn to_kernel_termios(self) -> Termios {
57         // TODO:这里没有考虑非规范模式
58         Termios {
59             input_mode: InputMode::from_bits_truncate(self.c_iflag),
60             output_mode: OutputMode::from_bits_truncate(self.c_oflag),
61             control_mode: ControlMode::from_bits_truncate(self.c_cflag),
62             local_mode: LocalMode::from_bits_truncate(self.c_lflag),
63             control_characters: self.c_cc,
64             line: LineDisciplineType::from_line(self.c_line),
65             input_speed: self.c_ispeed,
66             output_speed: self.c_ospeed,
67         }
68     }
69 }
70 
71 pub const INIT_CONTORL_CHARACTERS: [u8; CONTORL_CHARACTER_NUM] = [
72     b'C' - 0x40,  // VINTR
73     b'\\' - 0x40, // VQUIT
74     0o177,        // VERASE
75     b'U' - 0x40,  // VKILL
76     b'D' - 0x40,  // VEOF
77     1,            // VMIN
78     0,            // VEOL
79     0,            // VTIME
80     0,            // VEOL2
81     0,            // VSWTC
82     b'W' - 0x40,  // VWERASE
83     b'R' - 0x40,  // VREPRINT
84     b'Z' - 0x40,  // VSUSP
85     b'Q' - 0x40,  // VSTART
86     b'S' - 0x40,  // VSTOP
87     b'V' - 0x40,  // VLNEXT
88     b'O' - 0x40,  // VDISCARD
89     0,
90     0,
91 ];
92 
93 // pub const INIT_CONTORL_CHARACTERS: [u8; CONTORL_CHARACTER_NUM] = {
94 //     let mut chs: [u8; CONTORL_CHARACTER_NUM] = Default::default();
95 //     chs[ControlCharIndex::VINTR] = b'C' - 0x40;
96 //     chs[ControlCharIndex::VQUIT] = b'\\' - 0x40;
97 //     chs[ControlCharIndex::VERASE] = 0o177;
98 //     chs[ControlCharIndex::VKILL] = b'U' - 0x40;
99 //     chs[ControlCharIndex::VEOF] = b'D' - 0x40;
100 //     chs[ControlCharIndex::VSTART] = b'Q' - 0x40;
101 //     chs[ControlCharIndex::VSTOP] = b'S' - 0x40;
102 //     chs[ControlCharIndex::VSUSP] = b'Z' - 0x40;
103 //     chs[ControlCharIndex::VREPRINT] = b'R' - 0x40;
104 //     chs[ControlCharIndex::VDISCARD] = b'O' - 0x40;
105 //     chs[ControlCharIndex::VWERASE] = b'W' - 0x40;
106 //     chs[ControlCharIndex::VLNEXT] = b'V' - 0x40;
107 //     // chs[ContorlCharIndex::VDSUSP] = b'Y'  - 0x40;
108 //     chs[ControlCharIndex::VMIN] = 1;
109 //     return chs;
110 // };
111 
112 lazy_static! {
113     pub static ref TTY_STD_TERMIOS: Termios = {
114         Termios {
115             input_mode: InputMode::ICRNL | InputMode::IXON,
116             output_mode: OutputMode::OPOST | OutputMode::ONLCR,
117             control_mode: ControlMode::B38400
118                 | ControlMode::CREAD
119                 | ControlMode::HUPCL
120                 | ControlMode::CS8,
121             local_mode: LocalMode::ISIG
122                 | LocalMode::ICANON
123                 | LocalMode::ECHO
124                 | LocalMode::ECHOE
125                 | LocalMode::ECHOK
126                 | LocalMode::ECHOCTL
127                 | LocalMode::ECHOKE
128                 | LocalMode::IEXTEN,
129             control_characters: INIT_CONTORL_CHARACTERS,
130             line: LineDisciplineType::NTty,
131             input_speed: 38400,
132             output_speed: 38400,
133         }
134     };
135 }
136 
137 pub const CONTORL_CHARACTER_NUM: usize = 19;
138 
139 bitflags! {
140     /// termios输入特性
141     pub struct InputMode: u32 {
142         /// 如果设置了该标志,表示启用软件流控制。
143         const IXON = 0x0400;
144         /// 如果设置了该标志,表示启用输入流控制。
145         const IXOFF = 0x1000;
146         /// Map Uppercase to Lowercase on Input 将大写转换为小写
147         /// 表示不区分大小写
148         const IUCLC = 0x0200;
149         /// 如果设置了该标志,表示当输入队列满时,产生一个响铃信号。
150         const IMAXBEL = 0x2000;
151         /// 如果设置了该标志,表示输入数据被视为 UTF-8 编码。
152         const IUTF8 = 0x4000;
153 
154         /// 忽略中断信号
155         const IGNBRK	= 0x001;
156         /// 检测到中断信号时生成中断(产生中断信号)
157         const BRKINT	= 0x002;
158         /// 忽略具有奇偶校验错误的字符
159         const IGNPAR	= 0x004;
160         /// 在检测到奇偶校验错误或帧错误时,将字符以 \377 标记
161         const PARMRK	= 0x008;
162         /// 启用输入奇偶校验检查
163         const INPCK	= 0x010;
164         /// 从输入字符中剥离第 8 位,即只保留低 7 位
165         const ISTRIP	= 0x020;
166         /// 表示将输入的换行符 (\n) 映射为回车符 (\r)
167         const INLCR	= 0x040;
168         /// 表示忽略回车符 (\r)
169         const IGNCR	= 0x080;
170         /// 表示将输入的回车符 (\r) 映射为换行符 (\n)
171         const ICRNL	= 0x100;
172         /// 表示在输入被停止(Ctrl-S)后,任何字符的输入都将重新启动输入
173         const IXANY	= 0x800;
174     }
175 
176     /// termios输出特性
177     pub struct OutputMode: u32 {
178         /// 在输出时将换行符替换\r\n
179         const ONLCR	= 0x00004;
180         /// Map Lowercase to Uppercase on Output 输出字符时将小写字母映射为大写字母
181         const OLCUC	= 0x00002;
182 
183         /// 与NL协同 配置换行符的处理方式
184         const NLDLY	= 0x00100;
185         const   NL0	= 0x00000;  // 不延迟换行
186         const   NL1	= 0x00100;  // 延迟换行(输出回车后等待一段时间再输出换行)
187 
188         /// 配置水平制表符的处理方式
189         const TABDLY = 0x01800;
190         const  TAB0 = 0x00000;  // 不延迟水平制表符
191         const  TAB1 = 0x00800;  // 在输出水平制表符时,延迟到下一个设置的水平制表符位置
192         const  TAB2 = 0x01000;  // 在输出水平制表符时,延迟到下一个设置的 8 的倍数的位置
193         const  TAB3 = 0x01800;  // TAB3 和 XTABS(与 TAB3 等效)保留,暂未使用
194         const XTABS = 0x01800;
195 
196         /// 配置回车符的处理方式
197         const CRDLY	= 0x00600;
198         const   CR0	= 0x00000;  // 不延迟回车
199         const   CR1	= 0x02000;  //  延迟回车(输出回车后等待一段时间再输出换行)
200         const   CR2	= 0x04000;  // CR2 和 CR3保留,暂未使用
201         const   CR3	= 0x06000;
202 
203         /// 配置换页符(form feed)的处理方式
204         const FFDLY	= 0x08000;
205         const   FF0	= 0x00000;  // 不延迟换页
206         const   FF1	= 0x08000;  // 延迟换页
207 
208         /// 配置退格符(backspace)的处理方式
209         const BSDLY	= 0x02000;
210         const   BS0	= 0x00000;  // 不延迟退格
211         const   BS1	= 0x02000;  // 延迟退格
212 
213         /// 配置垂直制表符(vertical tab)的处理方式
214         const VTDLY	= 0x04000;
215         const   VT0	= 0x00000;  // 不延迟垂直制表符
216         const   VT1	= 0x04000;  // 延迟垂直制表符
217 
218         /// 表示执行输出处理,即启用输出处理函数
219         const OPOST	= 0x01;
220         /// 表示将输出的回车符 (\r) 映射为换行符 (\n)
221         const OCRNL	= 0x08;
222         /// 表示在输出时,如果光标在第 0 列,则不输出回车符 (\r)
223         const ONOCR	= 0x10;
224         /// 表示将回车符 (\r) 映射为换行符 (\n)
225         const ONLRET	= 0x20;
226         /// 表示使用填充字符进行延迟。这个填充字符的默认值是空格。
227         const OFILL	= 0x40;
228         /// 表示使用删除字符 (DEL, \177) 作为填充字符
229         const OFDEL	= 0x80;
230     }
231 
232     /// 配置终端设备的基本特性和控制参数
233     pub struct ControlMode: u32 {
234         /// Baud Rate Mask 指定波特率的掩码
235         const CBAUD		= 0x0000100f;
236         /// Extra Baud Bits 指定更高的波特率位
237         const CBAUDEX	= 0x00001000;
238         /// Custom Baud Rate 指定自定义波特率 如果设置了 BOTHER,则通过以下位来设置自定义的波特率值
239         const BOTHER	= 0x00001000;
240 
241         /* Common CBAUD rates */
242         const     B0	= 0x00000000;	/* hang up */
243         const    B50	= 0x00000001;
244         const    B75	= 0x00000002;
245         const   B110	= 0x00000003;
246         const   B134	= 0x00000004;
247         const   B150	= 0x00000005;
248         const   B200	= 0x00000006;
249         const   B300	= 0x00000007;
250         const   B600	= 0x00000008;
251         const  B1200	= 0x00000009;
252         const  B1800	= 0x0000000a;
253         const  B2400	= 0x0000000b;
254         const  B4800	= 0x0000000c;
255         const  B9600	= 0x0000000d;
256         const B19200	= 0x0000000e;
257         const B38400	= 0x0000000f;
258 
259         const     B57600 = 0x00001001;
260         const    B115200 = 0x00001002;
261         const    B230400 = 0x00001003;
262         const    B460800 = 0x00001004;
263         const    B500000 = 0x00001005;
264         const    B576000 = 0x00001006;
265         const    B921600 = 0x00001007;
266         const   B1000000 = 0x00001008;
267         const   B1152000 = 0x00001009;
268         const   B1500000 = 0x0000100a;
269         const   B2000000 = 0x0000100b;
270         const   B2500000 = 0x0000100c;
271         const   B3000000 = 0x0000100d;
272         const   B3500000 = 0x0000100e;
273         const   B4000000 = 0x0000100f;
274 
275         /// 指定字符大小的掩码 以下位为特定字符大小
276         const CSIZE		= 0x00000030;
277         const   CS5		= 0x00000000;
278         const   CS6		= 0x00000010;
279         const   CS7		= 0x00000020;
280         const   CS8		= 0x00000030;
281 
282         /// Stop Bit Select 表示使用两个停止位;否则,表示使用一个停止位
283         const CSTOPB	= 0x00000040;
284         /// 表示启用接收器。如果未设置,则禁用接收器。
285         const CREAD		= 0x00000080;
286         /// 表示启用奇偶校验。如果未设置,则禁用奇偶校验。
287         const PARENB	= 0x00000100;
288         /// 表示启用奇校验。如果未设置,则表示启用偶校验。
289         const PARODD	= 0x00000200;
290         /// 表示在终端设备被关闭时挂断线路(执行挂断操作)
291         const HUPCL		= 0x00000400;
292         /// 表示忽略调制解调器的状态(DCD、DSR、CTS 等)
293         const CLOCAL	= 0x00000800;
294         /// 指定输入波特率的掩码
295         const CIBAUD	= 0x100f0000;
296 
297         const ADDRB = 0x20000000;
298     }
299 
300     /// 配置终端设备的本地模式(local mode)或控制输入处理的行为
301     pub struct LocalMode: u32 {
302         /// 启用中断字符(Ctrl-C、Ctrl-Z)
303         const ISIG	 = 0x00001;
304         /// 表示启用规范模式,即启用行缓冲和回显。在规范模式下,输入被缓冲,并且只有在输入回车符时才会传递给应用程序。
305         const ICANON = 0x00002;
306         /// 表示启用大写模式,即输入输出都将被转换为大写。
307         const XCASE	 = 0x00004;
308         /// 表示启用回显(显示用户输入的字符)
309         const ECHO	 = 0x00008;
310         /// 表示在回显时将擦除的字符用 backspace 和空格字符显示。
311         const ECHOE	 = 0x00010;
312         /// 表示在回显时将换行符后的字符用空格字符显示。
313         const ECHOK	 = 0x00020;
314         /// 表示在回显时将换行符显示为换行和回车符。
315         const ECHONL = 0x00040;
316         /// 表示在收到中断(Ctrl-C)和退出(Ctrl-\)字符后,不清空输入和输出缓冲区。
317         const NOFLSH = 0x00080;
318         /// 表示在后台进程尝试写入终端时,发送停止信号(Ctrl-S)
319         const TOSTOP = 0x00100;
320         /// 表示在回显时,显示控制字符为 ^ 加字符。
321         const ECHOCTL= 0x00200;
322         /// 表示在回显时显示带有 # 的换行符(为了与 echo -n 命令兼容)。
323         const ECHOPRT= 0x00400;
324         /// 表示在回显时将 KILL 字符(Ctrl-U)用空格字符显示。
325         const ECHOKE = 0x00800;
326         /// 表示输出正在被冲刷(flush),通常是由于输入/输出流的状态变化。
327         const FLUSHO = 0x01000;
328         /// 表示在规范模式下,存在需要重新打印的字符。
329         const PENDIN = 0x04000;
330         /// 表示启用实现定义的输入处理。
331         const IEXTEN = 0x08000;
332         /// 表示启用扩展的处理函数
333         const EXTPROC= 0x10000;
334     }
335 
336     pub struct TtySetTermiosOpt: u8 {
337         const TERMIOS_FLUSH	=1;
338         const TERMIOS_WAIT	=2;
339         const TERMIOS_TERMIO	=4;
340         const TERMIOS_OLD	=8;
341     }
342 }
343 
344 /// 对应termios中控制字符的索引
345 pub struct ControlCharIndex;
346 #[allow(dead_code)]
347 impl ControlCharIndex {
348     pub const DISABLE_CHAR: u8 = b'\0';
349     /// 中断信号
350     pub const VINTR: usize = 0;
351     /// 退出信号
352     pub const VQUIT: usize = 1;
353     /// 退格
354     pub const VERASE: usize = 2;
355     /// 终止输入信号
356     pub const VKILL: usize = 3;
357     /// 文件结束信号 \0?
358     pub const VEOF: usize = 4;
359     /// 指定非规范模式下的最小字符数
360     pub const VMIN: usize = 5;
361     /// 换行符
362     pub const VEOL: usize = 6;
363     /// 指定非规范模式下的超时时间
364     pub const VTIME: usize = 7;
365     /// 换行符
366     pub const VEOL2: usize = 8;
367     /// 未使用,保留
368     pub const VSWTC: usize = 9;
369     /// 擦除前一个单词
370     pub const VWERASE: usize = 10;
371     /// 重新打印整行
372     pub const VREPRINT: usize = 11;
373     /// 挂起信号
374     pub const VSUSP: usize = 12;
375     /// 启动输出信号
376     pub const VSTART: usize = 13;
377     /// 停止输出信号
378     pub const VSTOP: usize = 14;
379     /// 将下一个字符视为字面值,而不是特殊字符
380     pub const VLNEXT: usize = 15;
381     /// 对应于字符丢弃信号,用于丢弃当前输入的行
382     pub const VDISCARD: usize = 16;
383 }
384