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