xref: /linux-6.15/include/linux/acpi.h (revision 78eb4ea2)
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 
278 int __init acpi_get_madt_revision(void);
279 
280 /* Validate the processor object's proc_id */
281 bool acpi_duplicate_processor_id(int proc_id);
282 /* Processor _CTS control */
283 struct acpi_processor_power;
284 
285 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
286 bool acpi_processor_claim_cst_control(void);
287 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
288 				struct acpi_processor_power *info);
289 #else
290 static inline bool acpi_processor_claim_cst_control(void) { return false; }
291 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
292 					      struct acpi_processor_power *info)
293 {
294 	return -ENODEV;
295 }
296 #endif
297 
298 #ifdef CONFIG_ACPI_HOTPLUG_CPU
299 /* Arch dependent functions for cpu hotplug support */
300 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
301 		 int *pcpu);
302 int acpi_unmap_cpu(int cpu);
303 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
304 
305 acpi_handle acpi_get_processor_handle(int 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_BATTERY_CHARGE_LIMITING_SUPPORT	0x00080000
580 #define OSC_SB_PRM_SUPPORT			0x00200000
581 #define OSC_SB_FFH_OPR_SUPPORT			0x00400000
582 
583 extern bool osc_sb_apei_support_acked;
584 extern bool osc_pc_lpi_support_confirmed;
585 extern bool osc_sb_native_usb4_support_confirmed;
586 extern bool osc_sb_cppc2_support_acked;
587 extern bool osc_cpc_flexible_adr_space_confirmed;
588 
589 /* USB4 Capabilities */
590 #define OSC_USB_USB3_TUNNELING			0x00000001
591 #define OSC_USB_DP_TUNNELING			0x00000002
592 #define OSC_USB_PCIE_TUNNELING			0x00000004
593 #define OSC_USB_XDOMAIN				0x00000008
594 
595 extern u32 osc_sb_native_usb4_control;
596 
597 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
598 #define OSC_PCI_EXT_CONFIG_SUPPORT		0x00000001
599 #define OSC_PCI_ASPM_SUPPORT			0x00000002
600 #define OSC_PCI_CLOCK_PM_SUPPORT		0x00000004
601 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT		0x00000008
602 #define OSC_PCI_MSI_SUPPORT			0x00000010
603 #define OSC_PCI_EDR_SUPPORT			0x00000080
604 #define OSC_PCI_HPX_TYPE_3_SUPPORT		0x00000100
605 
606 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
607 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL	0x00000001
608 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL		0x00000002
609 #define OSC_PCI_EXPRESS_PME_CONTROL		0x00000004
610 #define OSC_PCI_EXPRESS_AER_CONTROL		0x00000008
611 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL	0x00000010
612 #define OSC_PCI_EXPRESS_LTR_CONTROL		0x00000020
613 #define OSC_PCI_EXPRESS_DPC_CONTROL		0x00000080
614 
615 /* CXL _OSC: Capabilities DWORD 4: Support Field */
616 #define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT	0x00000001
617 #define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT	0x00000002
618 #define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT	0x00000004
619 #define OSC_CXL_NATIVE_HP_SUPPORT		0x00000008
620 
621 /* CXL _OSC: Capabilities DWORD 5: Control Field */
622 #define OSC_CXL_ERROR_REPORTING_CONTROL		0x00000001
623 
624 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
625 {
626 	u32 *ret = context->ret.pointer;
627 
628 	return ret[OSC_CONTROL_DWORD];
629 }
630 
631 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
632 {
633 	u32 *ret = context->ret.pointer;
634 
635 	return ret[OSC_EXT_CONTROL_DWORD];
636 }
637 
638 #define ACPI_GSB_ACCESS_ATTRIB_QUICK		0x00000002
639 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
640 #define ACPI_GSB_ACCESS_ATTRIB_BYTE		0x00000006
641 #define ACPI_GSB_ACCESS_ATTRIB_WORD		0x00000008
642 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK		0x0000000A
643 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE	0x0000000B
644 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL	0x0000000C
645 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL	0x0000000D
646 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES	0x0000000E
647 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS	0x0000000F
648 
649 /* Enable _OST when all relevant hotplug operations are enabled */
650 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&			\
651 	defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&		\
652 	defined(CONFIG_ACPI_CONTAINER)
653 #define ACPI_HOTPLUG_OST
654 #endif
655 
656 /* _OST Source Event Code (OSPM Action) */
657 #define ACPI_OST_EC_OSPM_SHUTDOWN		0x100
658 #define ACPI_OST_EC_OSPM_EJECT			0x103
659 #define ACPI_OST_EC_OSPM_INSERTION		0x200
660 
661 /* _OST General Processing Status Code */
662 #define ACPI_OST_SC_SUCCESS			0x0
663 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE	0x1
664 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY		0x2
665 
666 /* _OST OS Shutdown Processing (0x100) Status Code */
667 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED		0x80
668 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS	0x81
669 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED	0x82
670 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED	0x83
671 
672 /* _OST Ejection Request (0x3, 0x103) Status Code */
673 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED		0x80
674 #define ACPI_OST_SC_DEVICE_IN_USE		0x81
675 #define ACPI_OST_SC_DEVICE_BUSY			0x82
676 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY	0x83
677 #define ACPI_OST_SC_EJECT_IN_PROGRESS		0x84
678 
679 /* _OST Insertion Request (0x200) Status Code */
680 #define ACPI_OST_SC_INSERT_IN_PROGRESS		0x80
681 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE		0x81
682 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED	0x82
683 
684 enum acpi_predicate {
685 	all_versions,
686 	less_than_or_equal,
687 	equal,
688 	greater_than_or_equal,
689 };
690 
691 /* Table must be terminted by a NULL entry */
692 struct acpi_platform_list {
693 	char	oem_id[ACPI_OEM_ID_SIZE+1];
694 	char	oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
695 	u32	oem_revision;
696 	char	*table;
697 	enum acpi_predicate pred;
698 	char	*reason;
699 	u32	data;
700 };
701 int acpi_match_platform_list(const struct acpi_platform_list *plat);
702 
703 extern void acpi_early_init(void);
704 extern void acpi_subsystem_init(void);
705 
706 extern int acpi_nvs_register(__u64 start, __u64 size);
707 
708 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
709 				    void *data);
710 
711 const struct acpi_device_id *acpi_match_acpi_device(const struct acpi_device_id *ids,
712 						    const struct acpi_device *adev);
713 
714 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
715 					       const struct device *dev);
716 
717 const void *acpi_device_get_match_data(const struct device *dev);
718 extern bool acpi_driver_match_device(struct device *dev,
719 				     const struct device_driver *drv);
720 int acpi_device_uevent_modalias(const struct device *, struct kobj_uevent_env *);
721 int acpi_device_modalias(struct device *, char *, int);
722 
723 struct platform_device *acpi_create_platform_device(struct acpi_device *,
724 						    const struct property_entry *);
725 #define ACPI_PTR(_ptr)	(_ptr)
726 
727 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
728 {
729 	adev->flags.visited = true;
730 }
731 
732 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
733 {
734 	adev->flags.visited = false;
735 }
736 
737 enum acpi_reconfig_event  {
738 	ACPI_RECONFIG_DEVICE_ADD = 0,
739 	ACPI_RECONFIG_DEVICE_REMOVE,
740 };
741 
742 int acpi_reconfig_notifier_register(struct notifier_block *nb);
743 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
744 
745 #ifdef CONFIG_ACPI_GTDT
746 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
747 int acpi_gtdt_map_ppi(int type);
748 bool acpi_gtdt_c3stop(int type);
749 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
750 #endif
751 
752 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
753 static inline void acpi_arch_set_root_pointer(u64 addr)
754 {
755 }
756 #endif
757 
758 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
759 static inline u64 acpi_arch_get_root_pointer(void)
760 {
761 	return 0;
762 }
763 #endif
764 
765 int acpi_get_local_u64_address(acpi_handle handle, u64 *addr);
766 int acpi_get_local_address(acpi_handle handle, u32 *addr);
767 const char *acpi_get_subsystem_id(acpi_handle handle);
768 
769 #else	/* !CONFIG_ACPI */
770 
771 #define acpi_disabled 1
772 
773 #define ACPI_COMPANION(dev)		(NULL)
774 #define ACPI_COMPANION_SET(dev, adev)	do { } while (0)
775 #define ACPI_HANDLE(dev)		(NULL)
776 #define ACPI_HANDLE_FWNODE(fwnode)	(NULL)
777 
778 /* Get rid of the -Wunused-variable for adev */
779 #define acpi_dev_uid_match(adev, uid2)			(adev && false)
780 #define acpi_dev_hid_uid_match(adev, hid2, uid2)	(adev && false)
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 static inline acpi_handle acpi_get_processor_handle(int cpu)
1080 {
1081 	return NULL;
1082 }
1083 
1084 #endif	/* !CONFIG_ACPI */
1085 
1086 extern void arch_post_acpi_subsys_init(void);
1087 
1088 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1089 int acpi_ioapic_add(acpi_handle root);
1090 #else
1091 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1092 #endif
1093 
1094 #ifdef CONFIG_ACPI
1095 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1096 			       u32 pm1a_ctrl,  u32 pm1b_ctrl));
1097 
1098 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1099 				  u32 pm1a_control, u32 pm1b_control);
1100 
1101 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1102 				        u32 val_a,  u32 val_b));
1103 
1104 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1105 					   u32 val_a, u32 val_b);
1106 #if defined(CONFIG_SUSPEND) && defined(CONFIG_X86)
1107 struct acpi_s2idle_dev_ops {
1108 	struct list_head list_node;
1109 	void (*prepare)(void);
1110 	void (*check)(void);
1111 	void (*restore)(void);
1112 };
1113 int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1114 void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1115 int acpi_get_lps0_constraint(struct acpi_device *adev);
1116 #else /* CONFIG_SUSPEND && CONFIG_X86 */
1117 static inline int acpi_get_lps0_constraint(struct device *dev)
1118 {
1119 	return ACPI_STATE_UNKNOWN;
1120 }
1121 #endif /* CONFIG_SUSPEND && CONFIG_X86 */
1122 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1123 #else
1124 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1125 #endif
1126 
1127 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1128 int acpi_dev_suspend(struct device *dev, bool wakeup);
1129 int acpi_dev_resume(struct device *dev);
1130 int acpi_subsys_runtime_suspend(struct device *dev);
1131 int acpi_subsys_runtime_resume(struct device *dev);
1132 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1133 bool acpi_storage_d3(struct device *dev);
1134 bool acpi_dev_state_d0(struct device *dev);
1135 #else
1136 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1137 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1138 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1139 {
1140 	return 0;
1141 }
1142 static inline bool acpi_storage_d3(struct device *dev)
1143 {
1144 	return false;
1145 }
1146 static inline bool acpi_dev_state_d0(struct device *dev)
1147 {
1148 	return true;
1149 }
1150 #endif
1151 
1152 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1153 int acpi_subsys_prepare(struct device *dev);
1154 void acpi_subsys_complete(struct device *dev);
1155 int acpi_subsys_suspend_late(struct device *dev);
1156 int acpi_subsys_suspend_noirq(struct device *dev);
1157 int acpi_subsys_suspend(struct device *dev);
1158 int acpi_subsys_freeze(struct device *dev);
1159 int acpi_subsys_poweroff(struct device *dev);
1160 void acpi_ec_mark_gpe_for_wake(void);
1161 void acpi_ec_set_gpe_wake_mask(u8 action);
1162 int acpi_subsys_restore_early(struct device *dev);
1163 #else
1164 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1165 static inline void acpi_subsys_complete(struct device *dev) {}
1166 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1167 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1168 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1169 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1170 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1171 static inline int acpi_subsys_restore_early(struct device *dev) { return 0; }
1172 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1173 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1174 #endif
1175 
1176 #ifdef CONFIG_ACPI
1177 char *acpi_handle_path(acpi_handle handle);
1178 __printf(3, 4)
1179 void acpi_handle_printk(const char *level, acpi_handle handle,
1180 			const char *fmt, ...);
1181 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1182 				  acpi_status status);
1183 #else	/* !CONFIG_ACPI */
1184 static inline __printf(3, 4) void
1185 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1186 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1187 						const char *name,
1188 						acpi_status status) {}
1189 #endif	/* !CONFIG_ACPI */
1190 
1191 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1192 __printf(3, 4)
1193 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1194 #endif
1195 
1196 /*
1197  * acpi_handle_<level>: Print message with ACPI prefix and object path
1198  *
1199  * These interfaces acquire the global namespace mutex to obtain an object
1200  * path.  In interrupt context, it shows the object path as <n/a>.
1201  */
1202 #define acpi_handle_emerg(handle, fmt, ...)				\
1203 	acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1204 #define acpi_handle_alert(handle, fmt, ...)				\
1205 	acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1206 #define acpi_handle_crit(handle, fmt, ...)				\
1207 	acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1208 #define acpi_handle_err(handle, fmt, ...)				\
1209 	acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1210 #define acpi_handle_warn(handle, fmt, ...)				\
1211 	acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1212 #define acpi_handle_notice(handle, fmt, ...)				\
1213 	acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1214 #define acpi_handle_info(handle, fmt, ...)				\
1215 	acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1216 
1217 #if defined(DEBUG)
1218 #define acpi_handle_debug(handle, fmt, ...)				\
1219 	acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1220 #else
1221 #if defined(CONFIG_DYNAMIC_DEBUG)
1222 #define acpi_handle_debug(handle, fmt, ...)				\
1223 	_dynamic_func_call(fmt, __acpi_handle_debug,			\
1224 			   handle, pr_fmt(fmt), ##__VA_ARGS__)
1225 #else
1226 #define acpi_handle_debug(handle, fmt, ...)				\
1227 ({									\
1228 	if (0)								\
1229 		acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1230 	0;								\
1231 })
1232 #endif
1233 #endif
1234 
1235 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1236 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1237 				struct acpi_resource_gpio **agpio);
1238 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1239 			       struct acpi_resource_gpio **agpio);
1240 int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *con_id, int index,
1241 				  bool *wake_capable);
1242 #else
1243 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1244 					      struct acpi_resource_gpio **agpio)
1245 {
1246 	return false;
1247 }
1248 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1249 					     struct acpi_resource_gpio **agpio)
1250 {
1251 	return false;
1252 }
1253 static inline int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *con_id,
1254 						int index, bool *wake_capable)
1255 {
1256 	return -ENXIO;
1257 }
1258 #endif
1259 
1260 static inline int acpi_dev_gpio_irq_wake_get(struct acpi_device *adev, int index,
1261 					     bool *wake_capable)
1262 {
1263 	return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, wake_capable);
1264 }
1265 
1266 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *con_id,
1267 					   int index)
1268 {
1269 	return acpi_dev_gpio_irq_wake_get_by(adev, con_id, index, NULL);
1270 }
1271 
1272 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1273 {
1274 	return acpi_dev_gpio_irq_wake_get_by(adev, NULL, index, NULL);
1275 }
1276 
1277 /* Device properties */
1278 
1279 #ifdef CONFIG_ACPI
1280 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1281 			  acpi_object_type type, const union acpi_object **obj);
1282 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1283 				const char *name, size_t index, size_t num_args,
1284 				struct fwnode_reference_args *args);
1285 
1286 static inline int acpi_node_get_property_reference(
1287 				const struct fwnode_handle *fwnode,
1288 				const char *name, size_t index,
1289 				struct fwnode_reference_args *args)
1290 {
1291 	return __acpi_node_get_property_reference(fwnode, name, index,
1292 		NR_FWNODE_REFERENCE_ARGS, args);
1293 }
1294 
1295 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1296 {
1297 	return !list_empty(&adev->data.properties);
1298 }
1299 
1300 struct acpi_device_properties *
1301 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1302 		    union acpi_object *properties);
1303 
1304 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1305 		       void **valptr);
1306 
1307 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1308 					    struct fwnode_handle *child);
1309 
1310 struct acpi_probe_entry;
1311 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1312 						 struct acpi_probe_entry *);
1313 
1314 #define ACPI_TABLE_ID_LEN	5
1315 
1316 /**
1317  * struct acpi_probe_entry - boot-time probing entry
1318  * @id:			ACPI table name
1319  * @type:		Optional subtable type to match
1320  *			(if @id contains subtables)
1321  * @subtable_valid:	Optional callback to check the validity of
1322  *			the subtable
1323  * @probe_table:	Callback to the driver being probed when table
1324  *			match is successful
1325  * @probe_subtbl:	Callback to the driver being probed when table and
1326  *			subtable match (and optional callback is successful)
1327  * @driver_data:	Sideband data provided back to the driver
1328  */
1329 struct acpi_probe_entry {
1330 	__u8 id[ACPI_TABLE_ID_LEN];
1331 	__u8 type;
1332 	acpi_probe_entry_validate_subtbl subtable_valid;
1333 	union {
1334 		acpi_tbl_table_handler probe_table;
1335 		acpi_tbl_entry_handler probe_subtbl;
1336 	};
1337 	kernel_ulong_t driver_data;
1338 };
1339 
1340 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,	\
1341 				 valid, data, fn)			\
1342 	static const struct acpi_probe_entry __acpi_probe_##name	\
1343 		__used __section("__" #table "_acpi_probe_table") = {	\
1344 			.id = table_id,					\
1345 			.type = subtable,				\
1346 			.subtable_valid = valid,			\
1347 			.probe_table = fn,				\
1348 			.driver_data = data,				\
1349 		}
1350 
1351 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,	\
1352 					  subtable, valid, data, fn)	\
1353 	static const struct acpi_probe_entry __acpi_probe_##name	\
1354 		__used __section("__" #table "_acpi_probe_table") = {	\
1355 			.id = table_id,					\
1356 			.type = subtable,				\
1357 			.subtable_valid = valid,			\
1358 			.probe_subtbl = fn,				\
1359 			.driver_data = data,				\
1360 		}
1361 
1362 #define ACPI_PROBE_TABLE(name)		__##name##_acpi_probe_table
1363 #define ACPI_PROBE_TABLE_END(name)	__##name##_acpi_probe_table_end
1364 
1365 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1366 
1367 #define acpi_probe_device_table(t)					\
1368 	({ 								\
1369 		extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),	\
1370 			                       ACPI_PROBE_TABLE_END(t);	\
1371 		__acpi_probe_device_table(&ACPI_PROBE_TABLE(t),		\
1372 					  (&ACPI_PROBE_TABLE_END(t) -	\
1373 					   &ACPI_PROBE_TABLE(t)));	\
1374 	})
1375 #else
1376 static inline int acpi_dev_get_property(struct acpi_device *adev,
1377 					const char *name, acpi_object_type type,
1378 					const union acpi_object **obj)
1379 {
1380 	return -ENXIO;
1381 }
1382 
1383 static inline int
1384 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1385 				const char *name, size_t index, size_t num_args,
1386 				struct fwnode_reference_args *args)
1387 {
1388 	return -ENXIO;
1389 }
1390 
1391 static inline int
1392 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1393 				 const char *name, size_t index,
1394 				 struct fwnode_reference_args *args)
1395 {
1396 	return -ENXIO;
1397 }
1398 
1399 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1400 				     const char *propname,
1401 				     void **valptr)
1402 {
1403 	return -ENXIO;
1404 }
1405 
1406 static inline struct fwnode_handle *
1407 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1408 		      struct fwnode_handle *child)
1409 {
1410 	return NULL;
1411 }
1412 
1413 static inline struct fwnode_handle *
1414 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1415 			     struct fwnode_handle *prev)
1416 {
1417 	return ERR_PTR(-ENXIO);
1418 }
1419 
1420 static inline int
1421 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1422 			       struct fwnode_handle **remote,
1423 			       struct fwnode_handle **port,
1424 			       struct fwnode_handle **endpoint)
1425 {
1426 	return -ENXIO;
1427 }
1428 
1429 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1430 	static const void * __acpi_table_##name[]			\
1431 		__attribute__((unused))					\
1432 		 = { (void *) table_id,					\
1433 		     (void *) subtable,					\
1434 		     (void *) valid,					\
1435 		     (void *) fn,					\
1436 		     (void *) data }
1437 
1438 #define acpi_probe_device_table(t)	({ int __r = 0; __r;})
1439 #endif
1440 
1441 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1442 void acpi_table_upgrade(void);
1443 #else
1444 static inline void acpi_table_upgrade(void) { }
1445 #endif
1446 
1447 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1448 extern bool acpi_has_watchdog(void);
1449 #else
1450 static inline bool acpi_has_watchdog(void) { return false; }
1451 #endif
1452 
1453 #ifdef CONFIG_ACPI_SPCR_TABLE
1454 extern bool qdf2400_e44_present;
1455 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1456 #else
1457 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1458 {
1459 	return 0;
1460 }
1461 #endif
1462 
1463 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1464 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1465 #else
1466 static inline
1467 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1468 {
1469 	return -EINVAL;
1470 }
1471 #endif
1472 
1473 #ifdef CONFIG_ACPI_LPIT
1474 int lpit_read_residency_count_address(u64 *address);
1475 #else
1476 static inline int lpit_read_residency_count_address(u64 *address)
1477 {
1478 	return -EINVAL;
1479 }
1480 #endif
1481 
1482 #ifdef CONFIG_ACPI_PROCESSOR_IDLE
1483 #ifndef arch_get_idle_state_flags
1484 static inline unsigned int arch_get_idle_state_flags(u32 arch_flags)
1485 {
1486 	return 0;
1487 }
1488 #endif
1489 #endif /* CONFIG_ACPI_PROCESSOR_IDLE */
1490 
1491 #ifdef CONFIG_ACPI_PPTT
1492 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1493 int find_acpi_cpu_topology(unsigned int cpu, int level);
1494 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1495 int find_acpi_cpu_topology_package(unsigned int cpu);
1496 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1497 #else
1498 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1499 {
1500 	return -EINVAL;
1501 }
1502 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1503 {
1504 	return -EINVAL;
1505 }
1506 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1507 {
1508 	return -EINVAL;
1509 }
1510 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1511 {
1512 	return -EINVAL;
1513 }
1514 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1515 {
1516 	return -EINVAL;
1517 }
1518 #endif
1519 
1520 #ifdef CONFIG_ARM64
1521 void acpi_arm_init(void);
1522 #else
1523 static inline void acpi_arm_init(void) { }
1524 #endif
1525 
1526 #ifdef CONFIG_ACPI_PCC
1527 void acpi_init_pcc(void);
1528 #else
1529 static inline void acpi_init_pcc(void) { }
1530 #endif
1531 
1532 #ifdef CONFIG_ACPI_FFH
1533 void acpi_init_ffh(void);
1534 extern int acpi_ffh_address_space_arch_setup(void *handler_ctxt,
1535 					     void **region_ctxt);
1536 extern int acpi_ffh_address_space_arch_handler(acpi_integer *value,
1537 					       void *region_context);
1538 #else
1539 static inline void acpi_init_ffh(void) { }
1540 #endif
1541 
1542 #ifdef CONFIG_ACPI
1543 extern void acpi_device_notify(struct device *dev);
1544 extern void acpi_device_notify_remove(struct device *dev);
1545 #else
1546 static inline void acpi_device_notify(struct device *dev) { }
1547 static inline void acpi_device_notify_remove(struct device *dev) { }
1548 #endif
1549 
1550 static inline void acpi_use_parent_companion(struct device *dev)
1551 {
1552 	ACPI_COMPANION_SET(dev, ACPI_COMPANION(dev->parent));
1553 }
1554 
1555 #ifdef CONFIG_ACPI_HMAT
1556 int hmat_update_target_coordinates(int nid, struct access_coordinate *coord,
1557 				   enum access_coordinate_class access);
1558 #else
1559 static inline int hmat_update_target_coordinates(int nid,
1560 						 struct access_coordinate *coord,
1561 						 enum access_coordinate_class access)
1562 {
1563 	return -EOPNOTSUPP;
1564 }
1565 #endif
1566 
1567 #ifdef CONFIG_ACPI_NUMA
1568 bool acpi_node_backed_by_real_pxm(int nid);
1569 #else
1570 static inline bool acpi_node_backed_by_real_pxm(int nid)
1571 {
1572 	return false;
1573 }
1574 #endif
1575 
1576 #endif	/*_LINUX_ACPI_H*/
1577