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