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