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