xref: /linux/include/linux/acpi.h (revision fb2ac84f8acccdec644d26dfc8ba6554f30cd6c0)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * acpi.h - ACPI Interface
4  *
5  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
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/irqdomain.h>
14 #include <linux/resource_ext.h>
15 #include <linux/device.h>
16 #include <linux/property.h>
17 #include <linux/uuid.h>
18 
19 #ifndef _LINUX
20 #define _LINUX
21 #endif
22 #include <acpi/acpi.h>
23 
24 #ifdef	CONFIG_ACPI
25 
26 #include <linux/list.h>
27 #include <linux/mod_devicetable.h>
28 #include <linux/dynamic_debug.h>
29 #include <linux/module.h>
30 #include <linux/mutex.h>
31 
32 #include <acpi/acpi_bus.h>
33 #include <acpi/acpi_drivers.h>
34 #include <acpi/acpi_numa.h>
35 #include <acpi/acpi_io.h>
36 #include <asm/acpi.h>
37 
38 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
39 {
40 	return adev ? adev->handle : NULL;
41 }
42 
43 #define ACPI_COMPANION(dev)		to_acpi_device_node((dev)->fwnode)
44 #define ACPI_COMPANION_SET(dev, adev)	set_primary_fwnode(dev, (adev) ? \
45 	acpi_fwnode_handle(adev) : NULL)
46 #define ACPI_HANDLE(dev)		acpi_device_handle(ACPI_COMPANION(dev))
47 #define ACPI_HANDLE_FWNODE(fwnode)	\
48 				acpi_device_handle(to_acpi_device_node(fwnode))
49 
50 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
51 {
52 	struct fwnode_handle *fwnode;
53 
54 	fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
55 	if (!fwnode)
56 		return NULL;
57 
58 	fwnode_init(fwnode, &acpi_static_fwnode_ops);
59 
60 	return fwnode;
61 }
62 
63 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
64 {
65 	if (WARN_ON(!is_acpi_static_node(fwnode)))
66 		return;
67 
68 	kfree(fwnode);
69 }
70 
71 /**
72  * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
73  * the PCI-defined class-code information
74  *
75  * @_cls : the class, subclass, prog-if triple for this device
76  * @_msk : the class mask for this device
77  *
78  * This macro is used to create a struct acpi_device_id that matches a
79  * specific PCI class. The .id and .driver_data fields will be left
80  * initialized with the default value.
81  */
82 #define ACPI_DEVICE_CLASS(_cls, _msk)	.cls = (_cls), .cls_msk = (_msk),
83 
84 static inline bool has_acpi_companion(struct device *dev)
85 {
86 	return is_acpi_device_node(dev->fwnode);
87 }
88 
89 static inline void acpi_preset_companion(struct device *dev,
90 					 struct acpi_device *parent, u64 addr)
91 {
92 	ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
93 }
94 
95 static inline const char *acpi_dev_name(struct acpi_device *adev)
96 {
97 	return dev_name(&adev->dev);
98 }
99 
100 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
101 
102 enum acpi_irq_model_id {
103 	ACPI_IRQ_MODEL_PIC = 0,
104 	ACPI_IRQ_MODEL_IOAPIC,
105 	ACPI_IRQ_MODEL_IOSAPIC,
106 	ACPI_IRQ_MODEL_PLATFORM,
107 	ACPI_IRQ_MODEL_GIC,
108 	ACPI_IRQ_MODEL_LPIC,
109 	ACPI_IRQ_MODEL_COUNT
110 };
111 
112 extern enum acpi_irq_model_id	acpi_irq_model;
113 
114 enum acpi_interrupt_id {
115 	ACPI_INTERRUPT_PMI	= 1,
116 	ACPI_INTERRUPT_INIT,
117 	ACPI_INTERRUPT_CPEI,
118 	ACPI_INTERRUPT_COUNT
119 };
120 
121 #define	ACPI_SPACE_MEM		0
122 
123 enum acpi_address_range_id {
124 	ACPI_ADDRESS_RANGE_MEMORY = 1,
125 	ACPI_ADDRESS_RANGE_RESERVED = 2,
126 	ACPI_ADDRESS_RANGE_ACPI = 3,
127 	ACPI_ADDRESS_RANGE_NVS	= 4,
128 	ACPI_ADDRESS_RANGE_COUNT
129 };
130 
131 
132 /* Table Handlers */
133 union acpi_subtable_headers {
134 	struct acpi_subtable_header common;
135 	struct acpi_hmat_structure hmat;
136 	struct acpi_prmt_module_header prmt;
137 	struct acpi_cedt_header cedt;
138 };
139 
140 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
141 
142 typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
143 				      const unsigned long end);
144 
145 typedef int (*acpi_tbl_entry_handler_arg)(union acpi_subtable_headers *header,
146 					  void *arg, const unsigned long end);
147 
148 /* Debugger support */
149 
150 struct acpi_debugger_ops {
151 	int (*create_thread)(acpi_osd_exec_callback function, void *context);
152 	ssize_t (*write_log)(const char *msg);
153 	ssize_t (*read_cmd)(char *buffer, size_t length);
154 	int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
155 	int (*notify_command_complete)(void);
156 };
157 
158 struct acpi_debugger {
159 	const struct acpi_debugger_ops *ops;
160 	struct module *owner;
161 	struct mutex lock;
162 };
163 
164 #ifdef CONFIG_ACPI_DEBUGGER
165 int __init acpi_debugger_init(void);
166 int acpi_register_debugger(struct module *owner,
167 			   const struct acpi_debugger_ops *ops);
168 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
169 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
170 ssize_t acpi_debugger_write_log(const char *msg);
171 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
172 int acpi_debugger_wait_command_ready(void);
173 int acpi_debugger_notify_command_complete(void);
174 #else
175 static inline int acpi_debugger_init(void)
176 {
177 	return -ENODEV;
178 }
179 
180 static inline int acpi_register_debugger(struct module *owner,
181 					 const struct acpi_debugger_ops *ops)
182 {
183 	return -ENODEV;
184 }
185 
186 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
187 {
188 }
189 
190 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
191 					      void *context)
192 {
193 	return -ENODEV;
194 }
195 
196 static inline int acpi_debugger_write_log(const char *msg)
197 {
198 	return -ENODEV;
199 }
200 
201 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
202 {
203 	return -ENODEV;
204 }
205 
206 static inline int acpi_debugger_wait_command_ready(void)
207 {
208 	return -ENODEV;
209 }
210 
211 static inline int acpi_debugger_notify_command_complete(void)
212 {
213 	return -ENODEV;
214 }
215 #endif
216 
217 #define BAD_MADT_ENTRY(entry, end) (					    \
218 		(!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
219 		((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
220 
221 struct acpi_subtable_proc {
222 	int id;
223 	acpi_tbl_entry_handler handler;
224 	acpi_tbl_entry_handler_arg handler_arg;
225 	void *arg;
226 	int count;
227 };
228 
229 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
230 void __acpi_unmap_table(void __iomem *map, unsigned long size);
231 int early_acpi_boot_init(void);
232 int acpi_boot_init (void);
233 void acpi_boot_table_prepare (void);
234 void acpi_boot_table_init (void);
235 int acpi_mps_check (void);
236 int acpi_numa_init (void);
237 
238 int acpi_locate_initial_tables (void);
239 void acpi_reserve_initial_tables (void);
240 void acpi_table_init_complete (void);
241 int acpi_table_init (void);
242 
243 #ifdef CONFIG_ACPI_TABLE_LIB
244 #define EXPORT_SYMBOL_ACPI_LIB(x) EXPORT_SYMBOL_NS_GPL(x, ACPI)
245 #define __init_or_acpilib
246 #define __initdata_or_acpilib
247 #else
248 #define EXPORT_SYMBOL_ACPI_LIB(x)
249 #define __init_or_acpilib __init
250 #define __initdata_or_acpilib __initdata
251 #endif
252 
253 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
254 int __init_or_acpilib acpi_table_parse_entries(char *id,
255 		unsigned long table_size, int entry_id,
256 		acpi_tbl_entry_handler handler, unsigned int max_entries);
257 int __init_or_acpilib acpi_table_parse_entries_array(char *id,
258 		unsigned long table_size, struct acpi_subtable_proc *proc,
259 		int proc_num, unsigned int max_entries);
260 int acpi_table_parse_madt(enum acpi_madt_type id,
261 			  acpi_tbl_entry_handler handler,
262 			  unsigned int max_entries);
263 int __init_or_acpilib
264 acpi_table_parse_cedt(enum acpi_cedt_type id,
265 		      acpi_tbl_entry_handler_arg handler_arg, void *arg);
266 
267 int acpi_parse_mcfg (struct acpi_table_header *header);
268 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
269 
270 /* the following numa functions are architecture-dependent */
271 void acpi_numa_slit_init (struct acpi_table_slit *slit);
272 
273 #if defined(CONFIG_X86) || defined(CONFIG_IA64) || defined(CONFIG_LOONGARCH)
274 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
275 #else
276 static inline void
277 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
278 #endif
279 
280 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
281 
282 #ifdef CONFIG_ARM64
283 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
284 void acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size);
285 #else
286 static inline void
287 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
288 static inline void
289 acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size) { }
290 #endif
291 
292 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
293 
294 #ifndef PHYS_CPUID_INVALID
295 typedef u32 phys_cpuid_t;
296 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
297 #endif
298 
299 static inline bool invalid_logical_cpuid(u32 cpuid)
300 {
301 	return (int)cpuid < 0;
302 }
303 
304 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
305 {
306 	return phys_id == PHYS_CPUID_INVALID;
307 }
308 
309 /* Validate the processor object's proc_id */
310 bool acpi_duplicate_processor_id(int proc_id);
311 /* Processor _CTS control */
312 struct acpi_processor_power;
313 
314 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
315 bool acpi_processor_claim_cst_control(void);
316 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
317 				struct acpi_processor_power *info);
318 #else
319 static inline bool acpi_processor_claim_cst_control(void) { return false; }
320 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
321 					      struct acpi_processor_power *info)
322 {
323 	return -ENODEV;
324 }
325 #endif
326 
327 #ifdef CONFIG_ACPI_HOTPLUG_CPU
328 /* Arch dependent functions for cpu hotplug support */
329 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
330 		 int *pcpu);
331 int acpi_unmap_cpu(int cpu);
332 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
333 
334 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
335 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
336 #endif
337 
338 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
339 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
340 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
341 void acpi_irq_stats_init(void);
342 extern u32 acpi_irq_handled;
343 extern u32 acpi_irq_not_handled;
344 extern unsigned int acpi_sci_irq;
345 extern bool acpi_no_s5;
346 #define INVALID_ACPI_IRQ	((unsigned)-1)
347 static inline bool acpi_sci_irq_valid(void)
348 {
349 	return acpi_sci_irq != INVALID_ACPI_IRQ;
350 }
351 
352 extern int sbf_port;
353 extern unsigned long acpi_realmode_flags;
354 
355 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
356 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
357 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
358 
359 void acpi_set_irq_model(enum acpi_irq_model_id model,
360 			struct fwnode_handle *(*)(u32));
361 void acpi_set_gsi_to_irq_fallback(u32 (*)(u32));
362 
363 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
364 					     unsigned int size,
365 					     struct fwnode_handle *fwnode,
366 					     const struct irq_domain_ops *ops,
367 					     void *host_data);
368 
369 #ifdef CONFIG_X86_IO_APIC
370 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
371 #else
372 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
373 {
374 	return -1;
375 }
376 #endif
377 /*
378  * This function undoes the effect of one call to acpi_register_gsi().
379  * If this matches the last registration, any IRQ resources for gsi
380  * are freed.
381  */
382 void acpi_unregister_gsi (u32 gsi);
383 
384 struct pci_dev;
385 
386 int acpi_pci_irq_enable (struct pci_dev *dev);
387 void acpi_penalize_isa_irq(int irq, int active);
388 bool acpi_isa_irq_available(int irq);
389 #ifdef CONFIG_PCI
390 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
391 #else
392 static inline void acpi_penalize_sci_irq(int irq, int trigger,
393 					int polarity)
394 {
395 }
396 #endif
397 void acpi_pci_irq_disable (struct pci_dev *dev);
398 
399 extern int ec_read(u8 addr, u8 *val);
400 extern int ec_write(u8 addr, u8 val);
401 extern int ec_transaction(u8 command,
402                           const u8 *wdata, unsigned wdata_len,
403                           u8 *rdata, unsigned rdata_len);
404 extern acpi_handle ec_get_handle(void);
405 
406 extern bool acpi_is_pnp_device(struct acpi_device *);
407 
408 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
409 
410 typedef void (*wmi_notify_handler) (u32 value, void *context);
411 
412 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
413 					u32 method_id,
414 					const struct acpi_buffer *in,
415 					struct acpi_buffer *out);
416 extern acpi_status wmi_query_block(const char *guid, u8 instance,
417 					struct acpi_buffer *out);
418 extern acpi_status wmi_set_block(const char *guid, u8 instance,
419 					const struct acpi_buffer *in);
420 extern acpi_status wmi_install_notify_handler(const char *guid,
421 					wmi_notify_handler handler, void *data);
422 extern acpi_status wmi_remove_notify_handler(const char *guid);
423 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
424 extern bool wmi_has_guid(const char *guid);
425 extern char *wmi_get_acpi_device_uid(const char *guid);
426 
427 #endif	/* CONFIG_ACPI_WMI */
428 
429 #define ACPI_VIDEO_OUTPUT_SWITCHING			0x0001
430 #define ACPI_VIDEO_DEVICE_POSTING			0x0002
431 #define ACPI_VIDEO_ROM_AVAILABLE			0x0004
432 #define ACPI_VIDEO_BACKLIGHT				0x0008
433 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR		0x0010
434 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO		0x0020
435 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR	0x0040
436 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO		0x0080
437 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR			0x0100
438 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO			0x0200
439 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR		0x0400
440 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO		0x0800
441 
442 extern char acpi_video_backlight_string[];
443 extern long acpi_is_video_device(acpi_handle handle);
444 extern int acpi_blacklisted(void);
445 extern void acpi_osi_setup(char *str);
446 extern bool acpi_osi_is_win8(void);
447 
448 #ifdef CONFIG_ACPI_NUMA
449 int acpi_map_pxm_to_node(int pxm);
450 int acpi_get_node(acpi_handle handle);
451 
452 /**
453  * pxm_to_online_node - Map proximity ID to online node
454  * @pxm: ACPI proximity ID
455  *
456  * This is similar to pxm_to_node(), but always returns an online
457  * node.  When the mapped node from a given proximity ID is offline, it
458  * looks up the node distance table and returns the nearest online node.
459  *
460  * ACPI device drivers, which are called after the NUMA initialization has
461  * completed in the kernel, can call this interface to obtain their device
462  * NUMA topology from ACPI tables.  Such drivers do not have to deal with
463  * offline nodes.  A node may be offline when SRAT memory entry does not exist,
464  * or NUMA is disabled, ex. "numa=off" on x86.
465  */
466 static inline int pxm_to_online_node(int pxm)
467 {
468 	int node = pxm_to_node(pxm);
469 
470 	return numa_map_to_online_node(node);
471 }
472 #else
473 static inline int pxm_to_online_node(int pxm)
474 {
475 	return 0;
476 }
477 static inline int acpi_map_pxm_to_node(int pxm)
478 {
479 	return 0;
480 }
481 static inline int acpi_get_node(acpi_handle handle)
482 {
483 	return 0;
484 }
485 #endif
486 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
487 
488 extern int pnpacpi_disabled;
489 
490 #define PXM_INVAL	(-1)
491 
492 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
493 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
494 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
495 				     struct resource_win *win);
496 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
497 					 struct resource_win *win);
498 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
499 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
500 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
501 				 struct resource *res);
502 
503 void acpi_dev_free_resource_list(struct list_head *list);
504 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
505 			   int (*preproc)(struct acpi_resource *, void *),
506 			   void *preproc_data);
507 int acpi_dev_get_dma_resources(struct acpi_device *adev,
508 			       struct list_head *list);
509 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
510 				  unsigned long types);
511 
512 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
513 						   void *arg)
514 {
515 	return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
516 }
517 
518 struct acpi_device *acpi_resource_consumer(struct resource *res);
519 
520 int acpi_check_resource_conflict(const struct resource *res);
521 
522 int acpi_check_region(resource_size_t start, resource_size_t n,
523 		      const char *name);
524 
525 int acpi_resources_are_enforced(void);
526 
527 #ifdef CONFIG_HIBERNATION
528 extern int acpi_check_s4_hw_signature;
529 #endif
530 
531 #ifdef CONFIG_PM_SLEEP
532 void __init acpi_old_suspend_ordering(void);
533 void __init acpi_nvs_nosave(void);
534 void __init acpi_nvs_nosave_s3(void);
535 void __init acpi_sleep_no_blacklist(void);
536 #endif /* CONFIG_PM_SLEEP */
537 
538 int acpi_register_wakeup_handler(
539 	int wake_irq, bool (*wakeup)(void *context), void *context);
540 void acpi_unregister_wakeup_handler(
541 	bool (*wakeup)(void *context), void *context);
542 
543 struct acpi_osc_context {
544 	char *uuid_str;			/* UUID string */
545 	int rev;
546 	struct acpi_buffer cap;		/* list of DWORD capabilities */
547 	struct acpi_buffer ret;		/* free by caller if success */
548 };
549 
550 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
551 
552 /* Number of _OSC capability DWORDS depends on bridge type */
553 #define OSC_PCI_CAPABILITY_DWORDS		3
554 #define OSC_CXL_CAPABILITY_DWORDS		5
555 
556 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 to 5 are device-specific) */
557 #define OSC_QUERY_DWORD				0	/* DWORD 1 */
558 #define OSC_SUPPORT_DWORD			1	/* DWORD 2 */
559 #define OSC_CONTROL_DWORD			2	/* DWORD 3 */
560 #define OSC_EXT_SUPPORT_DWORD			3	/* DWORD 4 */
561 #define OSC_EXT_CONTROL_DWORD			4	/* DWORD 5 */
562 
563 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
564 #define OSC_QUERY_ENABLE			0x00000001  /* input */
565 #define OSC_REQUEST_ERROR			0x00000002  /* return */
566 #define OSC_INVALID_UUID_ERROR			0x00000004  /* return */
567 #define OSC_INVALID_REVISION_ERROR		0x00000008  /* return */
568 #define OSC_CAPABILITIES_MASK_ERROR		0x00000010  /* return */
569 
570 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
571 #define OSC_SB_PAD_SUPPORT			0x00000001
572 #define OSC_SB_PPC_OST_SUPPORT			0x00000002
573 #define OSC_SB_PR3_SUPPORT			0x00000004
574 #define OSC_SB_HOTPLUG_OST_SUPPORT		0x00000008
575 #define OSC_SB_APEI_SUPPORT			0x00000010
576 #define OSC_SB_CPC_SUPPORT			0x00000020
577 #define OSC_SB_CPCV2_SUPPORT			0x00000040
578 #define OSC_SB_PCLPI_SUPPORT			0x00000080
579 #define OSC_SB_OSLPI_SUPPORT			0x00000100
580 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT		0x00001000
581 #define OSC_SB_GENERIC_INITIATOR_SUPPORT	0x00002000
582 #define OSC_SB_CPC_FLEXIBLE_ADR_SPACE		0x00004000
583 #define OSC_SB_NATIVE_USB4_SUPPORT		0x00040000
584 #define OSC_SB_PRM_SUPPORT			0x00200000
585 
586 extern bool osc_sb_apei_support_acked;
587 extern bool osc_pc_lpi_support_confirmed;
588 extern bool osc_sb_native_usb4_support_confirmed;
589 extern bool osc_sb_cppc2_support_acked;
590 extern bool osc_cpc_flexible_adr_space_confirmed;
591 
592 /* USB4 Capabilities */
593 #define OSC_USB_USB3_TUNNELING			0x00000001
594 #define OSC_USB_DP_TUNNELING			0x00000002
595 #define OSC_USB_PCIE_TUNNELING			0x00000004
596 #define OSC_USB_XDOMAIN				0x00000008
597 
598 extern u32 osc_sb_native_usb4_control;
599 
600 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
601 #define OSC_PCI_EXT_CONFIG_SUPPORT		0x00000001
602 #define OSC_PCI_ASPM_SUPPORT			0x00000002
603 #define OSC_PCI_CLOCK_PM_SUPPORT		0x00000004
604 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT		0x00000008
605 #define OSC_PCI_MSI_SUPPORT			0x00000010
606 #define OSC_PCI_EDR_SUPPORT			0x00000080
607 #define OSC_PCI_HPX_TYPE_3_SUPPORT		0x00000100
608 
609 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
610 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL	0x00000001
611 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL		0x00000002
612 #define OSC_PCI_EXPRESS_PME_CONTROL		0x00000004
613 #define OSC_PCI_EXPRESS_AER_CONTROL		0x00000008
614 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL	0x00000010
615 #define OSC_PCI_EXPRESS_LTR_CONTROL		0x00000020
616 #define OSC_PCI_EXPRESS_DPC_CONTROL		0x00000080
617 
618 /* CXL _OSC: Capabilities DWORD 4: Support Field */
619 #define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT	0x00000001
620 #define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT	0x00000002
621 #define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT	0x00000004
622 #define OSC_CXL_NATIVE_HP_SUPPORT		0x00000008
623 
624 /* CXL _OSC: Capabilities DWORD 5: Control Field */
625 #define OSC_CXL_ERROR_REPORTING_CONTROL		0x00000001
626 
627 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
628 {
629 	u32 *ret = context->ret.pointer;
630 
631 	return ret[OSC_CONTROL_DWORD];
632 }
633 
634 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
635 {
636 	u32 *ret = context->ret.pointer;
637 
638 	return ret[OSC_EXT_CONTROL_DWORD];
639 }
640 
641 #define ACPI_GSB_ACCESS_ATTRIB_QUICK		0x00000002
642 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
643 #define ACPI_GSB_ACCESS_ATTRIB_BYTE		0x00000006
644 #define ACPI_GSB_ACCESS_ATTRIB_WORD		0x00000008
645 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK		0x0000000A
646 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE	0x0000000B
647 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL	0x0000000C
648 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL	0x0000000D
649 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES	0x0000000E
650 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS	0x0000000F
651 
652 /* Enable _OST when all relevant hotplug operations are enabled */
653 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&			\
654 	defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&		\
655 	defined(CONFIG_ACPI_CONTAINER)
656 #define ACPI_HOTPLUG_OST
657 #endif
658 
659 /* _OST Source Event Code (OSPM Action) */
660 #define ACPI_OST_EC_OSPM_SHUTDOWN		0x100
661 #define ACPI_OST_EC_OSPM_EJECT			0x103
662 #define ACPI_OST_EC_OSPM_INSERTION		0x200
663 
664 /* _OST General Processing Status Code */
665 #define ACPI_OST_SC_SUCCESS			0x0
666 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE	0x1
667 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY		0x2
668 
669 /* _OST OS Shutdown Processing (0x100) Status Code */
670 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED		0x80
671 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS	0x81
672 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED	0x82
673 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED	0x83
674 
675 /* _OST Ejection Request (0x3, 0x103) Status Code */
676 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED		0x80
677 #define ACPI_OST_SC_DEVICE_IN_USE		0x81
678 #define ACPI_OST_SC_DEVICE_BUSY			0x82
679 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY	0x83
680 #define ACPI_OST_SC_EJECT_IN_PROGRESS		0x84
681 
682 /* _OST Insertion Request (0x200) Status Code */
683 #define ACPI_OST_SC_INSERT_IN_PROGRESS		0x80
684 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE		0x81
685 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED	0x82
686 
687 enum acpi_predicate {
688 	all_versions,
689 	less_than_or_equal,
690 	equal,
691 	greater_than_or_equal,
692 };
693 
694 /* Table must be terminted by a NULL entry */
695 struct acpi_platform_list {
696 	char	oem_id[ACPI_OEM_ID_SIZE+1];
697 	char	oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
698 	u32	oem_revision;
699 	char	*table;
700 	enum acpi_predicate pred;
701 	char	*reason;
702 	u32	data;
703 };
704 int acpi_match_platform_list(const struct acpi_platform_list *plat);
705 
706 extern void acpi_early_init(void);
707 extern void acpi_subsystem_init(void);
708 extern void arch_post_acpi_subsys_init(void);
709 
710 extern int acpi_nvs_register(__u64 start, __u64 size);
711 
712 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
713 				    void *data);
714 
715 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
716 					       const struct device *dev);
717 
718 const void *acpi_device_get_match_data(const struct device *dev);
719 extern bool acpi_driver_match_device(struct device *dev,
720 				     const struct device_driver *drv);
721 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
722 int acpi_device_modalias(struct device *, char *, int);
723 
724 struct platform_device *acpi_create_platform_device(struct acpi_device *,
725 						    const struct property_entry *);
726 #define ACPI_PTR(_ptr)	(_ptr)
727 
728 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
729 {
730 	adev->flags.visited = true;
731 }
732 
733 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
734 {
735 	adev->flags.visited = false;
736 }
737 
738 enum acpi_reconfig_event  {
739 	ACPI_RECONFIG_DEVICE_ADD = 0,
740 	ACPI_RECONFIG_DEVICE_REMOVE,
741 };
742 
743 int acpi_reconfig_notifier_register(struct notifier_block *nb);
744 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
745 
746 #ifdef CONFIG_ACPI_GTDT
747 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
748 int acpi_gtdt_map_ppi(int type);
749 bool acpi_gtdt_c3stop(int type);
750 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
751 #endif
752 
753 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
754 static inline void acpi_arch_set_root_pointer(u64 addr)
755 {
756 }
757 #endif
758 
759 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
760 static inline u64 acpi_arch_get_root_pointer(void)
761 {
762 	return 0;
763 }
764 #endif
765 
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 #define ACPI_DEVICE_CLASS(_cls, _msk)	.cls = (0), .cls_msk = (0),
778 
779 #include <acpi/acpi_numa.h>
780 
781 struct fwnode_handle;
782 
783 static inline bool acpi_dev_found(const char *hid)
784 {
785 	return false;
786 }
787 
788 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
789 {
790 	return false;
791 }
792 
793 struct acpi_device;
794 
795 static inline bool
796 acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2)
797 {
798 	return false;
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_device(
927 	const struct acpi_device_id *ids, const struct device *dev)
928 {
929 	return NULL;
930 }
931 
932 static inline const void *acpi_device_get_match_data(const struct device *dev)
933 {
934 	return NULL;
935 }
936 
937 static inline bool acpi_driver_match_device(struct device *dev,
938 					    const struct device_driver *drv)
939 {
940 	return false;
941 }
942 
943 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
944 						   const guid_t *guid,
945 						   u64 rev, u64 func,
946 						   union acpi_object *argv4)
947 {
948 	return NULL;
949 }
950 
951 static inline int acpi_device_uevent_modalias(struct device *dev,
952 				struct kobj_uevent_env *env)
953 {
954 	return -ENODEV;
955 }
956 
957 static inline int acpi_device_modalias(struct device *dev,
958 				char *buf, int size)
959 {
960 	return -ENODEV;
961 }
962 
963 static inline struct platform_device *
964 acpi_create_platform_device(struct acpi_device *adev,
965 			    const struct property_entry *properties)
966 {
967 	return NULL;
968 }
969 
970 static inline bool acpi_dma_supported(const struct acpi_device *adev)
971 {
972 	return false;
973 }
974 
975 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
976 {
977 	return DEV_DMA_NOT_SUPPORTED;
978 }
979 
980 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
981 				     u64 *offset, u64 *size)
982 {
983 	return -ENODEV;
984 }
985 
986 static inline int acpi_dma_configure(struct device *dev,
987 				     enum dev_dma_attr attr)
988 {
989 	return 0;
990 }
991 
992 static inline int acpi_dma_configure_id(struct device *dev,
993 					enum dev_dma_attr attr,
994 					const u32 *input_id)
995 {
996 	return 0;
997 }
998 
999 #define ACPI_PTR(_ptr)	(NULL)
1000 
1001 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
1002 {
1003 }
1004 
1005 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
1006 {
1007 }
1008 
1009 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
1010 {
1011 	return -EINVAL;
1012 }
1013 
1014 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
1015 {
1016 	return -EINVAL;
1017 }
1018 
1019 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
1020 {
1021 	return NULL;
1022 }
1023 
1024 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
1025 {
1026 	return -ENODEV;
1027 }
1028 
1029 static inline const char *acpi_get_subsystem_id(acpi_handle handle)
1030 {
1031 	return ERR_PTR(-ENODEV);
1032 }
1033 
1034 static inline int acpi_register_wakeup_handler(int wake_irq,
1035 	bool (*wakeup)(void *context), void *context)
1036 {
1037 	return -ENXIO;
1038 }
1039 
1040 static inline void acpi_unregister_wakeup_handler(
1041 	bool (*wakeup)(void *context), void *context) { }
1042 
1043 struct acpi_osc_context;
1044 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
1045 {
1046 	return 0;
1047 }
1048 
1049 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
1050 {
1051 	return 0;
1052 }
1053 
1054 #endif	/* !CONFIG_ACPI */
1055 
1056 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1057 int acpi_ioapic_add(acpi_handle root);
1058 #else
1059 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1060 #endif
1061 
1062 #ifdef CONFIG_ACPI
1063 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1064 			       u32 pm1a_ctrl,  u32 pm1b_ctrl));
1065 
1066 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1067 				  u32 pm1a_control, u32 pm1b_control);
1068 
1069 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1070 				        u32 val_a,  u32 val_b));
1071 
1072 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1073 					   u32 val_a, u32 val_b);
1074 #ifdef CONFIG_X86
1075 struct acpi_s2idle_dev_ops {
1076 	struct list_head list_node;
1077 	void (*prepare)(void);
1078 	void (*restore)(void);
1079 };
1080 int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1081 void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1082 #endif /* CONFIG_X86 */
1083 #ifndef CONFIG_IA64
1084 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1085 #else
1086 static inline void arch_reserve_mem_area(acpi_physical_address addr,
1087 					  size_t size)
1088 {
1089 }
1090 #endif /* CONFIG_X86 */
1091 #else
1092 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1093 #endif
1094 
1095 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1096 int acpi_dev_suspend(struct device *dev, bool wakeup);
1097 int acpi_dev_resume(struct device *dev);
1098 int acpi_subsys_runtime_suspend(struct device *dev);
1099 int acpi_subsys_runtime_resume(struct device *dev);
1100 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1101 bool acpi_storage_d3(struct device *dev);
1102 bool acpi_dev_state_d0(struct device *dev);
1103 #else
1104 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1105 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1106 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1107 {
1108 	return 0;
1109 }
1110 static inline bool acpi_storage_d3(struct device *dev)
1111 {
1112 	return false;
1113 }
1114 static inline bool acpi_dev_state_d0(struct device *dev)
1115 {
1116 	return true;
1117 }
1118 #endif
1119 
1120 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1121 int acpi_subsys_prepare(struct device *dev);
1122 void acpi_subsys_complete(struct device *dev);
1123 int acpi_subsys_suspend_late(struct device *dev);
1124 int acpi_subsys_suspend_noirq(struct device *dev);
1125 int acpi_subsys_suspend(struct device *dev);
1126 int acpi_subsys_freeze(struct device *dev);
1127 int acpi_subsys_poweroff(struct device *dev);
1128 void acpi_ec_mark_gpe_for_wake(void);
1129 void acpi_ec_set_gpe_wake_mask(u8 action);
1130 #else
1131 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1132 static inline void acpi_subsys_complete(struct device *dev) {}
1133 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1134 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1135 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1136 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1137 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1138 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1139 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1140 #endif
1141 
1142 #ifdef CONFIG_ACPI
1143 __printf(3, 4)
1144 void acpi_handle_printk(const char *level, acpi_handle handle,
1145 			const char *fmt, ...);
1146 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1147 				  acpi_status status);
1148 #else	/* !CONFIG_ACPI */
1149 static inline __printf(3, 4) void
1150 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1151 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1152 						const char *name,
1153 						acpi_status status) {}
1154 #endif	/* !CONFIG_ACPI */
1155 
1156 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1157 __printf(3, 4)
1158 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1159 #endif
1160 
1161 /*
1162  * acpi_handle_<level>: Print message with ACPI prefix and object path
1163  *
1164  * These interfaces acquire the global namespace mutex to obtain an object
1165  * path.  In interrupt context, it shows the object path as <n/a>.
1166  */
1167 #define acpi_handle_emerg(handle, fmt, ...)				\
1168 	acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1169 #define acpi_handle_alert(handle, fmt, ...)				\
1170 	acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1171 #define acpi_handle_crit(handle, fmt, ...)				\
1172 	acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1173 #define acpi_handle_err(handle, fmt, ...)				\
1174 	acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1175 #define acpi_handle_warn(handle, fmt, ...)				\
1176 	acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1177 #define acpi_handle_notice(handle, fmt, ...)				\
1178 	acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1179 #define acpi_handle_info(handle, fmt, ...)				\
1180 	acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1181 
1182 #if defined(DEBUG)
1183 #define acpi_handle_debug(handle, fmt, ...)				\
1184 	acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1185 #else
1186 #if defined(CONFIG_DYNAMIC_DEBUG)
1187 #define acpi_handle_debug(handle, fmt, ...)				\
1188 	_dynamic_func_call(fmt, __acpi_handle_debug,			\
1189 			   handle, pr_fmt(fmt), ##__VA_ARGS__)
1190 #else
1191 #define acpi_handle_debug(handle, fmt, ...)				\
1192 ({									\
1193 	if (0)								\
1194 		acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1195 	0;								\
1196 })
1197 #endif
1198 #endif
1199 
1200 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1201 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1202 				struct acpi_resource_gpio **agpio);
1203 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1204 			       struct acpi_resource_gpio **agpio);
1205 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index);
1206 #else
1207 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1208 					      struct acpi_resource_gpio **agpio)
1209 {
1210 	return false;
1211 }
1212 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1213 					     struct acpi_resource_gpio **agpio)
1214 {
1215 	return false;
1216 }
1217 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev,
1218 					   const char *name, int index)
1219 {
1220 	return -ENXIO;
1221 }
1222 #endif
1223 
1224 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1225 {
1226 	return acpi_dev_gpio_irq_get_by(adev, NULL, index);
1227 }
1228 
1229 /* Device properties */
1230 
1231 #ifdef CONFIG_ACPI
1232 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1233 			  acpi_object_type type, const union acpi_object **obj);
1234 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1235 				const char *name, size_t index, size_t num_args,
1236 				struct fwnode_reference_args *args);
1237 
1238 static inline int acpi_node_get_property_reference(
1239 				const struct fwnode_handle *fwnode,
1240 				const char *name, size_t index,
1241 				struct fwnode_reference_args *args)
1242 {
1243 	return __acpi_node_get_property_reference(fwnode, name, index,
1244 		NR_FWNODE_REFERENCE_ARGS, args);
1245 }
1246 
1247 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1248 {
1249 	return !list_empty(&adev->data.properties);
1250 }
1251 
1252 struct acpi_device_properties *
1253 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1254 		    union acpi_object *properties);
1255 
1256 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1257 		       void **valptr);
1258 
1259 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1260 					    struct fwnode_handle *child);
1261 
1262 struct acpi_probe_entry;
1263 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1264 						 struct acpi_probe_entry *);
1265 
1266 #define ACPI_TABLE_ID_LEN	5
1267 
1268 /**
1269  * struct acpi_probe_entry - boot-time probing entry
1270  * @id:			ACPI table name
1271  * @type:		Optional subtable type to match
1272  *			(if @id contains subtables)
1273  * @subtable_valid:	Optional callback to check the validity of
1274  *			the subtable
1275  * @probe_table:	Callback to the driver being probed when table
1276  *			match is successful
1277  * @probe_subtbl:	Callback to the driver being probed when table and
1278  *			subtable match (and optional callback is successful)
1279  * @driver_data:	Sideband data provided back to the driver
1280  */
1281 struct acpi_probe_entry {
1282 	__u8 id[ACPI_TABLE_ID_LEN];
1283 	__u8 type;
1284 	acpi_probe_entry_validate_subtbl subtable_valid;
1285 	union {
1286 		acpi_tbl_table_handler probe_table;
1287 		acpi_tbl_entry_handler probe_subtbl;
1288 	};
1289 	kernel_ulong_t driver_data;
1290 };
1291 
1292 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,	\
1293 				 valid, data, fn)			\
1294 	static const struct acpi_probe_entry __acpi_probe_##name	\
1295 		__used __section("__" #table "_acpi_probe_table") = {	\
1296 			.id = table_id,					\
1297 			.type = subtable,				\
1298 			.subtable_valid = valid,			\
1299 			.probe_table = fn,				\
1300 			.driver_data = data,				\
1301 		}
1302 
1303 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,	\
1304 					  subtable, valid, data, fn)	\
1305 	static const struct acpi_probe_entry __acpi_probe_##name	\
1306 		__used __section("__" #table "_acpi_probe_table") = {	\
1307 			.id = table_id,					\
1308 			.type = subtable,				\
1309 			.subtable_valid = valid,			\
1310 			.probe_subtbl = fn,				\
1311 			.driver_data = data,				\
1312 		}
1313 
1314 #define ACPI_PROBE_TABLE(name)		__##name##_acpi_probe_table
1315 #define ACPI_PROBE_TABLE_END(name)	__##name##_acpi_probe_table_end
1316 
1317 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1318 
1319 #define acpi_probe_device_table(t)					\
1320 	({ 								\
1321 		extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),	\
1322 			                       ACPI_PROBE_TABLE_END(t);	\
1323 		__acpi_probe_device_table(&ACPI_PROBE_TABLE(t),		\
1324 					  (&ACPI_PROBE_TABLE_END(t) -	\
1325 					   &ACPI_PROBE_TABLE(t)));	\
1326 	})
1327 #else
1328 static inline int acpi_dev_get_property(struct acpi_device *adev,
1329 					const char *name, acpi_object_type type,
1330 					const union acpi_object **obj)
1331 {
1332 	return -ENXIO;
1333 }
1334 
1335 static inline int
1336 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1337 				const char *name, size_t index, size_t num_args,
1338 				struct fwnode_reference_args *args)
1339 {
1340 	return -ENXIO;
1341 }
1342 
1343 static inline int
1344 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1345 				 const char *name, size_t index,
1346 				 struct fwnode_reference_args *args)
1347 {
1348 	return -ENXIO;
1349 }
1350 
1351 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1352 				     const char *propname,
1353 				     void **valptr)
1354 {
1355 	return -ENXIO;
1356 }
1357 
1358 static inline struct fwnode_handle *
1359 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1360 		      struct fwnode_handle *child)
1361 {
1362 	return NULL;
1363 }
1364 
1365 static inline struct fwnode_handle *
1366 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1367 			     struct fwnode_handle *prev)
1368 {
1369 	return ERR_PTR(-ENXIO);
1370 }
1371 
1372 static inline int
1373 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1374 			       struct fwnode_handle **remote,
1375 			       struct fwnode_handle **port,
1376 			       struct fwnode_handle **endpoint)
1377 {
1378 	return -ENXIO;
1379 }
1380 
1381 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1382 	static const void * __acpi_table_##name[]			\
1383 		__attribute__((unused))					\
1384 		 = { (void *) table_id,					\
1385 		     (void *) subtable,					\
1386 		     (void *) valid,					\
1387 		     (void *) fn,					\
1388 		     (void *) data }
1389 
1390 #define acpi_probe_device_table(t)	({ int __r = 0; __r;})
1391 #endif
1392 
1393 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1394 void acpi_table_upgrade(void);
1395 #else
1396 static inline void acpi_table_upgrade(void) { }
1397 #endif
1398 
1399 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1400 extern bool acpi_has_watchdog(void);
1401 #else
1402 static inline bool acpi_has_watchdog(void) { return false; }
1403 #endif
1404 
1405 #ifdef CONFIG_ACPI_SPCR_TABLE
1406 extern bool qdf2400_e44_present;
1407 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1408 #else
1409 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1410 {
1411 	return 0;
1412 }
1413 #endif
1414 
1415 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1416 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1417 #else
1418 static inline
1419 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1420 {
1421 	return -EINVAL;
1422 }
1423 #endif
1424 
1425 #ifdef CONFIG_ACPI_LPIT
1426 int lpit_read_residency_count_address(u64 *address);
1427 #else
1428 static inline int lpit_read_residency_count_address(u64 *address)
1429 {
1430 	return -EINVAL;
1431 }
1432 #endif
1433 
1434 #ifdef CONFIG_ACPI_PPTT
1435 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1436 int find_acpi_cpu_topology(unsigned int cpu, int level);
1437 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1438 int find_acpi_cpu_topology_package(unsigned int cpu);
1439 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1440 #else
1441 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1442 {
1443 	return -EINVAL;
1444 }
1445 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1446 {
1447 	return -EINVAL;
1448 }
1449 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1450 {
1451 	return -EINVAL;
1452 }
1453 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1454 {
1455 	return -EINVAL;
1456 }
1457 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1458 {
1459 	return -EINVAL;
1460 }
1461 #endif
1462 
1463 #ifdef CONFIG_ACPI_PCC
1464 void acpi_init_pcc(void);
1465 #else
1466 static inline void acpi_init_pcc(void) { }
1467 #endif
1468 
1469 #ifdef CONFIG_ACPI
1470 extern void acpi_device_notify(struct device *dev);
1471 extern void acpi_device_notify_remove(struct device *dev);
1472 #else
1473 static inline void acpi_device_notify(struct device *dev) { }
1474 static inline void acpi_device_notify_remove(struct device *dev) { }
1475 #endif
1476 
1477 #endif	/*_LINUX_ACPI_H*/
1478