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