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