xref: /linux/drivers/tty/Kconfig (revision 995832b2cebe6969d1b42635db698803ee31294d)
1# SPDX-License-Identifier: GPL-2.0
2config TTY
3	bool "Enable TTY" if EXPERT
4	default y
5	help
6	  Allows you to remove TTY support which can save space, and
7	  blocks features that require TTY from inclusion in the kernel.
8	  TTY is required for any text terminals or serial port
9	  communication. Most users should leave this enabled.
10
11if TTY
12
13config VT
14	bool "Virtual terminal" if EXPERT
15	select INPUT
16	default y if !UML
17	help
18	  If you say Y here, you will get support for terminal devices with
19	  display and keyboard devices. These are called "virtual" because you
20	  can run several virtual terminals (also called virtual consoles) on
21	  one physical terminal. This is rather useful, for example one
22	  virtual terminal can collect system messages and warnings, another
23	  one can be used for a text-mode user session, and a third could run
24	  an X session, all in parallel. Switching between virtual terminals
25	  is done with certain key combinations, usually Alt-<function key>.
26
27	  The setterm command ("man setterm") can be used to change the
28	  properties (such as colors or beeping) of a virtual terminal. The
29	  man page console_codes(4) ("man console_codes") contains the special
30	  character sequences that can be used to change those properties
31	  directly. The fonts used on virtual terminals can be changed with
32	  the setfont ("man setfont") command and the key bindings are defined
33	  with the loadkeys ("man loadkeys") command.
34
35	  You need at least one virtual terminal device in order to make use
36	  of your keyboard and monitor. Therefore, only people configuring an
37	  embedded system would want to say N here in order to save some
38	  memory; the only way to log into such a system is then via a serial
39	  or network connection.
40
41	  If unsure, say Y, or else you won't be able to do much with your new
42	  shiny Linux system :-)
43
44config CONSOLE_TRANSLATIONS
45	depends on VT
46	default y
47	bool "Enable character translations in console" if EXPERT
48	help
49	  This enables support for font mapping and Unicode translation
50	  on virtual consoles.
51
52config VT_CONSOLE
53	bool "Support for console on virtual terminal" if EXPERT
54	depends on VT
55	default y
56	help
57	  The system console is the device which receives all kernel messages
58	  and warnings and which allows logins in single user mode. If you
59	  answer Y here, a virtual terminal (the device used to interact with
60	  a physical terminal) can be used as system console. This is the most
61	  common mode of operations, so you should say Y here unless you want
62	  the kernel messages be output only to a serial port (in which case
63	  you should say Y to "Console on serial port", below).
64
65	  If you do say Y here, by default the currently visible virtual
66	  terminal (/dev/tty0) will be used as system console. You can change
67	  that with a kernel command line option such as "console=tty3" which
68	  would use the third virtual terminal as system console. (Try "man
69	  bootparam" or see the documentation of your boot loader (lilo or
70	  loadlin) about how to pass options to the kernel at boot time.)
71
72	  If unsure, say Y.
73
74config VT_CONSOLE_SLEEP
75	def_bool y
76	depends on VT_CONSOLE && PM_SLEEP
77
78config VT_HW_CONSOLE_BINDING
79	bool "Support for binding and unbinding console drivers"
80	depends on VT
81	help
82	  The virtual terminal is the device that interacts with the physical
83	  terminal through console drivers. On these systems, at least one
84	  console driver is loaded. In other configurations, additional console
85	  drivers may be enabled, such as the framebuffer console. If more than
86	  1 console driver is enabled, setting this to 'y' will allow you to
87	  select the console driver that will serve as the backend for the
88	  virtual terminals.
89
90	  See <file:Documentation/driver-api/console.rst> for more
91	  information. For framebuffer console users, please refer to
92	  <file:Documentation/fb/fbcon.rst>.
93
94config UNIX98_PTYS
95	bool "Unix98 PTY support" if EXPERT
96	default y
97	help
98	  A pseudo terminal (PTY) is a software device consisting of two
99	  halves: a master and a slave. The slave device behaves identical to
100	  a physical terminal; the master device is used by a process to
101	  read data from and write data to the slave, thereby emulating a
102	  terminal. Typical programs for the master side are telnet servers
103	  and xterms.
104
105	  Linux has traditionally used the BSD-like names /dev/ptyxx for
106	  masters and /dev/ttyxx for slaves of pseudo terminals. This scheme
107	  has a number of problems. The GNU C library glibc 2.1 and later,
108	  however, supports the Unix98 naming standard: in order to acquire a
109	  pseudo terminal, a process opens /dev/ptmx; the number of the pseudo
110	  terminal is then made available to the process and the pseudo
111	  terminal slave can be accessed as /dev/pts/<number>. What was
112	  traditionally /dev/ttyp2 will then be /dev/pts/2, for example.
113
114	  All modern Linux systems use the Unix98 ptys.  Say Y unless
115	  you're on an embedded system and want to conserve memory.
116
117config LEGACY_PTYS
118	bool "Legacy (BSD) PTY support"
119	default y
120	help
121	  A pseudo terminal (PTY) is a software device consisting of two
122	  halves: a master and a slave. The slave device behaves identical to
123	  a physical terminal; the master device is used by a process to
124	  read data from and write data to the slave, thereby emulating a
125	  terminal. Typical programs for the master side are telnet servers
126	  and xterms.
127
128	  Linux has traditionally used the BSD-like names /dev/ptyxx
129	  for masters and /dev/ttyxx for slaves of pseudo
130	  terminals. This scheme has a number of problems, including
131	  security.  This option enables these legacy devices; on most
132	  systems, it is safe to say N.
133
134config LEGACY_PTY_COUNT
135	int "Maximum number of legacy PTY in use"
136	depends on LEGACY_PTYS
137	range 0 256
138	default "256"
139	help
140	  The maximum number of legacy PTYs that can be used at any one time.
141	  The default is 256, and should be more than enough.  Embedded
142	  systems may want to reduce this to save memory.
143
144	  When not in use, each legacy PTY occupies 12 bytes on 32-bit
145	  architectures and 24 bytes on 64-bit architectures.
146
147config LEGACY_TIOCSTI
148	bool "Allow legacy TIOCSTI usage"
149	default y
150	help
151	  Historically the kernel has allowed TIOCSTI, which will push
152	  characters into a controlling TTY. This continues to be used
153	  as a malicious privilege escalation mechanism, and provides no
154	  meaningful real-world utility any more. Its use is considered
155	  a dangerous legacy operation, and can be disabled on most
156	  systems.
157
158	  Say Y here only if you have confirmed that your system's
159	  userspace depends on this functionality to continue operating
160	  normally.
161
162	  Processes which run with CAP_SYS_ADMIN, such as BRLTTY, can
163	  use TIOCSTI even when this is set to N.
164
165	  This functionality can be changed at runtime with the
166	  dev.tty.legacy_tiocsti sysctl. This configuration option sets
167	  the default value of the sysctl.
168
169config LDISC_AUTOLOAD
170	bool "Automatically load TTY Line Disciplines"
171	default y
172	help
173	  Historically the kernel has always automatically loaded any
174	  line discipline that is in a kernel module when a user asks
175	  for it to be loaded with the TIOCSETD ioctl, or through other
176	  means.  This is not always the best thing to do on systems
177	  where you know you will not be using some of the more
178	  "ancient" line disciplines, so prevent the kernel from doing
179	  this unless the request is coming from a process with the
180	  CAP_SYS_MODULE permissions.
181
182	  Say 'Y' here if you trust your userspace users to do the right
183	  thing, or if you have only provided the line disciplines that
184	  you know you will be using, or if you wish to continue to use
185	  the traditional method of on-demand loading of these modules
186	  by any user.
187
188	  This functionality can be changed at runtime with the
189	  dev.tty.ldisc_autoload sysctl, this configuration option will
190	  only set the default value of this functionality.
191
192source "drivers/tty/serial/Kconfig"
193
194config SERIAL_NONSTANDARD
195	bool "Non-standard serial port support"
196	depends on HAS_IOMEM
197	help
198	  Say Y here if you have any non-standard serial boards -- boards
199	  which aren't supported using the standard "dumb" serial driver.
200	  This includes intelligent serial boards such as
201	  Digiboards, etc. These are usually used for systems that need many
202	  serial ports because they serve many terminals or dial-in
203	  connections.
204
205	  Note that the answer to this question won't directly affect the
206	  kernel: saying N will just cause the configurator to skip all
207	  the questions about non-standard serial boards.
208
209	  Most people can say N here.
210
211config MOXA_INTELLIO
212	tristate "Moxa Intellio support"
213	depends on SERIAL_NONSTANDARD && PCI
214	select FW_LOADER
215	help
216	  Say Y here if you have a Moxa Intellio multiport serial card.
217
218	  To compile this driver as a module, choose M here: the
219	  module will be called moxa.
220
221config MOXA_SMARTIO
222	tristate "Moxa SmartIO support v. 2.0"
223	depends on SERIAL_NONSTANDARD && PCI && HAS_IOPORT
224	help
225	  Say Y here if you have a Moxa SmartIO multiport serial card and/or
226	  want to help develop a new version of this driver.
227
228	  This is upgraded (1.9.1) driver from original Moxa drivers with
229	  changes finally resulting in PCI probing.
230
231	  This driver can also be built as a module. The module will be called
232	  mxser. If you want to do that, say M here.
233
234config N_HDLC
235	tristate "HDLC line discipline support"
236	depends on SERIAL_NONSTANDARD
237	help
238	  Allows synchronous HDLC communications with tty device drivers that
239	  support synchronous HDLC.
240
241	  This driver can be built as a module ( = code which can be
242	  inserted in and removed from the running kernel whenever you want).
243	  The module will be called n_hdlc. If you want to do that, say M
244	  here.
245
246config PPC_EPAPR_HV_BYTECHAN
247	bool "ePAPR hypervisor byte channel driver"
248	depends on PPC
249	select EPAPR_PARAVIRT
250	help
251	  This driver creates /dev entries for each ePAPR hypervisor byte
252	  channel, thereby allowing applications to communicate with byte
253	  channels as if they were serial ports.
254
255config PPC_EARLY_DEBUG_EHV_BC
256	bool "Early console (udbg) support for ePAPR hypervisors"
257	depends on PPC_EPAPR_HV_BYTECHAN=y
258	help
259	  Select this option to enable early console (a.k.a. "udbg") support
260	  via an ePAPR byte channel.  You also need to choose the byte channel
261	  handle below.
262
263config PPC_EARLY_DEBUG_EHV_BC_HANDLE
264	int "Byte channel handle for early console (udbg)"
265	depends on PPC_EARLY_DEBUG_EHV_BC
266	default 0
267	help
268	  If you want early console (udbg) output through a byte channel,
269	  specify the handle of the byte channel to use.
270
271	  For this to work, the byte channel driver must be compiled
272	  in-kernel, not as a module.
273
274	  Note that only one early console driver can be enabled, so don't
275	  enable any others if you enable this one.
276
277	  If the number you specify is not a valid byte channel handle, then
278	  there simply will be no early console output.  This is true also
279	  if you don't boot under a hypervisor at all.
280
281config GOLDFISH_TTY
282	tristate "Goldfish TTY Driver"
283	depends on GOLDFISH
284	select SERIAL_CORE
285	select SERIAL_CORE_CONSOLE
286	help
287	  Console and system TTY driver for the Goldfish virtual platform.
288
289config GOLDFISH_TTY_EARLY_CONSOLE
290	bool
291	default y if GOLDFISH_TTY=y
292	select SERIAL_EARLYCON
293
294config IPWIRELESS
295	tristate "IPWireless 3G UMTS PCMCIA card support"
296	depends on PCMCIA && NETDEVICES && HAS_IOPORT
297	select PPP
298	help
299	  This is a driver for 3G UMTS PCMCIA card from IPWireless company. In
300	  some countries (for example Czech Republic, T-Mobile ISP) this card
301	  is shipped for service called UMTS 4G.
302
303config N_GSM
304	tristate "GSM MUX line discipline support (EXPERIMENTAL)"
305	depends on NET
306	help
307	  This line discipline provides support for the GSM MUX protocol and
308	  presents the mux as a set of 61 individual tty devices.
309
310config NOZOMI
311	tristate "HSDPA Broadband Wireless Data Card - Globe Trotter"
312	depends on PCI
313	help
314	  If you have a HSDPA driver Broadband Wireless Data Card -
315	  Globe Trotter PCMCIA card, say Y here.
316
317	  To compile this driver as a module, choose M here, the module
318	  will be called nozomi.
319
320config MIPS_EJTAG_FDC_TTY
321	bool "MIPS EJTAG Fast Debug Channel TTY"
322	depends on MIPS_CDMM
323	help
324	  This enables a TTY and console on the MIPS EJTAG Fast Debug Channels,
325	  if they are present. This can be useful when working with an EJTAG
326	  probe which supports it, to get console output and a login prompt via
327	  EJTAG without needing to connect a serial cable.
328
329	  TTY devices are named e.g. ttyFDC3c2 (for FDC channel 2 of the FDC on
330	  CPU3).
331
332	  The console can be enabled with console=fdc1 (for FDC channel 1 on all
333	  CPUs). Do not use the console unless there is a debug probe attached
334	  to drain the FDC TX FIFO.
335
336	  If unsure, say N.
337
338config MIPS_EJTAG_FDC_EARLYCON
339	bool "Early FDC console"
340	depends on MIPS_EJTAG_FDC_TTY
341	help
342	  This registers a console on FDC channel 1 very early during boot (from
343	  MIPS arch code). This is useful for bring-up and debugging early boot
344	  issues.
345
346	  Do not enable unless there is a debug probe attached to drain the FDC
347	  TX FIFO.
348
349	  If unsure, say N.
350
351config MIPS_EJTAG_FDC_KGDB
352	bool "Use KGDB over an FDC channel"
353	depends on MIPS_EJTAG_FDC_TTY && KGDB
354	default y
355	help
356	  This enables the use of KGDB over an FDC channel, allowing KGDB to be
357	  used remotely or when a serial port isn't available.
358
359config MIPS_EJTAG_FDC_KGDB_CHAN
360	int "KGDB FDC channel"
361	depends on MIPS_EJTAG_FDC_KGDB
362	range 2 15
363	default 3
364	help
365	  FDC channel number to use for KGDB.
366
367config NULL_TTY
368	tristate "NULL TTY driver"
369	help
370	  Say Y here if you want a NULL TTY which simply discards messages.
371
372	  This is useful to allow userspace applications which expect a console
373	  device to work without modifications even when no console is
374	  available or desired.
375
376	  In order to use this driver, you should redirect the console to this
377	  TTY, boot the kernel with console=ttynull, or enable
378	  NULL_TTY_DEFAULT_CONSOLE.
379
380	  If unsure, say N.
381
382config NULL_TTY_DEFAULT_CONSOLE
383	bool "Support for console on ttynull"
384	depends on NULL_TTY=y && !VT_CONSOLE
385	help
386	  Say Y here if you want the NULL TTY to be used as a /dev/console
387	  device by default.
388
389	  For example, it might be useful to prevent a VT-less kernel from
390	  writing the system log to a random device connected to the serial
391	  port.
392
393	  Another console driver still might get preferred via the command
394	  line, SPCR, or the device tree.
395
396	  If unsure, say N.
397
398config VCC
399	tristate "Sun Virtual Console Concentrator"
400	depends on SUN_LDOMS
401	help
402	  Support for Sun logical domain consoles.
403
404source "drivers/tty/hvc/Kconfig"
405
406config RPMSG_TTY
407	tristate "RPMSG tty driver"
408	depends on RPMSG
409	help
410	  Say y here to export rpmsg endpoints as tty devices, usually found
411	  in /dev/ttyRPMSGx.
412	  This makes it possible for user-space programs to send and receive
413	  rpmsg messages as a standard tty protocol.
414
415	  To compile this driver as a module, choose M here: the module will be
416	  called rpmsg_tty.
417
418endif # TTY
419
420source "drivers/tty/serdev/Kconfig"
421