1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * acpi.h - ACPI Interface
4 *
5 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
6 */
7
8#ifndef _LINUX_ACPI_H
9#define _LINUX_ACPI_H
10
11#include <linux/errno.h>
12#include <linux/ioport.h>	/* for struct resource */
13#include <linux/resource_ext.h>
14#include <linux/device.h>
15#include <linux/mod_devicetable.h>
16#include <linux/property.h>
17#include <linux/uuid.h>
18#include <linux/node.h>
19
20struct irq_domain;
21struct irq_domain_ops;
22
23#ifndef _LINUX
24#define _LINUX
25#endif
26#include <acpi/acpi.h>
27
28#ifdef	CONFIG_ACPI
29
30#include <linux/list.h>
31#include <linux/dynamic_debug.h>
32#include <linux/module.h>
33#include <linux/mutex.h>
34#include <linux/fw_table.h>
35
36#include <acpi/acpi_bus.h>
37#include <acpi/acpi_drivers.h>
38#include <acpi/acpi_numa.h>
39#include <acpi/acpi_io.h>
40#include <asm/acpi.h>
41
42#ifdef CONFIG_ACPI_TABLE_LIB
43#define EXPORT_SYMBOL_ACPI_LIB(x) EXPORT_SYMBOL_NS_GPL(x, ACPI)
44#define __init_or_acpilib
45#define __initdata_or_acpilib
46#else
47#define EXPORT_SYMBOL_ACPI_LIB(x)
48#define __init_or_acpilib __init
49#define __initdata_or_acpilib __initdata
50#endif
51
52static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
53{
54	return adev ? adev->handle : NULL;
55}
56
57#define ACPI_COMPANION(dev)		to_acpi_device_node((dev)->fwnode)
58#define ACPI_COMPANION_SET(dev, adev)	set_primary_fwnode(dev, (adev) ? \
59	acpi_fwnode_handle(adev) : NULL)
60#define ACPI_HANDLE(dev)		acpi_device_handle(ACPI_COMPANION(dev))
61#define ACPI_HANDLE_FWNODE(fwnode)	\
62				acpi_device_handle(to_acpi_device_node(fwnode))
63
64static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
65{
66	struct fwnode_handle *fwnode;
67
68	fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
69	if (!fwnode)
70		return NULL;
71
72	fwnode_init(fwnode, &acpi_static_fwnode_ops);
73
74	return fwnode;
75}
76
77static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
78{
79	if (WARN_ON(!is_acpi_static_node(fwnode)))
80		return;
81
82	kfree(fwnode);
83}
84
85static inline bool has_acpi_companion(struct device *dev)
86{
87	return is_acpi_device_node(dev->fwnode);
88}
89
90static inline void acpi_preset_companion(struct device *dev,
91					 struct acpi_device *parent, u64 addr)
92{
93	ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
94}
95
96static inline const char *acpi_dev_name(struct acpi_device *adev)
97{
98	return dev_name(&adev->dev);
99}
100
101struct device *acpi_get_first_physical_node(struct acpi_device *adev);
102
103enum acpi_irq_model_id {
104	ACPI_IRQ_MODEL_PIC = 0,
105	ACPI_IRQ_MODEL_IOAPIC,
106	ACPI_IRQ_MODEL_IOSAPIC,
107	ACPI_IRQ_MODEL_PLATFORM,
108	ACPI_IRQ_MODEL_GIC,
109	ACPI_IRQ_MODEL_LPIC,
110	ACPI_IRQ_MODEL_COUNT
111};
112
113extern enum acpi_irq_model_id	acpi_irq_model;
114
115enum acpi_interrupt_id {
116	ACPI_INTERRUPT_PMI	= 1,
117	ACPI_INTERRUPT_INIT,
118	ACPI_INTERRUPT_CPEI,
119	ACPI_INTERRUPT_COUNT
120};
121
122#define	ACPI_SPACE_MEM		0
123
124enum acpi_address_range_id {
125	ACPI_ADDRESS_RANGE_MEMORY = 1,
126	ACPI_ADDRESS_RANGE_RESERVED = 2,
127	ACPI_ADDRESS_RANGE_ACPI = 3,
128	ACPI_ADDRESS_RANGE_NVS	= 4,
129	ACPI_ADDRESS_RANGE_COUNT
130};
131
132
133/* Table Handlers */
134typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
135
136/* Debugger support */
137
138struct acpi_debugger_ops {
139	int (*create_thread)(acpi_osd_exec_callback function, void *context);
140	ssize_t (*write_log)(const char *msg);
141	ssize_t (*read_cmd)(char *buffer, size_t length);
142	int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
143	int (*notify_command_complete)(void);
144};
145
146struct acpi_debugger {
147	const struct acpi_debugger_ops *ops;
148	struct module *owner;
149	struct mutex lock;
150};
151
152#ifdef CONFIG_ACPI_DEBUGGER
153int __init acpi_debugger_init(void);
154int acpi_register_debugger(struct module *owner,
155			   const struct acpi_debugger_ops *ops);
156void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
157int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
158ssize_t acpi_debugger_write_log(const char *msg);
159ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
160int acpi_debugger_wait_command_ready(void);
161int acpi_debugger_notify_command_complete(void);
162#else
163static inline int acpi_debugger_init(void)
164{
165	return -ENODEV;
166}
167
168static inline int acpi_register_debugger(struct module *owner,
169					 const struct acpi_debugger_ops *ops)
170{
171	return -ENODEV;
172}
173
174static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
175{
176}
177
178static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
179					      void *context)
180{
181	return -ENODEV;
182}
183
184static inline int acpi_debugger_write_log(const char *msg)
185{
186	return -ENODEV;
187}
188
189static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
190{
191	return -ENODEV;
192}
193
194static inline int acpi_debugger_wait_command_ready(void)
195{
196	return -ENODEV;
197}
198
199static inline int acpi_debugger_notify_command_complete(void)
200{
201	return -ENODEV;
202}
203#endif
204
205#define BAD_MADT_ENTRY(entry, end) (					    \
206		(!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
207		((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
208
209void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
210void __acpi_unmap_table(void __iomem *map, unsigned long size);
211int early_acpi_boot_init(void);
212int acpi_boot_init (void);
213void acpi_boot_table_prepare (void);
214void acpi_boot_table_init (void);
215int acpi_mps_check (void);
216int acpi_numa_init (void);
217
218int acpi_locate_initial_tables (void);
219void acpi_reserve_initial_tables (void);
220void acpi_table_init_complete (void);
221int acpi_table_init (void);
222
223int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
224int __init_or_acpilib acpi_table_parse_entries(char *id,
225		unsigned long table_size, int entry_id,
226		acpi_tbl_entry_handler handler, unsigned int max_entries);
227int __init_or_acpilib acpi_table_parse_entries_array(char *id,
228		unsigned long table_size, struct acpi_subtable_proc *proc,
229		int proc_num, unsigned int max_entries);
230int acpi_table_parse_madt(enum acpi_madt_type id,
231			  acpi_tbl_entry_handler handler,
232			  unsigned int max_entries);
233int __init_or_acpilib
234acpi_table_parse_cedt(enum acpi_cedt_type id,
235		      acpi_tbl_entry_handler_arg handler_arg, void *arg);
236
237int acpi_parse_mcfg (struct acpi_table_header *header);
238void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
239
240static inline bool acpi_gicc_is_usable(struct acpi_madt_generic_interrupt *gicc)
241{
242	return gicc->flags & ACPI_MADT_ENABLED;
243}
244
245/* the following numa functions are architecture-dependent */
246void acpi_numa_slit_init (struct acpi_table_slit *slit);
247
248#if defined(CONFIG_X86) || defined(CONFIG_LOONGARCH)
249void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
250#else
251static inline void
252acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
253#endif
254
255void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
256
257#if defined(CONFIG_ARM64) || defined(CONFIG_LOONGARCH)
258void acpi_arch_dma_setup(struct device *dev);
259#else
260static inline void acpi_arch_dma_setup(struct device *dev) { }
261#endif
262
263#ifdef CONFIG_ARM64
264void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
265#else
266static inline void
267acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
268#endif
269
270int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
271
272#ifndef PHYS_CPUID_INVALID
273typedef u32 phys_cpuid_t;
274#define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
275#endif
276
277static inline bool invalid_logical_cpuid(u32 cpuid)
278{
279	return (int)cpuid < 0;
280}
281
282static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
283{
284	return phys_id == PHYS_CPUID_INVALID;
285}
286
287/* Validate the processor object's proc_id */
288bool acpi_duplicate_processor_id(int proc_id);
289/* Processor _CTS control */
290struct acpi_processor_power;
291
292#ifdef CONFIG_ACPI_PROCESSOR_CSTATE
293bool acpi_processor_claim_cst_control(void);
294int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
295				struct acpi_processor_power *info);
296#else
297static inline bool acpi_processor_claim_cst_control(void) { return false; }
298static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
299					      struct acpi_processor_power *info)
300{
301	return -ENODEV;
302}
303#endif
304
305#ifdef CONFIG_ACPI_HOTPLUG_CPU
306/* Arch dependent functions for cpu hotplug support */
307int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
308		 int *pcpu);
309int acpi_unmap_cpu(int cpu);
310#endif /* CONFIG_ACPI_HOTPLUG_CPU */
311
312#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
313int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
314#endif
315
316int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
317int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
318int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
319void acpi_irq_stats_init(void);
320extern u32 acpi_irq_handled;
321extern u32 acpi_irq_not_handled;
322extern unsigned int acpi_sci_irq;
323extern bool acpi_no_s5;
324#define INVALID_ACPI_IRQ	((unsigned)-1)
325static inline bool acpi_sci_irq_valid(void)
326{
327	return acpi_sci_irq != INVALID_ACPI_IRQ;
328}
329
330extern int sbf_port;
331extern unsigned long acpi_realmode_flags;
332
333int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
334int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
335int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
336
337void acpi_set_irq_model(enum acpi_irq_model_id model,
338			struct fwnode_handle *(*)(u32));
339void acpi_set_gsi_to_irq_fallback(u32 (*)(u32));
340
341struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
342					     unsigned int size,
343					     struct fwnode_handle *fwnode,
344					     const struct irq_domain_ops *ops,
345					     void *host_data);
346
347#ifdef CONFIG_X86_IO_APIC
348extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
349#else
350static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
351{
352	return -1;
353}
354#endif
355/*
356 * This function undoes the effect of one call to acpi_register_gsi().
357 * If this matches the last registration, any IRQ resources for gsi
358 * are freed.
359 */
360void acpi_unregister_gsi (u32 gsi);
361
362struct pci_dev;
363
364int acpi_pci_irq_enable (struct pci_dev *dev);
365void acpi_penalize_isa_irq(int irq, int active);
366bool acpi_isa_irq_available(int irq);
367#ifdef CONFIG_PCI
368void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
369#else
370static inline void acpi_penalize_sci_irq(int irq, int trigger,
371					int polarity)
372{
373}
374#endif
375void acpi_pci_irq_disable (struct pci_dev *dev);
376
377extern int ec_read(u8 addr, u8 *val);
378extern int ec_write(u8 addr, u8 val);
379extern int ec_transaction(u8 command,
380                          const u8 *wdata, unsigned wdata_len,
381                          u8 *rdata, unsigned rdata_len);
382extern acpi_handle ec_get_handle(void);
383
384extern bool acpi_is_pnp_device(struct acpi_device *);
385
386#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
387
388typedef void (*wmi_notify_handler) (u32 value, void *context);
389
390int wmi_instance_count(const char *guid);
391
392extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
393					u32 method_id,
394					const struct acpi_buffer *in,
395					struct acpi_buffer *out);
396extern acpi_status wmi_query_block(const char *guid, u8 instance,
397					struct acpi_buffer *out);
398extern acpi_status wmi_set_block(const char *guid, u8 instance,
399					const struct acpi_buffer *in);
400extern acpi_status wmi_install_notify_handler(const char *guid,
401					wmi_notify_handler handler, void *data);
402extern acpi_status wmi_remove_notify_handler(const char *guid);
403extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
404extern bool wmi_has_guid(const char *guid);
405extern char *wmi_get_acpi_device_uid(const char *guid);
406
407#endif	/* CONFIG_ACPI_WMI */
408
409#define ACPI_VIDEO_OUTPUT_SWITCHING			0x0001
410#define ACPI_VIDEO_DEVICE_POSTING			0x0002
411#define ACPI_VIDEO_ROM_AVAILABLE			0x0004
412#define ACPI_VIDEO_BACKLIGHT				0x0008
413#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR		0x0010
414#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO		0x0020
415#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR	0x0040
416#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO		0x0080
417#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR			0x0100
418#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO			0x0200
419#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR		0x0400
420#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO		0x0800
421
422extern char acpi_video_backlight_string[];
423extern long acpi_is_video_device(acpi_handle handle);
424extern int acpi_blacklisted(void);
425extern void acpi_osi_setup(char *str);
426extern bool acpi_osi_is_win8(void);
427
428#ifdef CONFIG_ACPI_THERMAL_LIB
429int thermal_acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
430int thermal_acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
431int thermal_acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
432int thermal_acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
433#endif
434
435#ifdef CONFIG_ACPI_HMAT
436int acpi_get_genport_coordinates(u32 uid, struct access_coordinate *coord);
437#else
438static inline int acpi_get_genport_coordinates(u32 uid,
439					       struct access_coordinate *coord)
440{
441	return -EOPNOTSUPP;
442}
443#endif
444
445#ifdef CONFIG_ACPI_NUMA
446int acpi_map_pxm_to_node(int pxm);
447int acpi_get_node(acpi_handle handle);
448
449/**
450 * pxm_to_online_node - Map proximity ID to online node
451 * @pxm: ACPI proximity ID
452 *
453 * This is similar to pxm_to_node(), but always returns an online
454 * node.  When the mapped node from a given proximity ID is offline, it
455 * looks up the node distance table and returns the nearest online node.
456 *
457 * ACPI device drivers, which are called after the NUMA initialization has
458 * completed in the kernel, can call this interface to obtain their device
459 * NUMA topology from ACPI tables.  Such drivers do not have to deal with
460 * offline nodes.  A node may be offline when SRAT memory entry does not exist,
461 * or NUMA is disabled, ex. "numa=off" on x86.
462 */
463static inline int pxm_to_online_node(int pxm)
464{
465	int node = pxm_to_node(pxm);
466
467	return numa_map_to_online_node(node);
468}
469#else
470static inline int pxm_to_online_node(int pxm)
471{
472	return 0;
473}
474static inline int acpi_map_pxm_to_node(int pxm)
475{
476	return 0;
477}
478static inline int acpi_get_node(acpi_handle handle)
479{
480	return 0;
481}
482#endif
483extern int pnpacpi_disabled;
484
485#define PXM_INVAL	(-1)
486
487bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
488bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
489bool acpi_dev_resource_address_space(struct acpi_resource *ares,
490				     struct resource_win *win);
491bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
492					 struct resource_win *win);
493unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable, u8 wake_capable);
494unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
495bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
496				 struct resource *res);
497
498void acpi_dev_free_resource_list(struct list_head *list);
499int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
500			   int (*preproc)(struct acpi_resource *, void *),
501			   void *preproc_data);
502int acpi_dev_get_dma_resources(struct acpi_device *adev,
503			       struct list_head *list);
504int acpi_dev_get_memory_resources(struct acpi_device *adev, struct list_head *list);
505int acpi_dev_filter_resource_type(struct acpi_resource *ares,
506				  unsigned long types);
507
508static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
509						   void *arg)
510{
511	return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
512}
513
514struct acpi_device *acpi_resource_consumer(struct resource *res);
515
516int acpi_check_resource_conflict(const struct resource *res);
517
518int acpi_check_region(resource_size_t start, resource_size_t n,
519		      const char *name);
520
521int acpi_resources_are_enforced(void);
522
523#ifdef CONFIG_HIBERNATION
524extern int acpi_check_s4_hw_signature;
525#endif
526
527#ifdef CONFIG_PM_SLEEP
528void __init acpi_old_suspend_ordering(void);
529void __init acpi_nvs_nosave(void);
530void __init acpi_nvs_nosave_s3(void);
531void __init acpi_sleep_no_blacklist(void);
532#endif /* CONFIG_PM_SLEEP */
533
534int acpi_register_wakeup_handler(
535	int wake_irq, bool (*wakeup)(void *context), void *context);
536void acpi_unregister_wakeup_handler(
537	bool (*wakeup)(void *context), void *context);
538
539struct acpi_osc_context {
540	char *uuid_str;			/* UUID string */
541	int rev;
542	struct acpi_buffer cap;		/* list of DWORD capabilities */
543	struct acpi_buffer ret;		/* free by caller if success */
544};
545
546acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
547
548/* Number of _OSC capability DWORDS depends on bridge type */
549#define OSC_PCI_CAPABILITY_DWORDS		3
550#define OSC_CXL_CAPABILITY_DWORDS		5
551
552/* Indexes into _OSC Capabilities Buffer (DWORDs 2 to 5 are device-specific) */
553#define OSC_QUERY_DWORD				0	/* DWORD 1 */
554#define OSC_SUPPORT_DWORD			1	/* DWORD 2 */
555#define OSC_CONTROL_DWORD			2	/* DWORD 3 */
556#define OSC_EXT_SUPPORT_DWORD			3	/* DWORD 4 */
557#define OSC_EXT_CONTROL_DWORD			4	/* DWORD 5 */
558
559/* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
560#define OSC_QUERY_ENABLE			0x00000001  /* input */
561#define OSC_REQUEST_ERROR			0x00000002  /* return */
562#define OSC_INVALID_UUID_ERROR			0x00000004  /* return */
563#define OSC_INVALID_REVISION_ERROR		0x00000008  /* return */
564#define OSC_CAPABILITIES_MASK_ERROR		0x00000010  /* return */
565
566/* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
567#define OSC_SB_PAD_SUPPORT			0x00000001
568#define OSC_SB_PPC_OST_SUPPORT			0x00000002
569#define OSC_SB_PR3_SUPPORT			0x00000004
570#define OSC_SB_HOTPLUG_OST_SUPPORT		0x00000008
571#define OSC_SB_APEI_SUPPORT			0x00000010
572#define OSC_SB_CPC_SUPPORT			0x00000020
573#define OSC_SB_CPCV2_SUPPORT			0x00000040
574#define OSC_SB_PCLPI_SUPPORT			0x00000080
575#define OSC_SB_OSLPI_SUPPORT			0x00000100
576#define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT		0x00001000
577#define OSC_SB_GENERIC_INITIATOR_SUPPORT	0x00002000
578#define OSC_SB_CPC_FLEXIBLE_ADR_SPACE		0x00004000
579#define OSC_SB_NATIVE_USB4_SUPPORT		0x00040000
580#define OSC_SB_PRM_SUPPORT			0x00200000
581#define OSC_SB_FFH_OPR_SUPPORT			0x00400000
582
583extern bool osc_sb_apei_support_acked;
584extern bool osc_pc_lpi_support_confirmed;
585extern bool osc_sb_native_usb4_support_confirmed;
586extern bool osc_sb_cppc2_support_acked;
587extern bool osc_cpc_flexible_adr_space_confirmed;
588
589/* USB4 Capabilities */
590#define OSC_USB_USB3_TUNNELING			0x00000001
591#define OSC_USB_DP_TUNNELING			0x00000002
592#define OSC_USB_PCIE_TUNNELING			0x00000004
593#define OSC_USB_XDOMAIN				0x00000008
594
595extern u32 osc_sb_native_usb4_control;
596
597/* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
598#define OSC_PCI_EXT_CONFIG_SUPPORT		0x00000001
599#define OSC_PCI_ASPM_SUPPORT			0x00000002
600#define OSC_PCI_CLOCK_PM_SUPPORT		0x00000004
601#define OSC_PCI_SEGMENT_GROUPS_SUPPORT		0x00000008
602#define OSC_PCI_MSI_SUPPORT			0x00000010
603#define OSC_PCI_EDR_SUPPORT			0x00000080
604#define OSC_PCI_HPX_TYPE_3_SUPPORT		0x00000100
605
606/* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
607#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL	0x00000001
608#define OSC_PCI_SHPC_NATIVE_HP_CONTROL		0x00000002
609#define OSC_PCI_EXPRESS_PME_CONTROL		0x00000004
610#define OSC_PCI_EXPRESS_AER_CONTROL		0x00000008
611#define OSC_PCI_EXPRESS_CAPABILITY_CONTROL	0x00000010
612#define OSC_PCI_EXPRESS_LTR_CONTROL		0x00000020
613#define OSC_PCI_EXPRESS_DPC_CONTROL		0x00000080
614
615/* CXL _OSC: Capabilities DWORD 4: Support Field */
616#define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT	0x00000001
617#define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT	0x00000002
618#define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT	0x00000004
619#define OSC_CXL_NATIVE_HP_SUPPORT		0x00000008
620
621/* CXL _OSC: Capabilities DWORD 5: Control Field */
622#define OSC_CXL_ERROR_REPORTING_CONTROL		0x00000001
623
624static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
625{
626	u32 *ret = context->ret.pointer;
627
628	return ret[OSC_CONTROL_DWORD];
629}
630
631static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
632{
633	u32 *ret = context->ret.pointer;
634
635	return ret[OSC_EXT_CONTROL_DWORD];
636}
637
638#define ACPI_GSB_ACCESS_ATTRIB_QUICK		0x00000002
639#define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
640#define ACPI_GSB_ACCESS_ATTRIB_BYTE		0x00000006
641#define ACPI_GSB_ACCESS_ATTRIB_WORD		0x00000008
642#define ACPI_GSB_ACCESS_ATTRIB_BLOCK		0x0000000A
643#define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE	0x0000000B
644#define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL	0x0000000C
645#define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL	0x0000000D
646#define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES	0x0000000E
647#define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS	0x0000000F
648
649/* Enable _OST when all relevant hotplug operations are enabled */
650#if defined(CONFIG_ACPI_HOTPLUG_CPU) &&			\
651	defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&		\
652	defined(CONFIG_ACPI_CONTAINER)
653#define ACPI_HOTPLUG_OST
654#endif
655
656/* _OST Source Event Code (OSPM Action) */
657#define ACPI_OST_EC_OSPM_SHUTDOWN		0x100
658#define ACPI_OST_EC_OSPM_EJECT			0x103
659#define ACPI_OST_EC_OSPM_INSERTION		0x200
660
661/* _OST General Processing Status Code */
662#define ACPI_OST_SC_SUCCESS			0x0
663#define ACPI_OST_SC_NON_SPECIFIC_FAILURE	0x1
664#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY		0x2
665
666/* _OST OS Shutdown Processing (0x100) Status Code */
667#define ACPI_OST_SC_OS_SHUTDOWN_DENIED		0x80
668#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS	0x81
669#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED	0x82
670#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED	0x83
671
672/* _OST Ejection Request (0x3, 0x103) Status Code */
673#define ACPI_OST_SC_EJECT_NOT_SUPPORTED		0x80
674#define ACPI_OST_SC_DEVICE_IN_USE		0x81
675#define ACPI_OST_SC_DEVICE_BUSY			0x82
676#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY	0x83
677#define ACPI_OST_SC_EJECT_IN_PROGRESS		0x84
678
679/* _OST Insertion Request (0x200) Status Code */
680#define ACPI_OST_SC_INSERT_IN_PROGRESS		0x80
681#define ACPI_OST_SC_DRIVER_LOAD_FAILURE		0x81
682#define ACPI_OST_SC_INSERT_NOT_SUPPORTED	0x82
683
684enum acpi_predicate {
685	all_versions,
686	less_than_or_equal,
687	equal,
688	greater_than_or_equal,
689};
690
691/* Table must be terminted by a NULL entry */
692struct acpi_platform_list {
693	char	oem_id[ACPI_OEM_ID_SIZE+1];
694	char	oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
695	u32	oem_revision;
696	char	*table;
697	enum acpi_predicate pred;
698	char	*reason;
699	u32	data;
700};
701int acpi_match_platform_list(const struct acpi_platform_list *plat);
702
703extern void acpi_early_init(void);
704extern void acpi_subsystem_init(void);
705
706extern int acpi_nvs_register(__u64 start, __u64 size);
707
708extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
709				    void *data);
710
711const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
712						    const struct acpi_device *adev);
713
714const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
715					       const struct device *dev);
716
717const void *acpi_device_get_match_data(const struct device *dev);
718extern bool acpi_driver_match_device(struct device *dev,
719				     const struct device_driver *drv);
720int acpi_device_uevent_modalias(const struct device *, struct kobj_uevent_env *);
721int acpi_device_modalias(struct device *, char *, int);
722
723struct platform_device *acpi_create_platform_device(struct acpi_device *,
724						    const struct property_entry *);
725#define ACPI_PTR(_ptr)	(_ptr)
726
727static inline void acpi_device_set_enumerated(struct acpi_device *adev)
728{
729	adev->flags.visited = true;
730}
731
732static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
733{
734	adev->flags.visited = false;
735}
736
737enum acpi_reconfig_event  {
738	ACPI_RECONFIG_DEVICE_ADD = 0,
739	ACPI_RECONFIG_DEVICE_REMOVE,
740};
741
742int acpi_reconfig_notifier_register(struct notifier_block *nb);
743int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
744
745#ifdef CONFIG_ACPI_GTDT
746int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
747int acpi_gtdt_map_ppi(int type);
748bool acpi_gtdt_c3stop(int type);
749int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
750#endif
751
752#ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
753static inline void acpi_arch_set_root_pointer(u64 addr)
754{
755}
756#endif
757
758#ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
759static inline u64 acpi_arch_get_root_pointer(void)
760{
761	return 0;
762}
763#endif
764
765int acpi_get_local_address(acpi_handle handle, u32 *addr);
766const char *acpi_get_subsystem_id(acpi_handle handle);
767
768#else	/* !CONFIG_ACPI */
769
770#define acpi_disabled 1
771
772#define ACPI_COMPANION(dev)		(NULL)
773#define ACPI_COMPANION_SET(dev, adev)	do { } while (0)
774#define ACPI_HANDLE(dev)		(NULL)
775#define ACPI_HANDLE_FWNODE(fwnode)	(NULL)
776
777/* Get rid of the -Wunused-variable for adev */
778#define acpi_dev_uid_match(adev, uid2)			(adev && false)
779#define acpi_dev_hid_uid_match(adev, hid2, uid2)	(adev && false)
780
781#include <acpi/acpi_numa.h>
782
783struct fwnode_handle;
784
785static inline bool acpi_dev_found(const char *hid)
786{
787	return false;
788}
789
790static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
791{
792	return false;
793}
794
795struct acpi_device;
796
797static inline int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer)
798{
799	return -ENODEV;
800}
801
802static inline struct acpi_device *
803acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
804{
805	return NULL;
806}
807
808static inline bool acpi_reduced_hardware(void)
809{
810	return false;
811}
812
813static inline void acpi_dev_put(struct acpi_device *adev) {}
814
815static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
816{
817	return false;
818}
819
820static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
821{
822	return false;
823}
824
825static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
826{
827	return NULL;
828}
829
830static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
831{
832	return false;
833}
834
835static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
836{
837	return NULL;
838}
839
840static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
841					const char *name)
842{
843	return false;
844}
845
846static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
847{
848	return NULL;
849}
850
851static inline bool has_acpi_companion(struct device *dev)
852{
853	return false;
854}
855
856static inline void acpi_preset_companion(struct device *dev,
857					 struct acpi_device *parent, u64 addr)
858{
859}
860
861static inline const char *acpi_dev_name(struct acpi_device *adev)
862{
863	return NULL;
864}
865
866static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
867{
868	return NULL;
869}
870
871static inline void acpi_early_init(void) { }
872static inline void acpi_subsystem_init(void) { }
873
874static inline int early_acpi_boot_init(void)
875{
876	return 0;
877}
878static inline int acpi_boot_init(void)
879{
880	return 0;
881}
882
883static inline void acpi_boot_table_prepare(void)
884{
885}
886
887static inline void acpi_boot_table_init(void)
888{
889}
890
891static inline int acpi_mps_check(void)
892{
893	return 0;
894}
895
896static inline int acpi_check_resource_conflict(struct resource *res)
897{
898	return 0;
899}
900
901static inline int acpi_check_region(resource_size_t start, resource_size_t n,
902				    const char *name)
903{
904	return 0;
905}
906
907struct acpi_table_header;
908static inline int acpi_table_parse(char *id,
909				int (*handler)(struct acpi_table_header *))
910{
911	return -ENODEV;
912}
913
914static inline int acpi_nvs_register(__u64 start, __u64 size)
915{
916	return 0;
917}
918
919static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
920					   void *data)
921{
922	return 0;
923}
924
925struct acpi_device_id;
926
927static inline const struct acpi_device_id *acpi_match_acpi_device(
928	const struct acpi_device_id *ids, const struct acpi_device *adev)
929{
930	return NULL;
931}
932
933static inline const struct acpi_device_id *acpi_match_device(
934	const struct acpi_device_id *ids, const struct device *dev)
935{
936	return NULL;
937}
938
939static inline const void *acpi_device_get_match_data(const struct device *dev)
940{
941	return NULL;
942}
943
944static inline bool acpi_driver_match_device(struct device *dev,
945					    const struct device_driver *drv)
946{
947	return false;
948}
949
950static inline bool acpi_check_dsm(acpi_handle handle, const guid_t *guid,
951				  u64 rev, u64 funcs)
952{
953	return false;
954}
955
956static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
957						   const guid_t *guid,
958						   u64 rev, u64 func,
959						   union acpi_object *argv4)
960{
961	return NULL;
962}
963
964static inline union acpi_object *acpi_evaluate_dsm_typed(acpi_handle handle,
965							 const guid_t *guid,
966							 u64 rev, u64 func,
967							 union acpi_object *argv4,
968							 acpi_object_type type)
969{
970	return NULL;
971}
972
973static inline int acpi_device_uevent_modalias(const struct device *dev,
974				struct kobj_uevent_env *env)
975{
976	return -ENODEV;
977}
978
979static inline int acpi_device_modalias(struct device *dev,
980				char *buf, int size)
981{
982	return -ENODEV;
983}
984
985static inline struct platform_device *
986acpi_create_platform_device(struct acpi_device *adev,
987			    const struct property_entry *properties)
988{
989	return NULL;
990}
991
992static inline bool acpi_dma_supported(const struct acpi_device *adev)
993{
994	return false;
995}
996
997static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
998{
999	return DEV_DMA_NOT_SUPPORTED;
1000}
1001
1002static inline int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map)
1003{
1004	return -ENODEV;
1005}
1006
1007static inline int acpi_dma_configure(struct device *dev,
1008				     enum dev_dma_attr attr)
1009{
1010	return 0;
1011}
1012
1013static inline int acpi_dma_configure_id(struct device *dev,
1014					enum dev_dma_attr attr,
1015					const u32 *input_id)
1016{
1017	return 0;
1018}
1019
1020#define ACPI_PTR(_ptr)	(NULL)
1021
1022static inline void acpi_device_set_enumerated(struct acpi_device *adev)
1023{
1024}
1025
1026static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
1027{
1028}
1029
1030static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
1031{
1032	return -EINVAL;
1033}
1034
1035static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
1036{
1037	return -EINVAL;
1038}
1039
1040static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
1041{
1042	return NULL;
1043}
1044
1045static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
1046{
1047	return -ENODEV;
1048}
1049
1050static inline const char *acpi_get_subsystem_id(acpi_handle handle)
1051{
1052	return ERR_PTR(-ENODEV);
1053}
1054
1055static inline int acpi_register_wakeup_handler(int wake_irq,
1056	bool (*wakeup)(void *context), void *context)
1057{
1058	return -ENXIO;
1059}
1060
1061static inline void acpi_unregister_wakeup_handler(
1062	bool (*wakeup)(void *context), void *context) { }
1063
1064struct acpi_osc_context;
1065static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
1066{
1067	return 0;
1068}
1069
1070static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
1071{
1072	return 0;
1073}
1074
1075static inline bool acpi_sleep_state_supported(u8 sleep_state)
1076{
1077	return false;
1078}
1079
1080#endif	/* !CONFIG_ACPI */
1081
1082extern void arch_post_acpi_subsys_init(void);
1083
1084#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1085int acpi_ioapic_add(acpi_handle root);
1086#else
1087static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1088#endif
1089
1090#ifdef CONFIG_ACPI
1091void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1092			       u32 pm1a_ctrl,  u32 pm1b_ctrl));
1093
1094acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1095				  u32 pm1a_control, u32 pm1b_control);
1096
1097void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1098				        u32 val_a,  u32 val_b));
1099
1100acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1101					   u32 val_a, u32 val_b);
1102#if defined(CONFIG_SUSPEND) && defined(CONFIG_X86)
1103struct acpi_s2idle_dev_ops {
1104	struct list_head list_node;
1105	void (*prepare)(void);
1106	void (*check)(void);
1107	void (*restore)(void);
1108};
1109int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1110void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1111int acpi_get_lps0_constraint(struct acpi_device *adev);
1112#else /* CONFIG_SUSPEND && CONFIG_X86 */
1113static inline int acpi_get_lps0_constraint(struct device *dev)
1114{
1115	return ACPI_STATE_UNKNOWN;
1116}
1117#endif /* CONFIG_SUSPEND && CONFIG_X86 */
1118void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1119#else
1120#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1121#endif
1122
1123#if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1124int acpi_dev_suspend(struct device *dev, bool wakeup);
1125int acpi_dev_resume(struct device *dev);
1126int acpi_subsys_runtime_suspend(struct device *dev);
1127int acpi_subsys_runtime_resume(struct device *dev);
1128int acpi_dev_pm_attach(struct device *dev, bool power_on);
1129bool acpi_storage_d3(struct device *dev);
1130bool acpi_dev_state_d0(struct device *dev);
1131#else
1132static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1133static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1134static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1135{
1136	return 0;
1137}
1138static inline bool acpi_storage_d3(struct device *dev)
1139{
1140	return false;
1141}
1142static inline bool acpi_dev_state_d0(struct device *dev)
1143{
1144	return true;
1145}
1146#endif
1147
1148#if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1149int acpi_subsys_prepare(struct device *dev);
1150void acpi_subsys_complete(struct device *dev);
1151int acpi_subsys_suspend_late(struct device *dev);
1152int acpi_subsys_suspend_noirq(struct device *dev);
1153int acpi_subsys_suspend(struct device *dev);
1154int acpi_subsys_freeze(struct device *dev);
1155int acpi_subsys_poweroff(struct device *dev);
1156void acpi_ec_mark_gpe_for_wake(void);
1157void acpi_ec_set_gpe_wake_mask(u8 action);
1158int acpi_subsys_restore_early(struct device *dev);
1159#else
1160static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1161static inline void acpi_subsys_complete(struct device *dev) {}
1162static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1163static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1164static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1165static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1166static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1167static inline int acpi_subsys_restore_early(struct device *dev) { return 0; }
1168static inline void acpi_ec_mark_gpe_for_wake(void) {}
1169static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1170#endif
1171
1172#ifdef CONFIG_ACPI
1173char *acpi_handle_path(acpi_handle handle);
1174__printf(3, 4)
1175void acpi_handle_printk(const char *level, acpi_handle handle,
1176			const char *fmt, ...);
1177void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1178				  acpi_status status);
1179#else	/* !CONFIG_ACPI */
1180static inline __printf(3, 4) void
1181acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1182static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1183						const char *name,
1184						acpi_status status) {}
1185#endif	/* !CONFIG_ACPI */
1186
1187#if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1188__printf(3, 4)
1189void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1190#endif
1191
1192/*
1193 * acpi_handle_<level>: Print message with ACPI prefix and object path
1194 *
1195 * These interfaces acquire the global namespace mutex to obtain an object
1196 * path.  In interrupt context, it shows the object path as <n/a>.
1197 */
1198#define acpi_handle_emerg(handle, fmt, ...)				\
1199	acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1200#define acpi_handle_alert(handle, fmt, ...)				\
1201	acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1202#define acpi_handle_crit(handle, fmt, ...)				\
1203	acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1204#define acpi_handle_err(handle, fmt, ...)				\
1205	acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1206#define acpi_handle_warn(handle, fmt, ...)				\
1207	acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1208#define acpi_handle_notice(handle, fmt, ...)				\
1209	acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1210#define acpi_handle_info(handle, fmt, ...)				\
1211	acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1212
1213#if defined(DEBUG)
1214#define acpi_handle_debug(handle, fmt, ...)				\
1215	acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1216#else
1217#if defined(CONFIG_DYNAMIC_DEBUG)
1218#define acpi_handle_debug(handle, fmt, ...)				\
1219	_dynamic_func_call(fmt, __acpi_handle_debug,			\
1220			   handle, pr_fmt(fmt), ##__VA_ARGS__)
1221#else
1222#define acpi_handle_debug(handle, fmt, ...)				\
1223({									\
1224	if (0)								\
1225		acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1226	0;								\
1227})
1228#endif
1229#endif
1230
1231#if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1232bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1233				struct acpi_resource_gpio **agpio);
1234bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1235			       struct acpi_resource_gpio **agpio);
1236int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *name, int index,
1237				  bool *wake_capable);
1238#else
1239static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1240					      struct acpi_resource_gpio **agpio)
1241{
1242	return false;
1243}
1244static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1245					     struct acpi_resource_gpio **agpio)
1246{
1247	return false;
1248}
1249static inline int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *name,
1250						int index, bool *wake_capable)
1251{
1252	return -ENXIO;
1253}
1254#endif
1255
1256static inline int acpi_dev_gpio_irq_wake_get(struct acpi_device *adev, int index,
1257					     bool *wake_capable)
1258{
1259	return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, wake_capable);
1260}
1261
1262static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name,
1263					   int index)
1264{
1265	return acpi_dev_gpio_irq_wake_get_by(adev, name, index, NULL);
1266}
1267
1268static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1269{
1270	return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, NULL);
1271}
1272
1273/* Device properties */
1274
1275#ifdef CONFIG_ACPI
1276int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1277			  acpi_object_type type, const union acpi_object **obj);
1278int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1279				const char *name, size_t index, size_t num_args,
1280				struct fwnode_reference_args *args);
1281
1282static inline int acpi_node_get_property_reference(
1283				const struct fwnode_handle *fwnode,
1284				const char *name, size_t index,
1285				struct fwnode_reference_args *args)
1286{
1287	return __acpi_node_get_property_reference(fwnode, name, index,
1288		NR_FWNODE_REFERENCE_ARGS, args);
1289}
1290
1291static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1292{
1293	return !list_empty(&adev->data.properties);
1294}
1295
1296struct acpi_device_properties *
1297acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1298		    union acpi_object *properties);
1299
1300int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1301		       void **valptr);
1302
1303struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1304					    struct fwnode_handle *child);
1305
1306struct acpi_probe_entry;
1307typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1308						 struct acpi_probe_entry *);
1309
1310#define ACPI_TABLE_ID_LEN	5
1311
1312/**
1313 * struct acpi_probe_entry - boot-time probing entry
1314 * @id:			ACPI table name
1315 * @type:		Optional subtable type to match
1316 *			(if @id contains subtables)
1317 * @subtable_valid:	Optional callback to check the validity of
1318 *			the subtable
1319 * @probe_table:	Callback to the driver being probed when table
1320 *			match is successful
1321 * @probe_subtbl:	Callback to the driver being probed when table and
1322 *			subtable match (and optional callback is successful)
1323 * @driver_data:	Sideband data provided back to the driver
1324 */
1325struct acpi_probe_entry {
1326	__u8 id[ACPI_TABLE_ID_LEN];
1327	__u8 type;
1328	acpi_probe_entry_validate_subtbl subtable_valid;
1329	union {
1330		acpi_tbl_table_handler probe_table;
1331		acpi_tbl_entry_handler probe_subtbl;
1332	};
1333	kernel_ulong_t driver_data;
1334};
1335
1336#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,	\
1337				 valid, data, fn)			\
1338	static const struct acpi_probe_entry __acpi_probe_##name	\
1339		__used __section("__" #table "_acpi_probe_table") = {	\
1340			.id = table_id,					\
1341			.type = subtable,				\
1342			.subtable_valid = valid,			\
1343			.probe_table = fn,				\
1344			.driver_data = data,				\
1345		}
1346
1347#define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,	\
1348					  subtable, valid, data, fn)	\
1349	static const struct acpi_probe_entry __acpi_probe_##name	\
1350		__used __section("__" #table "_acpi_probe_table") = {	\
1351			.id = table_id,					\
1352			.type = subtable,				\
1353			.subtable_valid = valid,			\
1354			.probe_subtbl = fn,				\
1355			.driver_data = data,				\
1356		}
1357
1358#define ACPI_PROBE_TABLE(name)		__##name##_acpi_probe_table
1359#define ACPI_PROBE_TABLE_END(name)	__##name##_acpi_probe_table_end
1360
1361int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1362
1363#define acpi_probe_device_table(t)					\
1364	({ 								\
1365		extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),	\
1366			                       ACPI_PROBE_TABLE_END(t);	\
1367		__acpi_probe_device_table(&ACPI_PROBE_TABLE(t),		\
1368					  (&ACPI_PROBE_TABLE_END(t) -	\
1369					   &ACPI_PROBE_TABLE(t)));	\
1370	})
1371#else
1372static inline int acpi_dev_get_property(struct acpi_device *adev,
1373					const char *name, acpi_object_type type,
1374					const union acpi_object **obj)
1375{
1376	return -ENXIO;
1377}
1378
1379static inline int
1380__acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1381				const char *name, size_t index, size_t num_args,
1382				struct fwnode_reference_args *args)
1383{
1384	return -ENXIO;
1385}
1386
1387static inline int
1388acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1389				 const char *name, size_t index,
1390				 struct fwnode_reference_args *args)
1391{
1392	return -ENXIO;
1393}
1394
1395static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1396				     const char *propname,
1397				     void **valptr)
1398{
1399	return -ENXIO;
1400}
1401
1402static inline struct fwnode_handle *
1403acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1404		      struct fwnode_handle *child)
1405{
1406	return NULL;
1407}
1408
1409static inline struct fwnode_handle *
1410acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1411			     struct fwnode_handle *prev)
1412{
1413	return ERR_PTR(-ENXIO);
1414}
1415
1416static inline int
1417acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1418			       struct fwnode_handle **remote,
1419			       struct fwnode_handle **port,
1420			       struct fwnode_handle **endpoint)
1421{
1422	return -ENXIO;
1423}
1424
1425#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1426	static const void * __acpi_table_##name[]			\
1427		__attribute__((unused))					\
1428		 = { (void *) table_id,					\
1429		     (void *) subtable,					\
1430		     (void *) valid,					\
1431		     (void *) fn,					\
1432		     (void *) data }
1433
1434#define acpi_probe_device_table(t)	({ int __r = 0; __r;})
1435#endif
1436
1437#ifdef CONFIG_ACPI_TABLE_UPGRADE
1438void acpi_table_upgrade(void);
1439#else
1440static inline void acpi_table_upgrade(void) { }
1441#endif
1442
1443#if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1444extern bool acpi_has_watchdog(void);
1445#else
1446static inline bool acpi_has_watchdog(void) { return false; }
1447#endif
1448
1449#ifdef CONFIG_ACPI_SPCR_TABLE
1450extern bool qdf2400_e44_present;
1451int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1452#else
1453static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1454{
1455	return 0;
1456}
1457#endif
1458
1459#if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1460int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1461#else
1462static inline
1463int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1464{
1465	return -EINVAL;
1466}
1467#endif
1468
1469#ifdef CONFIG_ACPI_LPIT
1470int lpit_read_residency_count_address(u64 *address);
1471#else
1472static inline int lpit_read_residency_count_address(u64 *address)
1473{
1474	return -EINVAL;
1475}
1476#endif
1477
1478#ifdef CONFIG_ACPI_PROCESSOR_IDLE
1479#ifndef arch_get_idle_state_flags
1480static inline unsigned int arch_get_idle_state_flags(u32 arch_flags)
1481{
1482	return 0;
1483}
1484#endif
1485#endif /* CONFIG_ACPI_PROCESSOR_IDLE */
1486
1487#ifdef CONFIG_ACPI_PPTT
1488int acpi_pptt_cpu_is_thread(unsigned int cpu);
1489int find_acpi_cpu_topology(unsigned int cpu, int level);
1490int find_acpi_cpu_topology_cluster(unsigned int cpu);
1491int find_acpi_cpu_topology_package(unsigned int cpu);
1492int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1493#else
1494static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1495{
1496	return -EINVAL;
1497}
1498static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1499{
1500	return -EINVAL;
1501}
1502static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1503{
1504	return -EINVAL;
1505}
1506static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1507{
1508	return -EINVAL;
1509}
1510static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1511{
1512	return -EINVAL;
1513}
1514#endif
1515
1516#ifdef CONFIG_ARM64
1517void acpi_arm_init(void);
1518#else
1519static inline void acpi_arm_init(void) { }
1520#endif
1521
1522#ifdef CONFIG_ACPI_PCC
1523void acpi_init_pcc(void);
1524#else
1525static inline void acpi_init_pcc(void) { }
1526#endif
1527
1528#ifdef CONFIG_ACPI_FFH
1529void acpi_init_ffh(void);
1530extern int acpi_ffh_address_space_arch_setup(void *handler_ctxt,
1531					     void **region_ctxt);
1532extern int acpi_ffh_address_space_arch_handler(acpi_integer *value,
1533					       void *region_context);
1534#else
1535static inline void acpi_init_ffh(void) { }
1536#endif
1537
1538#ifdef CONFIG_ACPI
1539extern void acpi_device_notify(struct device *dev);
1540extern void acpi_device_notify_remove(struct device *dev);
1541#else
1542static inline void acpi_device_notify(struct device *dev) { }
1543static inline void acpi_device_notify_remove(struct device *dev) { }
1544#endif
1545
1546static inline void acpi_use_parent_companion(struct device *dev)
1547{
1548	ACPI_COMPANION_SET(dev, ACPI_COMPANION(dev->parent));
1549}
1550
1551#ifdef CONFIG_ACPI_HMAT
1552int hmat_update_target_coordinates(int nid, struct access_coordinate *coord,
1553				   enum access_coordinate_class access);
1554#else
1555static inline int hmat_update_target_coordinates(int nid,
1556						 struct access_coordinate *coord,
1557						 enum access_coordinate_class access)
1558{
1559	return -EOPNOTSUPP;
1560}
1561#endif
1562
1563#ifdef CONFIG_ACPI_NUMA
1564bool acpi_node_backed_by_real_pxm(int nid);
1565#else
1566static inline bool acpi_node_backed_by_real_pxm(int nid)
1567{
1568	return false;
1569}
1570#endif
1571
1572#endif	/*_LINUX_ACPI_H*/
1573