xref: /linux/arch/um/drivers/Kconfig (revision 69bfec7548f4c1595bac0e3ddfc0458a5af31f4c)
1# SPDX-License-Identifier: GPL-2.0
2
3menu "UML Character Devices"
4
5config STDERR_CONSOLE
6	bool "stderr console"
7	default y
8	help
9	  console driver which dumps all printk messages to stderr.
10
11config SSL
12	bool "Virtual serial line"
13	help
14	  The User-Mode Linux environment allows you to create virtual serial
15	  lines on the UML that are usually made to show up on the host as
16	  ttys or ptys.
17
18	  See <http://user-mode-linux.sourceforge.net/old/input.html> for more
19	  information and command line examples of how to use this facility.
20
21	  Unless you have a specific reason for disabling this, say Y.
22
23config NULL_CHAN
24	bool "null channel support"
25	help
26	  This option enables support for attaching UML consoles and serial
27	  lines to a device similar to /dev/null.  Data written to it disappears
28	  and there is never any data to be read.
29
30config PORT_CHAN
31	bool "port channel support"
32	help
33	  This option enables support for attaching UML consoles and serial
34	  lines to host portals.  They may be accessed with 'telnet <host>
35	  <port number>'.  Any number of consoles and serial lines may be
36	  attached to a single portal, although what UML device you get when
37	  you telnet to that portal will be unpredictable.
38	  It is safe to say 'Y' here.
39
40config PTY_CHAN
41	bool "pty channel support"
42	help
43	  This option enables support for attaching UML consoles and serial
44	  lines to host pseudo-terminals.  Access to both traditional
45	  pseudo-terminals (/dev/pty*) and pts pseudo-terminals are controlled
46	  with this option.  The assignment of UML devices to host devices
47	  will be announced in the kernel message log.
48	  It is safe to say 'Y' here.
49
50config TTY_CHAN
51	bool "tty channel support"
52	help
53	  This option enables support for attaching UML consoles and serial
54	  lines to host terminals.  Access to both virtual consoles
55	  (/dev/tty*) and the slave side of pseudo-terminals (/dev/ttyp* and
56	  /dev/pts/*) are controlled by this option.
57	  It is safe to say 'Y' here.
58
59config XTERM_CHAN
60	bool "xterm channel support"
61	help
62	  This option enables support for attaching UML consoles and serial
63	  lines to xterms.  Each UML device so assigned will be brought up in
64	  its own xterm.
65	  It is safe to say 'Y' here.
66
67config XTERM_CHAN_DEFAULT_EMULATOR
68	string "xterm channel default terminal emulator"
69	depends on XTERM_CHAN
70	default "xterm"
71	help
72	  This option allows changing the default terminal emulator.
73
74config NOCONFIG_CHAN
75	bool
76	default !(XTERM_CHAN && TTY_CHAN && PTY_CHAN && PORT_CHAN && NULL_CHAN)
77
78config CON_ZERO_CHAN
79	string "Default main console channel initialization"
80	default "fd:0,fd:1"
81	help
82	  This is the string describing the channel to which the main console
83	  will be attached by default.  This value can be overridden from the
84	  command line.  The default value is "fd:0,fd:1", which attaches the
85	  main console to stdin and stdout.
86	  It is safe to leave this unchanged.
87
88config CON_CHAN
89	string "Default console channel initialization"
90	default "xterm"
91	help
92	  This is the string describing the channel to which all consoles
93	  except the main console will be attached by default.  This value can
94	  be overridden from the command line.  The default value is "xterm",
95	  which brings them up in xterms.
96	  It is safe to leave this unchanged, although you may wish to change
97	  this if you expect the UML that you build to be run in environments
98	  which don't have X or xterm available.
99
100config SSL_CHAN
101	string "Default serial line channel initialization"
102	default "pty"
103	help
104	  This is the string describing the channel to which the serial lines
105	  will be attached by default.  This value can be overridden from the
106	  command line.  The default value is "pty", which attaches them to
107	  traditional pseudo-terminals.
108	  It is safe to leave this unchanged, although you may wish to change
109	  this if you expect the UML that you build to be run in environments
110	  which don't have a set of /dev/pty* devices.
111
112config UML_SOUND
113	tristate "Sound support"
114	help
115	  This option enables UML sound support.  If enabled, it will pull in
116	  soundcore and the UML hostaudio relay, which acts as a intermediary
117	  between the host's dsp and mixer devices and the UML sound system.
118	  It is safe to say 'Y' here.
119
120config SOUND
121	tristate
122	default UML_SOUND
123
124config SOUND_OSS_CORE
125	bool
126	default UML_SOUND
127
128config HOSTAUDIO
129	tristate
130	default UML_SOUND
131
132endmenu
133
134menu "UML Network Devices"
135	depends on NET
136
137# UML virtual driver
138config UML_NET
139	bool "Virtual network device"
140	help
141	  While the User-Mode port cannot directly talk to any physical
142	  hardware devices, this choice and the following transport options
143	  provide one or more virtual network devices through which the UML
144	  kernels can talk to each other, the host, and with the host's help,
145	  machines on the outside world.
146
147	  For more information, including explanations of the networking and
148	  sample configurations, see
149	  <http://user-mode-linux.sourceforge.net/old/networking.html>.
150
151	  If you'd like to be able to enable networking in the User-Mode
152	  linux environment, say Y; otherwise say N.  Note that you must
153	  enable at least one of the following transport options to actually
154	  make use of UML networking.
155
156config UML_NET_ETHERTAP
157	bool "Ethertap transport (obsolete)"
158	depends on UML_NET
159	help
160	  The Ethertap User-Mode Linux network transport allows a single
161	  running UML to exchange packets with its host over one of the
162	  host's Ethertap devices, such as /dev/tap0.  Additional running
163	  UMLs can use additional Ethertap devices, one per running UML.
164	  While the UML believes it's on a (multi-device, broadcast) virtual
165	  Ethernet network, it's in fact communicating over a point-to-point
166	  link with the host.
167
168	  To use this, your host kernel must have support for Ethertap
169	  devices.  Also, if your host kernel is 2.4.x, it must have
170	  CONFIG_NETLINK_DEV configured as Y or M.
171
172	  For more information, see
173	  <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
174	  has examples of the UML command line to use to enable Ethertap
175	  networking.
176
177	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
178	  migrate to UML_NET_VECTOR.
179
180	  If unsure, say N.
181
182config UML_NET_TUNTAP
183	bool "TUN/TAP transport (obsolete)"
184	depends on UML_NET
185	help
186	  The UML TUN/TAP network transport allows a UML instance to exchange
187	  packets with the host over a TUN/TAP device.  This option will only
188	  work with a 2.4 host, unless you've applied the TUN/TAP patch to
189	  your 2.2 host kernel.
190
191	  To use this transport, your host kernel must have support for TUN/TAP
192	  devices, either built-in or as a module.
193
194	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
195	  migrate to UML_NET_VECTOR.
196
197	  If unsure, say N.
198
199config UML_NET_SLIP
200	bool "SLIP transport (obsolete)"
201	depends on UML_NET
202	help
203	  The slip User-Mode Linux network transport allows a running UML to
204	  network with its host over a point-to-point link.  Unlike Ethertap,
205	  which can carry any Ethernet frame (and hence even non-IP packets),
206	  the slip transport can only carry IP packets.
207
208	  To use this, your host must support slip devices.
209
210	  For more information, see
211	  <http://user-mode-linux.sourceforge.net/old/networking.html>.
212	  has examples of the UML command line to use to enable slip
213	  networking, and details of a few quirks with it.
214
215	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
216	  migrate to UML_NET_VECTOR.
217
218	  If unsure, say N.
219
220config UML_NET_DAEMON
221	bool "Daemon transport (obsolete)"
222	depends on UML_NET
223	help
224	  This User-Mode Linux network transport allows one or more running
225	  UMLs on a single host to communicate with each other, but not to
226	  the host.
227
228	  To use this form of networking, you'll need to run the UML
229	  networking daemon on the host.
230
231	  For more information, see
232	  <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
233	  has examples of the UML command line to use to enable Daemon
234	  networking.
235
236	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
237	  migrate to UML_NET_VECTOR.
238
239	  If unsure, say N.
240
241config UML_NET_DAEMON_DEFAULT_SOCK
242	string "Default socket for daemon transport"
243	default "/tmp/uml.ctl"
244	depends on UML_NET_DAEMON
245	help
246	  This option allows setting the default socket for the daemon
247	  transport, normally it defaults to /tmp/uml.ctl.
248
249config UML_NET_VECTOR
250	bool "Vector I/O high performance network devices"
251	depends on UML_NET
252	select MAY_HAVE_RUNTIME_DEPS
253	help
254	  This User-Mode Linux network driver uses multi-message send
255	  and receive functions. The host running the UML guest must have
256	  a linux kernel version above 3.0 and a libc version > 2.13.
257	  This driver provides tap, raw, gre and l2tpv3 network transports
258	  with up to 4 times higher network throughput than the UML network
259	  drivers.
260
261config UML_NET_VDE
262	bool "VDE transport (obsolete)"
263	depends on UML_NET
264	depends on !MODVERSIONS
265	select MAY_HAVE_RUNTIME_DEPS
266	help
267	  This User-Mode Linux network transport allows one or more running
268	  UMLs on a single host to communicate with each other and also
269	  with the rest of the world using Virtual Distributed Ethernet,
270	  an improved fork of uml_switch.
271
272	  You must have libvdeplug installed in order to build the vde
273	  transport into UML.
274
275	  To use this form of networking, you will need to run vde_switch
276	  on the host.
277
278	  For more information, see <http://wiki.virtualsquare.org/>
279	  That site has a good overview of what VDE is and also examples
280	  of the UML command line to use to enable VDE networking.
281
282	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
283	  migrate to UML_NET_VECTOR.
284
285	  If unsure, say N.
286
287config UML_NET_MCAST
288	bool "Multicast transport (obsolete)"
289	depends on UML_NET
290	help
291	  This Multicast User-Mode Linux network transport allows multiple
292	  UMLs (even ones running on different host machines!) to talk to
293	  each other over a virtual ethernet network.  However, it requires
294	  at least one UML with one of the other transports to act as a
295	  bridge if any of them need to be able to talk to their hosts or any
296	  other IP machines.
297
298	  To use this, your host kernel(s) must support IP Multicasting.
299
300	  For more information, see
301	  <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
302	  has examples of the UML command line to use to enable Multicast
303	  networking, and notes about the security of this approach.
304
305	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
306	  migrate to UML_NET_VECTOR.
307
308	  If unsure, say N.
309
310config UML_NET_PCAP
311	bool "pcap transport (obsolete)"
312	depends on UML_NET
313	depends on !MODVERSIONS
314	select MAY_HAVE_RUNTIME_DEPS
315	help
316	  The pcap transport makes a pcap packet stream on the host look
317	  like an ethernet device inside UML.  This is useful for making
318	  UML act as a network monitor for the host.  You must have libcap
319	  installed in order to build the pcap transport into UML.
320
321	  For more information, see
322	  <http://user-mode-linux.sourceforge.net/old/networking.html>  That site
323	  has examples of the UML command line to use to enable this option.
324
325	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
326	  migrate to UML_NET_VECTOR.
327
328	  If unsure, say N.
329
330config UML_NET_SLIRP
331	bool "SLiRP transport (obsolete)"
332	depends on UML_NET
333	help
334	  The SLiRP User-Mode Linux network transport allows a running UML
335	  to network by invoking a program that can handle SLIP encapsulated
336	  packets.  This is commonly (but not limited to) the application
337	  known as SLiRP, a program that can re-socket IP packets back onto
338	  he host on which it is run.  Only IP packets are supported,
339	  unlike other network transports that can handle all Ethernet
340	  frames.  In general, slirp allows the UML the same IP connectivity
341	  to the outside world that the host user is permitted, and unlike
342	  other transports, SLiRP works without the need of root level
343	  privileges, setuid binaries, or SLIP devices on the host.  This
344	  also means not every type of connection is possible, but most
345	  situations can be accommodated with carefully crafted slirp
346	  commands that can be passed along as part of the network device's
347	  setup string.  The effect of this transport on the UML is similar
348	  that of a host behind a firewall that masquerades all network
349	  connections passing through it (but is less secure).
350
351	  NOTE: THIS TRANSPORT IS DEPRECATED AND WILL BE REMOVED SOON!!! Please
352	  migrate to UML_NET_VECTOR.
353
354	  If unsure, say N.
355
356	  Startup example: "eth0=slirp,FE:FD:01:02:03:04,/usr/local/bin/slirp"
357
358endmenu
359
360config VIRTIO_UML
361	bool "UML driver for virtio devices"
362	select VIRTIO
363	help
364	  This driver provides support for virtio based paravirtual device
365	  drivers over vhost-user sockets.
366
367config UML_RTC
368	bool "UML RTC driver"
369	depends on RTC_CLASS
370	# there's no use in this if PM_SLEEP isn't enabled ...
371	depends on PM_SLEEP
372	help
373	  When PM_SLEEP is configured, it may be desirable to wake up using
374	  rtcwake, especially in time-travel mode. This driver enables that
375	  by providing a fake RTC clock that causes a wakeup at the right
376	  time.
377
378config UML_PCI_OVER_VIRTIO
379	bool "Enable PCI over VIRTIO device simulation"
380	# in theory, just VIRTIO is enough, but that causes recursion
381	depends on VIRTIO_UML
382	select FORCE_PCI
383	select UML_IOMEM_EMULATION
384	select UML_DMA_EMULATION
385	select PCI_MSI
386	select PCI_LOCKLESS_CONFIG
387
388config UML_PCI_OVER_VIRTIO_DEVICE_ID
389	int "set the virtio device ID for PCI emulation"
390	default -1
391	depends on UML_PCI_OVER_VIRTIO
392	help
393	  There's no official device ID assigned (yet), set the one you
394	  wish to use for experimentation here. The default of -1 is
395	  not valid and will cause the driver to fail at probe.
396