Documentation/admin-guide/kernel-parameters.rst

   1 .. _kernelparameters:
   2
   3 The kernel's command-line parameters
   4 ====================================
   5
   6 The following is a consolidated list of the kernel parameters as implemented
   7 by the __setup(), early_param(), core_param() and module_param() macros
   8 and sorted into English Dictionary order (defined as ignoring all
   9 punctuation and sorting digits before letters in a case insensitive
  10 manner), and with descriptions where known.
  11
  12 The kernel parses parameters from the kernel command line up to "``--``";
  13 if it doesn't recognize a parameter and it doesn't contain a '.', the
  14 parameter gets passed to init: parameters with '=' go into init's
  15 environment, others are passed as command line arguments to init.
  16 Everything after "``--``" is passed as an argument to init.
  17
  18 Module parameters can be specified in two ways: via the kernel command
  19 line with a module name prefix, or via modprobe, e.g.::
  20
  21         (kernel command line) usbcore.blinkenlights=1
  22         (modprobe command line) modprobe usbcore blinkenlights=1
  23
  24 Parameters for modules which are built into the kernel need to be
  25 specified on the kernel command line.  modprobe looks through the
  26 kernel command line (/proc/cmdline) and collects module parameters
  27 when it loads a module, so the kernel command line can be used for
  28 loadable modules too.
  29
  30 This document may not be entirely up to date and comprehensive. The command
  31 "modinfo -p ${modulename}" shows a current list of all parameters of a loadable
  32 module. Loadable modules, after being loaded into the running kernel, also
  33 reveal their parameters in /sys/module/${modulename}/parameters/. Some of these
  34 parameters may be changed at runtime by the command
  35 ``echo -n ${value} > /sys/module/${modulename}/parameters/${parm}``.
  36
  37 Special handling
  38 ----------------
  39
  40 Hyphens (dashes) and underscores are equivalent in parameter names, so::
  41
  42         log_buf_len=1M print-fatal-signals=1
  43
  44 can also be entered as::
  45
  46         log-buf-len=1M print_fatal_signals=1
  47
  48 Double-quotes can be used to protect spaces in values, e.g.::
  49
  50         param="spaces in here"
  51
  52 cpu lists
  53 ~~~~~~~~~
  54
  55 Some kernel parameters take a list of CPUs as a value, e.g.  isolcpus,
  56 nohz_full, irqaffinity, rcu_nocbs.  The format of this list is:
  57
  58         <cpu number>,...,<cpu number>
  59
  60 or
  61
  62         <cpu number>-<cpu number>
  63         (must be a positive range in ascending order)
  64
  65 or a mixture
  66
  67 <cpu number>,...,<cpu number>-<cpu number>
  68
  69 Note that for the special case of a range one can split the range into equal
  70 sized groups and for each group use some amount from the beginning of that
  71 group:
  72
  73         <cpu number>-<cpu number>:<used size>/<group size>
  74
  75 For example one can add to the command line following parameter:
  76
  77         isolcpus=1,2,10-20,100-2000:2/25
  78
  79 where the final item represents CPUs 100,101,125,126,150,151,...
  80
  81 The value "N" can be used to represent the numerically last CPU on the system,
  82 i.e "foo_cpus=16-N" would be equivalent to "16-31" on a 32 core system.
  83
  84 Keep in mind that "N" is dynamic, so if system changes cause the bitmap width
  85 to change, such as less cores in the CPU list, then N and any ranges using N
  86 will also change.  Use the same on a small 4 core system, and "16-N" becomes
  87 "16-3" and now the same boot input will be flagged as invalid (start > end).
  88
  89 The special case-tolerant group name "all" has a meaning of selecting all CPUs,
  90 so that "nohz_full=all" is the equivalent of "nohz_full=0-N".
  91
  92 The semantics of "N" and "all" is supported on a level of bitmaps and holds for
  93 all users of bitmap_parselist().
  94
  95 Metric suffixes
  96 ~~~~~~~~~~~~~~~
  97
  98 The [KMG] suffix is commonly described after a number of kernel
  99 parameter values. 'K', 'M', 'G', 'T', 'P', and 'E' suffixes are allowed.
 100 These letters represent the _binary_ multipliers 'Kilo', 'Mega', 'Giga',
 101 'Tera', 'Peta', and 'Exa', equaling 2^10, 2^20, 2^30, 2^40, 2^50, and
 102 2^60 bytes respectively. Such letter suffixes can also be entirely omitted.
 103
 104 Kernel Build Options
 105 --------------------
 106
 107 The parameters listed below are only valid if certain kernel build options
 108 were enabled and if respective hardware is present. This list should be kept
 109 in alphabetical order. The text in square brackets at the beginning
 110 of each description states the restrictions within which a parameter
 111 is applicable::
 112
 113         ACPI    ACPI support is enabled.
 114         AGP     AGP (Accelerated Graphics Port) is enabled.
 115         ALSA    ALSA sound support is enabled.
 116         APIC    APIC support is enabled.
 117         APM     Advanced Power Management support is enabled.
 118         APPARMOR AppArmor support is enabled.
 119         ARM     ARM architecture is enabled.
 120         ARM64   ARM64 architecture is enabled.
 121         AX25    Appropriate AX.25 support is enabled.
 122         CLK     Common clock infrastructure is enabled.
 123         CMA     Contiguous Memory Area support is enabled.
 124         DRM     Direct Rendering Management support is enabled.
 125         DYNAMIC_DEBUG Build in debug messages and enable them at runtime
 126         EARLY   Parameter processed too early to be embedded in initrd.
 127         EDD     BIOS Enhanced Disk Drive Services (EDD) is enabled
 128         EFI     EFI Partitioning (GPT) is enabled
 129         EVM     Extended Verification Module
 130         FB      The frame buffer device is enabled.
 131         FTRACE  Function tracing enabled.
 132         GCOV    GCOV profiling is enabled.
 133         HIBERNATION HIBERNATION is enabled.
 134         HW      Appropriate hardware is enabled.
 135         HYPER_V HYPERV support is enabled.
 136         IMA     Integrity measurement architecture is enabled.
 137         IP_PNP  IP DHCP, BOOTP, or RARP is enabled.
 138         IPV6    IPv6 support is enabled.
 139         ISAPNP  ISA PnP code is enabled.
 140         ISDN    Appropriate ISDN support is enabled.
 141         ISOL    CPU Isolation is enabled.
 142         JOY     Appropriate joystick support is enabled.
 143         KGDB    Kernel debugger support is enabled.
 144         KVM     Kernel Virtual Machine support is enabled.
 145         LIBATA  Libata driver is enabled
 146         LOONGARCH LoongArch architecture is enabled.
 147         LOOP    Loopback device support is enabled.
 148         LP      Printer support is enabled.
 149         M68k    M68k architecture is enabled.
 150                         These options have more detailed description inside of
 151                         Documentation/arch/m68k/kernel-options.rst.
 152         MDA     MDA console support is enabled.
 153         MIPS    MIPS architecture is enabled.
 154         MOUSE   Appropriate mouse support is enabled.
 155         MSI     Message Signaled Interrupts (PCI).
 156         MTD     MTD (Memory Technology Device) support is enabled.
 157         NET     Appropriate network support is enabled.
 158         NFS     Appropriate NFS support is enabled.
 159         NUMA    NUMA support is enabled.
 160         OF      Devicetree is enabled.
 161         PARISC  The PA-RISC architecture is enabled.
 162         PCI     PCI bus support is enabled.
 163         PCIE    PCI Express support is enabled.
 164         PCMCIA  The PCMCIA subsystem is enabled.
 165         PNP     Plug & Play support is enabled.
 166         PPC     PowerPC architecture is enabled.
 167         PPT     Parallel port support is enabled.
 168         PS2     Appropriate PS/2 support is enabled.
 169         PV_OPS  A paravirtualized kernel is enabled.
 170         RAM     RAM disk support is enabled.
 171         RDT     Intel Resource Director Technology.
 172         RISCV   RISCV architecture is enabled.
 173         S390    S390 architecture is enabled.
 174         SCSI    Appropriate SCSI support is enabled.
 175                         A lot of drivers have their options described inside
 176                         the Documentation/scsi/ sub-directory.
 177         SDW     SoundWire support is enabled.
 178         SECURITY Different security models are enabled.
 179         SELINUX SELinux support is enabled.
 180         SERIAL  Serial support is enabled.
 181         SH      SuperH architecture is enabled.
 182         SMP     The kernel is an SMP kernel.
 183         SPARC   Sparc architecture is enabled.
 184         SUSPEND System suspend states are enabled.
 185         SWSUSP  Software suspend (hibernation) is enabled.
 186         TPM     TPM drivers are enabled.
 187         UMS     USB Mass Storage support is enabled.
 188         USB     USB support is enabled.
 189         USBHID  USB Human Interface Device support is enabled.
 190         V4L     Video For Linux support is enabled.
 191         VGA     The VGA console has been enabled.
 192         VMMIO   Driver for memory mapped virtio devices is enabled.
 193         VT      Virtual terminal support is enabled.
 194         WDT     Watchdog support is enabled.
 195         X86-32  X86-32, aka i386 architecture is enabled.
 196         X86-64  X86-64 architecture is enabled.
 197                         More X86-64 boot options can be found in
 198                         Documentation/arch/x86/x86_64/boot-options.rst.
 199         X86     Either 32-bit or 64-bit x86 (same as X86-32+X86-64)
 200         X86_UV  SGI UV support is enabled.
 201         XEN     Xen support is enabled
 202         XTENSA  xtensa architecture is enabled.
 203
 204 In addition, the following text indicates that the option::
 205
 206         BOOT    Is a boot loader parameter.
 207         BUGS=   Relates to possible processor bugs on the said processor.
 208         KNL     Is a kernel start-up parameter.
 209
 210 Parameters denoted with BOOT are actually interpreted by the boot
 211 loader, and have no meaning to the kernel directly.
 212 Do not modify the syntax of boot loader parameters without extreme
 213 need or coordination with <Documentation/arch/x86/boot.rst>.
 214
 215 There are also arch-specific kernel-parameters not documented here.
 216 See for example <Documentation/arch/x86/x86_64/boot-options.rst>.
 217
 218 Note that ALL kernel parameters listed below are CASE SENSITIVE, and that
 219 a trailing = on the name of any parameter states that that parameter will
 220 be entered as an environment variable, whereas its absence indicates that
 221 it will appear as a kernel argument readable via /proc/cmdline by programs
 222 running once the system is up.
 223
 224 The number of kernel parameters is not limited, but the length of the
 225 complete command line (parameters including spaces etc.) is limited to
 226 a fixed number of characters. This limit depends on the architecture
 227 and is between 256 and 4096 characters. It is defined in the file
 228 ./include/uapi/asm-generic/setup.h as COMMAND_LINE_SIZE.
 229
 230 .. include:: kernel-parameters.txt
 231    :literal: