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