2017-04-20 13:04:15 +00:00
|
|
|
.. _kernelparameters:
|
|
|
|
|
|
2016-10-26 22:14:52 +00:00
|
|
|
The kernel's command-line parameters
|
|
|
|
|
====================================
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2020-12-26 17:44:33 +00:00
|
|
|
The following is a consolidated list of the kernel parameters as implemented
|
|
|
|
|
by the __setup(), early_param(), core_param() and module_param() macros
|
2014-05-14 01:03:45 +00:00
|
|
|
and sorted into English Dictionary order (defined as ignoring all
|
|
|
|
|
punctuation and sorting digits before letters in a case insensitive
|
|
|
|
|
manner), and with descriptions where known.
|
|
|
|
|
|
2019-06-27 13:59:38 +00:00
|
|
|
The kernel parses parameters from the kernel command line up to "``--``";
|
2014-05-14 01:03:45 +00:00
|
|
|
if it doesn't recognize a parameter and it doesn't contain a '.', the
|
|
|
|
|
parameter gets passed to init: parameters with '=' go into init's
|
|
|
|
|
environment, others are passed as command line arguments to init.
|
2019-06-27 13:59:38 +00:00
|
|
|
Everything after "``--``" is passed as an argument to init.
|
2014-05-14 01:03:45 +00:00
|
|
|
|
|
|
|
|
Module parameters can be specified in two ways: via the kernel command
|
2016-09-21 12:48:55 +00:00
|
|
|
line with a module name prefix, or via modprobe, e.g.::
|
2014-05-14 01:03:45 +00:00
|
|
|
|
|
|
|
|
(kernel command line) usbcore.blinkenlights=1
|
|
|
|
|
(modprobe command line) modprobe usbcore blinkenlights=1
|
|
|
|
|
|
|
|
|
|
Parameters for modules which are built into the kernel need to be
|
|
|
|
|
specified on the kernel command line. modprobe looks through the
|
|
|
|
|
kernel command line (/proc/cmdline) and collects module parameters
|
|
|
|
|
when it loads a module, so the kernel command line can be used for
|
|
|
|
|
loadable modules too.
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2024-10-29 18:03:20 +00:00
|
|
|
This document may not be entirely up to date and comprehensive. The command
|
|
|
|
|
"modinfo -p ${modulename}" shows a current list of all parameters of a loadable
|
|
|
|
|
module. Loadable modules, after being loaded into the running kernel, also
|
|
|
|
|
reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
|
|
|
|
|
parameters may be changed at runtime by the command
|
|
|
|
|
``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
|
|
|
|
|
|
|
|
|
|
Special handling
|
|
|
|
|
----------------
|
|
|
|
|
|
2016-09-21 12:48:55 +00:00
|
|
|
Hyphens (dashes) and underscores are equivalent in parameter names, so::
|
|
|
|
|
|
2009-05-06 23:02:58 +00:00
|
|
|
log_buf_len=1M print-fatal-signals=1
|
2016-09-21 12:48:55 +00:00
|
|
|
|
|
|
|
|
can also be entered as::
|
|
|
|
|
|
2009-05-06 23:02:58 +00:00
|
|
|
log-buf-len=1M print_fatal_signals=1
|
|
|
|
|
|
2016-09-21 12:48:55 +00:00
|
|
|
Double-quotes can be used to protect spaces in values, e.g.::
|
|
|
|
|
|
2014-05-14 01:03:45 +00:00
|
|
|
param="spaces in here"
|
2009-05-06 23:02:58 +00:00
|
|
|
|
2024-10-29 18:03:20 +00:00
|
|
|
cpu lists
|
|
|
|
|
~~~~~~~~~
|
2016-10-11 20:51:35 +00:00
|
|
|
|
|
|
|
|
Some kernel parameters take a list of CPUs as a value, e.g. isolcpus,
|
|
|
|
|
nohz_full, irqaffinity, rcu_nocbs. The format of this list is:
|
|
|
|
|
|
|
|
|
|
<cpu number>,...,<cpu number>
|
|
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
|
|
|
|
<cpu number>-<cpu number>
|
|
|
|
|
(must be a positive range in ascending order)
|
|
|
|
|
|
|
|
|
|
or a mixture
|
|
|
|
|
|
|
|
|
|
<cpu number>,...,<cpu number>-<cpu number>
|
|
|
|
|
|
|
|
|
|
Note that for the special case of a range one can split the range into equal
|
|
|
|
|
sized groups and for each group use some amount from the beginning of that
|
|
|
|
|
group:
|
|
|
|
|
|
2021-01-27 10:43:43 +00:00
|
|
|
<cpu number>-<cpu number>:<used size>/<group size>
|
2016-10-11 20:51:35 +00:00
|
|
|
|
|
|
|
|
For example one can add to the command line following parameter:
|
|
|
|
|
|
|
|
|
|
isolcpus=1,2,10-20,100-2000:2/25
|
|
|
|
|
|
|
|
|
|
where the final item represents CPUs 100,101,125,126,150,151,...
|
|
|
|
|
|
2021-02-21 08:08:25 +00:00
|
|
|
The value "N" can be used to represent the numerically last CPU on the system,
|
|
|
|
|
i.e "foo_cpus=16-N" would be equivalent to "16-31" on a 32 core system.
|
|
|
|
|
|
|
|
|
|
Keep in mind that "N" is dynamic, so if system changes cause the bitmap width
|
|
|
|
|
to change, such as less cores in the CPU list, then N and any ranges using N
|
|
|
|
|
will also change. Use the same on a small 4 core system, and "16-N" becomes
|
|
|
|
|
"16-3" and now the same boot input will be flagged as invalid (start > end).
|
2016-10-11 20:51:35 +00:00
|
|
|
|
2021-04-21 03:13:25 +00:00
|
|
|
The special case-tolerant group name "all" has a meaning of selecting all CPUs,
|
|
|
|
|
so that "nohz_full=all" is the equivalent of "nohz_full=0-N".
|
|
|
|
|
|
|
|
|
|
The semantics of "N" and "all" is supported on a level of bitmaps and holds for
|
2023-08-17 14:04:32 +00:00
|
|
|
all users of bitmap_parselist().
|
2016-10-11 20:51:35 +00:00
|
|
|
|
2024-10-29 18:03:20 +00:00
|
|
|
Metric suffixes
|
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
The [KMG] suffix is commonly described after a number of kernel
|
|
|
|
|
parameter values. 'K', 'M', 'G', 'T', 'P', and 'E' suffixes are allowed.
|
|
|
|
|
These letters represent the _binary_ multipliers 'Kilo', 'Mega', 'Giga',
|
|
|
|
|
'Tera', 'Peta', and 'Exa', equaling 2^10, 2^20, 2^30, 2^40, 2^50, and
|
|
|
|
|
2^60 bytes respectively. Such letter suffixes can also be entirely omitted.
|
|
|
|
|
|
|
|
|
|
Kernel Build Options
|
|
|
|
|
--------------------
|
2006-03-31 23:43:18 +00:00
|
|
|
|
2023-07-25 17:42:47 +00:00
|
|
|
The parameters listed below are only valid if certain kernel build options
|
|
|
|
|
were enabled and if respective hardware is present. This list should be kept
|
|
|
|
|
in alphabetical order. The text in square brackets at the beginning
|
|
|
|
|
of each description states the restrictions within which a parameter
|
|
|
|
|
is applicable::
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
|
ACPI ACPI support is enabled.
|
2007-07-27 00:46:20 +00:00
|
|
|
AGP AGP (Accelerated Graphics Port) is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
ALSA ALSA sound support is enabled.
|
|
|
|
|
APIC APIC support is enabled.
|
|
|
|
|
APM Advanced Power Management support is enabled.
|
2022-04-03 05:48:21 +00:00
|
|
|
APPARMOR AppArmor support is enabled.
|
2011-08-13 19:34:52 +00:00
|
|
|
ARM ARM architecture is enabled.
|
2019-04-13 03:56:21 +00:00
|
|
|
ARM64 ARM64 architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
AX25 Appropriate AX.25 support is enabled.
|
2013-04-27 21:10:18 +00:00
|
|
|
CLK Common clock infrastructure is enabled.
|
2013-03-29 01:41:46 +00:00
|
|
|
CMA Contiguous Memory Area support is enabled.
|
2011-01-25 14:18:38 +00:00
|
|
|
DRM Direct Rendering Management support is enabled.
|
|
|
|
|
DYNAMIC_DEBUG Build in debug messages and enable them at runtime
|
doc: Add EARLY flag to early-parsed kernel boot parameters
Kernel boot parameters declared with early_param() are parsed before
embedded parameters are extracted from initrd, and early_param()
parameters are not helpful when embedded in initrd. Therefore,
mark early_param() kernel boot parameters with "EARLY" in
kernel-parameters.txt.
The following early_param() calls declare kernel boot parameters that
are undocumented:
early_param("atmel.pm_modes", at91_pm_modes_select);
early_param("mem_fclk_21285", early_fclk);
early_param("ecc", early_ecc);
early_param("cachepolicy", early_cachepolicy);
early_param("nodebugmon", early_debug_disable);
early_param("kfence.sample_interval", parse_kfence_early_init);
early_param("additional_cpus", setup_additional_cpus);
early_param("stram_pool", atari_stram_setup);
early_param("disable_octeon_edac", disable_octeon_edac);
early_param("rd_start", rd_start_early);
early_param("rd_size", rd_size_early);
early_param("coherentio", setcoherentio);
early_param("nocoherentio", setnocoherentio);
early_param("fadump", early_fadump_param);
early_param("fadump_reserve_mem", early_fadump_reserve_mem);
early_param("no_stf_barrier", handle_no_stf_barrier);
early_param("no_rfi_flush", handle_no_rfi_flush);
early_param("smt-enabled", early_smt_enabled);
early_param("ppc_pci_reset_phbs", pci_reset_phbs_setup);
early_param("ps3fb", early_parse_ps3fb);
early_param("ps3flash", early_parse_ps3flash);
early_param("novx", disable_vector_extension);
early_param("nobp", nobp_setup_early);
early_param("nospec", nospec_setup_early);
early_param("possible_cpus", _setup_possible_cpus);
early_param("stp", early_parse_stp);
early_param("nopfault", nopfault);
early_param("nmi_mode", nmi_mode_setup);
early_param("sh_mv", early_parse_mv);
early_param("pmb", early_pmb);
early_param("hvirq", early_hvirq_major);
early_param("cfi", cfi_parse_cmdline);
early_param("disableapic", setup_disableapic);
early_param("noapictimer", parse_disable_apic_timer);
early_param("disable_cpu_apicid", apic_set_disabled_cpu_apicid);
early_param("uv_memblksize", parse_mem_block_size);
early_param("retbleed", retbleed_parse_cmdline);
early_param("no-kvmclock-vsyscall", parse_no_kvmclock_vsyscall);
early_param("update_mptable", update_mptable_setup);
early_param("alloc_mptable", parse_alloc_mptable_opt);
early_param("possible_cpus", _setup_possible_cpus);
early_param("lsmsi", early_parse_ls_scfg_msi);
early_param("nokgdbroundup", opt_nokgdbroundup);
early_param("kgdbcon", opt_kgdb_con);
early_param("kasan", early_kasan_flag);
early_param("kasan.mode", early_kasan_mode);
early_param("kasan.vmalloc", early_kasan_flag_vmalloc);
early_param("kasan.page_alloc.sample", early_kasan_flag_page_alloc_sample);
early_param("kasan.page_alloc.sample.order", early_kasan_flag_page_alloc_sample_order);
early_param("kasan.fault", early_kasan_fault);
early_param("kasan.stacktrace", early_kasan_flag_stacktrace);
early_param("kasan.stack_ring_size", early_kasan_flag_stack_ring_size);
early_param("accept_memory", accept_memory_parse);
early_param("page_table_check", early_page_table_check_param);
sh_early_platform_init("earlytimer", &sh_cmt_device_driver);
early_param_on_off("gbpages", "nogbpages", direct_gbpages, CONFIG_X86_DIRECT_GBPAGES);
These are not necessarily bugs, given that some kernel boot parameters
are intended for deep debugging rather than general use.
This work does not cover all of the kernel boot parameters declared using
cmdline_find_option() and cmdline_find_option_bool(). If these are in
fact guaranteed to be early (which appears to be the case), they can be
added in a later version of this patch.
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Petr Malat <oss@malat.biz>
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: <linux-doc@vger.kernel.org>
Cc: <linux-arch@vger.kernel.org>
Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
2023-11-26 19:06:10 +00:00
|
|
|
EARLY Parameter processed too early to be embedded in initrd.
|
2005-04-16 22:20:36 +00:00
|
|
|
EDD BIOS Enhanced Disk Drive Services (EDD) is enabled
|
|
|
|
|
EFI EFI Partitioning (GPT) is enabled
|
2011-05-12 22:33:20 +00:00
|
|
|
EVM Extended Verification Module
|
2005-04-16 22:20:36 +00:00
|
|
|
FB The frame buffer device is enabled.
|
2011-08-13 19:34:52 +00:00
|
|
|
FTRACE Function tracing enabled.
|
2009-06-17 23:28:08 +00:00
|
|
|
GCOV GCOV profiling is enabled.
|
2022-04-03 05:48:21 +00:00
|
|
|
HIBERNATION HIBERNATION is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
HW Appropriate hardware is enabled.
|
2022-04-03 05:48:21 +00:00
|
|
|
HYPER_V HYPERV support is enabled.
|
2009-02-04 14:06:57 +00:00
|
|
|
IMA Integrity measurement architecture is enabled.
|
2005-07-12 20:58:33 +00:00
|
|
|
IP_PNP IP DHCP, BOOTP, or RARP is enabled.
|
2010-02-04 21:36:50 +00:00
|
|
|
IPV6 IPv6 support is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
ISAPNP ISA PnP code is enabled.
|
|
|
|
|
ISDN Appropriate ISDN support is enabled.
|
2017-12-14 18:18:27 +00:00
|
|
|
ISOL CPU Isolation is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
JOY Appropriate joystick support is enabled.
|
2010-05-21 02:04:24 +00:00
|
|
|
KGDB Kernel debugger support is enabled.
|
2009-07-10 12:20:35 +00:00
|
|
|
KVM Kernel Virtual Machine support is enabled.
|
2006-09-28 18:29:01 +00:00
|
|
|
LIBATA Libata driver is enabled
|
2023-04-18 11:38:58 +00:00
|
|
|
LOONGARCH LoongArch architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
LOOP Loopback device support is enabled.
|
2023-07-25 17:42:47 +00:00
|
|
|
LP Printer support is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
M68k M68k architecture is enabled.
|
|
|
|
|
These options have more detailed description inside of
|
2023-03-30 19:48:12 +00:00
|
|
|
Documentation/arch/m68k/kernel-options.rst.
|
2005-04-16 22:20:36 +00:00
|
|
|
MDA MDA console support is enabled.
|
2011-08-13 19:34:52 +00:00
|
|
|
MIPS MIPS architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
MOUSE Appropriate mouse support is enabled.
|
2006-03-06 05:33:34 +00:00
|
|
|
MSI Message Signaled Interrupts (PCI).
|
2007-07-31 07:37:40 +00:00
|
|
|
MTD MTD (Memory Technology Device) support is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
NET Appropriate network support is enabled.
|
|
|
|
|
NFS Appropriate NFS support is enabled.
|
2023-07-25 17:42:47 +00:00
|
|
|
NUMA NUMA support is enabled.
|
2019-09-04 21:11:22 +00:00
|
|
|
OF Devicetree is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
PARISC The PA-RISC architecture is enabled.
|
|
|
|
|
PCI PCI bus support is enabled.
|
2007-10-05 20:17:58 +00:00
|
|
|
PCIE PCI Express support is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
PCMCIA The PCMCIA subsystem is enabled.
|
|
|
|
|
PNP Plug & Play support is enabled.
|
|
|
|
|
PPC PowerPC architecture is enabled.
|
|
|
|
|
PPT Parallel port support is enabled.
|
|
|
|
|
PS2 Appropriate PS/2 support is enabled.
|
2023-07-25 17:42:47 +00:00
|
|
|
PV_OPS A paravirtualized kernel is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
RAM RAM disk support is enabled.
|
2017-08-24 16:26:51 +00:00
|
|
|
RDT Intel Resource Director Technology.
|
2023-07-25 17:42:47 +00:00
|
|
|
RISCV RISCV architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
S390 S390 architecture is enabled.
|
|
|
|
|
SCSI Appropriate SCSI support is enabled.
|
2010-08-14 19:36:14 +00:00
|
|
|
A lot of drivers have their options described inside
|
|
|
|
|
the Documentation/scsi/ sub-directory.
|
2024-10-04 02:18:50 +00:00
|
|
|
SDW SoundWire support is enabled.
|
2007-10-17 06:31:32 +00:00
|
|
|
SECURITY Different security models are enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
SELINUX SELinux support is enabled.
|
|
|
|
|
SERIAL Serial support is enabled.
|
2007-02-28 09:30:01 +00:00
|
|
|
SH SuperH architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
SMP The kernel is an SMP kernel.
|
|
|
|
|
SPARC Sparc architecture is enabled.
|
2008-07-24 04:28:33 +00:00
|
|
|
SUSPEND System suspend states are enabled.
|
2023-07-25 17:42:47 +00:00
|
|
|
SWSUSP Software suspend (hibernation) is enabled.
|
2010-03-25 03:55:32 +00:00
|
|
|
TPM TPM drivers are enabled.
|
2008-11-10 19:07:45 +00:00
|
|
|
UMS USB Mass Storage support is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
USB USB support is enabled.
|
|
|
|
|
USBHID USB Human Interface Device support is enabled.
|
|
|
|
|
V4L Video For Linux support is enabled.
|
|
|
|
|
VGA The VGA console has been enabled.
|
2023-07-25 17:42:47 +00:00
|
|
|
VMMIO Driver for memory mapped virtio devices is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
VT Virtual terminal support is enabled.
|
|
|
|
|
WDT Watchdog support is enabled.
|
2007-07-31 07:37:59 +00:00
|
|
|
X86-32 X86-32, aka i386 architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
X86-64 X86-64 architecture is enabled.
|
|
|
|
|
More X86-64 boot options can be found in
|
2023-03-14 23:06:44 +00:00
|
|
|
Documentation/arch/x86/x86_64/boot-options.rst.
|
2011-08-13 19:34:52 +00:00
|
|
|
X86 Either 32-bit or 64-bit x86 (same as X86-32+X86-64)
|
2016-03-31 19:18:29 +00:00
|
|
|
X86_UV SGI UV support is enabled.
|
2010-05-14 11:44:30 +00:00
|
|
|
XEN Xen support is enabled
|
2020-11-28 19:51:21 +00:00
|
|
|
XTENSA xtensa architecture is enabled.
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2016-09-21 12:48:55 +00:00
|
|
|
In addition, the following text indicates that the option::
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2023-07-25 17:42:47 +00:00
|
|
|
BOOT Is a boot loader parameter.
|
2005-04-16 22:20:36 +00:00
|
|
|
BUGS= Relates to possible processor bugs on the said processor.
|
|
|
|
|
KNL Is a kernel start-up parameter.
|
|
|
|
|
|
|
|
|
|
Parameters denoted with BOOT are actually interpreted by the boot
|
|
|
|
|
loader, and have no meaning to the kernel directly.
|
|
|
|
|
Do not modify the syntax of boot loader parameters without extreme
|
2023-03-14 23:06:44 +00:00
|
|
|
need or coordination with <Documentation/arch/x86/boot.rst>.
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2007-02-13 12:26:21 +00:00
|
|
|
There are also arch-specific kernel-parameters not documented here.
|
2023-03-14 23:06:44 +00:00
|
|
|
See for example <Documentation/arch/x86/x86_64/boot-options.rst>.
|
2007-02-13 12:26:21 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
|
|
|
|
|
a trailing = on the name of any parameter states that that parameter will
|
|
|
|
|
be entered as an environment variable, whereas its absence indicates that
|
|
|
|
|
it will appear as a kernel argument readable via /proc/cmdline by programs
|
|
|
|
|
running once the system is up.
|
|
|
|
|
|
2006-09-29 09:00:27 +00:00
|
|
|
The number of kernel parameters is not limited, but the length of the
|
|
|
|
|
complete command line (parameters including spaces etc.) is limited to
|
|
|
|
|
a fixed number of characters. This limit depends on the architecture
|
|
|
|
|
and is between 256 and 4096 characters. It is defined in the file
|
2022-04-03 05:48:21 +00:00
|
|
|
./include/uapi/asm-generic/setup.h as COMMAND_LINE_SIZE.
|
2006-09-29 09:00:27 +00:00
|
|
|
|
2016-11-03 10:10:10 +00:00
|
|
|
.. include:: kernel-parameters.txt
|
|
|
|
|
:literal:
|