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