drivers/acpi/Kconfig

   1 # SPDX-License-Identifier: GPL-2.0
   2 #
   3 # ACPI Configuration
   4 #
   5
   6 config ARCH_SUPPORTS_ACPI
   7         bool
   8
   9 menuconfig ACPI
  10         bool "ACPI (Advanced Configuration and Power Interface) Support"
  11         depends on ARCH_SUPPORTS_ACPI
  12         select PNP
  13         select NLS
  14         select CRC32
  15         select FIRMWARE_TABLE
  16         default y if X86
  17         help
  18           Advanced Configuration and Power Interface (ACPI) support for
  19           Linux requires an ACPI-compliant platform (hardware/firmware),
  20           and assumes the presence of OS-directed configuration and power
  21           management (OSPM) software.  This option will enlarge your
  22           kernel by about 70K.
  23
  24           Linux ACPI provides a robust functional replacement for several
  25           legacy configuration and power management interfaces, including
  26           the Plug-and-Play BIOS specification (PnP BIOS), the
  27           MultiProcessor Specification (MPS), and the Advanced Power
  28           Management (APM) specification.  If both ACPI and APM support
  29           are configured, ACPI is used.
  30
  31           Linux support for ACPI is based on Intel Corporation's ACPI
  32           Component Architecture (ACPI CA).  For more information on the
  33           ACPI CA, see:
  34           <https://acpica.org/>
  35
  36           ACPI is an open industry specification originally co-developed by
  37           Hewlett-Packard, Intel, Microsoft, Phoenix, and Toshiba. Currently,
  38           it is developed by the ACPI Specification Working Group (ASWG) under
  39           the UEFI Forum and any UEFI member can join the ASWG and contribute
  40           to the ACPI specification.
  41           The specification is available at:
  42           <https://uefi.org/specifications>
  43
  44 if ACPI
  45
  46 config ACPI_LEGACY_TABLES_LOOKUP
  47         bool
  48
  49 config ARCH_MIGHT_HAVE_ACPI_PDC
  50         bool
  51
  52 config ACPI_GENERIC_GSI
  53         bool
  54
  55 config ACPI_SYSTEM_POWER_STATES_SUPPORT
  56         bool
  57
  58 config ACPI_CCA_REQUIRED
  59         bool
  60
  61 config ACPI_TABLE_LIB
  62         bool
  63
  64 config ACPI_DEBUGGER
  65         bool "AML debugger interface"
  66         select ACPI_DEBUG
  67         help
  68           Enable in-kernel debugging of AML facilities: statistics,
  69           internal object dump, single step control method execution.
  70           This is still under development, currently enabling this only
  71           results in the compilation of the ACPICA debugger files.
  72
  73 if ACPI_DEBUGGER
  74
  75 config ACPI_DEBUGGER_USER
  76         tristate "Userspace debugger accessibility"
  77         depends on DEBUG_FS
  78         help
  79           Export /sys/kernel/debug/acpi/acpidbg for userspace utilities
  80           to access the debugger functionalities.
  81
  82 endif
  83
  84 config ACPI_SPCR_TABLE
  85         bool "ACPI Serial Port Console Redirection Support"
  86         default y if X86
  87         help
  88           Enable support for Serial Port Console Redirection (SPCR) Table.
  89           This table provides information about the configuration of the
  90           earlycon console.
  91
  92 config ACPI_FPDT
  93         bool "ACPI Firmware Performance Data Table (FPDT) support"
  94         depends on X86_64 || ARM64
  95         help
  96           Enable support for the Firmware Performance Data Table (FPDT).
  97           This table provides information on the timing of the system
  98           boot, S3 suspend and S3 resume firmware code paths.
  99
 100 config ACPI_LPIT
 101         bool
 102         depends on X86_64
 103         default y
 104
 105 config ACPI_SLEEP
 106         bool
 107         depends on SUSPEND || HIBERNATION
 108         depends on ACPI_SYSTEM_POWER_STATES_SUPPORT
 109         default y
 110
 111 config ACPI_REV_OVERRIDE_POSSIBLE
 112         bool "Allow supported ACPI revision to be overridden"
 113         depends on X86
 114         default y
 115         help
 116           The platform firmware on some systems expects Linux to return "5" as
 117           the supported ACPI revision which makes it expose system configuration
 118           information in a special way.
 119
 120           For example, based on what ACPI exports as the supported revision,
 121           Dell XPS 13 (2015) configures its audio device to either work in HDA
 122           mode or in I2S mode, where the former is supposed to be used on Linux
 123           until the latter is fully supported (in the kernel as well as in user
 124           space).
 125
 126           This option enables a DMI-based quirk for the above Dell machine (so
 127           that HDA audio is exposed by the platform firmware to the kernel) and
 128           makes it possible to force the kernel to return "5" as the supported
 129           ACPI revision via the "acpi_rev_override" command line switch.
 130
 131 config ACPI_EC_DEBUGFS
 132         tristate "EC read/write access through /sys/kernel/debug/ec"
 133         help
 134           Say N to disable Embedded Controller /sys/kernel/debug interface
 135
 136           Be aware that using this interface can confuse your Embedded
 137           Controller in a way that a normal reboot is not enough. You then
 138           have to power off your system, and remove the laptop battery for
 139           some seconds.
 140           An Embedded Controller typically is available on laptops and reads
 141           sensor values like battery state and temperature.
 142           The kernel accesses the EC through ACPI parsed code provided by BIOS
 143           tables. This option allows to access the EC directly without ACPI
 144           code being involved.
 145           Thus this option is a debug option that helps to write ACPI drivers
 146           and can be used to identify ACPI code or EC firmware bugs.
 147
 148 config ACPI_AC
 149         tristate "AC Adapter"
 150         select POWER_SUPPLY
 151         default y
 152         help
 153           This driver supports the AC Adapter object, which indicates
 154           whether a system is on AC or not.  If you have a system that can
 155           switch between A/C and battery, say Y.
 156
 157           To compile this driver as a module, choose M here:
 158           the module will be called ac.
 159
 160 config ACPI_BATTERY
 161         tristate "Battery"
 162         select POWER_SUPPLY
 163         default y
 164         help
 165           This driver adds support for battery information through
 166           /proc/acpi/battery. If you have a mobile system with a battery,
 167           say Y.
 168
 169           To compile this driver as a module, choose M here:
 170           the module will be called battery.
 171
 172 config ACPI_BUTTON
 173         tristate "Button"
 174         depends on INPUT
 175         default y
 176         help
 177           This driver handles events on the power, sleep, and lid buttons.
 178           A daemon reads events from input devices or via netlink and
 179           performs user-defined actions such as shutting down the system.
 180           This is necessary for software-controlled poweroff.
 181
 182           To compile this driver as a module, choose M here:
 183           the module will be called button.
 184
 185 config ACPI_TINY_POWER_BUTTON
 186         tristate "Tiny Power Button Driver"
 187         depends on !ACPI_BUTTON
 188         help
 189           This driver provides a tiny alternative to the ACPI Button driver.
 190           The tiny power button driver only handles the power button. Rather
 191           than notifying userspace via the input layer or a netlink event, this
 192           driver directly signals the init process to shut down.
 193
 194           This driver is particularly suitable for cloud and VM environments,
 195           which use a simulated power button to initiate a controlled poweroff,
 196           but which may not want to run a separate userspace daemon to process
 197           input events.
 198
 199 config ACPI_TINY_POWER_BUTTON_SIGNAL
 200         int "Tiny Power Button Signal"
 201         depends on ACPI_TINY_POWER_BUTTON
 202         default 38
 203         help
 204           Default signal to send to init in response to the power button.
 205
 206           Likely values here include 38 (SIGRTMIN+4) to power off, or 2
 207           (SIGINT) to simulate Ctrl+Alt+Del.
 208
 209 config ACPI_VIDEO
 210         tristate "Video"
 211         depends on BACKLIGHT_CLASS_DEVICE
 212         depends on INPUT
 213         depends on ACPI_WMI || !X86
 214         select THERMAL
 215         help
 216           This driver implements the ACPI Extensions For Display Adapters
 217           for integrated graphics devices on motherboard, as specified in
 218           ACPI 2.0 Specification, Appendix B.  This supports basic operations
 219           such as defining the video POST device, retrieving EDID information,
 220           and setting up a video output.
 221
 222           To compile this driver as a module, choose M here:
 223           the module will be called video.
 224
 225 config ACPI_FAN
 226         tristate "Fan"
 227         depends on THERMAL
 228         default y
 229         help
 230           This driver supports ACPI fan devices, allowing user-mode
 231           applications to perform basic fan control (on, off, status).
 232
 233           To compile this driver as a module, choose M here:
 234           the module will be called fan.
 235
 236 config ACPI_TAD
 237         tristate "ACPI Time and Alarm (TAD) Device Support"
 238         depends on SYSFS && PM_SLEEP
 239         help
 240           The ACPI Time and Alarm (TAD) device is an alternative to the Real
 241           Time Clock (RTC).  Its wake timers allow the system to transition from
 242           the S3 (or optionally S4/S5) state to S0 state after a time period
 243           elapses.  In comparison with the RTC Alarm, the TAD provides a larger
 244           scale of flexibility in the wake timers.  The time capabilities of the
 245           TAD maintain the time of day information across platform power
 246           transitions, and keep track of time even when the platform is turned
 247           off.
 248
 249 config ACPI_DOCK
 250         bool "Dock"
 251         help
 252           This driver supports ACPI-controlled docking stations and removable
 253           drive bays such as the IBM Ultrabay and the Dell Module Bay.
 254
 255 config ACPI_CPU_FREQ_PSS
 256         bool
 257
 258 config ACPI_PROCESSOR_CSTATE
 259         def_bool y
 260         depends on ACPI_PROCESSOR
 261         depends on X86
 262
 263 config ACPI_PROCESSOR_IDLE
 264         bool
 265         select CPU_IDLE
 266
 267 config ACPI_MCFG
 268         bool
 269
 270 config ACPI_CPPC_LIB
 271         bool
 272         depends on ACPI_PROCESSOR
 273         select MAILBOX
 274         select PCC
 275         help
 276           If this option is enabled, this file implements common functionality
 277           to parse CPPC tables as described in the ACPI 5.1+ spec. The
 278           routines implemented are meant to be used by other
 279           drivers to control CPU performance using CPPC semantics.
 280           If your platform does not support CPPC in firmware,
 281           leave this option disabled.
 282
 283 config ACPI_PROCESSOR
 284         tristate "Processor"
 285         depends on X86 || ARM64 || LOONGARCH
 286         select ACPI_PROCESSOR_IDLE
 287         select ACPI_CPU_FREQ_PSS if X86 || LOONGARCH
 288         select THERMAL
 289         default y
 290         help
 291           This driver adds support for the ACPI Processor package. It is required
 292           by several flavors of cpufreq performance-state, thermal, throttling and
 293           idle drivers.
 294
 295           To compile this driver as a module, choose M here:
 296           the module will be called processor.
 297
 298 config ACPI_IPMI
 299         tristate "IPMI"
 300         depends on IPMI_HANDLER
 301         help
 302           This driver enables the ACPI to access the BMC controller. And it
 303           uses the IPMI request/response message to communicate with BMC
 304           controller, which can be found on the server.
 305
 306           To compile this driver as a module, choose M here:
 307           the module will be called as acpi_ipmi.
 308
 309 config ACPI_HOTPLUG_CPU
 310         bool
 311         depends on ACPI_PROCESSOR && HOTPLUG_CPU
 312         select ACPI_CONTAINER
 313         default y
 314
 315 config ACPI_PROCESSOR_AGGREGATOR
 316         tristate "Processor Aggregator"
 317         depends on ACPI_PROCESSOR
 318         depends on X86
 319         help
 320           ACPI 4.0 defines processor Aggregator, which enables OS to perform
 321           specific processor configuration and control that applies to all
 322           processors in the platform. Currently only logical processor idling
 323           is defined, which is to reduce power consumption. This driver
 324           supports the new device.
 325
 326 config ACPI_THERMAL
 327         tristate "Thermal Zone"
 328         depends on ACPI_PROCESSOR
 329         select THERMAL
 330         default y
 331         help
 332           This driver supports ACPI thermal zones.  Most mobile and
 333           some desktop systems support ACPI thermal zones.  It is HIGHLY
 334           recommended that this option be enabled, as your processor(s)
 335           may be damaged without it.
 336
 337           To compile this driver as a module, choose M here:
 338           the module will be called thermal.
 339
 340 config ACPI_PLATFORM_PROFILE
 341         tristate
 342
 343 config ACPI_CUSTOM_DSDT_FILE
 344         string "Custom DSDT Table file to include"
 345         default ""
 346         depends on !STANDALONE
 347         help
 348           This option supports a custom DSDT by linking it into the kernel.
 349
 350           Enter the full path name to the file which includes the AmlCode
 351           or dsdt_aml_code declaration.
 352
 353           If unsure, don't enter a file name.
 354
 355 config ACPI_CUSTOM_DSDT
 356         bool
 357         default ACPI_CUSTOM_DSDT_FILE != ""
 358
 359 config ARCH_HAS_ACPI_TABLE_UPGRADE
 360         def_bool n
 361
 362 config ACPI_TABLE_UPGRADE
 363         bool "Allow upgrading ACPI tables via initrd"
 364         depends on BLK_DEV_INITRD && ARCH_HAS_ACPI_TABLE_UPGRADE
 365         default y
 366         help
 367           This option provides functionality to upgrade arbitrary ACPI tables
 368           via initrd. No functional change if no ACPI tables are passed via
 369           initrd, therefore it's safe to say Y.
 370           See Documentation/admin-guide/acpi/initrd_table_override.rst for details
 371
 372 config ACPI_TABLE_OVERRIDE_VIA_BUILTIN_INITRD
 373         bool "Override ACPI tables from built-in initrd"
 374         depends on ACPI_TABLE_UPGRADE
 375         depends on INITRAMFS_SOURCE!="" && INITRAMFS_COMPRESSION_NONE
 376         help
 377           This option provides functionality to override arbitrary ACPI tables
 378           from built-in uncompressed initrd.
 379
 380           See Documentation/admin-guide/acpi/initrd_table_override.rst for details
 381
 382 config ACPI_DEBUG
 383         bool "Debug Statements"
 384         help
 385           The ACPI subsystem can produce debug output.  Saying Y enables this
 386           output and increases the kernel size by around 50K.
 387
 388           Use the acpi.debug_layer and acpi.debug_level kernel command-line
 389           parameters documented in Documentation/firmware-guide/acpi/debug.rst and
 390           Documentation/admin-guide/kernel-parameters.rst to control the type and
 391           amount of debug output.
 392
 393 config ACPI_PCI_SLOT
 394         bool "PCI slot detection driver"
 395         depends on SYSFS && PCI
 396         help
 397           This driver creates entries in /sys/bus/pci/slots/ for all PCI
 398           slots in the system.  This can help correlate PCI bus addresses,
 399           i.e., segment/bus/device/function tuples, with physical slots in
 400           the system.  If you are unsure, say N.
 401
 402 config ACPI_CONTAINER
 403         bool "Container and Module Devices"
 404         default (ACPI_HOTPLUG_MEMORY || ACPI_HOTPLUG_CPU)
 405         help
 406           This driver supports ACPI Container and Module devices (IDs
 407           ACPI0004, PNP0A05, and PNP0A06).
 408
 409           This helps support hotplug of nodes, CPUs, and memory.
 410
 411 config ACPI_HOTPLUG_MEMORY
 412         bool "Memory Hotplug"
 413         depends on MEMORY_HOTPLUG
 414         help
 415           This driver supports ACPI memory hotplug.  The driver
 416           fields notifications on ACPI memory devices (PNP0C80),
 417           which represent memory ranges that may be onlined or
 418           offlined during runtime.
 419
 420           If your hardware and firmware do not support adding or
 421           removing memory devices at runtime, you need not enable
 422           this driver.
 423
 424 config ACPI_HOTPLUG_IOAPIC
 425         bool
 426         depends on PCI
 427         depends on X86_IO_APIC
 428         default y
 429
 430 config ACPI_SBS
 431         tristate "Smart Battery System"
 432         depends on X86
 433         select POWER_SUPPLY
 434         help
 435           This driver supports the Smart Battery System, another
 436           type of access to battery information, found on some laptops.
 437
 438           To compile this driver as a module, choose M here:
 439           the modules will be called sbs and sbshc.
 440
 441 config ACPI_HED
 442         tristate "Hardware Error Device"
 443         help
 444           This driver supports the Hardware Error Device (PNP0C33),
 445           which is used to report some hardware errors notified via
 446           SCI, mainly the corrected errors.
 447
 448 config ACPI_CUSTOM_METHOD
 449         tristate "Allow ACPI methods to be inserted/replaced at run time"
 450         depends on DEBUG_FS
 451         help
 452           This debug facility allows ACPI AML methods to be inserted and/or
 453           replaced without rebooting the system. For details refer to:
 454           Documentation/firmware-guide/acpi/method-customizing.rst.
 455
 456           NOTE: This option is security sensitive, because it allows arbitrary
 457           kernel memory to be written to by root (uid=0) users, allowing them
 458           to bypass certain security measures (e.g. if root is not allowed to
 459           load additional kernel modules after boot, this feature may be used
 460           to override that restriction).
 461
 462 config ACPI_BGRT
 463         bool "Boottime Graphics Resource Table support"
 464         depends on EFI && (X86 || ARM64)
 465         help
 466           This driver adds support for exposing the ACPI Boottime Graphics
 467           Resource Table, which allows the operating system to obtain
 468           data from the firmware boot splash. It will appear under
 469           /sys/firmware/acpi/bgrt/ .
 470
 471 config ACPI_REDUCED_HARDWARE_ONLY
 472         bool "Hardware-reduced ACPI support only" if EXPERT
 473         def_bool n
 474         help
 475           This config item changes the way the ACPI code is built.  When this
 476           option is selected, the kernel will use a specialized version of
 477           ACPICA that ONLY supports the ACPI "reduced hardware" mode.  The
 478           resulting kernel will be smaller but it will also be restricted to
 479           running in ACPI reduced hardware mode ONLY.
 480
 481           If you are unsure what to do, do not enable this option.
 482
 483 source "drivers/acpi/nfit/Kconfig"
 484 source "drivers/acpi/numa/Kconfig"
 485 source "drivers/acpi/apei/Kconfig"
 486 source "drivers/acpi/dptf/Kconfig"
 487
 488 config ACPI_WATCHDOG
 489         bool
 490
 491 config ACPI_EXTLOG
 492         tristate "Extended Error Log support"
 493         depends on X86_MCE && X86_LOCAL_APIC && EDAC
 494         select UEFI_CPER
 495         help
 496           Certain usages such as Predictive Failure Analysis (PFA) require
 497           more information about the error than what can be described in
 498           processor machine check banks. Most server processors log
 499           additional information about the error in processor uncore
 500           registers. Since the addresses and layout of these registers vary
 501           widely from one processor to another, system software cannot
 502           readily make use of them. To complicate matters further, some of
 503           the additional error information cannot be constructed without
 504           detailed knowledge about platform topology.
 505
 506           Enhanced MCA Logging allows firmware to provide additional error
 507           information to system software, synchronous with MCE or CMCI. This
 508           driver adds support for that functionality with corresponding
 509           tracepoint which carries that information to userspace.
 510
 511 config ACPI_ADXL
 512         bool
 513
 514 config ACPI_CONFIGFS
 515         tristate "ACPI configfs support"
 516         select CONFIGFS_FS
 517         help
 518           Select this option to enable support for ACPI configuration from
 519           userspace. The configurable ACPI groups will be visible under
 520           /config/acpi, assuming configfs is mounted under /config.
 521
 522 config ACPI_PFRUT
 523         tristate "ACPI Platform Firmware Runtime Update and Telemetry"
 524         depends on 64BIT
 525         help
 526           This mechanism allows certain pieces of the platform firmware
 527           to be updated on the fly while the system is running (runtime)
 528           without the need to restart it, which is key in the cases when
 529           the system needs to be available 100% of the time and it cannot
 530           afford the downtime related to restarting it, or when the work
 531           carried out by the system is particularly important, so it cannot
 532           be interrupted, and it is not practical to wait until it is complete.
 533
 534           The existing firmware code can be modified (driver update) or
 535           extended by adding new code to the firmware (code injection).
 536
 537           Besides, the telemetry driver allows user space to fetch telemetry
 538           data from the firmware with the help of the Platform Firmware Runtime
 539           Telemetry interface.
 540
 541           To compile the drivers as modules, choose M here:
 542           the modules will be called pfr_update and pfr_telemetry.
 543
 544 if ARM64
 545 source "drivers/acpi/arm64/Kconfig"
 546 endif
 547
 548 config ACPI_PPTT
 549         bool
 550
 551 config ACPI_PCC
 552         bool "ACPI PCC Address Space"
 553         depends on PCC
 554         default y
 555         help
 556           The PCC Address Space also referred as PCC Operation Region pertains
 557           to the region of PCC subspace that succeeds the PCC signature.
 558
 559           The PCC Operation Region works in conjunction with the PCC Table
 560           (Platform Communications Channel Table). PCC subspaces that are
 561           marked for use as PCC Operation Regions must not be used as PCC
 562           subspaces for the standard ACPI features such as CPPC, RASF, PDTT and
 563           MPST. These standard features must always use the PCC Table instead.
 564
 565           Enable this feature if you want to set up and install the PCC Address
 566           Space handler to handle PCC OpRegion in the firmware.
 567
 568 config ACPI_FFH
 569         bool "ACPI FFH Address Space"
 570         default n
 571         help
 572           The FFH(Fixed Function Hardware) Address Space also referred as FFH
 573           Operation Region allows to define platform specific opregion.
 574
 575           Enable this feature if you want to set up and install the FFH Address
 576           Space handler to handle FFH OpRegion in the firmware.
 577
 578 source "drivers/acpi/pmic/Kconfig"
 579
 580 config ACPI_VIOT
 581         bool
 582
 583 config ACPI_PRMT
 584         bool "Platform Runtime Mechanism Support"
 585         depends on EFI_RUNTIME_WRAPPERS && (X86_64 || ARM64)
 586         default y
 587         help
 588           Platform Runtime Mechanism (PRM) is a firmware interface exposing a
 589           set of binary executables that can be called from the AML interpreter
 590           or directly from device drivers.
 591
 592           Say Y to enable the AML interpreter to execute the PRM code.
 593
 594           While this feature is optional in principle, leaving it out may
 595           substantially increase computational overhead related to the
 596           initialization of some server systems.
 597
 598 endif   # ACPI
 599
 600 config X86_PM_TIMER
 601         bool "Power Management Timer Support" if EXPERT
 602         depends on X86 && (ACPI || JAILHOUSE_GUEST)
 603         default y
 604         help
 605           The Power Management Timer is available on all ACPI-capable,
 606           in most cases even if ACPI is unusable or blacklisted.
 607
 608           This timing source is not affected by power management features
 609           like aggressive processor idling, throttling, frequency and/or
 610           voltage scaling, unlike the commonly used Time Stamp Counter
 611           (TSC) timing source.
 612
 613           You should nearly always say Y here because many modern
 614           systems require this timer.