xref: /linux-6.15/include/linux/acpi.h (revision 09ea8089)
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 #include <acpi/acpi_numa.h>
28 
29 #ifdef	CONFIG_ACPI
30 
31 #include <linux/list.h>
32 #include <linux/dynamic_debug.h>
33 #include <linux/module.h>
34 #include <linux/mutex.h>
35 #include <linux/fw_table.h>
36 
37 #include <acpi/acpi_bus.h>
38 #include <acpi/acpi_drivers.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 #if defined(CONFIG_X86) || defined(CONFIG_LOONGARCH)
241 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
242 #else
243 static inline void
244 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
245 #endif
246 
247 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
248 
249 #if defined(CONFIG_ARM64) || defined(CONFIG_LOONGARCH)
250 void acpi_arch_dma_setup(struct device *dev);
251 #else
252 static inline void acpi_arch_dma_setup(struct device *dev) { }
253 #endif
254 
255 #ifdef CONFIG_ARM64
256 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
257 #else
258 static inline void
259 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
260 #endif
261 
262 #ifndef PHYS_CPUID_INVALID
263 typedef u32 phys_cpuid_t;
264 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
265 #endif
266 
267 static inline bool invalid_logical_cpuid(u32 cpuid)
268 {
269 	return (int)cpuid < 0;
270 }
271 
272 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
273 {
274 	return phys_id == PHYS_CPUID_INVALID;
275 }
276 
277 /* Validate the processor object's proc_id */
278 bool acpi_duplicate_processor_id(int proc_id);
279 /* Processor _CTS control */
280 struct acpi_processor_power;
281 
282 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
283 bool acpi_processor_claim_cst_control(void);
284 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
285 				struct acpi_processor_power *info);
286 #else
287 static inline bool acpi_processor_claim_cst_control(void) { return false; }
288 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
289 					      struct acpi_processor_power *info)
290 {
291 	return -ENODEV;
292 }
293 #endif
294 
295 #ifdef CONFIG_ACPI_HOTPLUG_CPU
296 /* Arch dependent functions for cpu hotplug support */
297 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
298 		 int *pcpu);
299 int acpi_unmap_cpu(int cpu);
300 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
301 
302 acpi_handle acpi_get_processor_handle(int cpu);
303 
304 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
305 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
306 #endif
307 
308 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
309 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
310 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
311 void acpi_irq_stats_init(void);
312 extern u32 acpi_irq_handled;
313 extern u32 acpi_irq_not_handled;
314 extern unsigned int acpi_sci_irq;
315 extern bool acpi_no_s5;
316 #define INVALID_ACPI_IRQ	((unsigned)-1)
317 static inline bool acpi_sci_irq_valid(void)
318 {
319 	return acpi_sci_irq != INVALID_ACPI_IRQ;
320 }
321 
322 extern int sbf_port;
323 extern unsigned long acpi_realmode_flags;
324 
325 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
326 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
327 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
328 
329 void acpi_set_irq_model(enum acpi_irq_model_id model,
330 			struct fwnode_handle *(*)(u32));
331 void acpi_set_gsi_to_irq_fallback(u32 (*)(u32));
332 
333 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
334 					     unsigned int size,
335 					     struct fwnode_handle *fwnode,
336 					     const struct irq_domain_ops *ops,
337 					     void *host_data);
338 
339 #ifdef CONFIG_X86_IO_APIC
340 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
341 #else
342 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
343 {
344 	return -1;
345 }
346 #endif
347 /*
348  * This function undoes the effect of one call to acpi_register_gsi().
349  * If this matches the last registration, any IRQ resources for gsi
350  * are freed.
351  */
352 void acpi_unregister_gsi (u32 gsi);
353 
354 struct pci_dev;
355 
356 int acpi_pci_irq_enable (struct pci_dev *dev);
357 void acpi_penalize_isa_irq(int irq, int active);
358 bool acpi_isa_irq_available(int irq);
359 #ifdef CONFIG_PCI
360 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
361 #else
362 static inline void acpi_penalize_sci_irq(int irq, int trigger,
363 					int polarity)
364 {
365 }
366 #endif
367 void acpi_pci_irq_disable (struct pci_dev *dev);
368 
369 extern int ec_read(u8 addr, u8 *val);
370 extern int ec_write(u8 addr, u8 val);
371 extern int ec_transaction(u8 command,
372                           const u8 *wdata, unsigned wdata_len,
373                           u8 *rdata, unsigned rdata_len);
374 extern acpi_handle ec_get_handle(void);
375 
376 extern bool acpi_is_pnp_device(struct acpi_device *);
377 
378 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
379 
380 typedef void (*wmi_notify_handler) (u32 value, void *context);
381 
382 int wmi_instance_count(const char *guid);
383 
384 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
385 					u32 method_id,
386 					const struct acpi_buffer *in,
387 					struct acpi_buffer *out);
388 extern acpi_status wmi_query_block(const char *guid, u8 instance,
389 					struct acpi_buffer *out);
390 extern acpi_status wmi_set_block(const char *guid, u8 instance,
391 					const struct acpi_buffer *in);
392 extern acpi_status wmi_install_notify_handler(const char *guid,
393 					wmi_notify_handler handler, void *data);
394 extern acpi_status wmi_remove_notify_handler(const char *guid);
395 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
396 extern bool wmi_has_guid(const char *guid);
397 extern char *wmi_get_acpi_device_uid(const char *guid);
398 
399 #endif	/* CONFIG_ACPI_WMI */
400 
401 #define ACPI_VIDEO_OUTPUT_SWITCHING			0x0001
402 #define ACPI_VIDEO_DEVICE_POSTING			0x0002
403 #define ACPI_VIDEO_ROM_AVAILABLE			0x0004
404 #define ACPI_VIDEO_BACKLIGHT				0x0008
405 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR		0x0010
406 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO		0x0020
407 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR	0x0040
408 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO		0x0080
409 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR			0x0100
410 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO			0x0200
411 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR		0x0400
412 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO		0x0800
413 
414 extern char acpi_video_backlight_string[];
415 extern long acpi_is_video_device(acpi_handle handle);
416 
417 extern void acpi_osi_setup(char *str);
418 extern bool acpi_osi_is_win8(void);
419 
420 #ifdef CONFIG_ACPI_THERMAL_LIB
421 int thermal_acpi_active_trip_temp(struct acpi_device *adev, int id, int *ret_temp);
422 int thermal_acpi_passive_trip_temp(struct acpi_device *adev, int *ret_temp);
423 int thermal_acpi_hot_trip_temp(struct acpi_device *adev, int *ret_temp);
424 int thermal_acpi_critical_trip_temp(struct acpi_device *adev, int *ret_temp);
425 #endif
426 
427 #ifdef CONFIG_ACPI_HMAT
428 int acpi_get_genport_coordinates(u32 uid, struct access_coordinate *coord);
429 #else
430 static inline int acpi_get_genport_coordinates(u32 uid,
431 					       struct access_coordinate *coord)
432 {
433 	return -EOPNOTSUPP;
434 }
435 #endif
436 
437 #ifdef CONFIG_ACPI_NUMA
438 int acpi_map_pxm_to_node(int pxm);
439 int acpi_get_node(acpi_handle handle);
440 
441 /**
442  * pxm_to_online_node - Map proximity ID to online node
443  * @pxm: ACPI proximity ID
444  *
445  * This is similar to pxm_to_node(), but always returns an online
446  * node.  When the mapped node from a given proximity ID is offline, it
447  * looks up the node distance table and returns the nearest online node.
448  *
449  * ACPI device drivers, which are called after the NUMA initialization has
450  * completed in the kernel, can call this interface to obtain their device
451  * NUMA topology from ACPI tables.  Such drivers do not have to deal with
452  * offline nodes.  A node may be offline when SRAT memory entry does not exist,
453  * or NUMA is disabled, ex. "numa=off" on x86.
454  */
455 static inline int pxm_to_online_node(int pxm)
456 {
457 	int node = pxm_to_node(pxm);
458 
459 	return numa_map_to_online_node(node);
460 }
461 #else
462 static inline int pxm_to_online_node(int pxm)
463 {
464 	return 0;
465 }
466 static inline int acpi_map_pxm_to_node(int pxm)
467 {
468 	return 0;
469 }
470 static inline int acpi_get_node(acpi_handle handle)
471 {
472 	return 0;
473 }
474 #endif
475 extern int pnpacpi_disabled;
476 
477 #define PXM_INVAL	(-1)
478 
479 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
480 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
481 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
482 				     struct resource_win *win);
483 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
484 					 struct resource_win *win);
485 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable, u8 wake_capable);
486 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
487 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
488 				 struct resource *res);
489 
490 void acpi_dev_free_resource_list(struct list_head *list);
491 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
492 			   int (*preproc)(struct acpi_resource *, void *),
493 			   void *preproc_data);
494 int acpi_dev_get_dma_resources(struct acpi_device *adev,
495 			       struct list_head *list);
496 int acpi_dev_get_memory_resources(struct acpi_device *adev, struct list_head *list);
497 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
498 				  unsigned long types);
499 
500 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
501 						   void *arg)
502 {
503 	return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
504 }
505 
506 struct acpi_device *acpi_resource_consumer(struct resource *res);
507 
508 int acpi_check_resource_conflict(const struct resource *res);
509 
510 int acpi_check_region(resource_size_t start, resource_size_t n,
511 		      const char *name);
512 
513 int acpi_resources_are_enforced(void);
514 
515 #ifdef CONFIG_HIBERNATION
516 extern int acpi_check_s4_hw_signature;
517 #endif
518 
519 #ifdef CONFIG_PM_SLEEP
520 void __init acpi_old_suspend_ordering(void);
521 void __init acpi_nvs_nosave(void);
522 void __init acpi_nvs_nosave_s3(void);
523 void __init acpi_sleep_no_blacklist(void);
524 #endif /* CONFIG_PM_SLEEP */
525 
526 int acpi_register_wakeup_handler(
527 	int wake_irq, bool (*wakeup)(void *context), void *context);
528 void acpi_unregister_wakeup_handler(
529 	bool (*wakeup)(void *context), void *context);
530 
531 struct acpi_osc_context {
532 	char *uuid_str;			/* UUID string */
533 	int rev;
534 	struct acpi_buffer cap;		/* list of DWORD capabilities */
535 	struct acpi_buffer ret;		/* free by caller if success */
536 };
537 
538 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
539 
540 /* Number of _OSC capability DWORDS depends on bridge type */
541 #define OSC_PCI_CAPABILITY_DWORDS		3
542 #define OSC_CXL_CAPABILITY_DWORDS		5
543 
544 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 to 5 are device-specific) */
545 #define OSC_QUERY_DWORD				0	/* DWORD 1 */
546 #define OSC_SUPPORT_DWORD			1	/* DWORD 2 */
547 #define OSC_CONTROL_DWORD			2	/* DWORD 3 */
548 #define OSC_EXT_SUPPORT_DWORD			3	/* DWORD 4 */
549 #define OSC_EXT_CONTROL_DWORD			4	/* DWORD 5 */
550 
551 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
552 #define OSC_QUERY_ENABLE			0x00000001  /* input */
553 #define OSC_REQUEST_ERROR			0x00000002  /* return */
554 #define OSC_INVALID_UUID_ERROR			0x00000004  /* return */
555 #define OSC_INVALID_REVISION_ERROR		0x00000008  /* return */
556 #define OSC_CAPABILITIES_MASK_ERROR		0x00000010  /* return */
557 
558 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
559 #define OSC_SB_PAD_SUPPORT			0x00000001
560 #define OSC_SB_PPC_OST_SUPPORT			0x00000002
561 #define OSC_SB_PR3_SUPPORT			0x00000004
562 #define OSC_SB_HOTPLUG_OST_SUPPORT		0x00000008
563 #define OSC_SB_APEI_SUPPORT			0x00000010
564 #define OSC_SB_CPC_SUPPORT			0x00000020
565 #define OSC_SB_CPCV2_SUPPORT			0x00000040
566 #define OSC_SB_PCLPI_SUPPORT			0x00000080
567 #define OSC_SB_OSLPI_SUPPORT			0x00000100
568 #define OSC_SB_FAST_THERMAL_SAMPLING_SUPPORT	0x00000200
569 #define OSC_SB_OVER_16_PSTATES_SUPPORT		0x00000400
570 #define OSC_SB_GED_SUPPORT			0x00000800
571 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT		0x00001000
572 #define OSC_SB_IRQ_RESOURCE_SOURCE_SUPPORT	0x00002000
573 #define OSC_SB_CPC_FLEXIBLE_ADR_SPACE		0x00004000
574 #define OSC_SB_GENERIC_INITIATOR_SUPPORT	0x00020000
575 #define OSC_SB_NATIVE_USB4_SUPPORT		0x00040000
576 #define OSC_SB_BATTERY_CHARGE_LIMITING_SUPPORT	0x00080000
577 #define OSC_SB_PRM_SUPPORT			0x00200000
578 #define OSC_SB_FFH_OPR_SUPPORT			0x00400000
579 
580 extern bool osc_sb_apei_support_acked;
581 extern bool osc_pc_lpi_support_confirmed;
582 extern bool osc_sb_native_usb4_support_confirmed;
583 extern bool osc_sb_cppc2_support_acked;
584 extern bool osc_cpc_flexible_adr_space_confirmed;
585 
586 /* USB4 Capabilities */
587 #define OSC_USB_USB3_TUNNELING			0x00000001
588 #define OSC_USB_DP_TUNNELING			0x00000002
589 #define OSC_USB_PCIE_TUNNELING			0x00000004
590 #define OSC_USB_XDOMAIN				0x00000008
591 
592 extern u32 osc_sb_native_usb4_control;
593 
594 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
595 #define OSC_PCI_EXT_CONFIG_SUPPORT		0x00000001
596 #define OSC_PCI_ASPM_SUPPORT			0x00000002
597 #define OSC_PCI_CLOCK_PM_SUPPORT		0x00000004
598 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT		0x00000008
599 #define OSC_PCI_MSI_SUPPORT			0x00000010
600 #define OSC_PCI_EDR_SUPPORT			0x00000080
601 #define OSC_PCI_HPX_TYPE_3_SUPPORT		0x00000100
602 
603 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
604 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL	0x00000001
605 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL		0x00000002
606 #define OSC_PCI_EXPRESS_PME_CONTROL		0x00000004
607 #define OSC_PCI_EXPRESS_AER_CONTROL		0x00000008
608 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL	0x00000010
609 #define OSC_PCI_EXPRESS_LTR_CONTROL		0x00000020
610 #define OSC_PCI_EXPRESS_DPC_CONTROL		0x00000080
611 
612 /* CXL _OSC: Capabilities DWORD 4: Support Field */
613 #define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT	0x00000001
614 #define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT	0x00000002
615 #define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT	0x00000004
616 #define OSC_CXL_NATIVE_HP_SUPPORT		0x00000008
617 
618 /* CXL _OSC: Capabilities DWORD 5: Control Field */
619 #define OSC_CXL_ERROR_REPORTING_CONTROL		0x00000001
620 
621 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
622 {
623 	u32 *ret = context->ret.pointer;
624 
625 	return ret[OSC_CONTROL_DWORD];
626 }
627 
628 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
629 {
630 	u32 *ret = context->ret.pointer;
631 
632 	return ret[OSC_EXT_CONTROL_DWORD];
633 }
634 
635 #define ACPI_GSB_ACCESS_ATTRIB_QUICK		0x00000002
636 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
637 #define ACPI_GSB_ACCESS_ATTRIB_BYTE		0x00000006
638 #define ACPI_GSB_ACCESS_ATTRIB_WORD		0x00000008
639 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK		0x0000000A
640 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE	0x0000000B
641 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL	0x0000000C
642 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL	0x0000000D
643 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES	0x0000000E
644 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS	0x0000000F
645 
646 /* Enable _OST when all relevant hotplug operations are enabled */
647 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&			\
648 	defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&		\
649 	defined(CONFIG_ACPI_CONTAINER)
650 #define ACPI_HOTPLUG_OST
651 #endif
652 
653 /* _OST Source Event Code (OSPM Action) */
654 #define ACPI_OST_EC_OSPM_SHUTDOWN		0x100
655 #define ACPI_OST_EC_OSPM_EJECT			0x103
656 #define ACPI_OST_EC_OSPM_INSERTION		0x200
657 
658 /* _OST General Processing Status Code */
659 #define ACPI_OST_SC_SUCCESS			0x0
660 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE	0x1
661 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY		0x2
662 
663 /* _OST OS Shutdown Processing (0x100) Status Code */
664 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED		0x80
665 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS	0x81
666 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED	0x82
667 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED	0x83
668 
669 /* _OST Ejection Request (0x3, 0x103) Status Code */
670 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED		0x80
671 #define ACPI_OST_SC_DEVICE_IN_USE		0x81
672 #define ACPI_OST_SC_DEVICE_BUSY			0x82
673 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY	0x83
674 #define ACPI_OST_SC_EJECT_IN_PROGRESS		0x84
675 
676 /* _OST Insertion Request (0x200) Status Code */
677 #define ACPI_OST_SC_INSERT_IN_PROGRESS		0x80
678 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE		0x81
679 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED	0x82
680 
681 enum acpi_predicate {
682 	all_versions,
683 	less_than_or_equal,
684 	equal,
685 	greater_than_or_equal,
686 };
687 
688 /* Table must be terminted by a NULL entry */
689 struct acpi_platform_list {
690 	char	oem_id[ACPI_OEM_ID_SIZE+1];
691 	char	oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
692 	u32	oem_revision;
693 	char	*table;
694 	enum acpi_predicate pred;
695 	char	*reason;
696 	u32	data;
697 };
698 int acpi_match_platform_list(const struct acpi_platform_list *plat);
699 
700 extern void acpi_early_init(void);
701 extern void acpi_subsystem_init(void);
702 
703 extern int acpi_nvs_register(__u64 start, __u64 size);
704 
705 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
706 				    void *data);
707 
708 const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
709 						    const struct acpi_device *adev);
710 
711 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
712 					       const struct device *dev);
713 
714 const void *acpi_device_get_match_data(const struct device *dev);
715 extern bool acpi_driver_match_device(struct device *dev,
716 				     const struct device_driver *drv);
717 int acpi_device_uevent_modalias(const struct device *, struct kobj_uevent_env *);
718 int acpi_device_modalias(struct device *, char *, int);
719 
720 struct platform_device *acpi_create_platform_device(struct acpi_device *,
721 						    const struct property_entry *);
722 #define ACPI_PTR(_ptr)	(_ptr)
723 
724 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
725 {
726 	adev->flags.visited = true;
727 }
728 
729 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
730 {
731 	adev->flags.visited = false;
732 }
733 
734 enum acpi_reconfig_event  {
735 	ACPI_RECONFIG_DEVICE_ADD = 0,
736 	ACPI_RECONFIG_DEVICE_REMOVE,
737 };
738 
739 int acpi_reconfig_notifier_register(struct notifier_block *nb);
740 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
741 
742 #ifdef CONFIG_ACPI_GTDT
743 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
744 int acpi_gtdt_map_ppi(int type);
745 bool acpi_gtdt_c3stop(int type);
746 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
747 #endif
748 
749 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
750 static inline void acpi_arch_set_root_pointer(u64 addr)
751 {
752 }
753 #endif
754 
755 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
756 static inline u64 acpi_arch_get_root_pointer(void)
757 {
758 	return 0;
759 }
760 #endif
761 
762 int acpi_get_local_u64_address(acpi_handle handle, u64 *addr);
763 int acpi_get_local_address(acpi_handle handle, u32 *addr);
764 const char *acpi_get_subsystem_id(acpi_handle handle);
765 
766 #else	/* !CONFIG_ACPI */
767 
768 #define acpi_disabled 1
769 
770 #define ACPI_COMPANION(dev)		(NULL)
771 #define ACPI_COMPANION_SET(dev, adev)	do { } while (0)
772 #define ACPI_HANDLE(dev)		(NULL)
773 #define ACPI_HANDLE_FWNODE(fwnode)	(NULL)
774 
775 /* Get rid of the -Wunused-variable for adev */
776 #define acpi_dev_uid_match(adev, uid2)			(adev && false)
777 #define acpi_dev_hid_uid_match(adev, hid2, uid2)	(adev && false)
778 
779 struct fwnode_handle;
780 
781 static inline bool acpi_dev_found(const char *hid)
782 {
783 	return false;
784 }
785 
786 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
787 {
788 	return false;
789 }
790 
791 struct acpi_device;
792 
793 static inline int acpi_dev_uid_to_integer(struct acpi_device *adev, u64 *integer)
794 {
795 	return -ENODEV;
796 }
797 
798 static inline struct acpi_device *
799 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
800 {
801 	return NULL;
802 }
803 
804 static inline bool acpi_reduced_hardware(void)
805 {
806 	return false;
807 }
808 
809 static inline void acpi_dev_put(struct acpi_device *adev) {}
810 
811 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
812 {
813 	return false;
814 }
815 
816 static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
817 {
818 	return false;
819 }
820 
821 static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
822 {
823 	return NULL;
824 }
825 
826 static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
827 {
828 	return false;
829 }
830 
831 static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
832 {
833 	return NULL;
834 }
835 
836 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
837 					const char *name)
838 {
839 	return false;
840 }
841 
842 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
843 {
844 	return NULL;
845 }
846 
847 static inline bool has_acpi_companion(struct device *dev)
848 {
849 	return false;
850 }
851 
852 static inline void acpi_preset_companion(struct device *dev,
853 					 struct acpi_device *parent, u64 addr)
854 {
855 }
856 
857 static inline const char *acpi_dev_name(struct acpi_device *adev)
858 {
859 	return NULL;
860 }
861 
862 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
863 {
864 	return NULL;
865 }
866 
867 static inline void acpi_early_init(void) { }
868 static inline void acpi_subsystem_init(void) { }
869 
870 static inline int early_acpi_boot_init(void)
871 {
872 	return 0;
873 }
874 static inline int acpi_boot_init(void)
875 {
876 	return 0;
877 }
878 
879 static inline void acpi_boot_table_prepare(void)
880 {
881 }
882 
883 static inline void acpi_boot_table_init(void)
884 {
885 }
886 
887 static inline int acpi_mps_check(void)
888 {
889 	return 0;
890 }
891 
892 static inline int acpi_check_resource_conflict(struct resource *res)
893 {
894 	return 0;
895 }
896 
897 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
898 				    const char *name)
899 {
900 	return 0;
901 }
902 
903 struct acpi_table_header;
904 static inline int acpi_table_parse(char *id,
905 				int (*handler)(struct acpi_table_header *))
906 {
907 	return -ENODEV;
908 }
909 
910 static inline int acpi_nvs_register(__u64 start, __u64 size)
911 {
912 	return 0;
913 }
914 
915 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
916 					   void *data)
917 {
918 	return 0;
919 }
920 
921 struct acpi_device_id;
922 
923 static inline const struct acpi_device_id *acpi_match_acpi_device(
924 	const struct acpi_device_id *ids, const struct acpi_device *adev)
925 {
926 	return NULL;
927 }
928 
929 static inline const struct acpi_device_id *acpi_match_device(
930 	const struct acpi_device_id *ids, const struct device *dev)
931 {
932 	return NULL;
933 }
934 
935 static inline const void *acpi_device_get_match_data(const struct device *dev)
936 {
937 	return NULL;
938 }
939 
940 static inline bool acpi_driver_match_device(struct device *dev,
941 					    const struct device_driver *drv)
942 {
943 	return false;
944 }
945 
946 static inline bool acpi_check_dsm(acpi_handle handle, const guid_t *guid,
947 				  u64 rev, u64 funcs)
948 {
949 	return false;
950 }
951 
952 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
953 						   const guid_t *guid,
954 						   u64 rev, u64 func,
955 						   union acpi_object *argv4)
956 {
957 	return NULL;
958 }
959 
960 static inline union acpi_object *acpi_evaluate_dsm_typed(acpi_handle handle,
961 							 const guid_t *guid,
962 							 u64 rev, u64 func,
963 							 union acpi_object *argv4,
964 							 acpi_object_type type)
965 {
966 	return NULL;
967 }
968 
969 static inline int acpi_device_uevent_modalias(const struct device *dev,
970 				struct kobj_uevent_env *env)
971 {
972 	return -ENODEV;
973 }
974 
975 static inline int acpi_device_modalias(struct device *dev,
976 				char *buf, int size)
977 {
978 	return -ENODEV;
979 }
980 
981 static inline struct platform_device *
982 acpi_create_platform_device(struct acpi_device *adev,
983 			    const struct property_entry *properties)
984 {
985 	return NULL;
986 }
987 
988 static inline bool acpi_dma_supported(const struct acpi_device *adev)
989 {
990 	return false;
991 }
992 
993 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
994 {
995 	return DEV_DMA_NOT_SUPPORTED;
996 }
997 
998 static inline int acpi_dma_get_range(struct device *dev, const struct bus_dma_region **map)
999 {
1000 	return -ENODEV;
1001 }
1002 
1003 static inline int acpi_dma_configure(struct device *dev,
1004 				     enum dev_dma_attr attr)
1005 {
1006 	return 0;
1007 }
1008 
1009 static inline int acpi_dma_configure_id(struct device *dev,
1010 					enum dev_dma_attr attr,
1011 					const u32 *input_id)
1012 {
1013 	return 0;
1014 }
1015 
1016 #define ACPI_PTR(_ptr)	(NULL)
1017 
1018 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
1019 {
1020 }
1021 
1022 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
1023 {
1024 }
1025 
1026 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
1027 {
1028 	return -EINVAL;
1029 }
1030 
1031 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
1032 {
1033 	return -EINVAL;
1034 }
1035 
1036 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
1037 {
1038 	return NULL;
1039 }
1040 
1041 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
1042 {
1043 	return -ENODEV;
1044 }
1045 
1046 static inline const char *acpi_get_subsystem_id(acpi_handle handle)
1047 {
1048 	return ERR_PTR(-ENODEV);
1049 }
1050 
1051 static inline int acpi_register_wakeup_handler(int wake_irq,
1052 	bool (*wakeup)(void *context), void *context)
1053 {
1054 	return -ENXIO;
1055 }
1056 
1057 static inline void acpi_unregister_wakeup_handler(
1058 	bool (*wakeup)(void *context), void *context) { }
1059 
1060 struct acpi_osc_context;
1061 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
1062 {
1063 	return 0;
1064 }
1065 
1066 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
1067 {
1068 	return 0;
1069 }
1070 
1071 static inline bool acpi_sleep_state_supported(u8 sleep_state)
1072 {
1073 	return false;
1074 }
1075 
1076 static inline acpi_handle acpi_get_processor_handle(int cpu)
1077 {
1078 	return NULL;
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 #if defined(CONFIG_SUSPEND) && defined(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 int acpi_get_lps0_constraint(struct acpi_device *adev);
1113 #else /* CONFIG_SUSPEND && CONFIG_X86 */
1114 static inline int acpi_get_lps0_constraint(struct device *dev)
1115 {
1116 	return ACPI_STATE_UNKNOWN;
1117 }
1118 #endif /* CONFIG_SUSPEND && CONFIG_X86 */
1119 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1120 #else
1121 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1122 #endif
1123 
1124 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1125 int acpi_dev_suspend(struct device *dev, bool wakeup);
1126 int acpi_dev_resume(struct device *dev);
1127 int acpi_subsys_runtime_suspend(struct device *dev);
1128 int acpi_subsys_runtime_resume(struct device *dev);
1129 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1130 bool acpi_storage_d3(struct device *dev);
1131 bool acpi_dev_state_d0(struct device *dev);
1132 #else
1133 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1134 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1135 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1136 {
1137 	return 0;
1138 }
1139 static inline bool acpi_storage_d3(struct device *dev)
1140 {
1141 	return false;
1142 }
1143 static inline bool acpi_dev_state_d0(struct device *dev)
1144 {
1145 	return true;
1146 }
1147 #endif
1148 
1149 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1150 int acpi_subsys_prepare(struct device *dev);
1151 void acpi_subsys_complete(struct device *dev);
1152 int acpi_subsys_suspend_late(struct device *dev);
1153 int acpi_subsys_suspend_noirq(struct device *dev);
1154 int acpi_subsys_suspend(struct device *dev);
1155 int acpi_subsys_freeze(struct device *dev);
1156 int acpi_subsys_poweroff(struct device *dev);
1157 void acpi_ec_mark_gpe_for_wake(void);
1158 void acpi_ec_set_gpe_wake_mask(u8 action);
1159 int acpi_subsys_restore_early(struct device *dev);
1160 #else
1161 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1162 static inline void acpi_subsys_complete(struct device *dev) {}
1163 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1164 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1165 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1166 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1167 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1168 static inline int acpi_subsys_restore_early(struct device *dev) { return 0; }
1169 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1170 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1171 #endif
1172 
1173 #ifdef CONFIG_ACPI
1174 char *acpi_handle_path(acpi_handle handle);
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 *con_id, 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 *con_id,
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 *con_id,
1264 					   int index)
1265 {
1266 	return acpi_dev_gpio_irq_wake_get_by(adev, con_id, 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_PROCESSOR_IDLE
1480 #ifndef arch_get_idle_state_flags
1481 static inline unsigned int arch_get_idle_state_flags(u32 arch_flags)
1482 {
1483 	return 0;
1484 }
1485 #endif
1486 #endif /* CONFIG_ACPI_PROCESSOR_IDLE */
1487 
1488 #ifdef CONFIG_ACPI_PPTT
1489 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1490 int find_acpi_cpu_topology(unsigned int cpu, int level);
1491 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1492 int find_acpi_cpu_topology_package(unsigned int cpu);
1493 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1494 #else
1495 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1496 {
1497 	return -EINVAL;
1498 }
1499 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1500 {
1501 	return -EINVAL;
1502 }
1503 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1504 {
1505 	return -EINVAL;
1506 }
1507 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1508 {
1509 	return -EINVAL;
1510 }
1511 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1512 {
1513 	return -EINVAL;
1514 }
1515 #endif
1516 
1517 #ifdef CONFIG_ARM64
1518 void acpi_arm_init(void);
1519 #else
1520 static inline void acpi_arm_init(void) { }
1521 #endif
1522 
1523 #ifdef CONFIG_ACPI_PCC
1524 void acpi_init_pcc(void);
1525 #else
1526 static inline void acpi_init_pcc(void) { }
1527 #endif
1528 
1529 #ifdef CONFIG_ACPI_FFH
1530 void acpi_init_ffh(void);
1531 extern int acpi_ffh_address_space_arch_setup(void *handler_ctxt,
1532 					     void **region_ctxt);
1533 extern int acpi_ffh_address_space_arch_handler(acpi_integer *value,
1534 					       void *region_context);
1535 #else
1536 static inline void acpi_init_ffh(void) { }
1537 #endif
1538 
1539 #ifdef CONFIG_ACPI
1540 extern void acpi_device_notify(struct device *dev);
1541 extern void acpi_device_notify_remove(struct device *dev);
1542 #else
1543 static inline void acpi_device_notify(struct device *dev) { }
1544 static inline void acpi_device_notify_remove(struct device *dev) { }
1545 #endif
1546 
1547 static inline void acpi_use_parent_companion(struct device *dev)
1548 {
1549 	ACPI_COMPANION_SET(dev, ACPI_COMPANION(dev->parent));
1550 }
1551 
1552 #ifdef CONFIG_ACPI_HMAT
1553 int hmat_update_target_coordinates(int nid, struct access_coordinate *coord,
1554 				   enum access_coordinate_class access);
1555 #else
1556 static inline int hmat_update_target_coordinates(int nid,
1557 						 struct access_coordinate *coord,
1558 						 enum access_coordinate_class access)
1559 {
1560 	return -EOPNOTSUPP;
1561 }
1562 #endif
1563 
1564 #ifdef CONFIG_ACPI_NUMA
1565 bool acpi_node_backed_by_real_pxm(int nid);
1566 #else
1567 static inline bool acpi_node_backed_by_real_pxm(int nid)
1568 {
1569 	return false;
1570 }
1571 #endif
1572 
1573 #endif	/*_LINUX_ACPI_H*/
1574